github pages

rtbrick · Dec 21, 2023 · bbbc194 · bbbc194
1 parent 4b28ba1
commit bbbc194
Show file tree

Hide file tree

Showing 10 changed files with 111 additions and 53 deletions.
diff --git a/docs/_sources/api/streams.rst.txt b/docs/_sources/api/streams.rst.txt
@@ -10,15 +10,17 @@
 +-----------------------------------+----------------------------------------------------------------------+
 | **stream-summary**                | | Display stream/flow summary information.                           |
 +-----------------------------------+----------------------------------------------------------------------+
-| **stream-traffic-start**          | | Enable/start traffic streams.                                      |
+| **stream-traffic-start**          | | Enable/start traffic streams bound to sessions.                    |
 |                                   | |                                                                    |
 |                                   | | **Arguments:**                                                     |
 |                                   | | ``session-id``                                                     |
+|                                   | | ``session-group-id``                                               |
 +-----------------------------------+----------------------------------------------------------------------+
-| **stream-traffic-stop**           | | Disable/stop traffic streams.                                      |
+| **stream-traffic-stop**           | | Disable/stop traffic streams bound to sessions.                    |
 |                                   | |                                                                    |
 |                                   | | **Arguments:**                                                     |
 |                                   | | ``session-id``                                                     |
+|                                   | | ``session-group-id``                                               |
 +-----------------------------------+----------------------------------------------------------------------+
 | **stream-reset**                  | | Reset all traffic streams.                                         |
 +-----------------------------------+----------------------------------------------------------------------+

diff --git a/docs/_sources/configuration/bgp.rst.txt b/docs/_sources/configuration/bgp.rst.txt
@@ -8,13 +8,13 @@
 | **network-interface**             | | BGP local interface (source interface).                            |
 |                                   | | Default: `first network interface from configuration`              |
 +-----------------------------------+----------------------------------------------------------------------+
-| **local-ipv4-address**            | | BGP local IPv4 address (source address).                           |
+| **local-address**                 | | BGP local IPv4/6 address (source address).                         |
 |                                   | | Default: `network interface address`                               |
 +-----------------------------------+----------------------------------------------------------------------+
 | **local-as**                      | | BGP local AS.                                                      |
 |                                   | | Default: 65000 Range: 0 - 4294967295                               |
 +-----------------------------------+----------------------------------------------------------------------+
-| **peer-ipv4-address**             | | Mandatory BGP peer address.                                        |
+| **peer-address**                  | | Mandatory BGP peer IPv4/6 address.                                 |
 +-----------------------------------+----------------------------------------------------------------------+
 | **peer-as**                       | | BGP peer AS.                                                       |
 |                                   | | Default: `local AS` Range: 0 - 4294967295                          |
@@ -43,4 +43,18 @@
 |                                   | | Default: 5 Range: 0 - 65535                                        |
 +-----------------------------------+----------------------------------------------------------------------+
 | **raw-update-file**               | | BGP RAW update file.                                               |
++-----------------------------------+----------------------------------------------------------------------+
+| **family**                        | | BGP families to be send in open message.                           |
+|                                   | | Default: ipv4/6-unicast, ipv4/6-labeled-unicast                    |
+|                                   | | Values:                                                            |
+|                                   | | ipv4-unicast, ipv6-unicast,                                        |
+|                                   | | ipv4-multicast, ipv6-multicast,                                    |
+|                                   | | ipv4-labeled-unicast, ipv6-labeled-unicast,                        |
+|                                   | | ipv4-vpn-unicast, ipv6-vpn-unicast,                                |
+|                                   | | ipv4-vpn-multicast, ipv6-vpn-multicast,                            |
+|                                   | | ipv4-flow, ipv6-flow, evpn                                         |
++-----------------------------------+----------------------------------------------------------------------+
+| **extended-nexthop**              | | BGP extended-nexthop families to be send in open message.          |
+|                                   | | Default: None                                                      |
+|                                   | | Values: ipv4-unicast, ipv4-vpn-unicast                             |
 +-----------------------------------+----------------------------------------------------------------------+
