Cluster

Cluster
Cluster

Cluster representation

JSON Example
{
    "capacity": {
        "cpu": {
            "total": {
                "unit": "string",
                "value": "number"
            },
            "used": {
                "unit": "string",
                "value": "number"
            }
        },
        "memory": {
            "total": {
                "unit": "string",
                "value": "number"
            },
            "used": {
                "unit": "string",
                "value": "number"
            }
        },
        "storage": {
            "total": {
                "unit": "string",
                "value": "number"
            },
            "used": {
                "unit": "string",
                "value": "number"
            }
        }
    },
    "hosts": [
        {
            "azName": "string",
            "fqdn": "string",
            "id": "string",
            "ipAddress": "string",
            "vmNics": [
                {
                    "isActive": false,
                    "isAutoNegotiateSupported": false,
                    "isInUse": false,
                    "linkSpeedMB": 0,
                    "name": "string"
                }
            ]
        }
    ],
    "id": "string",
    "isDefault": false,
    "isImageBased": false,
    "isStretched": false,
    "name": "string",
    "primaryDatastoreName": "string",
    "primaryDatastoreType": "One among: VSAN, VSAN_ESA, NFS, FC, VVOL_FC, VVOL_ISCSI, VVOL_NFS, VSAN_REMOTE",
    "tags": [
        {
            "categoryId": "string",
            "categoryName": "string",
            "id": "string",
            "name": "string"
        }
    ],
    "vdsSpecs": [
        {
            "isUsedByNsxt": false,
            "nsxtSwitchConfig": {
                "transportZones": [
                    {
                        "name": "string",
                        "transportType": "One among: VLAN, OVERLAY"
                    }
                ],
                "hostSwitchOperationalMode": "One among: STANDARD, ENS, ENS_INTERRUPT"
            },
            "mtu": 0,
            "name": "string",
            "niocBandwidthAllocationSpecs": [
                {
                    "niocTrafficResourceAllocation": {
                        "limit": 0,
                        "reservation": 0,
                        "sharesInfo": {
                            "level": "One among: low, normal, high, custom",
                            "shares": 0
                        }
                    },
                    "type": "string"
                }
            ],
            "portGroupSpecs": [
                {
                    "activeUplinks": [
                        "string"
                    ],
                    "standByUplinks": [
                        "string"
                    ],
                    "teamingPolicy": "One among: loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, loadbalance_loadbased",
                    "name": "string",
                    "transportType": "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK, VM_MANAGEMENT"
                }
            ]
        }
    ]
}
capacity
Optional

capacity

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
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

Property Of
Returned By