Get All External Networks

Get All External Networks

Get all external networks. Supported filters are:

  • id
  • name
  • backing type (networkBackings.values.backingType)
  • vDC Group ID (vdcGroupId==[ID]) - | Returns all the external networks which are accessible to a specific NSX-T vDC Group.
  • Provider vDC ID (providerVdcId==[ID]) - | Returns all the external networks which are available to a specific Provider vDC.
  • Org vDC ID (orgVdcId==[ID]) - | Returns all the external networks which are available to a specific Org vDC.
  • vCenter ID And Resource Pool Moref (vCenterId==[ID];rpMoref==[moref]) - | Returns all the external networks accessible to a given vCenter resource pool.
  • Org vDC ID And Edge Deployment Mode (orgVdcId==[ID];edgeDeploymentMode==[deploymentMode) - | Returns all the external networks to which an edge gateway can connect. Edge Deployment Mode can be 'standaloneEdgeDeployment' or 'haEdgeDeployment'. Deployment mode specifies whether to use both primary edge cluster and secondary edge cluster or just primary edge cluster to determine external network accessibility. Edge clusters are determined via vDC Network Profile for input Org vDC.
  • Org vDC ID And Dedicatable External Networks (orgVdcId==[ID];dedicatable==true) - | Dedicatable only shows external networks that have no connected Edge Gateways.
  • OrgAssociated orgAssociated==true filter can be specified to get the list of external networks which are already associated with the Organization. An External network is already associated with the Organization, if either the Organization is the owner of the external network or if the Organization has an Edge Gateway which is connected to the external network.

The following contexts are deprecated as of API version 38.0: vDC Group ID (_context==vdcGroupId), Provider vDC ID (_context==providerVdcId), Org vDC ID (_context==orgVdcId), vCenter ID And Resource Pool Moref (_context==vCenterId;_context==rpMoref), Org vDC ID And Edge Deployment Mode (_context==orgVdcId;_context==anEdgeDeploymentMode), Org vDC ID And Dedicatable External Networks (_context==orgVdcId;_context==dedicatable)

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/externalNetworks
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.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ExternalNetworks of type(s) application/json;version=39.0
This response body class contains all of the following: Page , InlineExternalNetworks1 
{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ],
    "values": [
        {
            "id": "string",
            "name": "string",
            "description": "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
                    }
                ]
            },
            "status": {},
            "networkBackings": {
                "values": [
                    {
                        "backingId": "string",
                        "backingType": {},
                        "backingTypeValue": "string",
                        "networkProvider": {
                            "name": "string",
                            "id": "string"
                        },
                        "name": "string",
                        "isNsxTVlanSegment": false,
                        "parentTier0Ref": {
                            "id": "2a4ba9ad-e8d5-409c-8cae-c06910cd9b47",
                            "name": "string",
                            "type": "string"
                        }
                    }
                ]
            },
            "totalIpCount": 0,
            "usedIpCount": 0,
            "dedicatedOrg": {
                "name": "string",
                "id": "string"
            },
            "dedicatedEdgeGateway": {
                "name": "string",
                "id": "string"
            },
            "usingIpSpace": false,
            "networkRouteAdvertisementIntention": "string",
            "natAndFirewallServiceIntention": "string",
            "vpnServiceIntention": "string",
            "strictIpMode": false
        }
    ]
}

Availability
Added in 32.0
On This Page
External Networks Operations
POST
Create External Network
GET
Get All External Networks