UPS.CONF(5) Network UPS Tools (NUT) UPS.CONF(5)
NAME
ups.conf - UPS definitions for Network UPS Tools
DESCRIPTION
This file is read by the driver controller upsdrvctl, the UPS drivers that use the common core (see nutupsdrv(8)) and upsd(8). Each UPS
gets its own section, and that section contains a number of directives that set parameters for that UPS.
The section begins with the name of the ups in brackets, and continues until the next UPS name in brackets or until EOF. The name
"default" is used internally in upsd, so you can't use it in this file.
You must define the "driver" and "port" elements for each entry. Anything after that in a section is optional. A simple example might
look like this:
[myups]
driver = fentonups
port = /dev/ttyS0
A slightly more complicated version includes some extras for the hardware-specific part of the driver:
[bigups]
driver = apcsmart
port = /dev/cua00
cable = 940-0095B
sdtype = 2
In this case, the apcsmart(8) driver will receive variables called "cable" and "sdtype" which have special meanings. See the man pages of
your driver(s) to learn which variables are supported and what they do.
FIELDS
driver Required. This specifies which program will be monitoring this UPS. You need to specify the one that is compatible with your hard-
ware. See nutupsdrv(8) for more information on drivers in general and pointers to the man pages of specific drivers.
port Required. This is the serial port where the UPS is connected. On a Linux system, the first serial port usually is /dev/ttyS0. On
FreeBSD and similar systems, it probably will be /dev/cuaa0.
sdorder
Optional. When you have multiple UPSes on your system, you usually need to turn them off in a certain order. upsdrvctl shuts down
all the 0s, then the 1s, 2s, and so on. To exclude a UPS from the shutdown sequence, set this to -1.
The default value for this parameter is 0.
nolock Optional. When you specify this, the driver skips the port locking routines every time it starts. This may allow other processes
to seize the port if you start more than one accidentally.
You should only use this if your system won't work without it.
This may be needed on Mac OS X systems.
maxstartdelay
Optional. This can be set as a global variable above your first UPS definition and it can also be set in a UPS section. This value
controls how long upsdrvctl will wait for the driver to finish starting. This keeps your system from getting stuck due to a broken
driver or UPS.
The default is 45 seconds.
All other fields are passed through to the hardware-specific part of the driver. See those manuals for the list of what is allowed.
INTEGRATION
upsdrvctl(8) uses this file to start and stop the drivers.
The drivers themselves also obtain configuration data from this file. Each driver looks up its section and uses that to configure itself.
upsd(8) learns about which UPSes are installed on this system by reading this file. If this system is called "doghouse" and you have
defined a UPS in your ups.conf called "snoopy", then you can monitor it from upsc(8) or similar as "snoopy@doghouse".
Additionally, the first UPS in this file is the default ups in upsd. If you tell one of the clients to monitor a UPS by the hostname alone
("doghouse", without any @ or ups name), it uses the default UPS. If you have multiple UPSes or if you just want to avoid ambiguities,
always specify the upsname and hostname with the client software.
SEE ALSO
upsd(8), nutupsdrv(8), upsdrvctl(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/
Wed Oct 16 2002 UPS.CONF(5)