Get Network Pools Summary

Get Network Pools Summary

Retrieves summary of all Network Pools in the system. Supported filters are:

  • Provider vDC ID (providerVdcId==[ID]) - Returns all the network pools which are available to a specific Provider vDC.
  • Org vDC ID (orgVdcId==[ID]) - Returns all the network pools which are available to a specific Org vDC.
  • Virtual Center ID (managingOwnerRef.id==[ID]) + Resource Pool Moref (rpMoref==[moref]) - Returns all the network pools which are related to a specific Resource Pool.
  • isProjectedToOrg (isProjectedToOrg==[ID]) - The URN of the organization. Filters all network pools that are projected to a given Organization. Filtering for only non-projected network pools is also supported. isProjectedToOrg is supported from version 39.0
The following contexts are deprecated as of API version 38.0: Provider vDC ID (_context==providerVdcId), Org vDC ID (_context==orgVdcId), Virtual Center ID (managingOwnerRef.id==vcId) + Resource Pool Moref (_context==moref)
Request
URI
GET
https://{api_host}/cloudapi/1.0.0/networkPools/networkPoolSummaries
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 NetworkPoolsSummary of type(s) application/json;version=39.0
This response body class contains all of the following: Page , InlineNetworkPoolsSummary1
{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ],
    "values": [
        {
            "status": {},
            "id": "string",
            "name": "string",
            "description": "string",
            "poolType": {},
            "promiscuousMode": false,
            "totalBackingsCount": 0,
            "usedBackingsCount": 0,
            "managingOwnerRef": {
                "name": "string",
                "id": "string"
            },
            "networkProviderScope": "string"
        }
    ]
}