Class: Com::Vmware::Vcenter::Vm::Hardware::Boot::Device

Inherits:
VAPI::Bindings::VapiService
  • Object
show all
Defined in:
/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware/boot.rb

Overview

The ``Com::Vmware::Vcenter::Vm::Hardware::Boot::Device`` class provides methods for configuring the device order used when booting a virtual machine. 


 The boot order may be specified using a mixture of device classes and device instances, chosen from among the following:  

  *  :attr:`Com::Vmware::Vcenter::Vm::Hardware::Boot::Device::Type.CDROM`  : Boot from a virtual CD-ROM drive; the device instance(s) will be chosen by the BIOS subsystem.
   *  :attr:`Com::Vmware::Vcenter::Vm::Hardware::Boot::Device::Type.FLOPPY`  : Boot from a virtual floppy drive; the device instance(s) will be chosen by the BIOS subsystem.
   *  :attr:`Com::Vmware::Vcenter::Vm::Hardware::Boot::Device::Type.DISK`  : Boot from a virtual disk device; the device instance is specified explicitly in   :attr:`Com::Vmware::Vcenter::Vm::Hardware::Boot::Device::Entry.disks`   list, and multiple instances may be specified in the list.
   *  :attr:`Com::Vmware::Vcenter::Vm::Hardware::Boot::Device::Type.ETHERNET`  : Boot from a virtual Ethernet adapter; the device instance is specified explicitly as   :attr:`Com::Vmware::Vcenter::Vm::Hardware::Boot::Device::Entry.nic`  , and multiple adapters may be specified in the boot order list.

Defined Under Namespace

Classes: Entry, EntryCreateSpec, Type

Instance Method Summary (collapse)

Constructor Details

- (Device) initialize(config)

Constructs a new instance.

Parameters:

  • config (VAPI::Bindings::StubConfig) —

    A hash with the api provider details. 



90
91
92
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware/boot.rb', line 90

def initialize(config)
    super(config, @@service_info)
end

Instance Method Details

- (Array<Com::Vmware::Vcenter::Vm::Hardware::Boot::Device::Entry>) get(vm)

Returns an ordered list of boot devices for the virtual machine. If the list is empty, the virtual machine uses a default boot sequence.

Parameters:

  • vm (String) —

    Virtual machine identifier.

Returns:

Raises:



113
114
115
116
117
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware/boot.rb', line 113

def get(vm)
    invoke_with_info(@@get_info, {
        'vm' => vm,
    })
end

- (Void) set(vm, devices)

Sets the virtual devices that will be used to boot the virtual machine. The virtual machine will check the devices in order, attempting to boot from each, until the virtual machine boots successfully. If the list is empty, the virtual machine will use a default boot sequence. There should be no more than one instance of :class:`Com::Vmware::Vcenter::Vm::Hardware::Boot::Device::Entry` for a given device type except :attr:`Com::Vmware::Vcenter::Vm::Hardware::Boot::Device::Type.ETHERNET` in the list .

Parameters:

Returns:

  • (Void)

Raises:



143
144
145
146
147
148
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware/boot.rb', line 143

def set(vm, devices)
    invoke_with_info(@@set_info, {
        'vm' => vm,
        'devices' => devices,
    })
end