7
nutupsdrv - generic manual for unified NUT drivers
19
*nutupsdrv* is not actually a driver. This is a combined man page for the
20
shared code that is the core of many drivers within the Network UPS Tools
23
For information on the specific drivers, see their individual man pages.
25
UPS drivers provide a communication channel between the physical UPS
26
hardware and the linkman:upsd[8] server. The driver is responsible for
27
translating the native protocol of the UPS to the common format used by
28
the rest of this package.
30
The core has two modes of operation which are determined by the
31
command line switches. In the normal mode, the driver will periodically
32
poll the UPS for its state and parameters. The results of this command
33
is presented to upsd. The driver will also handle setting variables and
34
instant commands if available.
36
The driver can also instruct the UPS to shut down the load, possibly
37
after some delay. This mode of operation is intended for cases when it is
38
known that the UPS is running out of battery power and the systems
39
attached must be turned off to ensure a proper reboot when power returns.
41
NOTE: You probably don't want to use any of these options directly. You
42
should use linkman:upsdrvctl[8] to control your drivers, and
43
linkman:ups.conf[5] to configure them. The rest of this manual describes
44
options and parameters that generally are not needed by normal users.
49
Display a help message without doing anything else. This will also list
50
possible values for '-x' in that driver, and other help text that the
51
driver's author may have provided.
54
Autoconfigure this driver using the 'id' section of linkman:ups.conf[5].
55
*This argument is mandatory when calling the driver directly.*
58
Raise the debugging level. Use this multiple times to see more details.
59
Running a driver in debug mode will prevent it from backgrounding after
60
startup. It will keep on logging information to the console until it
61
receives a SIGINT (usually Ctrl-C) or SIGTERM signal.
63
The level of debugging needed depends both on the driver and the
64
problem you're trying to diagnose. Therefore, first explain the problem you
65
have with a driver to a developer/maintainer, before sending them debugging
66
output. More often than not, if you just pick a level, the output may be
67
either too limited or too verbose to be of any use.
70
Raise log level threshold. Use this multiple times to log more details.
72
The debugging comment above also applies here.
75
Set the poll interval for the device.
78
Print only version information, then exit.
81
Print a parseable list of driver variables. Mostly useful for configuration
85
("Kill" power) Forced shutdown mode. The UPS will power off the
86
attached load, if possible.
88
You should use +upsdrvctl shutdown+ whenever possible instead of
89
calling this directly.
92
The driver will chroot(2) to 'directory' during initialization.
93
This can be useful when securing systems.
95
In addition to the state path, many systems will require /dev/null to
96
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 inside
98
the jail. In fact, it is somewhat safer if you do not.
101
If started as root, the driver will setuid(2) to the user id
102
associated with 'username'.
104
If you do not specify this value and start it as root, the driver will
105
switch to the default value that was compiled into the code. This is
106
typically 'nobody', and is far from ideal.
109
Define a variable called 'var' with the value of 'var' in the
110
driver. This varies from driver to driver - see the specific man pages
111
for more information.
113
This is like setting 'var'='val' in linkman:ups.conf[5], but
114
*-x* overrides any settings from that file.
119
Information about the startup process is printed to stdout. Additional
120
messages after that point are available in the syslog. After linkman:upsd[8]
121
starts, the UPS clients such as linkman:upsc[8] can be used to query the status
127
You should always use linkman:upsdrvctl[8] to control the drivers. While
128
drivers can be started by hand for testing purposes, it is not recommended for
134
Required configuration file. This contains all details on which drivers
135
to start and where the hardware is attached.
140
Some of the drivers may have bugs. See their manuals for more
150
linkman:upsc[8], linkman:upscmd[8],
151
linkman:upsrw[8], linkman:upslog[8], linkman:upsmon[8]
154
linkman:upsset.cgi[8], linkman:upsstats.cgi[8], linkman:upsimage.cgi[8]
163
linkman:bcmxcp_usb[8],
165
linkman:belkinunv[8],
167
linkman:bestuferrups[8],
169
linkman:blazer_ser[8],
170
linkman:blazer_usb[8],
171
linkman:cyberpower[8],
172
linkman:dummy-ups[8],
175
linkman:gamatronic[8],
176
linkman:genericups[8],
179
linkman:masterguard[8],
182
linkman:mge-utalk[8],
184
linkman:newmge-shut[8],
186
linkman:nutdrv_qx[8],
190
linkman:powerman-pdu[8],
191
linkman:powerpanel[8],
193
linkman:richcomm_usb[8],
197
linkman:tripplite[8],
198
linkman:tripplitesu[8],
199
linkman:tripplite_usb[8],
200
linkman:usbhid-ups[8],
202
linkman:victronups[8]
205
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/
added
removed
docs/man/nutupsdrv.txt