diff --git a/docs/_sources/install.rst.txt b/docs/_sources/install.rst.txt
@@ -33,25 +33,11 @@ Build from Sources
 Dependencies
 ^^^^^^^^^^^^
 
-The BNG Blaster has dependencies on the RtBrick
-`libdict fork <https://github.com/rtbrick/libdict>`_
-and the following standard dependencies:
+The BNG Blaster has the following dependcancies:
 
 .. code-block:: none
 
-    # install libdict for Ubuntu 18.04 LTS
-    wget https://github.com/rtbrick/libdict/releases/download/v1.0.1/libdict-debian.zip
-    unzip libdict-debian.zip
-    sudo dpkg -i libdict_1.0.1_amd64.deb
-    sudo dpkg -i libdict-dev_1.0.1_amd64.deb
-
-    # install libdict for Ubuntu 22.04 LTS
-    wget https://github.com/rtbrick/libdict/releases/download/1.0.3/libdict-ubuntu-22.04.zip
-    unzip libdict-ubuntu-22.04.zip
-    sudo dpkg -i libdict_1.0.3_amd64.deb
-    sudo dpkg -i libdict-dev_1.0.3_amd64.deb
-
-    # install other dependencies
+    # install dependencies
     sudo apt install -y cmake \
         libpcap-dev \
         libcunit1-dev \

diff --git a/docs/api/index.html b/docs/api/index.html
@@ -739,19 +739,21 @@ <h2>Streams<a class="headerlink" href="#streams" title="Permalink to this headli
 </tr>
 <tr class="row-odd"><td><p><strong>stream-traffic-start</strong></p></td>
 <td><div class="line-block">
-<div class="line">Enable/start traffic streams.</div>
+<div class="line">Enable/start traffic streams bound to sessions.</div>
 <div class="line"><br /></div>
 <div class="line"><strong>Arguments:</strong></div>
 <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></div>
 </div>
 </td>
 </tr>
 <tr class="row-even"><td><p><strong>stream-traffic-stop</strong></p></td>
 <td><div class="line-block">
-<div class="line">Disable/stop traffic streams.</div>
+<div class="line">Disable/stop traffic streams bound to sessions.</div>
 <div class="line"><br /></div>
 <div class="line"><strong>Arguments:</strong></div>
 <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></div>
 </div>
 </td>
 </tr>

diff --git a/docs/api/streams.html b/docs/api/streams.html
@@ -111,19 +111,21 @@
 </tr>
 <tr class="row-odd"><td><p><strong>stream-traffic-start</strong></p></td>
 <td><div class="line-block">
-<div class="line">Enable/start traffic streams.</div>
+<div class="line">Enable/start traffic streams bound to sessions.</div>
 <div class="line"><br /></div>
 <div class="line"><strong>Arguments:</strong></div>
 <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></div>
 </div>
 </td>
 </tr>
 <tr class="row-even"><td><p><strong>stream-traffic-stop</strong></p></td>
 <td><div class="line-block">
-<div class="line">Disable/stop traffic streams.</div>
+<div class="line">Disable/stop traffic streams bound to sessions.</div>
 <div class="line"><br /></div>
 <div class="line"><strong>Arguments:</strong></div>
 <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></div>
 </div>
 </td>
 </tr>

diff --git a/docs/configuration/bgp.html b/docs/configuration/bgp.html
@@ -98,9 +98,9 @@
 </div>
 </td>
 </tr>
-<tr class="row-odd"><td><p><strong>local-ipv4-address</strong></p></td>
+<tr class="row-odd"><td><p><strong>local-address</strong></p></td>
 <td><div class="line-block">
-<div class="line">BGP local IPv4 address (source address).</div>
+<div class="line">BGP local IPv4/6 address (source address).</div>
 <div class="line">Default: <cite>network interface address</cite></div>
 </div>
 </td>
@@ -112,9 +112,9 @@
 </div>
 </td>
 </tr>
-<tr class="row-odd"><td><p><strong>peer-ipv4-address</strong></p></td>
+<tr class="row-odd"><td><p><strong>peer-address</strong></p></td>
 <td><div class="line-block">
