Data Object - VirtualMachineBootOptions(vim.vm.BootOptions)

Property of
VirtualMachineConfigInfo, VirtualMachineConfigSpec
See also
VI API 2.5

Data Object Description

The VirtualMachineBootOptions data object defines the boot-time behavior of a virtual machine.

You can use the delay options to specify a time interval during which you can enter the virtual machine BIOS setup. These options provide a solution for the situation that occurs when the console attaches to the virtual machine after the boot sequence has passed the BIOS setup entry point.


Name Type Description

Delay in milliseconds before starting the boot sequence. The boot delay specifies a time interval between virtual machine power on or restart and the beginning of the boot sequence.

Boot order. Listed devices are used for booting. After list is exhausted, default BIOS boot device algorithm is used for booting. Note that order of the entries in the list is important: device listed first is used for boot first, if that one fails second entry is used, and so on. Platform may have some internal limit on the number of devices it supports. If bootable device is not reached before platform's limit is hit, boot will fail. At least single entry is supported by all products supporting boot order settings.

Since vSphere API 5.0

Delay in milliseconds before a boot retry. The boot retry delay specifies a time interval between virtual machine boot failure and the subsequent attempt to boot again. The virtual machine uses this value only if bootRetryEnabled is true.

Since vSphere API 4.1

If set to true, a virtual machine that fails to boot will try again after the bootRetryDelay time period has expired. When false, the virtual machine waits indefinitely for you to initiate boot retry.

Since vSphere API 4.1

If set to true, the virtual machine's firmware will perform signature checks of any EFI images loaded during startup, and will refuse to start any images which do not pass those signature checks. When creating a new VM: - If vim.vm.FlagInfo.vbsEnabled is set to true, and this flag is set to false error is returned. - If this flag is unset and vim.vm.FlagInfo.vbsEnabled is set to true, the value of this flag is set to true.

Since vSphere API 6.5

If set to true, the virtual machine automatically enters BIOS setup the next time it boots. The virtual machine resets this flag to false so that subsequent boots proceed normally.

Protocol to attempt during PXE network boot or NetBoot.
See VirtualMachineBootOptionsNetworkBootProtocolType

Since vSphere API 6.0
Properties inherited from DynamicData
*Need not be set
Show WSDL type definition