VmHardwareBootUpdateSpec

The Boot.UpdateSpec structure describes the updates to the settings used when booting a virtual machine.


Properties

Required Property Name Type Description
optional 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. If unset, the value is unchanged.

optional efi_legacy_boot boolean

Flag indicating whether to use EFI legacy boot mode. If unset, the value is unchanged.

optional enter_setup_mode boolean

Flag indicating whether the firmware boot process should 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. If unset, the value is unchanged.

optional network_protocol VmHardwareBootNetworkProtocol Enum

Protocol to use when attempting to boot the virtual machine over the network. If unset, the value is unchanged.

optional retry boolean

Flag indicating whether the virtual machine should automatically retry the boot process after a failure. If unset, the value is unchanged.

optional retry_delay integer

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

optional type VmHardwareBootType Enum

Firmware type to be used by the virtual machine. If unset, the value is unchanged.

JSON Example

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

Was this page helpful?