[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director

Get Networking VDC Group Candidates

Description

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.
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.

Request

Request

URL

URL


get
https://{api_host}/cloudapi/1.0.0/vdcGroups/networkingCandidateVdcs
Copy

Query Parameters

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

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns NetworkingCandidateVdcs of type(s) application/json;version=36.3
This response body class contains all of the following: Page, InlineNetworkingCandidateVdcs1

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl https://{api_host}/cloudapi/1.0.0/vdcGroups/networkingCandidateVdcs?page=10&pageSize=10
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-vcloud-multisite: true


[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Feedback

Was this page helpful?