Skip to content

Commit

Permalink
update github pages
Browse files Browse the repository at this point in the history
  • Loading branch information
GIC-de committed Feb 9, 2023
1 parent 2905b14 commit eb19118
Show file tree
Hide file tree
Showing 13 changed files with 249 additions and 55 deletions.
2 changes: 1 addition & 1 deletion docs/_sources/api/sessions.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,4 @@

The argument ``reconnect-delay`` is only applicable in combination with
session reconnect enabled in the configuration. This argument delays the
session reconnect by the defined amount of seconds.
session reconnect by the defined amount of seconds.
3 changes: 3 additions & 0 deletions docs/_sources/configuration/interfaces_access.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,9 @@
* - `igmp-version`
- Overwrite IGMP protocol version (1, 2 or 3)
-
* - `session-group-id`
- Session group identifier
-
* - `stream-group-id`
- Stream group identifier
-
Expand Down
18 changes: 18 additions & 0 deletions docs/_sources/configuration/isis.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,30 @@
* - `level1-auth-type`
- ISIS level 1 authentication type (simple or md5)
- disabled
* - `level1-auth-hello`
- ISIS level 1 hello authentication
- true
* - `level1-auth-csnp`
- ISIS level 1 CSNP authentication
- true
* - `level1-auth-psnp`
- ISIS level 1 PSNP authentication
- true
* - `level2-auth-key`
- ISIS level 2 authentication key
-
* - `level2-auth-type`
- ISIS level 2 authentication type (simple or md5)
- disabled
* - `level2-auth-hello`
- ISIS level 2 hello authentication
- true
* - `level2-auth-csnp`
- ISIS level 2 CSNP authentication
- true
* - `level2-auth-psnp`
- ISIS level 2 PSNP authentication
- true
* - `hello-interval`
- ISIS hello interval in seconds
- 10
Expand Down
6 changes: 5 additions & 1 deletion docs/_sources/configuration/streams.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,11 @@ and inner IPv4 header.

The ``pps`` option supports also float numbers like 0.1, or 2.5 PPS and has
priority over ``bps`` where the second is only a helper to calculate the ``pps``
based on given ``bps`` and ``length``.
based on given ``bps`` and ``length``. The resulting rate in ``bps`` is the
layer 3 rate because ``length`` is also the layer 3 length (IP header + payload).
It is also supported to put the capital letters ``K`` (Kilo), ``M`` (Mega)
or ``G`` (Giga) in front of ``bps`` for better readability.
For example ``"Gbps": 1`` which is equal to ``"bps": 1000000000``.

The options ``access-ipv4-source-address`` and ``access-ipv6-source-address``
can be used to test the BNG RPF functionality with traffic sent from source addresses
Expand Down
48 changes: 43 additions & 5 deletions docs/_sources/interfaces.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ The interfaces section contains all configurations around interface links and op
"interfaces": {
"tx-interval": 0.1,
"rx-interval": 0.1,
"io-slots": 2048,
"io-slots": 4096,
}
}
Expand All @@ -120,7 +120,7 @@ for interface links referenced by interface functions.
"interfaces": {
"tx-interval": 0.1,
"rx-interval": 0.1,
"io-slots": 2048,
"io-slots": 4096,
}
}
Expand Down Expand Up @@ -216,9 +216,9 @@ The configured traffic streams are automatically balanced over all TX threads of
interfaces but a single stream can't be split over multiple threads to prevent re-ordering issues.

Enabling multithreaded I/O causes some limitations. First of all, it works only on systems with
CPU cache coherence, which should apply to all modern CPU architectures. It is also not possible
to bundle (Link Aggregation) multithreaded interfaces. It is also not possible to capture traffic
streams send or received on threaded interfaces. All other traffic is still captured on threaded
CPU cache coherence, which should apply to all modern CPU architectures. TX threads are not allowed
for LAG (Link Aggregation) interfaces but RX threads are supported. It is also not possible to capture
traffic streams send or received on threaded interfaces. All other traffic is still captured on threaded
interfaces.

