Validate Clusters Operations
Validate the input specification for Cluster creation
Request
URI
POST
https://sfo-vcf01.rainpole.io/v1/clusters/validations
COPY
Request Body
Cluster creation specification
ClusterCreationSpec of type(s) application/json
Required
Show optional properties
{
"computeSpec": {
"clusterSpecs": [
{
"datastoreSpec": {},
"hostSpecs": [
{
"id": "string"
}
],
"name": "string",
"networkSpec": {
"nsxClusterSpec": {},
"vdsSpecs": [
{
"name": "string"
}
]
}
}
]
},
"domainId": "string"
}{
"computeSpec": {
"clusterSpecs": [
{
"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"
},
"arrayContextWithKeyValuePair": {
"arrayContextWithKeyValuePair": "List Object"
},
"contextWithKeyValuePair": {
"contextWithKeyValuePair": "List Object"
},
"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"
}
}
]
},
"domainId": "string"
}
computeSpec
Required
This specification contains the parameters required to add each cluster to a workload domain
string
domainId
Required
ID of the domain to which the clusters will be added
Responses
200
Ok
Returns Validation of type(s) application/json
{
"additionalProperties": {
"additionalProperties": "string"
},
"description": "string",
"executionStatus": "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"id": "string",
"resultStatus": "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS",
"validationChecks": [
{
"description": "string",
"errorResponse": {
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
},
"nestedValidationChecks": [
"ValidationCheck Object"
],
"resultStatus": "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
"severity": "One among: WARNING, ERROR, INFO"
}
]
}object
additionalProperties
Optional
additionalProperties
string
description
Optional
Description of the validation
string
executionStatus
Optional
Execution status of the validation
string
id
Optional
ID of the validation
string
resultStatus
Optional
Result status of the validation after it has completed its execution
array of ValidationCheck
validationChecks
Optional
List of one or more validation checks that are performed as part of the validation
400
Bad Request
Returns Error of type(s) application/json
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}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
errorCode
Optional
The minor error code
string
errorType
Optional
The error type
string
message
Optional
The localized 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.
string
remediationMessage
Optional
The localized remediation error message
500
InternalServerError
Returns Error of type(s) application/json
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}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
errorCode
Optional
The minor error code
string
errorType
Optional
The error type
string
message
Optional
The localized 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.
string
remediationMessage
Optional
The localized remediation error message
Clusters Operations
POST
Add Datastore To Cluster
GET
Assignable Tags To Cluster
PUT
Assign Tags To Existing Cluster
POST
Create Cluster
DELETE
Delete Cluster
GET
Get Cluster
GET
Get Cluster Datastores
GET
Get Clusters
GET
Get Cluster Tag Manager Url
GET
Get Datastore Criterion
GET
Get Datastore Query Response
GET
Get Datastores Criteria
GET
Get Host Criteria
GET
Get Host Criterion
GET
Get Host Query Response
GET
Get Tags Assigned To Cluster
GET
Get Tags Assigned To Clusters
GET
Get Vdses
POST
Post Datastore Query
POST
Post Host Query
DELETE
Remove Datastore From Cluster
DELETE
Remove Tags From Existing Cluster
PATCH
Update Cluster
POST
Validate Cluster Operations
POST
Validate Clusters Operations
POST
Validate Vsan Remote Datastore