List Ip Pools
Returns information about the configured IP address pools. Information includes the display name and description of the pool and the details of each of the subnets in the pool, including the DNS servers, allocation ranges, gateway, and CIDR subnet address.
Request
URI
GET
https://nsxmanager.your.domain/api/v1/pools/ip-pools
COPY
Query Parameters
string
cursor
Optional
Opaque cursor to be used for getting next page of records (supplied by current result page)
boolean
sort_ascending
Optional
sort_ascending
string
included_fields
Optional
Comma separated list of fields that should be included to result of query
integer
page_size
Optional
Maximum number of results to return in this page (server may return fewer)
string
sort_by
Optional
Field by which records are sorted
Responses
200
Success
Returns IpPoolListResult of type(s) application/json
This response body class contains all of the following: ListResult , InlineIpPoolListResult1
{
"_self": {
"rel": "string"
},
"cursor": "string",
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"sort_ascending": false,
"result_count": 0,
"_schema": "string",
"sort_by": "string",
"results": [
{
"_self": {
"rel": "string"
},
"_system_owned": false,
"display_name": "string",
"description": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
],
"_revision": 0,
"_create_user": "string",
"_schema": "string",
"_create_time": 0,
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_last_modified_time": 0,
"_last_modified_user": "string",
"id": "string",
"resource_type": "string",
"subnets": [
{
"_self": {
"rel": "string"
},
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"dns_nameservers": [
"string"
],
"cidr": "string",
"gateway_ip": "string",
"allocation_ranges": [
{
"_self": {
"rel": "string"
},
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"start": "string",
"end": "string"
}
],
"dns_suffix": "string"
}
],
"pool_usage": {
"total_ids": 0,
"allocated_ids": 0,
"free_ids": 0
}
}
]
}
default
Unexpected error
Returns ApiError of type(s) application/json
{
"module_name": "string",
"error_message": "string",
"error_code": 0
}string
module_name
Optional
module_name
string
error_message
Optional
error_message
integer As int64 As int64
error_code
Optional
error_code