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 = "../configuration/index.html" > Configuration</ a ></ li >
< li class = "toctree-l1" >< a class = "reference internal" href = "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/api/sessions.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" >
< table class = "docutils align-default" >
< colgroup >
< col style = "width: 25%" />
< col style = "width: 25%" />
< col style = "width: 25%" />
< 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 > Mandatory Arguments</ p ></ th >
< th class = "head" >< p > Optional Arguments</ p ></ th >
</ tr >
</ thead >
< tbody >
< tr class = "row-even" >< td >< p >< cite > session-info</ cite ></ p ></ td >
< td >< p > Display session information</ p ></ td >
< td ></ td >
< td >< p >< cite > session-id</ cite ></ p ></ td >
</ tr >
< tr class = "row-odd" >< td >< p >< cite > session-counters</ cite ></ p ></ td >
< td >< p > Display session counters</ p ></ td >
< td ></ td >
< td ></ td >
</ tr >
< tr class = "row-even" >< td >< p >< cite > sessions-pending</ cite ></ p ></ td >
< td >< p > List all sessions not established</ p ></ td >
< td ></ td >
< td ></ td >
</ tr >
< tr class = "row-odd" >< td >< p >< cite > session-traffic</ cite ></ p ></ td >
< td >< p > Display session traffic statistics</ p ></ td >
< td ></ td >
< td ></ td >
</ tr >
< tr class = "row-even" >< td >< p >< cite > session-traffic-start</ cite ></ p ></ td >
< td >< p > Enable/start session traffic</ p ></ td >
< td ></ td >
< td >< p >< cite > session-id</ cite ></ p ></ td >
</ tr >
< tr class = "row-odd" >< td >< p >< cite > session-traffic-stop</ cite ></ p ></ td >
< td >< p > Disable/stop session traffic</ p ></ td >
< td ></ td >
< td >< p >< cite > session-id</ cite ></ p ></ td >
</ tr >
< tr class = "row-even" >< td >< p >< cite > session-streams</ cite ></ p ></ td >
< td >< p > Display session streams</ p ></ td >
< td >< p >< cite > session-id</ cite ></ p ></ td >
< td ></ td >
</ tr >
< tr class = "row-odd" >< td >< p >< cite > terminate</ cite ></ p ></ td >
< td >< p > Terminate session</ p ></ td >
< td ></ td >
2022-04-05 15:11:53 +02:00
< td >< p >< cite > session-id</ cite > , < cite > reconnect-delay</ cite ></ p ></ td >
2022-04-01 12:16:46 +02:00
</ tr >
2022-04-26 17:13:46 +02:00
< tr class = "row-even" >< td >< p >< cite > session-start</ cite ></ p ></ td >
< td >< p > Start session manually</ p ></ td >
< td >< p >< cite > session-id</ cite ></ p ></ td >
< td ></ td >
</ tr >
2022-04-01 12:16:46 +02:00
</ tbody >
</ table >
2022-04-05 15:11:53 +02:00
< p > The argument < code class = "docutils literal notranslate" >< span class = "pre" > reconnect-delay</ span ></ code > is only applicable in combination with < code class = "docutils literal notranslate" >< span class = "pre" > session-id</ span ></ code >
2022-11-07 14:19:29 +00:00
and reconnect enabled in the configuration. This argument allows to delay the session
2022-04-05 15:11:53 +02:00
reconnect by the defined amount of seconds.</ p >
2022-04-01 12:16:46 +02:00
</ 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 >
