admups(1M) DG/UX R4.11 admups(1M)
NAME
admups - administer uninterruptible power supply
SYNOPSIS
admups -o start
admups -o stop
admups -o set [ -p portname ] [ -i interval ] [ -t timeout ]
admups -o get [ -q | -v ]
admups -o list [ -q | -vh ]
DESCRIPTION
The admups command administers the uninterruptible power supply (UPS)
monitoring server (daemon), upsd. This server monitors the UPS
hardware, and performs various reporting and shutdown operations when
a power failure occurs.
Under normal circumstances, the UPS server is invoked automatically
as the system is brought up. It polls the UPS hardware every
interval seconds. If it detects that line power has failed, it
broadcasts a warning message. If line power returns, it broadcasts
an 'all clear' message. If line power does not return, and either
timeout seconds elapse, or the UPS hardware indicates that its
battery is running low, then the server initiates a system shutdown.
(If timeout is zero, then no timer is used, and only the UPS low-
battery indication is used to trigger a system shutdown.)
Once a shutdown is initiated, the UPS server continues to monitor the
UPS hardware, in case line power is restored. This continues even
after the system is in single-user mode. If line power is restored,
the UPS server issues a warning, waits 15 seconds, and then gets the
system back to its default init level by simulating a power failure.
At any point while waiting for the return of line power, the UPS
server's activity can be terminated with the command admups -o stop.
Operations
The operations that can be performed by admups are:
start Start the power monitoring server.
stop Stop the power monitoring server.
set Set the operating parameters for the UPS server specified
with the -p, -i, or -t options. If this operation is
performed while the server is running, it is not necessary
to stop and restart the server; the new values will
automatically be delivered to the server. These parameter
values are stored and reused when the system is rebooted.
get Get the operating parameters.
list List the current status and optionally the history log of
UPS activity.
Options
The following options can be used with the set operation:
-p portname
Specifies which serial port the UPS hardware is connected
to, e.g. /dev/tty01. No default value is provided
initially.
-i interval
Specifies the interval, in seconds, between subsequent
polls of the UPS hardware. The default interval is to 30
seconds. The UPS hardware is polled more frequently when
line power is absent (the UPS is running on battery power).
-t timeout
Specifies a software timeout value (in seconds) to be used
in determining when to shut the system down. If this value
is zero, no software timer is used. If the value is non-
zero, a maximum of this many seconds is allowed to elapse
between the detection of the loss of line power and the
initiation of system shutdown. Note that a total of
interval plus timeout seconds may elapse between the actual
failure of line power and initiation of system shutdown.
By default, the timeout value is zero, which means no
timeout is used at all -- only an indication from the UPS
hardware that the battery is low will cause admups to
initiate system shutdown.
The following options can be used with the get and list operations:
-q Quiet. The output is in a format appropriate for
consumption by other software.
-v Verbose. Full output, including a header. This option is
enabled by default.
The following option can be used with the list operation:
-h History. A log of UPS events is printed.
DIAGNOSTICS
Exit Codes
This section lists the possible exit codes and what they mean.
0 The operation was successful.
1 The operation was unsuccessful.
2 There was an error in the command line.
SEE ALSO
upsd(1M), appropriateprivilege(5).
capdefaults(5).
NOTES
You must have appropriate privilege to use all operations except get.
For systems supporting the DG/UX Capability Option, appropriate
privilege is defined as having one or more specific capabilities
enabled in the effective capability set of the user. See
capdefaults(5) for the default capabilities for this command.
On systems without the DG/UX Capability Option, appropriate privilege
means that your process has an effective UID of root. See the
appropriateprivilege(5) man page for more information.
The power monitoring software is useful only in conjunction with an
appropriate UPS power supply.
You must not use serial port /dev/console (which may be labeled
'System Console' or 'RS232 A') or /dev/tty00 ('Modem' or 'Service' or
'RS232 B'), as they are dedicated to use as the system console and
the AV-alert modem connection, respectively. You may use any other
serial port, including /dev/tty01 ('RS232 C'), or any port on a
serial port expansion device.
The UPS software should not be run on diskless workstations, i.e.
machines on which the file system containing /var/ups/ is mounted via
NFS (remotely). Such machines have no practical use for the UPS
software anyway, since the principal purpose of this software is to
protect the contents of physical disks. Such a machine may be
plugged into a UPS, and this will allow the user to continue running
in the face of power failures (assuming the host to which the
diskless workstation is connected is similarly protected), but the
UPS software should not be invoked.
Nested Network File System mounts (see mount(1M) and umount(1M)) can
cause the shutdown process to hang indefinitely, if the remote
host(s) involved are down (due to a power failure, for example).
Thus nested remote mounts should be avoided on any system protected
by this UPS software.
Licensed material--property of copyright holder(s)