iperf3

https://software.es.net/iperf/
Admin
iperf3 is a tool that performs active measurements to determine the maximum achievable bandwidth on...
Tokens:6,091
Snippets:106
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Standard build and install commands

Source: https://software.es.net/iperf/building.html

The default sequence for compiling and installing the software on most systems.

```bash
./configure && make && make install
```

--------------------------------

### Start iperf3 server

Source: https://software.es.net/iperf/invoking.html

Commands to initiate an iperf3 server instance.

```bash
iperf3 -s
```

```bash
iperf3 --server
```

--------------------------------

### Start iperf3 server on custom port

Source: https://software.es.net/iperf/invoking.html

Initiate a server listening on a specific TCP port.

```bash
iperf3 -s -p 5002
```

--------------------------------

### Example Credentials File

Source: https://software.es.net/iperf/invoking.html

Format for the plaintext credentials file containing comma-separated username and SHA256 hash pairs.

```text
> cat credentials.csv
   # file format: username,sha256
   mario,bf7a49a846d44b454a5d11e7ac-
faf13d138bbe0b7483aa3e050879700572709b
```

--------------------------------

### Bootstrap configuration

Source: https://software.es.net/iperf/building.html

Run this command if the standard configuration process fails.

```bash
./bootstrap.sh
```

--------------------------------

### Update documentation files

Source: https://software.es.net/iperf/dev.html

Open README and LICENSE files to verify copyright dates.

```bash
vi README.md
vi LICENSE
```

--------------------------------

### Connect iperf3 client to server

Source: https://software.es.net/iperf/invoking.html

Initiate a client connection to a server using various address formats.

```bash
iperf3 -c iperf3.example.com
```

```bash
iperf3 -c 192.0.2.1
```

```bash
iperf3 -c 2001:db8::1
```

--------------------------------

### Create and checkout a release branch

Source: https://software.es.net/iperf/dev.html

Initialize a short-lived branch for release engineering tasks.

```bash
git branch releng-3.20     # create short-lived branch
git checkout releng-3.20   # check it out
```

--------------------------------

### Check available congestion control algorithms

Source: https://software.es.net/iperf/faq.html

Commands to list supported TCP congestion control algorithms on Linux and FreeBSD systems.

```bash
/sbin/sysctl net.ipv4.tcp_available_congestion_control
```

```bash
/sbin/sysctl net.inet.tcp.cc.available
```

--------------------------------

### Configure and commit release changes

Source: https://software.es.net/iperf/dev.html

Update version parameters, manpages, and regenerate build scripts before pushing the release branch.

```bash
vi configure.ac    # update version parameter in AC_INIT
                   # (there should not be any "+" in artifacts)
vi src/iperf3.1    # update manpage revision date (only if needed)
vi src/libiperf.3  # update manpage revision date (only if needed)
git commit -a      # commit changes to the local repository only
                   # (commit log should mention version number)
./bootstrap.sh     # regenerate configure script, etc.
                   # do this on a platform with a recent
                   # autotools/libtools, such as HomeBrew or
                   # FreeBSD ports.
git commit -a      # commit changes to the local repository only
                   # (commit can be simply "Regen.")
git push --set-upstream origin releng-3.20  # Push branch for review
```

--------------------------------

### Tag and package the release

Source: https://software.es.net/iperf/dev.html

Create a repository tag and generate the distribution tarball with its SHA256 checksum.

```bash
./make_release tag 3.20 # this creates a tag in the local repo
./make_release tar 3.20 # create tarball and compute SHA256 hash
```

--------------------------------

### Generate iPerf3 Manual Page

Source: https://software.es.net/iperf/dev.html

Commands to generate a text-based manual page from the nroff source for inclusion in documentation.

```bash
TERM=
export TERM
nroff -Tascii -c -man src/iperf3.1 | ul | sed 's/^/   /' > iperf3.txt
```

--------------------------------

### Update release notes

Source: https://software.es.net/iperf/dev.html

Edit the release notes file to reflect the new version and date.

```bash
vi RELNOTES.md     # update version number and release date
```

--------------------------------

### Generate RSA Keypair for iperf3

Source: https://software.es.net/iperf/invoking.html

Commands to generate a PEM-formatted RSA keypair suitable for iperf3 authentication.

```bash
> openssl genrsa -des3 -out private.pem 2048
>  openssl  rsa  -in  private.pem -outform PEM -pubout -out pub-
lic.pem
> openssl rsa -in private.pem -out private_not_protected.pem \
  -outform PEM
```

--------------------------------

### Run iperf3 in reverse mode

Source: https://software.es.net/iperf/invoking.html

Measure download speed by reversing the data flow direction.

```bash
iperf3 -c iperf3.example.com -p 5202 -R
```

--------------------------------

### Update iPerf3 Version and Regenerate Configuration

Source: https://software.es.net/iperf/dev.html

Steps to increment the version number in configure.ac and regenerate the build configuration scripts.

```bash
vi configure.ac         # update version in AC_INIT, add "+"
git commit configure.ac # commit changes to local repository
                        # commit log should mention
                        # "post-release version bump"
./bootstrap.sh          # regenerate configure script, etc.
git commit -a           # commit changes to local repository
                        # (commit can be simply "Regen.")
# test
git push
```

--------------------------------

### Push release tags

Source: https://software.es.net/iperf/dev.html

Finalize the release by pushing tags to the remote repository.

```bash
git push --tags     # Push the new tag to the GitHub repo
```

--------------------------------

### Connect iperf3 client to custom port

Source: https://software.es.net/iperf/invoking.html

Connect a client to a server running on a non-default port.

```bash
iperf3 -c iperf3.example.com -p 5002
```

--------------------------------

### Modify src/Makefile.am to permanently exclude profiled iperf3

Source: https://software.es.net/iperf/faq.html

Update the noinst_PROGRAMS line in src/Makefile.am and run ./bootstrap.sh to regenerate Makefiles without the profiled executable.

```makefile
noinst_PROGRAMS         = t_timer t_units t_uuid iperf3_profile
```

```makefile
noinst_PROGRAMS         = t_timer t_units t_uuid
```

--------------------------------

### Generate SHA256 Password Hash

Source: https://software.es.net/iperf/invoking.html

Command to generate the required SHA256 hash for a username and password combination.

```bash
> S_USER=mario S_PASSWD=rossi
> echo -n "{$S_USER}$S_PASSWD" | sha256sum | awk '{ print $1 }'
```

--------------------------------

### Modify src/Makefile to disable profiled iperf3

Source: https://software.es.net/iperf/faq.html

Edit the noinst_PROGRAMS definition to exclude iperf3_profile to resolve build failures on systems not supporting profiled executables.

```makefile
noinst_PROGRAMS = t_timer$(EXEEXT) t_units$(EXEEXT) t_uuid$(EXEEXT) \
  iperf3_profile$(EXEEXT)
```

```makefile
noinst_PROGRAMS = t_timer$(EXEEXT) t_units$(EXEEXT) t_uuid$(EXEEXT)
```
Tokens:
Raw