NSX-T Data Center REST API
# ***************************************************************************
# Copyright 2020-2024 VMware, Inc. All rights reserved. VMware Confidential.
# ***************************************************************************
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 or disabled. 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. DP_MODE_CHANGE - This invalidation type indicates that the livetrace function will not work if the datapath mode of ports with livetrace enabled is changed (e.g., from Standard mode to Enhanced Datapath mode). |
string | Readonly Enum: PORT_DISCONNECT, DP_DESTROY, UNKNOWN, PCAP_IO_FAILURE, DP_MODE_CHANGE |
| ipsec_vpn_config | IPSec VPN configuration for starting livetrace on IPSec tunnel interface IPSec VPN configuration for starting livetrace on IPSec tunnel interface |
LiveTraceIpsecVpnConfig | Readonly |
| 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: 600 |