update github pages

rtbrick · Feb 14, 2023 · 2c5bf68 · 2c5bf68
1 parent 5b2ee98
commit 2c5bf68
Show file tree

Hide file tree

Showing 6 changed files with 126 additions and 9 deletions.
diff --git a/docs/_sources/api/sessions.rst.txt b/docs/_sources/api/sessions.rst.txt
@@ -29,6 +29,10 @@
      - Disable/stop session traffic
      - 
      - `session-id`
+   * - `session-traffic-reset`
+     - Reset all session traffic streams
+     - 
+     - 
    * - `session-streams`
      - Display session streams
      - `session-id`

diff --git a/docs/_sources/quickstart.rst.txt b/docs/_sources/quickstart.rst.txt
@@ -711,3 +711,57 @@ Now you can start the BNG Blaster with this configuration.
 
     sudo bngblaster -C ldp.json -l ldp -S run.sock -P ldp.pcap
 
+
+Network Traffic
+---------------
+
+In the following example, we create two connected network interfaces 
+and set up RAW traffic streams between them.
+
+**network.json:**
+
+.. code-block:: json
+
+    {
+        "interfaces": {
+            "network": [
+                {
+                    "interface": "veth1.1",
+                    "address": "192.168.0.1/24",
+                    "gateway": "192.168.0.2"
+                },
+                {
+                    "interface": "veth1.2",
+                    "address": "192.168.0.2/24",
+                    "gateway": "192.168.0.1"
+                }
+            ]
+        },
+        "streams": [
+            {
+                "name": "S1",
+                "type": "ipv4",
+                "pps": 1,
+                "network-interface": "veth1.1",
+                "destination-ipv4-address": "192.168.0.2"
+            },
+            {
+                "name": "S2",
+                "type": "ipv4",
+                "pps": 1,
+                "network-interface": "veth1.2",
+                "destination-ipv4-address": "192.168.0.1"
+            }
+        ]
+    }
+
+Now you can start the BNG Blaster with stream reports enabled to get extensive
+result of every single stream at the end of the test.
+
+.. code-block:: none
+    
+    $ sudo bngblaster -C network.json -l loss -J report.json -j streams -S run.sock -I
+
+Such a configuration with two network interfaces in the same network can be used to 
+test layer two network QoS configurations or filters. The same would also work through
+a routed network with two network interfaces in different networks. 
diff --git a/docs/api/index.html b/docs/api/index.html
@@ -348,22 +348,27 @@ <h2>Sessions<a class="headerlink" href="#sessions" title="Permalink to this head
 <td></td>
 <td><p><cite>session-id</cite></p></td>
 </tr>
-<tr class="row-even"><td><p><cite>session-streams</cite></p></td>
+<tr class="row-even"><td><p><cite>session-traffic-reset</cite></p></td>
+<td><p>Reset all session traffic streams</p></td>
+<td></td>
+<td></td>
+</tr>
+<tr class="row-odd"><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>session-start</cite></p></td>
+<tr class="row-even"><td><p><cite>session-start</cite></p></td>
 <td><p>Start session manually</p></td>
 <td></td>
 <td><p><cite>session-id</cite>, <cite>session-group-id</cite></p></td>
 </tr>
-<tr class="row-even"><td><p><cite>session-stop</cite></p></td>
+<tr class="row-odd"><td><p><cite>session-stop</cite></p></td>
 <td><p>Stop sessions manually</p></td>
 <td></td>
 <td><p><cite>session-id</cite>, <cite>session-group-id</cite>, <cite>reconnect-delay</cite></p></td>
 </tr>
-<tr class="row-odd"><td><p><cite>session-restart</cite></p></td>
+<tr class="row-even"><td><p><cite>session-restart</cite></p></td>
 <td><p>Restart sessions manually</p></td>
 <td></td>
 <td><p><cite>session-id</cite>, <cite>session-group-id</cite>, <cite>reconnect-delay</cite></p></td>

diff --git a/docs/api/sessions.html b/docs/api/sessions.html
@@ -121,22 +121,27 @@
 <td></td>
 <td><p><cite>session-id</cite></p></td>
 </tr>
-<tr class="row-even"><td><p><cite>session-streams</cite></p></td>
+<tr class="row-even"><td><p><cite>session-traffic-reset</cite></p></td>
+<td><p>Reset all session traffic streams</p></td>
+<td></td>
+<td></td>
+</tr>
+<tr class="row-odd"><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>session-start</cite></p></td>
+<tr class="row-even"><td><p><cite>session-start</cite></p></td>
 <td><p>Start session manually</p></td>
 <td></td>
 <td><p><cite>session-id</cite>, <cite>session-group-id</cite></p></td>
 </tr>
-<tr class="row-even"><td><p><cite>session-stop</cite></p></td>
+<tr class="row-odd"><td><p><cite>session-stop</cite></p></td>
 <td><p>Stop sessions manually</p></td>
 <td></td>
 <td><p><cite>session-id</cite>, <cite>session-group-id</cite>, <cite>reconnect-delay</cite></p></td>
 </tr>
