Update an existing IPFIX configuration

Request:

Method:

PUT

URI Path(s):

/api/v1/ipfix/configs/<config-id>

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

IpfixDfwConfig+

IpfixSwitchConfig (schema)

(Deprecated)

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	AppliedTo List List of objects where the IPFIX Config will be enabled.	array of ResourceReference	Maximum items: 128
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
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"
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"
resource_type	Must be set to the value IpfixSwitchConfig	IpfixConfigType	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Request:

PUT https://<nsx-mgr>/api/v1/ipfix/configs/7e5d3a8c-8aa8-4df6-9a0f-b0456575b233 { "resource_type": "IpfixSwitchConfig", "id": "7e5d3a8c-8aa8-4df6-9a0f-b0456575b233", "display_name": "IPFIX Switch Config 001", "packet_sample_probability": 0.1, "active_timeout": 300, "max_flows": 16384, "idle_timeout": 300, "applied_tos": [], "_revision": 1 }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

IpfixDfwConfig+

IpfixDfwConfig (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_flow_export_timeout	Active flow export timeout (minutes) For long standing active flows, IPFIX records will be sent per timeout period	integer	Minimum: 1 Maximum: 60 Default: "1"
applied_tos	AppliedTo List List of objects where the IPFIX Config will be enabled.	array of ResourceReference	Maximum items: 128
collector	UUID of IPFIX DFW Collector Config Each IPFIX DFW config can have its own collector config.	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
id	Unique identifier of this resource	string	Sortable
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
priority	Config Priority This priority field is used to resolve conflicts in Logical Ports which are covered by more than one IPFIX profiles. The IPFIX exporter will send records to Collectors in highest priority profile (lowest number) only.	integer	Required Minimum: 0 Maximum: 65536 Default: "0"
resource_type	Must be set to the value IpfixDfwConfig	IpfixConfigType	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
template_parameters	Template Parameters An object that indicates whether each corresponding template parameter is required or not.	IpfixDfwTemplateParameters

IpfixSwitchConfig+

IpfixSwitchConfig (schema)

(Deprecated)

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	AppliedTo List List of objects where the IPFIX Config will be enabled.	array of ResourceReference	Maximum items: 128
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
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"
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"
resource_type	Must be set to the value IpfixSwitchConfig	IpfixConfigType	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "resource_type": "IpfixSwitchConfig", "id": "7e5d3a8c-8aa8-4df6-9a0f-b0456575b233", "display_name": "IPFIX Switch Config 001", "packet_sample_probability": 0.1, "active_timeout": 300, "max_flows": 16384, "idle_timeout": 300, "applied_tos": [], "_last_modified_user": "admin", "_last_modified_time": 1463555176314, "_revision": 2 }

Update an existing IPFIX configuration

Request:

IpfixDfwConfig (schema)

IpfixSwitchConfig (schema)

Example Request:

Successful Response:

IpfixDfwConfig (schema)

IpfixSwitchConfig (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: