Get Hardware Boot
DescriptionReturns the boot-related settings of a virtual machine.
Request
URLURL
https://{api_host}/rest/vcenter/vm/{vm}/hardware/boot
Parameters
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
Response
Response
Response BodyResponse Body
200 OK returns
VmHardwareBootGetResponseBody
of type application/json
Boot-related settings of the virtual machine.
{
"value": {
"delay": 0,
"efi_legacy_boot": false,
"enter_setup_mode": false,
"network_protocol": "enum",
"retry": false,
"retry_delay": 0,
"type": "enum"
}
}
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/vcenter/vm/{vm}/hardware/boot
Errors
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_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.
Hardware Boot Operations
patch