mirror of
https://github.com/rtbrick/bngblaster.git
synced 2024-05-06 15:54:57 +00:00
215 lines
9.2 KiB
HTML
215 lines
9.2 KiB
HTML
<!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" />
|
|
<title><no title> — BNG Blaster 0.8 documentation</title>
|
|
<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>
|
|
<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"></a> »</li>
|
|
<li><no title></li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="../_sources/configuration/igmp.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">"igmp"</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>autostart</cite></p></td>
|
|
<td><p>Automatically join after the session is established</p></td>
|
|
<td><p>true</p></td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><cite>version</cite></p></td>
|
|
<td><p>IGMP protocol version (1, 2 or 3)</p></td>
|
|
<td><p>3</p></td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><cite>combined-leave-join</cite></p></td>
|
|
<td><p>Combine leave and join records within a single IGMPv3 report</p></td>
|
|
<td><p>true</p></td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><cite>start-delay</cite></p></td>
|
|
<td><p>Delay between session established and initial IGMP join in seconds</p></td>
|
|
<td><p>1</p></td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><cite>group</cite></p></td>
|
|
<td><p>Multicast group base address (e.g. 239.0.0.1)</p></td>
|
|
<td><p>0.0.0.0 (disabled)</p></td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><cite>group-iter</cite></p></td>
|
|
<td><p>Multicast group iterator</p></td>
|
|
<td><p>0.0.0.1</p></td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><cite>group-count</cite></p></td>
|
|
<td><p>Multicast group count</p></td>
|
|
<td><p>1</p></td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><cite>source</cite></p></td>
|
|
<td><p>Multicast source address (e.g. 1.1.1.1)</p></td>
|
|
<td><p>0.0.0.0 (ASM)</p></td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><cite>zapping-interval</cite></p></td>
|
|
<td><p>IGMP channel zapping interval in seconds</p></td>
|
|
<td><p>0 (disabled)</p></td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><cite>zapping-count</cite></p></td>
|
|
<td><p>Define the number of channel changes before starting the view duration</p></td>
|
|
<td><p>0 (disabled)</p></td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><cite>view-duration</cite></p></td>
|
|
<td><p>Define the view duration in seconds</p></td>
|
|
<td><p>0 (disabled)</p></td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><cite>send-multicast-traffic</cite></p></td>
|
|
<td><p>Generate multicast traffic</p></td>
|
|
<td><p>false</p></td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><cite>multicast-traffic-autostart</cite></p></td>
|
|
<td><p>Automatically start multicast traffic</p></td>
|
|
<td><p>true</p></td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><cite>multicast-traffic-length</cite></p></td>
|
|
<td><p>Multicast traffic IP length</p></td>
|
|
<td><p>76</p></td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><cite>multicast-traffic-tos</cite></p></td>
|
|
<td><p>Multicast traffic TOS priority</p></td>
|
|
<td><p>0</p></td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><cite>multicast-traffic-pps</cite></p></td>
|
|
<td><p>Multicast traffic PPS per group</p></td>
|
|
<td><p>1000</p></td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><cite>network-interface</cite></p></td>
|
|
<td><p>Multicast traffic source interface</p></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><cite>max-join-delay</cite></p></td>
|
|
<td><p>Maximum join delay in milliseconds</p></td>
|
|
<td><p>0 (disabled)</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Per default, join and leave requests are sent using dedicated reports.
|
|
The option <code class="docutils literal notranslate"><span class="pre">combined-leave-join</span></code> allows the combination of leave and
|
|
join records within a single IGMPv3 report using multiple group records.
|
|
This option applies to the IGMP version 3 only!</p>
|
|
<p>If <code class="docutils literal notranslate"><span class="pre">send-multicast-traffic</span></code> is true, the BNG Blaster generates multicast
|
|
traffic on the network interface based on the specified group and source
|
|
attributes mentioned before. This traffic includes some special signatures
|
|
for faster processing and more detailed analysis. This traffic starts
|
|
automatically, which can be suppressed by setting <code class="docutils literal notranslate"><span class="pre">multicast-traffic-autostart</span></code>
|
|
to false. The length, TOS and packets per second (PPS) can be controlled
|
|
with the corresponding options.</p>
|
|
<p>If group is set to 293.0.0.1 with group-iter of 0.0.0.2, source 1.1.1.1
|
|
and group-count 3, the result are the following three groups (S.G)
|
|
1.1.1.1,239.0.0.1, 1.1.1.1,239.0.0.3 and 1.1.1.1,239.0.0.5.</p>
|
|
<p>If <code class="docutils literal notranslate"><span class="pre">max-join-delay</span></code> is configured, the final report includes how often
|
|
the measured join delay is above this threshold.</p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>© Copyright 2020-2023, 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> |