NSX-T Data Center REST API

Update an existing IPFIX collector profile (Deprecated)

Update an existing IPFIX collector profile with profile ID and modified
properties.

Request:

Method:

PUT

URI Path(s):

/api/v1/ipfix-collector-profiles/<ipfix-collector-profile-id>

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

IpfixCollectorUpmProfile+

IpfixCollectorUpmProfile (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
collectors	IPFIX Collector Set	array of IpfixCollector	Required Minimum items: 1 Maximum items: 4
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
resource_type	Must be set to the value IpfixCollectorUpmProfile	IpfixCollectorUpmProfileType	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Request:

PUT https://<nsx-mgr>/api/v1/ipfix-collector-profiles/ 7e5d3a8c-8aa8-4df6-9a0f-b0456575b233 { "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" } ], "_revision": 0 }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

IpfixCollectorUpmProfile+

IpfixCollectorUpmProfile (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
collectors	IPFIX Collector Set	array of IpfixCollector	Required Minimum items: 1 Maximum items: 4
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
resource_type	Must be set to the value IpfixCollectorUpmProfile	IpfixCollectorUpmProfileType	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

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

Required Permissions:

crud

Feature:

unified_nsgroup_ipfix_collector_profiles

Additional Errors:

• 404 Not Found
• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable