tcpreplay/src/tcpreplay.1

.de1 NOP
.  it 1 an-trap
.  if \\n[.$] \,\\$*\/
..
.ie t \
.ds B-Font [CB]
.ds I-Font [CI]
.ds R-Font [CR]
.el \
.ds B-Font B
.ds I-Font I
.ds R-Font R
.TH tcpreplay 1 "12 Jul 2024" "tcpreplay" "User Commands"
.\"
.\" DO NOT EDIT THIS FILE (in-mem file)
.\"
.\" It has been AutoGen-ed
.\" From the definitions ../../src/tcpreplay_opts.def
.\" and the template file agman-cmd.tpl
.SH NAME
\f\*[B-Font]tcpreplay\fP
\- Replay network traffic stored in pcap files
.SH SYNOPSIS
\f\*[B-Font]tcpreplay\fP
.\" Mixture of short (flag) options and long options
[\f\*[B-Font]\-flags\f[]]
[\f\*[B-Font]\-flag\f[] [\f\*[I-Font]value\f[]]]
[\f\*[B-Font]\-\-option-name\f[][[=| ]\f\*[I-Font]value\f[]]]
<pcap_file(s)> | <pcap_dir(s)>
.sp \n(Ppu
.ne 2

tcpreplay is a tool for replaying network traffic from files saved with
tcpdump or other tools which write pcap(3) files.
.SH "DESCRIPTION"
The basic operation of tcpreplay is to resend  all  packets  from  the
input file(s) at the speed at which they were recorded, or a specified 
data rate, up to as fast as the hardware is capable.
.sp
Optionally, the traffic can be split between two interfaces, written to
files, filtered and edited in various ways, providing the means to test
firewalls, NIDS and other network devices.
.sp
For more details, please see the Tcpreplay Manual at:
http://tcpreplay.appneta.com
.SH "OPTIONS"
.TP
.NOP \f\*[B-Font]\-d\f[] \f\*[I-Font]number\f[], \f\*[B-Font]\-\-dbug\f[]=\f\*[I-Font]number\f[]
Enable debugging output.
This option may appear up to 1 times.
This option takes an integer number as its argument.
The value of
\f\*[I-Font]number\f[]
is constrained to being:
.in +4
.nf
.na
in the range  0 through 5
.fi
.in -4
The default
\f\*[I-Font]number\f[]
for this option is:
.ti +4
 0
.sp
If configured with \--enable-debug, then you can specify a verbosity 
level for debugging output.  Higher numbers increase verbosity.
.TP
.NOP \f\*[B-Font]\-q\f[], \f\*[B-Font]\-\-quiet\f[]
Quiet mode.
.sp
Print nothing except the statistics at the end of the run
.TP
.NOP \f\*[B-Font]\-T\f[] \f\*[I-Font]string\f[], \f\*[B-Font]\-\-timer\f[]=\f\*[I-Font]string\f[]
Select packet timing mode: select, ioport, gtod, nano.
This option may appear up to 1 times.
The default
\f\*[I-Font]string\f[]
for this option is:
.ti +4
 gtod
.sp
Allows you to select the packet timing method to use:
.sp
.IR "nano"
- Use nanosleep() API
.sp
.IR "select"
- Use select() API
.sp
.IR "ioport"
- Write to the i386 IO Port 0x80
.sp
.IR "gtod [default]"
- Use a gettimeofday() loop
.br
.TP
.NOP \f\*[B-Font]\-\-maxsleep\f[]=\f\*[I-Font]number\f[]
Sleep for no more then X milliseconds between packets.
This option takes an integer number as its argument.
The default
\f\*[I-Font]number\f[]
for this option is:
.ti +4
 0
.sp
Set a limit for the maximum number of milliseconds that tcpreplay will sleep
between packets.  Effectively prevents long delays between packets without
effecting the majority of packets.  Default is disabled.
.TP
.NOP \f\*[B-Font]\-v\f[], \f\*[B-Font]\-\-verbose\f[]
Print decoded packets via tcpdump to STDOUT.
This option may appear up to 1 times.
.sp
.TP
.NOP \f\*[B-Font]\-A\f[] \f\*[I-Font]string\f[], \f\*[B-Font]\-\-decode\f[]=\f\*[I-Font]string\f[]
Arguments passed to tcpdump decoder.
This option may appear up to 1 times.
This option must appear in combination with the following options:
verbose.
.sp
When enabling verbose mode (\fB-v\fP) you may also specify one or more
additional  arguments to pass to \fBtcpdump\fP to modify the way packets
are decoded.  By default, \-n and \-l are used.   Be  sure  to
quote the arguments like: \-A "-axxx" so that they are not interpreted
by tcpreplay.   Please see the tcpdump(1) man page for a complete list of 
options.
.TP
.NOP \f\*[B-Font]\-K\f[], \f\*[B-Font]\-\-preload\-pcap\f[]
Preloads packets into RAM before sending.
.sp
This option loads the specified pcap(s) into RAM before starting to send in order
to improve replay performance while introducing a startup performance hit.
Preloading can be used with or without \fB--loop\fP. This option also suppresses
flow statistics collection for every iteration, which can significantly reduce
memory usage. Flow statistics are predicted based on options supplied and
statistics collected from the first loop iteration.
.TP
.NOP \f\*[B-Font]\-c\f[] \f\*[I-Font]string\f[], \f\*[B-Font]\-\-cachefile\f[]=\f\*[I-Font]string\f[]
Split traffic via a tcpprep cache file.
This option may appear up to 1 times.
This option must appear in combination with the following options:
intf2.
This option must not appear in combination with any of the following options:
dualfile.
.sp
If you have a pcap file you would like to use to send bi-directional
traffic through a device (firewall, router, IDS, etc) then using tcpprep
you can create a cachefile which tcpreplay will use to split the traffic
across two network interfaces.
.TP
.NOP \f\*[B-Font]\-2\f[], \f\*[B-Font]\-\-dualfile\f[]
Replay two files at a time from a network tap.
This option may appear up to 1 times.
This option must appear in combination with the following options:
intf2.
This option must not appear in combination with any of the following options:
cachefile.
.sp
If you captured network traffic using a network tap, then you can end up with
two pcap files- one for each direction.  This option will replay these two
files at the same time, one on each interface and inter-mix them using the 
timestamps in each.
.TP
.NOP \f\*[B-Font]\-i\f[] \f\*[I-Font]string\f[], \f\*[B-Font]\-\-intf1\f[]=\f\*[I-Font]string\f[]
Client to server/RX/primary traffic output interface.
This option may appear up to 1 times.
This option is a member of the intf1 class of options.
.sp
Required network interface used to send either all traffic or traffic which is 
marked as 'primary' via tcpprep.  Primary traffic is usually client-to-server 
or inbound (RX) on khial virtual interfaces.
.TP
.NOP \f\*[B-Font]\-I\f[] \f\*[I-Font]string\f[], \f\*[B-Font]\-\-intf2\f[]=\f\*[I-Font]string\f[]
Server to client/TX/secondary traffic output interface.
This option may appear up to 1 times.
.sp
Optional network interface used to send traffic which is marked as 'secondary' 
via tcpprep.  Secondary traffic is usually server-to-client or outbound 
(TX) on khial virtual interfaces.  Generally, it only makes sense to use this
option with \--cachefile.
.TP
.NOP \f\*[B-Font]\-w\f[] \f\*[I-Font]string\f[], \f\*[B-Font]\-\-write\f[]=\f\*[I-Font]string\f[]
Pcap file to receive traffic outputs.
This option may appear up to 1 times.
This option is a member of the intf1 class of options.
This option must not appear in combination with any of the following options:
intf2.
.sp
Optional pcap file name used to receive traffic.
.TP
.NOP \f\*[B-Font]\-\-include\f[]=\f\*[I-Font]string\f[]
Send only selected packet numbers.
This option may appear up to 1 times.
This option must not appear in combination with any of the following options:
exclude.
.sp
Override default of processing all packets stored in the capture file and only
send packets that are part of a supplied list of packet numbers.
.sp
.nf
    \-x P:1-5,9,15,72-
.fi
would skip packets 1 through 5, the 9th and 15th packet, and packets 72 until the
end of the file
.TP
.NOP \f\*[B-Font]\-\-exclude\f[]=\f\*[I-Font]string\f[]
Send all but selected packet numbers.
This option may appear up to 1 times.
This option must not appear in combination with any of the following options:
include.
.sp
Override default of processing all packets stored in the capture file and only
send packets that are NOT part of a supplied list of packet numbers.
.sp
.nf
    \-x P:1-5,9,15,72-
.fi
would skip packets 1 through 5, the 9th and 15th packet, and packets 72 until the
end of the file
.TP
.NOP \f\*[B-Font]\-\-listnics\f[]
List available network interfaces and exit.
.sp
.TP
.NOP \f\*[B-Font]\-l\f[] \f\*[I-Font]number\f[], \f\*[B-Font]\-\-loop\f[]=\f\*[I-Font]number\f[]
Loop through the capture file X times.
This option may appear up to 1 times.
This option takes an integer number as its argument.
The value of
\f\*[I-Font]number\f[]
is constrained to being:
.in +4
.nf
.na
greater than or equal to 0
.fi
.in -4
The default
\f\*[I-Font]number\f[]
for this option is:
.ti +4
 1
.sp
.TP
.NOP \f\*[B-Font]\-\-loopdelay\-ms\f[]=\f\*[I-Font]number\f[]
Delay between loops in milliseconds.
This option must appear in combination with the following options:
loop.
This option must not appear in combination with any of the following options:
loopdelay-ns.
This option takes an integer number as its argument.
The value of
\f\*[I-Font]number\f[]
is constrained to being:
.in +4
.nf
.na
greater than or equal to 0
.fi
.in -4
The default
\f\*[I-Font]number\f[]
for this option is:
.ti +4
 0
.sp
.TP
.NOP \f\*[B-Font]\-\-loopdelay\-ns\f[]=\f\*[I-Font]number\f[]
Delay between loops in nanoseconds.
This option must appear in combination with the following options:
loop.
This option must not appear in combination with any of the following options:
loopdelay-ms.
This option takes an integer number as its argument.
The value of
\f\*[I-Font]number\f[]
is constrained to being:
.in +4
.nf
.na
greater than or equal to 0
.fi
.in -4
The default
\f\*[I-Font]number\f[]
for this option is:
.ti +4
 0
.sp
By default, tcpreplay will use loop delay with microsecond accuracy (loopdelay-ms).
In order to use loop delay with nanosecond accuracy you need to use nano packet timing mode.
.TP
.NOP \f\*[B-Font]\-\-pktlen\f[]
Override the snaplen and use the actual packet len.
This option may appear up to 1 times.
.sp
By default, tcpreplay will send packets based on the size of the "snaplen"
stored in the pcap file which is usually the correct thing to do.  However,
occasionally, tools will store more bytes then told to.  By specifying this
option, tcpreplay will ignore the snaplen field and instead try to send
packets based on the original packet length.  Bad things may happen if
you specify this option.
.TP
.NOP \f\*[B-Font]\-L\f[] \f\*[I-Font]number\f[], \f\*[B-Font]\-\-limit\f[]=\f\*[I-Font]number\f[]
Limit the number of packets to send.
This option may appear up to 1 times.
This option takes an integer number as its argument.
The value of
\f\*[I-Font]number\f[]
is constrained to being:
.in +4
.nf
.na
greater than or equal to 1
.fi
.in -4
The default
\f\*[I-Font]number\f[]
for this option is:
.ti +4
 \-1
.sp
By default, tcpreplay will send all the packets.  Alternatively, you can 
specify a maximum number of packets to send.  
.TP
.NOP \f\*[B-Font]\-\-duration\f[]=\f\*[I-Font]number\f[]
Limit the number of seconds to send.
This option may appear up to 1 times.
This option takes an integer number as its argument.
The value of
\f\*[I-Font]number\f[]
is constrained to being:
.in +4
.nf
.na
greater than or equal to 1
.fi
.in -4
The default
\f\*[I-Font]number\f[]
for this option is:
.ti +4
 \-1
.sp
By default, tcpreplay will send all the packets.  Alternatively, you can
specify a maximum number of seconds to transmit.
.TP
.NOP \f\*[B-Font]\-x\f[] \f\*[I-Font]string\f[], \f\*[B-Font]\-\-multiplier\f[]=\f\*[I-Font]string\f[]
Modify replay speed to a given multiple.
This option may appear up to 1 times.
This option must not appear in combination with any of the following options:
pps, mbps, oneatatime, topspeed.
.sp
Specify a value to modify the packet replay speed.
Examples:
.nf
        2.0 will replay traffic at twice the speed captured
        0.7 will replay traffic at 70% the speed captured
.fi
.TP
.NOP \f\*[B-Font]\-p\f[] \f\*[I-Font]string\f[], \f\*[B-Font]\-\-pps\f[]=\f\*[I-Font]string\f[]
Replay packets at a given packets/sec.
This option may appear up to 1 times.
This option must not appear in combination with any of the following options:
multiplier, mbps, oneatatime, topspeed.
.sp
Specify a value to regulate the packet replay to a specific packet-per-second rate.
Examples:
.nf
        200 will replay traffic at 200 packets per second
        0.25 will replay traffic at 15 packets per minute
.fi
.TP
.NOP \f\*[B-Font]\-M\f[] \f\*[I-Font]string\f[], \f\*[B-Font]\-\-mbps\f[]=\f\*[I-Font]string\f[]
Replay packets at a given Mbps.
This option may appear up to 1 times.
This option must not appear in combination with any of the following options:
multiplier, pps, oneatatime, topspeed.
.sp
Specify a floating point value for the Mbps rate that tcpreplay
should send packets at.
.TP
.NOP \f\*[B-Font]\-t\f[], \f\*[B-Font]\-\-topspeed\f[]
Replay packets as fast as possible.
This option must not appear in combination with any of the following options:
mbps, multiplier, pps, oneatatime.
.sp
.TP
.NOP \f\*[B-Font]\-o\f[], \f\*[B-Font]\-\-oneatatime\f[]
Replay one packet at a time for each user input.
This option must not appear in combination with any of the following options:
mbps, pps, multiplier, topspeed.
.sp
Allows you to step through one or more packets at a time.
.TP
.NOP \f\*[B-Font]\-\-pps\-multi\f[]=\f\*[I-Font]number\f[]
Number of packets to send for each time interval.
This option must appear in combination with the following options:
pps.
This option takes an integer number as its argument.
The value of
\f\*[I-Font]number\f[]
is constrained to being:
.in +4
.nf
.na
greater than or equal to 1
.fi
.in -4
The default
\f\*[I-Font]number\f[]
for this option is:
.ti +4
 1
.sp
When trying to send packets at very high rates, the time between each packet
can be so short that it is impossible to accurately sleep for the required
period of time.  This option allows you to send multiple packets at a time,
thus allowing for longer sleep times which can be more accurately implemented.
.TP
.NOP \f\*[B-Font]\-\-unique\-ip\f[]
Modify IP addresses each loop iteration to generate unique flows.
This option must appear in combination with the following options:
loop.
.sp
Ensure IPv4 and IPv6 packets will be unique for each \fB--loop\fP iteration. 
This is done in a way that will not alter packet CRC, and therefore will generally
not affect performance. This option will significantly increase the flows/sec over
generated over multiple loop iterations.
.TP
.NOP \f\*[B-Font]\-\-unique\-ip\-loops\f[]=\f\*[I-Font]string\f[]
Number of times to loop before assigning new unique ip.
This option may appear up to 1 times.
This option must appear in combination with the following options:
unique-ip.
.sp
Number of \fB--loop\fP iterations before a new unique IP is assigned. Default
is 1. Assumes both \fB--loop\fP and \fB--unique-ip\fP.
.TP
.NOP \f\*[B-Font]\-\-netmap\f[]
Write packets directly to netmap enabled network adapter.
.sp
This feature will detect netmap capable network drivers on Linux and BSD
systems. If detected, the network driver is bypassed for the execution
duration, and network buffers will be written to directly. This will allow
you to achieve full line rates on commodity network adapters, similar to rates
achieved by commercial network traffic generators. Note that bypassing the network
driver will disrupt other applications connected through the test interface. See
INSTALL for more information.
.sp
This feature can also be enabled by specifying an interface as 'netmap:<intf>'
or 'vale:<intf>. For example 'netmap:eth0' specifies netmap over interface eth0.
.TP
.NOP \f\*[B-Font]\-\-nm\-delay\f[]=\f\*[I-Font]number\f[]
Netmap startup delay.
This option takes an integer number as its argument.
The default
\f\*[I-Font]number\f[]
for this option is:
.ti +4
 10
.sp
Number of seconds to delay after netmap is loaded. Required to ensure interfaces
are fully up before netmap transmit. Requires netmap option. Default is 10 seconds.
.TP
.NOP \f\*[B-Font]\-\-no\-flow\-stats\f[]
Suppress printing and tracking flow count, rates and expirations.
.sp
Suppress the collection and printing of flow statistics. This option may
improve performance when not using \fB--preload-pcap\fP option, otherwise
its only function is to suppress printing. 
.sp
The flow feature will track and print statistics of the flows being sent. 
A flow is loosely defined as a unique combination of a 5-tuple, i.e. 
source IP, destination IP, source port, destination port and protocol.
.sp
If \fB--loop\fP is specified, the flows from one iteration to the next
will not be unique, unless the packets are altered. Use \fB--unique-ip\fP
or \fBtcpreplay-edit\fP to alter packets between iterations. 
.TP
.NOP \f\*[B-Font]\-\-flow\-expiry\f[]=\f\*[I-Font]number\f[]
Number of inactive seconds before a flow is considered expired.
This option must not appear in combination with any of the following options:
no-flow-stats.
This option takes an integer number as its argument.
The value of
\f\*[I-Font]number\f[]
is constrained to being:
.in +4
.nf
.na
greater than or equal to 0
.fi
.in -4
The default
\f\*[I-Font]number\f[]
for this option is:
.ti +4
 0
.sp
This option will track and report flow expirations based on the flow idle
times. The timestamps within the pcap file are used to determine the expiry,
not the actual timestamp of the packets are replayed. For example, a value of
30 suggests that if no traffic is seen on a flow for 30 seconds, any
subsequent traffic would be considered a new flow, and thereby will increment
the flows and flows per second (fps) statistics. 
.sp
This option can be used to optimize flow timeout settings for flow products.
Setting the timeout low may lead to flows being dropped when in fact the flow
is simply slow to respond. Configuring your flow timeouts too high may
increase resources required by your flow product.
.sp
Note that using this option while replaying at higher than original speeds
can lead to inflated flows and fps counts.
.sp
Default is 0 (no expiry) and a typical value is 30-120 seconds.
.TP
.NOP \f\*[B-Font]\-P\f[], \f\*[B-Font]\-\-pid\f[]
Print the PID of tcpreplay at startup.
.sp
.TP
.NOP \f\*[B-Font]\-\-stats\f[]=\f\*[I-Font]number\f[]
Print statistics every X seconds, or every loop if '0'.
This option takes an integer number as its argument.
The value of
\f\*[I-Font]number\f[]
is constrained to being:
.in +4
.nf
.na
greater than or equal to 0
.fi
.in -4
.sp
Note that timed delays are a "best effort" and long delays between
sending packets may cause equally long delays between printing statistics.
.TP
.NOP \f\*[B-Font]\-W\f[], \f\*[B-Font]\-\-suppress\-warnings\f[]
suppress printing warning messages.
.sp
.TP
.NOP \f\*[B-Font]\-\-xdp\f[]
Write packets directly to AF_XDP enabled network adapter.
.sp
This feature will detect AF_XDP capable network drivers on Linux systems
that have 'libxdp-dev' and 'libbpf-dev' installed. If detected, the network
stack is bypassed and packets are sent directly to an eBPF enabled driver directly.
This will allow you to achieve full line rates on commodity network adapters, similar to rates
achieved by commercial network traffic generators.
.TP
.NOP \f\*[B-Font]\-\-xdp\-batch\-size\f[]=\f\*[I-Font]number\f[]
The maximum number of packets that can be submitted to the AF_XDP TX ring at once.
This option takes an integer number as its argument.
The value of
\f\*[I-Font]number\f[]
is constrained to being:
.in +4
.nf
.na
in the range  1 through 4096
.fi
.in -4
The default
\f\*[I-Font]number\f[]
for this option is:
.ti +4
 25
.sp
Higher values may improve performance at the cost of accuracy
.TP
.NOP \f\*[B-Font]\-V\f[], \f\*[B-Font]\-\-version\f[]
Print version information.
.sp
.TP
.NOP \f\*[B-Font]\-h\f[], \f\*[B-Font]\-\-less\-help\f[]
Display less usage information and exit.
.sp
.TP
.NOP \f\*[B-Font]\-H\f[], \f\*[B-Font]\-\-help\f[]
Display usage information and exit.
.TP
.NOP \f\*[B-Font]\-\&!\f[], \f\*[B-Font]\-\-more-help\f[]
Pass the extended usage information through a pager.
.TP
.NOP \f\*[B-Font]\-\-save-opts\f[] [=\f\*[I-Font]cfgfile\f[]]
Save the option state to \fIcfgfile\fP.  The default is the \fIlast\fP
configuration file listed in the \fBOPTION PRESETS\fP section, below.
The command will exit after updating the config file.
.TP
.NOP \f\*[B-Font]\-\-load-opts\f[]=\f\*[I-Font]cfgfile\f[], \f\*[B-Font]\-\-no-load-opts\f[]
Load options from \fIcfgfile\fP.
The \fIno-load-opts\fP form will disable the loading
of earlier config/rc/ini files.  \fI\-\-no-load-opts\fP is handled early,
out of order.
.PP
.SH "OPTION PRESETS"
Any option that is not marked as \fInot presettable\fP may be preset
by loading values from configuration ("RC" or ".INI") file(s).
The \fIhomerc\fP file is "\fI$$/\fP", unless that is a directory.
In that case, the file "\fI.tcpreplayrc\fP"
is searched for within that directory.
.SH "FILES"
See \fBOPTION PRESETS\fP for configuration files.
.SH "EXIT STATUS"
One of the following exit values will be returned:
.TP
.NOP 0 " (EXIT_SUCCESS)"
Successful program execution.
.TP
.NOP 1 " (EXIT_FAILURE)"
The operation failed or the command syntax was not valid.
.TP
.NOP 66 " (EX_NOINPUT)"
A specified configuration file could not be loaded.
.TP
.NOP 70 " (EX_SOFTWARE)"
libopts had an internal operational error.  Please report
it to autogen-users@lists.sourceforge.net.  Thank you.
.PP
.SH "AUTHORS"
Copyright 2013-2024 Fred Klassen \- AppNeta
Copyright 2000-2012 Aaron Turner
For support please use the tcpreplay-users@lists.sourceforge.net mailing list.
The latest version of this software is always available from:
http://tcpreplay.appneta.com/
.SH "COPYRIGHT"
Copyright (C) 2000-2024 Aaron Turner and Fred Klassen all rights reserved.
This program is released under the terms of the GNU General Public License, version 3 or later.
.SH "BUGS"
Please send bug reports to: tcpreplay-users@lists.sourceforge.net
.SH "NOTES"
This manual page was \fIAutoGen\fP-erated from the \fBtcpreplay\fP
option definitions.