2022-04-01 12:16:46 +02:00
<!DOCTYPE html>
2024-03-25 22:01:36 +00:00
< html class = "writer-html5" lang = "en" data-content_root = "../" >
2022-04-01 12:16:46 +02:00
< head >
2024-03-25 22:01:36 +00:00
< meta charset = "utf-8" / > < meta name = "viewport" content = "width=device-width, initial-scale=1" / >
2022-04-01 12:16:46 +02:00
< 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 >
2024-03-25 22:01:36 +00:00
< 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] -->
2022-04-01 12:16:46 +02:00
2024-03-25 22:01:36 +00:00
< 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 >
2022-04-01 12:16:46 +02:00
< 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" >
2024-03-25 22:01:36 +00:00
< a href = "../index.html" class = "icon icon-home" >
BNG Blaster
< img src = "../_static/rtbrick_logo.png" class = "logo" alt = "Logo" / >
2022-04-01 12:16:46 +02:00
< / a >
< div role = "search" >
< form id = "rtd-search-form" class = "wy-form" action = "../search.html" method = "get" >
2024-03-25 22:01:36 +00:00
< input type = "text" name = "q" placeholder = "Search docs" aria-label = "Search docs" / >
2022-04-01 12:16:46 +02:00
< 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 >
2023-06-30 11:07:35 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../http.html" > HTTP Emulation< / a > < / li >
2023-11-03 08:56:38 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../nat.html" > NAT / CGNAT< / a > < / li >
2022-04-01 12:16:46 +02:00
< 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 >
2023-02-15 21:24:51 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../performance.html" > Performance Guide< / 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" >
2024-03-25 22:01:36 +00:00
< li > < a href = "../index.html" class = "icon icon-home" aria-label = "Home" > < / a > < / li >
< li class = "breadcrumb-item active" > < no title> < / li >
2022-04-01 12:16:46 +02:00
< li class = "wy-breadcrumbs-aside" >
< a href = "../_sources/api/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" >
< table class = "docutils align-default" >
< thead >
2023-11-03 08:56:38 +00:00
< tr class = "row-odd" > < th class = "head" > < p > Command< / p > < / th >
2022-04-01 12:16:46 +02:00
< th class = "head" > < p > Description< / p > < / th >
< / tr >
< / thead >
< tbody >
2023-11-03 08:56:38 +00:00
< tr class = "row-even" > < td > < p > < strong > stream-stats< / strong > < / p > < / td >
< td > < div class = "line-block" >
< div class = "line" > Display stream traffic statistics.< / div >
< / div >
< / td >
< / tr >
< tr class = "row-odd" > < td > < p > < strong > stream-info< / strong > < / p > < / td >
< td > < div class = "line-block" >
< div class = "line" > Display stream/flow information.< / div >
< div class = "line" > < br / > < / div >
< div class = "line" > < strong > Arguments:< / strong > < / div >
< div class = "line" > < code class = "docutils literal notranslate" > < span class = "pre" > flow-id< / span > < / code > < / div >
< / div >
< / td >
2022-04-01 12:16:46 +02:00
< / tr >
2023-11-03 08:56:38 +00:00
< tr class = "row-even" > < td > < p > < strong > stream-summary< / strong > < / p > < / td >
< td > < div class = "line-block" >
< div class = "line" > Display stream/flow summary information.< / div >
< div class = "line" > < br / > < / div >
< div class = "line" > < strong > Arguments:< / strong > < / div >
2023-12-21 12:10:42 +00:00
< div class = "line" > < code class = "docutils literal notranslate" > < span class = "pre" > session-group-id< / span > < / code > < / div >
2024-02-20 15:57:36 +00:00
< div class = "line" > < code class = "docutils literal notranslate" > < span class = "pre" > name< / span > < / code > stream name< / div >
< div class = "line" > < code class = "docutils literal notranslate" > < span class = "pre" > interface< / span > < / code > TX interface name< / div >
< div class = "line" > < code class = "docutils literal notranslate" > < span class = "pre" > direction< / span > < / code > [both(default), upstream, downstream]< / div >
2023-11-03 08:56:38 +00:00
< / div >
< / td >
2022-04-01 12:16:46 +02:00
< / tr >
2023-11-03 08:56:38 +00:00
< tr class = "row-odd" > < td > < p > < strong > stream-reset< / strong > < / p > < / td >
< td > < div class = "line-block" >
< div class = "line" > Reset all traffic streams.< / div >
< / div >
< / td >
2022-04-01 12:16:46 +02:00
< / tr >
2024-02-22 12:09:28 +00:00
< tr class = "row-even" > < td > < p > < strong > stream-start< / strong > < / p >
< p > < strong > stream-stop< / strong > < / p >
2024-03-05 09:28:25 +00:00
< p > < strong > stream-stop-verified< / strong > < / p >
2024-02-22 12:09:28 +00:00
< / td >
2024-01-09 15:28:31 +00:00
< td > < div class = "line-block" >
2024-02-20 15:57:36 +00:00
< div class = "line" > This command can be used to start or stop traffic stream flows.< / div >
< div class = "line" > This command applies to all flows except session-traffic and< / div >
< div class = "line" > multicast. If you provide a specific < code class = "docutils literal notranslate" > < span class = "pre" > flow-id< / span > < / code > as an argument,< / div >
< div class = "line" > other arguments are ignored. In this particular case, you can also< / div >
< div class = "line" > start and stop session-traffic and multicast.< / div >
2024-01-09 15:28:31 +00:00
< div class = "line" > < br / > < / div >
2024-03-05 09:28:25 +00:00
< div class = "line" > The command < strong > stream-stop-verified< / strong > works similar to< / div >
< div class = "line" > < strong > stream-stop< / strong > but only verified streams will be stopped.< / div >
2024-01-09 15:28:31 +00:00
< div class = "line" > < br / > < / div >
< div class = "line" > < strong > Arguments:< / strong > < / div >
< div class = "line" > < code class = "docutils literal notranslate" > < span class = "pre" > flow-id< / span > < / code > < / div >
2024-02-20 15:57:36 +00:00
< div class = "line" > < code class = "docutils literal notranslate" > < span class = "pre" > session-id< / span > < / code > < / div >
< div class = "line" > < code class = "docutils literal notranslate" > < span class = "pre" > session-group-id< / span > < / code > (ignored if session-id is present)< / div >
< div class = "line" > < code class = "docutils literal notranslate" > < span class = "pre" > name< / span > < / code > stream name< / div >
< div class = "line" > < code class = "docutils literal notranslate" > < span class = "pre" > interface< / span > < / code > TX interface name< / div >
< div class = "line" > < code class = "docutils literal notranslate" > < span class = "pre" > direction< / span > < / code > [both(default), upstream, downstream]< / div >
2024-01-09 15:28:31 +00:00
< / div >
< / td >
< / tr >
2024-02-20 15:57:36 +00:00
< tr class = "row-odd" > < td > < p > < strong > streams-pending< / strong > < / p > < / td >
2023-11-03 08:56:38 +00:00
< td > < div class = "line-block" >
2024-02-20 15:57:36 +00:00
< div class = "line" > List flow-id of all pending (not verified) traffic streams.< / div >
2023-11-03 08:56:38 +00:00
< / div >
< / td >
2022-04-06 23:03:25 +02:00
< / tr >
2024-02-28 16:58:04 +00:00
< tr class = "row-even" > < td > < p > < strong > stream-update< / strong > < / p > < / td >
< td > < div class = "line-block" >
< div class = "line" > Update stream/flow configuration.< / div >
< div class = "line" > < br / > < / div >
< div class = "line" > < strong > Arguments:< / strong > < / div >
< div class = "line" > < code class = "docutils literal notranslate" > < span class = "pre" > flow-id< / span > < / code > < / div >
< div class = "line" > < code class = "docutils literal notranslate" > < span class = "pre" > tcp-flags< / span > < / code > [ack, fin, fin-ack, syn, syn-ack, rst]< / div >
< / div >
< / td >
< / tr >
2022-04-01 12:16:46 +02:00
< / tbody >
< / table >
< / div >
< / div >
< footer >
< hr / >
< div role = "contentinfo" >
2024-02-23 20:14:00 +00:00
< p > © Copyright 2020-2024, 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 >
