Lines Matching +full:ipv6 +full:- +full:single +full:- +full:target
4 iperf3 includes a manual page listing all of the command-line options.
5 The manual page is the most up-to-date reference to the various flags and parameters.
9 https://fasterdata.es.net/performance-testing/network-troubleshooting-tools/iperf/
14 (such as ``splice()``-ing the data to ``/dev/null``). iperf3 does
16 explicitly activated. These flags include the ``-Z`` (``--zerocopy``)
17 and ``-A`` (``--affinity``) options.
20 ------------------
35 iperf3 - perform network throughput tests
38 iperf3 -s [ options ]
39 iperf3 -c server [ options ]
48 An iperf3 server can be started using either of the -s or --server com-
49 mand-line parameters, for example:
51 iperf3 -s
53 iperf3 --server
55 Note that many iperf3 parameters have both short (-s) and long
56 (--server) forms. In this section we will generally use the short form
57 of command-line flags, unless only the long form of a flag is avail-
61 from an iperf3 client. A custom port can be specified by using the -p
64 iperf3 -s -p 5002
68 client mode can be started using the -c command-line option, which also
69 requires a host to which iperf3 should connect. The host can by speci-
70 fied by hostname, IPv4 literal, or IPv6 literal:
72 iperf3 -c iperf3.example.com
74 iperf3 -c 192.0.2.1
76 iperf3 -c 2001:db8::1
78 If the iperf3 server is running on a non-default TCP port, that port
81 iperf3 -c iperf3.example.com -p 5002
87 packets, or as an independent SCTP connection, depending on what proto-
90 Normally, the test data is sent from the client to the server, and mea-
92 from the server can be done by specifying the -R flag on the client.
95 iperf3 -c iperf3.example.com -p 5202 -R
98 least one line of output per measurement interval (by default a mea-
100 -i option). Each line of output includes (at least) the time since the
111 indicated above, use of the -R flag will reverse these roles.
113 The client can be made to retrieve the server-side output for a given
114 test by specifying the --get-server-output flag.
116 Either the client or the server can produce its output in a JSON struc-
117 ture, useful for integration with other programs, by passing it the -J
122 iperf3 has a (overly) large set of command-line options that can be
125 iperf3's help output, which can be viewed by running iperf3 with the -h
129 -p, --port n
132 -f, --format
135 -i, --interval n
139 -F, --file name
148 -A, --affinity n/n,m
155 only be bound to a single CPU (as opposed to a set containing
158 -B, --bind host
160 the host has multiple interfaces, it will use the first inter-
163 -V, --verbose
166 -J, --json
169 --logfile file
172 --forceflush
173 force flushing output at every interval. Used to avoid buffer-
176 -d, --debug
180 -v, --version
183 -h, --help
188 -s, --server
191 -D, --daemon
194 -I, --pidfile file
198 -1, --one-off
201 --rsa-private-key-path file
202 path to the RSA private key (not password-protected) used to
206 --authorized-users-path file
207 path to the configuration file containing authorized users cre-
214 -c, --client host
217 server, unless the -R flag is specified.
219 --sctp use SCTP rather than TCP (FreeBSD and Linux)
221 -u, --udp
224 --connect-timeout n
226 the server, in milliseconds. The default behavior is the oper-
227 ating system's timeout for TCP connection establishment. Pro-
231 -b, --bitrate n[KM]
232 set target bitrate to n bits/sec (default 1 Mbit/sec for UDP,
233 unlimited for TCP/SCTP). If there are multiple streams (-P
238 exceeds the specified throughput limit. Setting the target
242 the --fq-rate flag. This option replaces the --bandwidth flag,
245 --pacing-timer n[KMG]
248 timer for the -b/--bitrate option. The timer fires at the
254 --fq-rate n[KM]
255 Set a rate to be used with fair-queueing based socket-level pac-
257 addition to any pacing due to iperf3's internal throughput pac-
258 ing (-b/--bitrate flag), and both can be specified for the same
259 test. Only available on platforms supporting the SO_MAX_PAC-
261 no fair-queueing based pacing.
263 --no-fq-socket-pacing
265 to specifying --fq-rate=0.
267 -t, --time n
270 -n, --bytes n[KM]
271 number of bytes to transmit (instead of -t)
273 -k, --blockcount n[KM]
274 number of blocks (packets) to transmit (instead of -t or -n)
276 -l, --length n[KM]
283 --cport port
287 -P, --parallel n
289 single threaded, so if you are CPU bound, this will not yield
292 -R, --reverse
296 --bidir
299 -w, --window n[KM]
303 -M, --set-mss n
304 set TCP/SCTP maximum segment size (MTU - 40 bytes)
306 -N, --no-delay
309 -4, --version4
312 -6, --version6
313 only use IPv6
315 -S, --tos n
319 --dscp dscp
322 hex (see --tos above).
324 -L, --flowlabel n
325 set the IPv6 flow label (currently only supported on Linux)
327 -X, --xbind name
329 sctp_bindx(3). The --B flag will be ignored if this flag is
331 all active links on the local host when setting up an associa-
332 tion. Specifying at least one --X name will disable this behav-
335 clients (the latter are supported by passing the first --X argu-
337 resolved using getaddrinfo(3). If the --4 or --6 flags are
341 --nstreams n
344 -Z, --zerocopy
348 -O, --omit n
349 Omit the first n seconds of the test, to skip past the TCP slow-
352 -T, --title str
355 --extra-data str
356 Specify an extra data string field to be included in JSON out-
359 -C, --congestion algo
361 An older --linux-congestion synonym for this flag is accepted
364 --get-server-output
367 --json flag, the output will be in JSON format, otherwise it
368 will be in human-readable format). If the client is run with
369 --json, the server output is included in a JSON object; other-
370 wise it is appended at the bottom of the human-readable output.
372 --repeating-payload
380 --username username
382 with OpenSSL support). The password will be prompted for inter-
388 --rsa-public-key-path file
389 path to the RSA public key used to encrypt authentication cre-
394 Authentication - RSA Keypair
401 > openssl genrsa -des3 -out private.pem 2048
402 > openssl rsa -in private.pem -outform PEM -pubout -out public.pem
403 > openssl rsa -in private.pem -out private_not_protected.pem -out-
406 After these commands, the public key will be contained in the file pub-
407 lic.pem and the private key will be contained in the file pri-
410 Authentication - Authorized users configuration file
413 of comma-separated pairs of a username and a corresponding password
414 hash. The password hash is a SHA256 hash of the string "{$user}$pass-
420 > echo -n "{$S_USER}$S_PASSWD" | sha256sum | awk '{ print $1 }'
431 A list of the contributors to iperf3 can be found within the documenta-