This API has a deprecated equivalent from v7.0U1.
Get Cluster Mode
Retrieves the current mode of a VCHA cluster.
Request
URLURL
https://{api_host}/api/vcenter/vcha/cluster/mode
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"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
VchaClusterModeInfo
of type application/json
Info structure containing the mode of the the VCHA cluster.
{
"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
Errors
400
com.vmware.vapi.std.errors.not_allowed_in_current_state : If the VCHA cluster is not configured.
403
com.vmware.vapi.std.errors.unauthorized : If the user has insufficient privilege to perform the operation. Operation execution requires the System.Read 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
Invoke-GetVchaClusterMode
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/vcha/cluster/mode
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/vcenter/vcha/cluster/mode
x-vmw-doc-operation: get
Availability
Added in 7.0U2
