Updates for iperf-3.2 (new news, update manpage, version number).
Этот коммит содержится в:
Bruce A. Mah
родитель
b0e0a30631
Коммит
b6d9de52a4
@ -52,10 +52,10 @@ copyright = u'2014-2017, ESnet'
|
||||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
version = '3.1.7'
|
||||
version = '3.2'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
|
||||
release = '3.1.7'
|
||||
release = '3.2'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
|
||||
@ -41,9 +41,89 @@ the executable.
|
||||
|
||||
DESCRIPTION
|
||||
iperf3 is a tool for performing network throughput measurements. It
|
||||
can test either TCP or UDP throughput. To perform an iperf3 test the
|
||||
can test TCP, UDP, or SCTP throughput. To perform an iperf3 test the
|
||||
user must establish both a server and a client.
|
||||
|
||||
The iperf3 executable contains both client and server functionality.
|
||||
An iperf3 server can be started using either of the -s or --server com-
|
||||
mand-line parameters, for example:
|
||||
|
||||
iperf3 -s
|
||||
|
||||
iperf3 --server
|
||||
|
||||
Note that many iperf3 parameters have both short (-s) and long
|
||||
(--server) forms. In this section we will generally use the short form
|
||||
of command-line flags, unless only the long form of a flag is avail-
|
||||
able.
|
||||
|
||||
By default, the iperf3 server listens on TCP port 5201 for connections
|
||||
from an iperf3 client. A custom port can be specified by using the -p
|
||||
flag, for example:
|
||||
|
||||
iperf3 -s -p 5002
|
||||
|
||||
After the server is started, it will listen for connections from iperf3
|
||||
clients (in other words, the iperf3 program run in client mode). The
|
||||
client mode can be started using the -c command-line option, which also
|
||||
requires a host to which iperf3 should connect. The host can by speci-
|
||||
fied by hostname, IPv4 literal, or IPv6 literal:
|
||||
|
||||
iperf3 -c iperf3.example.com
|
||||
|
||||
iperf3 -c 192.0.2.1
|
||||
|
||||
iperf3 -c 2001:db8::1
|
||||
|
||||
If the iperf3 server is running on a non-default TCP port, that port
|
||||
number needs to be specified on the client as well:
|
||||
|
||||
iperf3 -c iperf3.example.com -p 5002
|
||||
|
||||
The initial TCP connection is used to exchange test parameters, control
|
||||
the start and end of the test, and to exchange test results. This is
|
||||
sometimes referred to as the "control connection". The actual test
|
||||
data is sent over a separate TCP connection, as a separate flow of UDP
|
||||
packets, or as an independent SCTP connection, depending on what proto-
|
||||
col was specified by the client.
|
||||
|
||||
Normally, the test data is sent from the client to the server, and mea-
|
||||
sures the upload speed of the client. Measuring the download speed
|
||||
from the server can be done by specifying the -R flag on the client.
|
||||
This causes data to be sent from the server to the client.
|
||||
|
||||
iperf3 -c iperf3.example.com -p 5202 -R
|
||||
|
||||
Results are displayed on both the client and server. There will be at
|
||||
least one line of output per measurement interval (by default a mea-
|
||||
surement interval lasts for one second, but this can be changed by the
|
||||
-i option). Each line of output includes (at least) the time since the
|
||||
start of the test, amount of data transfered during the interval, and
|
||||
the average bitrate over that interval. Note that the values for each
|
||||
measurement interval are taken from the point of view of the endpoint
|
||||
process emitting that output (in other words, the output on the client
|
||||
shows the measurement interval data for the client.
|
||||
|
||||
At the end of the test is a set of statistics that shows (at least as
|
||||
much as possible) a summary of the test as seen by both the sender and
|
||||
the receiver, with lines tagged accordingly. Recall that by default
|
||||
the client is the sender and the server is the receiver, although as
|
||||
indicated above, use of the -R flag will reverse these roles.
|
||||
|
||||
The client can be made to retrieve the server-side output for a given
|
||||
test by specifying the --get-server-output flag.
|
||||
|
||||
Either the client or the server can produce its output in a JSON struc-
|
||||
ture, useful for integration with other programs, by passing it the -J
|
||||
flag. Because the contents of the JSON structure are only competely
|
||||
known after the test has finished, no JSON output will be emitted until
|
||||
the end of the test.
|
||||
|
||||
iperf3 has a (overly) large set of command-line options that can be
|
||||
used to set the parameters of a test. They are given in the "GENERAL
|
||||
OPTIONS" section of the manual page below, as well as summarized in
|
||||
iperf3's help output, which can be viewed by running iperf3 with the -h
|
||||
flag.
|
||||
|
||||
GENERAL OPTIONS
|
||||
-p, --port n
|
||||
@ -53,26 +133,30 @@ the executable.
|
||||
[kmgtKMGT] format to report: Kbits/Mbits/Gbits/Tbits
|
||||
|
||||
-i, --interval n
|
||||
pause n seconds between periodic throughput reports; default is
|
||||
pause n seconds between periodic throughput reports; default is
|
||||
1, use 0 to disable
|
||||
|
||||
-F, --file name
|
||||
client-side: read from the file and write to the network,
|
||||
instead of using random data; server-side: read from the network
|
||||
and write to the file, instead of throwing the data away
|
||||
Use a file as the source (on the sender) or sink (on the
|
||||
receiver) of data, rather than just generating random data or
|
||||
throwing it away. This feature is used for finding whether or
|
||||
not the storage subsystem is the bottleneck for file transfers.
|
||||
It does not turn iperf3 into a file transfer tool. The length,
|
||||
attributes, and in some cases contents of the received file may
|
||||
not match those of the original file.
|
||||
|
||||
-A, --affinity n/n,m
|
||||
Set the CPU affinity, if possible (Linux and FreeBSD only). On
|
||||
both the client and server you can set the local affinity by
|
||||
Set the CPU affinity, if possible (Linux and FreeBSD only). On
|
||||
both the client and server you can set the local affinity by
|
||||
using the n form of this argument (where n is a CPU number). In
|
||||
addition, on the client side you can override the server's
|
||||
addition, on the client side you can override the server's
|
||||
affinity for just that one test, using the n,m form of argument.
|
||||
Note that when using this feature, a process will only be bound
|
||||
to a single CPU (as opposed to a set containing potentialy mul-
|
||||
Note that when using this feature, a process will only be bound
|
||||
to a single CPU (as opposed to a set containing potentialy mul-
|
||||
tiple CPUs).
|
||||
|
||||
-B, --bind host
|
||||
bind to a specific interface. If the host has multiple inter-
|
||||
bind to a specific interface. If the host has multiple inter-
|
||||
faces, it will use the first interface by default.
|
||||
|
||||
-V, --verbose
|
||||
@ -85,11 +169,11 @@ the executable.
|
||||
send output to a log file.
|
||||
|
||||
--forceflush
|
||||
force flushing output at every interval. Used to avoid buffer-
|
||||
force flushing output at every interval. Used to avoid buffer-
|
||||
ing when sending output to pipe.
|
||||
|
||||
-d, --debug
|
||||
emit debugging output. Primarily (perhaps exclusively) of use
|
||||
emit debugging output. Primarily (perhaps exclusively) of use
|
||||
to developers.
|
||||
|
||||
-v, --version
|
||||
@ -107,28 +191,28 @@ the executable.
|
||||
run the server in background as a daemon
|
||||
|
||||
-I, --pidfile file
|
||||
write a file with the process ID, most useful when running as a
|
||||
write a file with the process ID, most useful when running as a
|
||||
daemon.
|
||||
|
||||
-1, --one-off
|
||||
handle one client connection, then exit.
|
||||
|
||||
--rsa-private-key-path file
|
||||
path to the RSA private key (not password-protected) used to
|
||||
decrypt authentication credentials from the client (if built
|
||||
path to the RSA private key (not password-protected) used to
|
||||
decrypt authentication credentials from the client (if built
|
||||
with OpenSSL support).
|
||||
|
||||
--authorized-users-path file
|
||||
path to the configuration file containing authorized users cre-
|
||||
dentials to run iperf tests (if built with OpenSSL support).
|
||||
The file is a comma separated list of usernames and password
|
||||
hashes; more information on the structure of the file can be
|
||||
path to the configuration file containing authorized users cre-
|
||||
dentials to run iperf tests (if built with OpenSSL support).
|
||||
The file is a comma separated list of usernames and password
|
||||
hashes; more information on the structure of the file can be
|
||||
found in the EXAMPLES section.
|
||||
|
||||
CLIENT SPECIFIC OPTIONS
|
||||
-c, --client host
|
||||
run in client mode, connecting to the specified server. By
|
||||
default, a test consists of sending data from the client to the
|
||||
run in client mode, connecting to the specified server. By
|
||||
default, a test consists of sending data from the client to the
|
||||
server, unless the -R flag is specified.
|
||||
|
||||
--sctp use SCTP rather than TCP (FreeBSD and Linux)
|
||||
@ -137,29 +221,30 @@ the executable.
|
||||
use UDP rather than TCP
|
||||
|
||||
--connect-timeout n
|
||||
set timeout for establishing the initial control connection to
|
||||
the server, in milliseconds. The default behavior is the oper-
|
||||
ating system's timeout for TCP connection establishment. Pro-
|
||||
viding a shorter value may speed up detection of a down iperf3
|
||||
set timeout for establishing the initial control connection to
|
||||
the server, in milliseconds. The default behavior is the oper-
|
||||
ating system's timeout for TCP connection establishment. Pro-
|
||||
viding a shorter value may speed up detection of a down iperf3
|
||||
server.
|
||||
|
||||
-b, --bandwidth n[KM]
|
||||
set target bandwidth to n bits/sec (default 1 Mbit/sec for UDP,
|
||||
unlimited for TCP). If there are multiple streams (-P flag),
|
||||
the bandwidth limit is applied separately to each stream. You
|
||||
can also add a '/' and a number to the bandwidth specifier.
|
||||
This is called "burst mode". It will send the given number of
|
||||
packets without pausing, even if that temporarily exceeds the
|
||||
specified bandwidth limit. Setting the target bandwidth to 0
|
||||
will disable bandwidth limits (particularly useful for UDP
|
||||
tests). This bandwidth limit is implemented internally inside
|
||||
iperf3, and is available on all platforms. Compare with the
|
||||
--fq-rate flag.
|
||||
-b, --bitrate n[KM]
|
||||
set target bitrate to n bits/sec (default 1 Mbit/sec for UDP,
|
||||
unlimited for TCP/SCTP). If there are multiple streams (-P
|
||||
flag), the throughput limit is applied separately to each
|
||||
stream. You can also add a '/' and a number to the bitrate
|
||||
specifier. This is called "burst mode". It will send the given
|
||||
number of packets without pausing, even if that temporarily
|
||||
exceeds the specified throughput limit. Setting the target
|
||||
bitrate to 0 will disable bitrate limits (particularly useful
|
||||
for UDP tests). This throughput limit is implemented internally
|
||||
inside iperf3, and is available on all platforms. Compare with
|
||||
the --fq-rate flag. This option replaces the --bandwidth flag,
|
||||
which is now deprecated but (at least for now) still accepted.
|
||||
|
||||
--pacing-timer n[KMG]
|
||||
set pacing timer interval in microseconds (default 1000
|
||||
microseconds, or 1 ms). This controls iperf3's internal pacing
|
||||
timer for the -b/--bandwidth option. The timer fires at the
|
||||
timer for the -b/--bitrate option. The timer fires at the
|
||||
interval set by this parameter. 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
|
||||
@ -168,11 +253,11 @@ the executable.
|
||||
--fq-rate n[KM]
|
||||
Set a rate to be used with fair-queueing based socket-level pac-
|
||||
ing, in bits per second. This pacing (if specified) will be in
|
||||
addition to any pacing due to iperf3's internal bandwidth pacing
|
||||
(-b flag), and both can be specified for the same test. Only
|
||||
available on platforms supporting the SO_MAX_PACING_RATE socket
|
||||
option (currently only Linux). The default is no fair-queueing
|
||||
based pacing.
|
||||
addition to any pacing due to iperf3's internal throughput pac-
|
||||
ing (-b/--bitrate flag), and both can be specified for the same
|
||||
test. Only available on platforms supporting the SO_MAX_PAC-
|
||||
ING_RATE socket option (currently only Linux). The default is
|
||||
no fair-queueing based pacing.
|
||||
|
||||
--no-fq-socket-pacing
|
||||
This option is deprecated and will be removed. It is equivalent
|
||||
@ -331,8 +416,7 @@ the executable.
|
||||
|
||||
|
||||
|
||||
ESnet May 2017 IPERF3(1)
|
||||
|
||||
ESnet June 2017 IPERF3(1)
|
||||
The iperf3 manual page will typically be installed in manual
|
||||
section 1.
|
||||
|
||||
|
||||
@ -1,6 +1,14 @@
|
||||
iperf3 Project News
|
||||
===================
|
||||
|
||||
2017-06-26: iperf-3.2 released
|
||||
-------------------------------
|
||||
|
||||
| URL: http://downloads.es.net/pub/iperf/iperf-3.2.tar.gz
|
||||
| SHA256: ``f207b36f861485845dbdf09f909c62f3d2222a3cf3d2682095aede8213cd9c1d iperf-3.2.tar.gz``
|
||||
|
||||
New minor release of iperf 3.2, with new features, bugfixes, and enhancements.
|
||||
|
||||
2017-06-06: iperf3 update, June 2017
|
||||
--------------------------------------
|
||||
|
||||
|
||||
Загрузка…
x
Ссылка в новой задаче
Block a user