Class List Method List File List

# Class: Com::Vmware::Appliance::Techpreview::Networking::Ipv6::IPv6ConfigReadOnly

Inherits:
  VAPI::Bindings::VapiStruct
  - Object
  - VAPI::Bindings::VapiStruct
  - Com::Vmware::Appliance::Techpreview::Networking::Ipv6::IPv6ConfigReadOnly
  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::Ipv6::IPv6ConfigReadOnly`` class Structure that defines an existing IPv6 configuration on a particular interface. This structure is read only.

## Instance Attribute Summary (collapse)

- - (Array<Com::Vmware::Appliance::Techpreview::Networking::Ipv6::IPv6AddressReadOnly>) addresses

  A list of all addresses assigned to this interface.

- - (Boolean) autoconf

  Address is assigned by Stateless Address Autoconfiguration (SLAAC).

- - (String) default_gateway

  Default gateway.

- - (Boolean) dhcp

  Address assigned by a DHCP server.

- - (String) interface_name

  Network interface, for example, “nic0” queried.

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

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

  Constructs a new instance.

## Constructor Details

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

    530
    531
    532
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 530

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

## Instance Attribute Details

### - (`Array<Com::Vmware::Appliance::Techpreview::Networking::Ipv6::IPv6AddressReadOnly>`) addresses

A list of all addresses assigned to this interface. The origin field of each address determines how the address was assigned, for example, statically, by DHCP, SLAAC.

Returns:

