This API has a deprecated equivalent from v7.0U1.
Set Hardware Boot Device
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}/api/vcenter/vm/{vm}/hardware/boot/device
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
VmHardwareBootDeviceSetRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"devices": [
{
"type": "CDROM"
}
]
}
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
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.
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have the required privileges.
404
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.
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.
Code Samples
PowerCLI Client SDK Example
$VmHardwareBootDeviceEntry = Initialize-VmHardwareBootDeviceEntry -Type "CDROM"
$VmHardwareBootDeviceSetRequestBody = Initialize-VmHardwareBootDeviceSetRequestBody -Devices $VmHardwareBootDeviceEntry
Invoke-SetVmHardwareBootDevice -Vm "MyVm" -VmHardwareBootDeviceSetRequestBody $VmHardwareBootDeviceSetRequestBody
PowerCLI Client SDK All Parameters Example
$VmHardwareBootDeviceEntry = Initialize-VmHardwareBootDeviceEntry -Type "CDROM" -Nic "MyNic" -Disks "MyDisks"
$VmHardwareBootDeviceSetRequestBody = Initialize-VmHardwareBootDeviceSetRequestBody -Devices $VmHardwareBootDeviceEntry
Invoke-SetVmHardwareBootDevice -Vm "MyVm" -VmHardwareBootDeviceSetRequestBody $VmHardwareBootDeviceSetRequestBody
cURL Command
curl -X PUT -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"devices":[{"disks":["string"],"nic":"string","type":"CDROM"}]}' https://{api_host}/api/vcenter/vm/{vm}/hardware/boot/device
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: put
x-vmw-doc-deprecated-path: /rest/vcenter/vm/{vm}/hardware/boot/device
x-vmw-doc-operation: set
Availability
Added in 7.0U2
