Read Packet Capture Session

Read Packet Capture Session

Get the packet capture status information by session id.

Request
URI
GET
https://nsxmanager.your.domain/api/v1/pktcap/session/{session-id}
COPY
Path Parameters
string
session-id
Required

Packet capture session id

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns PacketCaptureSession of type(s) application/json 
{
    "sessionid": "string",
    "filelocation": "string",
    "filesize": 0,
    "sessionname": "string",
    "errormsg": "string",
    "endtime": 0,
    "request": {
        "node": "string",
        "cappoint": "string",
        "capduration": 0,
        "capamount": 0,
        "capsource": "string",
        "filtertype": "string",
        "direction": "string",
        "capfilesize": 0,
        "options": {
            "values": [
                {
                    "name": "string",
                    "value": "string"
                }
            ]
        },
        "streamport": 0,
        "caprate": 0,
        "capvalue": "string",
        "streamaddress": "string",
        "capmode": "string"
    },
    "starttime": 0,
    "sessionstatus": "string"
}
string
sessionid
Required

Packet capture session id

string
filelocation
Optional

Packet capture file location

integer As int32 As int32
filesize
Optional

Packet capture file Size in bytes

string
sessionname
Optional

Packet capture session name

string
errormsg
Optional

Error messasge in capture

integer As int64 As int64
endtime
Optional

Timestamp when session was stopped in epoch millisecond

PacketCaptureRequest
request
Required

request

integer As int64 As int64
starttime
Optional

Timestamp when session was created in epoch millisecond

string
sessionstatus
Required

Packet capture session status

Possible values are : CREATED, STARTED, STOPPED, FINISHED, ERROR,

400
Returns BadRequest of type(s) application/json 
{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
object
error_data
Optional

Additional data about the error

string
details
Optional

Further details about the error

array of ApiError
related_errors
Optional

Other errors related to this error

string
module_name
Optional

The module name where the error occurred

string
error_message
Optional

A description of the error

integer As int64 As int64
error_code
Optional

A numeric error code


403
Returns Forbidden of type(s) application/json 
{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
object
error_data
Optional

Additional data about the error

string
details
Optional

Further details about the error

array of ApiError
related_errors
Optional

Other errors related to this error

string
module_name
Optional

The module name where the error occurred

string
error_message
Optional

A description of the error

integer As int64 As int64
error_code
Optional

A numeric error code


404

Not Found

Operation doesn't return any data structure

412
Returns PreconditionFailed of type(s) application/json 
{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
object
error_data
Optional

Additional data about the error

string
details
Optional

Further details about the error

array of ApiError
related_errors
Optional

Other errors related to this error

string
module_name
Optional

The module name where the error occurred

string
error_message
Optional

A description of the error

integer As int64 As int64
error_code
Optional

A numeric error code


500
Returns InternalServerError of type(s) application/json 
{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
object
error_data
Optional

Additional data about the error

string
details
Optional

Further details about the error

array of ApiError
related_errors
Optional

Other errors related to this error

string
module_name
Optional

The module name where the error occurred

string
error_message
Optional

A description of the error

integer As int64 As int64
error_code
Optional

A numeric error code


503
Returns ServiceUnavailable of type(s) application/json 
{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
object
error_data
Optional

Additional data about the error

string
details
Optional

Further details about the error

array of ApiError
related_errors
Optional

Other errors related to this error

string
module_name
Optional

The module name where the error occurred

string
error_message
Optional

A description of the error

integer As int64 As int64
error_code
Optional

A numeric error code


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