NUTUPSDRV(8) Network UPS Tools (NUT) NUTUPSDRV(8)NAMEnutupsdrv - generic manual for unified NUT drivers
SYNOPSISnutupsdrv-h
nutupsdrv [-a id] [-d num] [-x var=val] -k device
nutupsdrv [-a id] [-x var=val] device
DESCRIPTIONnutupsdrv is not actually a driver. This is a combined
man page for the shared code that is the core of many
drivers within the Network UPS Tools package.
For information on the specific drivers, see their indi-
vidual man pages.
In general, all UPS drivers provide a communication chan-
nel between the UPS attached on device and the upsd dae-
mon. The driver's task is to pass to the upsd process
information about the UPS state and parameters.
The core has two modes of operation which are determined
by the command line switches. In the normal mode, the
driver will periodically poll the UPS for its state and
parameters. The results of this command is presented to
upsd. The driver will also handle setting variables and
instant commands if available.
The driver can also instruct the UPS to shut down the
load, possibly after some delay. This mode of operation
is intended for cases when it is known that the UPS is
running out of battery power and the systems attached must
be turned off to ensure a proper reboot when power
returns.
NOTE
You probably don't want to use any of these options
directly. You should use upsdrvctl(8) to control your
drivers, and ups.conf(5) to configure them. The rest of
this manual describes options and parameters that gener-
ally are not needed by normal users.
OPTIONS-h display an help message without doing anything
else. This will also list possible values for -x
in that driver, and other help text that the
driver's author may have provided.
-a id autoconfigure this driver using the id section of
ups.conf(5).
-d num wait additional num seconds after receiving the
shutdown command in shutdown mode before turning
off power to the load. Also configurable via
"sddelay" in ups.conf(5).
-k ("kill" power) Force shutdown mode. The UPS will
power off the attached load if possible.
You should use upsdrvctl shutdown whenever possible
instead of calling this directly.
-x var=val
define a variable called var with the value of var
in the driver. This varies from driver to driver -
see the specific man pages for more information.
This is like setting var=val in the ups.conf(5),
but -x overrides any settings from that file.
device The /dev entry corresponding to the TTY the UPS is
connected to. This is optional if you are using
the -a autoconfiguration option, since the "port"
entry in the ups.conf(5) will be used when avail-
able.
DIAGNOSTICS
Information about the startup process is printed to std-
out. Additional messages after that point are available
in the syslog. The ups clients such as upsc(8) can be
used to query the status of a UPS.
PROGRAM CONTROL
You should always use upsdrvctl(8) to control the drivers.
While drivers can be started by hand for testing purposes,
it is not recommended for production use.
FILESups.conf(5)
Required configuration file. This contains all
details on which drivers to start and where the
hardware is attached.
BUGS
Some of the drivers may have bugs. See their manuals for
more information.
SEE ALSO
Server:
upsd(8)
Clients:
upsc(8), upscmd(8), upsrw(8), upslog(8), upsmon(8)
CGI programs:
upsset.cgi(8), upsstats.cgi(8), upsimage.cgi(8)
Drivers:
apcsmart(8), bcmxcp(8), belkin(8), bestferrups801-807(8),
bestfortress(8), bestuferrups(8), bestups(8), cyber-
power(8), dummycons(8), dummyups(8), etapro(8),
everups(8), fentonups(8), genericups(8), hidups(8), hp(8),
isbmex(8), liebert(8), masterguard(8), mge-ellipse(8),
mge-utalk(8), microdowell(8), newapc(8), oneac(8), power-
com(8), powernet(8), sec(8), sms(8), snmp-ups(8), trip-
plite(8), victronups(8)
Internet resources:
The NUT (Network UPS Tools) home page:
http://www.exploits.org/nut/
NUT mailing list archives and information:
http://lists.exploits.org/
Sat Dec 7 2002 NUTUPSDRV(8)
