[{"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 Cluster Operations

Description

Validate the input spec for operations on a cluster

Request

Request

URL

URL


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

Path Parameters

Path Parameters

string
id Required

Cluster ID


Request Body

Request Body

ClusterUpdateSpec of type(s) application/json Required

clusterUpdateSpec

{
	"clusterCompactionSpec": {
		"force": false,
		"forceByPassingSafeMinSize": false,
		"hosts": [
			{
				"azName": "string",
				"fqdn": "string",
				"id": "string",
				"ipAddress": "string",
				"vmNics": [
					{
						"isActive": false,
						"isAutoNegotiateSupported": false,
						"isInUse": false,
						"linkSpeedMB": 0,
						"name": "string"
					}
				]
			}
		]
	},
	"clusterExpansionSpec": {
		"forceHostAdditionInPresenceofDeadHosts": false,
		"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"
			}
		],
		"interRackExpansion": false,
		"skipThumbprintValidation": false,
		"vsanNetworkSpecs": [
			{
				"vsanCidr": "string",
				"vsanGatewayIP": "string"
			}
		],
		"witnessSpec": {
			"fqdn": "string",
			"vsanCidr": "string",
			"vsanIp": "string"
		},
		"witnessTrafficSharedWithVsanTraffic": false
	},
	"clusterStretchSpec": {
		"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"
			}
		],
		"isEdgeClusterConfiguredForMultiAZ": false,
		"secondaryAzOverlayVlanId": 0,
		"vsanNetworkSpecs": [
			{
				"vsanCidr": "string",
				"vsanGatewayIP": "string"
			}
		],
		"witnessSpec": {
			"fqdn": "string",
			"vsanCidr": "string",
			"vsanIp": "string"
		},
		"witnessTrafficSharedWithVsanTraffic": false
	},
	"clusterUnstretchSpec": {},
	"markForDeletion": false,
	"prepareForStretch": false
}
clusterCompactionSpec Optional

Parameters required to perform cluster compaction, optional otherwise


clusterExpansionSpec Optional

Parameters required to perform cluster expansion, optional otherwise


clusterStretchSpec Optional

Parameters required to perform Stretch operation on cluster, optional otherwise


clusterUnstretchSpec Optional

Parameters required to perform Unstretch operation on cluster, optional otherwise


boolean
markForDeletion Optional

Prepare the cluster for deletion


boolean
prepareForStretch Optional

Prepare the cluster for stretch

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


404

Not Found


500

InternalServerError

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"clusterCompactionSpec":{"force":false,"forceByPassingSafeMinSize":false,"hosts":[{"azName":"string","fqdn":"string","id":"string","ipAddress":"string","vmNics":[{"isActive":false,"isAutoNegotiateSupported":false,"isInUse":false,"linkSpeedMB":0,"name":"string"}]}]},"clusterExpansionSpec":{"forceHostAdditionInPresenceofDeadHosts":false,"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"}],"interRackExpansion":false,"skipThumbprintValidation":false,"vsanNetworkSpecs":[{"vsanCidr":"string","vsanGatewayIP":"string"}],"witnessSpec":{"fqdn":"string","vsanCidr":"string","vsanIp":"string"},"witnessTrafficSharedWithVsanTraffic":false},"clusterStretchSpec":{"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"}],"isEdgeClusterConfiguredForMultiAZ":false,"secondaryAzOverlayVlanId":0,"vsanNetworkSpecs":[{"vsanCidr":"string","vsanGatewayIP":"string"}],"witnessSpec":{"fqdn":"string","vsanCidr":"string","vsanIp":"string"},"witnessTrafficSharedWithVsanTraffic":false},"clusterUnstretchSpec":{},"markForDeletion":false,"prepareForStretch":false}' https://sfo-vcf01.rainpole.io/v1/clusters/{id}/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?