This API has a deprecated equivalent from v7.0U1.
Get Guest Power
DescriptionReturns information about the guest operating system power state.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/guest/power
Path Parameters
Path Parameters
string
vm
Required
Identifier of the virtual machine.
The parameter must be an identifier for the resource type: VirtualMachine.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
vmware-api-session-id example
b00db39f948d13ea1e59b4d6fce56389
Response
Response
Response BodyResponse Body
200 OK returns
VmGuestPowerInfo of type application/json
Guest OS powerstate information.
{
"operations_ready": false,
"state": "enum"
}
boolean
operations_ready
Required
Flag indicating if the virtual machine is ready to process soft power operations.
state
Required
The power state of the guest operating system.
Possible values are: RUNNING , SHUTTING_DOWN , RESETTING , STANDBY , NOT_RUNNING
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/vm/{vm}/guest/power
Errors
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
Availability
Added in 7.0U2
