Create IP Address Pool Allocation
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
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/ip-pools/{ip-pool-id}/ip-allocations/{ip-allocation-id}
Path Parameters
Path Parameters
string
ip-pool-id
Required
This parameter has no documentation
string
ip-allocation-id
Required
This parameter has no documentation
Request Body
Request Body
IpAddressAllocation of type(s) application/json
Required
Allocation parameters for the IP address (e.g. specific IP address) can be specified. Tags, display_name and description attributes are not supported in this release.
(The request body parameter is missing description)
This request body class requires all of the following: PolicyConfigResource, InlineIpAddressAllocation
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
IpAddressAllocation of type(s) application/json
This response body class contains all of the following: PolicyConfigResource, InlineIpAddressAllocation
Errors
404
Not Found
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
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
On This Page
IP Pools Operations
delete
patch
