This API has a deprecated equivalent from v7.0U1.
Get Cluster
Retrieves the status of a VCHA cluster.
Request
URLURL
https://{api_host}/api/vcenter/vcha/cluster?action=get
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
VchaClusterGetRequestBody of mimetype application/json
Optional
This is a request body class for an operation.
(The request body parameter is missing description)
{
"partial": false,
"vc_spec": {
"active_location": {
"hostname": "string",
"password": "string",
"port": 0,
"ssl_thumbprint": "string",
"username": "string"
}
}
}
boolean
partial
Optional
If true, then return only the information that does not require connecting to the Active vCenter Server. If false or unset, then return all the information. If unset, then return all the information.
vc_spec
Optional
Contains active node’s management vCenter server credentials. If unset, then the active vCenter Server instance is assumed to be either self-managed or else in enhanced linked mode and managed by a linked vCenter Server instance.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
VchaClusterInfo
of type application/json
Info structure containing the VCHA configuration and health information.
{
"auto_failover_allowed": false,
"config_state": "CONFIGURED",
"health_exception": [
{
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
}
],
"health_state": "HEALTHY",
"health_warnings": [
{
"error": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"recommendation": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
}
}
],
"manual_failover_allowed": false,
"mode": "ENABLED",
"node1": {
"failover_ip": {
"gateway_ip": "string",
"ip_family": "IPV4",
"ipv4": {
"address": "string",
"prefix": 0,
"subnet_mask": "string"
},
"ipv6": {
"address": "string",
"prefix": 0
}
},
"ha_ip": {
"gateway_ip": "string",
"ip_family": "IPV4",
"ipv4": {
"address": "string",
"prefix": 0,
"subnet_mask": "string"
},
"ipv6": {
"address": "string",
"prefix": 0
}
},
"runtime": {
"placement": {
"bios_uuid": "string",
"cluster": "string",
"cluster_name": "string",
"datacenter": "string",
"datacenter_name": "string",
"ha_network": "string",
"ha_network_name": "string",
"ha_network_type": "STANDARD_PORTGROUP",
"host": "string",
"host_name": "string",
"management_network": "string",
"management_network_name": "string",
"management_network_type": "STANDARD_PORTGROUP",
"management_vcenter_name": "string",
"management_vcenter_server_guid": "string",
"storage": {
"datastore": "string",
"datastore_name": "string"
},
"vm_name": "string"
},
"role": "ACTIVE",
"state": "UP"
}
},
"node2": {
"failover_ip": {
"gateway_ip": "string",
"ip_family": "IPV4",
"ipv4": {
"address": "string",
"prefix": 0,
"subnet_mask": "string"
},
"ipv6": {
"address": "string",
"prefix": 0
}
},
"ha_ip": {
"gateway_ip": "string",
"ip_family": "IPV4",
"ipv4": {
"address": "string",
"prefix": 0,
"subnet_mask": "string"
},
"ipv6": {
"address": "string",
"prefix": 0
}
},
"runtime": {
"placement": {
"bios_uuid": "string",
"cluster": "string",
"cluster_name": "string",
"datacenter": "string",
"datacenter_name": "string",
"ha_network": "string",
"ha_network_name": "string",
"ha_network_type": "STANDARD_PORTGROUP",
"host": "string",
"host_name": "string",
"management_network": "string",
"management_network_name": "string",
"management_network_type": "STANDARD_PORTGROUP",
"management_vcenter_name": "string",
"management_vcenter_server_guid": "string",
"storage": {
"datastore": "string",
"datastore_name": "string"
},
"vm_name": "string"
},
"role": "ACTIVE",
"state": "UP"
}
},
"witness": {
"ha_ip": {
"gateway_ip": "string",
"ip_family": "IPV4",
"ipv4": {
"address": "string",
"prefix": 0,
"subnet_mask": "string"
},
"ipv6": {
"address": "string",
"prefix": 0
}
},
"runtime": {
"placement": {
"bios_uuid": "string",
"cluster": "string",
"cluster_name": "string",
"datacenter": "string",
"datacenter_name": "string",
"ha_network": "string",
"ha_network_name": "string",
"ha_network_type": "STANDARD_PORTGROUP",
"host": "string",
"host_name": "string",
"management_network": "string",
"management_network_name": "string",
"management_network_type": "STANDARD_PORTGROUP",
"management_vcenter_name": "string",
"management_vcenter_server_guid": "string",
"storage": {
"datastore": "string",
"datastore_name": "string"
},
"vm_name": "string"
},
"role": "ACTIVE",
"state": "UP"
}
}
}
boolean
auto_failover_allowed
Optional
Specifies if automatic failover is allowed. If unset, then the cluster state healthy and automatic failover allowance in accordance with the cluster mode.
config_state
Optional
The Cluster.ConfigState enumerated type defines the VCHA configuration state.
CONFIGURED : VCHA cluster is configured.
NOTCONFIGURED : VCHA cluster is not configured.
INVALID : VCHA cluster is in an invalid/dirty state.
PREPARED : vCenter server appliance has been prepared for VCHA cluster configuration.
Possible values are: CONFIGURED , NOTCONFIGURED , INVALID , PREPARED
array of
StdLocalizableMessage
health_exception
Optional
Health warning messages if the health information is unavailable. If unset, then the cluster is in a healthy state.
health_state
Optional
The Cluster.ClusterState enumerated type defines the possible for a VCHA Cluster.
HEALTHY : All three nodes in a VCHA Cluster are healthy and connected. State replication between Active and Passive node is working and both nodes are in sync.
DEGRADED : A VCHA Cluster is said to be in a degraded state for either or all of the following reasons:
- There is a node loss.
- State replication between the Active and Passive node fails.
ISOLATED : All three nodes are isolated from each other.
Possible values are: HEALTHY , DEGRADED , ISOLATED
array of
VchaClusterErrorCondition
health_warnings
Optional
A collection of messages describing the reason for a non-healthy Cluster. If unset, then the cluster is in a healthy state.
boolean
manual_failover_allowed
Optional
Specifies if manual failover is allowed. If unset, then the cluster state healthy and manual failover allowance in accordance with the cluster mode.
mode
Optional
The Cluster.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 Active and Passive node is enabled but automatic failover is not allowed.
Possible values are: ENABLED , DISABLED , MAINTENANCE
node1
Optional
Node configuration information for the VCHA cluster. If unset, then the information is unavailable.
node2
Optional
Node configuration information for the VCHA cluster. If unset, then the information is unavailable or the node is not cloned yet.
witness
Optional
Node configuration information for the VCHA cluster. If unset, then the information is unavailable or the node is not cloned yet.
Errors
400
com.vmware.vapi.std.errors.invalid_argument : If the credentials provided for authenticating with the active node’s management vCenter server are invalid. | com.vmware.vapi.std.errors.unverified_peer : If the SSL certificate of the management vCenter server cannot be validated. The value of the data field of Error will be a structure that contains all the fields defined in CertificateInfo.
403
com.vmware.vapi.std.errors.unauthorized : If the user has insufficient privilege to perform the operation. - If partial is false or unset, then the operation execution requires the Global.VCServer privilege. - If partial is true, then the 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
$VchaConnectionSpec = Initialize-VchaConnectionSpec -Hostname "MyHostname" -Port 0 -SslThumbprint "MySslThumbprint" -Username "MyUsername" -Password "MyPassword"
$VchaCredentialsSpec = Initialize-VchaCredentialsSpec -ActiveLocation $VchaConnectionSpec
$VchaClusterGetRequestBody = Initialize-VchaClusterGetRequestBody -VcSpec $VchaCredentialsSpec -Partial $false
Invoke-GetVchaCluster -VchaClusterGetRequestBody $VchaClusterGetRequestBody
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"partial":false,"vc_spec":{"active_location":{"hostname":"string","password":"string","port":0,"ssl_thumbprint":"string","username":"string"}}}' https://{api_host}/api/vcenter/vcha/cluster?action=get
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/vcenter/vcha/cluster?action=get
x-vmw-doc-operation: get
Availability
Added in 7.0U2
