Start NSX Edge dataplane flow monitor

Starts NSX Edge dataplane flow monitor on all or certain CPU core(s) with a timeout.
Stops flow monitor after timeout and dumps the flow file on local file store
on edge. If top_10 argument is set to true top 10 flows are collected,
else all flows are collected.

Request:

Method:

PUT

URI Path(s):

/api/v1/node/services/dataplane/flow-mon
/api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/flow-mon
/api/v1/cluster/<cluster-node-id>/node/services/dataplane/flow-mon

Request Headers:

n/a

Query Parameters:

EdgeDataplaneFlowQueryParameters+

Name	Description	Type	Notes
fields	Fields to include in query results Comma-separated field names to include in query result	string
top_10	Collect top 10 flows when set to true Collect top 10 flows when set to true, else collect all flows.	boolean	Default: "False"

Request Body:

EdgeDataplaneFlowMonitorStartSetting+

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
core_id	Core id Flow monitor core id	string
timeout	Timeout for flow monitor in seconds, in the range of 1 - 600. Flow monitor timeout in seconds	string	Default: "15"

Example Request:

PUT https://<ip>/api/v1/node/services/dataplane/flow-mon { "core_id": "1", "timeout": "30" } (or) PUT https://<ip>/api/v1/node/services/dataplane/flow-mon?top_10=true { "core_id": "1", "timeout": "30" }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

EdgeDataplaneFlowMonitorMessage+

Name	Description	Type	Notes
message	Message Edge dataplane flow monitor message	string

Example Response:

{ "message": "flow_mon.tgz will be available in edge filestore in 30 seconds. Go to edge CLI, use the following command to transfer the file: copy file flow_mon.tgz url " }

Start NSX Edge dataplane flow monitor

Request:

EdgeDataplaneFlowQueryParameters (schema)

EdgeDataplaneFlowMonitorStartSetting (schema)

Example Request:

Successful Response:

EdgeDataplaneFlowMonitorMessage (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: