Class List Method List File List

# Class: Com::Vmware::Vcenter::Vm::Hardware::Ethernet::BackingSpec

Inherits:
  VAPI::Bindings::VapiStruct
  - Object
  - VAPI::Bindings::VapiStruct
  - Com::Vmware::Vcenter::Vm::Hardware::Ethernet::BackingSpec
  show all
Defined in:
  /build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb

## Overview

The ``Com::Vmware::Vcenter::Vm::Hardware::Ethernet::BackingSpec`` class provides a specification of the physical resource that backs a virtual Ethernet adapter.

## Instance Attribute Summary (collapse)

- - (String?) distributed_port

  Key of the distributed virtual port that backs the virtual Ethernet adapter.

- - (String) network

  Identifier of the network that backs the virtual Ethernet adapter.

- - (Com::Vmware::Vcenter::Vm::Hardware::Ethernet::BackingType) type

  Backing type for the virtual Ethernet adapter.

## Class Method Summary (collapse)

- + (VAPI::Bindings::StructType) binding_type

  Holds (gets or creates) the binding type metadata for this structure type.

## Instance Method Summary (collapse)

- - (BackingSpec) initialize(ruby_values = nil, struct_value = nil) constructor

  Constructs a new instance.

## Constructor Details

### - (`BackingSpec`) initialize(ruby_values = nil, struct_value = nil)

Constructs a new instance.

Parameters:

- ruby_values (`Hash`) (defaults to: `nil`) —

  a map of initial property values (optional)

- struct_value (`VAPI::Data::StructValue`) (defaults to: `nil`) —

  a raw StructValue from the wire (optional)

    2835
    2836
    2837
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 2835

    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end

## Instance Attribute Details

### - (`String`?) distributed_port

Key of the distributed virtual port that backs the virtual Ethernet adapter. Depending on the type of the Portgroup, the port may be specified using this field. If the portgroup type is early-binding (also known as static), a port is assigned when the Ethernet adapter is configured to use the port. The port may be either automatically or specifically assigned based on the value of this field . If the portgroup type is ephemeral, the port is created and assigned to a virtual machine when it is powered on and the Ethernet adapter is connected. This field cannot be specified as no free ports exist before use. May be used to specify a port when the network specified on the ``network`` field is a static or early binding distributed portgroup. If nil , the port will be automatically assigned to the Ethernet adapter based on the policy embodied by the portgroup type.

Returns:

- (`String`, `nil`)

    2808
    2809
    2810
    2811
    2812
    2813
    2814
    2815
    2816
    2817
    2818
    2819
    2820
    2821
    2822
    2823
    2824
    2825
    2826
    2827
    2828
    2829
    2830
    2831
    2832
    2833
    2834
    2835
    2836
    2837
    2838
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 2808

    class BackingSpec < VAPI::Bindings::VapiStruct

        class << self
            # Holds (gets or creates) the binding type metadata for this structure type.
            # @scope class
            # @return [VAPI::Bindings::StructType] the binding type
            def binding_type
                @binding_type ||= VAPI::Bindings::StructType.new(
                    'com.vmware.vcenter.vm.hardware.ethernet.backing_spec',
                    {
                        'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Ethernet::BackingType'),
                        'network' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                        'distributed_port' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    },
                    BackingSpec,
                    false,
                    nil)
            end
        end

        attr_accessor :type,
                      :network,
                      :distributed_port

        # Constructs a new instance.
        # @param ruby_values [Hash] a map of initial property values (optional)
        # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
        def initialize(ruby_values=nil, struct_value=nil)
            super(self.class.binding_type, ruby_values, struct_value)
        end
    end

### - (`String`) network

Identifier of the network that backs the virtual Ethernet adapter. This field is optional and it is only relevant when the value of ``type`` is one of :attr:`Com::Vmware::Vcenter::Vm::Hardware::Ethernet::BackingType.STANDARD_PORTGROUP` , :attr:`Com::Vmware::Vcenter::Vm::Hardware::Ethernet::BackingType.DISTRIBUTED_PORTGROUP` , or :attr:`Com::Vmware::Vcenter::Vm::Hardware::Ethernet::BackingType.OPAQUE_NETWORK` .

Returns:

- (`String`)

    2808
    2809
    2810
    2811
    2812
    2813
    2814
    2815
    2816
    2817
    2818
    2819
    2820
    2821
    2822
    2823
    2824
    2825
    2826
    2827
    2828
    2829
    2830
    2831
    2832
    2833
    2834
    2835
    2836
    2837
    2838
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 2808

    class BackingSpec < VAPI::Bindings::VapiStruct

        class << self
            # Holds (gets or creates) the binding type metadata for this structure type.
            # @scope class
            # @return [VAPI::Bindings::StructType] the binding type
            def binding_type
                @binding_type ||= VAPI::Bindings::StructType.new(
                    'com.vmware.vcenter.vm.hardware.ethernet.backing_spec',
                    {
                        'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Ethernet::BackingType'),
                        'network' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                        'distributed_port' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    },
                    BackingSpec,
                    false,
                    nil)
            end
        end

        attr_accessor :type,
                      :network,
                      :distributed_port

        # Constructs a new instance.
        # @param ruby_values [Hash] a map of initial property values (optional)
        # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
        def initialize(ruby_values=nil, struct_value=nil)
            super(self.class.binding_type, ruby_values, struct_value)
        end
    end

### - (`Com::Vmware::Vcenter::Vm::Hardware::Ethernet::BackingType`) type

Backing type for the virtual Ethernet adapter.

Returns:

- (`Com::Vmware::Vcenter::Vm::Hardware::Ethernet::BackingType`)

    2808
    2809
    2810
    2811
    2812
    2813
    2814
    2815
    2816
    2817
    2818
    2819
    2820
    2821
    2822
    2823
    2824
    2825
    2826
    2827
    2828
    2829
    2830
    2831
    2832
    2833
    2834
    2835
    2836
    2837
    2838
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 2808

    class BackingSpec < VAPI::Bindings::VapiStruct

        class << self
            # Holds (gets or creates) the binding type metadata for this structure type.
            # @scope class
            # @return [VAPI::Bindings::StructType] the binding type
            def binding_type
                @binding_type ||= VAPI::Bindings::StructType.new(
                    'com.vmware.vcenter.vm.hardware.ethernet.backing_spec',
                    {
                        'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Ethernet::BackingType'),
                        'network' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                        'distributed_port' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    },
                    BackingSpec,
                    false,
                    nil)
            end
        end

        attr_accessor :type,
                      :network,
                      :distributed_port

        # Constructs a new instance.
        # @param ruby_values [Hash] a map of initial property values (optional)
        # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
        def initialize(ruby_values=nil, struct_value=nil)
            super(self.class.binding_type, ruby_values, struct_value)
        end
    end

## Class Method Details

### + (`VAPI::Bindings::StructType`) binding_type

Holds (gets or creates) the binding type metadata for this structure type.

Returns:

- (`VAPI::Bindings::StructType`) —

  the binding type

    2814
    2815
    2816
    2817
    2818
    2819
    2820
    2821
    2822
    2823
    2824
    2825
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 2814

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.vcenter.vm.hardware.ethernet.backing_spec',
            {
                'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Ethernet::BackingType'),
                'network' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                'distributed_port' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
            },
            BackingSpec,
            false,
            nil)
    end