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

Introduced1

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

isImageBased Introduced Optional

Is vSphere cluster managed by vSphere Lifecycle Manager - true for managed, false for not managed

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 Optional

Deprecated, this list will always be returned empty

array of VdsSpec

vdsSpecs Optional

Distributed switches to added to the cluster

JSON Example

{
    "primaryDatastoreType": "One among: VSAN, VSAN_ESA, NFS, FC, VVOL_FC, VVOL_ISCSI, VVOL_NFS, VSAN_REMOTE"
}

vcf-for-vxrail

Property Of

PageOfCluster

Returned By

Get Cluster

What's changed in 5.0.0?

Added Properties
isImageBased

Cluster

Properties

JSON Example

Property Of

Returned By

What's changed in 5.0.0?

Was this page helpful?