PacketCaptureRequest

PacketCaptureRequest
PacketCaptureRequest

This type is used to create packet request on give node. Need to specify related parameters according to the capture point.

JSON Example
{
    "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.