This API has a deprecated equivalent from v7.0U1.
Set Cluster Mode 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.
Request
URLURL
https://{api_host}/api/vcenter/vcha/cluster/mode?vmw-task=true
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
VchaClusterModeSetTaskRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"mode": "ENABLED"
}
mode
Required
The Mode.ClusterMode enumerated type defines the possible modes for a VCHA Cluster.
ENABLED : VCHA Cluster is enabled. State replication between the Active and Passive node is enabled and automatic failover is allowed.
DISABLED : VCHA Cluster is disabled. State replication between the Active and Passive node is disabled and automatic failover is not allowed.
MAINTENANCE : VCHA Cluster is in maintenance mode. State replication between the and Passive node is enabled but automatic failover is not allowed.
Possible values are: ENABLED , DISABLED , MAINTENANCE
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
202 Accepted returns
string
of type application/json
An identifier for the task created by this API invocation will be returned. If the non-async version of the operation returns a value, this id can be used with the CIS Get Task operation to fetch that value. The normal description of this operation’s return value will follow if one exists.
Errors
403
com.vmware.vapi.std.errors.unauthorized : If the user has insufficient privilege to perform the operation. Operation execution requires the Global.VCServer privilege.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$VchaClusterModeSetTaskRequestBody = Initialize-VchaClusterModeSetTaskRequestBody -Mode "ENABLED"
Invoke-SetClusterModeAsync -VchaClusterModeSetTaskRequestBody $VchaClusterModeSetTaskRequestBody
cURL Command
curl -X PUT -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"mode":"ENABLED"}' https://{api_host}/api/vcenter/vcha/cluster/mode?vmw-task=true
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: put
x-vmw-doc-deprecated-path: /rest/vcenter/vcha/cluster/mode?vmw-task=true
x-vmw-doc-operation: set_task
Availability
Added in 7.0U2
