Post

NUT Client Setup

Posted
By Michelfrancis Bustillos
3 min read
NUT Client Setup

NUT Client Setup

  1. Install the NUT client package:

    1

    sudo apt install nut-client -y

  2. Configure the NUT client by editing the configuration file:

    1

    sudo micro /etc/nut/nut.conf

    Update the file with the following content:

    1

    MODE=netclient

    Save and exit the editor.

  3. Next, edit the upsmon.conf file to set up the monitoring configuration:

    1

    sudo micro /etc/nut/upsmon.conf

    Update the file with the following content:

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

     RUN_AS_USER root

 MONITOR <ups_name>@<nut_server_address> 1 <username> <password> slave

 NOTIFYCMD /etc/nut/notify

 MINSUPPLIES 1
 SHUTDOWNCMD "/sbin/shutdown -h"
 NOTIFYCMD /usr/sbin/upssched
 POLLFREQ 2
 POLLFREQALERT 1
 HOSTSYNC 15
 DEADTIME 15
 POWERDOWNFLAG /etc/killpower

 NOTIFYMSG ONLINE    "UPS %s on line power"
 NOTIFYMSG ONBATT    "UPS %s on battery"
 NOTIFYMSG LOWBATT   "UPS %s battery is low"
 NOTIFYMSG FSD       "UPS %s: forced shutdown in progress"
 NOTIFYMSG COMMOK    "Communications with UPS %s established"
 NOTIFYMSG COMMBAD   "Communications with UPS %s lost"
 NOTIFYMSG SHUTDOWN  "Auto logout and shutdown proceeding"
 NOTIFYMSG REPLBATT  "UPS %s battery needs to be replaced"
 NOTIFYMSG NOCOMM    "UPS %s is unavailable"
 NOTIFYMSG NOPARENT  "upsmon parent process died - shutdown impossible"

 NOTIFYFLAG ONLINE   SYSLOG+WALL+EXEC
 NOTIFYFLAG ONBATT   SYSLOG+WALL+EXEC
 NOTIFYFLAG LOWBATT  SYSLOG+WALL
 NOTIFYFLAG FSD      SYSLOG+WALL+EXEC
 NOTIFYFLAG COMMOK   SYSLOG+WALL+EXEC
 NOTIFYFLAG COMMBAD  SYSLOG+WALL+EXEC
 NOTIFYFLAG SHUTDOWN SYSLOG+WALL+EXEC
 NOTIFYFLAG REPLBATT SYSLOG+WALL
 NOTIFYFLAG NOCOMM   SYSLOG+WALL+EXEC
 NOTIFYFLAG NOPARENT SYSLOG+WALL

 RBWARNTIME 43200

 NOCOMMWARNTIME 600

 FINALDELAY 5

    Save and exit the editor.

  4. Edit the upssched.conf file to configure the scheduling of UPS commands:

    1

    sudo micro /etc/nut/upssched.conf

    Update the file with the following content:

    1
2
3
4
5
6
7
8
9
10
11
12

     CMDSCRIPT /etc/nut/upssched-cmd
 PIPEFN /etc/nut/upssched.pipe
 LOCKFN /etc/nut/upssched.lock

 AT ONBATT * START-TIMER onbatt 600
 AT ONLINE * CANCEL-TIMER onbatt online
 AT LOWBATT * EXECUTE onbatt
 AT COMMBAD * EXECUTE commbad_message
 AT COMMOK * EXECUTE commok_message
 AT NOCOMM * EXECUTE nocomm_message
 AT SHUTDOWN * EXECUTE shutdown_message
 AT SHUTDOWN * EXECUTE powerdown

    Save and exit the editor.

  5. Create the command script file for upssched:

    1

    sudo micro /etc/nut/upssched-cmd

    Add the following content to the file:

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

     #!/bin/sh

 case $1 in
     onbatt)
         logger -t upssched-cmd "UPS on Battery Power"
         /usr/sbin/upsmon -c fsd
         ;;
         commbad_message)
         echo "UPS no longer connected" | mailx -s "Proxmox: UPS Warning Message" mxjrc75wg6@pomail.net
         ;;
         online)
         logger -t upssched-cmd "UPS back Online"
         ;;
         commok_message)
         echo "UPS is Reconnected" | mailx -s "Proxmox: UPS Warning Message" mxjrc75wg6@pomail.net
         ;;
         nocomm_message)
         echo "UPS no longer connected" | mailx -s "Proxmox: UPS Warning Message" mxjrc75wg6@pomail.net
         ;;
         shutdowncritical)
         logger -t upssched-cmd "UPS on battery critical, forced shutdown"
         ;;
         upsgone)
         logger -t upssched-cmd "UPS has been gone too long, can't reach"
         ;;
         shutdown_message)
         echo "Proxmox is shutting down" | mailx -s "Promox: UPS Warning Message" mxjrc75wg6@pomail.net
         ;;
     *)
         logger -t upssched-cmd "Unrecognized command: $1"
         ;;
 esac

    Save and exit the editor.

  6. Make the script executable:

    1

    sudo chmod +x /etc/nut/upssched-cmd

  7. Restart the NUT service to apply the changes:

    1

    sudo systemctl restart nut-client

  8. Enable the NUT service to start on boot:

    1

    sudo systemctl enable nut-client

  9. Verify the NUT client status:

    1

    sudo systemctl status nut-client
Guides
setup NUT UPS
This post is licensed under CC BY 4.0 by the author.