-<tr class="row-odd"><td><p><cite>session-restart</cite></p></td>
+<tr class="row-even"><td><p><cite>session-restart</cite></p></td>
 <td><p>Restart sessions manually</p></td>
 <td></td>
 <td><p><cite>session-id</cite>, <cite>session-group-id</cite>, <cite>reconnect-delay</cite></p></td>

diff --git a/docs/quickstart.html b/docs/quickstart.html
@@ -47,6 +47,7 @@
 <li class="toctree-l2"><a class="reference internal" href="#isis">ISIS</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#bgp">BGP</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#ldp">LDP</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#network-traffic">Network Traffic</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="interfaces.html">Interfaces</a></li>
@@ -714,6 +715,54 @@ <h2>LDP<a class="headerlink" href="#ldp" title="Permalink to this headline"><
 </pre></div>
 </div>
 </section>
+<section id="network-traffic">
+<h2>Network Traffic<a class="headerlink" href="#network-traffic" title="Permalink to this headline"></a></h2>
+<p>In the following example, we create two connected network interfaces
+and set up RAW traffic streams between them.</p>
+<p><strong>network.json:</strong></p>
+<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="w"></span>
+<span class="w">    </span><span class="nt">&quot;interfaces&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
+<span class="w">        </span><span class="nt">&quot;network&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w"></span>
+<span class="w">            </span><span class="p">{</span><span class="w"></span>
+<span class="w">                </span><span class="nt">&quot;interface&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;veth1.1&quot;</span><span class="p">,</span><span class="w"></span>
+<span class="w">                </span><span class="nt">&quot;address&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;192.168.0.1/24&quot;</span><span class="p">,</span><span class="w"></span>
+<span class="w">                </span><span class="nt">&quot;gateway&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;192.168.0.2&quot;</span><span class="w"></span>
+<span class="w">            </span><span class="p">},</span><span class="w"></span>
+<span class="w">            </span><span class="p">{</span><span class="w"></span>
+<span class="w">                </span><span class="nt">&quot;interface&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;veth1.2&quot;</span><span class="p">,</span><span class="w"></span>
+<span class="w">                </span><span class="nt">&quot;address&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;192.168.0.2/24&quot;</span><span class="p">,</span><span class="w"></span>
+<span class="w">                </span><span class="nt">&quot;gateway&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;192.168.0.1&quot;</span><span class="w"></span>
+<span class="w">            </span><span class="p">}</span><span class="w"></span>
+<span class="w">        </span><span class="p">]</span><span class="w"></span>
+<span class="w">    </span><span class="p">},</span><span class="w"></span>
+<span class="w">    </span><span class="nt">&quot;streams&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w"></span>
+<span class="w">        </span><span class="p">{</span><span class="w"></span>
+<span class="w">            </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;S1&quot;</span><span class="p">,</span><span class="w"></span>
+<span class="w">            </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;ipv4&quot;</span><span class="p">,</span><span class="w"></span>
+<span class="w">            </span><span class="nt">&quot;pps&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"></span>
+<span class="w">            </span><span class="nt">&quot;network-interface&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;veth1.1&quot;</span><span class="p">,</span><span class="w"></span>
+<span class="w">            </span><span class="nt">&quot;destination-ipv4-address&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;192.168.0.2&quot;</span><span class="w"></span>
+<span class="w">        </span><span class="p">},</span><span class="w"></span>
+<span class="w">        </span><span class="p">{</span><span class="w"></span>
+<span class="w">            </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;S2&quot;</span><span class="p">,</span><span class="w"></span>
+<span class="w">            </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;ipv4&quot;</span><span class="p">,</span><span class="w"></span>
+<span class="w">            </span><span class="nt">&quot;pps&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"></span>
+<span class="w">            </span><span class="nt">&quot;network-interface&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;veth1.2&quot;</span><span class="p">,</span><span class="w"></span>
+<span class="w">            </span><span class="nt">&quot;destination-ipv4-address&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;192.168.0.1&quot;</span><span class="w"></span>
+<span class="w">        </span><span class="p">}</span><span class="w"></span>
+<span class="w">    </span><span class="p">]</span><span class="w"></span>
+<span class="p">}</span><span class="w"></span>
+</pre></div>
+</div>
+<p>Now you can start the BNG Blaster with stream reports enabled to get extensive
+result of every single stream at the end of the test.</p>
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>$ sudo bngblaster -C network.json -l loss -J report.json -j streams -S run.sock -I
+</pre></div>
+</div>
+<p>Such a configuration with two network interfaces in the same network can be used to
+test layer two network QoS configurations or filters. The same would also work through
+a routed network with two network interfaces in different networks.</p>
+</section>
 </section>
 
 

diff --git a/docs/searchindex.js b/docs/searchindex.js