- (`Array<Com::Vmware::Appliance::Techpreview::Networking::Ipv6::IPv6AddressReadOnly>`)

    497
    498
    499
    500
    501
    502
    503
    504
    505
    506
    507
    508
    509
    510
    511
    512
    513
    514
    515
    516
    517
    518
    519
    520
    521
    522
    523
    524
    525
    526
    527
    528
    529
    530
    531
    532
    533
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 497

    class IPv6ConfigReadOnly < 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.ipv6.I_pv6_config_read_only',
                    {
                        'interface_name' => VAPI::Bindings::StringType.instance,
                        'dhcp' => VAPI::Bindings::BooleanType.instance,
                        'autoconf' => VAPI::Bindings::BooleanType.instance,
                        'addresses' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Networking::Ipv6::IPv6AddressReadOnly')),
                        'default_gateway' => VAPI::Bindings::StringType.instance,
                        'updateable' => VAPI::Bindings::BooleanType.instance,
                    },
                    IPv6ConfigReadOnly,
                    false,
                    nil)
            end
        end

        attr_accessor :interface_name,
                      :dhcp,
                      :autoconf,
                      :addresses,
                      :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`) autoconf

Address is assigned by Stateless Address Autoconfiguration (SLAAC).

Returns:

- (`Boolean`)

    497
    498
    499
    500
    501
    502
    503
    504
    505
    506
    507
    508
    509
    510
    511
    512
    513
    514
    515
    516
    517
    518
    519
    520
    521
    522
    523
    524
    525
    526
    527
    528
    529
    530
    531
    532
    533
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 497

    class IPv6ConfigReadOnly < 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.ipv6.I_pv6_config_read_only',
                    {
                        'interface_name' => VAPI::Bindings::StringType.instance,
                        'dhcp' => VAPI::Bindings::BooleanType.instance,
                        'autoconf' => VAPI::Bindings::BooleanType.instance,
                        'addresses' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Networking::Ipv6::IPv6AddressReadOnly')),
                        'default_gateway' => VAPI::Bindings::StringType.instance,
                        'updateable' => VAPI::Bindings::BooleanType.instance,
                    },
                    IPv6ConfigReadOnly,
                    false,
                    nil)
            end
        end

        attr_accessor :interface_name,
                      :dhcp,
                      :autoconf,
                      :addresses,
                      :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

Default gateway. This configures the global IPv6 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`)

    497
    498
    499
    500
    501
    502
    503
    504
    505
    506
    507
    508
    509
    510
    511
    512
    513
    514
    515
    516
    517
    518
    519
    520
    521
    522
    523
    524
    525
    526
    527
    528
    529
    530
    531
    532
    533
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 497

    class IPv6ConfigReadOnly < 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.ipv6.I_pv6_config_read_only',
                    {
                        'interface_name' => VAPI::Bindings::StringType.instance,
                        'dhcp' => VAPI::Bindings::BooleanType.instance,
                        'autoconf' => VAPI::Bindings::BooleanType.instance,
                        'addresses' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Networking::Ipv6::IPv6AddressReadOnly')),
                        'default_gateway' => VAPI::Bindings::StringType.instance,
                        'updateable' => VAPI::Bindings::BooleanType.instance,
                    },
                    IPv6ConfigReadOnly,
                    false,
                    nil)
            end
        end

        attr_accessor :interface_name,
                      :dhcp,
                      :autoconf,
                      :addresses,
                      :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`) dhcp

Address assigned by a DHCP server.

Returns:

- (`Boolean`)

    497
    498
    499
    500
    501
    502
    503
    504
    505
    506
    507
    508
    509
    510
    511
    512
    513
    514
    515
    516
    517
    518
    519
    520
    521
    522
    523
    524
    525
    526
    527
    528
    529
    530
    531
    532
    533
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 497

    class IPv6ConfigReadOnly < 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.ipv6.I_pv6_config_read_only',
                    {
                        'interface_name' => VAPI::Bindings::StringType.instance,
                        'dhcp' => VAPI::Bindings::BooleanType.instance,
                        'autoconf' => VAPI::Bindings::BooleanType.instance,
                        'addresses' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Networking::Ipv6::IPv6AddressReadOnly')),
                        'default_gateway' => VAPI::Bindings::StringType.instance,
                        'updateable' => VAPI::Bindings::BooleanType.instance,
                    },
                    IPv6ConfigReadOnly,
                    false,
                    nil)
            end
        end

        attr_accessor :interface_name,
                      :dhcp,
                      :autoconf,
                      :addresses,
                      :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

Network interface, for example, “nic0” queried.

Returns:

- (`String`)

    497
    498
    499
    500
    501
    502
    503
    504
    505
    506
    507
    508
    509
    510
    511
    512
    513
    514
    515
    516
    517
    518
    519
    520
    521
    522
    523
    524
    525
    526
    527
    528
    529
    530
    531
    532
    533
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 497

    class IPv6ConfigReadOnly < 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.ipv6.I_pv6_config_read_only',
                    {
                        'interface_name' => VAPI::Bindings::StringType.instance,
                        'dhcp' => VAPI::Bindings::BooleanType.instance,
                        'autoconf' => VAPI::Bindings::BooleanType.instance,
                        'addresses' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Networking::Ipv6::IPv6AddressReadOnly')),
                        'default_gateway' => VAPI::Bindings::StringType.instance,
                        'updateable' => VAPI::Bindings::BooleanType.instance,
                    },
                    IPv6ConfigReadOnly,
                    false,
                    nil)
            end
        end

        attr_accessor :interface_name,
                      :dhcp,
                      :autoconf,
                      :addresses,
                      :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`)

    497
    498
    499
    500
    501
    502
    503
    504
    505
    506
    507
    508
    509
    510
    511
    512
    513
    514
    515
    516
    517
    518
    519
    520
    521
    522
    523
    524
    525
    526
    527
    528
    529
    530
    531
    532
    533
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 497

    class IPv6ConfigReadOnly < 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.ipv6.I_pv6_config_read_only',
                    {
                        'interface_name' => VAPI::Bindings::StringType.instance,
                        'dhcp' => VAPI::Bindings::BooleanType.instance,
                        'autoconf' => VAPI::Bindings::BooleanType.instance,
                        'addresses' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Networking::Ipv6::IPv6AddressReadOnly')),
                        'default_gateway' => VAPI::Bindings::StringType.instance,
                        'updateable' => VAPI::Bindings::BooleanType.instance,
                    },
                    IPv6ConfigReadOnly,
                    false,
                    nil)
            end
        end

        attr_accessor :interface_name,
                      :dhcp,
                      :autoconf,
                      :addresses,
                      :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

    503
    504
    505
    506
    507
    508
    509
    510
    511
    512
    513
    514
    515
    516
    517
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 503

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.appliance.techpreview.networking.ipv6.I_pv6_config_read_only',
            {
                'interface_name' => VAPI::Bindings::StringType.instance,
                'dhcp' => VAPI::Bindings::BooleanType.instance,
                'autoconf' => VAPI::Bindings::BooleanType.instance,
                'addresses' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Networking::Ipv6::IPv6AddressReadOnly')),
                'default_gateway' => VAPI::Bindings::StringType.instance,
                'updateable' => VAPI::Bindings::BooleanType.instance,
            },
            IPv6ConfigReadOnly,
            false,
            nil)
    end