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

URL

put

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

Copy

Path Parameters

string

ip-pool-id Required

string

ip-allocation-id Required

Request Body

IpAddressAllocation of type(s) application/json Required

This request body class requires all of the following: PolicyConfigResource, InlineIpAddressAllocation1

Authentication

This operation uses the following authentication methods.

BasicAuth

Response

Response Body

200 OK

Returns IpAddressAllocation of type(s) application/json

This response body class contains all of the following: PolicyConfigResource, InlineIpAddressAllocation1

Errors

ApiError

400

Bad Request

ApiError

403

Forbidden

404

Not Found

ApiError

412

Precondition Failed

ApiError

500

Internal Server Error

ApiError

503

Service Unavailable

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"_create_time":0,"_create_user":"string","_last_modified_time":0,"_last_modified_user":"string","_links":[{"action":"string","href":"string","rel":"string"}],"_protection":"string","_revision":0,"_schema":"string","_self":{"action":"string","href":"string","rel":"string"},"_system_owned":false,"allocation_ip":"string","children":[{"_create_time":0,"_create_user":"string","_last_modified_time":0,"_last_modified_user":"string","_links":[{"action":"string","href":"string","rel":"string"}],"_protection":"string","_revision":0,"_schema":"string","_self":{"action":"string","href":"string","rel":"string"},"_system_owned":false,"description":"string","display_name":"string","id":"string","marked_for_delete":false,"resource_type":"string","tags":[{"scope":"string","tag":"string"}]}],"description":"string","display_name":"string","id":"string","marked_for_delete":false,"parent_path":"string","path":"string","relative_path":"string","resource_type":"string","tags":[{"scope":"string","tag":"string"}]}' 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

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

nsx-vmc-policy

Infrastructure Operations

put

Create IP Address Pool

put

Create IP Address Pool Allocation

put

Create IP Address Pool Subnet

delete

Delete IP Address Pool

delete

Delete IP Address Pool Allocation

delete

Delete IP Address Pool Subnet

get

Get IP Address Pool

get

Get IP Address Pool Allocation

get

Get IP Address Pool Subnet

get

List IP Address Pool Allocations

get

List IP Address Pool Subnbets

get

List IP Address Pools

patch

Update IP Address Pool

patch

Update IP Address Pool Allocation

patch

Update IP Address Pool Subnet

Create IP Address Pool Allocation

Request

URL

Path Parameters

Request Body

Authentication

BasicAuth

Response

Response Body

200 OK

Errors

Code Samples

cURL Command

Vendor Extensions

On This Page

Infrastructure Operations

Was this page helpful?