NSX-T Data Center REST API

Create a new IPFIX profile (Deprecated)

Create a new IPFIX profile with essential properties.

Request:

Method:

POST

URI Path(s):

/api/v1/ipfix-profiles

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

IpfixSwitchUpmProfile+

IpfixSwitchUpmProfile (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_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
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
active_timeout	Active Timeout The time in seconds after a flow is expired even if more packets matching this Flow are received by the cache.	int	Minimum: 60 Maximum: 3600 Default: "300"
applied_tos	Entitys Applied with Profile Entities where the IPFIX profile will be enabled on. Maximum entity count of all types is 128.	AppliedTos
collector_profile	UUID of IPFIX Collector Profile Each IPFIX switching profile can have its own collector profile.	string	Required
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
export_overlay_flow	Export Overlay Flow It controls whether sample result includes overlay flow info.	boolean	Default: "True"
id	Unique identifier of this resource	string	Sortable
idle_timeout	Idle Timeout The time in seconds after a flow is expired if no more packets matching this flow are received by the cache.	int	Minimum: 60 Maximum: 3600 Default: "300"
max_flows	Max Flows The maximum number of flow entries in each exporter flow cache.	integer	Minimum: 0 Maximum: 4294967295 Default: "16384"
observation_domain_id	Observation Domain ID An identifier that is unique to the exporting process and used to meter the Flows.	integer	Required Minimum: 0 Maximum: 4294967295
packet_sample_probability	Packet Sample Probability The probability in percentage that a packet is sampled. The value should be in range (0,100] and can only have three decimal places at most. The probability is equal for every packet.	number	Minimum: 0 Maximum: 100 Default: "0.1"
priority	Profile Priority This priority field is used to resolve conflicts in logical ports/switch which inherit multiple switch IPFIX profiles from NSGroups. Override rule is : for multiple profiles inherited from NSGroups, the one with highest priority (lowest number) overrides others; the profile directly applied to logical switch overrides profiles inherited from NSGroup; the profile directly applied to logical port overides profiles inherited from logical switch and/or nsgroup; The IPFIX exporter will send records to collectors of final effective profile only.	int	Required Minimum: 0 Maximum: 65536
resource_type	Must be set to the value IpfixSwitchUpmProfile	IpfixUpmProfileType	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Request:

POST https://<nsx-mgr>/api/v1/ipfix-profiles { "resource_type": "IpfixSwitchUpmProfile", "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": [] } }

Successful Response:

Response Code:

201 Created

Response Headers:

Content-type: application/json

Response Body:

IpfixSwitchUpmProfile+

IpfixSwitchUpmProfile (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_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
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
active_timeout	Active Timeout The time in seconds after a flow is expired even if more packets matching this Flow are received by the cache.	int	Minimum: 60 Maximum: 3600 Default: "300"
applied_tos	Entitys Applied with Profile Entities where the IPFIX profile will be enabled on. Maximum entity count of all types is 128.	AppliedTos
collector_profile	UUID of IPFIX Collector Profile Each IPFIX switching profile can have its own collector profile.	string	Required
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
export_overlay_flow	Export Overlay Flow It controls whether sample result includes overlay flow info.	boolean	Default: "True"
id	Unique identifier of this resource	string	Sortable
idle_timeout	Idle Timeout The time in seconds after a flow is expired if no more packets matching this flow are received by the cache.	int	Minimum: 60 Maximum: 3600 Default: "300"
max_flows	Max Flows The maximum number of flow entries in each exporter flow cache.	integer	Minimum: 0 Maximum: 4294967295 Default: "16384"
observation_domain_id	Observation Domain ID An identifier that is unique to the exporting process and used to meter the Flows.	integer	Required Minimum: 0 Maximum: 4294967295
packet_sample_probability	Packet Sample Probability The probability in percentage that a packet is sampled. The value should be in range (0,100] and can only have three decimal places at most. The probability is equal for every packet.	number	Minimum: 0 Maximum: 100 Default: "0.1"
priority	Profile Priority This priority field is used to resolve conflicts in logical ports/switch which inherit multiple switch IPFIX profiles from NSGroups. Override rule is : for multiple profiles inherited from NSGroups, the one with highest priority (lowest number) overrides others; the profile directly applied to logical switch overrides profiles inherited from NSGroup; the profile directly applied to logical port overides profiles inherited from logical switch and/or nsgroup; The IPFIX exporter will send records to collectors of final effective profile only.	int	Required Minimum: 0 Maximum: 65536
resource_type	Must be set to the value IpfixSwitchUpmProfile	IpfixUpmProfileType	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "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" : 0 }

Required Permissions:

crud

Feature:

unified_nsgroup_ipfix_profiles

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