Returns list of configured IP address blocks.

Returns information about configured IP address blocks. Information includes
the id, display name, description & CIDR of IP address blocks

Request:

Method:

GET

URI Path(s):

/api/v1/pools/ip-blocks

Request Headers:

n/a

Query Parameters:

ListRequestParameters+

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

n/a

Example Request:

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

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

IpBlockListResult+

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	IP block list results	array of IpBlock	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "cursor": "003622dc1d1a-adcb-4c58-874e-6e783df02790IPBlock-Tenant-1", "sort_by": "displayName", "sort_ascending": true, "result_count": 1, "results": [ { "_revision": 0, "id": "4a5f22a8-8293-4212-93df-99286d20e35b", "display_name": "IPBlock-Tenant-1", "description": "IPBlock-Tenant-1 Description", "resource_type": "IpBlock", "cidr": "192.168.0.0/16", "_last_modified_user": "admin", "_last_modified_time": 1414691880507, "_create_time": 1414691880507, "_create_user": "admin" } ] }

Returns list of configured IP address blocks.

Request:

ListRequestParameters (schema)

Example Request:

Successful Response:

IpBlockListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: