[{"label":"Latest (5.0.0)","version":"latest"},{"version":"4.5.1"},{"version":"4.5.0"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]

vcf-for-vxrail

Validate Cluster Operations

Description

Validate input specification for updating given Cluster

Request

URL

post

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

Copy

Path Parameters

string

id Required

Cluster ID

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,
	"name": "string",
	"prepareForStretch": false
}

ClusterCompactionSpec

clusterCompactionSpec Optional

Parameters required to perform cluster compaction, optional otherwise

ClusterExpansionSpec

clusterExpansionSpec Optional

Parameters required to perform cluster expansion, optional otherwise

ClusterStretchSpec

clusterStretchSpec Optional

Parameters required to perform Stretch operation on cluster, optional otherwise

ClusterUnstretchSpec

clusterUnstretchSpec Optional

Parameters required to perform Unstretch operation on cluster, optional otherwise

boolean

markForDeletion Optional

Prepare the cluster for deletion

string

name Optional

Cluster Name

boolean

prepareForStretch Optional

Prepare the cluster for stretch

Response

Response Body

200 OK

Returns Validation of type(s) application/json

{
    "executionStatus": "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
    "resultStatus": "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS"
}

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

Error

400

Bad Request

Error

404

Not Found

Error

500

InternalServerError

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,"name":"string","prepareForStretch":false}' https://sfo-vcf01.rainpole.io/v1/clusters/{id}/validations

vcf-for-vxrail

Clusters Operations

post

Add Datastore To Cluster Introduced

put

Assign Tags To Existing Cluster Introduced

get

Assignable Tags To Cluster Introduced

post

Create Cluster

delete

Delete Cluster

get

Get Cluster

get

Get Cluster Create Validation

get

Get Cluster Datastores Introduced

get

Get Cluster Tag Manager URL

get

Get Cluster Update Validation

get

Get Clusters

get

Get Datastore Criterion Introduced

get

Get Datastore Query Response Introduced

get

Get Datastores Criteria Introduced

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 Introduced

get

Get VDses

post

Post Datastore Query Introduced

post

Post Host Query

delete

Remove Datastore From Cluster Introduced

delete

Remove Tags From Existing Cluster Introduced

patch

Update Cluster

post

Validate Cluster Operations

post

Validate Clusters Operations

post

Validate vSAN Remote Datastore Introduced

Validate Cluster Operations

Request

URL

Path Parameters

Request Body

Response

Response Body

200 OK

Errors

Code Samples

cURL Command

On This Page

Clusters Operations

Was this page helpful?