This API has a deprecated equivalent from v7.0U1.
Reboot Shutdown
DescriptionReboot the appliance.
Request
URLURL
https://{api_host}/api/appliance/shutdown?action=reboot
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"
Request Body
Request Body
ShutdownRebootRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"delay": 0,
"reason": "string"
}
integer
delay
Required
Minutes after which reboot should start. If 0 is specified, reboot will start immediately.
string
reason
Required
Reason for peforming reboot.
Authentication
This operation uses the following authentication methods.
Errors
Errors
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
$ShutdownRebootRequestBody = Initialize-ShutdownRebootRequestBody -Delay 0 -Reason "MyReason"
Invoke-RebootShutdown -ShutdownRebootRequestBody $ShutdownRebootRequestBody
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"delay":0,"reason":"string"}' https://{api_host}/api/appliance/shutdown?action=reboot
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/appliance/shutdown/reboot
x-vmw-doc-operation: reboot
Availability
Added in 7.0U2
