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

Description

Validate the input spec for hosts operations

Request

URL

post

https://sfo-vcf01.rainpole.io/v1/hosts/validations

Copy

Request Body

array of HostCommissionSpec of type(s) application/json Required

hostCommissionSpecs

Show optional properties

{
	"fqdn": "string",
	"networkPoolId": "string",
	"password": "string",
	"storageType": "One among: VSAN, NFS, VMFS_FC, VVOL",
	"username": "string"
}

{
	"fqdn": "string",
	"networkPoolId": "string",
	"networkPoolName": "string",
	"password": "string",
	"sshThumbprint": "string",
	"sslThumbprint": "string",
	"storageType": "One among: VSAN, NFS, VMFS_FC, VVOL",
	"username": "string",
	"vvolStorageProtocolType": "One among: ISCSI, NFS, FC"
}

string

fqdn Required

FQDN of the host

string

networkPoolId Required

ID of the network pool to associate the host with

string

password Required

Password of the host

string

storageType Required

Storage Type

string

username Required

Username of the host

string

networkPoolName Optional

Name of the network pool to associate the host with

string

sshThumbprint Optional

SSH thumbprint of the host

string

sslThumbprint Optional

SSL thumbprint of the host

string

vvolStorageProtocolType Optional

vVol Storage Protocol Type

Response

Response Body

202 Accepted 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

Error

400

Bad Request

500

Internal server error

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '[{"fqdn":"string","networkPoolId":"string","networkPoolName":"string","password":"string","sshThumbprint":"string","sslThumbprint":"string","storageType":"One among: VSAN, NFS, VMFS_FC, VVOL","username":"string","vvolStorageProtocolType":"One among: ISCSI, NFS, FC"}]' https://sfo-vcf01.rainpole.io/v1/hosts/validations

vcf

Hosts Operations

post

Commission Hosts

delete

Decommission Hosts

get

Get Criteria

get

Get Criterion

get

Get Host

get

Get Host Query Response

get

Get Hosts

get

Get Validation For Commission Hosts

post

Post Query

post

Validate Hosts Operations

Validate Hosts Operations

Request

URL

Request Body

Response

Response Body

Errors

Code Samples

cURL Command

On This Page

Hosts Operations

Was this page helpful?