Create Packet Capture Session

Create Packet Capture Session

Create an new packet capture session on given node with specified options

Request
URI
POST
https://nsxmanager.your.domain/api/v1/pktcap/session
COPY
Request Body
PacketCaptureRequest of type(s) application/json
Required

Show optional properties

{
    "cappoint": "string",
    "capsource": "string"
}
{
    "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
}
integer As int32 As int32
capamount
Optional

Define the packet capture amount size.

integer As int32 As int32
capcore
Optional

The CPU core id on Edge node.

integer As int32 As int32
capduration
Optional

Define the packet capture duration time. After the capture duration time, the capture process will stop working.

integer As int32 As int32
capfilesize
Optional

Define the packet capture file size limit.

string
capmode
Optional

Define the capture streaming mode. The STREAM mode will send the data to given stream address and port. And the STANDALONE mode will save the capture file in local folder.

Possible values are : STANDALONE, STREAM,
string
cappoint
Required

Define the point to capture data.

Possible values are : VNIC, VMKNIC, VMNIC, VDRPORT, DVFILTER, LOGICALPORT, FCPORT, VIF, PNIC,
integer As int32 As int32
caprate
Optional

Define the rate of packet capture process.

integer As int32 As int32
capsnaplen
Optional

Limit the number of bytes captured from each packet.

string
capsource
Required

This type is used to differenite the incoming request from CLI/UI.

Possible values are : CLI, UI,
string
capvalue
Optional

Define the capture value of given capture point.

string
direction
Optional

Define the capture direction. Support three types INPUT/OUTPUT/DUAL.

Possible values are : INPUT, OUTPUT, DUAL,
string
filtertype
Optional

Define the capture filter type. Support PRE/POST mode.

Possible values are : PRE, POST,
string
node
Optional

Define the transport node to capture data.

string As ip As ip
node_ip
Optional

Define the transport node to capture data.

options
Optional

List of packet capture options to filter data in capture process.

string
streamaddress
Optional

Set the stream address to receive the capture packet.

integer As int32 As int32
streamport
Optional

Set the stream port to receive the capture packet. The STREAM mode is based on GRE-in-UDP Encapsulation(RFC8086). Packets are sent to UDP port 4754.

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
"PacketCaptureSession Object"

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
Returns NotFound of type(s) application/json
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>' -H 'Content-Type: application/json' -d '{"cappoint:"string","capsource:"string"}' https://{api_host}/api/v1/pktcap/session
                
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