VmHardwareBootInfo

The Boot.Info structure contains information about the virtual machine boot process.


Properties

integer as int64
delay Required

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.


boolean
efi_legacy_boot Optional

Flag indicating whether to use EFI legacy boot mode. This field is optional and it is only relevant when the value of Boot.Info.type is EFI.


boolean
enter_setup_mode Required

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.


network_protocol Optional

The Boot.NetworkProtocol enumerated type defines the valid network boot protocols supported when booting a virtual machine with EFI firmware over the network.
IPV4 : PXE or Apple NetBoot over IPv4.
IPV6 : PXE over IPv6.

Possible values are: IPV4IPV6


boolean
retry Required

Flag indicating whether the virtual machine will automatically retry the boot process after a failure.


integer as int64
retry_delay Required

Delay in milliseconds before retrying the boot process after a failure; applicable only when Boot.Info.retry is true.


type Required

The Boot.Type enumerated type defines the valid firmware types for a virtual machine.
BIOS : Basic Input/Output System (BIOS) firmware.
EFI : Extensible Firmware Interface (EFI) firmware.

Possible values are: BIOSEFI

JSON Example

{
	"delay": 0,
	"enter_setup_mode": false,
	"retry": false,
	"retry_delay": 0,
	"type": "BIOS"
}

Feedback

Was this page helpful?