diff options
Diffstat (limited to 'src/iperf3.1')
| -rw-r--r-- | src/iperf3.1 | 25 |
1 files changed, 17 insertions, 8 deletions
diff --git a/src/iperf3.1 b/src/iperf3.1 index 93fe7b9..aad6997 100644 --- a/src/iperf3.1 +++ b/src/iperf3.1 @@ -1,4 +1,4 @@ -.TH IPERF3 1 "June 2019" ESnet "User Manuals" +.TH IPERF3 1 "July 2020" ESnet "User Manuals" .SH NAME iperf3 \- perform network throughput tests .SH SYNOPSIS @@ -177,6 +177,15 @@ write a file with the process ID, most useful when running as a daemon. .BR -1 ", " --one-off handle one client connection, then exit. .TP +.BR --server-bitrate-limit " \fIn\fR[KMGT]" +set a limit on the server side, which will cause a test to abort if +the client specifies a test of more than \fIn\fR bits per second, or +if the average data sent or received by the client (including all data +streams) is greater than \fIn\fR bits per second. The default limit +is zero, which implies no limit. The interval over which to average +the data rate is 5 seconds by default, but can be specified by adding +a '/' and a number to the bitrate specifier. +.TP .BR --rsa-private-key-path " \fIfile\fR" path to the RSA private key (not password-protected) used to decrypt authentication credentials from the client (if built with OpenSSL @@ -209,7 +218,7 @@ connection establishment. Providing a shorter value may speed up detection of a down iperf3 server. .TP -.BR -b ", " --bitrate " \fIn\fR[KM]" +.BR -b ", " --bitrate " \fIn\fR[KMGT]" set target bitrate to \fIn\fR bits/sec (default 1 Mbit/sec for UDP, unlimited for TCP/SCTP). If there are multiple streams (\-P flag), the throughput limit is applied @@ -226,7 +235,7 @@ Compare with the \--fq-rate flag. This option replaces the \--bandwidth flag, which is now deprecated but (at least for now) still accepted. .TP -.BR --pacing-timer " \fIn\fR[KMG]" +.BR --pacing-timer " \fIn\fR[KMGT]" set pacing timer interval in microseconds (default 1000 microseconds, or 1 ms). This controls iperf3's internal pacing timer for the \-b/\--bitrate @@ -236,7 +245,7 @@ Smaller values of the pacing timer parameter smooth out the traffic emitted by iperf3, but potentially at the cost of performance due to more frequent timer processing. .TP -.BR --fq-rate " \fIn\fR[KM]" +.BR --fq-rate " \fIn\fR[KMGT]" Set a rate to be used with fair-queueing based socket-level pacing, in bits per second. This pacing (if specified) will be in addition to any pacing due to @@ -253,13 +262,13 @@ It is equivalent to specifying --fq-rate=0. .BR -t ", " --time " \fIn\fR" time in seconds to transmit for (default 10 secs) .TP -.BR -n ", " --bytes " \fIn\fR[KM]" +.BR -n ", " --bytes " \fIn\fR[KMGT]" number of bytes to transmit (instead of \-t) .TP -.BR -k ", " --blockcount " \fIn\fR[KM]" +.BR -k ", " --blockcount " \fIn\fR[KMGT]" number of blocks (packets) to transmit (instead of \-t or \-n) .TP -.BR -l ", " --length " \fIn\fR[KM]" +.BR -l ", " --length " \fIn\fR[KMGT]" length of buffer to read or write. For TCP tests, the default value is 128KB. In the case of UDP, iperf3 tries to dynamically determine a reasonable @@ -282,7 +291,7 @@ client test in both directions (normal and reverse), with both the client and server sending and receiving data simultaneously .TP -.BR -w ", " --window " \fIn\fR[KM]" +.BR -w ", " --window " \fIn\fR[KMGT]" window size / socket buffer size (this gets sent to the server and used on that side too) .TP .BR -M ", " --set-mss " \fIn\fR" |