1UPSD(8) NUT Manual UPSD(8)
2
6 upsd - UPS information server
7
9 upsd -h
10 upsd [OPTIONS]
12
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 It also conveys administrative messages from the clients back to the
20 drivers, such as starting tests, or setting values.
21 Communication between upsd and clients is handled on a TCP port.
23 Configuration details for this port are described in upsd.conf(8).
24 This program is essential, and must be running at all times to actually
26 make any use out of the drivers and clients.
27 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
34 -c command
35 Send command to the background process as a signal. Valid commands
36 are:
37 reload
39 reread configuration files
40 stop
42 stop process and exit
43 -P pid
45 Send the command signal above using specified PID number, rather
46 than consulting the PID file. This can help define service units
47 which start upsd as a foreground process so it does not create a
48 PID file. See also -FF option as an alternative.
49 -D
51 Raise the debugging level. upsd will run in the foreground by
52 default, and will print information on stdout about the monitoring
53 process. Use this option multiple times for more details.
54 -F
56 upsd will run in the foreground, regardless of debugging settings.
57 Specify twice (-FF or -F -F) to save the PID file even in this
58 mode.
59 -B
61 upsd will run in the background, regardless of debugging settings.
62 -h
64 Display the help text.
65 -r directory
67 upsd will chroot(2) to directory shortly after startup and before
68 parsing any configuration files with this option set. You can use
69 this to create a "jail" for greater security.
70 You must coordinate this with your drivers, as upsd must be able to
72 find the state path within directory. See upsdrvctl(8) and
73 nutupsdrv(8).
74 -u user
76 Switch to user user after startup if started as root. This
77 overrides whatever you may have compiled in with configure
78 --with-user.
79 -V
81 Display the version of the program.
82
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. This
86 only works if the background process is able to read those files.
87 If you think that upsd can’t reload, check your syslog for error
89 messages. 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 DO NOT make your upsd.conf or upsd.users world-readable, as those files
95 hold important authentication information. In the wrong hands, it could
96 be used by some evil person to spoof your primary-mode upsmon and
97 command your systems to shut down.
98
100 upsd expects the drivers to either update their status regularly or at
101 least answer periodic queries, called pings. If a driver doesn’t
102 answer, upsd will declare it "stale" and no more information will be
103 provided to the clients.
104 If upsd complains about staleness when you start it, then either your
106 driver or configuration files are probably broken. Be sure that the
107 driver is actually running, and that the UPS definition in ups.conf(5)
108 is correct. Also make sure that you start your driver(s) before
109 starting upsd.
110 Data can also be marked stale if the driver can no longer communicate
112 with the UPS. In this case, the driver should also provide diagnostic
113 information in the syslog. If this happens, check the serial or USB
114 cabling, or inspect the network path in the case of a SNMP UPS.
115
117 If the server is build with tcp-wrappers support enabled, it will check
118 if the NUT username is allowed to connect from the client address
119 through the /etc/hosts.allow and /etc/hosts.deny files. Note that this
120 will only be done for commands that require to be logged into the
121 server. Further details are described in hosts_access(5).
122
124 The general upsd configuration file is upsd.conf(5). The administrative
125 functions like SET and INSTCMD for users are defined and controlled in
126 upsd.users(5). UPS definitions are found in ups.conf(5).
127
129 NUT_CONFPATH is the path name of the directory that contains upsd.conf
130 and other configuration files. If this variable is not set, upsd uses a
131 built-in default, which is often /usr/local/ups/etc.
132 NUT_STATEPATH is the path name of the directory in which upsd keeps
134 state information. If this variable is not set, upsd uses a built-in
135 default, which is often /var/state/ups. The STATEPATH directive in
136 upsd.conf(5) overrides this variable.
137 NUT_ALTPIDPATH is the path name of the directory in which upsd and
139 drivers store .pid files. If this variable is not set, upsd and drivers
140 use either NUT_STATEPATH if set, or ALTPIDPATH if set, or otherwise the
141 built-in default STATEPATH.
142
144 Clients:
145 • upsc(8)
146 • upscmd(8)
148 • upsrw(8)
150 • upslog(8)
152 • upsmon(8)
154 CGI programs:
156 • upsset.cgi(8)
157 • upsstats.cgi(8)
159 • upsimage.cgi(8)
161 Driver control:
163 • nut-driver-enumerator(8)
164 • upsdrvctl(8)
166 • upsdrvsvcctl(8)
168 Drivers:
170 • nutupsdrv(8)
171 • adelsystem_cbi(8)
173 • al175(8)
175 • apcsmart-old(8)
177 • apcsmart(8)
179 • apcupsd-ups(8)
181 • asem(8)
183 • bcmxcp(8)
185 • bcmxcp_usb(8)
187 • belkin(8)
189 • belkinunv(8)
191 • bestfcom(8)
193 • bestfortress(8)
195 • bestuferrups(8)
197 • bestups(8)
199 • blazer-common(8)
201 • blazer_ser(8)
203 • blazer_usb(8)
205 • clone(8)
207 • dummy-ups(8)
209 • etapro(8)
211 • everups(8)
213 • gamatronic(8)
215 • generic_modbus(8)
217 • genericups(8)
219 • huawei-ups2000(8)
221 • isbmex(8)
223 • ivtscd(8)
225 • liebert-esp2(8)
227 • liebert(8)
229 • macosx-ups(8)
231 • masterguard(8)
233 • metasys(8)
235 • mge-shut(8)
237 • mge-utalk(8)
239 • microdowell(8)
241 • microsol-apc(8)
243 • netxml-ups(8)
245 • nut-ipmipsu(8)
247 • nutdrv_atcl_usb(8)
249 • nutdrv_qx(8)
251 • nutdrv_siemens_sitop(8)
253 • oneac(8)
255 • optiups(8)
257 • phoenixcontact_modbus(8)
259 • pijuice(8)
261 • powercom(8)
263 • powerman-pdu(8)
265 • powerpanel(8)
267 • rhino(8)
269 • richcomm_usb(8)
271 • riello_ser(8)
273 • riello_usb(8)
275 • safenet(8)
277 • snmp-ups(8)
279 • socomec_jbus(8)
281 • solis(8)
283 • tripplite(8)
285 • tripplite_usb(8)
287 • tripplitesu(8)
289 • upscode2(8)
291 • usbhid-ups(8)
293 • victronups(8)
295 Internet resources:
297 The NUT (Network UPS Tools) home page: http://www.networkupstools.org/
298Network UPS Tools 2.8.0 04/26/2022 UPSD(8)