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 11ad319
Show file tree
Hide file tree
Showing 152 changed files with 9,695 additions and 6,791 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
8 changes: 4 additions & 4 deletions code/bngblaster/src/bbl_config.c
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ json_parse_access_line_profile(json_t *config, bbl_access_line_profile_s *profil
return false;
}

JSON_OBJ_GET_NUMBER(config, value, "access-line-profiles", "access-line-profile-id", 0, 65535);
JSON_OBJ_GET_NUMBER(config, value, "access-line-profiles", "access-line-profile-id", 1, 65535);
if(value) {
profile->access_line_profile_id = json_number_value(value);
} else {
Expand Down Expand Up @@ -2472,15 +2472,15 @@ json_parse_http_client_config(json_t *http, bbl_http_client_config_s *http_clien
return false;
}

JSON_OBJ_GET_NUMBER(http, value, "http-client", "http-client-group-id", 0, 65535);
JSON_OBJ_GET_NUMBER(http, value, "http-client", "http-client-group-id", 1, 65535);
if(value) {
http_client_config->http_client_group_id = json_number_value(value);
} else {
fprintf(stderr, "JSON config error: Missing value for http-client->http-client-group-id\n");
return false;
}

JSON_OBJ_GET_NUMBER(http, value, "http-client", "destination-port", 0, 65535);
JSON_OBJ_GET_NUMBER(http, value, "http-client", "destination-port", 1, 65535);
if(value) {
http_client_config->dst_port = json_number_value(value);
} else {
Expand Down Expand Up @@ -2548,7 +2548,7 @@ json_parse_http_server_config(json_t *http, bbl_http_server_config_s *http_serve
return false;
}

JSON_OBJ_GET_NUMBER(http, value, "http-server", "port", 0, 65535);
JSON_OBJ_GET_NUMBER(http, value, "http-server", "port", 1, 65535);
if(value) {
http_server_config->port = json_number_value(value);
} else {
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).
Loading

0 comments on commit 11ad319

Please sign in to comment.