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-10-31 23:26:32 +00:00
< title > < no title> — BNG Blaster 0.8 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 = "../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/interfaces.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" >
2022-10-31 23:26:32 +00:00
< p > The following configuration allows to overwrite the global default interface link settings.< / p >
< div class = "highlight-json notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "p" > {< / span > < span class = "w" > < / span > < span class = "nt" > " interfaces" < / 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 >
2022-04-01 12:16:46 +02:00
< / 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 >
2022-10-31 23:26:32 +00:00
< tr class = "row-even" > < td > < p > < cite > io-mode< / cite > < / p > < / td >
< td > < p > IO mode< / p > < / td >
< td > < p > packet_mmap_raw< / p > < / td >
2022-04-01 12:16:46 +02:00
< / tr >
2022-10-31 23:26:32 +00:00
< tr class = "row-odd" > < td > < p > < cite > io-slots< / cite > < / p > < / td >
< td > < p > IO slots (ring size)< / p > < / td >
< td > < p > 4096< / p > < / td >
2022-04-01 12:16:46 +02:00
< / tr >
< tr class = "row-even" > < td > < p > < cite > qdisc-bypass< / cite > < / p > < / td >
< td > < p > Bypass the kernel’ s qdisc layer< / p > < / td >
< td > < p > true< / p > < / td >
< / tr >
2022-10-31 23:26:32 +00:00
< tr class = "row-odd" > < td > < p > < cite > tx-interval< / cite > < / p > < / td >
< td > < p > TX polling interval in milliseconds< / p > < / td >
< td > < p > 1.0< / p > < / td >
2022-04-01 12:16:46 +02:00
< / tr >
2022-10-31 23:26:32 +00:00
< tr class = "row-even" > < td > < p > < cite > rx-interval< / cite > < / p > < / td >
< td > < p > RX polling interval in milliseconds< / p > < / td >
< td > < p > 1.0< / p > < / td >
< / tr >
< tr class = "row-odd" > < td > < p > < cite > tx-threads< / cite > < / p > < / td >
< td > < p > Number of TX threads per interface link< / p > < / td >
< td > < p > 0 (main thread)< / p > < / td >
2022-04-01 12:16:46 +02:00
< / tr >
2022-10-31 23:26:32 +00:00
< tr class = "row-even" > < td > < p > < cite > rx-threads< / cite > < / p > < / td >
< td > < p > Number of RX threads per interface link< / p > < / td >
< td > < p > 0 (main thread)< / p > < / td >
2022-04-01 12:16:46 +02:00
< / tr >
2022-10-31 23:26:32 +00:00
< tr class = "row-odd" > < td > < p > < cite > capture-include-streams< / cite > < / p > < / td >
< td > < p > Include traffic streams in the capture< / p > < / td >
2022-11-08 21:43:35 +00:00
< td > < p > false< / p > < / td >
2022-04-01 12:16:46 +02:00
< / tr >
2022-10-31 23:26:32 +00:00
< tr class = "row-even" > < td > < p > < cite > mac-modifier< / cite > < / p > < / td >
2022-04-19 10:52:03 +02:00
< td > < p > Third byte of access session MAC address (0-255)< / p > < / td >
< td > < p > 0< / p > < / td >
< / tr >
2022-04-01 12:16:46 +02:00
< / tbody >
< / table >
2022-10-31 23:26:32 +00:00
< p > The supported IO modes are listed with < code class = "docutils literal notranslate" > < span class = "pre" > bngblaster< / span > < span class = "pre" > -v< / span > < / code > but except
< code class = "docutils literal notranslate" > < span class = "pre" > packet_mmap_raw< / span > < / code > all other modes are currently considered experimental. In
the default mode (< code class = "docutils literal notranslate" > < span class = "pre" > packet_mmap_raw< / span > < / code > ) all packets are received in a Packet MMAP
ring buffer and sent directly through RAW packet sockets.< / p >
< p > The default < code class = "docutils literal notranslate" > < span class = "pre" > tx-interval< / span > < / code > and < code class = "docutils literal notranslate" > < span class = "pre" > rx-interval< / span > < / code > of < code class = "docutils literal notranslate" > < span class = "pre" > 1.0< / span > < / code > (1ms) allows precise timestamps
and high throughput. Those values can be further increased (e.g. < code class = "docutils literal notranslate" > < span class = "pre" > 0.1< / span > < / code > ) for higher throughput
or decreased (e.g. < code class = "docutils literal notranslate" > < span class = "pre" > 5.0< / span > < / code > ) for lower system load.< / p >
< p > It might be also needed to increase the < code class = "docutils literal notranslate" > < span class = "pre" > io-slots< / span > < / code > from the default value of < code class = "docutils literal notranslate" > < span class = "pre" > 4096< / span > < / code > to
reach the desired throughput. The actual meaning of IO slots depends on the selected IO mode.
For Packet MMAP, it defines the maximum number of packets in the ring buffer.< / p >
2022-04-01 12:16:46 +02:00
< / div >
< / div >
< footer >
< hr / >
< div role = "contentinfo" >
2023-01-13 16:02:11 +00:00
< p > © Copyright 2020-2023, RtBrick, Inc..< / p >
2022-04-01 12:16:46 +02:00
< / 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 >