NSX-T Data Center REST API

Get the result of a livetrace session (Deprecated)

Deprecated: This API is deprecated. Please use policy API /infra/livetraces//result to get the livetrace session result.

Request:

Method:

GET

URI Path(s):

/api/v1/livetraces/{livetrace-session-id}/results

Request Headers:

n/a

Query Parameters:

LiveTraceDetailListParameters+

LiveTraceDetailListParameters (schema)

Name	Description	Type	Notes
action_type	The type of observations that will be listed.	LiveTraceActionType
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

n/a

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

LiveTraceResult+

LiveTraceResult (schema)

Name	Description	Type	Notes
counter_results	Count action results The results of the count action.	CounterResult
datapath_stats_results	Datapath statistics action results The results of the datapath statistics action.	array of DatapathStatsResult
id	ID of a livetrace session The id is assigned by Livetrace and cannot be specified by user.	string	Required Readonly
pktcap_results	PktCap action results	array of PktCapResult
trace_results	Trace action observation list results	array of TraceResult

Example Response:

{ "id": "309", "trace_results": [ { "packet_id": "1", "direction": "FORWARD", "result_overflowed": false, "counters": { "received_count": 2, "delivered_count": 1, "dropped_count": 0, "forwarded_count": 1 }, "logical_counters": { "received_count": 2, "delivered_count": 0, "dropped_count": 0, "forwarded_count": 2 }, "observations": [ { "resource_type": "TraceflowObservationReceived", "sequence_no": 0, "transport_node_id": "4de6359e-78e9-11ea-9904-455b0cc9e97f", "transport_node_name": "sc2-10-185-241-17.eng.vmware.com", "transport_node_type": "ESX", "timestamp": 1589983092358, "timestamp_micro": 1589983092358640, "component_type": "PHYSICAL", "component_sub_type": "UNKNOWN", "component_name": "Physical" }, { "lport_id": "00000000-0000-0000-0000-000000000000", "resource_type": "TraceflowObservationReceivedLogical", "sequence_no": 0, "transport_node_id": "4de6359e-78e9-11ea-9904-455b0cc9e97f", "transport_node_name": "sc2-10-185-241-17.eng.vmware.com", "transport_node_type": "ESX", "timestamp": 1589983092358, "timestamp_micro": 1589983092358698, "component_type": "DFW", "component_sub_type": "UNKNOWN", "component_name": "Distributed Firewall" }, { "lport_id": "00000000-0000-0000-0000-000000000000", "acl_rule_id": 2, "resource_type": "TraceflowObservationForwardedLogical", "sequence_no": 0, "transport_node_id": "4de6359e-78e9-11ea-9904-455b0cc9e97f", "transport_node_name": "sc2-10-185-241-17.eng.vmware.com", "transport_node_type": "ESX", "timestamp": 1589983092358, "timestamp_micro": 1589983092358769, "component_type": "DFW", "component_sub_type": "UNKNOWN", "component_name": "Distributed Firewall" }, { "context": 0, "remote_ip_address": "192.168.111.14", "local_ip_address": "192.168.111.70", "vtep_label": 118786, "resource_type": "TraceflowObservationForwarded", "sequence_no": 0, "transport_node_id": "4de6359e-78e9-11ea-9904-455b0cc9e97f", "transport_node_name": "sc2-10-185-241-17.eng.vmware.com", "transport_node_type": "ESX", "timestamp": 1589983092358, "timestamp_micro": 1589983092358837, "component_type": "PHYSICAL", "component_sub_type": "UNKNOWN", "component_name": "Physical" }, { "remote_ip_address": "192.168.111.70", "local_ip_address": "192.168.111.14", "vtep_label": 118785, "resource_type": "TraceflowObservationReceived", "sequence_no": 1, "transport_node_id": "297ec6b0-78e9-11ea-9259-79c38ffb2bf6", "transport_node_name": "sc2-10-185-243-227.eng.vmware.com", "transport_node_type": "ESX", "timestamp": 1589983092348, "timestamp_micro": 1589983092348306, "component_type": "PHYSICAL", "component_sub_type": "UNKNOWN", "component_name": "Physical" }, { "lport_id": "00000000-0000-0000-0000-000000000000", "resource_type": "TraceflowObservationReceivedLogical", "sequence_no": 1, "transport_node_id": "297ec6b0-78e9-11ea-9259-79c38ffb2bf6", "transport_node_name": "sc2-10-185-243-227.eng.vmware.com", "transport_node_type": "ESX", "timestamp": 1589983092348, "timestamp_micro": 1589983092348389, "component_type": "DFW", "component_sub_type": "UNKNOWN", "component_name": "Distributed Firewall" }, { "lport_id": "00000000-0000-0000-0000-000000000000", "acl_rule_id": 2, "resource_type": "TraceflowObservationForwardedLogical", "sequence_no": 1, "transport_node_id": "297ec6b0-78e9-11ea-9259-79c38ffb2bf6", "transport_node_name": "sc2-10-185-243-227.eng.vmware.com", "transport_node_type": "ESX", "timestamp": 1589983092348, "timestamp_micro": 1589983092348435, "component_type": "DFW", "component_sub_type": "UNKNOWN", "component_name": "Distributed Firewall" }, { "lport_id": "00000000-0000-0000-0000-000000000000", "resource_type": "TraceflowObservationDelivered", "sequence_no": 1, "transport_node_id": "297ec6b0-78e9-11ea-9259-79c38ffb2bf6", "transport_node_name": "sc2-10-185-243-227.eng.vmware.com", "transport_node_type": "ESX", "timestamp": 1589983092348, "timestamp_micro": 1589983092348456, "component_type": "PHYSICAL", "component_sub_type": "UNKNOWN", "component_name": "Physical" } ] }, { "packet_id": "2", "direction": "FORWARD", "result_overflowed": false, "counters": { "received_count": 2, "delivered_count": 1, "dropped_count": 0, "forwarded_count": 1 }, "logical_counters": { "received_count": 2, "delivered_count": 0, "dropped_count": 0, "forwarded_count": 2 }, "observations": [ { "resource_type": "TraceflowObservationReceived", "sequence_no": 0, "transport_node_id": "4de6359e-78e9-11ea-9904-455b0cc9e97f", "transport_node_name": "sc2-10-185-241-17.eng.vmware.com", "transport_node_type": "ESX", "timestamp": 1589983093359, "timestamp_micro": 1589983093359972, "component_type": "PHYSICAL", "component_sub_type": "UNKNOWN", "component_name": "Physical" }, { "lport_id": "00000000-0000-0000-0000-000000000000", "resource_type": "TraceflowObservationReceivedLogical", "sequence_no": 0, "transport_node_id": "4de6359e-78e9-11ea-9904-455b0cc9e97f", "transport_node_name": "sc2-10-185-241-17.eng.vmware.com", "transport_node_type": "ESX", "timestamp": 1589983093360, "timestamp_micro": 1589983093360025, "component_type": "DFW", "component_sub_type": "UNKNOWN", "component_name": "Distributed Firewall" }, { "lport_id": "00000000-0000-0000-0000-000000000000", "acl_rule_id": 2, "resource_type": "TraceflowObservationForwardedLogical", "sequence_no": 0, "transport_node_id": "4de6359e-78e9-11ea-9904-455b0cc9e97f", "transport_node_name": "sc2-10-185-241-17.eng.vmware.com", "transport_node_type": "ESX", "timestamp": 1589983093360, "timestamp_micro": 1589983093360078, "component_type": "DFW", "component_sub_type": "UNKNOWN", "component_name": "Distributed Firewall" }, { "context": 0, "remote_ip_address": "192.168.111.14", "local_ip_address": "192.168.111.70", "vtep_label": 118786, "resource_type": "TraceflowObservationForwarded", "sequence_no": 0, "transport_node_id": "4de6359e-78e9-11ea-9904-455b0cc9e97f", "transport_node_name": "sc2-10-185-241-17.eng.vmware.com", "transport_node_type": "ESX", "timestamp": 1589983093360, "timestamp_micro": 1589983093360134, "component_type": "PHYSICAL", "component_sub_type": "UNKNOWN", "component_name": "Physical" }, { "remote_ip_address": "192.168.111.70", "local_ip_address": "192.168.111.14", "vtep_label": 118785, "resource_type": "TraceflowObservationReceived", "sequence_no": 1, "transport_node_id": "297ec6b0-78e9-11ea-9259-79c38ffb2bf6", "transport_node_name": "sc2-10-185-243-227.eng.vmware.com", "transport_node_type": "ESX", "timestamp": 1589983093350, "timestamp_micro": 1589983093350284, "component_type": "PHYSICAL", "component_sub_type": "UNKNOWN", "component_name": "Physical" }, { "lport_id": "00000000-0000-0000-0000-000000000000", "resource_type": "TraceflowObservationReceivedLogical", "sequence_no": 1, "transport_node_id": "297ec6b0-78e9-11ea-9259-79c38ffb2bf6", "transport_node_name": "sc2-10-185-243-227.eng.vmware.com", "transport_node_type": "ESX", "timestamp": 1589983093350, "timestamp_micro": 1589983093350356, "component_type": "DFW", "component_sub_type": "UNKNOWN", "component_name": "Distributed Firewall" }, { "lport_id": "00000000-0000-0000-0000-000000000000", "acl_rule_id": 2, "resource_type": "TraceflowObservationForwardedLogical", "sequence_no": 1, "transport_node_id": "297ec6b0-78e9-11ea-9259-79c38ffb2bf6", "transport_node_name": "sc2-10-185-243-227.eng.vmware.com", "transport_node_type": "ESX", "timestamp": 1589983093350, "timestamp_micro": 1589983093350407, "component_type": "DFW", "component_sub_type": "UNKNOWN", "component_name": "Distributed Firewall" }, { "lport_id": "00000000-0000-0000-0000-000000000000", "resource_type": "TraceflowObservationDelivered", "sequence_no": 1, "transport_node_id": "297ec6b0-78e9-11ea-9259-79c38ffb2bf6", "transport_node_name": "sc2-10-185-243-227.eng.vmware.com", "transport_node_type": "ESX", "timestamp": 1589983093350, "timestamp_micro": 1589983093350419, "component_type": "PHYSICAL", "component_sub_type": "UNKNOWN", "component_name": "Physical" } ] }, { "packet_id": "1", "direction": "BACKWARD", "result_overflowed": false, "counters": { "received_count": 2, "delivered_count": 1, "dropped_count": 0, "forwarded_count": 1 }, "logical_counters": { "received_count": 2, "delivered_count": 0, "dropped_count": 0, "forwarded_count": 2 }, "observations": [ { "resource_type": "TraceflowObservationReceived", "sequence_no": 0, "transport_node_id": "297ec6b0-78e9-11ea-9259-79c38ffb2bf6", "transport_node_name": "sc2-10-185-243-227.eng.vmware.com", "transport_node_type": "ESX", "timestamp": 1589983092355, "timestamp_micro": 1589983092355004, "component_type": "PHYSICAL", "component_sub_type": "UNKNOWN", "component_name": "Physical" }, { "lport_id": "00000000-0000-0000-0000-000000000000", "resource_type": "TraceflowObservationReceivedLogical", "sequence_no": 0, "transport_node_id": "297ec6b0-78e9-11ea-9259-79c38ffb2bf6", "transport_node_name": "sc2-10-185-243-227.eng.vmware.com", "transport_node_type": "ESX", "timestamp": 1589983092355, "timestamp_micro": 1589983092355064, "component_type": "DFW", "component_sub_type": "UNKNOWN", "component_name": "Distributed Firewall" }, { "lport_id": "00000000-0000-0000-0000-000000000000", "acl_rule_id": 2, "resource_type": "TraceflowObservationForwardedLogical", "sequence_no": 0, "transport_node_id": "297ec6b0-78e9-11ea-9259-79c38ffb2bf6", "transport_node_name": "sc2-10-185-243-227.eng.vmware.com", "transport_node_type": "ESX", "timestamp": 1589983092355, "timestamp_micro": 1589983092355099, "component_type": "DFW", "component_sub_type": "UNKNOWN", "component_name": "Distributed Firewall" }, { "context": 0, "remote_ip_address": "192.168.111.70", "local_ip_address": "192.168.111.14", "vtep_label": 118785, "resource_type": "TraceflowObservationForwarded", "sequence_no": 0, "transport_node_id": "297ec6b0-78e9-11ea-9259-79c38ffb2bf6", "transport_node_name": "sc2-10-185-243-227.eng.vmware.com", "transport_node_type": "ESX", "timestamp": 1589983092355, "timestamp_micro": 1589983092355163, "component_type": "PHYSICAL", "component_sub_type": "UNKNOWN", "component_name": "Physical" }, { "remote_ip_address": "192.168.111.14", "local_ip_address": "192.168.111.70", "vtep_label": 118786, "resource_type": "TraceflowObservationReceived", "sequence_no": 1, "transport_node_id": "4de6359e-78e9-11ea-9904-455b0cc9e97f", "transport_node_name": "sc2-10-185-241-17.eng.vmware.com", "transport_node_type": "ESX", "timestamp": 1589983092369, "timestamp_micro": 1589983092369111, "component_type": "PHYSICAL", "component_sub_type": "UNKNOWN", "component_name": "Physical" }, { "lport_id": "00000000-0000-0000-0000-000000000000", "resource_type": "TraceflowObservationReceivedLogical", "sequence_no": 1, "transport_node_id": "4de6359e-78e9-11ea-9904-455b0cc9e97f", "transport_node_name": "sc2-10-185-241-17.eng.vmware.com", "transport_node_type": "ESX", "timestamp": 1589983092369, "timestamp_micro": 1589983092369170, "component_type": "DFW", "component_sub_type": "UNKNOWN", "component_name": "Distributed Firewall" }, { "lport_id": "00000000-0000-0000-0000-000000000000", "acl_rule_id": 2, "resource_type": "TraceflowObservationForwardedLogical", "sequence_no": 1, "transport_node_id": "4de6359e-78e9-11ea-9904-455b0cc9e97f", "transport_node_name": "sc2-10-185-241-17.eng.vmware.com", "transport_node_type": "ESX", "timestamp": 1589983092369, "timestamp_micro": 1589983092369207, "component_type": "DFW", "component_sub_type": "UNKNOWN", "component_name": "Distributed Firewall" }, { "lport_id": "00000000-0000-0000-0000-000000000000", "resource_type": "TraceflowObservationDelivered", "sequence_no": 1, "transport_node_id": "4de6359e-78e9-11ea-9904-455b0cc9e97f", "transport_node_name": "sc2-10-185-241-17.eng.vmware.com", "transport_node_type": "ESX", "timestamp": 1589983092369, "timestamp_micro": 1589983092369221, "component_type": "PHYSICAL", "component_sub_type": "UNKNOWN", "component_name": "Physical" } ] }, { "packet_id": "2", "direction": "BACKWARD", "result_overflowed": false, "counters": { "received_count": 2, "delivered_count": 1, "dropped_count": 0, "forwarded_count": 1 }, "logical_counters": { "received_count": 2, "delivered_count": 0, "dropped_count": 0, "forwarded_count": 2 }, "observations": [ { "resource_type": "TraceflowObservationReceived", "sequence_no": 0, "transport_node_id": "297ec6b0-78e9-11ea-9259-79c38ffb2bf6", "transport_node_name": "sc2-10-185-243-227.eng.vmware.com", "transport_node_type": "ESX", "timestamp": 1589983093361, "timestamp_micro": 1589983093361882, "component_type": "PHYSICAL", "component_sub_type": "UNKNOWN", "component_name": "Physical" }, { "lport_id": "00000000-0000-0000-0000-000000000000", "resource_type": "TraceflowObservationReceivedLogical", "sequence_no": 0, "transport_node_id": "297ec6b0-78e9-11ea-9259-79c38ffb2bf6", "transport_node_name": "sc2-10-185-243-227.eng.vmware.com", "transport_node_type": "ESX", "timestamp": 1589983093361, "timestamp_micro": 1589983093361956, "component_type": "DFW", "component_sub_type": "UNKNOWN", "component_name": "Distributed Firewall" }, { "lport_id": "00000000-0000-0000-0000-000000000000", "acl_rule_id": 2, "resource_type": "TraceflowObservationForwardedLogical", "sequence_no": 0, "transport_node_id": "297ec6b0-78e9-11ea-9259-79c38ffb2bf6", "transport_node_name": "sc2-10-185-243-227.eng.vmware.com", "transport_node_type": "ESX", "timestamp": 1589983093361, "timestamp_micro": 1589983093361994, "component_type": "DFW", "component_sub_type": "UNKNOWN", "component_name": "Distributed Firewall" }, { "context": 0, "remote_ip_address": "192.168.111.70", "local_ip_address": "192.168.111.14", "vtep_label": 118785, "resource_type": "TraceflowObservationForwarded", "sequence_no": 0, "transport_node_id": "297ec6b0-78e9-11ea-9259-79c38ffb2bf6", "transport_node_name": "sc2-10-185-243-227.eng.vmware.com", "transport_node_type": "ESX", "timestamp": 1589983093362, "timestamp_micro": 1589983093362069, "component_type": "PHYSICAL", "component_sub_type": "UNKNOWN", "component_name": "Physical" }, { "remote_ip_address": "192.168.111.14", "local_ip_address": "192.168.111.70", "vtep_label": 118786, "resource_type": "TraceflowObservationReceived", "sequence_no": 1, "transport_node_id": "4de6359e-78e9-11ea-9904-455b0cc9e97f", "transport_node_name": "sc2-10-185-241-17.eng.vmware.com", "transport_node_type": "ESX", "timestamp": 1589983093376, "timestamp_micro": 1589983093376153, "component_type": "PHYSICAL", "component_sub_type": "UNKNOWN", "component_name": "Physical" }, { "lport_id": "00000000-0000-0000-0000-000000000000", "resource_type": "TraceflowObservationReceivedLogical", "sequence_no": 1, "transport_node_id": "4de6359e-78e9-11ea-9904-455b0cc9e97f", "transport_node_name": "sc2-10-185-241-17.eng.vmware.com", "transport_node_type": "ESX", "timestamp": 1589983093376, "timestamp_micro": 1589983093376219, "component_type": "DFW", "component_sub_type": "UNKNOWN", "component_name": "Distributed Firewall" }, { "lport_id": "00000000-0000-0000-0000-000000000000", "acl_rule_id": 2, "resource_type": "TraceflowObservationForwardedLogical", "sequence_no": 1, "transport_node_id": "4de6359e-78e9-11ea-9904-455b0cc9e97f", "transport_node_name": "sc2-10-185-241-17.eng.vmware.com", "transport_node_type": "ESX", "timestamp": 1589983093376, "timestamp_micro": 1589983093376263, "component_type": "DFW", "component_sub_type": "UNKNOWN", "component_name": "Distributed Firewall" }, { "lport_id": "00000000-0000-0000-0000-000000000000", "resource_type": "TraceflowObservationDelivered", "sequence_no": 1, "transport_node_id": "4de6359e-78e9-11ea-9904-455b0cc9e97f", "transport_node_name": "sc2-10-185-241-17.eng.vmware.com", "transport_node_type": "ESX", "timestamp": 1589983093376, "timestamp_micro": 1589983093376276, "component_type": "PHYSICAL", "component_sub_type": "UNKNOWN", "component_name": "Physical" } ] } ], "counter_results" : { "forward_results": [ { "resource_type": "CountObservation", "port_id": "f42d13ef-834b-46e5-8acc-edbcabc46139", "transport_node_id": "67124d2a-879f-450e-8536-0dee13265103", "checkpoints": { "non_ens_checkpoints_result": [ { "checkpoint_type": "PORT_OUTPUT", "count": 1 }, { "checkpoint_type": "DFW_OUTPUT", "count": 1 }, { "checkpoint_type": "DFW_INPUT", "count": 1 } ], "ens_checkpoints_result": [ { "checkpoint_type": "ENS_PORT_OUTPUT", "count": 9 } ] } } ] }, "pktcap_results": [ { "transport_node_id": "4de6359e-78e9-11ea-9904-455b0cc9e97f", "transport_node_type": "ESXi", "pktcap_resource_list": [ { "port_id": "d4568e3b-326f-48c8-abbd-5b8a557bb43a", "pktcap_file_download_url": "/api/v1/livetraces/309/proxy/forward/capturefile", "resource_type": "PktCapResource" } ] }, { "transport_node_id": "297ec6b0-78e9-11ea-9259-79c38ffb2bf6", "transport_node_type": "ESXi", "pktcap_resource_list": [ { "port_id": "836d2e5e-4188-4ef7-ac48-23a6acb8936f", "pktcap_file_download_url": "/api/v1/livetraces/309/proxy/reverse/capturefile" "resource_type": "PktCapResource" } ] } ] }

Required Permissions:

crud

Feature:

tools_livetrace

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