| blob | 049f06f65c8aa8a0a0b219c1719e77c64056729b |
1 ## apcupsd.conf v1.1 ##\r
2 # \r
3 # for apcupsd release @VERSION@ - win32-mingw\r
4 #\r
5 # "apcupsd" POSIX config file\r
6 \r
7 #\r
8 # ========= General configuration parameters ============\r
9 #\r
10 \r
11 # UPSNAME xxx\r
12 # Use this to give your UPS a name in log files and such. This\r
13 # is particulary useful if you have multiple UPSes. This does not\r
14 # set the EEPROM. It should be 8 characters or less.\r
15 #UPSNAME\r
16 \r
17 # UPSCABLE <cable>\r
18 # Defines the type of cable connecting the UPS to your computer.\r
19 #\r
20 # Possible generic choices for <cable> are:\r
21 # simple, smart, ether, usb\r
22 #\r
23 # Or a specific cable model number may be used:\r
24 # 940-0119A, 940-0127A, 940-0128A, 940-0020B,\r
25 # 940-0020C, 940-0023A, 940-0024B, 940-0024C,\r
26 # 940-1524C, 940-0024G, 940-0095A, 940-0095B,\r
27 # 940-0095C, M-04-02-2000\r
28 #\r
29 UPSCABLE usb\r
30 \r
31 # To get apcupsd to work, in addition to defining the cable\r
32 # above, you must also define a UPSTYPE, which corresponds to\r
33 # the type of UPS you have (see the Description for more details).\r
34 # You must also specify a DEVICE, sometimes referred to as a port.\r
35 # For USB UPSes, please leave the DEVICE directive blank. For\r
36 # other UPS types, you must specify an appropriate port or address.\r
37 #\r
38 # UPSTYPE DEVICE Description\r
39 # apcsmart COMx Newer serial character device, appropriate for \r
40 # SmartUPS models using a serial cable (not USB).\r
41 # Can be COM1, COM2, etc.\r
42 #\r
43 # usb <BLANK> Most new UPSes are USB. A blank DEVICE\r
44 # setting enables autodetection, which is\r
45 # the best choice for most installations.\r
46 #\r
47 # net hostname:port Network link to a master apcupsd through apcupsd's \r
48 # Network Information Server. This is used if the\r
49 # UPS powering your computer is connected to a \r
50 # different computer for monitoring.\r
51 #\r
52 # snmp hostname:port:vendor:community\r
53 # SNMP network link to an SNMP-enabled UPS device.\r
54 # Hostname is the ip address or hostname of the UPS \r
55 # on the network. Vendor can be can be "APC" or \r
56 # "APC_NOTRAP". "APC_NOTRAP" will disable SNMP trap \r
57 # catching; you usually want "APC". Port is usually \r
58 # 161. Community is usually "private".\r
59 #\r
60 # netsnmp hostname:port:vendor:community\r
61 # OBSOLETE\r
62 # Same as SNMP above but requires use of the \r
63 # net-snmp library. Unless you have a specific need\r
64 # for this old driver, you should use 'snmp' instead.\r
65 #\r
66 # dumb COMx Old serial character device for use with \r
67 # simple-signaling UPSes. Can be COM1, COM2, etc.\r
68 #\r
69 # pcnet ipaddr:username:passphrase\r
70 # PowerChute Network Shutdown protocol which can be \r
71 # used as an alternative to SNMP with the AP9617 \r
72 # family of smart slot cards.ipaddr is the IP \r
73 # address of the UPS mgmtcard. username and \r
74 # passphrase are the credentials for which the card \r
75 # has been configured.\r
76 #\r
77 UPSTYPE usb\r
78 DEVICE\r
79 \r
80 # POLLTIME <int>\r
81 # Interval (in seconds) at which apcupsd polls the UPS for status. This\r
82 # setting applies both to directly-attached UPSes (UPSTYPE apcsmart, usb, \r
83 # dumb) and networked UPSes (UPSTYPE net, snmp). Lowering this setting\r
84 # will improve apcupsd's responsiveness to certain events at the cost of\r
85 # higher CPU utilization. The default of 60 is appropriate for most\r
86 # situations.\r
87 #POLLTIME 60\r
88 \r
89 # SCRIPTDIR <path to script directory>\r
90 # Directory in which apccontrol and event scripts are located.\r
91 SCRIPTDIR @sysconfdir@\r
92 \r
93 # PWRFAILDIR <path to powerfail directory>\r
94 # Directory in which to write the powerfail flag file. This file\r
95 # is created when apcupsd initiates a system shutdown and is\r
96 # checked in the OS halt scripts to determine if a killpower\r
97 # (turning off UPS output power) is required.\r
98 PWRFAILDIR @PWRFAILDIR@\r
99 \r
100 # NOLOGINDIR <path to nologin directory>\r
101 # Directory in which to write the nologin file. The existence\r
102 # of this flag file tells the OS to disallow new logins.\r
103 NOLOGINDIR @nologdir@\r
104 \r
105 \r
106 #\r
107 # ======== Configuration parameters used during power failures ==========\r
108 #\r
109 \r
110 # The ONBATTERYDELAY is the time in seconds from when a power failure\r
111 # is detected until we react to it with an onbattery event.\r
112 #\r
113 # This means that, apccontrol will be called with the powerout argument\r
114 # immediately when a power failure is detected. However, the\r
115 # onbattery argument is passed to apccontrol only after the \r
116 # ONBATTERYDELAY time. If you don't want to be annoyed by short\r
117 # powerfailures, make sure that apccontrol powerout does nothing\r
118 # i.e. comment out the wall.\r
119 ONBATTERYDELAY 6\r
120 \r
121 # \r
122 # Note: BATTERYLEVEL, MINUTES, and TIMEOUT work in conjunction, so\r
123 # the first that occurs will cause the initation of a shutdown.\r
124 #\r
125 \r
126 # If during a power failure, the remaining battery percentage\r
127 # (as reported by the UPS) is below or equal to BATTERYLEVEL, \r
128 # apcupsd will initiate a system shutdown.\r
129 BATTERYLEVEL 5\r
130 \r
131 # If during a power failure, the remaining runtime in minutes \r
132 # (as calculated internally by the UPS) is below or equal to MINUTES,\r
133 # apcupsd, will initiate a system shutdown.\r
134 MINUTES 3\r
135 \r
136 # If during a power failure, the UPS has run on batteries for TIMEOUT\r
137 # many seconds or longer, apcupsd will initiate a system shutdown.\r
138 # A value of 0 disables this timer.\r
139 #\r
140 # Note, if you have a Smart UPS, you will most likely want to disable\r
141 # this timer by setting it to zero. That way, you UPS will continue\r
142 # on batteries until either the % charge remaing drops to or below BATTERYLEVEL,\r
143 # or the remaining battery runtime drops to or below MINUTES. Of course,\r
144 # if you are testing, setting this to 60 causes a quick system shutdown\r
145 # if you pull the power plug. \r
146 # If you have an older dumb UPS, you will want to set this to less than\r
147 # the time you know you can run on batteries.\r
148 TIMEOUT 0\r
149 \r
150 # Time in seconds between annoying users to signoff prior to\r
151 # system shutdown. 0 disables.\r
152 ANNOY 300\r
153 \r
154 # Initial delay after power failure before warning users to get\r
155 # off the system.\r
156 ANNOYDELAY 60\r
157 \r
158 # The condition which determines when users are prevented from\r
159 # logging in during a power failure.\r
160 # NOLOGON <string> [ disable | timeout | percent | minutes | always ]\r
161 NOLOGON disable\r
162 \r
163 # If KILLDELAY is non-zero, apcupsd will continue running after a\r
164 # shutdown has been requested, and after the specified time in\r
165 # seconds attempt to kill the power. This is for use on systems\r
166 # where apcupsd cannot regain control after a shutdown.\r
167 # KILLDELAY <seconds> 0 disables\r
168 KILLDELAY 0\r
169 \r
170 #\r
171 # ==== Configuration statements for Network Information Server ====\r
172 #\r
173 \r
174 # NETSERVER [ on | off ] on enables, off disables the network\r
175 # information server. If netstatus is on, a network information\r
176 # server process will be started for serving the STATUS and\r
177 # EVENT data over the network (used by CGI programs).\r
178 NETSERVER on\r
179 \r
180 # NISIP <dotted notation ip address>\r
181 # IP address on which NIS server will listen for incoming connections.\r
182 # This is useful if your server is multi-homed (has more than one\r
183 # network interface and IP address). Default value is 0.0.0.0 which\r
184 # means any incoming request will be serviced. Alternatively, you can\r
185 # configure this setting to any specific IP address of your server and \r
186 # NIS will listen for connections only on that interface. Use the\r
187 # loopback address (127.0.0.1) to accept connections only from the\r
188 # local machine.\r
189 NISIP 0.0.0.0\r
190 \r
191 # NISPORT <port> default is 3551 as registered with the IANA\r
192 # port to use for sending STATUS and EVENTS data over the network.\r
193 # It is not used unless NETSERVER is on. If you change this port,\r
194 # you will need to change the corresponding value in the cgi directory\r
195 # and rebuild the cgi programs.\r
196 NISPORT 3551\r
197 \r
198 # If you want the last few EVENTS to be available over the network\r
199 # by the network information server, you must define an EVENTSFILE.\r
200 EVENTSFILE @LOGDIR@\apcupsd.events\r
201 \r
202 # EVENTSFILEMAX <kilobytes>\r
203 # By default, the size of the EVENTSFILE will be not be allowed to exceed\r
204 # 10 kilobytes. When the file grows beyond this limit, older EVENTS will\r
205 # be removed from the beginning of the file (first in first out). The\r
206 # parameter EVENTSFILEMAX can be set to a different kilobyte value, or set\r
207 # to zero to allow the EVENTSFILE to grow without limit.\r
208 EVENTSFILEMAX 10\r
209 \r
210 #\r
211 # ========== Configuration statements used if sharing =============\r
212 # a UPS with more than one machine\r
213 \r
214 #\r
215 # Remaining items are for ShareUPS (APC expansion card) ONLY\r
216 #\r
217 \r
218 # UPSCLASS [ standalone | shareslave | sharemaster ]\r
219 # Normally standalone unless you share an UPS using an APC ShareUPS\r
220 # card.\r
221 UPSCLASS standalone\r
222 \r
223 # UPSMODE [ disable | share ]\r
224 # Normally disable unless you share an UPS using an APC ShareUPS card.\r
225 UPSMODE disable\r
226 \r
227 #\r
228 # ===== Configuration statements to control apcupsd system logging ========\r
229 #\r
230 \r
231 # Time interval in seconds between writing the STATUS file; 0 disables\r
232 STATTIME 0\r
233 \r
234 # Location of STATUS file (written to only if STATTIME is non-zero)\r
235 STATFILE @LOGDIR@\apcupsd.status\r
236 \r
237 # LOGSTATS [ on | off ] on enables, off disables\r
238 # Note! This generates a lot of output, so if \r
239 # you turn this on, be sure that the\r
240 # file defined in syslog.conf for LOG_NOTICE is a named pipe.\r
241 # You probably do not want this on.\r
242 LOGSTATS off\r
243 \r
244 # Time interval in seconds between writing the DATA records to\r
245 # the log file. 0 disables.\r
246 DATATIME 0\r
247 \r
248 # FACILITY defines the logging facility (class) for logging to syslog. \r
249 # If not specified, it defaults to "daemon". This is useful \r
250 # if you want to separate the data logged by apcupsd from other\r
251 # programs.\r
252 #FACILITY DAEMON\r
253 \r
254 #\r
255 # ========== Configuration statements used in updating the UPS EPROM =========\r
256 #\r
257 \r
258 #\r
259 # These statements are used only by apctest when choosing "Set EEPROM with conf\r
260 # file values" from the EEPROM menu. THESE STATEMENTS HAVE NO EFFECT ON APCUPSD.\r
261 #\r
262 \r
263 # UPS name, max 8 characters \r
264 #UPSNAME UPS_IDEN\r
265 \r
266 # Battery date - 8 characters\r
267 #BATTDATE mm/dd/yy\r
268 \r
269 # Sensitivity to line voltage quality (H cause faster transfer to batteries) \r
270 # SENSITIVITY H M L (default = H)\r
271 #SENSITIVITY H\r
272 \r
273 # UPS delay after power return (seconds)\r
274 # WAKEUP 000 060 180 300 (default = 0)\r
275 #WAKEUP 60\r
276 \r
277 # UPS Grace period after request to power off (seconds)\r
278 # SLEEP 020 180 300 600 (default = 20)\r
279 #SLEEP 180\r
280 \r
281 # Low line voltage causing transfer to batteries\r
282 # The permitted values depend on your model as defined by last letter \r
283 # of FIRMWARE or APCMODEL. Some representative values are:\r
284 # D 106 103 100 097\r
285 # M 177 172 168 182\r
286 # A 092 090 088 086\r
287 # I 208 204 200 196 (default = 0 => not valid)\r
288 #LOTRANSFER 208\r
289 \r
290 # High line voltage causing transfer to batteries\r
291 # The permitted values depend on your model as defined by last letter \r
292 # of FIRMWARE or APCMODEL. Some representative values are:\r
293 # D 127 130 133 136\r
294 # M 229 234 239 224\r
295 # A 108 110 112 114\r
296 # I 253 257 261 265 (default = 0 => not valid)\r
297 #HITRANSFER 253\r
298 \r
299 # Battery charge needed to restore power\r
300 # RETURNCHARGE 00 15 50 90 (default = 15)\r
301 #RETURNCHARGE 15\r
302 \r
303 # Alarm delay \r
304 # 0 = zero delay after pwr fail, T = power fail + 30 sec, L = low battery, N = never\r
305 # BEEPSTATE 0 T L N (default = 0)\r
306 #BEEPSTATE T\r
307 \r
308 # Low battery warning delay in minutes\r
309 # LOWBATT 02 05 07 10 (default = 02)\r
310 #LOWBATT 2\r
311 \r
312 # UPS Output voltage when running on batteries\r
313 # The permitted values depend on your model as defined by last letter \r
314 # of FIRMWARE or APCMODEL. Some representative values are:\r
315 # D 115\r
316 # M 208\r
317 # A 100\r
318 # I 230 240 220 225 (default = 0 => not valid)\r
319 #OUTPUTVOLTS 230\r
320 \r
321 # Self test interval in hours 336=2 weeks, 168=1 week, ON=at power on\r
322 # SELFTEST 336 168 ON OFF (default = 336)\r
323 #SELFTEST 336\r