VmHardwareBootInfo

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


Properties

Required Property Name Type Description
required delay integer

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.

optional efi_legacy_boot boolean

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.

required enter_setup_mode boolean

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.

optional network_protocol VmHardwareBootNetworkProtocol Enum

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 Boot.Info.type is EFI.

required retry boolean

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

required retry_delay integer

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

required type VmHardwareBootType Enum

Firmware type used by the virtual machine.

JSON Example

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

Was this page helpful?