Get Network Pools Summary

Get Network Pools Summary

Retrieves summary of all Network Pools in the system. Results can be filtered by context (_context). Supported contexts are:

  • Provider vDC ID (_context==providerVdcId) - Returns all the network pools which are available to a specific Provider vDC.
  • Org vDC ID (_context==orgVdcId) - Returns all the network pools which are available to a specific Org vDC.
  • Virtual Center ID (managingOwnerRef.id==vcId) + Resource Pool Moref (_context==moref) - Returns all the network pools which are related to a specific Resoure Pool.
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=37.1
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": [
        {
            "id": "string",
            "name": "string",
            "description": "string",
            "promiscuousMode": false,
            "totalBackingsCount": 0,
            "usedBackingsCount": 0,
            "managingOwnerRef": {
                "name": "string",
                "id": "string"
            }
        }
    ]
}

Availability
Added in 33.0
On This Page
Network Pools Operations
POST
Create Network Pool
GET
Get Network Pools Summary