Host System Power Down Host To Stand By Task
Puts the host in standby mode, a mode in which the host is in a standby state from which it can be powered up remotely.
While this task is running, no virtual machines can be powered on and no provisioning operations can be performed on the host.
The task completes only if there are no powered-on virtual machines on the host, no provisioning operations in progress on the host, and the host stopped responding. The operation does not directly initiate any operations to evacuate or power-down powered-on virtual machines. However, if a dynamic recommendation generation module is running, if possible, it will provide, and depending on the automation level, it will execute migrations of powered-on virtual machine. Furthermore, VMware power management module may evacute and put a host in standby mode to save power. If the host is part of a cluster and the task is issued through VirtualCenter with evacuatePoweredOffVms set to true, the task will not succeed unless all the powered-off virtual machines are reregistered to other hosts. If VMware DRS is enabled, vCenter Server will automatically evacuate powered-off virtual machines.
The task is cancellable.
This command is not supported on all hosts. Check the host capability standbySupported.
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.
{
"timeoutSec": 0,
"evacuatePoweredOffVms": false
}
The task completes when the host successfully enters standby mode and stops sending heartbeat signals. If heartbeats are still coming after timeoutSecs seconds, the host is declared timedout, and the task is assumed failed.
This is a parameter used only by VirtualCenter. If set to true, for a DRS disabled cluster, the task will not succeed unless all powered-off virtual machines have been manually reregistered; for a DRS enabled cluster, VirtualCenter will automatically reregister powered-off virtual machines and a powered-off virtual machine may remain at the host only for two reasons: (a) no compatible host found for reregistration, (b) DRS is disabled for the virtual machine.
This method returns a Task object with which to monitor the operation.
{
"_typeName": "string",
"type": "string",
"value": "string"
}
HostPowerOpFailed: if the standby operation fails.
InvalidState: if the host is already in standby mode, or disconnected.
NotSupported: if the host does not support standby mode.
Timedout: if the host did not enter standby mode in the given time
RequestCanceled: if the operation is canceled.
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}
The base data object type for all the object model faults that an application might handle.
Message which has details about the error Message can also contain a key to message catalog which can be used to generate better localized messages.