LibreQoS is needed for Splynx to provide advanced, dynamic bandwidth management and traffic prioritization by seamlessly integrating with Splynx tariffs, speed limits, and burst configurations. It ensures fair resource allocation, scalability, and enhanced QoS/QoE, making it ideal for ISPs managing diverse traffic types.
To start the integration process, you need to set the relevant parameters for Splynx (splynx_api_key, splynx_api_secret, etc.) in /etc/lqos.conf.
The Splynx integration relies on Basic authentication. To use this authentication method, ensure that Unsecure access is enabled in your Splynx API key settings.
Additionally, make sure the Splynx API key has the required permissions:
Tariff Plans → Internet → view
Tariff Plans → Bundle → view
Tariff Plans → One time → view
Tariff Plans → Recurring → view
FUP → Counter → view
FUP → Compiler → view
FUP → Policies → view
FUP → Capped Data → view
FUP → CAP Tariff → view
FUP → FUP Limits → view
FUP → Traffic Usage → view
Customers → customer → view
Customers → customer information → view
Customers → Customers online → view
Customers → customer bundle services → view
Customers → customer internet services → view
Customers → traffic counter → view
Customers → customer recurring services → view
Customers → bonus traffic counter → view
Customers → CAP history → view
Networking → routers → view
Networking → network sites >view
Networking → router contention → view
Networking → IPv4 networks → view
Networking → IPv4 networks IP → view
Use the following command to test the Splynx integration:
python3 integrationSplynx.py
Upon the first successful run, the integration will generate two files: ShapedDevices.csv and network.json. The ShapedDevices.csv file will be overwritten each time the Splynx integration is executed.
To ensure that network.json is always updated with the latest version retrieved by the integration, follow these steps:
sudo nano /etc/lqos.conf
Locate the setting always_overwrite_network_json and set its value to true.
Save the changes and restart the service by running:
sudo systemctl restart lqosd
It is highly recommended to configure integrationSplynx.py to run automatically on system boot and periodically, with the interval defined by the parameter queue_refresh_interval_mins.
To enable this:
Set enable_spylnx = true in the /etc/lqos.conf file.
Save the changes and restart the scheduler by running:
sudo systemctl restart lqos_scheduler
You can customize the integrationSplynxBandwidths.csv file to override the default bandwidth settings for each Node (Site or Access Point).
A template file is available in the /opt/libreqos/src folder. To use it, copy the template file and remove the .template extension from the filename. Then, update the file with the appropriate details. For example, to modify the bandwidth for a specific site, follow these steps:
sudo cp /opt/libreqos/src/integrationSplynxBandwidths.template.csv /opt/libreqos/src/integrationSplynxBandwidths.csv
Save your updates to apply the new bandwidth settings.