[{"label":"Latest (4.4.0)","version":"latest"},{"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

Request

URL

URL


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

Request Body

Request Body

EdgeClusterCreationSpec of type(s) application/json Required

NSX-T Edge cluster creation data

{
	"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",
			"edgeTepVlan": 0,
			"interRackCluster": false,
			"managementGateway": "string",
			"managementIP": "string"
		}
	],
	"edgeRootPassword": "string",
	"mtu": 0,
	"tier0Name": "string",
	"tier0RoutingType": "One among: EBGP, STATIC",
	"tier0ServicesHighAvailability": "One among: ACTIVE_ACTIVE, ACTIVE_STANDBY",
	"tier1Name": "string"
}
integer as int64
asn Required

ASN to be used for the edge cluster


string
edgeAdminPassword Required

Edge Password for admin user


string
edgeAuditPassword Required

Edge Password for audit


string
edgeClusterName Required

Name for the edge cluster.


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


string
tier0ServicesHighAvailability Required

High-availability Mode for Tier-0


array of string
internalTransitSubnets Introduced Changed 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 Introduced Changed Optional

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

Response

Response

Response Body

Response Body

202 Accepted returns Task of type(s) application/json
{
	"completionTimestamp": "string",
	"creationTimestamp": "string",
	"errors": [
		{
			"arguments": [
				"string"
			],
			"causes": [
				{
					"message": "string",
					"type": "string"
				}
			],
			"context": {
				"key": "string"
			},
			"errorCode": "string",
			"errorType": "string",
			"message": "string",
			"nestedErrors": "Error Object",
			"referenceToken": "string",
			"remediationMessage": "string"
		}
	],
	"id": "string",
	"isCancellable": false,
	"name": "string",
	"resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
	"resources": [
		{
			"fqdn": "string",
			"name": "string",
			"resourceId": "string",
			"sans": [
				"string"
			],
			"type": "string"
		}
	],
	"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
	"subTasks": [
		{
			"completionTimestamp": "string",
			"creationTimestamp": "string",
			"description": "string",
			"errors": [
				{
					"arguments": [
						"string"
					],
					"causes": [
						{
							"message": "string",
							"type": "string"
						}
					],
					"context": {
						"key": "string"
					},
					"errorCode": "string",
					"errorType": "string",
					"message": "string",
					"nestedErrors": "Error Object",
					"referenceToken": "string",
					"remediationMessage": "string"
				}
			],
			"name": "string",
			"resources": [
				{
					"fqdn": "string",
					"name": "string",
					"resourceId": "string",
					"sans": [
						"string"
					],
					"type": "string"
				}
			],
			"stages": [
				{
					"completionTimestamp": "string",
					"creationTimestamp": "string",
					"description": "string",
					"errors": [
						{
							"arguments": [
								"string"
							],
							"causes": [
								{
									"message": "string",
									"type": "string"
								}
							],
							"context": {
								"key": "string"
							},
							"errorCode": "string",
							"errorType": "string",
							"message": "string",
							"nestedErrors": "Error Object",
							"referenceToken": "string",
							"remediationMessage": "string"
						}
					],
					"name": "string",
					"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
					"type": "string"
				}
			],
			"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
			"subTasks": "SubTask Object",
			"type": "string"
		}
	],
	"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.


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

Errors

400

Bad Request


500

InternalServerError

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"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","edgeTepVlan":0,"firstNsxVdsUplink":"One among: uplink1, uplink2, uplink3, uplink4","interRackCluster":false,"managementGateway":"string","managementIP":"string","secondNsxVdsUplink":"One among: uplink1, uplink2, uplink3, uplink4","uplinkNetwork":[{"asnPeer":0,"bgpPeerPassword":"string","bgpPeers":[{"asn":0,"ip":"string","password":"string"}],"peerIP":"string","uplinkInterfaceIP":"string","uplinkVlan":0}]}],"edgeRootPassword":"string","internalTransitSubnets":["string"],"mtu":0,"tier0Name":"string","tier0RoutingType":"One among: EBGP, STATIC","tier0ServicesHighAvailability":"One among: ACTIVE_ACTIVE, ACTIVE_STANDBY","tier1Name":"string","transitSubnets":["string"]}' https://sfo-vcf01.rainpole.io/v1/edge-clusters


[{"label":"Latest (4.4.0)","version":"latest"},{"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
Feedback

Was this page helpful?