Create Edge Cluster
Create an NSX Edge Cluster
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"
]
}Name for the edge cluster.
Type of edge cluster
Edge Password for root user.
Edge Password for admin user
Edge Password for audit
Edge Form Factor
High-availability Mode for Tier-0
Maximum transmission unit
ASN to be used for the edge cluster
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)
Tier 0 Routing type -eg eBGP, Static
Name for the 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)
Type of edge cluster profile
This specification contains edge cluster profile configurations
Set to true to bypass normal ICMP-based check of Edge TEP / host TEP routability (default is false, meaning do check)
Transit subnet addresses in CIDR notation that are used to assign addresses to logical links connecting Tier-0 and Tier-1s
Subnet addresses in CIDR notation that are used to assign addresses to logical links connecting service routers and distributed routers
Accepted
"Task Object"Task ID
Task name
A message pack representing a localizable message and suitable for machine processing. Contains a message key unique in the scope of the specified component, as well as the arguments needed to generate the localized message.
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
Task status
Task creation timestamp
Task completion timestamp
List of sub-tasks of the task
List of errors in case of a failure
List of resources associated with task
Resolution state
Represents task can be cancellable or not.
Indicates whether a task is eligible for retry or not.
Bad Request
"Error Object"The minor error code
The error type
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 localized error message
The localized remediation error message
The underlying cause exceptions.
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
InternalServerError
"Error Object"The minor error code
The error type
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 localized error message
The localized remediation error message
The underlying cause exceptions.
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
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