| blob | 6b9fd6a97adf1bfbf3d39ddc089ca1ab96a6fa83 |
1 .\" manual page [] for apctest version 3.14.6
2 .Dd January 10, 2009
3 .Dt APCACCESS 8
4 .Os apcaccess v3.14.6
5 .Sh NAME
6 .Nm apcaccess
7 .Nd retrieve status information from apcupsd(8)
8 .Sh SYNOPSIS
9 .Nm
10 [status [ [<hostname>][:<port>] ] ]
11 .Sh DESCRIPTION
12 .Nm
13 is a program which prints out the complete status of most American Power
14 Conversion Corp. (APC) UPSes provided you have the
15 .Xr apcupsd 8
16 daemon installed, properly configured and running. It can access status
17 information from any APC UPS attached to the localhost or attached to
18 any computer on the network which is running apcuspd in NIS mode.
19 .Pp
20 The command line options are:
21 .Bl -hang -width "<hostname>"
22 .It status
23 An optional command, unless a hostname is also being specified. Shorthand for
24 .Em status\& localhost:3551 .
25 This produces a full printout of the available status information for the
26 associated UPS.
27 .It <hostname>
28 An optional hostname which may be a bare machine name, fully qualified
29 domain name or IP address.
30 .It :<port>
31 An optional port number where a hostname argument has been specified. The
32 default is 3551, the official port number assigned by
33 .Tn IANA
34 for the apcupsd NIS server.
35 .El
36 .Pp
37 .Nm
38 uses apcupsd's inbuilt Network Information Server (NIS) -- no relation
39 to Sun's NIS/YP service -- to obtain the current status information from the
40 UPS on the local or remote computer. It is therefore
41 necessary to have the following configuration directives:
42 .Pp
43 .Bl -item -compact
44 .It
45 NETSERVER on
46 .It
47 NISPORT 3551
48 .El
49 .Pp
50 in the
51 .Pa /etc/apcupsd/apcupsd.conf
52 configuration file so that the Network Information Server will be accessible.
53 Firewall rules for appropriate network access may also be needed.
54 .Sh STATUS REPORT FORMAT
55 The status report output format is simple ASCII. Generally there
56 is a single piece of information on each line of output. The
57 content varies based on the model of UPS being used and, in some cases,
58 the firmware version.
59 .Sh EXAMPLES
60 Set out below is a sample of the status output which may be
61 generated for the specified UPS models.
62 .Pp
63 .Ss All models
64 .Bl -hang -width "xxxxxxxx" -compact
65 .It APC
66 : version, number of records and number of bytes following
67 .It DATE
68 : Date and time of last update from UPS
69 .It HOSTNAME
70 : hostname of computer running apcupsd
71 .It VERSION
72 : apcupsd version number, date and operating system
73 .It UPSNAME
74 : UPS name from configuration file (dumb) or EEPROM (smart)
75 .It CABLE
76 : Cable type specified in the configuration file
77 .It MODEL
78 : UPS model derived from UPS information
79 .It UPSMODE
80 : Mode in which UPS is operating
81 .It STARTTIME
82 : Date and time apcupsd was started
83 .It STATUS
84 : UPS status (online, charging, on battery etc)
85 .It MASTERUPD
86 : Last time the master sent an update to the slave
87 .It ENDAPC
88 : Date and time of status information was written
89 .El
90 .Ss Smart-UPS and Matrix-UPS (Smart Signalling)
91 .Bl -hang -width "xxxxxxxx"-compact
92 .It LINEV
93 : Current input line voltage
94 .It LOADPCT
95 : Percentage of UPS load capacity used as estimated by UPS
96 .It BCHARGE
97 : Current battery capacity charge percentage
98 .It TIMELEFT
99 : Remaining runtime left on battery as estimated by the UPS
100 .It MBATTCHG
101 : Min battery charge % (BCHARGE) required for system shutdown
102 .It MINTIMEL
103 : Min battery runtime (MINUTES) required for system shutdown
104 .It MAXTIME
105 : Max battery runtime (TIMEOUT) after which system is shutdown
106 .It MAXLINEV
107 : Maximum input line voltage since apcupsd started
108 .It MINLINEV
109 : Min (observed) input line voltage since apcupsd started
110 .It OUTPUTV
111 : Current UPS output voltage
112 .It SENSE
113 : Current UPS sensitivity setting for voltage fluctuations
114 .It DWAKE
115 : Time UPS waits after power off when the power is restored
116 .It DSHUTD
117 : Delay before UPS powers down after command received
118 .It DLOWBATT
119 : Low battery signal sent when this much runtime remains
120 .It LOTRANS
121 : Input line voltage below which UPS will switch to battery
122 .It HITRANS
123 : Input line voltage above which UPS will switch to battery
124 .It RETPCT
125 : Battery charge % required after power off to restore power
126 .It ITEMP
127 : UPS internal temperature in degrees Celcius
128 .It ALARMDEL
129 : Delay period before UPS starts sounding alarm
130 .It BATTV
131 : Current battery voltage
132 .It LINEFREQ
133 : Current line frequency in Hertz
134 .It LASTXFER
135 : Reason for last transfer to battery since apcupsd startup
136 .It NUMXFERS
137 : Number of transfers to battery since apcupsd startup
138 .It XONBATT
139 : Date, time of last transfer to battery since apcupsd startup
140 .It TONBATT
141 : Seconds currently on battery
142 .It CUMONBATT
143 : Cumulative seconds on battery since apcupsd startup
144 .It XOFFBAT
145 : Date, time of last transfer off battery since apcupsd startup
146 .It SELFTEST
147 : Date and time of last self test since apcupsd startup
148 .It STESTI
149 : Self-test interval
150 .It STATFLAG
151 : UPS status flag in hex
152 .It DIPSW
153 : Current UPS DIP switch settings
154 .It REG1
155 : Fault register 1 in hex
156 .It REG2
157 : Fault register 2 in hex
158 .It REG3
159 : Fault register 3 in hex
160 .It MANDATE
161 : UPS date of manufacture
162 .It SERIALNO
163 : UPS serial number
164 .It BATTDATE
165 : Date battery last replaced (if set)
166 .It NOMOUTV
167 : Nominal output voltage to supply when on battery power
168 .It NOMBATTV
169 : Nominal battery voltage
170 .It EXTBATTS
171 : Number of external batteries (for XL models)
172 .It BADBATTS
173 : Number of bad external battery packs (for XL models)
174 .It FIRMWARE
175 : UPS firmware version
176 .It APCMODEL
177 : APC model information
178 .El
179 .Ss Newer Back-UPS Pro (Smart Signalling)
180 .Bl -hang -width "xxxxxxxx"-compact
181 .It LINEV
182 : Current input line voltage
183 .It LOADPCT
184 : Percentage of UPS load capacity used
185 .It MBATTCHG
186 : Min battery charge % (BCHARGE) required for system shutdown
187 .It MINTIMEL
188 : Min battery runtime (MINUTES) required for system shutdown
189 .It MAXTIME
190 : Max battery runtime (TIMEOUT) after which system is shutdown
191 .It MAXLINEV
192 : Maximum input line voltage since apcupsd startup
193 .It MINLINEV
194 : Minimum input line voltage since apcupsd startup
195 .It OUTPUTV
196 : Current UPS output voltage
197 .It BATTV
198 : Current battery charge voltage
199 .It STATFLAG
200 : UPS status flag in hex
201 .El
202 .Ss Back-UPS RS 1500 (USB)
203 .Bl -hang -width "xxxxxxxx"-compact
204 .It LINEV
205 : Current input line voltage
206 .It LOADPCT
207 : Percentage of UPS load capacity used
208 .It BCHARGE
209 : Current battery capacity charge percentage
210 .It TIMELEFT
211 : Remaining runtime left on battery as estimated by UPS
212 .It MBATTCHG
213 : Min battery charge % (BCHARGE) required for system shutdown
214 .It MINTIMEL
215 : Min battery runtime (MINUTES) required for system shutdown
216 .It MAXTIME
217 : Max battery runtime (TIMEOUT) after which system is shutdown
218 .It *OUTPUTV
219 : Current UPS output voltage
220 .It *DWAKE
221 : Time UPS waits after power off when the power is restored
222 .It *DSHUTD
223 : Delay before UPS powers down after command received
224 .It LOTRANS
225 : Input line voltage below which UPS will switch to battery
226 .It HITRANS
227 : Input line voltage above which UPS will switch to battery
228 .It *RETPCT
229 : Battery charge % required after power off to restore power
230 .It *ITEMP
231 : UPS internal temperature in degrees Celcius
232 .It ALARMDEL
233 : Delay period before UPS starts sounding alarm
234 .It BATTV
235 : Current battery voltage
236 .It *LINEFREQ
237 : Current line frequency in Hertz
238 .It *LASTXFER
239 : Reason for last transfer to battery since apcupsd startup
240 .It NUMXFERS
241 : Number of transfers to battery since apcupsd startup
242 .It XONBATT
243 : Date, time of last transfer to battery since apcupsd startup
244 .It TONBATT
245 : Seconds currently on battery
246 .It CUMONBATT
247 : Cumulative seconds on battery since apcupsd startup
248 .It XOFFBAT
249 : Date, time of last transfer off battery since apcupsd startup
250 .It SELFTEST
251 : Date and time of last self test since apcupsd startup
252 .It STATFLAG
253 : UPS status flag in hex
254 .It MANDATE
255 : UPS date of manufacture
256 .It SERIALNO
257 : UPS serial number
258 .It BATTDATE
259 : Date battery last replaced (if set)
260 .It NOMBATTV
261 : Nominal battery voltage
262 .It FIRMWARE
263 : UPS firmware version
264 .It APCMODEL
265 : APC model information
266 .It * presence dependant on USB firmware version.
267 .El
268 .Ss Web/SNMP (AP9716) or PowerNet SNMP (AP9605) SmartSlot Card
269 .Bl -hang -width "xxxxxxxx"-compact
270 .It LINEV
271 : Current input line voltage
272 .It LOADPCT
273 : Percentage of UPS load capacity used as estimated by UPS
274 .It BCHARGE
275 : Current battery capacity charge percentage
276 .It TIMELEFT
277 : Remaining runtime left on battery as estimated by UPS
278 .It MBATTCHG
279 : Min battery charge % (BCHARGE) required for system shutdown
280 .It MINTIMEL
281 : Min battery runtime (MINUTES) required for system shutdown
282 .It MAXTIME
283 : Max battery runtime (TIMEOUT) after which system is shutdown
284 .It MAXLINEV
285 : Maximum input line voltage since apcupsd startup
286 .It MINLINEV
287 : Minimum input line voltage since apcupsd startup
288 .It OUTPUTV
289 : UPS output voltage
290 .It SENSE
291 : Current UPS sensitivity setting for voltage fluctuations
292 .It DWAKE
293 : Time UPS waits after power off when the power is restored
294 .It DSHUTD
295 : Delay before UPS powers down after command received
296 .It DLOWBATT
297 : Low battery signal sent when this much runtime remains
298 .It LOTRANS
299 : Input line voltage below which UPS will switch to battery
300 .It HITRANS
301 : Input line voltage above which UPS will switch to battery
302 .It RETPCT
303 : Battery charge % required after power off to restore power
304 .It ITEMP
305 : UPS internal temperature in degrees Celcius
306 .It ALARMDEL
307 : Delay period before UPS starts sounding alarm
308 .It LINEFREQ
309 : Current line frequency in Hertz
310 .It NUMXFERS
311 : Number of transfers to battery since apcupsd startup
312 .It TONBATT
313 : Seconds currently on battery
314 .It CUMONBATT
315 : Cumulative seconds on battery since apcupsd startup
316 .It XOFFBATT
317 : Date, time of last transfer off battery since apcupsd startup
318 .It STESTI
319 : Self-test interval
320 .It STATFLAG
321 : UPS status flag in hex
322 .It DIPSW
323 : Current UPS DIP switch settings
324 .It MANDATE
325 : UPS date of manufacture
326 .It SERIALNO
327 : UPS serial number
328 .It BATTDATE
329 : Date battery last replaced (if set)
330 .It NOMOUTV
331 : Nominal output voltage to supply when on battery power
332 .It NOMPOWER
333 : Nominal power output in watts
334 .It EXTBATTS
335 : Number of external batteries (for XL models)
336 .It BADBATTS
337 : Number of bad external battery packs (for XL models)
338 .It FIRMWARE
339 : UPS firmware version
340 .It APCMODEL
341 : APC model information
342 .El
343 .Ss Share-UPS (AP9270) (Basic port)
344 .Bl -hang -width "xxxxxxxx"-compact
345 .It MBATTCHG
346 : Min battery charge % (BCHARGE) required for system shutdown
347 .It MINTIMEL
348 : Min battery runtime (MINUTES) required for system shutdown
349 .It MAXTIME
350 : Max battery runtime (TIMEOUT) after which system is shutdown
351 .It NUMXFERS
352 : Number of transfers to battery since apcupsd startup
353 .It TONBATT
354 : Seconds currently on battery
355 .It CUMONBATT
356 : Cumulative seconds on battery since apcupsd startup
357 .It XOFFBATT
358 : Date, time of last transfer off battery since apcupsd startup
359 .It STATFLAG
360 : UPS status flag in hex
361 .El
362 .Ss UPS Environmental Monitoring SmartSlot Card (AP9612TH)
363 .Bl -hang -width "xxxxxxxx"-compact
364 .It HUMIDITY
365 : Ambient humidity
366 .It AMBTEMP
367 : Ambient temperature
368 .El
369 .Ss Back-UPS Pro and Smart-UPS v/s (Smart Signalling)
370 .Bl -hang -width "xxxxxxxx"-compact
371 .It LINEFAIL
372 : Input line voltage status.
373 .It BATTSTAT
374 : Battery status.
375 .It LASTXFER
376 : Last (observed) transfer to battery.
377 .El
378 .Ss Back-UPS and Net-UPS (Simple Signalling)
379 .Bl -hang -width "xxxxxxxx"-compact
380 .It LINEFAIL
381 : Input line voltage status.
382 .It BATTSTAT
383 : Battery status.
384 .It STATFLAG
385 : UPS status flag in hex.
386 .El
387 .Sh FILES
388 .Pa /etc/apcupsd/apcupsd.conf
389 .Sh SEE ALSO
390 .Xr apcupsd.conf 5 ,
391 .Xr apcupsd 8 .
392 .Pp
393 The HTML apcupsd manual installed on your system or available online at
394 http://www.apcupsd.org/
395 .Sh AUTHORS
396 .Ss This page
397 .An Trevor Roydhouse
398 .Ss Software
399 .An Adam Kropelin (current Project Manager and Code Maintainer)
400 .An Kern Sibbald (former Project Manager and Code Maintainer)
401 .An Riccardo Facchetti (former Project Manager and Code Maintainer)
402 .An Andre M. Hedrick (Project Founder and former Code Maintainer)
403 .Ss Contributors
404 An enormous number of users who have devoted their time and energy to
405 this project -- thanks.