[{"label":"Latest (5.0.0)","version":"latest"},{"version":"4.5.1"},{"version":"4.5.0"},{"version":"4.4.0"},{"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 Edge Cluster Spec

Description

Validate an Edge Cluster spec

Request

URL

post

https://sfo-vcf01.rainpole.io/v1/edge-clusters/validations

Copy

Request Body

EdgeClusterCreationSpec of type(s) application/json Required

NSX Edge cluster creation data to be validated

Show optional properties

{
    "edgeClusterProfileType": "One among: DEFAULT, CUSTOM",
    "edgeClusterType": "One among: NSX-T",
    "edgeFormFactor": "One among: XLARGE, LARGE, MEDIUM, SMALL",
    "tier0RoutingType": "One among: EBGP, STATIC",
    "tier0ServicesHighAvailability": "One among: ACTIVE_ACTIVE, ACTIVE_STANDBY"
}

{
    "edgeClusterProfileType": "One among: DEFAULT, CUSTOM",
    "edgeClusterType": "One among: NSX-T",
    "edgeFormFactor": "One among: XLARGE, LARGE, MEDIUM, SMALL",
    "tier0RoutingType": "One among: EBGP, STATIC",
    "tier0ServicesHighAvailability": "One among: ACTIVE_ACTIVE, ACTIVE_STANDBY"
}

string

tier0ServicesHighAvailability Required

High-availability Mode for Tier-0

string

edgeAdminPassword Required

Edge Password for admin user

string

edgeAuditPassword Required

Edge Password for audit

string

edgeClusterName Required

Name for the edge cluster.

NsxTEdgeClusterProfileSpec

edgeClusterProfileSpec Required

Specifications for Edge Node

string

edgeClusterProfileType Required

Type of edge cluster profile

string

edgeClusterType Required

Type of edge cluster

string

edgeFormFactor Required

Edge Form Factor

array of NsxTEdgeNodeSpec

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

string

edgeRootPassword Required

Edge Password for root user.

string

tier1Name Required

Name for the Tier-1

integer as int32

mtu Required

Maximum transmission unit

string

tier0Name Required

Name for the Tier-0

string

tier0RoutingType Required

Tier 0 Routing type -eg eBGP, Static

integer as int64

asn Optional

ASN to be used for the edge cluster

array of string

internalTransitSubnets Optional

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

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)

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

Response

200 OK Response Body>

Response Body

200 OK

Returns Validation of type(s) application/json

{
    "executionStatus": "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
    "resultStatus": "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS"
}

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

202 Accepted Response Body>

Response Body

202 Accepted

Returns Validation of type(s) application/json

{
    "executionStatus": "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
    "resultStatus": "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS"
}

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

Error

500

InternalServerError

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"edgeClusterProfileType":"One among: DEFAULT, CUSTOM","edgeClusterType":"One among: NSX-T","edgeFormFactor":"One among: XLARGE, LARGE, MEDIUM, SMALL","tier0RoutingType":"One among: EBGP, STATIC","tier0ServicesHighAvailability":"One among: ACTIVE_ACTIVE, ACTIVE_STANDBY"}' https://sfo-vcf01.rainpole.io/v1/edge-clusters/validations

vcf

NSX-T Edge Clusters Operations

post

Create Edge

get

Get Edge Cluster

get

Get Edge Clusters

get

Get Validation For Create Edge Cluster

patch

Update Edge Cluster

post

Validate Edge Cluster Spec

post

Validate Edge Cluster Update Spec

Validate Edge Cluster Spec

Request

URL

Request Body

Response

Response Body

200 OK

Response Body

202 Accepted

Errors

Code Samples

cURL Command

On This Page

NSX-T Edge Clusters Operations

Was this page helpful?