Skip to content

Commit

Permalink
PAGES: update config tables
Browse files Browse the repository at this point in the history
  • Loading branch information
GIC-de committed Nov 3, 2023
1 parent 16a8ffe commit 8c89bfe
Show file tree
Hide file tree
Showing 32 changed files with 1,745 additions and 1,059 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ on:
push:
paths-ignore:
- 'docs/**'
branches-ignore:
- pages

env:
BUILD_TYPE: Release
Expand Down
4 changes: 4 additions & 0 deletions docs/_sources/api/streams.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,8 @@
* - `stream-reset`
- Reset all traffic streams
-
-
* - `streams-pending`
- List flow-id of all pending (not verfied) traffic streams
-
-
58 changes: 34 additions & 24 deletions docs/_sources/configuration/access_line.rst.txt
Original file line number Diff line number Diff line change
@@ -1,30 +1,40 @@
This feature is designed to simulate various access line attributes defined by the Broadband Forum,
which are subsequently employed in protocols such as PPPoE discovery, DHCPv4, and DHCPv6 packets.

The values defined in ``access-line`` section apply globally but can be overwritten in the
access interface section. The strings agent-remote-id, agent-circuit-id, and
access-aggregation-circuit-id support :ref:`variable substitution <variables>`.

.. code-block:: json
{ "access-line": {} }
+-----------------------------------+----------------------------------------------------------------------+
| Attribute | Description |
+===================================+======================================================================+
| ``agent-circuit-id`` | | Agent-Circuit-Id (string). |
+-----------------------------------+----------------------------------------------------------------------+
| ``agent-remote-id`` | | Agent-Remote-Id (string). |
+-----------------------------------+----------------------------------------------------------------------+
| ``access-aggregation-circuit-id`` | | Access-Aggregation-Circuit-ID-ASCII (string). |
+-----------------------------------+----------------------------------------------------------------------+
| ``rate-up`` | | Actual Data Rate Upstream. |
| | | Default: 0 Range: 0 - 4294967295 |
+-----------------------------------+----------------------------------------------------------------------+
| ``rate-down`` | | Actual Data Rate Downstream. |
| | | Default: 0 Range: 0 - 4294967295 |
+-----------------------------------+----------------------------------------------------------------------+
| ``dsl-type`` | | DSL-Type. |
| | | Default: 0 Range: 0 - 4294967295 |
+-----------------------------------+----------------------------------------------------------------------+

.. list-table::
:widths: 25 50 25
:header-rows: 1
Attributes with values set to zero will be automatically excluded,
making it impossible to send attributes with a zero value. In other words,
any attribute that has a value of zero will not be included in the corresponding
packets.

* - Attribute
- Description
- Default
* - `agent-circuit-id`
- Agent-Circuit-Id
-
* - `agent-remote-id`
- Agent-Remote-Id
-
* - `access-aggregation-circuit-id`
- Access-Aggregation-Circuit-ID-ASCII
-
* - `rate-up`
- Actual Data Rate Upstream
-
* - `rate-down`
- Actual Data Rate Downstream
-
* - `dsl-type`
- DSL-Type
-
In the context of DHCPv6, access line attributes, as well as Agent-Remote-Id or Agent-Circuit-Id,
are exclusively permitted in DHCPv6 relay-forward messages as dictated by RFC. By default, BNG Blaster
includes these attributes in other DHCPv6 messages, even if this deviates from RFC guidelines.
Therefore, the DHCPv6 configuration section provides the option to either disable access-line attributes or,
as an alternative, enable LDRA (Lightweight DHCPv6 Relay Agent).
225 changes: 114 additions & 111 deletions docs/_sources/configuration/access_line_profiles.rst.txt
Original file line number Diff line number Diff line change
@@ -1,116 +1,119 @@
Attributes within the ``access-line-profiles`` are treated analogous to those within the
``access-line`` section but they provide the capability to apply different profiles to
each access interface.

