Update Edge Gateway

Update Edge Gateway

Update a specific Edge Gateway. Only NSX-T Edge Gateways can be created with this endpoint.

Request
URI
PUT
https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}
COPY
Path Parameters
string
gatewayId
Required

gatewayId

string
gatewayId
Required

gatewayId

Request Body
EdgeGateway of type(s) application/json
Optional
This request body class requires all of the following: NetworkingObjectStatus , InlineEdgeGateway1 
{
    "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,
            "vrfLiteBacked": false,
            "backingType": "string"
        }
    ],
    "distributedRoutingEnabled": false,
    "nonDistributedRoutingEnabled": false,
    "orgVdcNetworkCount": 0,
    "gatewayBacking": {
        "backingId": "string",
        "networkProvider": {
            "name": "string",
            "id": "string"
        }
    },
    "orgVdc": {
        "name": "string",
        "id": "string"
    },
    "ownerRef": {
        "name": "string",
        "id": "string"
    },
    "orgRef": {
        "name": "string",
        "id": "string"
    },
    "serviceNetworkDefinition": "string",
    "distributedRouterUplinkNetworkDefinition": "string",
    "edgeClusterConfig": {
        "primaryEdgeCluster": {
            "edgeClusterRef": {
                "name": "string",
                "id": "string"
            },
            "backingId": "string"
        },
        "secondaryEdgeCluster": {
            "edgeClusterRef": {
                "name": "string",
                "id": "string"
            },
            "backingId": "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=37.3 
{
    "minorErrorCode": "string",
    "message": "string",
    "stackTrace": "string"
}
string
minorErrorCode
Required

minorErrorCode

string
message
Required

message

string
stackTrace
Optional

stackTrace


404

The specified resource was not found

Returns Error of type(s) */*;version=37.3 
{
    "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 Gateway Operations
DELETE
Delete Edge Gateway
GET
Get Edge Gateway
GET
Get Used Ip Addresses
PUT
Update Edge Gateway