List MAC Pools

Returns a list of all the MAC pools

Request:

Method:

GET

URI Path(s):

/api/v1/pools/mac-pools

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/mac-pools

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

MacPoolListResult+

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	MAC pool list results	array of MacPool	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": "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": "DefaultMacPool", "description": "Default MAC Pool", "resource_type": "MacPool", "ranges": [ { "start": "02:50:56:00:00:00", "end": "02:50:56:00:7f:ff" } ], "_last_modified_user": "system", "_last_modified_time": 1413324646640, "_create_time": 1413324646640, "_create_user": "system" } ] }

Required Permissions:

read

Feature:

configuration_mac_pool

Additional Errors:

301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
412 Precondition Failed
500 Internal Server Error
503 Service Unavailable