[{"label":"Latest (5.0.0)","version":"latest"},{"version":"4.5.1"},{"version":"4.5.0"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]
vcf-for-vxrail
Get NSX-T Cluster
DescriptionGet a NSX-T cluster
Request
URLURL
https://sfo-vcf01.rainpole.io/v1/nsxt-clusters/{id}
Path Parameters
Path Parameters
string
id
Required
NSX-T cluster ID
Response
Response
Response BodyResponse Body
200 OK
Returns
NsxTCluster
of type(s) application/json
{
"status": "One among: INITIALIZING, STABLE, DEGRADED, UNSTABLE, UNAVAILABLE, UNIDENTIFIED, UNDEFINED"
}
string
id
Optional
ID of the cluster
boolean
isShareable
Optional
Boolean to identify if the NSX-T cluster can be shared to create a new workload domain
boolean
isShared
Optional
Boolean to identify if the NSX-T cluster is shared among workload domains
boolean
isVlcmCompatible
Optional
Boolean to identify if the NSX-T cluster is compatible with Vlcm
array of
NsxTManager
nodes
Optional
Information about the NSX-T managers associated with the cluster
string
status
Optional
NSX-T cluster status. To get NSX-T cluster status invoke nsxt-clusters query API with criterion NSXT_CLUSTERS_WITH_STATUS
string
version
Optional
Version of the NSX-T managers associated with the cluster
string
vip
Optional
VIP (Virtual IP Address) of the cluster
string
vipFqdn
Optional
FQDN for VIP of the cluster
Errors
Error
404
NSX-T cluster not found
Error
500
InternalServerError
Code Samples
cURL Command
curl https://sfo-vcf01.rainpole.io/v1/nsxt-clusters/{id}
[{"label":"Latest (5.0.0)","version":"latest"},{"version":"4.5.1"},{"version":"4.5.0"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]
vcf-for-vxrail
On This Page
NSX-T Clusters Operations
get
get
post
post
