List IP Address Pools
Paginated list of IpAddressPools.
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/ip-pools
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
IpAddressPoolListResult of type(s) application/json
This response body class contains all of the following: ListResult, InlineIpAddressPoolListResult
Errors
Code Samples
Code Samples
cURL Command
curl https://nsxmanager.your.domain/policy/api/v1/infra/ip-pools
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: list-ip-address-pools
x-vmw-nsx-module: PolicyIpam
On This Page
IP Pools Operations
delete
patch
