NUTCONF(8)

📦
version 2.8.5 · 14 versions
, in fedora 43, fedora 44

✨ NAME ✨

nutconf — the NUT configuration tool 🎀

so like, it's the little tool that handles all your NUT config files, bestie. she does it all. 💅

🦋 SYNOPSIS 🦋

nutconf --help

nutconf [OPTIONS]

💖 DESCRIPTION 💖

okay so <rainbow>nutconf</rainbow> is the tool you use to create and manipulate NUT configuration files. she's giving main character energy for your whole config setup. ✨

and that's not even all — she also supports device scanning, which is the part where she goes and peeks around and then suggests configuration for devices. so thoughtful of her honestly. 🫶

🧚 INSTALLATION 🧚

ngl this part matters: the scanning feature depends on the very same compile time and run time dependencies as the nut-scanner. literally the exact same ones. so if nut-scanner is happy, scanning in nutconf is happy too. 🦋

👑 OPTIONS 👑

  • -h | -help | --help — displays the help text. your "hey what do I even do" button 💖
  • -D — raises the debugging level. use this option multiple times for more details. it overrides the optional NUT_DEBUG_LEVEL environment variable. (so like, -D said "I got this" 💅)
  • -v | --verbose — increases output verbosity (may be used multiple times). the more times you say it, the more she says back ✨
  • --is-configured — checks whether NUT was configured, before.
  • --system — the system configuration directory shall be used.
  • --local directory — sets an alternative configuration directory.
  • --get-mode — prints the current NUT configuration mode.
  • --set-mode mode — sets the NUT configuration mode.

the known modes are, bestie:

  • standalone
  • netserver
  • netclient
  • controlled
  • manual
  • none

🌈 CONFIGURATION ENTRY SET/ADD OPTIONS 🌈

okay so these ones mostly come in 2 forms: --set-... or --add-.... 🎀

the difference, and this is the whole thing: the set options discard previous settings, while the add options keep them. so set = fresh start, add = build on top. got it? periodt. 💅

also — note that such options may be specified multiple times for one run, which is how you enable setting multiple entries at once. so you can just keep stacking them. 🔥

  • --set-monitor | --add-monitor <arguments> — sets/adds a NUT monitor.
    • Arguments:
'<ups_ID>' '<host>[:<port>]' '<power_value>' '<user>' '<passwd>' '(\"master\"|\"slave\")'
  • --set-listen | --add-listen <address> [<port>] — sets/adds the upsd(8) daemon listen address. 👑
  • --set-device | --add-device <arguments> — sets/adds a device (typically a UPS).
    • Arguments:
'<ups_ID>' '<driver>' '<port>' '[<attribute>=<value>]*'

the attribute/value pairs follow the device configuration syntax. heads up tho: devices may have very different configuration attributes depending on the driver. an exhaustive description of them is beyond this man page and may be found in NUT documentation. (iykyk — go read the docs for the deep lore 📚)

  • --set-notifyflags | --add-notifyflags <type> <flag>+ — sets/adds notification flags for the notification type.
    • the notification types are, and there's a LOT of them, stay with me:
      • ONLINE — mains is present
      • ONBATT — mains is gone
      • LOWBATT — remaining battery capacity is low
      • FSD — shutdown was forced
      • COMMOK — communication with device established
      • COMMBAD — lost communication with device
      • SHUTDOWN — system is going down, now
      • REPLBATT — UPS battery needs replacing
      • NOCOMM — device is unavailable
      • NOPARENT — upsmon parent process died, shutdown is impossible
      • CAL — calibration in progress
      • NOTCAL — calibration finished
      • OFF — UPS is administratively OFF or asleep, should wake up on command
      • NOTOFF — UPS is no longer administratively OFF or asleep
      • BYPASS — on bypass = powered, not protecting
      • NOTBYPASS — no longer on bypass
      • ALARM — UPS is in an alarm state (has active alarms)
      • NOTALARM — UPS is no longer in an alarm state (no active alarms)
      • OVER — overloaded
      • NOTOVER — no longer overloaded
      • TRIM — trimming incoming voltage
      • NOTTRIM — no longer trimming incoming voltage
      • BOOST — boosting incoming voltage
      • NOTBOOST — no longer boosting incoming voltage
      • OTHER — UPS has at least one unclassified status token
      • NOTOTHER — UPS has no unclassified status tokens anymore
      • SUSPEND_STARTING — OS is entering sleep/suspend/hibernate mode
      • SUSPEND_FINISHED — OS just finished sleep/suspend/hibernate mode
    • and the notification flags are:
      • SYSLOG — use syslogd to log the notification
      • WALL — push a message to users' terminals
      • EXEC — execute a command
      • IGNORE — don’t act
  • --set-notifymsg <type> <message> — sets the message for the specified notification type. 📝
  • --set-shutdowncmd <command> — sets the command used to shut the system down. 💀
  • --set-user | --add-user <arguments> — sets/adds a NUT user.
    • Arguments:
      • <username> — specifies user name. for a upsmon user it has a special form of upsmon=(primary|master|secondary|slave), which specifies the monitoring mode. 👑
      • password=<passwd> — sets the password for the user
      • actions=<actions> — sets actions (SET, FSD are supported)
      • instcmds=<command> — sets instant commands allowed for the user (may be used multiple times)

