Get Networking Vdc Group Candidates

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;includeVdcsInManagedOrgs==true) - Returns all vDCs that have the same network pool assigned to the org vDC.
  • Universal vDC Group backed by NSX-T network provider (_context==UNIVERSAL;_context==orgVdcId;includeVdcsInManagedOrgs==true) - Returns all vDCs that are associated with the same global NSX-T manager.
  • 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, returns all vDCs whose network pools are backed by that universal network pool. This case supports multisite/associated organization queries where the user wants to retrieve remote vDCs on different sites/associated organizations with the same backing universal network pool.
  • Existing vDC Group (_context==vdcGroupId;_context==networkPoolUniversalId;includeVdcsInManagedOrgs==true;includeParticipatingVdcs==false) - If the vDC Group is specified, returns all vDCs that have the same assigned network pool as that of 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, returns all vDCs whose network pools are backed by that universal network pool. This case supports multisite/associated organization queries where the user wants to retrieve remote vDCs on different sites/associated organizations with the same backing universal network pool.

Note that multisite calls to get the candidate vDCs for a local vDC Group will only return the vDCs of the local site's associated organizations. Remote site's vDCs are not returned since the org vDC or the vDC group is not found there.

The following filters are only supported for vDC Groups backed by an NSX-T network provider:

  • includeVdcsInManagedOrgs
  • includeParticipatingVdcs
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.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns NetworkingCandidateVdcs of type(s) application/json;version=39.0
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"
        }
    ]
}

Availability
Added in 35.0
On This Page
Vdc Group Candidates Operations
GET
Get Networking Vdc Group Candidates