Cluster

Cluster
Cluster

Cluster representation

JSON Example 
{
    "id": "string",
    "domain": {
        "id": "string",
        "name": "string",
        "type": "string"
    },
    "name": "string",
    "status": "One among: ACTIVE, ACTIVATING, UPGRADING, DISABLED, ERROR, SKIPPED, DEACTIVATING, EXPANDING, SHRINKING, CREATING",
    "hciMeshData": {
        "name": "string",
        "isHciMeshEnabled": false,
        "remoteDatastore": "string",
        "primaryDataStoreId": "string",
        "vsanDataStores": [
            "string"
        ],
        "clientClusters": [
            "string"
        ],
        "remoteDatastoreInfos": [
            {
                "serverCluster": "string",
                "remoteDatastore": "string"
            }
        ],
        "isServer": false,
        "isClient": false,
        "computeOnlyClient": false,
        "numberOfClients": 0,
        "numberOfServers": 0
    },
    "primaryDatastoreName": "string",
    "primaryDatastoreType": "One among: VSAN, VSAN_ESA, VSAN_MAX, NFS, FC, VVOL_FC, VVOL_ISCSI, VVOL_NFS, VSAN_REMOTE",
    "hosts": [
        {
            "id": "string",
            "ipAddress": "string",
            "fqdn": "string",
            "vmNics": [
                {
                    "name": "string",
                    "linkSpeedMB": 0,
                    "isInUse": false,
                    "isAutoNegotiateSupported": false,
                    "isActive": false
                }
            ],
            "azName": "string"
        }
    ],
    "isStretched": false,
    "isDefault": false,
    "failuresToTolerate": 0,
    "vdsSpecs": [
        {
            "name": "string",
            "isUsedByNsxt": false,
            "nsxtSwitchConfig": {
                "transportZones": [
                    {
                        "name": "string",
                        "transportType": "One among: VLAN, OVERLAY"
                    }
                ],
                "hostSwitchOperationalMode": "One among: STANDARD, ENS, ENS_INTERRUPT"
            },
            "portGroupSpecs": [
                {
                    "name": "string",
                    "transportType": "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK, VM_MANAGEMENT, VSAN_EXTERNAL",
                    "activeUplinks": [
                        "string"
                    ],
                    "standByUplinks": [
                        "string"
                    ],
                    "teamingPolicy": "One among:loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, loadbalance_loadbased"
                }
            ],
            "niocBandwidthAllocationSpecs": [
                {
                    "type": "string",
                    "niocTrafficResourceAllocation": {
                        "limit": 0,
                        "sharesInfo": {
                            "shares": 0,
                            "level": "One among: low, normal, high, custom"
                        },
                        "reservation": 0
                    }
                }
            ],
            "mtu": 0
        }
    ],
    "tags": [
        {
            "id": "string",
            "name": "string",
            "categoryId": "string",
            "categoryName": "string"
        }
    ],
    "isImageBased": false,
    "capacity": {
        "cpu": {
            "used": {
                "value": "number",
                "unit": "string"
            },
            "total": {
                "value": "number",
                "unit": "string"
            },
            "numberOfCores": 0,
            "numberOfCPUPackages": 0
        },
        "memory": {
            "used": {
                "value": "number",
                "unit": "string"
            },
            "total": {
                "value": "number",
                "unit": "string"
            }
        },
        "storage": {
            "used": {
                "value": "number",
                "unit": "string"
            },
            "total": {
                "value": "number",
                "unit": "string"
            }
        }
    },
    "vcenter": {
        "id": "string",
        "fqdn": "string",
        "vcInstanceId": "string"
    },
    "managedObjectReferenceId": "string",
    "vsanClusterMode": "string"
}
string
id
Optional

ID of the cluster

DomainReference
domain
Optional

Represents a domain reference

string
name
Optional

Name of the cluster

string
status
Optional

Status of the cluster

HciMeshData
hciMeshData
Optional

vSAN remote datastore mount related data for Cluster

string
primaryDatastoreName
Optional

Name of the primary datastore

string
primaryDatastoreType
Optional

Storage type of the primary datastore

array of HostReference
hosts
Optional

List of hosts associated with the cluster

boolean
isStretched
Optional

Status of the cluster if Stretched or not

boolean
isDefault
Optional

Status of the cluster if default or not

integer As int32 As int32
failuresToTolerate
Optional

Number of ESXi host failures to tolerate in the vSAN cluster. Applicable only for clusters with vSAN datastore

array of VdsSpec
vdsSpecs
Optional

Distributed switches to added to the cluster

array of Tag
tags
Optional

Deprecated, this list will always be returned empty

boolean
isImageBased
Optional

Is cluster managed by vSphere Lifecycle Manager Images - true if managed, false if managed by vSphere Lifecycle Manager Baselines

Capacity
capacity
Optional

Represents a usage and capacity information of a Resource

VcenterReference
vcenter
Optional

Represents a vCenter reference

string
managedObjectReferenceId
Optional

Managed Object Reference Id of this cluster in vCenter

string
vsanClusterMode
Optional

vSAN cluster mode

Property Of
Returned By