mirror of
https://github.com/rtbrick/bngblaster.git
synced 2024-05-06 15:54:57 +00:00
408 lines
15 KiB
HTML
408 lines
15 KiB
HTML
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" data-content_root="../">
|
|
<head>
|
|
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title><no title> — BNG Blaster 0.8 documentation</title>
|
|
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
|
|
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
|
|
<link rel="stylesheet" type="text/css" href="../_static/tabs.css?v=a5c4661c" />
|
|
<link rel="stylesheet" type="text/css" href="../_static/custom.css?v=411f5019" />
|
|
|
|
|
|
<!--[if lt IE 9]>
|
|
<script src="../_static/js/html5shiv.min.js"></script>
|
|
<![endif]-->
|
|
|
|
<script src="../_static/jquery.js?v=5d32c60e"></script>
|
|
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
|
<script src="../_static/documentation_options.js?v=a0e24af7"></script>
|
|
<script src="../_static/doctools.js?v=888ff710"></script>
|
|
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
|
<script src="../_static/js/theme.js"></script>
|
|
<link rel="index" title="Index" href="../genindex.html" />
|
|
<link rel="search" title="Search" href="../search.html" />
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav">
|
|
<div class="wy-grid-for-nav">
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search" >
|
|
|
|
|
|
|
|
<a href="../index.html" class="icon icon-home">
|
|
BNG Blaster
|
|
<img src="../_static/rtbrick_logo.png" class="logo" alt="Logo"/>
|
|
</a>
|
|
<div role="search">
|
|
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../install.html">Installation</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../quickstart.html">Quickstart Guide</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../interfaces.html">Interfaces</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../access/index.html">Access Protocols</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../routing/index.html">Routing Protocols</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../streams.html">Traffic Streams</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../http.html">HTTP Emulation</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../nat.html">NAT / CGNAT</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../reports.html">Reports</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="index.html">Configuration</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../api/index.html">API/CLI</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../controller.html">Controller</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../performance.html">Performance Guide</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../troubleshooting.html">Troubleshooting</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../faq.html">Frequently Asked Questions</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="../index.html">BNG Blaster</a>
|
|
</nav>
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<div role="navigation" aria-label="Page navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
|
<li class="breadcrumb-item active"><no title></li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="../_sources/configuration/streams.rst.txt" rel="nofollow"> View page source</a>
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div itemprop="articleBody">
|
|
|
|
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="w"> </span><span class="nt">"streams"</span><span class="p">:</span><span class="w"> </span><span class="p">{}</span><span class="w"> </span><span class="p">}</span>
|
|
</pre></div>
|
|
</div>
|
|
<table class="docutils align-default">
|
|
<tbody>
|
|
<tr class="row-odd"><td><p>Attribute</p></td>
|
|
<td><p>Description</p></td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><strong>name</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">Mandatory stream name.</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><strong>stream-group-id</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">Stream group identifier.</div>
|
|
<div class="line">Default: 0 (raw)</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><strong>type</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">Mandatory stream type (<cite>ipv4</cite>, <cite>ipv6</cite>, or <cite>ipv6pd</cite>).</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><strong>direction</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">Stream direction (<cite>upstream</cite>, <cite>downstream</cite>, or <cite>both</cite>).</div>
|
|
<div class="line">Default: <cite>both</cite></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><strong>autostart</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">Enable stream autostart.</div>
|
|
<div class="line">Default: true</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><strong>source-port</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">Overwrite the default source port.</div>
|
|
<div class="line">Default: 65056 Range: 0 - 65535</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><strong>destination-port</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">Overwrite the default destination port.</div>
|
|
<div class="line">Default: 65056 Range: 0 - 65535</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><strong>ipv4-df</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">Set IPv4 DF bit.</div>
|
|
<div class="line">Default: true</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><strong>priority</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">IPv4 TOS / IPv6 TC.</div>
|
|
<div class="line">For L2TP downstream traffic, the IPv4 TOS is applied</div>
|
|
<div class="line">to the outer IPv4 and inner IPv4 header.</div>
|
|
<div class="line">Default: 0 Range: 0 - 255</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><strong>vlan-priority</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">VLAN priority.</div>
|
|
<div class="line">Default: 0 Range: 0 - 7</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><strong>length</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">Layer 3 (IP header + payload) traffic length.</div>
|
|
<div class="line">Default: 128 Range: 76 - 9000</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><strong>ttl</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">TTL.</div>
|
|
<div class="line">Default: 64 Range: 0 - 255</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><strong>pps</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">Stream traffic rate in packets per second.</div>
|
|
<div class="line">This value supports also float numbers like 0.1 or 2.5.</div>
|
|
<div class="line">In example 0.1 means one packet every 10 seconds.</div>
|
|
<div class="line">Default: 1.0</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><strong>bps</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">Stream traffic rate in bits per second (layer 3).</div>
|
|
<div class="line">PPS has priority over bps where the second is only a helper</div>
|
|
<div class="line">to calculate the actual PPS based on given bps and length.</div>
|
|
<div class="line">The resulting rate in bps is the layer 3 rate because length</div>
|
|
<div class="line">is also the layer 3 length (IP header + payload).</div>
|
|
<div class="line">It is also supported to put the capital letters K (Kilo),</div>
|
|
<div class="line">M (Mega) or G (Giga) in front of bps for better readability.</div>
|
|
<div class="line">For example, <code class="docutils literal notranslate"><span class="pre">"Gbps":</span> <span class="pre">1</span></code></div>
|
|
<div class="line">which is equal to <code class="docutils literal notranslate"><span class="pre">"bps":</span> <span class="pre">1000000000</span></code>.</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><strong>pps-upstream</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">Optionally overwrite PPS in upstream to support bidirectional</div>
|
|
<div class="line">streams with different rates for upstream and downstream.</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><strong>bps-upstream</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">Optionally overwrite bps in upstream to support bidirectional</div>
|
|
<div class="line">streams with different rates for upstream and downstream.</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><strong>setup-interval</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">Set optional setup interval in seconds. If set, sent max 1</div>
|
|
<div class="line">packet per setup interval until stream becomes verified.</div>
|
|
<div class="line">After setup is done, the actual rate will be applied.</div>
|
|
<div class="line">For bidirectional streams (direction both), this requires both</div>
|
|
<div class="line">directions to be verified.</div>
|
|
<div class="line">Default: 0 (disabled) Range: 0 - 900</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><strong>a10nsp-interface</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">Select the corresponding A10NSP interface for this stream.</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><strong>network-interface</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">Select the corresponding network interface for this stream.</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><strong>network-ipv4-address</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">Overwrite network interface IPv4 address.</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><strong>network-ipv6-address</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">Overwrite network interface IPv6 address.</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><strong>destination-ipv4-address</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">Overwrite the IPv4 destination address.</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><strong>destination-ipv6-address</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">Overwrite the IPv6 destination address.</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><strong>access-ipv4-source-address</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">Overwrite the access IPv4 source address (client).</div>
|
|
<div class="line">This option can be used to test the BNG RPF functionality</div>
|
|
<div class="line">with traffic sent from source addresses different than those</div>
|
|
<div class="line">assigned to the client.</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><strong>access-ipv6-source-address</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">Overwrite the access IPv6 source address (client).</div>
|
|
<div class="line">This option can be used to test the BNG RPF functionality</div>
|
|
<div class="line">with traffic sent from source addresses different than those</div>
|
|
<div class="line">assigned to the client.</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><strong>max-packets</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">Send a burst of N packets and stop.</div>
|
|
<div class="line">Default: 0 (infinity)</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><strong>start-delay</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">Wait N seconds after the session is established</div>
|
|
<div class="line">before starting the traffic stream.</div>
|
|
<div class="line">Default: 0</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><strong>tx-label1</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">MPLS send (TX) label (outer label).</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><strong>tx-label1-exp</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">EXP bits of the first label (outer label).</div>
|
|
<div class="line">Default: 0</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><strong>tx-label1-ttl</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">TTL of the first label (outer label).</div>
|
|
<div class="line">Default: 255</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><strong>tx-label2</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">MPLS send (TX) label (inner label).</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><strong>tx-label2-exp</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">EXP bits of the second label (inner label).</div>
|
|
<div class="line">Default: 0</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><strong>tx-label2-ttl</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">TTL of the second label (inner label).</div>
|
|
<div class="line">Default: 255</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><strong>rx-label1</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">Expected receive MPLS label (outer label).</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><strong>rx-label2</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">Expected receive MPLS label (inner label).</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><strong>ldp-ipv4-lookup-address</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">Dynamically resolve outer label.</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><strong>ldp-ipv6-lookup-address</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">Dynamically resolve outer label.</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><strong>nat</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">Enable NAT support.</div>
|
|
<div class="line">Default: false</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><strong>raw-tcp</strong></p></td>
|
|
<td><div class="line-block">
|
|
<div class="line">Send RAW TCP traffic (UDP-like traffic with TCP header).</div>
|
|
<div class="line">Default: false</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>© Copyright 2020-2024, RtBrick, Inc..</p>
|
|
</div>
|
|
|
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
|
|
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
<script>
|
|
jQuery(function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
});
|
|
</script>
|
|
|
|
</body>
|
|
</html> |