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
GIC-de committed Nov 7, 2023
1 parent 16a8ffe commit 6ba6bdd
Show file tree
Hide file tree
Showing 194 changed files with 13,487 additions and 8,640 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/build.yml
View file
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
View file
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
50 changes: 50 additions & 0 deletions docs/_sources/access/index.rst.txt
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,56 @@
Access Protocols
================

A BNG, or Broadband Network Gateway, is a network device that
connects customer premises equipment to the service provider's
broadband network, managing user authentication, traffic routing,
and quality of service (QoS) for internet services.

.. _sessions:

The BNG Blaster is equipped with versatile support for various
access protocols, allowing the creation of seubscriber sessions,
each of which can comprise multiple protocols. For instance, in the
case of dual-stack IPoE sessions, these are formed by a combination of
DHCPv4, DHCPv6, as well as ARP/ND protocols. Every session is
defined by an :ref:`access interface function <access-interface>`
and identified by a globally unique **session-id**, with the
numbering starting at 1 and increasing sequentially for each
new session established. Furthermore, you have the flexibility
to group multiple sessions together using the optional
**session-group-id**, which enables the application of commands
:ref:`commands <api>` to an entire group of sessions simultaneously.

.. code-block:: json
{
"access": [
{
"interface": "eth1",
"type": "pppoe",
"session-group-id": 1,
"username": "[email protected]",
"outer-vlan-min": 1000,
"outer-vlan-max": 1998,
"outer-vlan-step": 2,
"inner-vlan": 7
},
{
"interface": "eth1",
"type": "pppoe",
"session-group-id": 2,
"username": "[email protected]",
"outer-vlan-min": 1001,
"outer-vlan-max": 1999,
"outer-vlan-step": 2,
"inner-vlan": 7
},
]
}
It is also possible to assign multiple access interface
sections to a single session group.

.. toctree::
:maxdepth: 1

Expand Down
4 changes: 0 additions & 4 deletions docs/_sources/access/l2bsa.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,6 @@ as the intermediate agent functionality.
The BNG Blaster A10NSP interface emulates such a layer two provider interface. This interface type accepts
all DHCPv4 and PPPoE sessions were received to verify forwarding and header enrichment.

.. note::
It is also planned to emulate a lightweight DHCPv6 server
to verify IPv6 forwarding and header enrichment for IPoE.

Following a basic PPPoE/A10NSP configuration example which is
detailed explained in the configuration section.

Expand Down
52 changes: 26 additions & 26 deletions docs/_sources/api/bgp.rst.txt
View file
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
.. list-table::
:header-rows: 1
+-----------------------------------+----------------------------------------------------------------------+
| Command | Description |
+===================================+======================================================================+
| **bgp-sessions** | | Display all matching BGP sessions. |
| | | |
| | | **Arguments:** |
| | | ``local-ipv4-address`` |
| | | ``peer-ipv4-address`` |
+-----------------------------------+----------------------------------------------------------------------+
| **bgp-disconnect** | | Disconnect all matching BGP sessions. |
| | | |
| | | **Arguments:** |
| | | ``local-ipv4-address`` |
| | | ``peer-ipv4-address`` |
+-----------------------------------+----------------------------------------------------------------------+
| **bgp-teardown** | | Teardown BGP. |
+-----------------------------------+----------------------------------------------------------------------+
| **bgp-raw-update-list** | | List all loaded BGP RAW update files. |
+-----------------------------------+----------------------------------------------------------------------+
| **bgp-raw-update** | | Update all matching BGP sessions. |
| | | |
| | | **Arguments:** |
| | | ``file`` Mandatory path to BGP RAW update file. |
| | | ``local-ipv4-address`` |
| | | ``peer-ipv4-address`` |
+-----------------------------------+----------------------------------------------------------------------+

* - Attribute
- Description
- Mandatory Arguments
- Optional Arguments
* - `bgp-sessions`
- Display all matching BGP sessions
-
- `local-ipv4-address`, `peer-ipv4-address`
* - `bgp-disconnect`
- Disconnect all matching BGP sessions
-
- `local-ipv4-address`, `peer-ipv4-address`
* - `bgp-teardown`
- Teardown BGP
-
-
* - `bgp-raw-update-list`
- List all loaded BGP RAW update files
-
-
* - `bgp-raw-update`
- Update all matching BGP session
- `file`
- `local-ipv4-address`, `peer-ipv4-address`
46 changes: 23 additions & 23 deletions docs/_sources/api/cfm.rst.txt
View file
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
.. list-table::
:header-rows: 1

