Validate Edge Cluster Update Spec
Perform validation of the EdgeClusterUpdateSpec specification
NSX Edge cluster id
NSX Edge Cluster Update spec to be validated
Show optional properties
{
"operation": "One among: EXPANSION, SHRINKAGE"
}{
"edgeClusterExpansionSpec": {
"additionalTier1Names": [
"string"
],
"edgeNodeAdminPassword": "string",
"edgeNodeAuditPassword": "string",
"edgeNodeRootPassword": "string",
"edgeNodeSpecs": [
{
"clusterId": "string",
"edgeNodeName": "string",
"edgeTep1IP": "string",
"edgeTep2IP": "string",
"edgeTepGateway": "string",
"edgeTepIpAddressPool": {
"name": "string",
"nsxId": "string"
},
"edgeTepVlan": 0,
"firstNsxVdsUplink": "One among: uplink1, uplink2, uplink3, uplink4, uplink5, uplink6, uplink7, uplink8",
"interRackCluster": false,
"managementGateway": "string",
"managementIP": "string",
"vmManagementPortgroupVlan": 0,
"vmManagementPortgroupName": "string",
"secondNsxVdsUplink": "One among: uplink1, uplink2, uplink3, uplink4, uplink5, uplink6, uplink7, uplink8",
"uplinkNetwork": [
{
"asnPeer": 0,
"bgpPeerPassword": "string",
"bgpPeers": [
{
"asn": 0,
"ip": "string",
"password": "string"
}
],
"peerIP": "string",
"uplinkInterfaceIP": "string",
"uplinkVlan": 0
}
]
}
],
"newIpAddressPoolSpecs": [
{
"description": "string",
"ignoreUnavailableNsxtCluster": false,
"name": "string",
"subnets": [
{
"cidr": "string",
"gateway": "string",
"ipAddressPoolRanges": [
{
"end": "string",
"start": "string"
}
]
}
]
}
],
"skipTepRoutabilityCheck": false,
"tier1Unhosted": false
},
"edgeClusterShrinkageSpec": {
"edgeNodeIds": [
"string"
]
},
"operation": "One among: EXPANSION, SHRINKAGE"
}This specification contains the parameters required to expand a NSX edge cluster.
This specification contains the parameters required to shrink a NSX edge cluster.
Edge cluster operation Type.
OK
{
"additionalProperties": {
"additionalProperties": "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": {
"context": "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"
}
]
}additionalProperties
Description of the validation
Execution status of the validation
ID of the validation
Result status of the validation after it has completed its execution
List of one or more validation checks that are performed as part of the validation
Accepted
{
"additionalProperties": {
"additionalProperties": "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": {
"context": "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"
}
]
}additionalProperties
Description of the validation
Execution status of the validation
ID of the validation
Result status of the validation after it has completed its execution
List of one or more validation checks that are performed as part of the validation
Bad Request
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
The minor error code
The error type
The localized error message
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized remediation error message
InternalServerError
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
The minor error code
The error type
The localized error message
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized remediation error message