ClusterSpec

ClusterSpec
ClusterSpec

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

JSON Example
{
    "name": "string",
    "datacenterName": "string",
    "clusterImageId": "string",
    "hostSpecs": [
        {
            "id": "string",
            "licenseKey": "string",
            "ipAddress": "string",
            "hostName": "string",
            "username": "string",
            "password": "string",
            "hostNetworkSpec": {
                "vmNics": [
                    {
                        "id": "string",
                        "vdsName": "string",
                        "moveToNvds": false,
                        "uplink": "string"
                    }
                ],
                "networkProfileName": "string"
            },
            "azName": "string",
            "sshThumbprint": "string",
            "serialNumber": "string"
        }
    ],
    "datastoreSpec": {
        "vsanDatastoreSpec": {
            "datastoreName": "string",
            "failuresToTolerate": 0,
            "licenseKey": "string",
            "dedupAndCompressionEnabled": false,
            "esaConfig": {
                "enabled": false,
                "vsanMaxConfig": {
                    "enableVsanMax": false,
                    "enableVsanExternalNetwork": false
                }
            }
        },
        "nfsDatastoreSpecs": [
            {
                "datastoreName": "string",
                "nasVolume": {
                    "serverName": [
                        "string"
                    ],
                    "path": "string",
                    "readOnly": false,
                    "userTag": "string",
                    "enableBindToVmknic": false
                }
            }
        ],
        "vmfsDatastoreSpec": {
            "fcSpec": [
                {
                    "datastoreName": "string"
                }
            ]
        },
        "vvolDatastoreSpecs": [
            {
                "name": "string",
                "vasaProviderSpec": {
                    "vasaProviderId": "string",
                    "storageContainerId": "string",
                    "storageProtocolType": "One among: ISCSI, NFS, FC",
                    "userId": "string"
                }
            }
        ],
        "vsanRemoteDatastoreClusterSpec": {
            "isStretched": false,
            "primaryAzName": "string",
            "vsanRemoteDatastoreSpec": [
                {
                    "datastoreUuid": "string",
                    "networkTopology": "string",
                    "siteAffinity": [
                        {
                            "serverSite": "string",
                            "clientSite": "string"
                        }
                    ]
                }
            ]
        }
    },
    "networkSpec": {
        "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,
                "lagSpecs": [
                    {
                        "name": "string",
                        "uplinksCount": 0,
                        "lacpMode": "One among:ACTIVE, PASSIVE",
                        "loadBalancingMode": "One among:SOURCE_MAC, DESTINATION_MAC, SOURCE_AND_DESTINATION_MAC, DESTINATION_IP_AND_VLAN, SOURCE_IP_AND_VLAN, SOURCE_AND_DESTINATION_IP_AND_VLAN, DESTINATION_TCP_UDP_PORT, SOURCE_TCP_UDP_PORT, SOURCE_AND_DESTINATION_TCP_UDP_PORT, DESTINATION_IP_AND_TCP_UDP_PORT, SOURCE_IP_AND_TCP_UDP_PORT, SOURCE_AND_DESTINATION_IP_AND_TCP_UDP_PORT, DESTINATION_IP_AND_TCP_UDP_PORT_AND_VLAN, SOURCE_IP_AND_TCP_UDP_PORT_AND_VLAN, SOURCE_AND_DESTINATION_IP_AND_TCP_UDP_PORT_AND_VLAN, DESTINATION_IP, SOURCE_IP, SOURCE_AND_DESTINATION_IP, VLAN, SOURCE_PORT_ID",
                        "lacpTimeoutMode": "One among:SLOW, FAST"
                    }
                ]
            }
        ],
        "nsxClusterSpec": {
            "nsxTClusterSpec": {
                "geneveVlanId": 0,
                "ipAddressPoolSpec": {
                    "name": "string",
                    "description": "string",
                    "ignoreUnavailableNsxtCluster": false,
                    "subnets": [
                        {
                            "ipAddressPoolRanges": [
                                {
                                    "start": "string",
                                    "end": "string"
                                }
                            ],
                            "cidr": "string",
                            "gateway": "string"
                        }
                    ]
                },
                "ipAddressPoolsSpec": [
                    {
                        "name": "string",
                        "description": "string",
                        "ignoreUnavailableNsxtCluster": false,
                        "subnets": [
                            {
                                "ipAddressPoolRanges": [
                                    {
                                        "start": "string",
                                        "end": "string"
                                    }
                                ],
                                "cidr": "string",
                                "gateway": "string"
                            }
                        ]
                    }
                ],
                "uplinkProfiles": [
                    {
                        "name": "string",
                        "teamings": [
                            {
                                "policy": "One among: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC",
                                "activeUplinks": [
                                    "string"
                                ],
                                "standByUplinks": [
                                    "string"
                                ]
                            }
                        ],
                        "transportVlan": 0,
                        "supportedTeamingPolicies": {
                            "supportedTeamingPolicies": "string"
                        }
                    }
                ]
            }
        },
        "networkProfiles": [
            {
                "name": "string",
                "description": "string",
                "isDefault": false,
                "nsxtHostSwitchConfigs": [
                    {
                        "vdsName": "string",
                        "uplinkProfileName": "string",
                        "ipAddressPoolName": "string",
                        "vdsUplinkToNsxUplink": [
                            {
                                "vdsUplinkName": "string",
                                "nsxUplinkName": "string"
                            }
                        ]
                    }
                ]
            }
        ]
    },
    "advancedOptions": {
        "evcMode": "One among: INTEL_MEROM, INTEL_PENRYN, INTEL_NEALEM, INTEL_WESTMERE, INTEL_SANDYBRIDGE, INTEL_IVYBRIDGE, INTEL_HASWELL, INTEL_BROADWELL, INTEL_SKYLAKE, INTEL_CASCADELAKE, INTEL_ICELAKE, INTEL_SAPPHIRERAPIDS, AMD_REV_E, AMD_REV_F, AMD_GREYHOUND_NO3DNOW, AMD_GREYHOUND, AMD_BULLDOZER, AMD_PILEDRIVER, AMD_STREAMROLLER, AMD_ZEN, AMD_ZEN2, AMD_ZEN3, AMD_ZEN4",
        "highAvailability": {
            "enabled": false
        }
    },
    "skipThumbprintValidation": false,
    "supervisorActivationSpec": {
        "zoneName": "string",
        "supervisorName": "string",
        "serviceCidr": {
            "address": "string",
            "prefix": 0
        },
        "managementNetwork": {
            "controlPlaneIpRange": {
                "startIpAddress": "192.168.0.123",
                "endIpAddress": "192.168.0.128"
            },
            "details": {
                "vlanId": 1,
                "netMask": "255.255.255.0",
                "gateway": "192.168.1.1",
                "vdsName": "vds1"
            }
        },
        "vpcNetwork": {
            "nsxProject": "/org/default/projects/ptenant0",
            "nsxVpcConnectivityProfile": "/orgs/default/projects/ptenant0/vpc-connectivity-profiles/default",
            "privateTransitNetworkCidr": {
                "address": "string",
                "prefix": 0
            },
            "privateCidr": {
                "address": "string",
                "prefix": 0
            },
            "dnsServers": [
                "192.168.0.1"
            ],
            "ntpServers": [
                "ntp.example.com"
            ]
        }
    }
}
string
name
Optional
Constraints: minLength: 0 maxLength: 80

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

string
datacenterName
Optional
Constraints: minLength: 0 maxLength: 80

Name of the vCenter Datacenter in which the Cluster will be added. Required only if there is more than one Datacenter

string
clusterImageId
Optional

ID of the Cluster Image to be used only with the Cluster managed by vSphere Lifecycle Manager Images. This is required, if we want to create a cluster on vCenter 9.0 or above.

array of HostSpec
hostSpecs
Required
Constraints: minItems: 1 maxItems: 96

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

datastoreSpec
Required

This specification contains cluster storage configuration

networkSpec
Required

This specification contains cluster's network configuration.

advancedOptions
Optional

Advanced Options used to add Cluster

boolean
skipThumbprintValidation
Optional

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

supervisorActivationSpec
Optional

This specification contains cluster's supervisor configuration.