This API has a deprecated equivalent from v7.0U1.
Get Guest Power
Returns 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, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
VmGuestPowerInfo
of type application/json
Guest OS powerstate information.
{
"operations_ready": false,
"state": "RUNNING"
}
boolean
operations_ready
Required
Flag indicating if the virtual machine is ready to process soft power operations.
state
Required
Possible guest power states.
RUNNING : The guest OS is running.
SHUTTING_DOWN : The guest OS is shutting down
RESETTING : The guest OS is resetting
STANDBY : The guest OS is in standby.
NOT_RUNNING : The guest OS is not running.
UNAVAILABLE : The guest OS power state is unknown.
Possible values are: RUNNING , SHUTTING_DOWN , RESETTING , STANDBY , NOT_RUNNING
Errors
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetVmGuestPower -Vm "MyVm"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/vm/{vm}/guest/power
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/vcenter/vm/{vm}/guest/power
x-vmw-doc-operation: get
Availability
Added in 7.0U2
