NSX-T Data Center REST API

Get the status of a livetrace session (Deprecated)

Request:

Method:

GET

URI Path(s):

/api/v1/livetraces/<livetrace-session-id>

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/livetraces/309

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

LiveTraceStatus+

LiveTraceStatus (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
actions	Action to the filtered packet	LiveTraceActionConfig	Required Readonly
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
filter	Packet filter for flows of interest	LiveTraceFilterData (Abstract type: pass one of the following concrete types) FieldsFilterData PlainFilterData	Readonly
filter_invalid_info	Detail on invalid filter(s) in a Livetrace session. The detail of invalid filter(s) in a Livetrace session. This field is only applicable for filters of PlainFilterData type.	array of LiveTraceFilterInvalidInfo	Readonly
id	Unique identifier of this resource	string	Sortable
invalidation_reason	Livetrace invalidation reason The reason of invalidating a Livetrace session. PORT_DISCONNECT - Source or destination logical port of the session is disconnected. DP_DESTROY - Dataplane is destroyed. UNKNOWN - The invalidation reason cannot be determined. PCAP_IO_FAILURE - Exception occurred when writing captured packets to file. In general, this issue could be caused by insufficient disk partition space of /tmp on ESXi or Edge.	string	Readonly Enum: PORT_DISCONNECT, DP_DESTROY, UNKNOWN, PCAP_IO_FAILURE
operation_state	Operation state The operation state of Livetrace. IN_PROGRESS - collecting the session results. FINISHED - session results collection completes. PARTIAL_FINISHED - session results may be incomplete. CANCELED - session is cancelled by exception. INVALIDATED - session is invalidated by configuration changes such as VM migration. TIMEOUT - session is not completed on time.	string	Required Readonly Enum: IN_PROGRESS, FINISHED, PARTIAL_FINISHED, CANCELED, INVALIDATED, TIMEOUT
request_status	Livetrace request status The status of a Livetrace request. SUCCESS_DELIVERED - The request is delivered successfully. LCP_FAILURE - LCP agent fails to realize the request. INVALID_FILTER - Filter is invalid. DATAPATH_FAILURE - Dataplane fails to realize the request. TIMEOUT - The response to the request is not received within timeout. CONNECTION_ERROR - There is connection error between host components. UNKNOWN - The status of request cannot be determined.	string	Required Readonly Enum: SUCCESS_DELIVERED, LCP_FAILURE, INVALID_FILTER, DATAPATH_FAILURE, CONNECTION_ERROR, TIMEOUT, UNKNOWN
resource_type	Must be set to the value LiveTraceStatus	string
source_lport	The source logical port	string	Required Readonly
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
timeout	Timeout in seconds for livetrace session	integer	Required Readonly Minimum: 5 Maximum: 300

Example Response:

{ "id": "309", "source_lport": "d4568e3b-326f-48c8-abbd-5b8a557bb43a", "operation_state": "FINISHED", "timeout": 10, "filter": { "ip_info": { "src_ip": "10.185.241.17", "dst_ip": "10.185.243.227" }, "transport_info": { "protocol": "TCP", "src_port": 16637, "dst_port": 80 }, "resource_type": "FieldsFilterData" }, "actions": { "trace_config": { "action_argument": { "trace_type": "BI_DIRECTIONAL", "dest_lport": "836d2e5e-4188-4ef7-ac48-23a6acb8936f" }, "sampling_argument": { "match_number": 2, "sampling_type": "FirstNSampling" } }, "pktcap_config": { "action_argument": { "pktcap_type": "BI_DIRECTIONAL", "dest_lport": "836d2e5e-4188-4ef7-ac48-23a6acb8936f" }, "sampling_argument": { "match_number": 2, "sampling_type": "FirstNSampling" } } }, "request_status": "SUCCESS_DELIVERED", "_protection": "NOT_PROTECTED" }

Required Permissions:

read

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