Get Importable Portgroups

Get Importable Portgroups

Get all standard portgroups that are available as backings. Supported filters are:

  • Network Pool ID (networkPoolId==[ID]) - Returns all the standard portgroups available as backings to a specific Network Pool.
  • External Network ID (externalNetworkId==[ID]) - Returns all the standard portgroups available as backings to a specific External Network.
  • Virtual Center ID (virtualCenter.id==[ID]) - Returns all the standard portgroups available as backings to a specific Virtual Center.
The following contexts are deprecated as of API version 38.0: Network Pool ID (_context==networkPoolId), External Network ID (_context==externalNetworkId)
Request
URI
GET
https://{api_host}/cloudapi/1.0.0/virtualCenters/resources/importablePortgroups
COPY
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.
Responses
200

OK

Returns PortGroups of type(s) application/json;version=38.1
This response body class contains all of the following: Page , InlinePortGroups1
{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ],
    "values": [
        {
            "backingRef": {
                "id": "string",
                "name": "string"
            },
            "virtualCenter": {
                "name": "string",
                "id": "string"
            }
        }
    ]
}