Allocate | VMware Cloud Director OpenAPI

Allocate

Allocate floating IP addresses or IP Prefix blocks from an IP Space. This results in reserving the IP address or IP Prefix block for the specified organization. The organization can then use the IP address for network services such as NAT or use the IP Prefix as the network CIDR definition during Org VDC network creation. An IP Space IP allocation request can either request a specific IP address or IP prefix, or a request can allocate a given number of any free IP Addresses or IP Prefixes within an IP Space. These two types of requests cannot be combined to request both a specific IP Address/Prefix or any number of IP Addresses/Prefixes simultaneously. Please either request a specific value or request a variable number of IP Addresses/Prefixes with different POST requests.

Request

URI

POST

https://{api_host}/cloudapi/1.0.0/ipSpaces/{ipSpaceId}/allocate

COPY

Path Parameters

string

ipSpaceId

Required

ipSpaceId

string

ipSpaceId

Required

ipSpaceId

Request Body

IpSpaceIpAllocationRequest of type(s) application/json

Required

{
    "type": "string",
    "quantity": 0,
    "prefixLength": 0,
    "value": "string",
    "purpose": "<clusterName>-<serviceName>"
}

string

type

Required

The type of the IP allocation requested. Possible values are:

FLOATING_IP - For allocation of floating IP addresses from defined IP Space ranges.
IP_PREFIX - For allocation of IP prefix sequences from defined IP Space prefixes.

integer

quantity

Optional

The number of IP addresses or IP Prefix blocks to allocate. Specifying quantity will allocate the given number of any free IP addresses or IP Prefixes within the IP Space. To use a specific IP address or IP Prefix, please use the value field to request a specific value.

integer

prefixLength

Optional

The prefix length of an IP Prefix to allocate. This is required if type is IP_PREFIX. This field is only required if the request is for a specific quantity of IP Prefixes and not needed if request value is specified.

string

value

Optional

The specific IP addresses or IP Prefix to allocate. If this property is set, the quantity value should not be set. For IP_PREFIX type, only a single IP PREFIX CIDR is supported. For FLOATING_IP type, this value can be single IP such as "192.168.1.1", an IP Range such as "192.168.1.1-192.168.1.2", or a CIDR block such as "192.168.1.32/28". For IP Range and CIDR block, the maximum supported number of IPs is 16 (i.e. prefix length of 28 for CIDR block for IPv4).

string

purpose

Optional

This field allows users to specify the intended use or reason for requesting this IP allocation.

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

202

The request have been accepted and the task to monitor the request is in the Location header.

Operation doesn't return any data structure

Availability