-<div class="line">Mandatory BGP peer address.</div>
+<div class="line">Mandatory BGP peer IPv4/6 address.</div>
 </div>
 </td>
 </tr>
@@ -182,6 +182,28 @@
 </div>
 </td>
 </tr>
+<tr class="row-odd"><td><p><strong>family</strong></p></td>
+<td><div class="line-block">
+<div class="line">BGP families to be send in open message.</div>
+<div class="line">Default: ipv4/6-unicast, ipv4/6-labeled-unicast</div>
+<div class="line">Values:</div>
+<div class="line">ipv4-unicast, ipv6-unicast,</div>
+<div class="line">ipv4-multicast, ipv6-multicast,</div>
+<div class="line">ipv4-labeled-unicast, ipv6-labeled-unicast,</div>
+<div class="line">ipv4-vpn-unicast, ipv6-vpn-unicast,</div>
+<div class="line">ipv4-vpn-multicast, ipv6-vpn-multicast,</div>
+<div class="line">ipv4-flow, ipv6-flow, evpn</div>
+</div>
+</td>
+</tr>
+<tr class="row-even"><td><p><strong>extended-nexthop</strong></p></td>
+<td><div class="line-block">
+<div class="line">BGP extended-nexthop families to be send in open message.</div>
+<div class="line">Default: None</div>
+<div class="line">Values: ipv4-unicast, ipv4-vpn-unicast</div>
+</div>
+</td>
+</tr>
 </tbody>
 </table>
 

diff --git a/docs/configuration/index.html b/docs/configuration/index.html
@@ -3300,9 +3300,9 @@ <h2>BGP<a class="headerlink" href="#bgp" title="Permalink to this headline"><
 </div>
 </td>
 </tr>
-<tr class="row-odd"><td><p><strong>local-ipv4-address</strong></p></td>
+<tr class="row-odd"><td><p><strong>local-address</strong></p></td>
 <td><div class="line-block">
-<div class="line">BGP local IPv4 address (source address).</div>
+<div class="line">BGP local IPv4/6 address (source address).</div>
 <div class="line">Default: <cite>network interface address</cite></div>
 </div>
 </td>
@@ -3314,9 +3314,9 @@ <h2>BGP<a class="headerlink" href="#bgp" title="Permalink to this headline"><
 </div>
 </td>
 </tr>
-<tr class="row-odd"><td><p><strong>peer-ipv4-address</strong></p></td>
+<tr class="row-odd"><td><p><strong>peer-address</strong></p></td>
 <td><div class="line-block">
-<div class="line">Mandatory BGP peer address.</div>
+<div class="line">Mandatory BGP peer IPv4/6 address.</div>
 </div>
 </td>
 </tr>
@@ -3384,6 +3384,28 @@ <h2>BGP<a class="headerlink" href="#bgp" title="Permalink to this headline"><
 </div>
 </td>
 </tr>
+<tr class="row-odd"><td><p><strong>family</strong></p></td>
+<td><div class="line-block">
+<div class="line">BGP families to be send in open message.</div>
+<div class="line">Default: ipv4/6-unicast, ipv4/6-labeled-unicast</div>
+<div class="line">Values:</div>
+<div class="line">ipv4-unicast, ipv6-unicast,</div>
+<div class="line">ipv4-multicast, ipv6-multicast,</div>
+<div class="line">ipv4-labeled-unicast, ipv6-labeled-unicast,</div>
+<div class="line">ipv4-vpn-unicast, ipv6-vpn-unicast,</div>
+<div class="line">ipv4-vpn-multicast, ipv6-vpn-multicast,</div>
+<div class="line">ipv4-flow, ipv6-flow, evpn</div>
+</div>
+</td>
+</tr>
+<tr class="row-even"><td><p><strong>extended-nexthop</strong></p></td>
+<td><div class="line-block">
+<div class="line">BGP extended-nexthop families to be send in open message.</div>
+<div class="line">Default: None</div>
+<div class="line">Values: ipv4-unicast, ipv4-vpn-unicast</div>
+</div>
+</td>
+</tr>
 </tbody>
 </table>
 </section>

