openvpn3-admin-log-service(8)

📦
version 27.1 · 5 versions
, in ubuntu stonking

💖 NAME 💖

openvpn3-admin-log-service — it's the OpenVPN 3 Linux admin corner for Log Service management, bestie. Yes, the man page is literally called openvpn3-admin-log-service(8) and it lives in the OpenVPN 3 Linux family 🫶

✨ SYNOPSIS ✨

openvpn3-admin log-service [OPTIONS]
openvpn3-admin log-service -h | --help

🌸 DESCRIPTION 🌸

Okay so listen 👑 this command manages a handful of adjustable knobs that live inside openvpn3-service-log when it's running as a D-Bus service. Just a few little settings, nothing scary.

The access control for this command? That's handled over in the D-Bus policy, and by default the only people allowed to touch it are the root and _openvpn user accounts. So if you're not one of those two, it's giving locked-out energy 🙈

💅 OPTIONS 💅

  • -h, --help — prints the usage and help deets right to your terminal. Classic. ✨
  • --config-show — shows you what's inside the configuration file that openvpn3-service-log(8) is using. Peek behind the curtain 🎀
  • --config-set — changes a setting in the configuration file. Heads up though: changing the config file means the openvpn3-service-log(8) process has to be restarted before the new stuff actually kicks in, fr fr. This option wants two arguments: CONFIG-NAME and CONFIG-VALUE. And here's your valid CONFIG-NAME lineup 👇
    • log-file — sets where the log events get sent. For the full tea, go peep the --log-file option in the man page for openvpn3-service-log(8).
Not settable if journald or syslog has already been set. Pick a lane bestie 😭
  • colour — turns on colours in logged lines when you're logging to a file. This one only works when a log file is configured. Rainbow logs, iconic 🌈
  • idle-exit — sets the automatic idle shut-down time-out. Deets live in the --idle-exit option in the man page for openvpn3-service-log(8).
  • journald — configures openvpn3-service-log(8) to ship log events off to the systemd-journald(8) service. More details over in the openvpn3-service-log(8) man page.
This one cannot be combined with syslog, log-file or colour. Periodt.
Cannot be combined with journald, log-file or colour either. Choose wisely 💀
  • syslog-facility — picks which syslog facility to use when you're logging via syslog. Default is LOG_DAEMON. And this only does anything at all when logging via syslog has been enabled. No syslog, no effect, iykyk.
  • --config-unset — basically --config-set's sibling, except instead of setting a thing it removes a setting from the configuration file. Bye bestie 👋
  • --log-level LEVEL — sets the system-wide log verbosity for the log events being written to file, or to whatever other log destination openvpn3-service-log is set up to use. Valid values are 0 to 6. The higher the number, the more verbose the log events get — and log level 6 contains all the debug events. Maximum yapping mode 🔥
  • --timestamp BOOL — some of the log destinations that openvpn3-service-log supports will let you log with or without timestamps, and this option enables or disables timestamps attached to log events. Valid arguments: true, false.
  • --dbus-details BOOL — every log event carries a lil bit of extra meta-data about the sender. This is disabled by default, but when you enable it, it adds a line on the log destination before the log event itself containing all that meta-data. Mostly only useful when you're debugging, and not recommended for normal production. Valid arguments: true, false.
  • --enable-log-prefix BOOL — this setting only exists if openvpn3-service-log(8) is configured to use journald. If you enable it, each log line (MESSAGE=) in the journal gets prefixed with a log tag. That log tag is always logged as a journald meta data variable (O3_LOGTAG), so you never lose it. Check out journalctl(1) and the --output and --output-fields options for the details. Valid arguments: true, false.
  • --list-subscriptions — lists every service that the log service has subscribed to. The full guest list 🎀

🦋 SEE ALSO 🦋

openvpn3(1) openvpn3-service-log(8)

And that's a wrap on the openvpn3-admin-log-service(8) page from the OpenVPN 3 Linux crew — same manual name, same page, just with way more sparkle ✨ Thanks for reading all the way to the bottom, you absolute icon, ily 💜

📦 where this page comes from