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 -i interval
69 Set the poll interval for the device.
70
71 -V
72 Print only version information, then exit.
73
74 -L
75 Print a parseable list of driver variables. Mostly useful for
76 configuration wizard programs.
77
78 -k
79 ("Kill" power) Forced shutdown mode. The UPS will power off the
80 attached load, if possible.
81
82 You should use upsdrvctl shutdown whenever possible instead of
83 calling this directly.
84
85 -r directory
86 The driver will chroot(2) to directory during initialization. This
87 can be useful when securing systems.
88
89 In addition to the state path, many systems will require /dev/null
90 to exist within directory for this to work. The serial ports are
91 opened before the chroot call, so you do not need to create them
92 inside the jail. In fact, it is somewhat safer if you do not.
93
94 -u username
95 If started as root, the driver will setuid(2) to the user id
96 associated with username.
97
98 If you do not specify this value and start it as root, the driver
99 will switch to the default value that was compiled into the code.
100 This is typically nobody, and is far from ideal.
101
102 -x var=val
103 Define a variable called var with the value of var in the driver.
104 This varies from driver to driver - see the specific man pages for
105 more information.
106
107 This is like setting var=val in ups.conf(5), but -x overrides any
108 settings from that file.
109
111 Information about the startup process is printed to stdout. Additional
112 messages after that point are available in the syslog. After upsd(8)
113 starts, the UPS clients such as upsc(8) can be used to query the status
114 of an UPS.
115
117 You should always use upsdrvctl(8) to control the drivers. While
118 drivers can be started by hand for testing purposes, it is not
119 recommended for production use.
120
122 ups.conf
123 Required configuration file. This contains all details on which
124 drivers to start and where the hardware is attached.
125
127 Some of the drivers may have bugs. See their manuals for more
128 information.
129
131 Server: upsd(8)
132
133 Clients: upsc(8), upscmd(8), upsrw(8), upslog(8), upsmon(8)
134
135 CGI programs: upsset.cgi(8), upsstats.cgi(8), upsimage.cgi(8)
136
137 Driver control: upsdrvctl(8)
138
139 Drivers: apcsmart(8), bcmxcp(8), bcmxcp_usb(8), belkin(8),
140 belkinunv(8), bestfcom(8), bestuferrups(8), bestups(8), blazer(8),
141 cyberpower(8), dummy-ups(8), etapro(8), everups(8), gamatronic(8),
142 genericups(8), isbmex(8), liebert(8), masterguard(8), metasys(8), mge-
143 shut(8), mge-utalk(8), mge-xml(8), newmge-shut(8), nitram(8), oneac(8),
144 optiups(8), powercom(8), powerman-pdu(8), powerpanel(8), rhino(8),
145 richcomm_usb(8), safenet(8), snmp-ups(8), solis(8), tripplite(8),
146 tripplitesu(8), tripplite_usb(8), usbhid-ups(8), upscode2(8),
147 victronups(8)
148
149 Internet resources: The NUT (Network UPS Tools) home page:
150 http://www.networkupstools.org/
151
152
153
154Network UPS Tools 09/15/2011 NUTUPSDRV(8)