Get Hardware Boot Device
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Returns an ordered list of boot devices for the virtual machine. If the list is empty, the virtual machine uses a default boot sequence.
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 |
Response
Response
Response BodyResponse Body
200 OK returns
VmHardwareBootDeviceGetResponseBody
of type application/json
Ordered list of configured boot devices.
{
"value": [
{
"disks": [
"string"
],
"nic": "string",
"type": "enum"
}
]
}| Property Name | Type | Description |
|---|---|---|
| value | array of VmHardwareBootDeviceEntry |
Ordered list of configured boot devices. |
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/vcenter/vm/{vm}/hardware/boot/device
Errors
| Code | Returns | Description |
|---|---|---|
| 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. | com.vmware.vapi.std.errors.resource_inaccessible : if the virtual machine's configuration state cannot be accessed. |
| 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 |
