List Packet Capture Sessions

• Troubleshooting And Monitoring

Get the information of all packet capture sessions.

Request

URI

GET

https://nsxmanager.your.domain/api/v1/pktcap/sessions

COPY

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Hide Details

OK

Returns PacketCaptureSessionList of type(s) application/json

This response body class contains all of the following: ListResult , InlinePacketCaptureSessionList1

{
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "cursor": "string",
    "sort_ascending": false,
    "sort_by": "string",
    "result_count": 0,
    "results": [
        {
            "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"
        }
    ]
}

400

Hide Details

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

Hide Details

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

Hide Details

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

Hide Details

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

Hide Details

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

Hide Details

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

Description

Request

Authentication

Response

200 Response Body

Errors

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