| blob | 113394d5d0c3b58e243cf659c9f7d70b33563a59 |
1 # Network UPS Tools: example ups.conf
2 #
3 # --- SECURITY NOTE ---
4 #
5 # If you use snmp-ups and set a community string in here, you
6 # will have to secure this file to keep other users from obtaining
7 # that string. It needs to be readable by upsdrvctl and any drivers,
8 # and by upsd.
9 #
10 # ---
11 #
12 # This is where you configure all the UPSes that this system will be
13 # monitoring directly. These are usually attached to serial ports, but
14 # USB devices and SNMP devices are also supported.
15 #
16 # This file is used by upsdrvctl to start and stop your driver(s), and
17 # is also used by upsd to determine which drivers to monitor. The
18 # drivers themselves also read this file for configuration directives.
19 #
20 # The general form is:
21 #
22 # [upsname]
23 # driver = <drivername>
24 # port = <portname>
25 # < any other directives here >
26 #
27 # The section header ([upsname]) can be just about anything as long as
28 # it is a single word inside brackets. upsd uses this to uniquely
29 # identify a UPS on this system.
30 #
31 # If you have a UPS called snoopy, your section header would be "[snoopy]".
32 # On a system called "doghouse", the line in your upsmon.conf to monitor
33 # it would look something like this:
34 #
35 # MONITOR snoopy@doghouse 1 upsmonuser mypassword master
36 #
37 # It might look like this if monitoring in slave mode:
38 #
39 # MONITOR snoopy@doghouse 1 upsmonuser mypassword slave
40 #
41 # Configuration directives
42 # ------------------------
43 #
44 # These directives are common to all drivers that support ups.conf:
45 #
46 # driver: REQUIRED. Specify the program to run to talk to this UPS.
47 # apcsmart, fentonups, bestups, and sec are some examples.
48 #
49 # port: REQUIRED. The serial port where your UPS is connected.
50 # /dev/ttyS0 is usually the first port on Linux boxes, for example.
51 #
52 # sdorder: optional. When you have multiple UPSes on your system, you
53 # usually need to turn them off in a certain order. upsdrvctl
54 # shuts down all the 0s, then the 1s, 2s, and so on. To exclude
55 # a UPS from the shutdown sequence, set this to -1.
56 #
57 # The default value for this parameter is 0.
58 #
59 # nolock: optional, and not recommended for use in this file.
60 #
61 # If you put nolock in here, the driver will not lock the
62 # serial port every time it starts. This may allow other
63 # processes to seize the port if you start more than one by
64 # mistake.
65 #
66 # This is only intended to be used on systems where locking
67 # absolutely must be disabled for the software to work.
68 #
69 # maxstartdelay: optional. This can be set as a global variable
70 # above your first UPS definition and it can also be
71 # set in a UPS section. This value controls how long
72 # upsdrvctl will wait for the driver to finish starting.
73 # This keeps your system from getting stuck due to a
74 # broken driver or UPS.
75 #
76 # The default is 45 seconds.
77 #
78 #
79 # Anything else is passed through to the hardware-specific part of
80 # the driver.
81 #
82 # Examples
83 # --------
84 #
85 # A simple example for a UPS called "powerpal" that uses the fentonups
86 # driver on /dev/ttyS0 is:
87 #
88 # [powerpal]
89 # driver = fentonups
90 # port = /dev/ttyS0
91 # desc = "Web server"
92 #
93 # If your UPS driver requires additional settings, you can specify them
94 # here. For example, if it supports a setting of "1234" for the
95 # variable "cable", it would look like this:
96 #
97 # [myups]
98 # driver = mydriver
99 # port = /dev/ttyS1
100 # cable = 1234
101 # desc = "Something descriptive"
102 #
103 # To find out if your driver supports any extra settings, start it with
104 # the -h option and/or read the driver's documentation.