Validate Edge Cluster Creation Spec
Perform validiation of the EdgeClusterCreationSpec specification
NSX Edge cluster creation data to be validated
Show optional properties
{
"edgeAdminPassword": "string",
"edgeAuditPassword": "string",
"edgeClusterName": "string",
"edgeClusterProfileSpec": {
"bfdAllowedHop": 0,
"bfdDeclareDeadMultiple": 0,
"bfdProbeInterval": 0,
"edgeClusterProfileName": "string",
"standbyRelocationThreshold": 0
},
"edgeClusterProfileType": "One among: DEFAULT, CUSTOM",
"edgeClusterType": "One among: NSX-T",
"edgeFormFactor": "One among: XLARGE, LARGE, MEDIUM, SMALL",
"edgeNodeSpecs": [
{
"clusterId": "string",
"edgeNodeName": "string",
"edgeTepVlan": 0,
"interRackCluster": false,
"managementGateway": "string",
"managementIP": "string"
}
],
"edgeRootPassword": "string",
"mtu": 0
}{
"asn": 0,
"edgeAdminPassword": "string",
"edgeAuditPassword": "string",
"edgeClusterName": "string",
"edgeClusterProfileSpec": {
"bfdAllowedHop": 0,
"bfdDeclareDeadMultiple": 0,
"bfdProbeInterval": 0,
"edgeClusterProfileName": "string",
"standbyRelocationThreshold": 0
},
"edgeClusterProfileType": "One among: DEFAULT, CUSTOM",
"edgeClusterType": "One among: NSX-T",
"edgeFormFactor": "One among: XLARGE, LARGE, MEDIUM, SMALL",
"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"
}
]
}
]
}
],
"edgeRootPassword": "string",
"internalTransitSubnets": [
"string"
],
"mtu": 0,
"skipTepRoutabilityCheck": false,
"tier0Name": "string",
"tier0RoutingType": "One among: EBGP, STATIC",
"tier0ServicesHighAvailability": "One among: ACTIVE_ACTIVE, ACTIVE_STANDBY",
"tier1Name": "string",
"tier1Unhosted": false,
"transitSubnets": [
"string"
]
}ASN to be used for the edge cluster
Edge Password for admin user
Edge Password for audit
Name for the edge cluster.
This specification contains edge cluster profile configurations
Type of edge cluster profile
Type of edge cluster
Edge Form Factor
Specifications for Edge Node. Number of Edge Nodes cannot exceed 8 if HA mode is ACTIVE-ACTIVE and can not exceed 2 if HA mode is ACTIVE-STANDBY
Specifications for new NSX IP address pool(s)
Edge Password for root user.
Subnet addresses in CIDR notation that are used to assign addresses to logical links connecting service routers and distributed routers
Maximum transmission unit
Set to true to bypass normal ICMP-based check of Edge TEP / host TEP routability (default is false, meaning do check)
Name for the Tier-0
Tier 0 Routing type -eg eBGP, Static
High-availability Mode for Tier-0
Name for the Tier-1
Select whether Tier-1 being created per this spec is hosted on the new Edge cluster or not (default value is false, meaning hosted)
Transit subnet addresses in CIDR notation that are used to assign addresses to logical links connecting Tier-0 and Tier-1s
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