[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy

Create IP Address Pool Allocation

Description

If allocation of the same ID is found, this is a no-op. If no allocation of the specified ID is found, then a new allocation is created. An allocation cannot be updated once created. When an IP allocation is requested from an IpAddressPool, the IP could be allocated from any subnet in the pool that has the available capacity. Request to allocate an IP will fail if no subnet was previously created. If specific IP was requested, the status of allocation is reflected in the realized state. If any IP is requested, the IP finally allocated is obtained by polling on the realized state until the allocated IP is returned in the extended attributes. An allocation cannot be updated once created.

Request

Request

URL

URL


put
https://nsxmanager.your.domain/policy/api/v1/infra/ip-pools/{ip-pool-id}/ip-allocations/{ip-allocation-id}
Copy

Path Parameters

Path Parameters

string
ip-pool-id Required

string
ip-allocation-id Required

Request Body

Request Body

IpAddressAllocation of type(s) application/json Required
This request body class requires all of the following: PolicyConfigResource, InlineIpAddressAllocation1
Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns IpAddressAllocation of type(s) application/json
This response body class contains all of the following: PolicyConfigResource, InlineIpAddressAllocation1
Errors

Errors

400

Bad Request


403

Forbidden


404

Not Found


412

Precondition Failed


500

Internal Server Error


503

Service Unavailable

Code Samples

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{}' https://nsxmanager.your.domain/policy/api/v1/infra/ip-pools/{ip-pool-id}/ip-allocations/{ip-allocation-id}
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: create-ip-address-pool-allocation
x-vmw-nsx-module: PolicyIpam


Feedback

Was this page helpful?