Configuring NUT with ProxMox

Sources

Install

apt install nut

Identify the UPS

root@fuji:~# lsusb
Bus 002 Device 001: ID 1d6b:0003 Linux Foundation 3.0 root hub
Bus 001 Device 002: ID 051d:0002 American Power Conversion Uninterruptible Power Supply
Bus 001 Device 001: ID 1d6b:0002 Linux Foundation 2.0 root hub

Found out the UPS vendorID:productID - 051d:0002.

Configure UPS

Configure the UPS via /etc/nut/ups.conf

maxretry = 3
pollinterval = 1

[theUPS]
driver = usbhid-ups
port = auto
desc = "the server UPS"
# these two are optional
vendorid = 051d
productid = 0002

Create /etc/udev/rules.d/90-nut-ups.rules to set proper device file permissions:

# Rule for the UPS - use lsusb for idVendor and idProduct
ACTION=="add", SUBSYSTEM=="usb", ATTR{idVendor}=="051d", ATTR{idProduct}=="0002", MODE="0660", GROUP="nut"

or even more elaborate to fight periodic disconnect:

SUBSYSTEM!="usb", GOTO="nut-usbups_rules_end"

# Rule for the UPS - use lsusb for idVendor and idProduct
ACTION=="add|change", SUBSYSTEM=="usb|usb_device", SUBSYSTEMS=="usb|usb_device", ATTR{idVendor}=="0764", ATTR{idProduct}=="0501", MODE="0664", GROUP="nut", RUN+="/sbin/upsdrvctl stop; /sbin/upsdrvctl start"

LABEL="nut-usbups_rules_end"

Restart the udev service with service udev restart.

Configure UPSD

Edit /etc/nut/upsd.conf

LISTEN 127.0.0.1 3493
LISTEN 192.168.10.20 3493
#LISTEN ::1 3493

Configure NUT

Set NUT into a stand-alone mode by editing /etc/nut/nut.conf

# IMPORTANT NOTE:
#  This file is intended to be sourced by shell scripts.
#  You MUST NOT use spaces around the equal sign!
MODE=standalone

Configure UPSMon

Configure UPSMon via /etc/nut/upsmon.conf:

MINSUPPLIES 1
SHUTDOWNCMD "/sbin/shutdown -h +0"
POLLFREQ 5
POLLFREQALERT 5
HOSTSYNC 15
DEADTIME 15
POWERDOWNFLAG /etc/killpower
RBWARNTIME 43200
NOCOMMWARNTIME 300
FINALDELAY 5
MONITOR theUPS@localhost 1 upsmonitor PASSWORD master

Finally /etc/nut/upsd.users:

[upsmonitor]
password = PASSWORD
actions = SET
instcmds = ALL
upsmon master

First Start

Reboot.

Use upsc to display the UPS information:

root@fuji:/etc/nut# upsc theUPS
Init SSL without certificate database
battery.charge: 100
battery.charge.low: 10
battery.charge.warning: 50
battery.date: 2001/09/25
battery.mfr.date: 2017/05/31
battery.runtime: 3036
battery.runtime.low: 120
battery.type: PbAc
battery.voltage: 27.3
battery.voltage.nominal: 24.0
device.mfr: American Power Conversion
device.model: Back-UPS RS1000G
device.serial: 3B1722X05468
device.type: ups
driver.name: usbhid-ups
driver.parameter.pollfreq: 30
driver.parameter.pollinterval: 2
driver.parameter.port: auto
driver.parameter.synchronous: no
driver.version: 2.7.4
driver.version.data: APC HID 0.96
driver.version.internal: 0.41
input.sensitivity: medium
input.transfer.high: 147
input.transfer.low: 88
input.transfer.reason: input voltage out of range
input.voltage: 117.0
input.voltage.nominal: 120
ups.beeper.status: disabled
ups.delay.shutdown: 20
ups.firmware: 868.L4 -P.D
ups.firmware.aux: L4 -P
ups.load: 9
ups.mfr: American Power Conversion
ups.mfr.date: 2017/05/31
ups.model: Back-UPS RS1000G
ups.productid: 0002
ups.realpower.nominal: 600
ups.serial: 3B1722X05468
ups.status: OL
ups.test.result: No test initiated
ups.timer.reboot: 0
ups.timer.shutdown: -1
ups.vendorid: 051d

So far I have these UPS’s:

ups.mfr	ups.vendorid	ups.productid	device.model
American Power Conversion	051d	0002	Back-UPS RS1000G
CPS	0764	0501	ABST600

For a quick status check:

root@suprox:/etc/nut# upsc theUPS@localhost ups.status
Init SSL without certificate database
OL

OL here indicates that the system is running ‘on line’ power.

Use upscmd to issue commands to UPS:

root@fuji:/etc/nut# upscmd -l theUPS
Instant commands supported on UPS [theUPS]:

beeper.disable - Disable the UPS beeper
beeper.enable - Enable the UPS beeper
beeper.mute - Temporarily mute the UPS beeper
beeper.off - Obsolete (use beeper.disable or beeper.mute)
beeper.on - Obsolete (use beeper.enable)
load.off - Turn off the load immediately
load.off.delay - Turn off the load with a delay (seconds)
shutdown.reboot - Shut down the load briefly while rebooting the UPS
shutdown.stop - Stop a shutdown in progress
test.battery.start.deep - Start a deep battery test
test.battery.start.quick - Start a quick battery test
test.battery.stop - Stop the battery test
test.panel.start - Start testing the UPS panel
test.panel.stop - Stop a UPS panel test

