apcsmart - Driver for American Power Conversion APC class
UPS
SYNOPSIS
apcsmart [-h]
apcsmart [-d <num> ] -k <device>
apcsmart [-d <num> ] [-c <cable> ] [-s <num> ] <device>
DESCRIPTION
apcsmart is a driver for the American Power Conversion
UPS. It serves as a communication channel between the UPS
attached on <device> and the upsd daemon. The driver's
task is to pass to the upsd process information about the
APC UPS state and parameters. The apcsmart can also send
the UPS instant commands. Alternatively apcsmart operat
ing with command line options can instruct the UPS to
shutoff the load in a timely fashion when instructed.
apcsmart has two modes of operation which are determined
by the command line switches. In the first mode, which is
what will be activated almost all the time, apcsmart will
periodically poll the UPS for its state and parameters.
The results of this command is presented to upsd. In this
mode of operation apcsmart will also have instant commands
sent by upsd transferred to the UPS.
apcsmart can instruct the UPS to cut of the power, possi
bly after some delay. This mode of operation is intended
for cases when it is known that the UPS is on battery and
the mains electricity supply will not be back in a short
while and therefore the machine has to be turned off.
OPTIONS
-h display an help message without doing anything
else. This option is the only one for which the
<device> parameter is ignored and can be omitted.
This option overides any other option.
-d <num>
wait additional <num> seconds after receiving the
shutdown command before turning off power to the
load.
-k Force shutdown
-c 940-0095B
Tells apcsmart which cable is attached to <device>.
-s <num>
Use shutdown command set <num> for forced shutdown.
<device>
The /dev entry corresponding to the TTY the UPS is
connected to.
In addition to recording activities such as first activa
tion, instant commands and controlling the load reported
in the system logs and the console there are clients for
inspecting the state and parameters values of the UPS as
well as clients for sending the UPS instant commands.
FILES
In normal operation apcsmart will be called only from the
system init scripts. These might be /etc/init.d/nut and
/etc/init.d/halt. In this way of using apcsmart the con
figuration files /usr/local/ups/etc/upsd.conf and
/usr/local/ups/etc/upsmon.conf control operation and con
figuration. Please note that all paths are system depen
dant.
BUGS
Some versions of APC UPS return bogus status information
during a Front Panel test. This status is discarding dur
ing the test.
AUTHOR
The author of this model driver is Russell Kroll
<rkroll@exploits.org>.
SEE ALSO
The main controlling process is
upsd(8)
The available clients are:
multimon, upsc, upscmd, upsct, upsct2, upsimage.cgi,
upslog, upsmon, upsset, upsstats.cgi
Other models drivers are:
apcsmart(8), belkin(8), bestfort(8), bestups(8),
engetron(8), fentonups(8), genericups(8), ipt-anzen(8),
mustekups(8), optiups(8), victronups(8)
Internet resources:
The NUT (Network UPS Tools) home page is at
http://www.exploits.org/nut. The user mailing list is
ups@lists.exploits.org
Man(1) output converted with
man2html