Validate Edge Cluster Creation Spec

Validate Edge Cluster Creation Spec

Perform validiation of the EdgeClusterCreationSpec specification

Request
URI
POST
https://{api_host}/v1/edge-clusters/validations
COPY
Request Body
EdgeClusterCreationSpec of type(s) application/json
Required

Show optional properties

{
    "edgeClusterName": "string",
    "edgeClusterType": "One among: NSX-T",
    "edgeRootPassword": "string",
    "edgeAdminPassword": "string",
    "edgeAuditPassword": "string",
    "edgeFormFactor": "One among: XLARGE, LARGE, MEDIUM, SMALL",
    "mtu": 0,
    "edgeNodeSpecs": [
        {
            "edgeNodeName": "string",
            "managementIP": "string",
            "managementGateway": "string",
            "edgeTepVlan": 0
        }
    ],
    "edgeClusterProfileType": "One among: DEFAULT, CUSTOM",
    "edgeClusterProfileSpec": {
        "edgeClusterProfileName": "string",
        "bfdAllowedHop": 0,
        "bfdDeclareDeadMultiple": 0,
        "bfdProbeInterval": 0,
        "standbyRelocationThreshold": 0
    }
}
{
    "edgeClusterName": "string",
    "edgeClusterType": "One among: NSX-T",
    "edgeRootPassword": "string",
    "edgeAdminPassword": "string",
    "edgeAuditPassword": "string",
    "edgeFormFactor": "One among: XLARGE, LARGE, MEDIUM, SMALL",
    "tier0ServicesHighAvailability": "One among: ACTIVE_ACTIVE, ACTIVE_STANDBY",
    "mtu": 0,
    "asn": 0,
    "edgeNodeSpecs": [
        {
            "edgeNodeName": "string",
            "managementIP": "string",
            "managementGateway": "string",
            "vmManagementPortgroupVlan": 0,
            "vmManagementPortgroupName": "string",
            "edgeTepGateway": "string",
            "edgeTep1IP": "string",
            "edgeTep2IP": "string",
            "edgeTepIpAddressPool": {
                "name": "string",
                "nsxId": "string"
            },
            "edgeTepVlan": 0,
            "clusterId": "string",
            "interRackCluster": false,
            "uplinkNetwork": [
                {
                    "uplinkVlan": 0,
                    "uplinkInterfaceIP": "string",
                    "peerIP": "string",
                    "asnPeer": 0,
                    "bgpPeerPassword": "string",
                    "bgpPeers": [
                        {
                            "ip": "string",
                            "asn": 0,
                            "password": "string"
                        }
                    ]
                }
            ],
            "firstNsxVdsUplink": "One among: uplink1, uplink2, uplink3, uplink4, uplink5, uplink6, uplink7, uplink8",
            "secondNsxVdsUplink": "One among: uplink1, uplink2, uplink3, uplink4, uplink5, uplink6, uplink7, uplink8"
        }
    ],
    "newIpAddressPoolSpecs": [
        {
            "name": "string",
            "description": "string",
            "ignoreUnavailableNsxtCluster": false,
            "subnets": [
                {
                    "ipAddressPoolRanges": [
                        {
                            "start": "string",
                            "end": "string"
                        }
                    ],
                    "cidr": "string",
                    "gateway": "string"
                }
            ]
        }
    ],
    "tier0RoutingType": "One among: EBGP, STATIC",
    "tier0Name": "string",
    "tier1Name": "string",
    "tier1Unhosted": false,
    "edgeClusterProfileType": "One among: DEFAULT, CUSTOM",
    "edgeClusterProfileSpec": {
        "edgeClusterProfileName": "string",
        "bfdAllowedHop": 0,
        "bfdDeclareDeadMultiple": 0,
        "bfdProbeInterval": 0,
        "standbyRelocationThreshold": 0
    },
    "skipTepRoutabilityCheck": false,
    "transitSubnets": [
        "string"
    ],
    "internalTransitSubnets": [
        "string"
    ]
}
string
edgeClusterName
Required
Constraints: minLength: 0 maxLength: 80

Name for the edge cluster.

string As (NSX-T)
edgeClusterType
Required

Type of edge cluster

string
edgeRootPassword
Required

Edge Password for root user.

string
edgeAdminPassword
Required

Edge Password for admin user

string
edgeAuditPassword
Required

Edge Password for audit

string As (XLARGE|LARGE|MEDIUM|SMALL)
edgeFormFactor
Required

Edge Form Factor

string As (ACTIVE_ACTIVE|ACTIVE_STANDBY|)
tier0ServicesHighAvailability
Optional

High-availability Mode for Tier-0

integer As int32 As int32
mtu
Required

Maximum transmission unit

integer As int64 As int64
asn
Optional
Constraints: minimum: 1 maximum: 4294967295

ASN to be used for the edge cluster

array of object
edgeNodeSpecs
Required

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

array of object
newIpAddressPoolSpecs
Optional

Specifications for new NSX IP address pool(s)

string As (EBGP|STATIC|)
tier0RoutingType
Optional

Tier 0 Routing type -eg eBGP, Static

string
tier0Name
Optional
Constraints: minLength: 0 maxLength: 30

Name for the Tier-0

string
tier1Name
Optional
Constraints: minLength: 0 maxLength: 30

Name for the Tier-1

boolean
tier1Unhosted
Optional

Select whether Tier-1 being created per this spec is hosted on the new Edge cluster or not (default value is false, meaning hosted)

string As (CUSTOM|DEFAULT)
edgeClusterProfileType
Required

Type of edge cluster profile

object
edgeClusterProfileSpec
Required

This specification contains edge cluster profile configurations

boolean
skipTepRoutabilityCheck
Optional

Set to true to bypass normal ICMP-based check of Edge TEP / host TEP routability (default is false, meaning do check)

array of string
transitSubnets
Optional

Transit subnet addresses in CIDR notation that are used to assign addresses to logical links connecting Tier-0 and Tier-1s

array of string
internalTransitSubnets
Optional
Constraints: minItems: 0 maxItems: 1

Subnet addresses in CIDR notation that are used to assign addresses to logical links connecting service routers and distributed routers

Responses
202

Accepted

Returns Validation of type(s) application/json
"Validation Object"
string
id
Required

ID of the validation

string
description
Required

Description of the validation

string
executionStatus
Required

Execution status of the validation. One among: IN_PROGRESS, FAILED, COMPLETED, UNKNOWN, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS

string
resultStatus
Required

Result status of the validation after it has completed its execution. One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, UNKNOWN, CANCELLATION_IN_PROGRESS

array of object
validationChecks
Optional

List of one or more validation checks that are performed as part of the validation

object
additionalProperties
Optional

additionalProperties


400

Bad Request

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


500

InternalServerError

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"edgeAdminPassword:"string","edgeAuditPassword:"string","edgeClusterName:"string","edgeClusterProfileSpec:"object","edgeClusterProfileType:"string","edgeClusterType:"string","edgeFormFactor:"string","edgeNodeSpecs":["object"],"edgeRootPassword:"string","mtu:"integer"}' https://{api_host}/v1/edge-clusters/validations