ClusterSpec

ClusterSpec
ClusterSpec

This specification contains the parameters required to add a cluster to a workload domain

JSON Example
{
    "advancedOptions": {
        "evcMode": "One among: INTEL_MEROM, INTEL_PENRYN, INTEL_NEALEM, INTEL_WESTMERE, INTEL_SANDYBRIDGE, INTEL_IVYBRIDGE, INTEL_HASWELL, INTEL_BROADWELL, INTEL_SKYLAKE, INTEL_CASCADELAKE, AMD_REV_E, AMD_REV_F, AMD_GREYHOUND_NO3DNOW, AMD_GREYHOUND, AMD_BULLDOZER, AMD_PILEDRIVER, AMD_STREAMROLLER, AMD_ZEN",
        "highAvailability": {
            "enabled": false
        }
    },
    "clusterImageId": "string",
    "datastoreSpec": {
        "nfsDatastoreSpecs": [
            {
                "datastoreName": "string",
                "nasVolume": {
                    "path": "string",
                    "readOnly": false,
                    "serverName": [
                        "string"
                    ],
                    "userTag": "string"
                }
            }
        ],
        "vmfsDatastoreSpec": {
            "fcSpec": [
                {
                    "datastoreName": "string"
                }
            ]
        },
        "vsanDatastoreSpec": {
            "datastoreName": "string",
            "dedupAndCompressionEnabled": false,
            "failuresToTolerate": 0,
            "licenseKey": "string"
        },
        "vsanRemoteDatastoreClusterSpec": {
            "vsanRemoteDatastoreSpec": [
                {
                    "datastoreUuid": "string"
                }
            ]
        },
        "vvolDatastoreSpecs": [
            {
                "name": "string",
                "vasaProviderSpec": {
                    "storageContainerId": "string",
                    "storageProtocolType": "One among: ISCSI, NFS, FC",
                    "userId": "string",
                    "vasaProviderId": "string"
                }
            }
        ]
    },
    "hostSpecs": [
        {
            "azName": "string",
            "hostName": "string",
            "hostNetworkSpec": {
                "vmNics": [
                    {
                        "id": "string",
                        "moveToNvds": false,
                        "uplink": "string",
                        "vdsName": "string"
                    }
                ]
            },
            "id": "string",
            "ipAddress": "string",
            "licenseKey": "string",
            "password": "string",
            "serialNumber": "string",
            "sshThumbprint": "string",
            "username": "string"
        }
    ],
    "name": "string",
    "networkSpec": {
        "nsxClusterSpec": {
            "nsxTClusterSpec": {
                "geneveVlanId": 0,
                "ipAddressPoolSpec": {
                    "description": "string",
                    "ignoreUnavailableNsxtCluster": false,
                    "name": "string",
                    "subnets": [
                        {
                            "cidr": "string",
                            "gateway": "string",
                            "ipAddressPoolRanges": [
                                {
                                    "end": "string",
                                    "start": "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"
                    }
                ]
            }
        ]
    },
    "skipThumbprintValidation": false,
    "vxRailDetails": {
        "adminCredentials": {
            "credentialType": "One among: SSH",
            "password": "string",
            "username": "string"
        },
        "dnsName": "string",
        "ipAddress": "string",
        "networks": [
            {
                "freeIps": [
                    "string"
                ],
                "gateway": "string",
                "id": "string",
                "ipPools": [
                    {
                        "end": "string",
                        "start": "string"
                    }
                ],
                "mask": "string",
                "mtu": 0,
                "subnet": "string",
                "type": "string",
                "usedIps": [
                    "string"
                ],
                "vlanId": 0
            }
        ],
        "nicProfile": "string",
        "rootCredentials": {
            "credentialType": "One among: SSH",
            "password": "string",
            "username": "string"
        },
        "sshThumbprint": "string",
        "sslThumbprint": "string"
    }
}
advancedOptions
Optional

Advanced Options used to add Cluster

string
clusterImageId
Optional

ID of the Cluster Image to be used with the Cluster

datastoreSpec
Required

This specification contains cluster storage configuration

array of HostSpec
hostSpecs
Required

List of vSphere host information from the free pool to consume in the workload domain

string
name
Required

Name of the new cluster that will be added to the specified workload domain

networkSpec
Required

This specification contains cluster network configuration

boolean
skipThumbprintValidation
Optional

Skip thumbprint validation for ESXi and VxRail Manager during add cluster/host operation. This property is deprecated.

vxRailDetails
Optional

Contains the VxRail Manager details