List IP Address Pool Allocations
Returns information about which addresses have been allocated from a specified IP address pool in policy.
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/ip-pools/{ip-pool-id}/ip-allocations
Path Parameters
Path Parameters
string
ip-pool-id
Required
This parameter has no documentation
Query Parameters
Query Parameters
string
cursor
Optional
Opaque cursor to be used for getting next page of records (supplied by current result page)
boolean
include_mark_for_delete_objects
Optional
Include objects that are marked for deletion in results
string
included_fields
Optional
Comma separated list of fields that should be included in query result
integer
page_size
Optional
Maximum number of results to return in this page (server may return fewer)
boolean
sort_ascending
Optional
This parameter has no documentation
string
sort_by
Optional
Field by which records are sorted
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
IpAddressAllocationListResult of type(s) application/json
This response body class contains all of the following: ListResult, InlineIpAddressAllocationListResult
cURL Command
curl https://nsxmanager.your.domain/policy/api/v1/infra/ip-pools/{ip-pool-id}/ip-allocations
Errors
Vendor Extensions
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: list-ip-address-pool-allocations
x-vmw-nsx-module: PolicyIpam
On This Page
IP Pools Operations
delete
patch
