System Administration > Configuration > Fabric > Pool Management > IP Pools

Allocate or Release an IP Address from a Pool

Allocates or releases an IP address from the specified IP pool. To allocate
an address, include ?action=ALLOCATE in the request and "allocation_id":null
in the request body. When the request is successful, the response is
"allocation_id": "<ip-address>", where <ip-address> is an IP address from
the specified pool. To release an IP address (return it back to the pool),
include ?action=RELEASE in the request and "allocation_id":<ip-address> in
the request body, where <ip-address> is the address to be released. When the
request is successful, the response is NULL. Tags, display_name and description
attributes are not supported for AllocationIpAddress in this release.

Request:

Method:
POST
URI Path(s):
/api/v1/pools/ip-pools/<pool-id>
Request Headers:
n/a
Query Parameters:
AllocationAction+
Request Body:
AllocationIpAddress+

Example Request:

POST https://<nsx-mgr>/api/v1/pools/ip-pools/5a5f22a8-8293-4212-93df-99286d20e25c?action=ALLOCATE { "allocation_id":null }

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AllocationIpAddress+

Example Response:

{ "allocation_id":2002:a70:cbfa:0:0:0:0:1 }

Required Permissions:

crud

Feature:

groups_ip_pools

Additional Errors: