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 filter "candidatesForVdcGroup" (candidatesForVdcGroup==vdcGroupId>) can be used to return only edge gateways that can be associated with that VDC Group. The following context is deprecated as of API version 38.0: Combination of ownerRef and _context. (_context==includeAccessible) The filter "loadBalancerCloudId" (loadBalancerCloudId==[ID]) can be used to return the edge gateways that are associated with that Load Balancer Cloud.
Filter for a query. FIQL format.
Field to use for ascending sort
Field to use for descending sort
Page to fetch, zero offset.
Results per page to fetch.
OK
{
"resultTotal": 0,
"pageCount": 0,
"page": 0,
"pageSize": 0,
"associations": [
{
"entityId": "string",
"associationId": "string"
}
],
"values": [
{
"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"
}
}
]
}
}
]
}