Host System Shutdown Host Task
Shuts down a host.
If the command is successful, then the host has been shut down. Thus, the client never receives an indicator of success in the returned task if connected directly to the host.
This command is not supported on all hosts. Check the host capability shutdownSupported.
Required privileges: Host.Config.Maintenance
The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case HostSystem/{moId}.
The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.
{
"force": false
}Flag to specify whether or not the host should be shut down regardless of whether it is in maintenance mode. If true, the host is shut down, even if there are virtual machines running or other operations in progress.
This method returns a Task object with which to monitor the operation.
{
"_typeName": "string",
"type": "string",
"value": "string"
}InvalidState: if "force" is false and the host is not in maintenance mode.
NotSupported: if the host does not support shutdown.
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}