Iperf And Bandwidth Testing

Category: Network Tools and Commands
Type: Network Tools & Commands
Generated on: 2025-07-10 09:16:39
For: Network Engineering, Administration & Technical Interviews

1. Tool Overview

Iperf3: A widely used, cross-platform tool for measuring network bandwidth and testing TCP and UDP throughput between two endpoints. It’s a command-line tool providing detailed statistics and can simulate various network conditions. Crucial for troubleshooting network performance issues, validating network designs, and benchmarking network devices.
When to Use:
- Measure network bandwidth between two hosts.
- Diagnose network bottlenecks.
- Validate network design and configuration changes.
- Verify QoS configurations.
- Test network performance across WAN links.
- Simulate network traffic loads.

2. Basic Syntax

Iperf3 (Client Mode):

iperf3 -c <server_ip> [options]

Iperf3 (Server Mode):

iperf3 -s [options]

3. Practical Examples

Example 1: Basic Bandwidth Test (TCP)

Server (host1):

iperf3 -s

Expected Output (truncated):

-----------------------------------------------------------
Server listening on 5201
-----------------------------------------------------------

Client (host2):

iperf3 -c <host1_ip>

Expected Output (truncated):

Connecting to host1_ip, port 5201
[  5] local 192.168.1.10 port 45678 connected to host1_ip port 5201
[ ID] Interval           Transfer     Bitrate         Retr  Cwnd
[  5]   0.00-10.00  sec  1.13 GBytes   969 Mbits/sec    0   525 KBytes
[  5] Sent 1599 msgs (1.13 GBytes)
-----------------------------------------------------------
Client connecting to host1_ip, port 5201
-----------------------------------------------------------
[ ID] Interval           Transfer     Bitrate         Retr
[  5]   0.00-10.00  sec  1.13 GBytes   969 Mbits/sec    0             sender
[  5]   0.00-10.00  sec  1.13 GBytes   969 Mbits/sec                  receiver
-----------------------------------------------------------

Example 2: UDP Bandwidth Test

Server (host1):
Terminal window
```
iperf3 -s -u
```

Client (host2):

iperf3 -c <host1_ip> -u -b 100M  # -b sets the target bandwidth to 100 Mbps

Expected Output (truncated):

Connecting to host1_ip, port 5201
[  5] local 192.168.1.10 port 45678 connected to host1_ip port 5201
[ ID] Interval           Transfer     Bitrate         Jitter   Lost/Total Datagrams
[  5]   0.00-10.00  sec  119 MBytes  100 Mbits/sec  0.032 ms  0/85108 (0%)
[  5] Sent 85108 datagrams
-----------------------------------------------------------
Client connecting to host1_ip, port 5201
-----------------------------------------------------------
[ ID] Interval           Transfer     Bitrate         Jitter   Lost/Total Datagrams
[  5]   0.00-10.00  sec  119 MBytes  100 Mbits/sec  0.032 ms  0/85108 (0%)             sender
[  5]   0.00-10.00  sec  119 MBytes  100 Mbits/sec  0.032 ms  0/85108 (0%)             receiver
-----------------------------------------------------------

Example 3: Reverse Mode (Server Sends to Client)

Server (host1):
Terminal window
```
iperf3 -s
```
Client (host2):
Terminal window
```
iperf3 -c <host1_ip> -R
```

Example 4: Running Iperf3 for a specific duration.

Server (host1):
Terminal window
```
iperf3 -s
```

Client (host2):

iperf3 -c <host1_ip> -t 60  # run test for 60 seconds

4. Common Options

-s: Server mode.
-c <server_ip>: Client mode, specify the server IP address.
-p <port>: Specify the port number (default: 5201).
-u: Use UDP instead of TCP.
-b <bandwidth>: Set target bandwidth (UDP only). e.g., 100M for 100 Mbps.
-t <seconds>: Run the test for a specific duration in seconds.
-i <seconds>: Interval between periodic bandwidth reports (default: 1 second).
-P <number>: Number of parallel client streams.
-R: Reverse mode (server sends data to the client).
-f [kmgtKMGT]: Format to report: Kbits, Mbits, Gbits, Tbits.
-w <size>: TCP window size / UDP buffer size. Useful for tuning performance over high-latency links.
-l <length>: Length of buffer to read or write. TCP by default is 128K, UDP is 1470.
--json: Output results in JSON format (useful for scripting).
-4: Use IPv4 only
-6: Use IPv6 only

5. Advanced Usage

Example 5: Multiple Parallel Streams (TCP)

Server (host1):
Terminal window
```
iperf3 -s
```

Client (host2):

