Class List Method List File List

# Class: Com::Vmware::Appliance::Techpreview::Networking::Ipv4::IPv4ConfigReadOnly

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

## Overview

``Com::Vmware::Appliance::Techpreview::Networking::Ipv4::IPv4ConfigReadOnly`` class Structure that defines the IPv4 configuration state of a network interface.

## Instance Attribute Summary (collapse)

- - (String) address

  IPv4 address, for example, “10.20.80.191”.

- - (String) default_gateway

  IPv4 address of the default gateway.

- - (String) interface_name

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

- - (Com::Vmware::Appliance::Techpreview::Networking::Ipv4::IPv4Mode) mode

  Address assignment mode.

- - (Fixnum) prefix

  IPv4 CIDR prefix, for example , 24.

- - (Boolean) updateable

  This indicates if the network configuration can be updated for the interface.

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

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

  Constructs a new instance.

## Constructor Details

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

    255
    256
    257
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 255

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

## Instance Attribute Details

### - (`String`) address

IPv4 address, for example, “10.20.80.191”. Set this argument to an empty string “”, if the mode is “unconfigured” or “dhcp”.

Returns:

- (`String`)

    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 222

    class IPv4ConfigReadOnly < 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.techpreview.networking.ipv4.I_pv4_config_read_only',
                    {
                        'interface_name' => VAPI::Bindings::StringType.instance,
                        'mode' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Networking::Ipv4::IPv4Mode'),
                        'address' => VAPI::Bindings::StringType.instance,
                        'prefix' => VAPI::Bindings::IntegerType.instance,
                        'default_gateway' => VAPI::Bindings::StringType.instance,
                        'updateable' => VAPI::Bindings::BooleanType.instance,
                    },
                    IPv4ConfigReadOnly,
                    false,
                    nil)
            end
        end

        attr_accessor :interface_name,
                      :mode,
                      :address,
                      :prefix,
                      :default_gateway,
                      :updateable

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

IPv4 address of the default gateway. This default gateway value is used if the mode argument is set to “static” This configures the global default gateway on the appliance with the specified gateway address and interface. This gateway replaces the existing default gateway configured on the appliance. However, if the gateway address is link-local, then it is added for that interface. This does not support configuration of multiple global default gateways through different interfaces.

Returns:

- (`String`)

    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 222

    class IPv4ConfigReadOnly < 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.techpreview.networking.ipv4.I_pv4_config_read_only',
                    {
                        'interface_name' => VAPI::Bindings::StringType.instance,
                        'mode' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Networking::Ipv4::IPv4Mode'),
                        'address' => VAPI::Bindings::StringType.instance,
                        'prefix' => VAPI::Bindings::IntegerType.instance,
                        'default_gateway' => VAPI::Bindings::StringType.instance,
                        'updateable' => VAPI::Bindings::BooleanType.instance,
                    },
                    IPv4ConfigReadOnly,
                    false,
                    nil)
            end
        end

        attr_accessor :interface_name,
                      :mode,
                      :address,
                      :prefix,
                      :default_gateway,
                      :updateable

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

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

Returns:

- (`String`)

    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 222

    class IPv4ConfigReadOnly < 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.techpreview.networking.ipv4.I_pv4_config_read_only',
                    {
                        'interface_name' => VAPI::Bindings::StringType.instance,
                        'mode' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Networking::Ipv4::IPv4Mode'),
                        'address' => VAPI::Bindings::StringType.instance,
                        'prefix' => VAPI::Bindings::IntegerType.instance,
                        'default_gateway' => VAPI::Bindings::StringType.instance,
                        'updateable' => VAPI::Bindings::BooleanType.instance,
                    },
                    IPv4ConfigReadOnly,
                    false,
                    nil)
            end
        end

        attr_accessor :interface_name,
                      :mode,
                      :address,
                      :prefix,
                      :default_gateway,
                      :updateable

        # 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::Techpreview::Networking::Ipv4::IPv4Mode`) mode

Address assignment mode.

Returns:

- (`Com::Vmware::Appliance::Techpreview::Networking::Ipv4::IPv4Mode`)

    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 222

    class IPv4ConfigReadOnly < 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.techpreview.networking.ipv4.I_pv4_config_read_only',
                    {
                        'interface_name' => VAPI::Bindings::StringType.instance,
                        'mode' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Networking::Ipv4::IPv4Mode'),
                        'address' => VAPI::Bindings::StringType.instance,
                        'prefix' => VAPI::Bindings::IntegerType.instance,
                        'default_gateway' => VAPI::Bindings::StringType.instance,
                        'updateable' => VAPI::Bindings::BooleanType.instance,
                    },
                    IPv4ConfigReadOnly,
                    false,
                    nil)
            end
        end

        attr_accessor :interface_name,
                      :mode,
                      :address,
                      :prefix,
                      :default_gateway,
                      :updateable

        # 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

### - (`Fixnum`) prefix

IPv4 CIDR prefix, for example , 24. See www.oav.net/mirrors/cidr.html for netmask-to-prefix conversion. Set this argument to 0 if the mode is “unconfigured” or “dhcp”.

Returns:

- (`Fixnum`)

    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 222

    class IPv4ConfigReadOnly < 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.techpreview.networking.ipv4.I_pv4_config_read_only',
                    {
                        'interface_name' => VAPI::Bindings::StringType.instance,
                        'mode' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Networking::Ipv4::IPv4Mode'),
                        'address' => VAPI::Bindings::StringType.instance,
                        'prefix' => VAPI::Bindings::IntegerType.instance,
                        'default_gateway' => VAPI::Bindings::StringType.instance,
                        'updateable' => VAPI::Bindings::BooleanType.instance,
                    },
                    IPv4ConfigReadOnly,
                    false,
                    nil)
            end
        end

        attr_accessor :interface_name,
                      :mode,
                      :address,
                      :prefix,
                      :default_gateway,
                      :updateable

        # 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

### - (`Boolean`) updateable

This indicates if the network configuration can be updated for the interface.

Returns:

- (`Boolean`)

    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 222

    class IPv4ConfigReadOnly < 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.techpreview.networking.ipv4.I_pv4_config_read_only',
                    {
                        'interface_name' => VAPI::Bindings::StringType.instance,
                        'mode' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Networking::Ipv4::IPv4Mode'),
                        'address' => VAPI::Bindings::StringType.instance,
                        'prefix' => VAPI::Bindings::IntegerType.instance,
                        'default_gateway' => VAPI::Bindings::StringType.instance,
                        'updateable' => VAPI::Bindings::BooleanType.instance,
                    },
                    IPv4ConfigReadOnly,
                    false,
                    nil)
            end
        end

        attr_accessor :interface_name,
                      :mode,
                      :address,
                      :prefix,
                      :default_gateway,
                      :updateable

        # 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

    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 228

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.appliance.techpreview.networking.ipv4.I_pv4_config_read_only',
            {
                'interface_name' => VAPI::Bindings::StringType.instance,
                'mode' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Networking::Ipv4::IPv4Mode'),
                'address' => VAPI::Bindings::StringType.instance,
                'prefix' => VAPI::Bindings::IntegerType.instance,
                'default_gateway' => VAPI::Bindings::StringType.instance,
                'updateable' => VAPI::Bindings::BooleanType.instance,
            },
            IPv4ConfigReadOnly,
            false,
            nil)
    end