tcpreplay(1)

NAME
*[B-Font]tcpreplay - Replay network traffic stored in pcap files

SYNOPSIS
*[B-Font]tcpreplay [*[B-Font]-flags] [*[B-Font]-flag [*[I-Font]value]] [*[B-Font]--option-name[[=| ]*[I-Font]value]] <pcap_file(s)> | <pcap_dir(s)>

tcpreplay is a tool for replaying network traffic from files saved with tcpdump or other tools which write pcap(3) files.

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.

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.

For more details, please see the Tcpreplay Manual at: http://tcpreplay.appneta.com

OPTIONS

Enable debugging output.
    This option may appear up to 1 times. This option takes an integer number as its argument. The value of *[I-Font]number is constrained to being:
    in the range  0 through 5
    The default *[I-Font]number for this option is:
     0

    If configured with --enable-debug, then you can specify a verbosity level for debugging output. Higher numbers increase verbosity.

Quiet mode.

    Print nothing except the statistics at the end of the run

Select packet timing mode: select, ioport, gtod, nano.
    This option may appear up to 1 times. The default *[I-Font]string for this option is:
     gtod

    Allows you to select the packet timing method to use:

    nano - Use nanosleep() API

    select - Use select() API

    ioport - Write to the i386 IO Port 0x80

    gtod [default] - Use a gettimeofday() loop

Sleep for no more then X milliseconds between packets.
    This option takes an integer number as its argument. The default *[I-Font]number for this option is:
     0

    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.

Print decoded packets via tcpdump to STDOUT.
    This option may appear up to 1 times.

Arguments passed to tcpdump decoder.
    This option may appear up to 1 times. This option must appear in combination with the following options: verbose.

    When enabling verbose mode (-v) you may also specify one or more additional arguments to pass to tcpdump 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.

Preloads packets into RAM before sending.

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

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.

    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.

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.

    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.

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.

    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.

Server to client/TX/secondary traffic output interface.
    This option may appear up to 1 times.

    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.

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.

    Optional pcap file name used to receive traffic.

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.

    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.

        -x P:1-5,9,15,72-
    would skip packets 1 through 5, the 9th and 15th packet, and packets 72 until the end of the file

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.

    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.

        -x P:1-5,9,15,72-
    would skip packets 1 through 5, the 9th and 15th packet, and packets 72 until the end of the file

List available network interfaces and exit.

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 *[I-Font]number is constrained to being:
    greater than or equal to 0
    The default *[I-Font]number for this option is:
     1

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 *[I-Font]number is constrained to being:
    greater than or equal to 0
    The default *[I-Font]number for this option is:
     0

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 *[I-Font]number is constrained to being:
    greater than or equal to 0
    The default *[I-Font]number for this option is:
     0

    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.

Override the snaplen and use the actual packet len.
    This option may appear up to 1 times.

    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.

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 *[I-Font]number is constrained to being:
    greater than or equal to 1
    The default *[I-Font]number for this option is:
     -1

    By default, tcpreplay will send all the packets. Alternatively, you can specify a maximum number of packets to send.

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 *[I-Font]number is constrained to being:
    greater than or equal to 1
    The default *[I-Font]number for this option is:
     -1

    By default, tcpreplay will send all the packets. Alternatively, you can specify a maximum number of seconds to transmit.

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.

    Specify a value to modify the packet replay speed. Examples:
            2.0 will replay traffic at twice the speed captured
            0.7 will replay traffic at 70% the speed captured

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.

    Specify a value to regulate the packet replay to a specific packet-per-second rate. Examples:
            200 will replay traffic at 200 packets per second
            0.25 will replay traffic at 15 packets per minute

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.

    Specify a floating point value for the Mbps rate that tcpreplay should send packets at.

Replay packets as fast as possible.
    This option must not appear in combination with any of the following options: mbps, multiplier, pps, oneatatime.

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.

    Allows you to step through one or more packets at a time.

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 *[I-Font]number is constrained to being:
    greater than or equal to 1
    The default *[I-Font]number for this option is:
     1

    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.

Modify IP addresses each loop iteration to generate unique flows.
    This option must appear in combination with the following options: loop.

    Ensure IPv4 and IPv6 packets will be unique for each --loop 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.

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.

    Number of --loop iterations before a new unique IP is assigned. Default is 1. Assumes both --loop and --unique-ip.

Write packets directly to netmap enabled network adapter.

    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.

    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.

Netmap startup delay.
    This option takes an integer number as its argument. The default *[I-Font]number for this option is:
     10

    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.

Suppress printing and tracking flow count, rates and expirations.

    Suppress the collection and printing of flow statistics. This option may improve performance when not using --preload-pcap option, otherwise its only function is to suppress printing.

    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.

    If --loop is specified, the flows from one iteration to the next will not be unique, unless the packets are altered. Use --unique-ip or tcpreplay-edit to alter packets between iterations.

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 *[I-Font]number is constrained to being:
    greater than or equal to 0
    The default *[I-Font]number for this option is:
     0

    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.

    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.

    Note that using this option while replaying at higher than original speeds can lead to inflated flows and fps counts.

    Default is 0 (no expiry) and a typical value is 30-120 seconds.

Print the PID of tcpreplay at startup.

Print statistics every X seconds, or every loop if '0'.
    This option takes an integer number as its argument. The value of *[I-Font]number is constrained to being:
    greater than or equal to 0

    Note that timed delays are a "best effort" and long delays between sending packets may cause equally long delays between printing statistics.

suppress printing warning messages.

Write packets directly to AF_XDP enabled network adapter.

    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.

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 *[I-Font]number is constrained to being:
    in the range  1 through 4096
    The default *[I-Font]number for this option is:
     25

    Higher values may improve performance at the cost of accuracy

Print version information.

Display less usage information and exit.

Display usage information and exit.

Pass the extended usage information through a pager.

Save the option state to cfgfile.  The default is the last
    configuration file listed in the OPTION PRESETS section, below. The command will exit after updating the config file.

Load options from cfgfile.
    The no-load-opts form will disable the loading of earlier config/rc/ini files. --no-load-opts is handled early, out of order.

OPTION PRESETS
Any option that is not marked as not presettable may be preset by loading values from configuration ("RC" or ".INI") file(s). The homerc file is "$$/", unless that is a directory. In that case, the file ".tcpreplayrc" is searched for within that directory.

FILES
See OPTION PRESETS for configuration files.

EXIT STATUS
One of the following exit values will be returned:

Successful program execution.

The operation failed or the command syntax was not valid.

A specified configuration file could not be loaded.

libopts had an internal operational error.  Please report
    it to autogen-users@lists.sourceforge.net. Thank you.

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/

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.

BUGS
Please send bug reports to: tcpreplay-users@lists.sourceforge.net

NOTES
This manual page was AutoGen-erated from the tcpreplay option definitions.