Delete Packet Capture Session

Delete Packet Capture Session

Before calling this method, terminate any running capture session.

Request
URI
POST
https://nsxmanager.your.domain/api/v1/pktcap/session/{session-id}?action=delete
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
This response body class contains all of the following: InlinePacketCaptureSession1 
{
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "_self": {},
    "_revision": 0,
    "_create_time": 0,
    "_create_user": "string",
    "_last_modified_time": 0,
    "_last_modified_user": "string",
    "_protection": "string",
    "_system_owned": false,
    "description": "string",
    "display_name": "string",
    "id": "string",
    "resource_type": "string",
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ],
    "endtime": 0,
    "errormsg": "string",
    "filelocation": "string",
    "filesize": 0,
    "request": {
        "capamount": 0,
        "capcore": 0,
        "capduration": 0,
        "capfilesize": 0,
        "capmode": "string",
        "cappoint": "string",
        "caprate": 0,
        "capsnaplen": 0,
        "capsource": "string",
        "capvalue": "string",
        "direction": "string",
        "filtertype": "string",
        "node": "string",
        "node_ip": "string",
        "options": {
            "values": [
                {
                    "name": "string",
                    "value": "string"
                }
            ]
        },
        "streamaddress": "string",
        "streamport": 0
    },
    "sessionid": "string",
    "sessionname": "string",
    "sessionstatus": "string",
    "starttime": 0
}

400
Returns BadRequest of type(s) application/json
Operation doesn't return any data structure

403
Returns Forbidden of type(s) application/json
Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

412
Returns PreconditionFailed of type(s) application/json
Operation doesn't return any data structure

500
Returns InternalServerError of type(s) application/json
Operation doesn't return any data structure

503
Returns ServiceUnavailable of type(s) application/json
Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' https://{api_host}/api/v1/pktcap/session/{session-id}?action=delete
On This Page
Management Plane Api Operations
GET
List Ipfix Collector Upm Profiles
Deprecated
POST
Create Ipfix Collector Upm Profile
Deprecated
DELETE
Delete Ipfix Collector Upm Profile
Deprecated
GET
Get Ipfix Collector Upm Profile
Deprecated
PUT
Update Ipfix Collector Upm Profile
Deprecated
GET
List Ipfix Upm Profiles
Deprecated
POST
Create Ipfix Upm Profile
Deprecated
DELETE
Delete Ipfix Upm Profile
Deprecated
GET
Get Ipfix Upm Profile
Deprecated
PUT
Update Ipfix Upm Profile
Deprecated
GET
List Ipfix Collector Config
Deprecated
POST
Create Ipfix Collector Config
Deprecated
DELETE
Delete Ipfix Collector Config
Deprecated
GET
Get Ipfix Collector Config
Deprecated
PUT
Update Ipfix Collector Config
Deprecated
GET
List Ipfix Config
Deprecated
POST
Create Ipfix Config
Deprecated
DELETE
Delete Ipfix Config
Deprecated
GET
Get Ipfix Config
Deprecated
PUT
Update Ipfix Config
Deprecated
GET
List Live Trace
Deprecated
POST
Create Live Trace
Deprecated
DELETE
Delete Live Trace
Deprecated
GET
Get Live Trace Status
Deprecated
GET
Get Forward Pkt Cap File Proxy
Deprecated
GET
Get Reverse Pkt Cap File Proxy
Deprecated
GET
Get Live Trace Result
Deprecated
GET
Get Forwarding Path
Deprecated
GET
List Manual Health Checks
POST
Create Manual Health Check
DELETE
Delete Manual Health Check
GET
Get Manual Health Check
GET
List Port Mirroring Session
Deprecated
POST
Create Port Mirroring Sessions
Deprecated
DELETE
Delete Port Mirroring Session
Deprecated
GET
Get Port Mirroring Session
Deprecated
PUT
Update Port Mirroring Session
Deprecated
GET
Get Mirror Stack Status
Deprecated
POST
Verify Port Mirroring Session
Deprecated
POST
Create Packet Capture Session
GET
Read Packet Capture Session
GET
Get Capture File
POST
Delete Packet Capture Session
POST
Restart Packet Capture Session
POST
Terminate Packet Capture Session
GET
List Packet Capture Sessions
POST
Delete All Capture Sessions
GET
List Traceflows
Deprecated
POST
Create Traceflow
Deprecated
DELETE
Delete Traceflow
Deprecated
GET
Get Traceflow
Deprecated
GET
Get Traceflow Observations
Deprecated