Failover Cluster Manager Set Cluster Mode Task

Failover Cluster Manager Set Cluster Mode Task

setClusterMode method allows caller to manipulate the mode of a VCHA Cluster Following mode transitions are allowed - enabled -> disabled - Allowed only in healthy and degraded states.

enabled -> maintenance - Allowed only in healthy state. disabled -> enabled - Allowed only in healthy state. maintenance -> enabled - Allowed only in healthy state with all nodes are running the same version. maintenance -> disabled - Allowed only in healthy state with all nodes are running the same version. All other transitions are not allowed. VCHA Cluster configuration remains intact in any of the cluster modes.

Required privileges: Global.VCServer

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/FailoverClusterManager/{moId}/setClusterMode_Task
COPY
Path Parameters
string
moId
Required

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}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.

Request Body
setClusterModeRequestType of type(s) application/json
Required 
{
    "mode": "string"
}
string
mode
Required

mode

Authentication
This operation uses the following authentication methods.
Responses
200

This method returns a Task object with which to monitor the progress of the operation.

Returns MoRefTask of type(s) application/json
This response body class contains all of the following: MoRefExtensibleManagedObject 
{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}

On This Page
Virtual Infrastructure Operations
POST
Failover Cluster Manager Get Cluster Mode
GET
Failover Cluster Manager Get Disabled Cluster Method
POST
Failover Cluster Manager Get Vcha Cluster Health
POST
Failover Cluster Manager Initiate Failover Task
POST
Failover Cluster Manager Set Cluster Mode Task