Developer Documentation
Reboot Guest Power
Released in v6.7Issues a request to the guest operating system asking it to perform a reboot. This request returns immediately and does not wait for the guest operating system to complete the operation.
Request
URLURL
https://{api_host}/rest/vcenter/vm/{vm}/guest/power?action=reboot
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine. |
Query Parameters
Query Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | action=reboot |
Errors
| Code | Returns | Description |
|---|---|---|
| default | Error | Not available |
| 404 | Error | 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. |
| 405 | Error | com.vmware.vapi.std.errors.unsupported : if the virtual machine does not support being powered on (e.g. marked as a template, serving as a fault-tolerance secondary virtual machine). |
| 409 | Error | com.vmware.vapi.std.errors.not_allowed_in_current_state : if the virtual machine is not powered on. | com.vmware.vapi.std.errors.resource_busy : if the virtual machine is performing another operation. |
| 503 | Error | com.vmware.vapi.std.errors.service_unavailable : if VMware Tools is not running. |
