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

Update IP Space IP Allocation

Description

Updates the specified IP Space IP Allocation.

Request

Request

URL

URL


put
https://{api_host}/cloudapi/1.0.0/ipSpaces/{ipSpaceId}/allocations/{ipAllocationId}
Copy

Path Parameters

Path Parameters

string
ipSpaceId Required

string
ipAllocationId Required

Request Body

Request Body

IpSpaceIpAllocation of type(s) application/json Required
{
    "id": "urn:vcloud:ipSpaceIpAllocation:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
string as date-time
allocationDate Optional

Date when the IP address or IP prefix is allocated. This property is read-only.


string
description Optional

Description about usage of an IP if the usageState is USED_MANUAL.


string
id Optional

The identifier of the IP Space IP allocation in URN format.


orgRef Optional

Reference to the organization where the IP is allocated.


string
type Optional

The type of the IP allocation. 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.


array of string
usageCategories Optional

The list of service categories where the IP address is being used. Typically this can be one of: SNAT, DNAT, LOAD_BALANCER, IPSEC_VPN, SSL_VPN or L2_VPN. This property is read-only.


string
usageState Optional

Specifies current usage state of an allocated IP. Possible values are:

  • UNUSED - the allocated IP is current not being used in the system.
  • USED - the allocated IP is currently in use in the system. An allocated IP address or IP Prefix is considered used if it is being used in network services such as NAT rule or in Org VDC network definition.
  • USED_MANUAL - the allocated IP is marked for manual usage. Allocation description can be referenced to get information about the manual usage.


usedByRef Optional

Reference to the entity using the IP, such as an Edge Gateway Reference if the Floating IP is used for NAT or Org VDC network reference if IP Prefix is used for network definition. This property is read-only.


string
value Optional

An individual IP Address or an IP Prefix which is allocated.

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 PUT -H "Content-Type: application/json" -d '{"id":"urn:vcloud:ipSpaceIpAllocation:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}' https://{api_host}/cloudapi/1.0.0/ipSpaces/{ipSpaceId}/allocations/{ipAllocationId}


[{"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?