.. note::
Expand Down Expand Up @@ -425,6 +425,7 @@ or VLAN ranges as shown in the example below.
{
"interface": "eth1",
"type": "pppoe",
"session-group-id": 1,
"username": "pta@rtbrick.com",
"outer-vlan-min": 1000,
"outer-vlan-max": 1999,
Expand All @@ -434,6 +435,7 @@ or VLAN ranges as shown in the example below.
{
"interface": "eth1",
"type": "pppoe",
"session-group-id": 2,
"username": "l2tp@rtbrick.com",
"outer-vlan-min": 2000,
"outer-vlan-max": 2999,
Expand All @@ -443,6 +445,7 @@ or VLAN ranges as shown in the example below.
{
"interface": "eth3",
"type": "pppoe",
"session-group-id": 1,
"username": "test@rtbrick.com",
"outer-vlan-min": 128,
"outer-vlan-max": 4000,
Expand All @@ -452,6 +455,7 @@ or VLAN ranges as shown in the example below.
{
"interface": "eth4",
"type": "ipoe",
"session-group-id": 3,
"outer-vlan-min": 8,
"outer-vlan-max": 9,
"address": "200.0.0.1",
Expand Down Expand Up @@ -498,6 +502,40 @@ section using this mode.
]
}
One or more access interface blocks can be grouped using the ``session-group-id``,
which allows applying some commands like `session-start`, `session-stop` or
`session-restart` to all sessions belonging to the same group. The example
below shows how to assign all even VLAN identifiers to session group 1 and
all odd VLAN identifiers to session group 2.

.. code-block:: json
{
"access": [
{
"interface": "eth1",
"type": "pppoe",
"session-group-id": 1,
"username": "even@rtbrick.com",
"outer-vlan-min": 1000,
"outer-vlan-max": 1998,
"outer-vlan-step": 2,
"inner-vlan": 7
},
{
"interface": "eth1",
"type": "pppoe",
"session-group-id": 2,
"username": "odd@rtbrick.com",
"outer-vlan-min": 1001,
"outer-vlan-max": 1999,
"outer-vlan-step": 2,
"inner-vlan": 7
},
]
}
The BNG Blaster supports access and network interface functions on the same
interface link if both are tagged with disjoint VLAN ranges.

Expand Down
60 changes: 46 additions & 14 deletions docs/configuration/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -561,47 +561,51 @@ <h3>Access Interfaces<a class="headerlink" href="#access-interfaces" title="Perm
<td><p>Overwrite IGMP protocol version (1, 2 or 3)</p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><cite>stream-group-id</cite></p></td>
<tr class="row-odd"><td><p><cite>session-group-id</cite></p></td>
<td><p>Session group identifier</p></td>
<td></td>
</tr>
<tr class="row-even"><td><p><cite>stream-group-id</cite></p></td>
<td><p>Stream group identifier</p></td>
<td></td>
</tr>
<tr class="row-even"><td><p><cite>access-line-profile-id</cite></p></td>
<tr class="row-odd"><td><p><cite>access-line-profile-id</cite></p></td>
<td><p>Access-line-profile identifier</p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><cite>cfm-cc</cite></p></td>
<tr class="row-even"><td><p><cite>cfm-cc</cite></p></td>
<td><p>De-/activate EOAM CFM CC (IPoE only)</p></td>
<td><p>false</p></td>
</tr>
<tr class="row-even"><td><p><cite>cfm-level</cite></p></td>
<tr class="row-odd"><td><p><cite>cfm-level</cite></p></td>
<td><p>Set EOAM CFM maintenance domain level</p></td>
<td><p>0</p></td>
</tr>
<tr class="row-odd"><td><p><cite>cfm-ma-id</cite></p></td>
<tr class="row-even"><td><p><cite>cfm-ma-id</cite></p></td>
<td><p>Set EOAM CFM maintenance association identifier</p></td>
<td><p>0</p></td>
</tr>
<tr class="row-even"><td><p><cite>cfm-ma-name</cite></p></td>
<tr class="row-odd"><td><p><cite>cfm-ma-name</cite></p></td>
<td><p>Set EOAM CFM maintenance association short name</p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><cite>i1-start</cite></p></td>
<tr class="row-even"><td><p><cite>i1-start</cite></p></td>
<td><p>Iterator for usage in strings <cite>{i1}</cite></p></td>
<td><p>1</p></td>
</tr>
<tr class="row-even"><td><p><cite>i1-step</cite></p></td>
<tr class="row-odd"><td><p><cite>i1-step</cite></p></td>
<td><p>Iterator step per session</p></td>
<td><p>1</p></td>
</tr>
<tr class="row-odd"><td><p><cite>i2-start</cite></p></td>
<tr class="row-even"><td><p><cite>i2-start</cite></p></td>
<td><p>Iterator for usage in strings <cite>{i2}</cite></p></td>
<td><p>1</p></td>
</tr>
<tr class="row-even"><td><p><cite>i2-step</cite></p></td>
<tr class="row-odd"><td><p><cite>i2-step</cite></p></td>
<td><p>Iterator step per session</p></td>
<td><p>1</p></td>
</tr>
<tr class="row-odd"><td><p><cite>monkey</cite></p></td>
<tr class="row-even"><td><p><cite>monkey</cite></p></td>
<td><p>Enable monkey testing</p></td>
<td><p>false</p></td>
</tr>
Expand Down Expand Up @@ -1474,7 +1478,11 @@ <h2>Traffic-Streams<a class="headerlink" href="#traffic-streams" title="Permalin
and inner IPv4 header.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">pps</span></code> option supports also float numbers like 0.1, or 2.5 PPS and has
priority over <code class="docutils literal notranslate"><span class="pre">bps</span></code> where the second is only a helper to calculate the <code class="docutils literal notranslate"><span class="pre">pps</span></code>
based on given <code class="docutils literal notranslate"><span class="pre">bps</span></code> and <code class="docutils literal notranslate"><span class="pre">length</span></code>.</p>
based on given <code class="docutils literal notranslate"><span class="pre">bps</span></code> and <code class="docutils literal notranslate"><span class="pre">length</span></code>. The resulting rate in <code class="docutils literal notranslate"><span class="pre">bps</span></code> is the
layer 3 rate because <code class="docutils literal notranslate"><span class="pre">length</span></code> is also the layer 3 length (IP header + payload).
It is also supported to put the capital letters <code class="docutils literal notranslate"><span class="pre">K</span></code> (Kilo), <code class="docutils literal notranslate"><span class="pre">M</span></code> (Mega)
or <code class="docutils literal notranslate"><span class="pre">G</span></code> (Giga) in front of <code class="docutils literal notranslate"><span class="pre">bps</span></code> for better readability.
For example <code class="docutils literal notranslate"><span class="pre">&quot;Gbps&quot;:</span> <span class="pre">1</span></code> which is equal to <code class="docutils literal notranslate"><span class="pre">&quot;bps&quot;:</span> <span class="pre">1000000000</span></code>.</p>
<p>The options <code class="docutils literal notranslate"><span class="pre">access-ipv4-source-address</span></code> and <code class="docutils literal notranslate"><span class="pre">access-ipv6-source-address</span></code>
can be used to test the BNG RPF functionality with traffic sent from source addresses
different than those assigned to the client.</p>
Expand Down Expand Up @@ -1771,14 +1779,38 @@ <h2>ISIS<a class="headerlink" href="#isis" title="Permalink to this headline">
<td><p>ISIS level 1 authentication type (simple or md5)</p></td>
<td><p>disabled</p></td>
</tr>
<tr class="row-odd"><td><p><cite>level2-auth-key</cite></p></td>
<tr class="row-odd"><td><p><cite>level1-auth-hello</cite></p></td>
<td><p>ISIS level 1 hello authentication</p></td>
<td><p>true</p></td>
</tr>
<tr class="row-even"><td><p><cite>level1-auth-csnp</cite></p></td>
<td><p>ISIS level 1 CSNP authentication</p></td>
<td><p>true</p></td>
</tr>
<tr class="row-odd"><td><p><cite>level1-auth-psnp</cite></p></td>
<td><p>ISIS level 1 PSNP authentication</p></td>
<td><p>true</p></td>
</tr>
<tr class="row-even"><td><p><cite>level2-auth-key</cite></p></td>
<td><p>ISIS level 2 authentication key</p></td>
<td></td>
</tr>
<tr class="row-even"><td><p><cite>level2-auth-type</cite></p></td>
<tr class="row-odd"><td><p><cite>level2-auth-type</cite></p></td>
<td><p>ISIS level 2 authentication type (simple or md5)</p></td>
<td><p>disabled</p></td>
</tr>
<tr class="row-even"><td><p><cite>level2-auth-hello</cite></p></td>
<td><p>ISIS level 2 hello authentication</p></td>
<td><p>true</p></td>
</tr>
<tr class="row-odd"><td><p><cite>level2-auth-csnp</cite></p></td>
<td><p>ISIS level 2 CSNP authentication</p></td>
<td><p>true</p></td>
</tr>
<tr class="row-even"><td><p><cite>level2-auth-psnp</cite></p></td>
<td><p>ISIS level 2 PSNP authentication</p></td>
<td><p>true</p></td>
</tr>
<tr class="row-odd"><td><p><cite>hello-interval</cite></p></td>
<td><p>ISIS hello interval in seconds</p></td>
<td><p>10</p></td>
Expand Down
26 changes: 15 additions & 11 deletions docs/configuration/interfaces_access.html
Original file line number Diff line number Diff line change
Expand Up @@ -232,47 +232,51 @@
<td><p>Overwrite IGMP protocol version (1, 2 or 3)</p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><cite>stream-group-id</cite></p></td>
<tr class="row-odd"><td><p><cite>session-group-id</cite></p></td>
<td><p>Session group identifier</p></td>
<td></td>
</tr>
<tr class="row-even"><td><p><cite>stream-group-id</cite></p></td>
<td><p>Stream group identifier</p></td>
<td></td>
</tr>
<tr class="row-even"><td><p><cite>access-line-profile-id</cite></p></td>
<tr class="row-odd"><td><p><cite>access-line-profile-id</cite></p></td>
<td><p>Access-line-profile identifier</p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><cite>cfm-cc</cite></p></td>
<tr class="row-even"><td><p><cite>cfm-cc</cite></p></td>
<td><p>De-/activate EOAM CFM CC (IPoE only)</p></td>
<td><p>false</p></td>
</tr>
<tr class="row-even"><td><p><cite>cfm-level</cite></p></td>
<tr class="row-odd"><td><p><cite>cfm-level</cite></p></td>
<td><p>Set EOAM CFM maintenance domain level</p></td>
<td><p>0</p></td>
</tr>
<tr class="row-odd"><td><p><cite>cfm-ma-id</cite></p></td>
<tr class="row-even"><td><p><cite>cfm-ma-id</cite></p></td>
<td><p>Set EOAM CFM maintenance association identifier</p></td>
<td><p>0</p></td>
</tr>
<tr class="row-even"><td><p><cite>cfm-ma-name</cite></p></td>
<tr class="row-odd"><td><p><cite>cfm-ma-name</cite></p></td>
<td><p>Set EOAM CFM maintenance association short name</p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><cite>i1-start</cite></p></td>
<tr class="row-even"><td><p><cite>i1-start</cite></p></td>
<td><p>Iterator for usage in strings <cite>{i1}</cite></p></td>
<td><p>1</p></td>
</tr>
<tr class="row-even"><td><p><cite>i1-step</cite></p></td>
<tr class="row-odd"><td><p><cite>i1-step</cite></p></td>
<td><p>Iterator step per session</p></td>
<td><p>1</p></td>
</tr>
<tr class="row-odd"><td><p><cite>i2-start</cite></p></td>
<tr class="row-even"><td><p><cite>i2-start</cite></p></td>
<td><p>Iterator for usage in strings <cite>{i2}</cite></p></td>
<td><p>1</p></td>
</tr>
<tr class="row-even"><td><p><cite>i2-step</cite></p></td>
<tr class="row-odd"><td><p><cite>i2-step</cite></p></td>
<td><p>Iterator step per session</p></td>
<td><p>1</p></td>
</tr>
<tr class="row-odd"><td><p><cite>monkey</cite></p></td>
<tr class="row-even"><td><p><cite>monkey</cite></p></td>
<td><p>Enable monkey testing</p></td>
<td><p>false</p></td>
</tr>
Expand Down
28 changes: 26 additions & 2 deletions docs/configuration/isis.html
Original file line number Diff line number Diff line change
Expand Up @@ -120,14 +120,38 @@
<td><p>ISIS level 1 authentication type (simple or md5)</p></td>
<td><p>disabled</p></td>
</tr>
<tr class="row-odd"><td><p><cite>level2-auth-key</cite></p></td>
<tr class="row-odd"><td><p><cite>level1-auth-hello</cite></p></td>
<td><p>ISIS level 1 hello authentication</p></td>
<td><p>true</p></td>
</tr>
<tr class="row-even"><td><p><cite>level1-auth-csnp</cite></p></td>
<td><p>ISIS level 1 CSNP authentication</p></td>
<td><p>true</p></td>
</tr>
<tr class="row-odd"><td><p><cite>level1-auth-psnp</cite></p></td>
<td><p>ISIS level 1 PSNP authentication</p></td>
<td><p>true</p></td>
</tr>
<tr class="row-even"><td><p><cite>level2-auth-key</cite></p></td>
<td><p>ISIS level 2 authentication key</p></td>
<td></td>
</tr>
<tr class="row-even"><td><p><cite>level2-auth-type</cite></p></td>
<tr class="row-odd"><td><p><cite>level2-auth-type</cite></p></td>
<td><p>ISIS level 2 authentication type (simple or md5)</p></td>
<td><p>disabled</p></td>
</tr>
<tr class="row-even"><td><p><cite>level2-auth-hello</cite></p></td>
<td><p>ISIS level 2 hello authentication</p></td>
<td><p>true</p></td>
</tr>
<tr class="row-odd"><td><p><cite>level2-auth-csnp</cite></p></td>
<td><p>ISIS level 2 CSNP authentication</p></td>
<td><p>true</p></td>
</tr>
<tr class="row-even"><td><p><cite>level2-auth-psnp</cite></p></td>
<td><p>ISIS level 2 PSNP authentication</p></td>
<td><p>true</p></td>
</tr>
<tr class="row-odd"><td><p><cite>hello-interval</cite></p></td>
<td><p>ISIS hello interval in seconds</p></td>
<td><p>10</p></td>
Expand Down
6 changes: 5 additions & 1 deletion docs/configuration/streams.html
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,11 @@
and inner IPv4 header.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">pps</span></code> option supports also float numbers like 0.1, or 2.5 PPS and has
priority over <code class="docutils literal notranslate"><span class="pre">bps</span></code> where the second is only a helper to calculate the <code class="docutils literal notranslate"><span class="pre">pps</span></code>
based on given <code class="docutils literal notranslate"><span class="pre">bps</span></code> and <code class="docutils literal notranslate"><span class="pre">length</span></code>.</p>
based on given <code class="docutils literal notranslate"><span class="pre">bps</span></code> and <code class="docutils literal notranslate"><span class="pre">length</span></code>. The resulting rate in <code class="docutils literal notranslate"><span class="pre">bps</span></code> is the
layer 3 rate because <code class="docutils literal notranslate"><span class="pre">length</span></code> is also the layer 3 length (IP header + payload).
It is also supported to put the capital letters <code class="docutils literal notranslate"><span class="pre">K</span></code> (Kilo), <code class="docutils literal notranslate"><span class="pre">M</span></code> (Mega)
or <code class="docutils literal notranslate"><span class="pre">G</span></code> (Giga) in front of <code class="docutils literal notranslate"><span class="pre">bps</span></code> for better readability.
For example <code class="docutils literal notranslate"><span class="pre">&quot;Gbps&quot;:</span> <span class="pre">1</span></code> which is equal to <code class="docutils literal notranslate"><span class="pre">&quot;bps&quot;:</span> <span class="pre">1000000000</span></code>.</p>
<p>The options <code class="docutils literal notranslate"><span class="pre">access-ipv4-source-address</span></code> and <code class="docutils literal notranslate"><span class="pre">access-ipv6-source-address</span></code>
can be used to test the BNG RPF functionality with traffic sent from source addresses
different than those assigned to the client.</p>
Expand Down
Loading

0 comments on commit eb19118

Please sign in to comment.