NSX-T Data Center REST API

List subnets within an IP block

Returns information about all subnets present within an IP address
block. Information includes subnet's id, display_name, description, cidr and
allocation ranges.

Request:

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

Example Request:

GET https://<nsx-mgr>/api/v1/pools/ip-subnets?block_id=4a5f22a8-8293-4212-93df-99286d20e35b

Successful Response:

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

Example Response:

{ "result_count": 1, "results": [ { "_revision": 0, "id": "4a1c354d-bf7a-42ce-8e27-57e75e803fa0", "display_name": "IPBlock-1-Subnet-1", "description": "IPBlock-1-Subnet-1 Description", "resource_type": "IpBlockSubnet", "cidr": "192.168.1.0/24", "allocation_ranges": [ { "start": "192.168.1.1", "end": "192.168.1.255" } ], "_last_modified_user": "admin", "_last_modified_time": 1514691880507, "_create_time": 1514691880507, "_create_user": "admin" } ] }

Required Permissions:

read

Feature:

ipam_ipam

Additional Errors: