VIRTNWFILTERD(8)

📦
version 12.8.0 · 8 versions
, in centos-stream 10

💅 VIRTNWFILTERD(8) — like, the manual page, bestie

okay so this is virtnwfilterd, section 8 of the manual (the "system administration" girlies), and literally everything you need to know is right here. grab a snack. 🍓

✨ NAME ✨

virtnwfilterd — the libvirt network filter management daemon. that's it, that's the vibe.

🦋 SYNOPSIS 🦋

virtnwfilterd [OPTION]...

💖 DESCRIPTION 💖

So virtnwfilterd is a server side daemon component of the libvirt virtualization management system. she's a team player. 🫶

She's one of a whole collection of modular daemons that replaced the functionality previously provided by the monolithic libvirtd daemon — think of it as the glow-up era where one giant daemon got broken into a bunch of specialized besties.

This daemon runs on virtualization hosts to provide management for network filters. that's her whole job and she's obsessed with it.

Important boundary talk: virtnwfilterd only listens for requests on a local Unix domain socket. Remote access via TLS/TCP — plus backwards compatibility with legacy clients that expect libvirtd — is provided by the virtproxyd daemon. not her department, she's not doing it, ask virtproxyd. 💅

Now the good news: restarting virtnwfilterd does not interrupt running guests. Guests keep operating and changes in their state will generally be picked up automatically during startup. so she's lowkey very chill about restarts. None the less, it is recommended to avoid restarting with running guests whenever practical — like, she won't ruin the party, but why risk it, y'know? 🙈

🔥 DAEMON STARTUP MODES 🔥

The virtnwfilterd daemon is capable of starting in two modes. two! a whole duality. ✨

🌸 Socket activation mode

On hosts with systemd it is started in socket activation mode, and it will rely on systemd to create and listen on the UNIX sockets and pass them as pre-opened file descriptors. in this mode most of the socket related config options in /etc/libvirt/virtnwfilterd.conf will no longer have any effect. so don't come for those options, they're off duty. 💀

🌈 Traditional service mode

On hosts without systemd, it will create and listen on UNIX sockets itself. independent queen behavior. 👑

⭐ OPTIONS ⭐

  • -h, --help — display command line help usage then exit. the "wait what does this do again" button.
  • -d, --daemon — run as a daemon & write PID file. commit to the bit fr fr.
  • -f, --config FILE — use this configuration file, overriding the default value.
  • -p, --pid-file FILE — use this name for the PID file, overriding the default value.
  • -t, --timeout SECONDS — exit after timeout period (in seconds), provided there are no client connections. so she peaces out once nobody's calling. 👋
  • -v, --verbose — enable output of verbose messages. she will tell you everything.
  • --version — display version information then exit.

🎀 SIGNALS 🎀

On receipt of SIGHUP, virtnwfilterd will reload its configuration. that's the whole section. short and iconic. periodt.

🧚 FILES 🧚

💜 When run as root

  • /etc/libvirt/virtnwfilterd.conf

The default configuration file used by virtnwfilterd, unless overridden on the command line using the -f | --config option.

  • /run/libvirt/virtnwfilterd-sock
  • /run/libvirt/virtnwfilterd-sock-ro
  • /run/libvirt/virtnwfilterd-admin-sock

The sockets virtnwfilterd will use.

The TLS Server private key virtnwfilterd will use.

  • /run/virtnwfilterd.pid

The PID file to use, unless overridden by the -p | --pid-file option.

🩷 When run as non-root

  • $XDG_CONFIG_HOME/libvirt/virtnwfilterd.conf

The default configuration file used by virtnwfilterd, unless overridden on the command line using the -f | --config option.

  • $XDG_RUNTIME_DIR/libvirt/virtnwfilterd-sock
  • $XDG_RUNTIME_DIR/libvirt/virtnwfilterd-admin-sock

The sockets virtnwfilterd will use.

  • $XDG_RUNTIME_DIR/libvirt/virtnwfilterd.pid

The PID file to use, unless overridden by the -p | --pid-file option.

If $XDG_CONFIG_HOME is not set in your environment, virtnwfilterd will use $HOME/.config

If $XDG_RUNTIME_DIR is not set in your environment, virtnwfilterd will use $HOME/.cache

🦋 EXAMPLES 🦋

To retrieve the version of virtnwfilterd:

# virtnwfilterd --version
virtnwfilterd (libvirt) 12.8.0

To start virtnwfilterd, instructing it to daemonize and create a PID file:

# virtnwfilterd -d
# ls -la /run/virtnwfilterd.pid
-rw-r--r-- 1 root root 6 Jul  9 02:40 /run/virtnwfilterd.pid

look at that PID file. six whole bytes of main character energy. 👑

💀 BUGS 💀

Please report all bugs you discover. she wants to know. This should be done via either:

  1. the mailing list

https://libvirt.org/contact.html

  1. the bug tracker

https://libvirt.org/bugs.html

Alternatively, you may report bugs to your software distributor / vendor. ngl they'll probably also want to hear about it.

🌟 AUTHORS 🌟

Please refer to the AUTHORS file distributed with libvirt. the credits are right there, bestie.

Copyright (C) 2006-2020 Red Hat, Inc., and the authors listed in the libvirt AUTHORS file.

📜 LICENSE 📜

virtnwfilterd is distributed under the terms of the GNU LGPL v2.1+. This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. like, legally none. zero. don't @ her. 😭

👀 SEE ALSO 👀

virsh(1), libvirtd(8), https://libvirt.org/daemons.html

okay that's the whole page, you ate that 💅✨ this was virtnwfilterd from the libvirt crew, manual page dated so it lines up with that Jul 9 02:40 energy up in the examples — go touch some sockets, ily, bye 🎀🦋💜

📦 where this page comes from