Set Hardware Boot Device
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Sets the virtual devices that will be used to boot the virtual machine. The virtual machine will check the devices in order, attempting to boot from each, until the virtual machine boots successfully. If the list is empty, the virtual machine will use a default boot sequence. There should be no more than one instance of Device.Entry for a given device type except ETHERNET in the list.
Request
URLURL
https://{api_host}/rest/vcenter/vm/{vm}/hardware/boot/device
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine. |
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Request Body
Request Body
Contains VmHardwareBootDeviceSetRequestBody
of type application/json
(required)
{
"devices": [
{
"type": "enum"
}
]
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | devices | array of VmHardwareBootDeviceEntry |
Ordered list of boot devices. |
cURL Command
curl -X PUT -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"devices":[{"disks":["string"],"nic":"string","type":"enum"}]}' https://{api_host}/rest/vcenter/vm/{vm}/hardware/boot/device
Errors
| Code | Returns | Description |
|---|---|---|
| 400 | ErrorRest | com.vmware.vapi.std.errors.invalid_argument : if a any of the Device.Type values appears in more than one Device.Entry with the exception of ETHERNET, which may appear multiple times if the virtual machine has been configured with multiple Ethernet adapters. |
| 401 | ErrorRest | com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated. | com.vmware.vapi.std.errors.unauthorized : if the user doesn't have the required privileges. |
| 404 | ErrorRest | com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.not_found : if the virtual machine is not found, or if any of the specified virtual devices is not found. | com.vmware.vapi.std.errors.resource_inaccessible : if the virtual machine's configuration state cannot be accessed. |
| 409 | ErrorRest | com.vmware.vapi.std.errors.resource_busy : if the virtual machine is busy performing another operation. |
| 503 | ErrorRest | com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request. |
| default | ErrorRest | Not available |
