Get Ip Prefix Suggestions

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

URI

GET

https://{api_host}/cloudapi/1.0.0/ipSpaces/ipPrefixSuggestions

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.

ApiKeyAuth

Responses

200

Returns IpSpaceIpPrefixSuggestions of type(s) application/json;version=38.1

This response body class contains all of the following: Page , InlineIpSpaceIpPrefixSuggestions1

{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ],
    "values": [
        {
            "ipSpaceRef": {
                "name": "string",
                "id": "string"
            },
            "unusedIpPrefixes": [
                {
                    "prefixLength": 0,
                    "unusedValues": [
                        "string"
                    ]
                }
            ]
        }
    ]
}

Availability

Added in 37.1

On This Page

Description

Request

Query Parameters

Authentication

Response

200 Response Body

Ip Spaces Operations

POST

Allocate