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

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.

Request

URL

post

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

Copy

Path Parameters

string

ipSpaceId Required

Request Body

IpSpaceIpAllocationRequest of type(s) application/json Required

Show optional properties

{
	"quantity": 0,
	"type": "string"
}

{
	"prefixLength": 0,
	"quantity": 0,
	"type": "string"
}

integer

quantity Required

Number of IP addresses or IP Prefix blocks to allocate.

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.

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Response

202 Accepted

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

Operation doesn't return any data structure.

No error details were provided in the OpenAPI specification.

Code Samples

cURL Command

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

vmware-cloud-director

What's changed in v37.1?

INTRODUCED

New in this version

Availability

Added in 37.1

IP Spaces Operations

post

Allocate Introduced

post

Create IP Space Introduced

delete

Delete IP Space Introduced

delete

Delete IP Space IP Allocation Introduced

get

Get Floating IP Suggestions Introduced

get

Get IP Prefix Sequences Introduced

get

Get IP Prefix Suggestions Introduced

get

Get IP Space Introduced

get

Get IP Space IP Allocation Introduced

get

Get IP Space IP Allocations Introduced

get

Get IP Space Summaries Introduced

put

Update IP Space Introduced

put

Update IP Space IP Allocation Introduced

Allocate

Request

URL

Path Parameters

Request Body

Authentication

ApiKeyAuth

Response

202 Accepted

No error details were provided in the OpenAPI specification.

Code Samples

cURL Command

What's changed in v37.1?

Availability

On This Page

IP Spaces Operations

Was this page helpful?