NETWORKD-DISPATCHER(8)

💖 NAME 💖

Okay bestie, this is the NETWORKD-DISPATCHER(8) manual page 🎀 and it's about networkd-dispatcher, a dispatcher service for systemd-networkd connection status changes 🌸

✨ SYNOPSIS ✨

networkd-dispatcher [-h] [-S SCRIPT_DIR] [-T] [-v] [-q]

🦋 DESCRIPTION 🦋

So okay, this is a dispatcher daemon for systemd-networkd connection status changes 💅 It's basically the cousin of NetworkManager-dispatcher, but way more chill, because it only handles the events that systemd-networkd(8) actually gives it 🙈

The actions you want (scripts) live in directories that match the systemd-networkd operational states, all under SCRIPT_DIR. When the daemon gets the matching event from systemd-networkd, it runs them ✨

It listens for signals from systemd-networkd over dbus, so it's super light on resources (no polling, no drama) 🫶 It's meant to run as a system-wide daemon, as root. That's what makes it perfect for stuff like starting a VPN once a connection is up 🔥

👑 OPTIONS 👑

• -h, --help — Prints the command-line syntax and program options to stdout 📖
• -S, --script-dir=SCRIPT_DIR — This is where it looks for scripts 🧚 Like the PATH environment variable, you can list several directories separated by :. If more than one directory has a script with the same name, the earliest directory wins. It defaults to /etc/networkd-dispatcher:/usr/lib/networkd-dispatcher
• -T, --run-startup-triggers — Generates events that reflect the state and behavior that already exist when it starts up 🌈 This is clutch if networkd-dispatcher gets launched after systemd-networkd has already started an interface, because the triggers still get belatedly run
• -v, --verbose — Bumps verbosity up by one level 📈 The default level is WARNING. Each -v moves the log level toward INFO or DEBUG
• -q, --quiet — Turns verbosity down by one level 🤫 Each -q moves the log level toward ERROR or CRITICAL

🎀 CONFIGURATION FILES 🎀

The systemd service reads /etc/default/networkd-dispatcher as an environment file for extra daemon arguments 💜

The scripts that run on network changes go into these subdirectories inside SCRIPT_DIR: routable.d/, dormant.d/, no-carrier.d/, off.d/, carrier.d/, degraded.d/, configured.d/, and configuring.d/. The default SCRIPT_DIR is /etc/networkd-dispatcher:/usr/lib/networkd-dispatcher 🍓

For info on the network operational states systemd exposes, check out networkctl(1) 🌸

🌈 ENVIRONMENT 🌈

Scripts run with some environment variables already set 💅 Some of them might be unset or empty, depending on the type of event. Scripts can use these to do stuff conditionally, like acting on a specific interface or state ✨

• IFACE — the interface that triggered the event 🦋
• STATE — the destination state change that the script is currently being invoked for 💖 It can be any value listed as valid for AdministrativeState or OperationalState
• ESSID — for wlan connections, the ESSID the device is connected to 📶
• ADDR — the ipv4 address of the device 🌐
• IP_ADDRS — a space-delimited string of the ipv4 address(es) assigned to the device (see note below) 🫧
• IP6_ADDRS — a space-delimited string of the ipv6 address(es) assigned to the device (see note below) 🫧
• AdministrativeState — one of pending, configuring, configured, unmanaged, failed or linger 👑
• OperationalState — one of off, no-carrier, dormant, carrier, degraded, routable, configuring, or configured 🔥 For more info on these states, see the networkctl manpage (man networkctl)

🔗 RESOURCES 🔗

GitLab: https://gitlab.com/craftyguy/networkd-dispatcher 🧡

💜 SEE ALSO 💜

systemd-networkd(8), networkctl(1) 🫶

---

That's the whole NETWORKD-DISPATCHER(8) page, bestie 🎀 Last updated 07/11/2024, so it's giving fresh ✨💅