NSX-T Data Center REST API

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:

Method:
GET
URI Path(s):
/api/v1/pools/ip-pools
Request Headers:
n/a
Query Parameters:
ListRequestParameters+
Request Body:
n/a

Example Request:

GET https://<nsx-mgr>/api/v1/pools/ip-pools

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
IpPoolListResult+

Example Response:

{ "cursor": "003622dc1d1a-adcb-4c58-874e-6e783df02790IPPool-IPV6-1", "sort_by": "displayName", "sort_ascending": true, "result_count": 1, "results": [ { "_revision": 0, "id": "22dc1d1a-adcb-4c58-874e-6e783df02790", "display_name": "IPPool-IPV6-1", "description": "IPPool-IPV6-1 Description", "resource_type": "IpPool", "subnets": [ { "dns_nameservers": [ "2002:a70:cbfa:1:1:1:1:1" ], "allocation_ranges": [ { "start": "2002:a70:cbfa:0:0:0:0:1", "end": "2002:a70:cbfa:0:0:0:0:5" } ], "gateway_ip": "2002:a80:cbfa:0:0:0:0:255", "cidr": "2002:a70:cbfa:0:0:0:0:0/24" } ], "_last_modified_user": "admin", "_last_modified_time": 1414691549566, "_create_time": 1414691549566, "_create_user": "admin" } ] }

Required Permissions:

read

Feature:

groups_ip_pools

Additional Errors: