This API has a deprecated equivalent from v7.0U1.
Update Hardware Boot
Updates the boot-related settings of a virtual machine.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/hardware/boot
Path Parameters
Path Parameters
string
vm
Required
Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
VmHardwareBootUpdateSpec of mimetype application/json
Required
Specification for updating the boot-related settings of the virtual machine.
{
"delay": 0,
"efi_legacy_boot": false,
"enter_setup_mode": false,
"network_protocol": "IPV4",
"retry": false,
"retry_delay": 0,
"type": "BIOS"
}
integer
delay
Optional
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.
boolean
efi_legacy_boot
Optional
Flag indicating whether to use EFI legacy boot mode. If unset, the value is unchanged.
boolean
enter_setup_mode
Optional
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.
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: IPV4 , IPV6
boolean
retry
Optional
Flag indicating whether the virtual machine should automatically retry the boot process after a failure. If unset, the value is unchanged.
integer
retry_delay
Optional
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.
type
Optional
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: BIOS , EFI
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if one of the provided settings is not permitted; for example, specifying a negative value for Boot.UpdateSpec.delay.
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have the required privileges.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.resource_busy : if the virtual machine is busy performing another operation. | com.vmware.vapi.std.errors.resource_inaccessible : if the virtual machine’s configuration state cannot be accessed.
503
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$VmHardwareBootUpdateSpec = Initialize-VmHardwareBootUpdateSpec -Type "BIOS" -EfiLegacyBoot $false -NetworkProtocol "IPV4" -Delay 0 -Retry $false -RetryDelay 0 -EnterSetupMode $false
Invoke-UpdateVmHardwareBoot -Vm "MyVm" -VmHardwareBootUpdateSpec $VmHardwareBootUpdateSpec
cURL Command
curl -X PATCH -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"delay":0,"efi_legacy_boot":false,"enter_setup_mode":false,"network_protocol":"IPV4","retry":false,"retry_delay":0,"type":"BIOS"}' https://{api_host}/api/vcenter/vm/{vm}/hardware/boot
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: patch
x-vmw-doc-deprecated-path: /rest/vcenter/vm/{vm}/hardware/boot
x-vmw-doc-operation: update
Availability
Added in 7.0U2
On This Page
Hardware Boot Operations
patch
