Developer Documentation
Get Power
Returns the power state information of a virtual machine. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires System.Read.
Request
URLURL
https://{api_host}/rest/vcenter/vm/{vm}/power
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. |
Response
Response
Response BodyResponse Body
200 OK returns
GetResponseBody
of type application/json
This structure was autogenerated to hold a response body. It contains: Power state information for the specified virtual machine.
{
"value": {
"clean_power_off": false,
"state": "enum"
}
}| Property Name | Type | Description |
|---|---|---|
| value | PowerInfo |
Power state information for the specified virtual machine. |
Errors
| Code | Returns | Description |
|---|---|---|
| 401 | Error | 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 | 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. | com.vmware.vapi.std.errors.resource_inaccessible : if the virtual machine's configuration or execution state cannot be accessed. |
| 503 | Error | com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request. |
| default | Error | Not available |
