vcenter vcha cluster mode: get
Retrieves the current mode of a VCHA cluster. This operation was added in vSphere API 6.7.1.
Request:
HTTP request
GET https://{server}/rest/vcenter/vcha/cluster/mode
No request parameters
Response:
HTTP Status Code: 200
Representation:
{
"value" : {
"mode" : "ENABLED"
}
}
"value" : {
"mode" : "ENABLED"
}
}
Response Type:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| value | info | Info structure containing the mode of the the VCHA cluster. |
| value.mode | string | Identifies the mode of the VCHA cluster. This attribute was added in vSphere API 6.7.1. 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. |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 400 | not_allowed_in_current_state | If the VCHA cluster is not configured. |
| 403 | unauthorized | If the user has insufficient privilege to perform the operation. Operation execution requires the System.Read privilege. |
| 500 | error | If any other error occurs. |