2022-04-01 12:16:46 +02:00
<!DOCTYPE html>
< html class = "writer-html5" lang = "en" >
< head >
< meta charset = "utf-8" />< meta name = "generator" content = "Docutils 0.17.1: http://docutils.sourceforge.net/" />
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" />
2022-04-19 10:52:03 +02:00
< title > < no title> — BNG Blaster 0.7 documentation</ title >
2022-04-01 12:16:46 +02:00
< link rel = "stylesheet" href = "../_static/pygments.css" type = "text/css" />
< link rel = "stylesheet" href = "../_static/css/theme.css" type = "text/css" />
< link rel = "stylesheet" href = "../_static/tabs.css" type = "text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
< script data-url_root = "../" id = "documentation_options" src = "../_static/documentation_options.js" ></ script >
< script src = "../_static/jquery.js" ></ script >
< script src = "../_static/underscore.js" ></ script >
< script src = "../_static/doctools.js" ></ 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" />
< 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 = "../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 >
2022-05-02 17:40:37 +02:00
< li class = "toctree-l1" >< a class = "reference internal" href = "../controller.html" > Controller</ a ></ li >
2022-04-01 12:16:46 +02:00
< li class = "toctree-l1" >< a class = "reference internal" href = "../troubleshooting.html" > Troubleshooting</ a ></ li >
< li class = "toctree-l1" >< a class = "reference internal" href = "../reference/index.html" > Reference</ 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" ></ a > » </ li >
< li > < 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 >< span class = "w" ></ span >
</ pre ></ div >
</ div >
< table class = "colwidths-given docutils align-default" >
< colgroup >
< col style = "width: 25%" />
< col style = "width: 50%" />
< col style = "width: 25%" />
</ colgroup >
< thead >
< tr class = "row-odd" >< th class = "head" >< p > Attribute</ p ></ th >
< th class = "head" >< p > Description</ p ></ th >
< th class = "head" >< p > Default</ p ></ th >
</ tr >
</ thead >
< tbody >
< tr class = "row-even" >< td >< p >< cite > name</ cite ></ p ></ td >
< td >< p > Mandatory stream name</ p ></ td >
< td ></ td >
</ tr >
< tr class = "row-odd" >< td >< p >< cite > stream-group-id</ cite ></ p ></ td >
< td >< p > Stream group identifier</ p ></ td >
< td >< p > 0 (raw)</ p ></ td >
</ tr >
< tr class = "row-even" >< td >< p >< cite > type</ cite ></ p ></ td >
< td >< p > Mandatory stream type (< cite > ipv4</ cite > , < cite > ipv6</ cite > or < cite > ipv6pd</ cite > )</ p ></ td >
< td ></ td >
</ tr >
< tr class = "row-odd" >< td >< p >< cite > direction</ cite ></ p ></ td >
< td >< p > Mandatory stream direction (< cite > upstream</ cite > , < cite > downstream</ cite > or < cite > both</ cite > )</ p ></ td >
< td >< p >< cite > both</ cite ></ p ></ td >
</ tr >
2022-06-15 08:35:51 +00:00
< tr class = "row-even" >< td >< p >< cite > source-port</ cite ></ p ></ td >
< td >< p > Overwrite the default source port</ p ></ td >
< td >< p > 65056</ p ></ td >
</ tr >
< tr class = "row-odd" >< td >< p >< cite > destination-port</ cite ></ p ></ td >
< td >< p > Overwrite the default destination port</ p ></ td >
< td >< p > 65056</ p ></ td >
</ tr >
< tr class = "row-even" >< td >< p >< cite > ipv4-df</ cite ></ p ></ td >
< td >< p > Set IPv4 DF bit</ p ></ td >
< td >< p > true</ p ></ td >
</ tr >
< tr class = "row-odd" >< td >< p >< cite > priority</ cite ></ p ></ td >
2022-04-01 12:16:46 +02:00
< td >< p > IPv4 TOS / IPv6 TC</ p ></ td >
< td >< p > 0</ p ></ td >
</ tr >
2022-06-15 08:35:51 +00:00
< tr class = "row-even" >< td >< p >< cite > vlan-priority</ cite ></ p ></ td >
2022-04-01 12:16:46 +02:00
< td >< p > VLAN priority</ p ></ td >
< td >< p > 0</ p ></ td >
</ tr >
2022-06-15 08:35:51 +00:00
< tr class = "row-odd" >< td >< p >< cite > length</ cite ></ p ></ td >
< td >< p > Layer 3 (IP header + payload) traffic length (76 - 9000)</ p ></ td >
2022-04-01 12:16:46 +02:00
< td >< p > 128</ p ></ td >
</ tr >
2022-06-15 08:35:51 +00:00
< tr class = "row-even" >< td >< p >< cite > pps</ cite ></ p ></ td >
2022-04-01 12:16:46 +02:00
< td >< p > Stream traffic rate in packets per second</ p ></ td >
< td >< p > 1</ p ></ td >
</ tr >
2022-06-15 08:35:51 +00:00
< tr class = "row-odd" >< td >< p >< cite > bps</ cite ></ p ></ td >
2022-04-01 12:16:46 +02:00
< td >< p > Stream traffic rate in bits per second (layer 3)</ p ></ td >
< td ></ td >
</ tr >
2022-06-15 08:35:51 +00:00
< tr class = "row-even" >< td >< p >< cite > a10nsp-interface</ cite ></ p ></ td >
2022-04-01 12:16:46 +02:00
< td >< p > Select the corresponding A10NSP interface for this stream</ p ></ td >
< td ></ td >
</ tr >
2022-06-15 08:35:51 +00:00
< tr class = "row-odd" >< td >< p >< cite > network-interface</ cite ></ p ></ td >
2022-04-01 12:16:46 +02:00
< td >< p > Select the corresponding network interface for this stream</ p ></ td >
< td ></ td >
</ tr >
2022-06-15 08:35:51 +00:00
< tr class = "row-even" >< td >< p >< cite > network-ipv4-address</ cite ></ p ></ td >
2022-04-01 12:16:46 +02:00
< td >< p > Overwrite network interface IPv4 address</ p ></ td >
< td ></ td >
</ tr >
2022-06-15 08:35:51 +00:00
< tr class = "row-odd" >< td >< p >< cite > network-ipv6-address</ cite ></ p ></ td >
2022-04-01 12:16:46 +02:00
< td >< p > Overwrite network interface IPv6 address</ p ></ td >
< td ></ td >
</ tr >
2022-06-15 08:35:51 +00:00
< tr class = "row-even" >< td >< p >< cite > destination-ipv4-address</ cite ></ p ></ td >
2022-04-01 12:16:46 +02:00
< td >< p > Overwrite the IPv4 destination address</ p ></ td >
< td ></ td >
</ tr >
2022-06-15 08:35:51 +00:00
< tr class = "row-odd" >< td >< p >< cite > destination-ipv6-address</ cite ></ p ></ td >
2022-04-01 12:16:46 +02:00
< td >< p > Overwrite the IPv6 destination address</ p ></ td >
< td ></ td >
</ tr >
2022-06-15 08:35:51 +00:00
< tr class = "row-even" >< td >< p >< cite > access-ipv4-source-address</ cite ></ p ></ td >
2022-04-01 12:16:46 +02:00
< td >< p > Overwrite the access IPv4 source address (client)</ p ></ td >
< td ></ td >
</ tr >
2022-06-15 08:35:51 +00:00
< tr class = "row-odd" >< td >< p >< cite > access-ipv6-source-address</ cite ></ p ></ td >
2022-04-01 12:16:46 +02:00
< td >< p > Overwrite the access IPv6 source address (client)</ p ></ td >
< td ></ td >
</ tr >
2022-06-15 08:35:51 +00:00
< tr class = "row-even" >< td >< p >< cite > threaded</ cite ></ p ></ td >
2022-04-01 12:16:46 +02:00
< td >< p > Run those streams in separate threads</ p ></ td >
< td >< p > false</ p ></ td >
</ tr >
2022-06-15 08:35:51 +00:00
< tr class = "row-odd" >< td >< p >< cite > thread-group</ cite ></ p ></ td >
2022-04-01 12:16:46 +02:00
< td >< p > Assign this stream to thread group (1-255)</ p ></ td >
< td >< p > 0 (thread per stream)</ p ></ td >
</ tr >
2022-06-15 08:35:51 +00:00
< tr class = "row-even" >< td >< p >< cite > max-packets</ cite ></ p ></ td >
2022-04-01 12:16:46 +02:00
< td >< p > Send a burst of N packets and stop</ p ></ td >
< td >< p > 0 (infinity)</ p ></ td >
</ tr >
2022-06-15 08:35:51 +00:00
< tr class = "row-odd" >< td >< p >< cite > start-delay</ cite ></ p ></ td >
2022-04-01 12:16:46 +02:00
< td >< p > Wait N seconds after session is established before start</ p ></ td >
< td >< p > 0</ p ></ td >
</ tr >
2022-06-15 08:35:51 +00:00
< tr class = "row-even" >< td >< p >< cite > tx-label1</ cite ></ p ></ td >
2022-04-01 12:16:46 +02:00
< td >< p > MPLS send (TX) label (outer label)</ p ></ td >
< td ></ td >
</ tr >
2022-06-15 08:35:51 +00:00
< tr class = "row-odd" >< td >< p >< cite > tx-label1-exp</ cite ></ p ></ td >
2022-04-01 12:16:46 +02:00
< td >< p > EXP bits of first label (outer label)</ p ></ td >
< td >< p > 0</ p ></ td >
</ tr >
2022-06-15 08:35:51 +00:00
< tr class = "row-even" >< td >< p >< cite > tx-label1-ttl</ cite ></ p ></ td >
2022-04-01 12:16:46 +02:00
< td >< p > TTL of first label (outer label)</ p ></ td >
< td >< p > 255</ p ></ td >
</ tr >
2022-06-15 08:35:51 +00:00
< tr class = "row-odd" >< td >< p >< cite > tx-label2</ cite ></ p ></ td >
2022-04-01 12:16:46 +02:00
< td >< p > MPLS send (TX) label (inner label)</ p ></ td >
< td ></ td >
</ tr >
2022-06-15 08:35:51 +00:00
< tr class = "row-even" >< td >< p >< cite > tx-label2-exp</ cite ></ p ></ td >
2022-04-01 12:16:46 +02:00
< td >< p > EXP bits of first label (inner label)</ p ></ td >
< td >< p > 0</ p ></ td >
</ tr >
2022-06-15 08:35:51 +00:00
< tr class = "row-odd" >< td >< p >< cite > tx-label2-ttl</ cite ></ p ></ td >
2022-04-01 12:16:46 +02:00
< td >< p > TTL of first label (inner label)</ p ></ td >
< td >< p > 255</ p ></ td >
</ tr >
2022-06-15 08:35:51 +00:00
< tr class = "row-even" >< td >< p >< cite > rx-label1</ cite ></ p ></ td >
2022-04-01 12:16:46 +02:00
< td >< p > Expected receive MPLS label (outer label)</ p ></ td >
< td ></ td >
</ tr >
2022-06-15 08:35:51 +00:00
< tr class = "row-odd" >< td >< p >< cite > rx-label2</ cite ></ p ></ td >
2022-04-01 12:16:46 +02:00
< td >< p > Expected receive MPLS label (inner label)</ p ></ td >
< td ></ td >
</ tr >
</ tbody >
</ table >
< p > For L2TP downstream traffic the IPv4 TOS is applied to the outer IPv4
and inner IPv4 header.</ p >
< p > The < code class = "docutils literal notranslate" >< span class = "pre" > pps</ span ></ code > option supports also float numbers like 0.1, or 2.5 PPS and has
priority over < code class = "docutils literal notranslate" >< span class = "pre" > bps</ span ></ code > where second is only a helper to calculate the < code class = "docutils literal notranslate" >< span class = "pre" > pps</ span ></ code >
based on given < code class = "docutils literal notranslate" >< span class = "pre" > bps</ span ></ code > and < code class = "docutils literal notranslate" >< span class = "pre" > length</ span ></ code > .</ p >
< p > The options < code class = "docutils literal notranslate" >< span class = "pre" > access-ipv4-source-address</ span ></ code > and < code class = "docutils literal notranslate" >< span class = "pre" > access-ipv6-source-address</ span ></ code >
are used to test the BNG RPF functionality with traffic send from source addresses
different to those assigned to the client.</ p >
</ div >
</ div >
< footer >
< hr />
< div role = "contentinfo" >
< p > © Copyright 2020-2022, 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 >
