Create Edge
Create an Edge Cluster
NSX Edge cluster creation data
Show optional properties
{
"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"
}{
"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",
"tier1Unhosted": false,
"transitSubnets": [
"string"
]
}ASN to be used for the edge cluster
Edge Password for admin user
Edge Password for audit
Name for the edge cluster.
This specification contains edge cluster profile configurations
Type of edge cluster profile
Type of edge cluster
Edge Form Factor
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
Edge Password for root user.
Subnet addresses in CIDR notation that are used to assign addresses to logical links connecting service routers and distributed routers
Maximum transmission unit
Name for the Tier-0
Tier 0 Routing type -eg eBGP, Static
High-availability Mode for 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)
Transit subnet addresses in CIDR notation that are used to assign addresses to logical links connecting Tier-0 and Tier-1s
OK
{
"completionTimestamp": "string",
"creationTimestamp": "string",
"errors": [
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}
],
"id": "string",
"isCancellable": false,
"localizableDescriptionPack": {
"arguments": [
"string"
],
"component": "string",
"message": "string",
"messageKey": "string"
},
"name": "string",
"resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
"resources": [
{
"fqdn": "sfo-vc01.rainpole.io",
"name": "string",
"resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
"sans": [
"string"
],
"type": "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER"
}
],
"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED, COMPLETED_WITH_WARNING, SKIPPED",
"subTasks": [
{
"completionTimestamp": "string",
"creationTimestamp": "string",
"description": "string",
"errors": [
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}
],
"name": "string",
"resources": [
{
"fqdn": "sfo-vc01.rainpole.io",
"name": "string",
"resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
"sans": [
"string"
],
"type": "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER"
}
],
"stages": [
{
"completionTimestamp": "string",
"creationTimestamp": "string",
"description": "string",
"errors": [
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "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, NOT_APPLICABLE",
"subTasks": [
"SubTask Object"
],
"type": "string"
}
],
"type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Task completion timestamp
Task creation timestamp
Task ID
Represents task can be cancellable or not.
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.
Task name
Resolution state
Task status
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
Accepted
{
"completionTimestamp": "string",
"creationTimestamp": "string",
"errors": [
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}
],
"id": "string",
"isCancellable": false,
"localizableDescriptionPack": {
"arguments": [
"string"
],
"component": "string",
"message": "string",
"messageKey": "string"
},
"name": "string",
"resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
"resources": [
{
"fqdn": "sfo-vc01.rainpole.io",
"name": "string",
"resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
"sans": [
"string"
],
"type": "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER"
}
],
"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED, COMPLETED_WITH_WARNING, SKIPPED",
"subTasks": [
{
"completionTimestamp": "string",
"creationTimestamp": "string",
"description": "string",
"errors": [
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}
],
"name": "string",
"resources": [
{
"fqdn": "sfo-vc01.rainpole.io",
"name": "string",
"resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
"sans": [
"string"
],
"type": "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER"
}
],
"stages": [
{
"completionTimestamp": "string",
"creationTimestamp": "string",
"description": "string",
"errors": [
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "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, NOT_APPLICABLE",
"subTasks": [
"SubTask Object"
],
"type": "string"
}
],
"type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}Task completion timestamp
Task creation timestamp
Task ID
Represents task can be cancellable or not.
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.
Task name
Resolution state
Task status
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
Bad Request
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}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 minor error code
The error type
The localized error message
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized remediation error message
InternalServerError
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}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 minor error code
The error type
The localized error message
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized remediation error message