REST API - get
  1. Operations
  2. vcenter
  3. vcha
  4. capabilities

vcenter vcha capabilities: get

Gets the capabilities of the active node of a VCHA cluster. This operation was added in vSphere API 6.7.1.

Request:

HTTP request

GET https://{server}/rest/vcenter/vcha/capabilities
No request parameters

Response:

HTTP Status Code: 200

Representation:

{
    "value" : {
        "vcha_licensed" : true,
        "management_vcenter_credentials_required" : true,
        "failover_ip_mode_valid" : true
    }
}

Response Type:

Name Type Description
bold = required
value info Info structure containing the VCHA capabilities.
value.management_vcenter_credentials_required boolean Are the active's management vCenter server credentials required. This attribute was added in vSphere API 6.7.1.
value.vcha_licensed boolean Does the vCenter have the appropriate license for VCHA. This attribute was added in vSphere API 6.7.1.
value.failover_ip_mode_valid boolean Is the assignment mode of failover IP of the active node in the VCHA cluster valid. This attribute was added in vSphere API 6.7.1.

Errors:

HTTP Status Code Type Description
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.