This API has a deprecated equivalent from v7.0U1.
Get Shutdown
Get details about the pending shutdown action.
Request
URLURL
https://{api_host}/api/appliance/shutdown
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
b00db39f948d13ea1e59b4d6fce56389Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
ShutdownShutdownConfig of type application/json
Configuration of pending shutdown action.
{
"action": "string",
"reason": "string",
"shutdown_time": "string"
}
string
action
Required
The pending shutdown operation. The string values for pending operations can be ‘poweroff’, ‘reboot’ or “.
string
reason
Required
The reason behind the shutdown action
string
shutdown_time
Optional
Shutdown time. shutdownTime Optional value of pending shutdown time
PowerCLI Client SDK Example
Invoke-GetShutdown
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/appliance/shutdown
Errors
Availability
Added in 7.0U2
