Create Cluster
Create a cluster and add to an existing domain
Request
URI
POST
https://{api_host}/v1/clusters
COPY
Request Body
ClusterCreationSpec of type(s) application/json
Required
Show optional properties
{
"domainId": "string",
"computeSpec": {
"clusterSpecs": [
{
"hostSpecs": [
{
"id": "string"
}
],
"datastoreSpec": {},
"networkSpec": {}
}
]
}
}{
"domainId": "string",
"computeSpec": {
"clusterSpecs": [
{
"name": "string",
"clusterImageId": "string",
"vxRailDetails": {
"rootCredentials": {
"credentialType": "One among: SSH",
"username": "string",
"password": "string"
},
"adminCredentials": {
"credentialType": "One among: SSH",
"username": "string",
"password": "string"
},
"sshThumbprint": "string",
"sslThumbprint": "string",
"networks": [
{
"id": "string",
"type": "VSAN, VMOTION, VXLAN, NFS, ISCSI, VSAN_EXTERNAL",
"vlanId": 0,
"mtu": 0,
"subnet": "string",
"mask": "string",
"gateway": "string",
"ipPools": [
{
"start": "string",
"end": "string"
}
],
"freeIps": [
"string"
],
"usedIps": [
"string"
]
}
],
"ipAddress": "string",
"dnsName": "string",
"nicProfile": "string",
"contextWithKeyValuePair": {
"contextWithKeyValuePair": [
{
"attributeName": "string",
"datatype": "string",
"value": "string"
}
]
},
"arrayContextWithKeyValuePair": {
"arrayContextWithKeyValuePair": [
{
"arrayAssociationContext": {
"parent": "VxRailArrayAssociationContext Object",
"arrayAttributeIdsKeyValue": {
"arrayAttributeIdsKeyValue": "string"
}
},
"simpleAttributes": [
{
"attributeName": "string",
"datatype": "string",
"value": "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
}
}
},
"nfsDatastoreSpecs": [
{
"datastoreName": "string",
"nasVolume": {
"serverName": [
"string"
],
"path": "string",
"readOnly": false,
"userTag": "string"
}
}
],
"vmfsDatastoreSpec": {
"fcSpec": [
{
"datastoreName": "string"
}
]
},
"vvolDatastoreSpecs": [
{
"name": "string",
"vasaProviderSpec": {
"vasaProviderId": "string",
"storageContainerId": "string",
"storageProtocolType": "One among: ISCSI, NFS, FC",
"userId": "string"
}
}
],
"vsanRemoteDatastoreClusterSpec": {
"vsanRemoteDatastoreSpec": [
{
"datastoreUuid": "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
}
],
"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
}
],
"skipFailedHosts": false
},
"deployWithoutLicenseKeys": false
}string
domainId
Required
ID of the domain to which the clusters will be added
computeSpec
Required
This specification contains the parameters required to add each cluster to a workload domain
boolean
deployWithoutLicenseKeys
Optional
Flag that indicates if the deployment should happen without license keys.
Responses
202
Accepted
Returns Task of type(s) application/json
{
"id": "string",
"name": "string",
"localizableDescriptionPack": {
"component": "string",
"messageKey": "string",
"arguments": [
"string"
],
"message": "string",
"bundle": "string"
},
"type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION",
"status": "One among: PENDING, IN_PROGRESS, In Progress, SUCCESSFUL, Successful, FAILED, Failed, CANCELLED, Cancelled, COMPLETED_WITH_WARNING, SKIPPED",
"creationTimestamp": "string",
"completionTimestamp": "string",
"subTasks": [
{
"name": "string",
"type": "string",
"description": "string",
"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, NOT_APPLICABLE",
"creationTimestamp": "string",
"completionTimestamp": "string",
"stages": [
{
"name": "string",
"type": "string",
"description": "string",
"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"creationTimestamp": "string",
"completionTimestamp": "string",
"errors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string"
}
]
}
],
"errors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string"
}
],
"resources": [
{
"resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
"fqdn": "sfo-vc01.rainpole.io",
"type": "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER, NSX_ALB, ESXI",
"name": "string",
"sans": [
"sfo-vc01.rainpole.io"
]
}
],
"subTasks": [
"SubTask Object"
]
}
],
"errors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string"
}
],
"resources": [
{
"resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
"fqdn": "sfo-vc01.rainpole.io",
"type": "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER, NSX_ALB, ESXI",
"name": "string",
"sans": [
"sfo-vc01.rainpole.io"
]
}
],
"resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
"isCancellable": false,
"isRetryable": false
}string
id
Required
Task ID
string
name
Required
Task name
localizableDescriptionPack
Optional
A message pack representing a localizable message and suitable for machine processing. Contains a message key unique in the scope of the specified component, as well as the arguments needed to generate the localized message.
string
type
Optional
Operation that is represented by the Task in machine readable format. The value is controlled by the owners/producers of the Task. The convention is
string
status
Required
Task status
string
creationTimestamp
Required
Task creation timestamp
string
completionTimestamp
Required
Task completion timestamp
string
resolutionStatus
Optional
Resolution state
boolean
isCancellable
Optional
Represents task can be cancellable or not.
boolean
isRetryable
Optional
Indicates whether a task is eligible for retry or not.
400
Bad Request
Returns Error of type(s) application/json
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string"
}string
errorCode
Optional
The minor error code
string
errorType
Optional
The error type
array of string
arguments
Optional
The arguments used to localize the message, Can be used by scripts to automate the error processing.
object
context
Optional
The error context (e.g. the component where it occurred).
string
message
Optional
The localized error message
string
remediationMessage
Optional
The localized remediation error message
string
referenceToken
Optional
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
500
InternalServerError
Returns Error of type(s) application/json
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string"
}string
errorCode
Optional
The minor error code
string
errorType
Optional
The error type
array of string
arguments
Optional
The arguments used to localize the message, Can be used by scripts to automate the error processing.
object
context
Optional
The error context (e.g. the component where it occurred).
string
message
Optional
The localized error message
string
remediationMessage
Optional
The localized remediation error message
string
referenceToken
Optional
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
Clusters Operations
POST
Add Datastore To Cluster
PUT
Assign Tags To Cluster
POST
Create Cluster
DELETE
Delete Cluster
GET
Get Cluster
GET
Get Cluster Create Validation
GET
Get Cluster Datastores
POST
Get Cluster Network Configuration
GET
Get Cluster Network Configuration Criteria
GET
Get Cluster Network Configuration Query Response
GET
Get Clusters
GET
Get Cluster Tag Manager Url
GET
Get Cluster Update Validation
GET
Get Datastore Criterion 1
GET
Get Datastore Query Response 1
GET
Get Datastores Criteria 1
GET
Get Host Criteria
GET
Get Host Criterion
GET
Get Host Query Response 1
GET
Get Tag Assignable For Cluster
GET
Get Tags Assigned To Cluster
GET
Get Tags Assigned To Clusters
GET
Get Vdses
POST
Import Vds To Inventory
POST
Post Datastore Query 1
POST
Post Host Query
DELETE
Remove Datastore From Cluster
DELETE
Remove Tags From Cluster
PATCH
Update Cluster
POST
Validate Cluster Creation Spec
POST
Validate Cluster Update Spec
POST
Validate Vsan Remote Datastore Mount Spec
POST
Validate Vsan Remote Datastore Spec
Deprecated