* - Attribute
- Description
- Mandatory Arguments
- Optional Arguments
* - `cfm-cc-start`
- Start EOAM CFM CC
-
- `session-id`
* - `cfm-cc-stop`
- Stop EOAM CFM CC
-
- `session-id`
* - `cfm-cc-rdi-on`
- Set EOAM CFM CC RDI
-
- `session-id`
* - `cfm-cc-rdi-off`
- Unset EOAM CFM CC RDI
-
- `session-id`
+-----------------------------------+----------------------------------------------------------------------+
| Command | Description |
+===================================+======================================================================+
| **cfm-cc-start** | | Start EOAM CFM CC. |
| | | |
| | | **Arguments:** |
| | | ``session-id`` |
+-----------------------------------+----------------------------------------------------------------------+
| **cfm-cc-stop** | | Stop EOAM CFM CC. |
| | | |
| | | **Arguments:** |
| | | ``session-id`` |
+-----------------------------------+----------------------------------------------------------------------+
| **cfm-cc-rdi-on** | | Set EOAM CFM CC RDI. |
| | | |
| | | **Arguments:** |
| | | ``session-id`` |
+-----------------------------------+----------------------------------------------------------------------+
| **cfm-cc-rdi-off** | | Unset EOAM CFM CC RDI. |
| | | |
| | | **Arguments:** |
| | | ``session-id`` |
+-----------------------------------+----------------------------------------------------------------------+
37 changes: 18 additions & 19 deletions docs/_sources/api/http.rst.txt
View file
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@
.. list-table::
:header-rows: 1

* - Attribute
- Description
- Mandatory Arguments
- Optional Arguments
* - `http-clients`
- Display all HTTP client instances
-
- `session-id`
* - `http-clients-start`
- Start all HTTP client instances
-
- `session-id`
* - `http-clients-stop`
- Stop all HTTP client instances
-
- `session-id`
+-----------------------------------+----------------------------------------------------------------------+
| Command | Description |
+===================================+======================================================================+
| **http-clients** | | Display all HTTP client instances. |
| | | |
| | | **Arguments:** |
| | | ``session-id`` |
+-----------------------------------+----------------------------------------------------------------------+
| **http-clients-start** | | Start all HTTP client instances. |
| | | |
| | | **Arguments:** |
| | | ``session-id`` |
+-----------------------------------+----------------------------------------------------------------------+
| **http-clients-stop** | | Stop all HTTP client instances. |
| | | |
| | | **Arguments:** |
| | | ``session-id`` |
+-----------------------------------+----------------------------------------------------------------------+
83 changes: 44 additions & 39 deletions docs/_sources/api/igmp.rst.txt
View file
Original file line number Diff line number Diff line change
@@ -1,39 +1,44 @@
.. list-table::
:header-rows: 1

* - Attribute
- Description
- Mandatory Arguments
- Optional Arguments
* - `igmp-join`
- Join group
- `session-id`, `group`
- `source1`, `source2`, `source3`
* - `igmp-join-iter`
- Join multiple groups over all sessions
- `group`
- `group-iter`, `group-count`, `source1`, `source2`, `source3`
* - `igmp-leave`
- Leave group
- `session-id`, `group`
-
* - `igmp-leave-all`
- Leave all groups from all sessions
-
-
* - `igmp-info`
- Display group information
- `session-id`
-
* - `zapping-start`
- Start IGMP zapping test
-
-
* - `zapping-stop`
- Stop IGMP zapping test
-
-
* - `zapping-stats`
- Return IGMP zapping stats
-
- `reset`
+-----------------------------------+----------------------------------------------------------------------+
| Command | Description |
+===================================+======================================================================+
| **igmp-join** | | Join group. |
| | | |
| | | **Arguments:** |
| | | ``session-id`` Mandatory |
| | | ``group`` Mandatory |
| | | ``source1`` |
| | | ``source2`` |
| | | ``source3`` |
+-----------------------------------+----------------------------------------------------------------------+
| **igmp-join-iter** | | Join multiple groups over all sessions. |
| | | |
| | | **Arguments:** |
| | | ``group`` Mandatory |
| | | ``group-iter`` |
| | | ``group-count`` |
| | | ``source1`` |
| | | ``source2`` |
| | | ``source3`` |
+-----------------------------------+----------------------------------------------------------------------+
| **igmp-leave** | | Leave group. |
| | | |
| | | **Arguments:** |
| | | ``session-id`` Mandatory |
| | | ``group`` Mandatory |
+-----------------------------------+----------------------------------------------------------------------+
| **igmp-leave-all** | | Leave all groups from all sessions. |
+-----------------------------------+----------------------------------------------------------------------+
| **igmp-info** | | Display group information. |
| | | |
| | | **Arguments:** |
| | | ``session-id`` Mandatory |
+-----------------------------------+----------------------------------------------------------------------+
| **zapping-start** | | Start IGMP zapping test. |
+-----------------------------------+----------------------------------------------------------------------+
| **zapping-stop** | | Stop IGMP zapping test. |
+-----------------------------------+----------------------------------------------------------------------+
| **zapping-stats** | | Return IGMP zapping stats. |
| | | |
| | | **Arguments:** |
| | | ``reset`` |
+-----------------------------------+----------------------------------------------------------------------+
Loading

0 comments on commit 6ba6bdd

Please sign in to comment.