.. code-block:: json
{ "access-line-profiles": [] }
+-----------------------------------+----------------------------------------------------------------------+
| Attribute | Description |
+===================================+======================================================================+
| ``access-line-profile-id`` | | Mandatory access-line-profile identifier. |
| | | Range: 0 - 65535 |
+-----------------------------------+----------------------------------------------------------------------+
| ``act-up`` | | Actual Data Rate Upstream. |
| | | This value is overwritten by ``rate-up``. |
| | | Default: 0 Range: 0 - 4294967295 |
+-----------------------------------+----------------------------------------------------------------------+
| ``act-down`` | | Actual Data Rate Downstream. |
| | | This value is overwritten by ``rate-down`` |
| | | Default: 0 Range: 0 - 4294967295 |
+-----------------------------------+----------------------------------------------------------------------+
| ``min-up`` | | Minimum Data Rate Upstream. |
| | | Default: 0 Range: 0 - 4294967295 |
+-----------------------------------+----------------------------------------------------------------------+
| ``min-down`` | | Minimum Data Rate Downstream. |
| | | Default: 0 Range: 0 - 4294967295 |
+-----------------------------------+----------------------------------------------------------------------+
| ``att-up`` | | Attainable DataRate Upstream. |
| | | Default: 0 Range: 0 - 4294967295 |
+-----------------------------------+----------------------------------------------------------------------+
| ``att-down`` | | Attainable DataRate Downstream. |
| | | Default: 0 Range: 0 - 4294967295 |
+-----------------------------------+----------------------------------------------------------------------+
| ``max-up`` | | Maximum Data Rate Upstream. |
| | | Default: 0 Range: 0 - 4294967295 |
+-----------------------------------+----------------------------------------------------------------------+
| ``max-down`` | | Maximum Data Rate Downstream. |
| | | Default: 0 Range: 0 - 4294967295 |
+-----------------------------------+----------------------------------------------------------------------+
| ``min-up-low`` | | Min Data Rate Upstream.in low power state |
| | | Default: 0 Range: 0 - 4294967295 |
+-----------------------------------+----------------------------------------------------------------------+
| ``min-down-low`` | | Min Data Rate Downstream.in low power state |
| | | Default: 0 Range: 0 - 4294967295 |
+-----------------------------------+----------------------------------------------------------------------+
| ``max-interl-delay-up`` | | Max Interleaving Delay Upstream. |
| | | Default: 0 Range: 0 - 4294967295 |
+-----------------------------------+----------------------------------------------------------------------+
| ``act-interl-delay-up`` | | Actual Interleaving Delay Upstream. |
| | | Default: 0 Range: 0 - 4294967295 |
+-----------------------------------+----------------------------------------------------------------------+
| ``max-interl-delay-down`` | | Max Interleaving Delay Downstream. |
| | | Default: 0 Range: 0 - 4294967295 |
+-----------------------------------+----------------------------------------------------------------------+
| ``act-interl-delay-down`` | | Actual Interleaving Delay Downstream. |
| | | Default: 0 Range: 0 - 4294967295 |
+-----------------------------------+----------------------------------------------------------------------+
| ``data-link-encaps`` | | Data Link Encapsulation |
| | | Default: 0 Range: 0 - 4294967295 |
+-----------------------------------+----------------------------------------------------------------------+
| ``dsl-type`` | | DSL Type. |
| | | Default: 0 Range: 0 - 4294967295 |
+-----------------------------------+----------------------------------------------------------------------+
| ``pon-type`` | | PON Access Type. |
| | | Default: 0 Range: 0 - 4294967295 |
+-----------------------------------+----------------------------------------------------------------------+
| ``etr-up`` | | Expected Throughput (ETR) Upstream. |
| | | Default: 0 Range: 0 - 4294967295 |
+-----------------------------------+----------------------------------------------------------------------+
| ``etr-down`` | | Expected Throughput (ETR) Downstream. |
| | | Default: 0 Range: 0 - 4294967295 |
+-----------------------------------+----------------------------------------------------------------------+
| ``attetr-up`` | | Attainable Expected Throughput (ATTETR) Upstream. |
| | | Default: 0 Range: 0 - 4294967295 |
+-----------------------------------+----------------------------------------------------------------------+
| ``attetr-down`` | | Attainable Expected Throughput (ATTETR) Downstream. |
| | | Default: 0 Range: 0 - 4294967295 |
+-----------------------------------+----------------------------------------------------------------------+
| ``gdr-up`` | | Gamma Data Rate (GDR) Upstream. |
| | | Default: 0 Range: 0 - 4294967295 |
+-----------------------------------+----------------------------------------------------------------------+
| ``gdr-down`` | | Gamma Data Rate (GDR) Downstream. |
| | | Default: 0 Range: 0 - 4294967295 |
+-----------------------------------+----------------------------------------------------------------------+
| ``attgdr-up`` | | Attainable Gamma Data Rate (ATTGDR) Upstream. |
| | | Default: 0 Range: 0 - 4294967295 |
+-----------------------------------+----------------------------------------------------------------------+
| ``attgdr-down`` | | Attainable Gamma Data Rate (ATTGDR) Downstream. |
| | | Default: 0 Range: 0 - 4294967295 |
+-----------------------------------+----------------------------------------------------------------------+
| ``ont-onu-avg-down`` | | ONT/ONU Average Data Rate Downstream. |
| | | Default: 0 Range: 0 - 4294967295 |
+-----------------------------------+----------------------------------------------------------------------+
| ``ont-onu-peak-down`` | | ONT/ONU Peak Data Rate Downstream. |
| | | Default: 0 Range: 0 - 4294967295 |
+-----------------------------------+----------------------------------------------------------------------+
| ``ont-onu-max-up`` | | ONT/ONU Maximum Data Rate Upstream. |
| | | Default: 0 Range: 0 - 4294967295 |
+-----------------------------------+----------------------------------------------------------------------+
| ``ont-onu-ass-up`` | | ONT/ONU Assured Data Rate Upstream. |
| | | Default: 0 Range: 0 - 4294967295 |
+-----------------------------------+----------------------------------------------------------------------+
| ``pon-max-up`` | | PON Tree Maximum Data Rate Upstream. |
| | | Default: 0 Range: 0 - 4294967295 |
+-----------------------------------+----------------------------------------------------------------------+
| ``pon-max-down`` | | PON Tree Maximum Data Rate Downstream. |
| | | Default: 0 Range: 0 - 4294967295 |
+-----------------------------------+----------------------------------------------------------------------+
| ``pon-access-line-version`` | | This option allows to switch between the versions |
| | | 00 (DRAFT-LIHAWI-00) and 04 (DRAFT-LIHAWI-04) of the RFC |
| | | `draft-lihawi-ancp-protocol-access-extension`. |
| | | Default: DRAFT-LIHAWI-04 |
+-----------------------------------+----------------------------------------------------------------------+
+-----------------------------------+----------------------------------------------------------------------+

.. list-table::
:widths: 25 50 25
:header-rows: 1

* - Attribute
- Description
- Default
* - `access-line-profile-id`
- Mandatory access-line-profile identifier
-
* - `act-up`
- Actual Data Rate Upstream
- 0
* - `act-down`
- Actual Data Rate Downstream
- 0
* - `min-up`
- Minimum Data Rate Upstream
- 0
* - `min-down`
- Minimum Data Rate Downstream
- 0
* - `att-up`
- Attainable DataRate Upstream
- 0
* - `att-down`
- Attainable DataRate Downstream
- 0
* - `max-up`
- Maximum Data Rate Upstream
- 0
* - `max-down`
- Maximum Data Rate Downstream
- 0
* - `min-up-low`
- Min Data Rate Upstream in low power state
- 0
* - `min-down-low`
- Min Data Rate Downstream in low power state
- 0
* - `max-interl-delay-up`
- Max Interleaving Delay Upstream
- 0
* - `act-interl-delay-up`
- Actual Interleaving Delay Upstream
- 0
* - `max-interl-delay-down`
- Max Interleaving Delay Downstream
- 0
* - `act-interl-delay-down`
- Actual Interleaving Delay Downstream
- 0
* - `data-link-encaps`
- Data Link Encapsulation
- 0
* - `dsl-type`
- DSL Type
- 0
* - `pon-type`
- PON Access Type
- 0
* - `etr-up`
- Expected Throughput (ETR) Upstream
- 0
* - `etr-down`
- Expected Throughput (ETR) Downstream
- 0
* - `attetr-up`
- Attainable Expected Throughput (ATTETR) Upstream
- 0
* - `attetr-down`
- Attainable Expected Throughput (ATTETR) Downstream
- 0
* - `gdr-up`
- Gamma Data Rate (GDR) Upstream
- 0
* - `gdr-down`
- Gamma Data Rate (GDR) Downstream
- 0
* - `attgdr-up`
- Attainable Gamma Data Rate (ATTGDR) Upstream
- 0
* - `attgdr-down`
- Attainable Gamma Data Rate (ATTGDR) Downstream
- 0
* - `ont-onu-avg-down`
- ONT/ONU Average Data Rate Downstream
- 0
* - `ont-onu-peak-down`
- ONT/ONUPeak Data Rate Downstream
- 0
* - `ont-onu-max-up`
- ONT/ONU Maximum Data Rate Upstream
- 0
* - `ont-onu-ass-up`
- ONT/ONU Assured Data Rate Upstream
- 0
* - `pon-max-up`
- PON Tree Maximum Data Rate Upstream
- 0
* - `pon-max-down`
- PON Tree Maximum Data Rate Downstream
- 0
* - `pon-access-line-version`
- DRAFT-LIHAWI-00 or DRAFT-LIHAWI-04
- DRAFT-LIHAWI-04

Attributes with values set to 0 will not be sent.

The values for ``rate-up``, ``rate-down`` and ``dsl-type`` defined in the
access-line or interface section has priority over those defined here.
The values specified for ``rate-up``, ``rate-down`` and ``dsl-type`` defined in the
``access-line`` or ``interface`` section section take precedence over the definitions
provided here.
Loading

0 comments on commit 8c89bfe

Please sign in to comment.