Create Edge Cluster

Create Edge Cluster

Create an NSX Edge Cluster

Request
URI
POST
https://sfo-vcf01.rainpole.io/v1/edge-clusters
COPY
Request Body

NSX Edge cluster creation data

EdgeClusterCreationSpec of type(s) application/json
Required

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",
            "edgeTepVlan": 0,
            "interRackCluster": false,
            "managementGateway": "string",
            "managementIP": "string"
        }
    ],
    "edgeRootPassword": "string",
    "mtu": 0
}
{
    "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",
            "edgeTepIpAddressPool": {
                "name": "string",
                "nsxId": "string"
            },
            "edgeTepVlan": 0,
            "firstNsxVdsUplink": "One among: uplink1, uplink2, uplink3, uplink4, uplink5, uplink6, uplink7, uplink8",
            "interRackCluster": false,
            "managementGateway": "string",
            "managementIP": "string",
            "vmManagementPortgroupVlan": 0,
            "vmManagementPortgroupName": "string",
            "secondNsxVdsUplink": "One among: uplink1, uplink2, uplink3, uplink4, uplink5, uplink6, uplink7, uplink8",
            "uplinkNetwork": [
                {
                    "asnPeer": 0,
                    "bgpPeerPassword": "string",
                    "bgpPeers": [
                        {
                            "asn": 0,
                            "ip": "string",
                            "password": "string"
                        }
                    ],
                    "peerIP": "string",
                    "uplinkInterfaceIP": "string",
                    "uplinkVlan": 0
                }
            ]
        }
    ],
    "newIpAddressPoolSpecs": [
        {
            "description": "string",
            "ignoreUnavailableNsxtCluster": false,
            "name": "string",
            "subnets": [
                {
                    "cidr": "string",
                    "gateway": "string",
                    "ipAddressPoolRanges": [
                        {
                            "end": "string",
                            "start": "string"
                        }
                    ]
                }
            ]
        }
    ],
    "edgeRootPassword": "string",
    "internalTransitSubnets": [
        "string"
    ],
    "mtu": 0,
    "skipTepRoutabilityCheck": false,
    "tier0Name": "string",
    "tier0RoutingType": "One among: EBGP, STATIC",
    "tier0ServicesHighAvailability": "One among: ACTIVE_ACTIVE, ACTIVE_STANDBY",
    "tier1Name": "string",
    "tier1Unhosted": false,
    "transitSubnets": [
        "string"
    ]
}
integer As int64 As int64
asn
Optional

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

This specification contains edge cluster profile configurations

string
edgeClusterProfileType
Required

Type of edge cluster profile

string
edgeClusterType
Required

Type of edge cluster

string
edgeFormFactor
Required

Edge Form Factor

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

newIpAddressPoolSpecs
Optional

Specifications for new NSX IP address pool(s)

string
edgeRootPassword
Required

Edge Password for root user.

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

integer As int32 As int32
mtu
Required

Maximum transmission unit

boolean
skipTepRoutabilityCheck
Optional

Set to true to bypass normal ICMP-based check of Edge TEP / host TEP routability (default is false, meaning do check)

string
tier0Name
Optional

Name for the Tier-0

string
tier0RoutingType
Optional

Tier 0 Routing type -eg eBGP, Static

string
tier0ServicesHighAvailability
Optional

High-availability Mode for Tier-0

string
tier1Name
Optional

Name for the Tier-1

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

Responses
200

OK

Returns Task of type(s) application/json
{
    "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, In Progress, SUCCESSFUL, Successful, FAILED, Failed, CANCELLED, 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",
    "isRetryable": false
}
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.

localizableDescriptionPack
Optional

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.

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 _

boolean
isRetryable
Optional

Indicates whether a task is eligible for retry or not.


202

Accepted

Returns Task of type(s) application/json
{
    "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, In Progress, SUCCESSFUL, Successful, FAILED, Failed, CANCELLED, 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",
    "isRetryable": false
}
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.

localizableDescriptionPack
Optional

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.

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 _

boolean
isRetryable
Optional

Indicates whether a task is eligible for retry or not.


400

Bad Request

Returns Error of type(s) application/json
{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "context": {
        "context": "string"
    },
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}
array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

array of ErrorCause
causes
Optional

The underlying cause exceptions.

object
context
Optional

The error context (e.g. the component where it occurred).

string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

string
message
Optional

The localized error message

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string
remediationMessage
Optional

The localized remediation error message


500

InternalServerError

Returns Error of type(s) application/json
{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "context": {
        "context": "string"
    },
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}
array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

array of ErrorCause
causes
Optional

The underlying cause exceptions.

object
context
Optional

The error context (e.g. the component where it occurred).

string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

string
message
Optional

The localized error message

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string
remediationMessage
Optional

The localized remediation error message