Class List Method List File List

# Class: Com::Vmware::Vcenter::Ovf::ExtraConfig

Inherits:
  VAPI::Bindings::VapiStruct
  - Object
  - VAPI::Bindings::VapiStruct
  - Com::Vmware::Vcenter::Ovf::ExtraConfig
  show all
Defined in:
  /build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb

## Overview

The ``Com::Vmware::Vcenter::Ovf::ExtraConfig`` class contains the information about a vmw:ExtraConfig element which can be used to specify configuration settings that are transferred directly to the ``.vmx`` file. The behavior of the vmw:ExtraConfig element is similar to the ``extraConfig`` property of the ``VirtualMachineConfigSpec`` object in the VMware vSphere API. Thus, the same restrictions apply, such as you cannot set values that could otherwise be set with other properties in the ``VirtualMachineConfigSpec`` object. See the VMware vSphere API reference for details on this.

     vmw:ExtraConfig elements may occur as direct child elements of a VirtualHardwareSection, or as child elements of individual virtual hardware items.

     See   :func:`Com::Vmware::Vcenter::Ovf::LibraryItem.deploy`   and   :func:`Com::Vmware::Vcenter::Ovf::LibraryItem.filter`  .

## Instance Attribute Summary (collapse)

- - (String) key

  The key of the ExtraConfig element.

- - (String) value

  The value of the ExtraConfig element.

- - (String) virtual_system_id

  The identifier of the virtual system containing the vmw:ExtraConfig element.

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

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

  Constructs a new instance.

## Constructor Details

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

    1229
    1230
    1231
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1229

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

## Instance Attribute Details

### - (`String`) key

The key of the ExtraConfig element. This field must be provided in the input parameters when deploying an OVF package. This field will always be present in the result when retrieving information about an OVF package.

Returns:

- (`String`)

    1202
    1203
    1204
    1205
    1206
    1207
    1208
    1209
    1210
    1211
    1212
    1213
    1214
    1215
    1216
    1217
    1218
    1219
    1220
    1221
    1222
    1223
    1224
    1225
    1226
    1227
    1228
    1229
    1230
    1231
    1232
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1202

    class ExtraConfig < 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.ovf.extra_config',
                    {
                        'key' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'value' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'virtual_system_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    },
                    ExtraConfig,
                    false,
                    nil)
            end
        end

        attr_accessor :key,
                      :value,
                      :virtual_system_id

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

The value of the ExtraConfig element. This field must be provided in the input parameters when deploying an OVF package. This field will always be present in the result when retrieving information about an OVF package.

Returns:

- (`String`)

    1202
    1203
    1204
    1205
    1206
    1207
    1208
    1209
    1210
    1211
    1212
    1213
    1214
    1215
    1216
    1217
    1218
    1219
    1220
    1221
    1222
    1223
    1224
    1225
    1226
    1227
    1228
    1229
    1230
    1231
    1232
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1202

    class ExtraConfig < 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.ovf.extra_config',
                    {
                        'key' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'value' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'virtual_system_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    },
                    ExtraConfig,
                    false,
                    nil)
            end
        end

        attr_accessor :key,
                      :value,
                      :virtual_system_id

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

The identifier of the virtual system containing the vmw:ExtraConfig element. This field is not used in the input parameters when deploying an OVF package. This field will always be present in the result when retrieving information about an OVF package.

Returns:

- (`String`)

    1202
    1203
    1204
    1205
    1206
    1207
    1208
    1209
    1210
    1211
    1212
    1213
    1214
    1215
    1216
    1217
    1218
    1219
    1220
    1221
    1222
    1223
    1224
    1225
    1226
    1227
    1228
    1229
    1230
    1231
    1232
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1202

    class ExtraConfig < 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.ovf.extra_config',
                    {
                        'key' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'value' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'virtual_system_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    },
                    ExtraConfig,
                    false,
                    nil)
            end
        end

        attr_accessor :key,
                      :value,
                      :virtual_system_id

        # 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

    1208
    1209
    1210
    1211
    1212
    1213
    1214
    1215
    1216
    1217
    1218
    1219
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1208

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.vcenter.ovf.extra_config',
            {
                'key' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                'value' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                'virtual_system_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
            },
            ExtraConfig,
            false,
            nil)
    end