List IPFIX Profies

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

Request:

Method:

GET

URI Path(s):

/api/v1/ipfix-profiles

Request Headers:

n/a

Query Parameters:

IpfixUpmProfileListParameters+

IpfixUpmProfileListParameters (schema)

Name	Description	Type	Notes
applied_to_entity_id	ID of Entity Applied with Profile The entity ID works as a filter param. Entity ID and entity type should be both provided or not at a query.	string
applied_to_entity_type	Type of Entity Applied with Profile The entity type works as a filter param. Enumerated value in UpmEntityType could be used here. Entity ID and entity type should be both provided or not at a query.	UpmEntityType
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 Profile Type List An English comma-separated list of profile types. Enumerated value in IpfixUpmProfileType could 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-profiles

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

IpfixUpmProfileListResult+

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 Profile List	array of IpfixUpmProfile (Abstract type: pass one of the following concrete types) IpfixSwitchUpmProfile	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": "IpfixSwitchUpmProfile", "id": "7e5d3a8c-8aa8-4df6-9a0f-b0456575b233", "display_name": "IPFIX Switch Profile 001", "packet_sample_probability": 0.1, "active_timeout": 300, "max_flows": 16384, "idle_timeout": 300, "observation_domain_id": 1001, "collector_profile": "516ea614-6692-4dcb-9fa7-8304f9765a7f", "priority": 0, "applied_tos": { "logical_switches": [], "logical_ports": [], "nsgroups": [] }, "export_overlay_flow" : true, "_protection" : "NOT_PROTECTED", "_create_user" : "admin", "_create_time" : 1507687895605, "_last_modified_user" : "admin", "_last_modified_time" : 1507705866588, "_system_owned" : false, "_revision" : 1 }, { "resource_type": "IpfixSwitchUpmProfile", "id": "2d5d3a9a-5bc7-4ad1-2f0a-a9836575d204", "display_name": "IPFIX Switch Profile 002", "packet_sample_probability": 0.1, "active_timeout": 300, "max_flows": 16384, "idle_timeout": 300, "observation_domain_id": 1002, "collector_profile": "8e6590f8-f203-4a9e-b53a-6c8058b79dd4", "priority": 1, "applied_tos": { "logical_switches": [], "logical_ports": [], "nsgroups": [] }, "export_overlay_flow" : true, "_protection" : "NOT_PROTECTED", "_create_user" : "admin", "_create_time" : 1507687895605, "_last_modified_user" : "admin", "_last_modified_time" : 1507705866588, "_system_owned" : false, "_revision" : 1 } ] }

List IPFIX Profies

Request:

IpfixUpmProfileListParameters (schema)

Example Request:

Successful Response:

IpfixUpmProfileListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: