Create Traceflow

Create Traceflow

Initiate a Traceflow Operation on the Specified Port

Request
URI
POST
https://nsxmanager.your.domain/api/v1/traceflows
COPY
Request Body
TraceflowRequest of type(s) application/json
Required 
{
    "packet": {
        "routed": false,
        "transport_type": "string",
        "resource_type": "string",
        "frame_size": 0
    },
    "timeout": 0,
    "lport_id": "string"
}
PacketData
packet
Required

packet

integer As int64 As int64
timeout
Optional

Maximum time (in ms) the management plane will wait for observation result list to be sent by controller plane.

string
lport_id
Required

id of the source logical port to inject the traceflow packet into

Authentication
This operation uses the following authentication methods.
Responses
201

Created

Returns Traceflow of type(s) application/json
This response body class contains all of the following: Resource , InlineTraceflow1 
{
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "operation_state": "string",
    "logical_counters": {
        "forwarded_count": 0,
        "dropped_count": 0,
        "delivered_count": 0,
        "received_count": 0
    },
    "timeout": 0,
    "result_overflowed": false,
    "lport_id": "string",
    "counters": {
        "forwarded_count": 0,
        "dropped_count": 0,
        "delivered_count": 0,
        "received_count": 0
    },
    "request_status": "string",
    "analysis": [
        "string"
    ],
    "id": "string"
}

400
Returns BadRequest of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

403
Returns Forbidden of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

404
Returns NotFound of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

412
Returns PreconditionFailed of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

500
Returns InternalServerError of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

503
Returns ServiceUnavailable of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

On This Page
Troubleshooting And Monitoring Operations
POST
Create Packet Capture Session
POST
Create Port Mirroring Sessions
POST
Create Traceflow
POST
Delete All Capture Sessions Delete
POST
Delete Packet Capture Session Delete
DELETE
Delete Port Mirroring Session
DELETE
Delete Traceflow
GET
Get All Transport Nodes Status
GET
Get All Transport Zone Status
GET
Get Forwarding Path
GET
Get Heatmap Transport Zone Status
GET
Get Ipfix Obs Points
GET
Get Pnic Statuses For Transport Node
GET
Get Port Mirroring Session
GET
Get Switch Ipfix Config
GET
Get Traceflow
GET
Get Traceflow Observations
GET
Get Transport Node Report
GET
Get Transport Node Report For A Transport Zone
GET
Get Transport Node Status
GET
List Node Logs
GET
List Packet Capture Sessions
GET
List Port Mirroring Session
GET
List Remote Transport Node Status
GET
List Traceflows
GET
List Transport Node Status
GET
List Transport Node Status For Transport Zone
GET
Read Node Log
GET
Read Node Log Data
GET
Read Packet Capture Session
POST
Terminate Packet Capture Session Terminate
PUT
Update Port Mirroring Session
PUT
Update Switch Ipfix Config
POST
Verify Port Mirroring Session Verify