# Network UPS Tools: example ups.conf # # This is where you configure all the UPSes that this system will be # directly monitoring through serial ports. This file is currently # optional if you are still using the old upsd.conf method, but you # are encouraged to switch to it to make future upgrades easier. # # If you are converting from upsd.conf, remember to remove your entries # from that file once you get done, or upsd will yell at you about # duplicate UPS definitions. # # This file is used by upsdrvctl to start and stop your driver(s), and # is also used by upsd to determine which drivers to monitor. The # drivers themselves also read this file for configuration directives. # # The general form is: # # [upsname] # driver = <drivername> # port = <portname> # < any other directives here > # # The section header ([upsname]) can be just about anything as long as # it's inside brackets. upsd uses this to uniquely identify a UPS on # this system. The only reserved name is "default". upsd uses this # internally, so you can't use it in this file. # # If you have a UPS called snoopy, your section header would be "[snoopy]". # On a system called "doghouse", the line in your upsmon.conf to monitor # it would look something like this: # # MONITOR snoopy@doghouse 1 mypassword master # # It might look like this if monitoring in slave mode: # # MONITOR snoopy@doghouse 1 mypassword slave # # Configuration directives # ------------------------ # # These directives are common to all drivers that support ups.conf: # # driver: REQUIRED. Specify the program to run to talk to this UPS. # apcsmart, fentonups, bestups, and sec are some examples. # # port: REQUIRED. The serial port where your UPS is connected. # /dev/ttyS0 is usually the first port on Linux boxes, for example. # # 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. # # sddelay: optional. Set this if you want the driver to wait a certain # amount of time when you tell it to shut down the UPS. This is # the same as using -d <num> on the command line. # # nolock: optional, and not recommended for use in this file. # # If you put nolock in here, the driver will not lock the # serial port every time it starts. This may allow other # processes to seize the port if you start more than one by # mistake. # # This is only intended to be used on systems where locking # absolutely must be disabled for the software to work. # # 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. # # # Anything else is passed through to the hardware-specific part of # the driver. # # Examples # -------- # # A simple example for a UPS called "powerpal" that uses the fentonups # driver on /dev/ttyS0 is: # # [powerpal] # driver = fentonups # port = /dev/ttyS0 # # If your UPS driver requires additional arguments that you can add with # -x when running it from the command line, you can specify them here. # # In other words, if you can do "/bin/mydriver -x cable=1234", then you can # also put "cable=1234" in the entry for that UPS in this file, like this: # # [myups] # driver = mydriver # port = /dev/ttyS1 # cable = 1234 # # To find out if your driver supports any extra (-x) options, start it # with the -h option and/or read the driver's documentation.