Get Cluster Active
Retrieves information about the active node of a VCHA cluster.
Request
URLURL
https://{api_host}/api/vcenter/vcha/cluster/active?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
VchaClusterActiveGetRequestBody 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
VchaClusterActiveInfo
of type application/json
Info Information about the VCHA network and placement of the active node.
{
"ha": {
"default_gateway": "string",
"dns_servers": [
"string"
],
"ip_family": "IPV4",
"ipv4": {
"address": "string",
"prefix": 0,
"subnet_mask": "string"
},
"ipv6": {
"address": "string",
"prefix": 0
}
},
"management": {
"default_gateway": "string",
"dns_servers": [
"string"
],
"ip_family": "IPV4",
"ipv4": {
"address": "string",
"prefix": 0,
"subnet_mask": "string"
},
"ipv6": {
"address": "string",
"prefix": 0
}
},
"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"
}
}
ha
Optional
IP specification for the HA network. If unset, then the second NIC of the Active Node of the VCHA cluster is not configured.
placement
Optional
Contains the placement information of the active node. If unset, the request specified that placement information of the active node should not be included.
Errors
400
com.vmware.vapi.std.errors.invalid_argument : If the credentials provided for authentincating 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. | com.vmware.vapi.std.errors.invalid_element_configuration : If the active node is on more than one datastore.
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.
404
com.vmware.vapi.std.errors.not_found : If the active virtual machine is not managed by the specified vCenter server for the active node.
500
com.vmware.vapi.std.errors.error : If the management interface IP address assignment is not static. If any other error occurs.
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
$VchaClusterActiveGetRequestBody = Initialize-VchaClusterActiveGetRequestBody -VcSpec $VchaCredentialsSpec -Partial $false
Invoke-GetClusterActive -VchaClusterActiveGetRequestBody $VchaClusterActiveGetRequestBody
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/active?action=get
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
Availability
Added in 6.7.1