🔍 SCANNING OPTIONS 🔍

okay bestie, here's the tea: whether you actually get each of these scanning options depends on whether the right 3rd-party libraries showed up — both at compile time and at run time. so like, the vibe has to be right at both parties. 🫶

run the tool with the --help option to check which of the --scan-... options are actually supported. don't just assume, go check, it's giving "look before you leap" energy fr fr.

⏰ heads up: all timeouts are in microseconds. not seconds. not milliseconds. microseconds. iykyk.
  • --scan-snmp <start IP> <stop IP> [<attribute>=<value>]* — scans for SNMP devices on IP addresses from the specified range.

✨ known attributes are:

  • timeout — device scan timeout
  • community — SNMP community (default: public)
  • sec-level — security level (SNMPv3); one of noAuthNoPriv authNoPriv, authPriv
  • sec-name — security name (SNMPv3); mandatory companion of sec-level
  • auth-password — authentication password (SNMPv3); mandatory for authNoPriv and authPriv
  • priv-password — privacy password (SNMPv3); mandatory for authPriv
  • auth-protocol — authentication protocol (SNMPv3): MD5 or SHA, MD5 is the default
  • priv-protocol — priv. protocol (SNMPv3): DES or AES, DES is the default
  • peer-name — peer name
  • --scan-usb — scans the USB bus for known devices 🦋
  • --scan-xml-http [<timeout>] — scans for XML/HTTP devices on the network.
  • --scan-nut <start IP> <stop IP> <port> [<timeout>] — scans for NUT (pseudo-)devices on the network.
  • --scan-avahi [<timeout>] — scans for Avahi devices.
  • --scan-ipmi <start IP> <stop IP> [<attribute>=<value>]* — scans for IPMI devices on IP addresses from the specified range.

✨ known attributes are:

  • username — username (mandatory for IPMI/LAN)
  • password — user password (mandatory for IPMI/LAN)
  • auth-type — authentication type (see below)
  • cipher-suite-id — cipher suite ID (see below)
  • K-g-BMC-key — optional second key (???)
  • priv-level — priv. level
  • workaround-flags
  • version — (1.5 or 2.0)

🔐 Authentication types

specifies the IPMI 1.5 authentication type to use (NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5) with the remote host (default=MD5). this forces connection through the lan IPMI interface, thus in IPMI 1.5 mode. periodt.

  • none — authentication is disabled
  • MD2
  • MD5 — (default)
  • plain-password — no ciphering used for password sending
  • OEM
  • RMCPplus

🎀 Cipher suite IDs

specifies the IPMI 2.0 cipher suite ID to use.

the Cipher Suite ID identifies a set of authentication, integrity, and confidentiality algorithms to use for IPMI 2.0 communication.

the authentication algorithm identifies the algorithm to use for session setup, the integrity algorithm identifies the algorithm to use for session packet signatures, and the confidentiality algorithm identifies the algorithm to use for payload encryption (default=3). literally three jobs in one little number, main character energy honestly.

the following cipher suite IDs are currently supported:

  • code 0 — Authentication: None, Integrity: None, Confidentiality: None
  • code 1 — Authentication: HMAC-SHA1, Integrity: None, Confidentiality: None
  • code 2 — Authentication: HMAC-SHA1, Integrity: HMAC-SHA1-96, Confidentiality: None
  • code 3 — Authentication: HMAC-SHA1, Integrity: HMAC-SHA1-96, Confidentiality: AES-CBC-128
  • code 6 — Authentication: HMAC-MD5, Integrity: None, Confidentiality: None
  • code 7 — Authentication: HMAC-MD5, Integrity: HMAC-MD5-128, Confidentiality: None
  • code 8 — Authentication: HMAC-MD5, Integrity: HMAC-MD5-128, Confidentiality: AES-CBC-128
  • code 11 — Authentication: HMAC-MD5, Integrity: MD5-128, Confidentiality: None
  • code 12 — Authentication: HMAC-MD5, Integrity: MD5-128, Confidentiality: AES-CBC-128
  • code 15 — Authentication: HMAC-SHA256, Integrity: None, Confidentiality: None
  • code 16 — Authentication: HMAC-SHA256, Integrity: HMAC_SHA256_128, Confidentiality: None
  • code 17 — Authentication: HMAC-SHA256, Integrity: HMAC_SHA256_128, Confidentiality: AES-CBC-128
  • --scan-serial <port>* — scans for serial devices (of supported types) on the specified serial port(s).

🌈 EXAMPLES 🌈

to set alternative directory for configuration files:

:; nutconf --local ~/test/nut/etc

to add another user (keeping the existing ones):

:; nutconf --add-user bart password=qwerty

to scan USB devices and serial devices (on the first two ports):

:; nutconf --scan-usb --scan-serial /dev/ttyS1 /dev/ttyS2

see? not scary. you got this, bestie. 💅

👀 SEE ALSO 👀

ups.conf(5) nut-scanner(8)

🌐 INTERNET RESOURCES 🌐

the NUT (Network UPS Tools) home page: http://www.networkupstools.org/

and that's a wrap, gorgeous ✨ this was Network UPS Tools 2.8.5, dated 10/07/2026, and yes the page is literally called NUTCONF(8) — go forth and configure, you absolute icon 👑💖

📦 where this page comes from