diff --git a/docs/install.html b/docs/install.html
@@ -114,22 +114,8 @@ <h2>Install Ubuntu<a class="headerlink" href="#install-ubuntu" title="Permalink
 <h2>Build from Sources<a class="headerlink" href="#build-from-sources" title="Permalink to this headline"></a></h2>
 <section id="dependencies">
 <h3>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to this headline"></a></h3>
-<p>The BNG Blaster has dependencies on the RtBrick
-<a class="reference external" href="https://github.com/rtbrick/libdict">libdict fork</a>
-and the following standard dependencies:</p>
-<div class="highlight-none notranslate"><div class="highlight"><pre><span></span># install libdict for Ubuntu 18.04 LTS
-wget https://github.com/rtbrick/libdict/releases/download/v1.0.1/libdict-debian.zip
-unzip libdict-debian.zip
-sudo dpkg -i libdict_1.0.1_amd64.deb
-sudo dpkg -i libdict-dev_1.0.1_amd64.deb
-
-# install libdict for Ubuntu 22.04 LTS
-wget https://github.com/rtbrick/libdict/releases/download/1.0.3/libdict-ubuntu-22.04.zip
-unzip libdict-ubuntu-22.04.zip
-sudo dpkg -i libdict_1.0.3_amd64.deb
-sudo dpkg -i libdict-dev_1.0.3_amd64.deb
-
-# install other dependencies
+<p>The BNG Blaster has the following dependcancies:</p>
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span># install dependencies
 sudo apt install -y cmake \
     libpcap-dev \
     libcunit1-dev \

diff --git a/docs/routing/bgp.html b/docs/routing/bgp.html
@@ -148,9 +148,9 @@ <h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to
 </div>
 </td>
 </tr>
-<tr class="row-odd"><td><p><strong>local-ipv4-address</strong></p></td>
+<tr class="row-odd"><td><p><strong>local-address</strong></p></td>
 <td><div class="line-block">
-<div class="line">BGP local IPv4 address (source address).</div>
+<div class="line">BGP local IPv4/6 address (source address).</div>
 <div class="line">Default: <cite>network interface address</cite></div>
 </div>
 </td>
@@ -162,9 +162,9 @@ <h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to
 </div>
 </td>
 </tr>
-<tr class="row-odd"><td><p><strong>peer-ipv4-address</strong></p></td>
+<tr class="row-odd"><td><p><strong>peer-address</strong></p></td>
 <td><div class="line-block">
-<div class="line">Mandatory BGP peer address.</div>
+<div class="line">Mandatory BGP peer IPv4/6 address.</div>
 </div>
 </td>
 </tr>
@@ -232,6 +232,28 @@ <h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to
 </div>
 </td>
 </tr>
+<tr class="row-odd"><td><p><strong>family</strong></p></td>
+<td><div class="line-block">
+<div class="line">BGP families to be send in open message.</div>
+<div class="line">Default: ipv4/6-unicast, ipv4/6-labeled-unicast</div>
+<div class="line">Values:</div>
+<div class="line">ipv4-unicast, ipv6-unicast,</div>
+<div class="line">ipv4-multicast, ipv6-multicast,</div>
+<div class="line">ipv4-labeled-unicast, ipv6-labeled-unicast,</div>
+<div class="line">ipv4-vpn-unicast, ipv6-vpn-unicast,</div>
+<div class="line">ipv4-vpn-multicast, ipv6-vpn-multicast,</div>
+<div class="line">ipv4-flow, ipv6-flow, evpn</div>
+</div>
+</td>
+</tr>
+<tr class="row-even"><td><p><strong>extended-nexthop</strong></p></td>
+<td><div class="line-block">
+<div class="line">BGP extended-nexthop families to be send in open message.</div>
+<div class="line">Default: None</div>
+<div class="line">Values: ipv4-unicast, ipv4-vpn-unicast</div>
+</div>
+</td>
+</tr>
 </tbody>
 </table>
 </section>

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