iperf3(1)

1IPERF(1)                         User Manuals                         IPERF(1)
2
3
4

NAME

6       iperf - perform network throughput tests
7

SYNOPSIS

9       iperf -s [ options ]
10
11       iperf -c server [ options ]
12
13
14

DESCRIPTION

16       iperf is a tool for performing network throughput measurements.  It can
17       test either TCP or UDP throughput.  To perform an iperf test  the  user
18       must establish both a server and a client.
19
20
21

GENERAL OPTIONS

23       -p, --port n
24              set server port to listen on/connect to to n (default 5201)
25
26       -f, --format
27              [kmKM]   format to report: Kbits, Mbits, KBytes, MBytes
28
29       -i, --interval n
30              pause n seconds between periodic bandwidth reports
31
32       -m, --print_mss
33              print TCP maximum segment size (MTU - TCP/IP header)
34
35       -h, --help
36              print a help synopsis
37
38       -v, --version
39              print version information and quit
40
41
42

SERVER SPECIFIC OPTIONS

44       -s, --server
45              run in server mode
46
47
48

CLIENT SPECIFIC OPTIONS

50       -c, --client <host>
51              run in client mode, connecting to <host>
52
53       -u, --udp
54              use UDP rather than TCP
55
56       -b, --bandwidth n[KM]
57              set  target  bandwidth  to  n  bits/sec  (default  1  Mbit/sec).
58              Requires UDP mode (-u)
59
60       -t, --time n
61              time in seconds to transmit for (default 10 secs)
62
63       -n, --num n[KM]
64              number of bytes to transmit (instead of -t)
65
66       -l, --len n[KM]
67              set length read/write buffer to n (default 128 KB)
68
69       -P, --parallel n
70              number of parallel client streams to run
71
72       -R, --reverse
73              run in reverse mode (server sends, client receives)
74
75       -w, --window n[KM]
76              TCP window size (socket buffer size)
77
78       -M, --mss n
79              set TCP maximum segment size (MTU - 40 bytes)
80
81       -N, --nodelay
82              set TCP no delay, disabling Nagle's Algorithm
83
84
85

DIAGNOSTICS

87       This section needs to be filled in.
88
89
90

BUGS

92       Exit statuses are  inconsistent.   Could  possibly  block  indefinitely
93       under some circumstances.
94
95
96

AUTHORS

98       Iperf  was  originally  written by Mark Gates and Alex Warshavsky.  Man
99       page and maintence by Jon Dugan <jdugan at x1024 dot net>.  Other  con‐
100       tributions  from  Ajay  Tirumala,  Jim Ferguson, Feng Qin, Kevin Gibbs,
101       John Estabrook <jestabro at ncsa.uiuc.edu>, Andrew  Gallatin  <gallatin
102       at gmail.com>, Stephen Hemminger <shemminger at linux-foundation.org>
103
104
105