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

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::Info`` class contains information about the virtual machine boot process.

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

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



201
202
203
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 201

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.

Returns:

  • (Fixnum) 


166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 166

class Info < 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.info',
                {
                    'type' => 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::IntegerType.instance,
                    'retry' => VAPI::Bindings::BooleanType.instance,
                    'retry_delay' => VAPI::Bindings::IntegerType.instance,
                    'enter_setup_mode' => VAPI::Bindings::BooleanType.instance,
                },
                Info,
                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. This field is optional and it is only relevant when the value of ``type`` is :attr:`Com::Vmware::Vcenter::Vm::Hardware::Boot::Type.EFI` .

Returns:

  • (Boolean) 


166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 166

class Info < 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.info',
                {
                    'type' => 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::IntegerType.instance,
                    'retry' => VAPI::Bindings::BooleanType.instance,
                    'retry_delay' => VAPI::Bindings::IntegerType.instance,
                    'enter_setup_mode' => VAPI::Bindings::BooleanType.instance,
                },
                Info,
                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 will 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.

Returns:

  • (Boolean) 


166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 166

class Info < 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.info',
                {
                    'type' => 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::IntegerType.instance,
                    'retry' => VAPI::Bindings::BooleanType.instance,
                    'retry_delay' => VAPI::Bindings::IntegerType.instance,
                    'enter_setup_mode' => VAPI::Bindings::BooleanType.instance,
                },
                Info,
                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. This field is optional and it is only relevant when the value of ``type`` is :attr:`Com::Vmware::Vcenter::Vm::Hardware::Boot::Type.EFI` .

Returns:

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


166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 166

class Info < 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.info',
                {
                    'type' => 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::IntegerType.instance,
                    'retry' => VAPI::Bindings::BooleanType.instance,
                    'retry_delay' => VAPI::Bindings::IntegerType.instance,
                    'enter_setup_mode' => VAPI::Bindings::BooleanType.instance,
                },
                Info,
                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 will automatically retry the boot process after a failure.

Returns:

  • (Boolean) 


166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 166

class Info < 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.info',
                {
                    'type' => 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::IntegerType.instance,
                    'retry' => VAPI::Bindings::BooleanType.instance,
                    'retry_delay' => VAPI::Bindings::IntegerType.instance,
                    'enter_setup_mode' => VAPI::Bindings::BooleanType.instance,
                },
                Info,
                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.

Returns:

  • (Fixnum) 


166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 166

class Info < 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.info',
                {
                    'type' => 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::IntegerType.instance,
                    'retry' => VAPI::Bindings::BooleanType.instance,
                    'retry_delay' => VAPI::Bindings::IntegerType.instance,
                    'enter_setup_mode' => VAPI::Bindings::BooleanType.instance,
                },
                Info,
                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 used by the virtual machine.

Returns:

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


166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 166

class Info < 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.info',
                {
                    'type' => 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::IntegerType.instance,
                    'retry' => VAPI::Bindings::BooleanType.instance,
                    'retry_delay' => VAPI::Bindings::IntegerType.instance,
                    'enter_setup_mode' => VAPI::Bindings::BooleanType.instance,
                },
                Info,
                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 



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 172

def binding_type
    @binding_type ||= VAPI::Bindings::StructType.new(
        'com.vmware.vcenter.vm.hardware.boot.info',
        {
            'type' => 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::IntegerType.instance,
            'retry' => VAPI::Bindings::BooleanType.instance,
            'retry_delay' => VAPI::Bindings::IntegerType.instance,
            'enter_setup_mode' => VAPI::Bindings::BooleanType.instance,
        },
        Info,
        false,
        nil)
end