[{"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/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

Create Edge

Description

Create an Edge Cluster

Request

URL

post

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

Copy

Request Body

EdgeClusterCreationSpec of type(s) application/json Required

NSX-T Edge cluster creation data

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 T1 .

integer as int32

mtu Required

Maximum transmission unit

string

tier0Name Required

Name for the T0 .

string

tier0RoutingType Required

Tier 0 Routing type -eg eBGP, Static

integer as int64

asn Changed 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

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 Task of type(s) application/json

{
    "resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
    "status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
    "type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}

string

completionTimestamp Optional

Task completion timestamp

string

creationTimestamp Optional

Task creation timestamp

array of Error

errors Optional

List of errors in case of a failure

string

id Optional

Task ID

boolean

isCancellable Optional

Represents task can be cancellable or not.

MessagePack

localizableDescriptionPack Introduced Optional

Localizable Task description

string

name Optional

Task name

string

resolutionStatus Optional

Resolution state

array of Resource

resources Optional

List of resources associated with task

string

status Optional

Task status

array of SubTask

subTasks Optional

List of sub-tasks of the task

string

type Optional

Operation that is represented by the Task in machine readable format. The value is controlled by the owners/producers of the Task. The convention is _

202 Accepted Response Body>

Response Body

202 Accepted

Returns Task of type(s) application/json

{
    "resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
    "status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
    "type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}

string

completionTimestamp Optional

Task completion timestamp

string

creationTimestamp Optional

Task creation timestamp

array of Error

errors Optional

List of errors in case of a failure

string

id Optional

Task ID

boolean

isCancellable Optional

Represents task can be cancellable or not.

MessagePack

localizableDescriptionPack Introduced Optional

Localizable Task description

string

name Optional

Task name

string

resolutionStatus Optional

Resolution state

array of Resource

resources Optional

List of resources associated with task

string

status Optional

Task status

array of SubTask

subTasks Optional

List of sub-tasks of the task

string

type Optional

Operation that is represented by the Task in machine readable format. The value is controlled by the owners/producers of the Task. The convention is _

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

vcf-for-vxrail

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

Create Edge

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?