[{"label":"Latest (v37.2)","version":"latest"},{"version":"v37.1"},{"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

Allocate

Description

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

Request

URL

URL


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

Path Parameters

Path Parameters

string
ipSpaceId Required

Request Body

Request Body

IpSpaceIpAllocationRequest of type(s) application/json Required
{
	"type": "string"
}
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
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.


integer
quantity Changed 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.


string
value Introduced Optional

The specific IP address or IP Prefix to allocate. If an IP address or IP Prefix is specified, the quantity value should not be set.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

202 Accepted

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

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"prefixLength":0,"quantity":0,"type":"string","value":"string"}' https://{api_host}/cloudapi/1.0.0/ipSpaces/{ipSpaceId}/allocate


[{"label":"Latest (v37.2)","version":"latest"},{"version":"v37.1"},{"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
Feedback

Was this page helpful?