[{"label":"Latest (4.4.0)","version":"latest"},{"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 Edge Cluster Update Spec
DescriptionValidate an NSX-T Edge Cluster update spec
Request
URLURL
https://sfo-vcf01.rainpole.io/v1/edge-clusters/{id}/validations
Path Parameters
Path Parameters
string
id
Required
NSX-T Edge cluster id
Request Body
Request Body
EdgeClusterUpdateSpec
of type(s) application/json
Required
NSX-T Edge Cluster Update spec to be validated
{
"operation": "One among: EXPANSION, SHRINKAGE"
}
string
operation
Required
Edge cluster operation Type.
edgeClusterExpansionSpec
Optional
Parameters required to perform edge cluster expansion, optional otherwise
edgeClusterShrinkageSpec
Optional
Parameters required to perform edge cluster shrinkage, optional otherwise
Response
Response
Response BodyResponse 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
Code Samples
Code Samples
cURL Command
curl -X POST -H "Content-Type: application/json" -d '{"edgeClusterExpansionSpec":{"additionalTier1Names":["string"],"edgeNodeAdminPassword":"string","edgeNodeAuditPassword":"string","edgeNodeRootPassword":"string","edgeNodeSpecs":[{"clusterId":"string","edgeNodeName":"string","edgeTep1IP":"string","edgeTep2IP":"string","edgeTepGateway":"string","edgeTepVlan":0,"firstNsxVdsUplink":"One among: uplink1, uplink2, uplink3, uplink4","interRackCluster":false,"managementGateway":"string","managementIP":"string","secondNsxVdsUplink":"One among: uplink1, uplink2, uplink3, uplink4","uplinkNetwork":[{"asnPeer":0,"bgpPeerPassword":"string","bgpPeers":[{"asn":0,"ip":"string","password":"string"}],"peerIP":"string","uplinkInterfaceIP":"string","uplinkVlan":0}]}]},"edgeClusterShrinkageSpec":{"edgeNodeIds":["string"]},"operation":"One among: EXPANSION, SHRINKAGE"}' https://sfo-vcf01.rainpole.io/v1/edge-clusters/{id}/validations
[{"label":"Latest (4.4.0)","version":"latest"},{"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
