REST API - set-task

vcenter vcha cluster mode: set-task

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

. This operation was added in vSphere API 6.7.1.

Request:

HTTP request

PUT https://{server}/rest/vcenter/vcha/cluster/mode?vmw-task=true

Request Body Structure:

{
"mode" : "ENABLED"
}

Request Body Parameters:

Name	Type	Description
bold = required
mode	string	Defines the possible modes for a VCHA Cluster. This enumeration was added in vSphere API 6.7.1. Value is one of: ENABLED: VCHA Cluster is enabled. State replication between the Active and Passive node is enabled and automatic failover is allowed. This constant was added in vSphere API 6.7.1. DISABLED: VCHA Cluster is disabled. State replication between the Active and Passive node is disabled and automatic failover is not allowed. This constant was added in vSphere API 6.7.1. MAINTENANCE: VCHA Cluster is in maintenance mode. State replication between the and Passive node is enabled but automatic failover is not allowed. This constant was added in vSphere API 6.7.1.Clustermode to change the VCHA cluster mode to.

Response:

HTTP Status Code: 200

Representation:

{
"value" : "obj-103"
}

Response Type:

Name	Type	Description
bold = required
value	string

Errors:

HTTP Status Code	Type	Description
403	unauthorized	If the user has insufficient privilege to perform the operation. Operation execution requires the Global.VCServer privilege.
500	error	If any other error occurs.