List IPFIX Collector Profies

Query IPFIX collector profiles with list parameters. List result can be
filtered by profile type defined by IpfixCollectorUpmProfileType.

Request:

Method:

GET

URI Path(s):

/api/v1/ipfix-collector-profiles

Request Headers:

n/a

Query Parameters:

IpfixCollectorUpmProfileListParameters+

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"
profile_types	IPFIX Collector Profile Type List An English comma-separated list of profile types. Enumerated value in IpfixCollectorUpmProfileType can be listed here as a filter param.	string
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-collector-profiles

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

IpfixCollectorUpmProfileListResult+

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 Profile List	array of IpfixCollectorUpmProfile	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_ascending" : true, "sort_by": "resource_type", "result_count": 2, "results": [ { "resource_type": "IpfixCollectorUpmProfile", "id": "2d5d3a9a-5bc7-4ad1-2f0a-a9836575d204", "display_name": "IPFIX Collector Profile 001", "collectors" : [ { "collector_port" : 4739, "collector_ip_address" : "192.168.1.112" }, { "collector_port" : 4739, "collector_ip_address" : "192.168.1.110" } ], "_protection" : "NOT_PROTECTED", "_create_user" : "admin", "_create_time" : 1507687895605, "_last_modified_user" : "admin", "_last_modified_time" : 1507705866588, "_system_owned" : false, "_revision" : 1 }, { "resource_type" : "IpfixCollectorUpmProfile", "id" : "e2954b96-bbb4-4fa1-bd2f-3b2bd9e89b64", "display_name" : "IPFIX Collector Profile 002", "collectors" : [ { "collector_port" : 4739, "collector_ip_address" : "192.168.1.102" }, { "collector_port" : 4739, "collector_ip_address" : "192.168.1.100" } ], "_protection" : "NOT_PROTECTED", "_create_user" : "admin", "_create_time" : 1507687895605, "_last_modified_user" : "admin", "_last_modified_time" : 1507705866588, "_system_owned" : false, "_revision" : 1 } ] }

List IPFIX Collector Profies

Request:

IpfixCollectorUpmProfileListParameters (schema)

Example Request:

Successful Response:

IpfixCollectorUpmProfileListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: