Class List Method List File List

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

Inherits:
  VAPI::Bindings::VapiService
  - Object
  - VAPI::Bindings::VapiService
  - Com::Vmware::Vcenter::Vm::Hardware::Boot::Device
  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)

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

  Returns an ordered list of boot devices for the virtual machine.

- - (Device) initialize(config) constructor

  Constructs a new instance.

- - (Void) set(vm, devices)

  Sets the virtual devices that will be used to boot the virtual machine.

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

- (`Array<Com::Vmware::Vcenter::Vm::Hardware::Boot::Device::Entry>`) —

  Ordered list of configured boot devices.

Raises:

- (`Com::Vmware::Vapi::Std::Errors::Error`) —

  if the system reports an error while responding to the request.

- (`Com::Vmware::Vapi::Std::Errors::NotFound`) —

  if the virtual machine is not found.

- (`Com::Vmware::Vapi::Std::Errors::ResourceInaccessible`) —

  if the virtual machine’s configuration state cannot be accessed.

- (`Com::Vmware::Vapi::Std::Errors::ServiceUnavailable`) —

  if the system is unable to communicate with a service to complete the request.

- (`Com::Vmware::Vapi::Std::Errors::Unauthenticated`) —

  if the user can not be authenticated.

- (`Com::Vmware::Vapi::Std::Errors::Unauthorized`) —

  if the user doesn’t have the required privileges.

    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:

- vm (`String`) —

  Virtual machine identifier.

- devices (`Array<Com::Vmware::Vcenter::Vm::Hardware::Boot::Device::Entry>`) —

  Ordered list of boot devices.

Returns:

- (`Void`)

Raises:

- (`Com::Vmware::Vapi::Std::Errors::Error`) —

  if the system reports an error while responding to the request.

- (`Com::Vmware::Vapi::Std::Errors::NotFound`) —

  if the virtual machine is not found, or if any of the specified virtual devices is not found.

- (`Com::Vmware::Vapi::Std::Errors::InvalidArgument`) —

  if a any of the ``CDROM``, ``DISK``, ``ETHERNET``, ``FLOPPY`` values appears in more than one ``Com::Vmware::Vcenter::Vm::Hardware::Boot::Device::Entry`` with the exception of :attr:`Com::Vmware::Vcenter::Vm::Hardware::Boot::Device::Type.ETHERNET` , which may appear multiple times if the virtual machine has been configured with multiple Ethernet adapters.

- (`Com::Vmware::Vapi::Std::Errors::ResourceBusy`) —

  if the virtual machine is busy performing another operation.

- (`Com::Vmware::Vapi::Std::Errors::ResourceInaccessible`) —

  if the virtual machine’s configuration state cannot be accessed.

- (`Com::Vmware::Vapi::Std::Errors::ServiceUnavailable`) —

  if the system is unable to communicate with a service to complete the request.

- (`Com::Vmware::Vapi::Std::Errors::Unauthenticated`) —

  if the user can not be authenticated.

- (`Com::Vmware::Vapi::Std::Errors::Unauthorized`) —

  if the user doesn’t have the required privileges.

    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