Class: Com::Vmware::Vcenter::Vm::Hardware::BootService::CreateSpec

Inherits:
VAPI::Bindings::VapiStruct
  • Object
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::Boot::CreateSpec`` class describes settings used when booting a virtual machine.

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

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



271
272
273
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 271

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

Instance Attribute Details

- (Fixnum?) delay

Delay in milliseconds before beginning the firmware boot process when the virtual machine is powered on. This delay may be used to provide a time window for users to connect to the virtual machine console and enter BIOS setup mode. If nil , default value is 0.

Returns:

  • (Fixnum, nil) 


236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 236

class CreateSpec < 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.boot.create_spec',
                {
                    'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Boot::Type')),
                    'efi_legacy_boot' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    'network_protocol' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Boot::NetworkProtocol')),
                    'delay' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    'retry' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    'retry_delay' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    'enter_setup_mode' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                },
                CreateSpec,
                false,
                nil)
        end
    end

    attr_accessor :type,
                  :efi_legacy_boot,
                  :network_protocol,
                  :delay,
                  :retry_,
                  :retry_delay,
                  :enter_setup_mode

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

Flag indicating whether to use EFI legacy boot mode. If nil , defaults to value that is recommended for the guest OS and is supported for the virtual hardware version.

Returns:

  • (Boolean, nil) 


236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 236

class CreateSpec < 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.boot.create_spec',
                {
                    'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Boot::Type')),
                    'efi_legacy_boot' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    'network_protocol' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Boot::NetworkProtocol')),
                    'delay' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    'retry' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    'retry_delay' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    'enter_setup_mode' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                },
                CreateSpec,
                false,
                nil)
        end
    end

    attr_accessor :type,
                  :efi_legacy_boot,
                  :network_protocol,
                  :delay,
                  :retry_,
                  :retry_delay,
                  :enter_setup_mode

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

Flag indicating whether the firmware boot process should automatically enter setup mode the next time the virtual machine boots. Note that this flag will automatically be reset to false once the virtual machine enters setup mode. If nil , the value is unchanged.

Returns:

  • (Boolean, nil) 


236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 236

class CreateSpec < 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.boot.create_spec',
                {
                    'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Boot::Type')),
                    'efi_legacy_boot' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    'network_protocol' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Boot::NetworkProtocol')),
                    'delay' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    'retry' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    'retry_delay' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    'enter_setup_mode' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                },
                CreateSpec,
                false,
                nil)
        end
    end

    attr_accessor :type,
                  :efi_legacy_boot,
                  :network_protocol,
                  :delay,
                  :retry_,
                  :retry_delay,
                  :enter_setup_mode

    # 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::Boot::NetworkProtocol?) network_protocol

Protocol to use when attempting to boot the virtual machine over the network. If nil , defaults to a system defined default value.

Returns:

  • (Com::Vmware::Vcenter::Vm::Hardware::Boot::NetworkProtocol, nil) 


236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 236

class CreateSpec < 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.boot.create_spec',
                {
                    'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Boot::Type')),
                    'efi_legacy_boot' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    'network_protocol' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Boot::NetworkProtocol')),
                    'delay' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    'retry' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    'retry_delay' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    'enter_setup_mode' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                },
                CreateSpec,
                false,
                nil)
        end
    end

    attr_accessor :type,
                  :efi_legacy_boot,
                  :network_protocol,
                  :delay,
                  :retry_,
                  :retry_delay,
                  :enter_setup_mode

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

Flag indicating whether the virtual machine should automatically retry the boot process after a failure. If nil , default value is false.

Returns:

  • (Boolean, nil) 


236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 236

class CreateSpec < 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.boot.create_spec',
                {
                    'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Boot::Type')),
                    'efi_legacy_boot' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    'network_protocol' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Boot::NetworkProtocol')),
                    'delay' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    'retry' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    'retry_delay' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    'enter_setup_mode' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                },
                CreateSpec,
                false,
                nil)
        end
    end

    attr_accessor :type,
                  :efi_legacy_boot,
                  :network_protocol,
                  :delay,
                  :retry_,
                  :retry_delay,
                  :enter_setup_mode

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

Delay in milliseconds before retrying the boot process after a failure; applicable only when :attr:`Com::Vmware::Vcenter::Vm::Hardware::Boot::Info.retry_` is true. If nil , default value is 10000.

Returns:

  • (Fixnum, nil) 


236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 236

class CreateSpec < 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.boot.create_spec',
                {
                    'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Boot::Type')),
                    'efi_legacy_boot' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    'network_protocol' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Boot::NetworkProtocol')),
                    'delay' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    'retry' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    'retry_delay' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    'enter_setup_mode' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                },
                CreateSpec,
                false,
                nil)
        end
    end

    attr_accessor :type,
                  :efi_legacy_boot,
                  :network_protocol,
                  :delay,
                  :retry_,
                  :retry_delay,
                  :enter_setup_mode

    # 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::Boot::Type?) type

Firmware type to be used by the virtual machine. If nil , defaults to value that is recommended for the guest OS and is supported for the virtual hardware version.

Returns:

  • (Com::Vmware::Vcenter::Vm::Hardware::Boot::Type, nil) 


236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 236

class CreateSpec < 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.boot.create_spec',
                {
                    'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Boot::Type')),
                    'efi_legacy_boot' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    'network_protocol' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Boot::NetworkProtocol')),
                    'delay' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    'retry' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    'retry_delay' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    'enter_setup_mode' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                },
                CreateSpec,
                false,
                nil)
        end
    end

    attr_accessor :type,
                  :efi_legacy_boot,
                  :network_protocol,
                  :delay,
                  :retry_,
                  :retry_delay,
                  :enter_setup_mode

    # 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 



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 242

def binding_type
    @binding_type ||= VAPI::Bindings::StructType.new(
        'com.vmware.vcenter.vm.hardware.boot.create_spec',
        {
            'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Boot::Type')),
            'efi_legacy_boot' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
            'network_protocol' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Boot::NetworkProtocol')),
            'delay' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
            'retry' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
            'retry_delay' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
            'enter_setup_mode' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
        },
        CreateSpec,
        false,
        nil)
end