[{"label":"Latest (4.4.0)","version":"latest"},{"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

Description

Get a NSX-T cluster

Request

Request

URL

URL


get
https://sfo-vcf01.rainpole.io/v1/nsxt-clusters/{id}
Copy

Path Parameters

Path Parameters

string
id Required

NSX-T cluster ID


Response

Response

Response Body

Response Body

200 OK returns NsxTCluster of type(s) application/json
{
	"domains": [
		{
			"id": "string",
			"name": "string"
		}
	],
	"id": "string",
	"isShareable": false,
	"isShared": false,
	"isVlcmCompatible": false,
	"nodes": [
		{
			"fqdn": "string",
			"id": "string",
			"ipAddress": "string",
			"name": "string"
		}
	],
	"status": "One among: INITIALIZING, STABLE, DEGRADED, UNSTABLE, UNAVAILABLE, UNIDENTIFIED, UNDEFINED",
	"version": "string",
	"vip": "string",
	"vipFqdn": "string"
}
array of DomainReference
domains Optional

Information about the domains associated with the cluster


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

Errors

404

NSX-T cluster not found


500

InternalServerError

Code Samples

Code Samples

cURL Command

curl https://sfo-vcf01.rainpole.io/v1/nsxt-clusters/{id}


[{"label":"Latest (4.4.0)","version":"latest"},{"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
Feedback

Was this page helpful?