Changed2
[{"label":"Latest (v37.1)","version":"latest"},{"version":"v37.0"},{"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 IP Prefix Suggestions

Description

Suggests IP Prefixes to use for network definitions. “orgVdcId”/“vdcGroupId” and “networkType” filters are required. Based on the specified Org VDC ID/vDC Group ID and network type, VCD will query all the applicable IP Spaces and suggest some IP prefixes which can be utilized for creation of network definition. IP Space IP prefixes which are are allocated but not currently used for any network definitions are considered. Allowed values for networkType filter are ISOLATED and ROUTED. If the networkType is ROUTED, “gatewayId” filter must be specified. For ROUTED networks, VCD will query all the IP Spaces associated with the Edge Gateway. For ISOLATED networks, VCD will query all the available private IP Spaces. Results can also be filtered by IPV4 or IPV6 IP address types. Filter examples:(filter=orgVdcId==URN;networkType==ROUTED;gatewayId==URN), (filter=vdcGroupId==URN;networkType==ISOLATED), (filter=orgVdcId==URN;networkType==ROUTED;gatewayId==URN;ipType==IPV4)

Request

Request

URL

URL


get
https://{api_host}/cloudapi/1.0.0/ipSpaces/ipPrefixSuggestions
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 IpSpaceIpPrefixSuggestions of type(s) application/json;version=37.1
This response body class contains all of the following: Page, InlineIpSpaceIpPrefixSuggestions1

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl https://{api_host}/cloudapi/1.0.0/ipSpaces/ipPrefixSuggestions?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.1)","version":"latest"},{"version":"v37.0"},{"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
What's changed in v37.1?
INTRODUCED
New in this version
Availability
Added in 37.1
IP Spaces Operations
Feedback

Was this page helpful?