[{"label":"Latest (v37.2)","version":"latest"},{"version":"v37.1"},{"version":"v37.0"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Get All External Networks
DescriptionGet all external networks. Results can be filtered by id, name, backing type (networkBackings.values.backingType) and context (_context). Supported contexts are:
- Provider vDC ID (_context==providerVdcId) - | Returns all the external networks which are available to a specific Provider vDC.
- Org vDC ID (_context==orgVdcId) - | Returns all the external networks which are available to a specific Org vDC.
- vCenter ID And Resource Pool Moref (_context==vCenterId;_context==rpMoref) - | Returns all the external networks accessible to a given vCenter resource pool.
- Org vDC ID And Edge Deployment Mode (_context==orgVdcId;_context==anEdgeDeploymentMode) - | 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 (_context==orgVdcId;_context==dedicatable) - | Dedicatable only shows external networks that have no connected Edge Gateways.
Request
URLURL
https://{api_host}/cloudapi/1.0.0/externalNetworks
Query Parameters
Query Parameters
string
filter
Optional
Filter for a query. FIQL format.
integer
page
Required
Page to fetch, zero offset.
integer
pageSize
Required
Results per page to fetch.
string
sortAsc
Optional
Field to use for ascending sort
string
sortDesc
Optional
Field to use for descending sort
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
ExternalNetworks
of type(s) application/json;version=37.2
This response body class contains all of the following:
Page, InlineExternalNetworks1
No error details were provided in the OpenAPI specification.
Code SamplesCode Samples
cURL Command
curl https://{api_host}/cloudapi/1.0.0/externalNetworks?page=10&pageSize=10
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vcloud-multisite: true
[{"label":"Latest (v37.2)","version":"latest"},{"version":"v37.1"},{"version":"v37.0"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Availability
Added in 32.0
