Class List Method List File List

# Class: Com::Vmware::Appliance::Networking::Interfaces::InterfaceInfo

Inherits:
  VAPI::Bindings::VapiStruct
  - Object
  - VAPI::Bindings::VapiStruct
  - Com::Vmware::Appliance::Networking::Interfaces::InterfaceInfo
  show all
Defined in:
  /build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/networking.rb

## Overview

``Com::Vmware::Appliance::Networking::Interfaces::InterfaceInfo`` class Structure that defines properties and status of a network interface.

## Instance Attribute Summary (collapse)

- - (String) mac

  MAC address.

- - (String) name

  Interface name, for example, “nic0”, “nic1”.

- - (Com::Vmware::Appliance::Networking::Interfaces::InterfaceStatus) status

  Interface status.

## 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)

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

  Constructs a new instance.

## Constructor Details

### - (`InterfaceInfo`) 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)

    131
    132
    133
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/networking.rb', line 131

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

## Instance Attribute Details

### - (`String`) mac

MAC address. For example 00:0C:29:94:BB:5A.

Returns:

- (`String`)

    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/networking.rb', line 104

    class InterfaceInfo < 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.appliance.networking.interfaces.interface_info',
                    {
                        'name' => VAPI::Bindings::StringType.instance,
                        'status' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Networking::Interfaces::InterfaceStatus'),
                        'mac' => VAPI::Bindings::StringType.instance,
                    },
                    InterfaceInfo,
                    false,
                    nil)
            end
        end

        attr_accessor :name,
                      :status,
                      :mac

        # 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`) name

Interface name, for example, “nic0”, “nic1”.

Returns:

- (`String`)

    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/networking.rb', line 104

    class InterfaceInfo < 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.appliance.networking.interfaces.interface_info',
                    {
                        'name' => VAPI::Bindings::StringType.instance,
                        'status' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Networking::Interfaces::InterfaceStatus'),
                        'mac' => VAPI::Bindings::StringType.instance,
                    },
                    InterfaceInfo,
                    false,
                    nil)
            end
        end

        attr_accessor :name,
                      :status,
                      :mac

        # 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::Appliance::Networking::Interfaces::InterfaceStatus`) status

Interface status.

Returns:

- (`Com::Vmware::Appliance::Networking::Interfaces::InterfaceStatus`)

    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/networking.rb', line 104

    class InterfaceInfo < 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.appliance.networking.interfaces.interface_info',
                    {
                        'name' => VAPI::Bindings::StringType.instance,
                        'status' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Networking::Interfaces::InterfaceStatus'),
                        'mac' => VAPI::Bindings::StringType.instance,
                    },
                    InterfaceInfo,
                    false,
                    nil)
            end
        end

        attr_accessor :name,
                      :status,
                      :mac

        # 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

    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/networking.rb', line 110

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.appliance.networking.interfaces.interface_info',
            {
                'name' => VAPI::Bindings::StringType.instance,
                'status' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Networking::Interfaces::InterfaceStatus'),
                'mac' => VAPI::Bindings::StringType.instance,
            },
            InterfaceInfo,
            false,
            nil)
    end