Initiate a Traceflow Operation on the Specified Port

Request:

Method:

POST

URI Path(s):

/api/v1/traceflows

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

TraceflowRequest+

TraceflowRequest (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
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
id	Unique identifier of this resource	string	Sortable
lport_id	id of the source logical port to inject the traceflow packet into	string	Required
packet	Packet configuration	PacketData (Abstract type: pass one of the following concrete types) BinaryPacketData FieldsPacketData	Required
resource_type	Must be set to the value TraceflowRequest	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
timeout	Timeout (in ms) for traceflow observations result list Maximum time (in ms) the management plane will wait for observation result list to be sent by controller plane.	integer	Minimum: 5000 Maximum: 15000 Default: "10000"

Example Request:

POST https://<nsx-mgr>/api/v1/traceflows { "packet": { "routed": "true", "transport_type": "UNICAST", "ip_header": { "src_ip": "192.168.1.10", "dst_ip": "192.168.2.10" }, "eth_header": { "dst_mac": "00:0c:29:de:4c:7b", "src_mac": "00:0c:29:9d:35:78" }, "payload": "test_payload", "resource_type": "FieldsPacketData" }, "timeout": 10000, "lport_id": "81d929ee-bc86-4e55-83d1-8e0451585d71" } { "packet": { "routed": "true", "transport_header": { "tcp_header": { "tcp_flags": "2", "src_port": "8080", "dst_port": "8080" } }, "ip_header": { "src_ip": "192.168.1.10", "dst_ip": "192.168.2.10" }, "eth_header": { "dst_mac": "00:0c:29:de:4c:7b", "src_mac": "00:0c:29:9d:35:78" }, "payload": "YXNkZmRhc2Zhc2Zhc2RmYXNmYXNkZm9pZXdoeWZsbGRrYXNmamFsc2RmanNh", "resource_type": "FieldsPacketData" }, "timeout": 5000, "lport_id": "81d929ee-bc86-4e55-83d1-8e0451585d71" } { "packet": { "routed": "true", "transport_header": { "udp_header": { "src_port": "8080", "dst_port": "8080" } }, "frame_size": "256", "ip_header": { "src_ip": "192.168.1.10", "dst_ip": "192.168.2.10" }, "eth_header": { "dst_mac": "00:0c:29:de:4c:7b", "src_mac": "00:0c:29:9d:35:78" }, "payload": "YXNkZmRhc2Zhc2Zhc2RmYXNmYXNkZm9pZXdoeWZsbGRrYXNmamFsc2RmanNh", "resource_type": "FieldsPacketData" }, "timeout": 8000, "lport_id": "81d929ee-bc86-4e55-83d1-8e0451585d71" } { "packet": { "route": "true", "transport_header": { "dhcp_header": { "op_code": "BOOTREQUEST" } }, "frame_size": "256", "ip_header": { "src_ip": "192.168.1.10", "dst_ip": "192.168.2.10" }, "eth_header": { "dst_mac": "00:0c:29:de:4c:7b", "src_mac": "00:0c:29:9d:35:78" } "payload": "YXNkZmRhc2Zhc2Zhc2RmYXNmYXNkZm9pZXdoeWZsbGRrYXNmamFsc2RmanNh", "resource_type": "FieldsPacketData" }, "timeout": 8000, "lport_id": "81d929ee-bc86-4e55-83d1-8e0451585d71" } { "packet": { "routed": "true", "transport_header": { "icmp_echo_request_header": { "sequence": "1" } }, "frame_size": "256", "ip_header": { "src_ip": "192.168.1.10", "dst_ip": "192.168.2.10" }, "eth_header": { "dst_mac": "00:0c:29:de:4c:7b", "src_mac": "00:0c:29:9d:35:78" }, "payload": "YXNkZmRhc2Zhc2Zhc2RmYXNmYXNkZm9pZXdoeWZsbGRrYXNmamFsc2RmanNh", "resource_type": "FieldsPacketData" }, "timeout": 5000, "lport_id": "81d929ee-bc86-4e55-83d1-8e0451585d71" } { "packet" { "routed": "false", "arp_header" : { "op_code":"ARP_REQUEST", "src_ip":"192.168.1.10", "dst_ip":192.168.1.11" }, "eth_header":{ "dst_mac":"ff:ff:ff:ff:ff:ff", "src_mac":"00:0c:29:9d:35:78", "eth_type":2054 }, "payload":"YXNkZmRhc2Zhc2Zhc2RmYXNmYXNkZm9pZXdoeWZsbGRrYXNmamFsc2RmanNh", "resource_type":"FieldPacketData" }, "timeout":5000, "lport_id":"81d929ee-bc86-4e55-83d1-8e0451585d71" }

Successful Response:

Response Code:

201 Created

Response Headers:

Content-type: application/json

Response Body:

Traceflow+

Traceflow (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
analysis	Traceflow result analysis notes	array of string	Readonly
counters	observation counters	TraceflowObservationCounters	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
id	The id of the traceflow round	string	Required Readonly
logical_counters	counters of observations from logical components	TraceflowObservationCounters	Readonly
lport_id	id of the source logical port used for injecting the traceflow packet	string	Readonly
operation_state	Represents the traceflow operation state	string	Required Readonly Enum: IN_PROGRESS, FINISHED, FAILED
request_status	Traceflow request status The status of the traceflow RPC request. SUCCESS - The traceflow request is sent successfully. TIMEOUT - The traceflow request gets timeout. SOURCE_PORT_NOT_FOUND - The source port of the request cannot be found. DATA_PATH_NOT_READY - The datapath component cannot be ready to receive request. CONNECTION_ERROR - There is connection error on datapath component. UNKNOWN - The status of traceflow request cannot be determined.	string	Readonly Enum: SUCCESS, TIMEOUT, SOURCE_PORT_NOT_FOUND, DATA_PATH_NOT_READY, CONNECTION_ERROR, UNKNOWN
resource_type	Must be set to the value Traceflow	string
result_overflowed	A flag, when set true, indicates some observations were deleted from the result set.	boolean	Readonly
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
timeout	Timeout (in ms) for traceflow observations result list Maximum time (in ms) the management plane will be waiting for this traceflow round.	integer	Readonly Minimum: 5000 Maximum: 15000

Example Response:

{ "lport_id" : "81d929ee-bc86-4e55-83d1-8e0451585d71", "counters" : { "forwarded_count" : 0, "delivered_count" : 0, "received_count" : 0, "dropped_count" : 0 }, "logical_counters" : { "forwarded_count" : 0, "delivered_count" : 0, "received_count" : 0, "dropped_count" : 0 }, "operation_state" : "IN_PROGRESS", "id" : "e2839c5f-5759-4673-bb11-8d4df2fbfa96", "result_overflowed" : false, "timeout" : 10000 } { "lport_id" : "81d929ee-bc86-4e55-83d1-8e0451585d71", "counters" : { "forwarded_count" : 0, "delivered_count" : 0, "received_count" : 0, "dropped_count" : 0 }, "logical_counters" : { "forwarded_count" : 0, "delivered_count" : 0, "received_count" : 0, "dropped_count" : 0 }, "operation_state" : "IN_PROGRESS", "id" : "40ba98be-df3d-421b-bdd7-30c1bce8a6ca", "result_overflowed" : false, "timeout" : 5000 } { "lport_id" : "81d929ee-bc86-4e55-83d1-8e0451585d71", "counters" : { "forwarded_count" : 0, "delivered_count" : 0, "received_count" : 0, "dropped_count" : 0 }, "logical_counters" : { "forwarded_count" : 0, "delivered_count" : 0, "received_count" : 0, "dropped_count" : 0 }, "operation_state" : "IN_PROGRESS", "id" : "d77a89a1-670f-43b0-809d-6ef792051f30", "result_overflowed" : false, "timeout" : 8000 } { "lport_id" : "81d929ee-bc86-4e55-83d1-8e0451585d71", "counters" : { "forwarded_count" : 0, "delivered_count" : 0, "received_count" : 0, "dropped_count" : 0 }, "logical_counters" : { "forwarded_count" : 0, "delivered_count" : 0, "received_count" : 0, "dropped_count" : 0 }, "operation_state" : "IN_PROGRESS", "id" : "d77a89a1-670f-43b0-809d-6ef792051f30", "result_overflowed" : false, "timeout" : 8000 } { "lport_id" : "81d929ee-bc86-4e55-83d1-8e0451585d71", "counters" : { "forwarded_count" : 0, "delivered_count" : 0, "received_count" : 0, "dropped_count" : 0 }, "logical_counters" : { "forwarded_count" : 0, "delivered_count" : 0, "received_count" : 0, "dropped_count" : 0 }, "operation_state" : "IN_PROGRESS", "id" : "c812263a-2122-45b4-b816-d6480eee6928", "result_overflowed" : false, "timeout" : 5000 } { "lport_id" : "81d929ee-bc86-4e55-83d1-8e0451585d71", "counters" : { "forwarded_count" : 0, "delivered_count" : 0, "received_count" : 0, "dropped_count" : 0 }, "logical_counters" : { "forwarded_count" : 0, "delivered_count" : 0, "received_count" : 0, "dropped_count" : 0 }, "operation_state" : "IN_PROGRESS", "id" : "c812263a-2122-45b4-b816-d6480eee6928", "result_overflowed" : false, "timeout" : 5000 }