iperf3 -c <host1_ip> -P 5  # Run 5 parallel TCP streams

Example 6: Setting TCP Window Size

Server (host1):
Terminal window
```
iperf3 -s
```

Client (host2):

iperf3 -c <host1_ip> -w 2M  # Set TCP window size to 2MB

Example 7: UDP testing with jitter and packet loss checking

Server (host1):
Terminal window
```
iperf3 -s -u
```

Client (host2):

iperf3 -c <host1_ip> -u -b 50M -t 30  # UDP, 50Mbps, run for 30 seconds

Example 8: JSON Output for Scripting

Server (host1):
Terminal window
```
iperf3 -s
```

Client (host2):

iperf3 -c <host1_ip> --json > iperf_results.json # Capture results in JSON file

6. Troubleshooting Scenarios

Low Bandwidth:
- Check Network Congestion: Use tools like ping, traceroute, and tcpdump to identify bottlenecks.
- Check Firewall Rules: Ensure that firewalls are not blocking traffic on port 5201 (or the port you’re using).
- Check Cable and Hardware: Verify physical connections and hardware (NICs, routers, switches).
- MTU Issues: Test with different MTU sizes (using ping with the -s flag) to rule out MTU problems.
- QoS Configuration: Review QoS settings on network devices. Incorrect QoS can throttle bandwidth.
- Duplex Mismatch: Ensure network interfaces are configured with the correct duplex settings (autonegotiate or full-duplex).
High Packet Loss (UDP):
- Reduce Bandwidth: Decrease the -b parameter to reduce the load on the network.
- Increase Buffer Size: Experiment with the -w option (UDP buffer size).
- Check for Network Congestion: Packet loss is often a symptom of congestion.
Iperf3 Not Connecting:
- Verify IP Addresses: Double-check that the client is connecting to the correct server IP address.
- Firewall: Ensure no firewall is blocking traffic.
- DNS: Verify that the client can resolve the server’s hostname (if used).
- Routing: Check that the client and server can reach each other via their respective network routes. Use traceroute.

7. Output Interpretation

Interval: The time interval for the reported statistics.
Transfer: The amount of data transferred during the interval.
Bitrate: The bandwidth achieved during the interval (usually in Mbps or Gbps). This is the key metric.
Retr: The number of TCP retransmissions. High retransmission rates indicate network problems.
Cwnd: TCP congestion window size. This shows how the TCP protocol is adjusting to network conditions. A consistently low cwnd may indicate a bottleneck.
Jitter (UDP): The variation in packet delay. Higher jitter can impact real-time applications like VoIP.
Lost/Total Datagrams (UDP): The number of UDP packets lost and the total number of packets sent. This gives the packet loss rate. A high loss rate can significantly degrade performance.

8. Security Considerations

Firewall: Iperf3 should only be run on trusted networks. Firewalls should restrict access to the Iperf3 server port (default 5201).
Authentication: Iperf3 does not have built-in authentication. If you need to run Iperf3 over an untrusted network, consider using a VPN or SSH tunnel.
Resource Consumption: Iperf3 can generate significant network traffic. Avoid running Iperf3 tests during peak hours, as it can impact network performance for other users.
Denial-of-Service (DoS): An attacker could potentially use Iperf3 to launch a DoS attack. Secure your network and limit access to Iperf3 servers.
Data Exposure: The data transferred during an Iperf3 test is not encrypted unless you use a tunneling solution.
Privileged Access: Running Iperf3 requires user-level access; root access is generally not needed.

9. Platform Differences

Linux: Iperf3 is typically installed via the package manager (e.g., apt-get install iperf3 on Debian/Ubuntu, yum install iperf3 on CentOS/RHEL).
Windows: Download the pre-compiled binary from the official Iperf website or use a package manager like Chocolatey. You may need to add the Iperf3 directory to your system’s PATH environment variable to run it from the command line.
macOS: Use Homebrew (brew install iperf3) or MacPorts (sudo port install iperf3).
Syntax: The basic command syntax is generally the same across all platforms.
Firewall: Ensure that the firewall on the operating system allows Iperf3 traffic. Windows Firewall is enabled by default and may need configuration.
Pathnames: Use forward slashes / in pathnames on macOS and Linux. On Windows, you can use either forward slashes / or backslashes \. However, backslashes may need to be escaped in some contexts (e.g., in scripts).
Version Variations: Be aware that output formats and some features may vary based on the Iperf3 version being used across different platforms. It’s good practice to check the version on both the client and server using iperf3 -v.

This cheatsheet provides a comprehensive guide to using Iperf3 for network bandwidth testing. Remember to adapt the commands and examples to your specific network environment and always prioritize security best practices.