NSX-T Data Center REST API

List VNI Pools

Returns information about the default and configured virtual
network identifier (VNI) pools for use when building logical network
segments. Each virtual network has a unique ID called a VNI. Instead
of creating a new VNI each time you need a new logical switch, you
can instead allocate a VNI from a VNI pool. VNI pools are sometimes
called segment ID pools. Each VNI pool has a range of usable VNIs. By
default, there is one pool with two ranges [5000, 65535] and [65536,
75000]. To create multiple smaller pools, specify a smaller range for
each pool such as 75001-75100 and 75101-75200. The VNI range determines
the maximum number of logical switches that can be created in each
network segment.

Request:

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

Example Request:

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

Successful Response:

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

Example Response:

{ "cursor": "0036ac926c72-daf2-4bb5-ac07-9ab70afded67DefaultVniPool", "sort_by": "displayName", "sort_ascending": true, "result_count": 1, "results": [ { "_revision": 0, "id": "ac926c72-daf2-4bb5-ac07-9ab70afded67", "display_name": "DefaultVniPool", "description": "Default VNI Pool", "resource_type": "VniPool", "ranges": [ { "start": 65536, "end": 75000 }, { "start": 5000, "end": 65535 } ], "_last_modified_user": "system", "_last_modified_time": 1413324646640, "_create_time": 1413324646640, "_create_user": "system" } ] }

Required Permissions:

read

Feature:

profiles_configuration

Additional Errors: