[{"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
Introduced1 Changed1

Cluster

Cluster representation


Properties

array of HostReference
hosts Optional

List of hosts associated with the cluster


string
id Optional

ID of the cluster


boolean
isDefault Optional

Status of the cluster if default or not


boolean
isStretched Optional

Status of the cluster if Stretched or not


string
name Optional

Name of the cluster


string
primaryDatastoreName Optional

Name of the primary datastore


string
primaryDatastoreType Optional

Storage type of the primary datastore


array of Tag
tags Introduced Changed Optional

List of assigned tags for the cluster


array of VdsSpec
vdsSpecs Optional

Distributed switches to added to the cluster

JSON Example

{
	"hosts": [
		{
			"azName": "string",
			"fqdn": "string",
			"id": "string",
			"ipAddress": "string",
			"vmNics": [
				{
					"isActive": false,
					"isAutoNegotiateSupported": false,
					"isInUse": false,
					"linkSpeedMB": 0,
					"name": "string"
				}
			]
		}
	],
	"id": "string",
	"isDefault": false,
	"isStretched": false,
	"name": "string",
	"primaryDatastoreName": "string",
	"primaryDatastoreType": "One among: VSAN, NFS, FC, VVOL_FC, VVOL_ISCSI, VVOL_NFS, VSAN_REMOTE",
	"tags": [
		{
			"categoryId": "string",
			"categoryName": "string",
			"id": "string",
			"name": "string"
		}
	],
	"vdsSpecs": [
		{
			"isUsedByNsxt": false,
			"name": "string",
			"niocBandwidthAllocationSpecs": [
				{
					"niocTrafficResourceAllocation": {
						"limit": 0,
						"reservation": 0,
						"sharesInfo": {
							"level": "One among: low, normal, high, custom",
							"shares": 0
						}
					},
					"type": "string"
				}
			],
			"portGroupSpecs": [
				{
					"activeUplinks": [
						"string"
					],
					"name": "string",
					"transportType": "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK"
				}
			]
		}
	]
}
[{"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
Property Of

PageOfCluster
Returned By

Get Cluster
What's changed in 4.4.0?

INTRODUCED (1)

Added Properties
tags
CHANGED (1)
Changed Properties
tags

Feedback

Was this page helpful?