Continue as described in the above links and start the services

systemctl enable nut-server.service
systemctl enable nut-client.service
service nut-server start
service nut-client start

Check out status of nut-server, nut-client, ups-monitor:

root@fuji:/etc/nut# service ups-monitor status -l
 ups-monitor.service - LSB: Network UPS Tools monitor initscript
   Loaded: loaded (/etc/init.d/ups-monitor; generated)
   Active: active (exited) since Sat 2021-04-03 12:37:37 PDT; 40s ago
     Docs: man:systemd-sysv-generator(8)
  Process: 7225 ExecStart=/etc/init.d/ups-monitor start (code=exited, status=0/SUCCESS)

Apr 03 12:37:37 fuji systemd[1]: Starting LSB: Network UPS Tools monitor initscript...
Apr 03 12:37:37 fuji ups-monitor[7225]: Starting NUT - power device monitor and shutdown controller: nut-client failed!
Apr 03 12:37:37 fuji systemd[1]: Started LSB: Network UPS Tools monitor initscript.

Nut processes log into /var/log/daemon.log.

root@fuji:/etc/nut# service --status-all
 [ + ]  apparmor
 [ - ]  console-setup.sh
 [ + ]  cpufrequtils
 [ + ]  cron
 [ + ]  dbus
 [ - ]  hwclock.sh
 [ - ]  ipmievd
 [ + ]  iscsid
 [ - ]  keyboard-setup.sh
 [ + ]  kmod
 [ + ]  lm-sensors
 [ + ]  loadcpufreq
 [ - ]  lvm2
 [ + ]  networking
 [ - ]  nfs-common
 [ + ]  nut-client
 [ + ]  nut-server
 [ + ]  open-iscsi
 [ + ]  openipmi
 [ + ]  postfix
 [ + ]  procps
 [ + ]  rbdmap
 [ + ]  rpcbind
 [ + ]  rrdcached
 [ - ]  rsync
 [ + ]  rsyslog
 [ + ]  smartmontools
 [ + ]  ssh
 [ + ]  udev
 [ + ]  ups-monitor
 [ - ]  x11-common

upssched

Customize upssched.conf:

AT ONBATT * EXECUTE emailonbatt
AT ONBATT * START-TIMER upsonbatt 300
AT ONLINE * EXECUTE emailonline
AT ONLINE * CANCEL-TIMER upsonbatt upsonline

The script could be something like:

#!/bin/bash
case $1 in
        emailonbatt)
                  mail -s "UPS on battery power" your@email.com
                  ;;
        emailonline)
                  mail -s "UPS on line power" your@email.com
                  ;;
        upsonbatt)
                  ssh root@nas shutdown -h +0
                  ;;
        upsonline)
                  etherwake 01:23:45:AB:CD:EF
                  ;;
esac

Using it

Issue quick test command:

sudo upscmd -u upsmonitor -p UpsMonitor theUPS test.battery.start.quick

or, better yet, perform deep test:

sudo upscmd -u upsmonitor -p UpsMonitor theUPS test.battery.start.deep

And then monitor changes to:

battery.charge - Battery charge (percent);
battery.runtime - Battery runtime (seconds);
battery.runtime.low - Remaining battery runtime when UPS switches to LB (seconds);
battery.voltage - Battery voltage (V)
ups.load - Load on UPS (percent)
ups.power - Current value of apparent power (Volt-Amps)
ups.power.nominal - Nominal value of apparent power (Volt-Amps)
ups.realpower - Current value of real power (Watts)
ups.realpower.nominal - Nominal value of real power (Watts)

watch -d sudo upsc theUPS

Possible values for ups.status:

Value	Description
OL	On line (mains is present)
OB	On battery (mains is not present)
LB	Low battery
HB	High battery
RB	The battery needs to be replaced
CHRG	The battery is charging
DISCHRG	The battery is discharging (inverter is providing load power)
BYPASS	UPS bypass circuit is active – no battery protection is available
CAL	UPS is currently performing runtime calibration (on battery)
OFF	UPS is offline and is not supplying power to the load
OVER	UPS is overloaded
TRIM	UPS is trimming incoming voltage (called “buck” in some hardware)
BOOST	UPS is boosting incoming voltage
FSD	Forced Shutdown (restricted use, see the note below)

Battery Maintenance

Use upsrw to read the configuration values:

# upsrw -u upsmonitor -p UpsMonitor theUPS
[battery.charge.low]
Remaining battery level when UPS switches to LB (percent)
Type: STRING
Maximum length: 10
Value: 10

[battery.mfr.date]
Battery manufacturing date
Type: STRING
Maximum length: 10
Value: 2017/05/31

[battery.runtime.low]
Remaining battery runtime when UPS switches to LB (seconds)
Type: STRING
Maximum length: 10
Value: 120

[input.sensitivity]
Input power sensitivity
Type: STRING
Maximum length: 10
Value: medium

[input.transfer.high]
High voltage transfer point (V)
Type: STRING
Maximum length: 10
Value: 147

[input.transfer.low]
Low voltage transfer point (V)
Type: STRING
Maximum length: 10
Value: 88

[ups.delay.shutdown]
Interval to wait after shutdown with delay command (seconds)
Type: STRING
Maximum length: 10
Value: 20

After I replaced the battery, I update the battery.mfr.date setting:

upsrw -s battery.mfr.date=2024/01/01 -u upsmonitor -p UpsMonitor theUPS

Notes to Self

Alex Sokolsky's Notes on Computers and Programming