Automate network configurations with dispatcher scripts
Debugging
Since NetworkManager runs in the background except for the configuration work, you cannot easily check your own dispatcher scripts for errors. If something goes wrong, don't expect a window with helpful error messages. If there is a bug in the script, simply nothing happens. To find programming errors, check out the system logs.
On the one hand, nmcli monitor
lets you trace what NetworkManager is doing in real time. You can see the network device names and what actions are currently running. To view the NetworkManager logs, you need to read the system journal with journalctl
. The following command:
journalctl -f -u NetworkManager
lets you have a look at the log in real time and filter the output from NetworkManager (Listing 9).
Listing 9
journalctl
$ journalctl -f -u NetworkManager [...] May 22 23:21:45 ontario NetworkManager[485]: <warn> [1590182505.2987] dispatcher: (44) /etc/NetworkManager/dispatcher.d/30-mount-diskstation failed (failed): Script '/etc/NetworkManager/dispatcher.d/30-mount-diskstation' exited with error status 2. $ nmcli monitor enp0s31f6: Connection "LAN1" is used enp0s31f6: is connected (being prepared) NetworkManager is now in the state "being connected [...] NetworkManager is now in "connected" state Connection state is now "complete
These commands give you a general overview of NetworkManager's actions. However, in order to search for an error, it is recommended that you send content to the systemd log yourself at critical points using logger
. For an example, as shown in Listing 10, you can use the $0
(script name), $1
(network device), and $2
(action) variables also used by NetworkManager for dispatching, as well as the environment variables provided by the dispatcher function, such as $CONNECTION_UUUID
or $IP4_DOMAINS
(Listing 11).
Listing 10
Logging
#!/bin/bash logger "Logger: Run script $0." if [ "$2" = "up" ]; then logger "LOGGER: network device: $1, action: $2" logger "LOGGER: Environment: CONNECTION_UUUID=$CONNECTION_UUID, IP4_DOMAINS=$IP4_DOMAINS" fi
Listing 11
grepping the Log
$ journalctl -f | grep LOGGER [...] May 22 23:36:47 root [16135]: LOGGER: Run script /etc/NetworkManager/dispatcher.d/30-mount-diskstation May 22 23:36:47 root [16136]: LOGGER: network device: enp0s31f6, action: up May 22 23:50:31 oroot[18811]: LOGGER: Environment: CONNECTION_UUUID=2911db45-3eff-3b74-9c87-4c36e0290693, IP4_DOMAINS=fritz.box
Conclusion
A meaningful dispatcher script will not automatically write itself. It takes some time to get everything working as desired. But once you work through all the details, you can get a dispatcher script to do almost anything you can do on the system at the file level. The biggest difficulty is extracting log output or viewing the environment variables populated during dispatching. But if you know the tricks, you can quickly overcome these hurdles.
Infos
« Previous 1 2
Buy this article as PDF
(incl. VAT)
Buy Linux Magazine
Subscribe to our Linux Newsletters
Find Linux and Open Source Jobs
Subscribe to our ADMIN Newsletters
Support Our Work
Linux Magazine content is made possible with support from readers like you. Please consider contributing when you've found an article to be beneficial.
News
-
2024 Open Source Professionals Job Survey Now Open
Share your expectations regarding open source jobs.
-
Arch Linux 2023.12.01 Released with a Much-Improved Installer
If you've ever wanted to install Arch Linux, now is your time. With the latest release, the archinstall script vastly simplifies the process.
-
Zorin OS 17 Beta Available for Testing
The upcoming version of Zorin OS includes plenty of improvements to take your PC to a whole new level of user-friendliness.
-
Red Hat Migrates RHEL from Xorg to Wayland
If you've been wondering when Xorg will finally be a thing of the past, wonder no more, as Red Hat has made it clear.
-
PipeWire 1.0 Officially Released
PipeWire was created to take the place of the oft-troubled PulseAudio and has finally reached the 1.0 status as a major update with plenty of improvements and the usual bug fixes.
-
Rocky Linux 9.3 Available for Download
The latest version of the RHEL alternative is now available and brings back cloud and container images for ppc64le along with plenty of new features and fixes.
-
Ubuntu Budgie Shifts How to Tackle Wayland
Ubuntu Budgie has yet to make the switch to Wayland but with a change in approaches, they're finally on track to making it happen.
-
TUXEDO's New Ultraportable Linux Workstation Released
The TUXEDO Pulse 14 blends portability with power, thanks to the AMD Ryzen 7 7840HS CPU.
-
AlmaLinux Will No Longer Be "Just Another RHEL Clone"
With the release of AlmaLinux 9.3, the distribution will be built entirely from upstream sources.
-
elementary OS 8 Has a Big Surprise in Store
When elementary OS 8 finally arrives, it will not only be based on Ubuntu 24.04 but it will also default to Wayland for better performance and security.