Create Edge Gateway

Create Edge Gateway

Create a new edge gateway for a vDC. Only NSX-T Edge Gateways can be created with this endpoint.

Request
URI
POST
https://{api_host}/cloudapi/1.0.0/edgeGateways
COPY
Request Body
EdgeGateway of type(s) application/json
Optional
This request body class requires all of the following: NetworkingObjectStatus , InlineEdgeGateway1 
{
    "status": {},
    "id": "string",
    "name": "string",
    "description": "string",
    "edgeGatewayUplinks": [
        {
            "uplinkId": "string",
            "uplinkName": "string",
            "subnets": {
                "values": [
                    {
                        "gateway": "string",
                        "prefixLength": 0,
                        "dnsSuffix": "string",
                        "dnsServer1": "string",
                        "dnsServer2": "string",
                        "ipRanges": {
                            "values": [
                                {
                                    "startAddress": "string",
                                    "endAddress": "string"
                                }
                            ]
                        },
                        "enabled": false,
                        "totalIpCount": 0,
                        "usedIpCount": 0,
                        "primaryIp": "string",
                        "autoAllocateIpRanges": false
                    }
                ]
            },
            "connected": false,
            "quickAddAllocatedIpCount": 0,
            "dedicated": false,
            "usingIpSpace": false,
            "natAndFirewallServiceIntention": "string",
            "vpnServiceIntention": "string",
            "vrfLiteBacked": false,
            "backingType": "string"
        }
    ],
    "distributedRoutingEnabled": false,
    "nonDistributedRoutingEnabled": false,
    "orgVdcNetworkCount": 0,
    "gatewayBacking": {
        "backingId": "string",
        "gatewayType": {},
        "networkProvider": {
            "name": "string",
            "id": "string"
        },
        "isUniversalVdcGroupEdge": false,
        "networkingTenancyEnabled": false
    },
    "orgVdc": {
        "name": "string",
        "id": "string"
    },
    "ownerRef": {
        "name": "string",
        "id": "string"
    },
    "orgRef": {
        "name": "string",
        "id": "string"
    },
    "serviceNetworkDefinition": "string",
    "distributedRouterUplinkNetworkDefinition": "string",
    "deploymentMode": "string",
    "edgeClusterConfig": {
        "primaryEdgeCluster": {
            "edgeClusterRef": {
                "name": "string",
                "id": "string"
            },
            "backingId": "string",
            "networkProviderScope": "string",
            "nsxTManagerRef": {
                "name": "string",
                "id": "string"
            }
        },
        "secondaryEdgeCluster": {
            "edgeClusterRef": {
                "name": "string",
                "id": "string"
            },
            "backingId": "string",
            "networkProviderScope": "string",
            "nsxTManagerRef": {
                "name": "string",
                "id": "string"
            }
        },
        "secondaryEdgeClusters": [
            {
                "edgeClusterRef": {
                    "name": "string",
                    "id": "string"
                },
                "backingId": "string",
                "networkProviderScope": "string",
                "nsxTManagerRef": {
                    "name": "string",
                    "id": "string"
                }
            }
        ]
    }
}
Authentication
This operation uses the following authentication methods.
Responses
202

The request have been accepted and the task to monitor the request is in the Location header.

Operation doesn't return any data structure

400

Invalid configuration.

Returns Error of type(s) */*;version=39.0 
{
    "minorErrorCode": "string",
    "message": "string",
    "stackTrace": "string"
}
string
minorErrorCode
Required

minorErrorCode

string
message
Required

message

string
stackTrace
Optional

stackTrace


Availability
Added in 32.0
On This Page
Edge Gateways Operations
POST
Create Edge Gateway
GET
Get All Edge Gateways