NSX-T Data Center REST API

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/transport-nodes/{transport-node-id}/node/services/dataplane/flow-mon
Request Headers:
n/a
Query Parameters:
EdgeDataplaneFlowQueryParameters+
Request Body:
EdgeDataplaneFlowMonitorStartSetting+

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+

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

Required Permissions:

read

Feature:

system_administration

Additional Errors: