NSX-T Data Center REST API

PacketCaptureRequest (schema)

Packet capture request information

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

Name Description Type Notes
capamount Packet capture amount

Define the packet capture amount size.
int
capcore The CPU core id on Edge node

The CPU core id on Edge node.
int
capduration Packet capture duration time in seconds

Define the packet capture duration time. After the capture duration time, the capture process will stop working.
int
capfilesize Packet capture file size limit

Define the packet capture file size limit.
int
capmode Packet Capture streaming mode

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.
string Enum: STANDALONE, STREAM
cappoint Packet capture point

Define the point to capture data.
string Required
Enum: VNIC, VMKNIC, VMNIC, VDRPORT, DVFILTER, LOGICALPORT, FCPORT, VIF, PNIC
caprate Packet capture rate

Define the rate of packet capture process.
int
capsnaplen Packet capture snapshot length

Limit the number of bytes captured from each packet.
int
capsource Packet capture source type

This type is used to differenite the incoming request from CLI/UI.
string Required
Enum: CLI, UI
capvalue Packet capture point value

Define the capture value of given capture point.
string
direction Packet capture direction type

Define the capture direction. Support three types INPUT/OUTPUT/DUAL.
string Enum: INPUT, OUTPUT, DUAL
filtertype Packet capture dvfilter stage type

Define the capture filter type. Support PRE/POST mode.
string Enum: PRE, POST
node Packet capture node id

Define the transport node to capture data.
string
node_ip Packet capture node ip

Define the transport node to capture data.
IPAddress
options Packet capture options

Define the packet capture additional options to filter the capture data.
PacketCaptureOptionList
streamaddress Packet capture Streaming address

Set the stream address to receive the capture packet.
string
streamport Packet capture Streaming port

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.
int