NsxTCluster

NsxTCluster
NsxTCluster

NSX Cluster representation

JSON Example
{
    "id": "string",
    "nativeId": "string",
    "vipFqdn": "string",
    "vip": "string",
    "domains": [
        {
            "id": "string",
            "name": "string",
            "type": "string"
        }
    ],
    "nodes": [
        {
            "id": "string",
            "fqdn": "string",
            "ipAddress": "string",
            "name": "string"
        }
    ],
    "version": "string",
    "isShared": false,
    "isShareable": false,
    "isVlcmCompatible": false,
    "status": "One among: INITIALIZING, STABLE, DEGRADED, UNSTABLE, UNAVAILABLE, UNIDENTIFIED, UNDEFINED"
}
string
id
Optional

ID of the cluster

string
nativeId
Optional

[Deprecated] Native ID of the NSX cluster

string
vipFqdn
Optional

FQDN for VIP of the cluster

string
vip
Optional

VIP (Virtual IP Address) of the cluster

domains
Optional

Information about the domains associated with the cluster

nodes
Optional

Information about the NSX managers associated with the cluster

string
version
Optional

Version of the NSX managers associated with the cluster

boolean
isShared
Optional

Boolean to identify if the NSX cluster is shared among workload domains

boolean
isShareable
Optional

Boolean to identify if the NSX cluster can be shared to create a new workload domain

boolean
isVlcmCompatible
Optional

Boolean to identify if the NSX cluster is compatible with vLCM. This should not be used to determineif vLCM Clusters can be created on the domain

string
status
Optional

NSX cluster status. To get NSX cluster status invoke nsxt-clusters query API with criterion NSXT_CLUSTERS_WITH_STATUS