Allocate Or Release From Ip Block Subnet

Allocates or releases an IP address from the specified IP subnet. To allocate an address, include ?action=ALLOCATE in the request and a "{}" in the request body. When the request is successful, the response is "allocation_id": " ", where 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": in the request body, where is the address to be released. When the request is successful, the response is NULL.

Request

URI

POST

https://nsxmanager.your.domain/api/v1/pools/ip-subnets/{subnet-id}

COPY

Path Parameters

string

subnet-id

Required

IP subnet id

Query Parameters

string

action

Required

Specifies allocate or release action

Possible values are : ALLOCATE, RELEASE,

Request Body

AllocationIpAddress of type(s) application/json

Optional

This request body class requires all of the following: ManagedResource , InlineAllocationIpAddress1

{
    "_self": {
        "rel": "string"
    },
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "_revision": 0,
    "_create_time": 0,
    "_system_owned": false,
    "display_name": "string",
    "description": "string",
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ],
    "_last_modified_time": 0,
    "_create_user": "string",
    "_last_modified_user": "string",
    "id": "string",
    "resource_type": "string",
    "allocation_id": "string"
}

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Success

Returns AllocationIpAddress of type(s) application/json

This response body class contains all of the following: ManagedResource , InlineAllocationIpAddress1

{
    "_self": {
        "rel": "string"
    },
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "_revision": 0,
    "_create_time": 0,
    "_system_owned": false,
    "display_name": "string",
    "description": "string",
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ],
    "_last_modified_time": 0,
    "_create_user": "string",
    "_last_modified_user": "string",
    "id": "string",
    "resource_type": "string",
    "allocation_id": "string"
}

400

Returns BadRequest of type(s) application/json

Operation doesn't return any data structure

403

Returns Forbidden of type(s) application/json

Operation doesn't return any data structure

404

Returns NotFound of type(s) application/json

Operation doesn't return any data structure

409

Operation doesn't return any data structure

412