| <!DOCTYPE html> |
| |
| <html lang="en" data-content_root="./"> |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" /> |
| |
| <title>iperf3 — iperf3 3.15 documentation</title> |
| <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" /> |
| <link rel="stylesheet" type="text/css" href="_static/bootstrap-sphinx.css?v=4468db6d" /> |
| <link rel="stylesheet" href="_static/bootstrap-3.3.6/css/bootstrap.min.css" type="text/css" /> |
| <link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" /> |
| <link rel="stylesheet" href="_static/esnet/esnet.css" type="text/css" /> |
| <script src="_static/documentation_options.js?v=c35749de"></script> |
| <script src="_static/doctools.js?v=888ff710"></script> |
| <script src="_static/sphinx_highlight.js?v=dc90522c"></script> |
| <script src="_static/js/jquery-1.11.0.min.js"></script> |
| <script src="_static/js/jquery-fix.js"></script> |
| <script src="_static/bootstrap-3.3.6/js/bootstrap.min.js"></script> |
| <script src="_static/bootstrap-sphinx.js"></script> |
| <link rel="icon" href="_static/favicon.ico"/> |
| <link rel="index" title="Index" href="genindex.html" /> |
| <link rel="search" title="Search" href="search.html" /> |
| <link rel="next" title="iperf3 Project News" href="news.html" /> |
| <meta charset='utf-8'> |
| <meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'> |
| <meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'> |
| <meta name="apple-mobile-web-app-capable" content="yes"> |
| |
| </head><body> |
| |
| <div id="navbar" class="navbar navbar-default navbar-fixed-top"> |
| <div class="container"> |
| <div class="navbar-header"> |
| <!-- .btn-navbar is used as the toggle for collapsed navbar content --> |
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse"> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| <a class="navbar-brand" href="#"> |
| iperf3</a> |
| </div> |
| |
| <div class="collapse navbar-collapse nav-collapse"> |
| <ul class="nav navbar-nav"> |
| |
| <li class="dropdown globaltoc-container"> |
| <a role="button" |
| id="dLabelGlobalToc" |
| data-toggle="dropdown" |
| data-target="#" |
| href="#">Section <b class="caret"></b></a> |
| <ul class="dropdown-menu globaltoc" |
| role="menu" |
| aria-labelledby="dLabelGlobalToc"><ul> |
| <li class="toctree-l1"><a class="reference internal" href="news.html">iperf3 Project News</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="obtaining.html">Obtaining iperf3</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="building.html">Building iperf3</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="invoking.html">Invoking iperf3</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="dev.html">iperf3 Development</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="faq.html">iperf3 FAQ</a></li> |
| </ul> |
| </ul> |
| </li> |
| |
| |
| |
| |
| |
| <li> |
| <a href="news.html" title="Next Chapter: iperf3 Project News"> |
| <span class="hidden-sm"> |
| iperf3 Project News |
| </span> |
| <span class="glyphicon glyphicon-chevron-right"></span> |
| </a> |
| </li> |
| |
| |
| <li class="divider-vertical"></li> |
| |
| <li><a href="genindex.html">Index</a></li> |
| <li><a href="https://www.es.net">ESnet</a></li> |
| |
| <li><a href="https://github.com/esnet/iperf"><img src="_static/icon-github.png" height="20" width="20"></a></li> |
| |
| |
| |
| <li class="hidden-sm"> |
| <div id="sourcelink"> |
| <a href="_sources/index.rst.txt" |
| rel="nofollow">Source</a> |
| </div></li> |
| |
| </ul> |
| |
| |
| <form class="navbar-form navbar-right" action="search.html" method="get"> |
| <div class="form-group"> |
| <input type="text" name="q" class="form-control" placeholder="Search" /> |
| </div> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| |
| </div> |
| </div> |
| </div> |
| |
| <div class="container"> |
| <div class="row"> |
| <div class="col-md-1"></div> |
| <div class="col-md-9"> |
| |
| <section id="iperf3"> |
| <h1>iperf3<a class="headerlink" href="#iperf3" title="Link to this heading">¶</a></h1> |
| <p>The iperf series of tools perform active measurements to determine the |
| maximum achievable bandwidth on IP networks. It supports tuning of |
| various parameters related to timing, protocols, and buffers. For |
| each test it reports the measured throughput, loss, and other |
| parameters.</p> |
| <p>This version, sometimes referred to as iperf3, is a redesign of an |
| original version developed at NLANR / DAST. iperf3 is a new |
| implementation from scratch, with the goal of a smaller, simpler code |
| base, and a library version of the functionality that can be used in |
| other programs. iperf3 also incorporates a number of features found in |
| other tools such as nuttcp and netperf, but were missing from the |
| original iperf. These include, for example, a zero-copy mode and |
| optional JSON output. Note that iperf3 is <em>not</em> backwards compatible |
| with the original iperf.</p> |
| <p>Primary development for iperf3 takes place on CentOS Linux, FreeBSD, |
| and macOS. At this time, these are the only officially |
| supported platforms, however there have been some reports of success |
| with OpenBSD, Android, and other Linux distributions.</p> |
| <p>iperf3 is principally developed by <a class="reference external" href="http://www.es.net/">ESnet</a> / |
| <a class="reference external" href="http://www.lbl.gov/">Lawrence Berkeley National Laboratory</a>. It |
| is released under a three-clause BSD license.</p> |
| <p>iperf2 is no longer being developed by its original maintainers. |
| However, beginning in 2014, another developer began fixing bugs and |
| enhancing functionality, and generating releases of iperf2. Both |
| projects (as of late 2017) are currently being developed actively, but |
| independently. More information can be found in the <a class="reference internal" href="faq.html#faq"><span class="std std-ref">iperf3 FAQ</span></a>.</p> |
| <section id="links-for-the-impatient"> |
| <h2>Links for the Impatient<a class="headerlink" href="#links-for-the-impatient" title="Link to this heading">¶</a></h2> |
| <p>Project homepage and documentation hosted on GitHub Pages: |
| <a class="reference external" href="https://software.es.net/iperf/">https://software.es.net/iperf/</a></p> |
| <p>Project site (source code repository, issue tracker) hosted on GitHub: |
| <a class="reference external" href="https://github.com/esnet/iperf">https://github.com/esnet/iperf</a></p> |
| <p>Source code downloads: |
| <a class="reference external" href="https://downloads.es.net/pub/iperf/">https://downloads.es.net/pub/iperf/</a></p> |
| </section> |
| <section id="contents"> |
| <h2>Contents<a class="headerlink" href="#contents" title="Link to this heading">¶</a></h2> |
| <div class="toctree-wrapper compound"> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="news.html">iperf3 Project News</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="news.html#iperf-3-16-released">2023-12-01: iperf-3.16 released</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="news.html#iperf-3-15-released">2023-09-14: iperf-3.15 released</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="news.html#iperf-3-14-released">2023-07-07: iperf-3.14 released</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="news.html#iperf-3-13-released">2023-02-16: iperf-3.13 released</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="news.html#iperf-3-12-released">2022-09-30: iperf-3.12 released</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="news.html#iperf-3-11-released">2022-01-28: iperf-3.11 released</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="news.html#iperf-3-10-1-released">2021-06-02: iperf-3.10.1 released</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="news.html#iperf-3-10-released">2021-05-26: iperf-3.10 released</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="news.html#iperf-3-9-released">2020-08-17: iperf-3.9 released</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="news.html#iperf-3-8-1-released">2020-06-10: iperf-3.8.1 released</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="news.html#iperf-3-8-released">2020-06-08: iperf-3.8 released</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="news.html#iperf-3-7-released">2019-06-21: iperf-3.7 released</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="news.html#iperf-3-6-released">2018-06-25: iperf-3.6 released</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="news.html#iperf-3-5-released">2018-03-02: iperf-3.5 released</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="news.html#iperf-3-4-released">2018-02-14: iperf-3.4 released</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="news.html#iperf-3-3-released">2017-10-31: iperf-3.3 released</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="news.html#iperf-3-2-released">2017-06-26: iperf-3.2 released</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="news.html#iperf3-update-june-2017">2017-06-06: iperf3 update, June 2017</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="news.html#iperf3-update-april-2017">2017-04-27: iperf3 update, April 2017</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="news.html#iperf-3-1-7-released">2017-03-06: iperf-3.1.7 released</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="news.html#iperf-3-1-6-released">2017-02-02: iperf-3.1.6 released</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="news.html#iperf-3-1-5-released">2017-01-12: iperf-3.1.5 released</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="news.html#iperf-3-1-4-released">2016-10-31: iperf-3.1.4 released</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="news.html#security-issue-iperf-3-1-3-iperf-3-0-12-released">2016-06-08: Security Issue: iperf-3.1.3, iperf-3.0.12 released</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="news.html#iperf-3-1-2-released">2016-02-01: iperf-3.1.2 released</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="news.html#older-news">Older News</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="obtaining.html">Obtaining iperf3</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="obtaining.html#binary-distributions">Binary Distributions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="obtaining.html#source-distributions">Source Distributions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="obtaining.html#source-code-repository">Source Code Repository</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="building.html">Building iperf3</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="building.html#prerequisites">Prerequisites</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="building.html#building">Building</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="invoking.html">Invoking iperf3</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="invoking.html#iperf3-manual-page">iperf3 Manual Page</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="dev.html">iperf3 Development</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="dev.html#mailing-lists">Mailing Lists</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="dev.html#bug-reports">Bug Reports</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="dev.html#changes-from-iperf-2-x">Changes from iperf 2.x</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="dev.html#known-issues">Known Issues</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="dev.html#versioning">Versioning</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="dev.html#release-engineering-checklist">Release Engineering Checklist</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="dev.html#code-authors">Code Authors</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="faq.html">iperf3 FAQ</a></li> |
| </ul> |
| </div> |
| </section> |
| <section id="indices-and-tables"> |
| <h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Link to this heading">¶</a></h2> |
| <ul class="simple"> |
| <li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li> |
| <li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li> |
| <li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li> |
| </ul> |
| </section> |
| </section> |
| |
| |
| </div> |
| |
| </div> |
| </div> |
| <footer class="footer"> |
| <div class="container"> |
| <div class="row"> |
| <div class="col-md-1"> |
| <a href="http://www.es.net/"><img src="_static/ESnet_Final_Logos_All_Blue_Circle_Stamp_RGB.png" alt="[ESnet]"></a> |
| </div> |
| <div class="col-md-11"> |
| <p class="pull-right"> |
| <a href="#">Back to top</a> |
| |
| </p> |
| <p> |
| © Copyright 2014-2023, ESnet.<br/> |
| Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 7.2.6.<br/> |
| </p> |
| </div> |
| </div> |
| </div> |
| </footer> |
| </body> |
| </html> |
