Get All Edge Gateways
Get all edge gateways. If "ownerRef.id" filter is not specified, then user will see all the edge gateways in the organization they have the right to view. Results can be filtered by ownerRef. Combination of ownerRef and includeAccessible (includeAccessible==true) can be used to get all the edge gateways which are available to an Org vDC including the gateways which are owned by datacenter groups but available to Org vDC. The following context is deprecated as of API version 38.0: Combination of ownerRef and _context. (_context==includeAccessible)
Request
URI
GET
https://{api_host}/cloudapi/1.0.0/edgeGateways
COPY
Query Parameters
string
filter
Optional
Filter for a query. FIQL format.
string
sortAsc
Optional
Field to use for ascending sort
string
sortDesc
Optional
Field to use for descending sort
integer
page
Required
Page to fetch, zero offset.
integer
pageSize
Required
Results per page to fetch.
Responses
200
OK
Returns EdgeGateways of type(s) application/json;version=38.1
This response body class contains all of the following: Page , InlineEdgeGateways1
{
"resultTotal": 0,
"pageCount": 0,
"page": 0,
"pageSize": 0,
"associations": [
{
"entityId": "string",
"associationId": "string"
}
],
"values": [
{
"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",
"vrfLiteBacked": false,
"backingType": "string"
}
],
"distributedRoutingEnabled": false,
"nonDistributedRoutingEnabled": false,
"orgVdcNetworkCount": 0,
"gatewayBacking": {
"backingId": "string",
"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",
"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"
}
}
]
}
}
]
}
Availability
Added in 32.0
Edge Gateways Operations
POST
Create Edge Gateway
GET
Get All Edge Gateways