iPerf3 — Network Performance Testing
NOTE
Status: implemented and unit-tested, not proven on hardware. See the implementation status table. Command examples on this page show the intended workflow; the param block of each script is the authority for parameter names. Not proven on a live cluster.
iPerf3 measures network bandwidth, jitter, and packet loss between cluster nodes and VMs. Use it to validate IP-path bandwidth, east-west VM bandwidth, and Switch Embedded Teaming (SET) throughput. iPerf3 does not exercise RDMA / SMB Direct: read the Azure Local network guidance before you rely on a result for the storage network.
Run This Test
Prerequisites
- iPerf3 binaries available on target nodes (Windows or Linux)
- For the storage network, RDMA validated separately (iPerf3 cannot test it: see the network guidance)
- Framework prerequisites completed
Step 1 — Install iPerf3 on target nodes
There is no PowerShell install script. The Ansible playbook installs iPerf3 on Linux VMs (inventory group linux_vms):
ansible-playbook -i common/ansible/inventory/hosts.yml tools/iperf/playbooks/deploy-iperf.ymlStep 2 — Run a network test
.\tools\iperf\scripts\Start-IperfTest.ps1 `
-ClusterName "hci01.corp.infiniteimprobability.com" `
-Nodes @("hci01-node1", "hci01-node2", "hci01-node3") `
-Profile "tcp-throughput" `
-DurationSeconds 60This runs iPerf3 in server mode on each node in turn, with all other nodes as clients, creating a full-mesh bandwidth test.
Step 3 — Collect results
.\tools\iperf\scripts\Collect-IperfResults.ps1 `
-ClusterName "hci01.corp.infiniteimprobability.com" `
-Nodes @("hci01-node1", "hci01-node2", "hci01-node3") `
-RunId "<run-id-from-previous-step>"When to Use iPerf3
| Scenario | iPerf3 |
|---|---|
| Validate RDMA / SMB Direct network paths | ✅ |
| Measure east-west bandwidth between VMs | ✅ |
| Test Switch Embedded Teaming throughput | ✅ |
| Baseline network before deploying workloads | ✅ |
| Detect packet loss or jitter issues | ✅ |
Key Capabilities
- TCP, UDP, and SCTP protocol support
- Multi-stream parallel connections for saturating links
- JSON output for automated parsing
- Server daemon mode for persistent testing endpoints
- Full-mesh testing across all cluster nodes
What You Get
After a test completes, you will have:
- JSON output per node-pair with bandwidth (Mbps), jitter (ms), and packet loss (%)
- Mesh bandwidth matrix showing throughput between every node pair
- Reports in PDF, DOCX, and/or XLSX format
File Locations
| Component | Path |
|---|---|
| Scripts | tools/iperf/scripts/ |
| Workload Profiles | tools/iperf/config/profiles/ |
| Alert Rules | tools/iperf/monitoring/alert-rules.yml |
| Report Templates | tools/iperf/reports/templates/ |
| Tests | tools/iperf/tests/ |
| Logs | tools/iperf/logs/ |
Deep Dive
| Topic | Page |
|---|---|
| Installation on Windows and Linux | Installation |
| TCP, UDP, and mesh profiles | Workload Profiles |
| Alert rules during test runs | Monitoring |
| Report formats and templates | Reporting |
| Common errors and fixes | Troubleshooting |
Automate This Test
To run iPerf3 tests on a schedule or as part of a CI/CD workflow, see CI/CD Pipelines. The pipeline calls the same scripts listed above.