Failover Cluster Manager Initiate Failover Task
Allows a caller to initiate a failover from Active vCenter Server node to the Passive node.
By default it is a forced failover. The planned flag can be used to initiate it as a planned failover. For forced failover, Active node immediately initiates a failover. This may result into a data loss after failover. For planned failover, Active node flushes all the state to the Passive node, waits for the flush to complete before causing a failover. After the failover, Passive node starts without any data loss. A failover is allowed only in the following cases - 1. Cluster's mode is enabled and all cluster members are present. 2. Cluster's mode is maintenance and all cluster members are present. API throws an exception in all other cases.
Required privileges: Global.VCServer
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 FailoverClusterManager/{moId}.
The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.
{
"planned": false
}- if false, a failover is initiated immediate and may result in data loss. if true, a failover is initated after the Active node flushes its state to Passive and there is no data loss.
OK
{
"_typeName": "string",
"type": "string",
"value": "string"
}