List IPFIX collector configurations

Request:

Method:

GET

URI Path(s):

/api/v1/ipfix/collectorconfigs

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	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/ipfix/collectorconfigs?page_size=1

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

IpfixCollectorConfigListResult+

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	IPFIX Collector Config	array of IpfixCollectorConfig	Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "sort_by": "resource_type", "result_count": 2, "results": [ { "resource_type": "IpfixCollectorConfig", "id": "2e6d9p0c-8aa8-4df6-9a0f-b0456575b233", "collectors": [ { "collector_ip_address": "10.24.24.24", "collector_port": 3569, } ], "_last_modified_user": "admin", "_last_modified_time": 1463555181478, "_revision": 0 }, { "resource_type": "IpfixCollectorConfig", "id": "1a2b3c4d-8aa8-4df6-9a0f-b0456575b233", "collectors": [ { "id": "2d5d3a9a-5bc7-4ad1-2f0a-a9836575d204", "collector_ip_address": "10.23.23.23", "collector_port": 6359 } ], "_last_modified_user": "admin", "_last_modified_time": 1463555183599, "_revision": 0 } ] }

List IPFIX collector configurations

Request:

ListRequestParameters (schema)

Example Request:

Successful Response:

IpfixCollectorConfigListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: