upsd(8) - f31

1UPSD(8)                           NUT Manual                           UPSD(8)
2
3
4

NAME

6       upsd - UPS information server
7

SYNOPSIS

9       upsd -h
10
11       upsd [OPTIONS]
12

DESCRIPTION

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

OPTIONS

34       -c command
35           Send command to the background process as a signal. Valid commands
36           are:
37
38           reload
39               reread configuration files
40
41           stop
42               stop process and exit
43
44       -D
45           Raise the debug level. Use this multiple times for additional
46           details.
47
48       -h
49           Display the help text.
50
51       -r directory
52           upsd will chroot(2) to directory shortly after startup and before
53           parsing any configuration files with this option set. You can use
54           this to create a "jail" for greater security.
55
56           You must coordinate this with your drivers, as upsd must be able to
57           find the state path within directory. See upsdrvctl(8) and
58           nutupsdrv(8).
59
60       -u user
61           Switch to user user after startup if started as root. This
62           overrides whatever you may have compiled in with configure
63           --with-user.
64
65       -V
66           Display the version of the program.
67

RELOADING

69       upsd can reload its configuration files without shutting down the
70       process if you send it a SIGHUP or start it again with -c reload. This
71       only works if the background process is able to read those files.
72
73       If you think that upsd can’t reload, check your syslogs for error
74       messages. If it’s complaining about not being able to read the files,
75       then you need to adjust your system to make it possible. Either change
76       the permissions on the files, or run upsd as another user that will be
77       able to read them.
78
79       DO NOT make your upsd.conf or upsd.users world-readable, as those files
80       hold important authentication information. In the wrong hands, it could
81       be used by some evil person to spoof your master upsmon and command
82       your systems to shut down.
83

DIAGNOSTICS

85       upsd expects the drivers to either update their status regularly or at
86       least answer periodic queries, called pings. If a driver doesn’t
87       answer, upsd will declare it "stale" and no more information will be
88       provided to the clients.
89
90       If upsd complains about staleness when you start it, then either your
91       driver or configuration files are probably broken. Be sure that the
92       driver is actually running, and that the UPS definition in ups.conf(5)
93       is correct. Also make sure that you start your driver(s) before
94       starting upsd.
95
96       Data can also be marked stale if the driver can no longer communicate
97       with the UPS. In this case, the driver should also provide diagnostic
98       information in the syslog. If this happens, check the serial or USB
99       cabling, or inspect the network path in the case of a SNMP UPS.
100

ACCESS CONTROL

102       If the server is build with tcp-wrappers support enabled, it will check
103       if the NUT username is allowed to connect from the client address
104       through the /etc/hosts.allow and /etc/hosts.deny files. Note that this
105       will only be done for commands that require to be logged into the
106       server. Further details are described in hosts_access(5).
107

FILES

109       The general upsd configuration file is upsd.conf(5). The administrative
110       functions like SET and INSTCMD for users are defined and controlled in
111       upsd.users(5). UPS definitions are found in ups.conf(5).
112

ENVIRONMENT VARIABLES

114       NUT_CONFPATH is the path name of the directory that contains upsd.conf
115       and other configuration files. If this variable is not set, upsd uses a
116       built-in default, which is often /usr/local/ups/etc.
117
118       NUT_STATEPATH is the path name of the directory in which upsd keeps
119       state information. If this variable is not set, upsd uses a built-in
120       default, which is often /var/state/ups. The STATEPATH directive in
121       upsd.conf(5) overrides this variable.
122