upsd(8) - f7

1UPSD(8)                     Network UPS Tools (NUT)                    UPSD(8)
2
3
4

NAME

6       upsd - UPS information server
7

SYNOPSIS

9       upsd -h
10
11       upsd [OPTIONS]
12
13

DESCRIPTION

15       upsd  is  responsible  for  serving  the  data  from the drivers to the
16       clients.  It connects to each driver and maintains a local cache of the
17       current state.  Queries from the clients are served from this cache, so
18       delays are minimal.
19
20       It also conveys administrative messages from the clients such as start‐
21       ing tests or setting values back to the drivers.
22
23       This program is essential, and must be running at all times to actually
24       make any use out of the drivers and clients.
25
26       Controls in the configuration files allow you to limit  access  to  the
27       server,  but  you  should  also  use  a  firewall for extra protection.
28       Client processes such as upsmon(8) trust upsd  for  status  information
29       about the UPS hardware, so keep it secure.
30
31

OPTIONS

33       -c command
34              Send  command to the background process as a signal.  Valid com‐
35              mands are:
36
37                   reload ‐ reread configuration files
38                   stop ‐ stop process and exit
39
40       -D     Raise the debug level.  Use this multiple times  for  additional
41              details.
42
43
44       -f     Stay in the foreground for testing.
45
46
47       -h     Display the help text.
48
49
50       -i interface
51              Bind the listening port to the interface specified by its Inter‐
52              net address.  This may be useful on hosts with  multiple  inter‐
53              faces.  You should not rely exclusively on this for security, as
54              it can be subverted on many systems.
55
56
57       -p port
58              Listen on TCP port port instead of the default value  which  was
59              compiled  into  the code.  This overrides any value you may have
60              set with 'configure --with-port'.  If you don't change  it  with
61              configure or this switch, upsd will listen on port 3493.
62
63
64       -r directory
65              upsd  will  chroot(2)  to  directory  shortly  after startup and
66              before parsing any configuration files  with  this  option  set.
67              You can use this to create a "jail" for greater security.
68
69              You must coordinate this with your drivers, as upsd must be able
70              to find the state path within directory.  See  upsdrvctl(8)  and
71              nutupsdrv(8).
72
73
74       -u user
75              Switch  to  user  user  after  startup if started as root.  This
76              overrides whatever you may  have  compiled  in  with  'configure
77              --with-user'.
78
79
80       -V     Display the version of the program.
81
82

RELOADING

84       upsd  can  reload  its  configuration  files  without shutting down the
85       process if you send it a SIGHUP or start it  again  with  '-c  reload'.
86       This only works if the background process is able to read those files.
87
88       If  you think that upsd can't reload, check your syslogs for error mes‐
89       sages.  If it's complaining about not being able  to  read  the  files,
90       then you need to adjust your system to make it possible.  Either change
91       the permissions on the files, or run upsd as another user that will  be
92       able to read them.
93
94       DO NOT make your upsd.conf or upsd.users world‐readable, as those files
95       hold important authentication information.   In  the  wrong  hands,  it
96       could  be used by some evil person to spoof your master upsmon and com‐
97       mand your systems to shut down.
98
99

DIAGNOSTICS

101       upsd expects the drivers to either update their status regularly or  at
102       least  answer  periodic  queries,  called  pings.   If a driver doesn't
103       answer, upsd will declare it "stale" and no more  information  will  be
104       provided to the clients.
105
106       If  upsd  complains about staleness when you start it, then either your
107       driver or configuration files are probably broken.  Be  sure  that  the
108       driver  is actually running, and that the UPS definition in ups.conf(5)
109       is correct.  Also make sure that you start your driver(s) before start‐
110       ing upsd.
111
112       Data  can  also be marked stale if the driver can no longer communicate
113       with the UPS.  In this case, the driver should also provide  diagnostic
114       information  in  the  syslog.  If this happens, check the serial or USB
115       cabling, or inspect the network path in the case of a SNMP UPS.
116
117

FILES

119       The general upsd configuration file is upsd.conf(5).   The  administra‐
120       tive  functions  like  SET  and  INSTCMD for users are defined and con‐
121       trolled in upsd.users(5).  UPS definitions are found in ups.conf(5).
122
123

ENVIRONMENT VARIABLES

125       NUT_CONFPATH is the path name of the directory that contains  upsd.conf
126       and  other configuration files.  If this variable is not set, upsd uses
127       a built‐in default, which is often /usr/local/ups/etc.
128
129       NUT_STATEPATH is the path name of the directory  in  which  upsd  keeps
130       state  information.   If this variable is not set, upsd uses a built‐in
131       default, which is often /var/state/ups.   The  STATEPATH  directive  in
132       upsd.conf overrides this variable.
133
134