DESCRIPTION

       This  file  is read by the driver controller upsdrvctl, the UPS drivers
       that use the common core (see  nutupsdrv(8))  and  upsd(8).   The  file
       begins  with  global  directives, and then each UPS has a section which
       contains a number of directives that set parameters for that UPS.

       A UPS section begins with the name of the ups in brackets, and  contin-
       ues  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.  Any-
       thing after that in a section is optional.  A simple example might look
       like this:


                   [myups]
                        driver = megatec
                        port = /dev/ttyS0
                        desc = "Web server UPS"


       A  slightly more complicated version includes some extras for the hard-
       ware-specific part of the driver:


                   [bigups]
                        driver = apcsmart
                        port = /dev/cua00
                        cable = 940-0095B
                        sdtype = 2
                        desc = "Database server UPS"


       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.

GLOBAL DIRECTIVES

       chroot Optional.   The  driver  will chroot(2) to this directory during
              initialization.  This can be useful when securing systems.


       driverpath
              Optional.  Path name of the directory in which  the  UPS  driver
              executables  reside.   If  you  don't specify this, the programs
              look  in  a  built-in  default   directory,   which   is   often
              /usr/local/ups/bin.


       maxstartdelay

UPS FIELDS

       driver Required.  This specifies which program will be monitoring  this
              UPS.   You  need to specify the one that is compatible with your
              hardware.  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 usu-
              ally  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.


       desc   Optional.   This allows you to set a brief description that upsd
              will provide to clients that ask for a list of connected  equip-
              ment.


       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 acciden-
              tally.

              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

   Internet resources:
       The NUT (Network UPS Tools) home page: http://www.networkupstools.org/



                                Sun Aug 24 2003                    UPS.CONF(5)