Skip to main content
Viptela is now part of Cisco.
Product Documentation
Viptela Documentation

tools iperf

tools iperf—Run tests to display various parameters related to timing, buffers, and the TCP and UDP protocols for IPv4 and IPv6 (on vEdge routers only). This command is similar to the standard iperf command.

Command Syntax

tools iperf [options options] [vpn vpn-id]
tools iperf help


Command Help
Display all the command options.
Command Options
options options
See the Example Output below for a list of all the tool iperf command options.
Specific VPN
vpn vpn-id
Run the command in a specific VPN.
Default: VPN 0

Output Fields

The output is self explanatory.

Example Output

Viptela# tools iperf help
   help                     Show usage
   vpn                      VPN or namespace
   options                  iperf options

iperf --help in VPN 0
Usage: iperf [-s|-c host] [options]
       iperf [-h|--help] [-v|--version]

  -f, --format    [kmKM]   format to report: Kbits, Mbits, KBytes, MBytes
  -i, --interval  #        seconds between periodic bandwidth reports
  -l, --len       #[KM]    length of buffer to read or write (default 8 KB)
  -m, --print_mss          print TCP maximum segment size (MTU - TCP/IP header)
  -o, --output    <filename> output the report or error message to this specified file
  -p, --port      #        server port to listen on/connect to
  -u, --udp                use UDP rather than TCP
  -w, --window    #[KM]    TCP window size (socket buffer size)
  -B, --bind      <host>   bind to <host>, an interface or multicast address
  -C, --compatibility      for use with older versions does not sent extra msgs
  -M, --mss       #        set TCP maximum segment size (MTU - 40 bytes)
  -N, --nodelay            set TCP no delay, disabling Nagle's Algorithm
  -V, --IPv6Version        Set the domain to IPv6

Server specific:
  -s, --server             run in server mode
  -U, --single_udp         run in single threaded UDP mode
  -D, --daemon             run the server as a daemon

Client specific:
  -b, --bandwidth #[KM]    for UDP, bandwidth to send at in bits/sec
                           (default 1 Mbit/sec, implies -u)
  -c, --client    <host>   run in client mode, connecting to <host>
  -d, --dualtest           Do a bidirectional test simultaneously
  -n, --num       #[KM]    number of bytes to transmit (instead of -t)
  -r, --tradeoff           Do a bidirectional test individually
  -t, --time      #        time in seconds to transmit for (default 10 secs)
  -F, --fileinput <name>   input the data to be transmitted from a file
  -I, --stdin              input the data to be transmitted from stdin
  -L, --listenport #       port to receive bidirectional tests back on
  -P, --parallel  #        number of parallel client threads to run
  -T, --ttl       #        time-to-live, for multicast (default 1)
  -Z, --linux-congestion <algo>  set TCP congestion control algorithm (Linux only)

  -x, --reportexclude [CDMSV]   exclude C(connection) D(data) M(multicast) S(settings) V(server) reports
  -y, --reportstyle C      report as a Comma-Separated Values
  -h, --help               print this message and quit
  -v, --version            print version information and quit

[KM] Indicates options that support a K or M suffix for kilo- or mega-

The TCP window size option can be set by the environment variable
TCP_WINDOW_SIZE. Most other options can be set by an environment variable
IPERF_<long option name>, such as IPERF_BANDWIDTH.

Report bugs to <>

Determine the data transfer rate and bandwidth available between two vEdge routers. Set up the client side:

Client-vEdge# tools iperf vpn 0 options -s
option_list, -s
arg list, -s
iperf -s in VPN 0
Server listening on TCP port 5001
TCP window size: 85.3 KByte (default)

Start the test on the server side:

Server-vEdge# tools iperf vpn 0 options "-c"
option_list, -c
arg list, -c
iperf -c in VPN 0
Client connecting to, TCP port 5001
TCP window size: 22.1 KByte (default)

View the output on the server vEdge router:

[  4] local port 54421 connected with port 5001

[ ID] Interval       Transfer     Bandwidth
[  4]  0.0-10.0 sec   239 MBytes   200 Mbits/sec

View the output and terminate the test on the client vEdge router:

[  5] local port 5001 connected with port 54421
[ ID] Interval       Transfer     Bandwidth
[  5]  0.0-10.1 sec   239 MBytes   200 Mbits/sec


Release Information

Command introduced in Viptela Software Release 17.1.

  • Was this article helpful?