Linux Blog

DUMPCAP

Section: The Wireshark Network Analyzer (1)
Updated: 2007-02-01
Index Return to Main Contents
 

NAME

dumpcap - Dump network traffic  

SYNOPSYS

dumpcap-a <capture autostop condition> ] ... [ -b <capture ring buffer option>] ... [ -B <capture buffer size (Win32 only)> ]  [ -c <capture packet count> ] [ -D ] [ -f <capture filter> ] [ -h ] [ -i <capture interface>|- ] [ -L ] [ -p ] [ -s <capture snaplen> ] [ -v ] [ -w <outfile> ] [ -y <capture link type> ]  

DESCRIPTION

Dumpcap is a network traffic dump tool. It lets you capture packet data from a live network and write the packets to a file. Dumpcap's native capture file format is libpcap format, which is also the format used by Wireshark, tcpdump and various other tools.

Without any options set it will use the pcap library to capture traffic from the first available network interface and writes the received raw packet data, along with the packets' time stamps into a libpcap file.

If the -w option is not specified, Dumpcap writes to a newly created libpcap file with a randomly chosen name. If the -w option is specified, Dumpcap writes to the file specified by that option.

Packet capturing is performed with the pcap library. The capture filter syntax follows the rules of the pcap library.  

OPTIONS

-a <capture autostop condition>
Specify a criterion that specifies when Dumpcap is to stop writing to a capture file. The criterion is of the form test:value, where test is one of:

duration:value Stop writing to a capture file after value seconds have elapsed.

filesize:value Stop writing to a capture file after it reaches a size of value kilobytes (where a kilobyte is 1024 bytes). If this option is used together with the -b option, dumpcap will stop writing to the current capture file and switch to the next one if filesize is reached.

files:value Stop writing to capture files after value number of files were written.

-b <capture ring buffer option>
Cause Dumpcap to run in ``multiple files'' mode. In ``multiple files'' mode, Dumpcap will write to several capture files. When the first capture file fills up, Dumpcap will switch writing to the next file and so on.

The created filenames are based on the filename given with the -w option, the number of the file and on the creation date and time, e.g. outfile_00001_20050604120117.pcap, outfile_00001_20050604120523.pcap, ...

With the files option it's also possible to form a ``ring buffer''. This will fill up new files until the number of files specified, at which point Dumpcap will discard the data in the first file and start writing to that file and so on. If the files option is not set, new files filled up until one of the capture stop conditions match (or until the disk if full).

The criterion is of the form key:value, where key is one of:

duration:value switch to the next file after value seconds have elapsed, even if the current file is not completely filled up.

filesize:value switch to the next file after it reaches a size of value kilobytes (where a kilobyte is 1024 bytes).

files:value begin again with the first file after value number of files were written (form a ring buffer).

-B <capture buffer size (Win32 only)>
Win32 only: set capture buffer size (in MB, default is 1MB). This is used by the the capture driver to buffer packet data until that data can be written to disk. If you encounter packet drops while capturing, try to increase this size.
-c <capture packet count>
Set the maximum number of packets to read when capturing live data.
-D
Print a list of the interfaces on which Dumpcap can capture, and exit. For each network interface, a number and an interface name, possibly followed by a text description of the interface, is printed. The interface name or the number can be supplied to the -i option to specify an interface on which to capture.

This can be useful on systems that don't have a command to list them (e.g., Windows systems, or UNIX systems lacking ifconfig -a); the number can be useful on Windows 2000 and later systems, where the interface name is a somewhat complex string.

Note that ``can capture'' means that Dumpcap was able to open that device to do a live capture. Depending on your system you may need to run dumpcap from an account with special privileges (for example, as root) to be able to capture network traffic. If "dumpcap -D" is not run from such an account, it will not list any interfaces.

-f <capture filter>
Set the capture filter expression.

The entire filter expression must be specified as a single argument (which means that if it contains spaces, it must be quoted).

-h
Print the version and options and exits.
-i <capture interface>|-
Set the name of the network interface or pipe to use for live packet capture.

Network interface names should match one of the names listed in "dumpcap -D`` (described above); a number, as reported by ''dumpcap -D``, can also be used. If you're using UNIX, ''netstat -i`` or ''ifconfig -a" might also work to list interface names, although not all versions of UNIX support the -a option to ifconfig.

If no interface is specified, Dumpcap searches the list of interfaces, choosing the first non-loopback interface if there are any non-loopback interfaces, and choosing the first loopback interface if there are no non-loopback interfaces. If there are no interfaces at all, Dumpcap reports an error and doesn't start the capture.

Pipe names should be either the name of a FIFO (named pipe) or ``-'' to read data from the standard input. Data read from pipes must be in standard libpcap format.

Note: the Win32 version of Dumpcap doesn't support capturing from pipes or stdin!

-L
List the data link types supported by the interface and exit. The reported link types can be used for the -y option.
-p
Don't put the interface into promiscuous mode. Note that the interface might be in promiscuous mode for some other reason; hence, -p cannot be used to ensure that the only traffic that is captured is traffic sent to or from the machine on which Dumpcap is running, broadcast traffic, and multicast traffic to addresses received by that machine.
-s <capture snaplen>
Set the default snapshot length to use when capturing live data. No more than snaplen bytes of each network packet will be read into memory, or saved to disk.
-v
Print the version and exit.
-w <outfile>
Write raw packet data to outfile.

NOTE: The usage of ``-'' for stdout is not allowed here!

-y <capture link type>
Set the data link type to use while capturing packets. The values reported by -L are the values that can be used.
 

CAPTURE FILTER SYNTAX

See the manual page of tcpdump(8).  

SEE ALSO

wireshark(1), tshark(1), editcap(1), mergecap(1), capinfos(1), tcpdump(8), pcap(3)  

NOTES

Dumpcap is part of the Wireshark distribution. The latest version of Wireshark can be found at <http://www.wireshark.org>.

HTML versions of the Wireshark project man pages are available at: <http://www.wireshark.org/docs/man-pages>.  

AUTHORS

Dumpcap is derived from the Wireshark capturing engine code; see the list of authors in the Wireshark man page for a list of authors of that code.


 

Index

NAME
SYNOPSYS
DESCRIPTION
OPTIONS
CAPTURE FILTER SYNTAX
SEE ALSO
NOTES
AUTHORS




Random Man Pages:
getuid
x2x
pgmdeshadow
vhangup