Configuring the `DHCPLSS` plugin to import clients from the YazFi plugin

Requirements:

Only for ASUS routers with the Merlin FW and Entware installed
You have guest networks modified with the YazFi pluginwith unidirectional communication from the private network to the guest network configured:

One way to guest: Yes

Problem: Clients inaccessible with the Asus API:

When using YazFi on an ASUS router, the guest clients will no longer be displayed in the regular client list
The guests are logged in the YazFi plugin and the networks are in an advanced mode
The ASUSWRT plugin by labmonkey can only access the clients from the Asus client list but not the guests in the YazFi plugin

Solution: Getting the `dnsmasq.leases` from the Asus router and configuriong the `DHCPLSS` plugin:

Enable SSH login on your Asus router
Generate a pair of SSH keys and place them inside /root/.ssh/
In your router's admin-settings, paste the public key and disable "password login" for SSH
On your docker machine, create a script (I placed it in /home/root):

Replace the IP if necessary.
Replace ssh2_privateKey and asususer with your keyfile and your routers login name.
Replace /mnt/service-data/netalertx_dhcp.leases/ with your preferred save path inside the docker machine.

nano grabdnsmasq.sh

#!/bin/bash
rsync -avzh -e "ssh -i /root/.ssh/ssh2_privateKey" asususer@192.168.1.1:/var/lib/misc/dnsmasq.leases /mnt/service-data/netalertx_dhcp.leases/

Create a config file in /root/.ssh/:

Again, replace the IP, the SSH key and the user and also the port if necessary

Host ASUS-GT-AXE16000
    HostName 192.168.1.1
    IdentityFile /root/.ssh/ssh2_privateKey
    IdentitiesOnly yes
    User asususer
    Port 22

Try a dry run with the command in step 4. If everything is fine, you should have a dnsmasq.leases file at your target location
Edit crontab for root:

crontab -e

add your scheduled time and the path to your script file:

*/2 * * * * /root/grabdnsmasq.sh

Save and reload the cron service:

service cron reload

Load the DHCPLSS plugin in NetAlertX and add the newly generated dhcp.leases file into the container with a path that must contain the string dnsmasq. An example of the mount point could be:

volumes:
      - /mnt/service-data/netalertx_dhcp.leases:/etc/dnsmasq
      ...

Load the DHCPLSS plugin and add the search path: /etc/dnsmasq/dnsmasq.leases

Configure the plugin, and save everything. You can trigger a manual run.

Note

DHCP leases don't allow for realtime tracking and the freshness of the data depends on the DHCP leasing time (usually set to 1 or 24h, or 3600 to 86400 seconds).

For a Docker LXC setup the file could be located at /mnt/service-data/netalertx_dhcp.leases/dnsmasq.leases.

Quick setup overview:

DHCPLSS_RUN: 'schedule'
DHCPLSS_CMD: 'python3 /app/front/plugins/dhcp_leases/script.py paths={paths}'
DHCPLSS_paths_to_check: ['/etc/dnsmasq/dnsmasq.leases']
DHCPLSS_RUN_SCHD: '*/5 * * * *'
DHCPLSS_TUN_TIMEOUT: 5
DHCPLSS_WATCH: ['Watched_Value1', 'Watched_Value4']
DHCPLSS_REPORT_ON: ['new', 'watched_changed']

You can check the the dnsmasq.leases file in the container by running ls /etc/dnsmasq/:

CT_NetAlertX:/# ls /etc/dnsmasq/
dnsmasq.leases

Other Info

Publishing date: 22.1.2025
Author: EinKantHolz - odin

3.4 KiB Executable File Raw Blame History

Configuring the DHCPLSS plugin to import clients from the YazFi plugin