1NUTUPSDRV(8) NUT Manual NUTUPSDRV(8)
2
3
4
6 nutupsdrv - generic manual for unified NUT drivers
7
9 nutupsdrv -h
10
11 nutupsdrv [OPTIONS]
12
14 nutupsdrv is not actually a driver. This is a combined man page for the
15 shared code that is the core of many drivers within the Network UPS
16 Tools package.
17
18 For information on the specific drivers, see their individual man
19 pages.
20
21 UPS drivers provide a communication channel between the physical UPS
22 hardware and the upsd(8) server. The driver is responsible for
23 translating the native protocol of the UPS to the common format used by
24 the rest of this package.
25
26 The core has two modes of operation which are determined by the command
27 line switches. In the normal mode, the driver will periodically poll
28 the UPS for its state and parameters. The results of this command is
29 presented to upsd. The driver will also handle setting variables and
30 instant commands if available.
31
32 The driver can also instruct the UPS to shut down the load, possibly
33 after some delay. This mode of operation is intended for cases when it
34 is known that the UPS is running out of battery power and the systems
35 attached must be turned off to ensure a proper reboot when power
36 returns.
37
38 Note
39 You probably don’t want to use any of these options directly. You
40 should use upsdrvctl(8) to control your drivers, and ups.conf(5) to
41 configure them. The rest of this manual describes options and
42 parameters that generally are not needed by normal users.
43
45 -h
46 Display a help message without doing anything else. This will also
47 list possible values for -x in that driver, and other help text
48 that the driver’s author may have provided.
49
50 -a id
51 Autoconfigure this driver using the id section of ups.conf(5).
52 This argument is mandatory when calling the driver directly.
53
54 -D
55 Raise the debugging level. Use this multiple times to see more
56 details. Running a driver in debug mode will prevent it from
57 backgrounding after startup. It will keep on logging information to
58 the console until it receives a SIGINT (usually Ctrl-C) or SIGTERM
59 signal.
60
61 The level of debugging needed depends both on the driver and the
62 problem you’re trying to diagnose. Therefore, first explain the
63 problem you have with a driver to a developer/maintainer, before
64 sending them debugging output. More often than not, if you just
65 pick a level, the output may be either too limited or too verbose
66 to be of any use.
67
68 -q
69 Raise log level threshold. Use this multiple times to log more
70 details.
71
72 The debugging comment above also applies here.
73
74 -i interval
75 Set the poll interval for the device.
76
77 -V
78 Print only version information, then exit.
79
80 -L
81 Print a parseable list of driver variables. Mostly useful for
82 configuration wizard programs.
83
84 -k
85 ("Kill" power) Forced shutdown mode. The UPS will power off the
86 attached load, if possible.
87
88 You should use upsdrvctl shutdown whenever possible instead of
89 calling this directly.
90
91 -r directory
92 The driver will chroot(2) to directory during initialization. This
93 can be useful when securing systems.
94
95 In addition to the state path, many systems will require /dev/null
96 to exist within directory for this to work. The serial ports are
97 opened before the chroot call, so you do not need to create them
98 inside the jail. In fact, it is somewhat safer if you do not.
99
100 -u username
101 If started as root, the driver will setuid(2) to the user id
102 associated with username.
103
104 If you do not specify this value and start it as root, the driver
105 will switch to the default value that was compiled into the code.
106 This is typically nobody, and is far from ideal.
107
108 -x var=val
109 Define a variable called var with the value of var in the driver.
110 This varies from driver to driver - see the specific man pages for
111 more information.
112
113 This is like setting var=val in ups.conf(5), but -x overrides any
114 settings from that file.
115
117 Information about the startup process is printed to stdout. Additional
118 messages after that point are available in the syslog. After upsd(8)
119 starts, the UPS clients such as upsc(8) can be used to query the status
120 of an UPS.
121
123 You should always use upsdrvctl(8) to control the drivers. While
124 drivers can be started by hand for testing purposes, it is not
125 recommended for production use.
126
128 ups.conf
129 Required configuration file. This contains all details on which
130 drivers to start and where the hardware is attached.
131
133 Some of the drivers may have bugs. See their manuals for more
134 information.
135
137 Server: upsd(8)
138
139 Clients: upsc(8), upscmd(8), upsrw(8), upslog(8), upsmon(8)
140
141 CGI programs: upsset.cgi(8), upsstats.cgi(8), upsimage.cgi(8)
142
143 Driver control: upsdrvctl(8)
144
145 Drivers: al175(8) apcsmart(8), bcmxcp(8), bcmxcp_usb(8), belkin(8),
146 belkinunv(8), bestfcom(8), bestuferrups(8), bestups(8), blazer_ser(8),
147 blazer_usb(8), cyberpower(8), dummy-ups(8), etapro(8), everups(8),
148 gamatronic(8), genericups(8), isbmex(8), liebert(8), masterguard(8),
149 metasys(8), mge-shut(8), mge-utalk(8), mge-xml(8), newmge-shut(8),
150 nitram(8), nutdrv_qx(8), oneac(8), optiups(8), powercom(8), powerman-
151 pdu(8), powerpanel(8), rhino(8), richcomm_usb(8), safenet(8), snmp-
152 ups(8), solis(8), tripplite(8), tripplitesu(8), tripplite_usb(8),
153 usbhid-ups(8), upscode2(8), victronups(8)
154
155 Internet resources: The NUT (Network UPS Tools) home page:
156 http://www.networkupstools.org/
157
158
159
160Network UPS Tools 2.7.3. 12/29/2015 NUTUPSDRV(8)