[{"label":"Latest (4.4.0)","version":"latest"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1126/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1077/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1032/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1002/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/921/vmware-cloud-foundation","version":"4.0"},{"link":"https://developer.vmware.com/apis/925/vmware-cloud-foundation","version":"3.10"},{"link":"https://developer.vmware.com/apis/891/vmware-cloud-foundation","version":"3.9.1"},{"link":"https://developer.vmware.com/apis/723/vmware-cloud-foundation","version":"3.9.0"},{"link":"https://developer.vmware.com/apis/711/vmware-cloud-foundation","version":"3.8.1"},{"link":"https://developer.vmware.com/apis/685/vmware-cloud-foundation","version":"3.8"}]
vcf

Validate Clusters Operations

Description

Validate the input spec for clusters operations

Request

Request

URL

URL


post
https://sfo-vcf01.rainpole.io/v1/clusters/validations
Copy

Request Body

Request Body

ClusterCreationSpec of type(s) application/json Required

Clusters Operation Spec Validation

{
	"computeSpec": {
		"clusterSpecs": [
			{
				"datastoreSpec": {},
				"hostSpecs": [
					{
						"id": "string"
					}
				],
				"name": "string",
				"networkSpec": {
					"nsxClusterSpec": {},
					"vdsSpecs": [
						{
							"name": "string"
						}
					]
				}
			}
		]
	},
	"domainId": "string"
}
computeSpec Required

Cluster specification to be added to the domain


string
domainId Required

ID of the domain to which the clusters will be added

Response

Response

Response Body

Response Body

200 OK returns Validation of type(s) application/json
{
	"additionalProperties": {
		"key": "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": {
					"key": "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"
		}
	]
}
map of string
additionalProperties Optional

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

Errors

Errors

400

Bad Request


500

InternalServerError

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"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":[{"IpAddressPoolRangeSpec":"Too large to render past this point..."}]}]}}},"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"}}],"skipFailedHosts":"false"},"domainId":"string"}' https://sfo-vcf01.rainpole.io/v1/clusters/validations


[{"label":"Latest (4.4.0)","version":"latest"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1126/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1077/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1032/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1002/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/921/vmware-cloud-foundation","version":"4.0"},{"link":"https://developer.vmware.com/apis/925/vmware-cloud-foundation","version":"3.10"},{"link":"https://developer.vmware.com/apis/891/vmware-cloud-foundation","version":"3.9.1"},{"link":"https://developer.vmware.com/apis/723/vmware-cloud-foundation","version":"3.9.0"},{"link":"https://developer.vmware.com/apis/711/vmware-cloud-foundation","version":"3.8.1"},{"link":"https://developer.vmware.com/apis/685/vmware-cloud-foundation","version":"3.8"}]
vcf
Feedback

Was this page helpful?