Get Networking Vdc Group Candidates
Get a list of candidate vDCs. Results can be filtered by the type of vDC group and contexts of vDC ID or network pool ID. Below are the supported contexts:
- Local vDC Group
(_context==LOCAL;_context==orgVdcId)- Returns all vDCs that have the same network pool assigned to the org vDC. - Universal vDC Group backed by NSX-V network provider
(_context==UNIVERSAL;_context==orgVdcId;_context==networkPoolUniversalId)- If the orgVdc is specified, returns all vDCs that have the same assigned universal network pool as that of the org vDC. A universal network pool is backed by a broadcast domain that can stretch to multiple VMware Cloud Director sites. If the org vDC is not specified or not found and the universal network pool is specified, return all vDCs whose network pool are backed by that universal network pool. This case supports multisite/associated organization queries where user wants to retrieve remote vDCs on different sites/associated organizations with same backing universal network pool. - Existing vDC Group
(_context==vdcGroupId;_context==networkPoolUniversalId)- If vDC Group is specified, return all vDCs that have the?same assigned network pool as that of the vDC Group and also all vDCs that are currently participating in the vDC Group. The assigned network pool can also be universal if the vDC Group type is UNIVERSAL. If vDC Group is not specified or not found and the universal network pool is specified, return all vDCs whose network pool are backed by that universal network pool. This case supports multisite/associated organization queries where user wants to retrieve remote vDCs on different sites/associated organizations with same backing universal network pool.
Request
URI
GET
https://{api_host}/cloudapi/1.0.0/vdcGroups/networkingCandidateVdcs
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.
Responses
200
OK
Returns NetworkingCandidateVdcs of type(s) application/json;version=37.1
This response body class contains all of the following: Page , InlineNetworkingCandidateVdcs1
{
"resultTotal": 0,
"pageCount": 0,
"page": 0,
"pageSize": 0,
"associations": [
{
"entityId": "string",
"associationId": "string"
}
],
"values": [
{
"id": "string",
"name": "string",
"orgRef": {
"name": "string",
"id": "string"
},
"siteRef": {
"name": "string",
"id": "string"
},
"networkProviderScope": "string",
"faultDomainTag": "string"
}
]
}