1APCACCESS(8) BSD System Manager's Manual APCACCESS(8)
2
4 apcaccess — retrieve status information from apcupsd(8)
5
7 apcaccess [status [ [<hostname>][:<port>] ] ]
8
10 apcaccess is a program which prints out the complete status of most Amer‐
11 ican Power Conversion Corp. (APC) UPSes provided you have the apcupsd(8)
12 daemon installed, properly configured and running. It can access status
13 information from any APC UPS attached to the localhost or attached to any
14 computer on the network which is running apcuspd in NIS mode.
15 The command line options are:
17 status An optional command, unless a hostname is also being speci‐
19 fied. Shorthand for status localhost:3551. This produces a
20 full printout of the available status information for the
21 associated UPS.
22 <hostname> An optional hostname which may be a bare machine name, fully
24 qualified domain name or IP address.
25 :<port> An optional port number where a hostname argument has been
27 specified. The default is 3551, the official port number
28 assigned by IANA for the apcupsd NIS server.
29 apcaccess uses apcupsd's inbuilt Network Information Server (NIS) -- no
31 relation to Sun's NIS/YP service -- to obtain the current status informa‐
32 tion from the UPS on the local or remote computer. It is therefore neces‐
33 sary to have the following configuration directives:
34 NETSERVER on
36 NISPORT 3551
37 in the /etc/apcupsd/apcupsd.conf configuration file so that the Network
39 Information Server will be accessible. Firewall rules for appropriate
40 network access may also be needed.
41
43 The status report output format is simple ASCII. Generally there is a
44 single piece of information on each line of output. The content varies
45 based on the model of UPS being used and, in some cases, the firmware
46 version.
47
49 Set out below is a sample of the status output which may be generated for
50 the specified UPS models.
51 All models
53 APC : version, number of records and number of bytes following
54 DATE : Date and time of last update from UPS
55 HOSTNAME : hostname of computer running apcupsd
56 VERSION : apcupsd version number, date and operating system
57 UPSNAME : UPS name from configuration file (dumb) or EEPROM (smart)
58 CABLE : Cable type specified in the configuration file
59 MODEL : UPS model derived from UPS information
60 UPSMODE : Mode in which UPS is operating
61 STARTTIME : Date and time apcupsd was started
62 STATUS : UPS status (online, charging, on battery etc)
63 MASTERUPD : Last time the master sent an update to the slave
64 ENDAPC : Date and time of status information was written
65 Smart-UPS and Matrix-UPS (Smart Signalling)
67 LINEV : Current input line voltage
68 LOADPCT : Percentage of UPS load capacity used as estimated by UPS
69 BCHARGE : Current battery capacity charge percentage
70 TIMELEFT : Remaining runtime left on battery as estimated by the UPS
71 MBATTCHG : Min battery charge % (BCHARGE) required for system shutdown
72 MINTIMEL : Min battery runtime (MINUTES) required for system shutdown
73 MAXTIME : Max battery runtime (TIMEOUT) after which system is shutdown
74 MAXLINEV : Maximum input line voltage since apcupsd started
75 MINLINEV : Min (observed) input line voltage since apcupsd started
76 OUTPUTV : Current UPS output voltage
77 SENSE : Current UPS sensitivity setting for voltage fluctuations
78 DWAKE : Time UPS waits after power off when the power is restored
79 DSHUTD : Delay before UPS powers down after command received
80 DLOWBATT : Low battery signal sent when this much runtime remains
81 LOTRANS : Input line voltage below which UPS will switch to battery
82 HITRANS : Input line voltage above which UPS will switch to battery
83 RETPCT : Battery charge % required after power off to restore power
84 ITEMP : UPS internal temperature in degrees Celcius
85 ALARMDEL : Delay period before UPS starts sounding alarm
86 BATTV : Current battery voltage
87 LINEFREQ : Current line frequency in Hertz
88 LASTXFER : Reason for last transfer to battery since apcupsd startup
89 NUMXFERS : Number of transfers to battery since apcupsd startup
90 XONBATT : Date, time of last transfer to battery since apcupsd startup
91 TONBATT : Seconds currently on battery
92 CUMONBATT : Cumulative seconds on battery since apcupsd startup
93 XOFFBAT : Date, time of last transfer off battery since apcupsd startup
94 SELFTEST : Date and time of last self test since apcupsd startup
95 STESTI : Self-test interval
96 STATFLAG : UPS status flag in hex
97 DIPSW : Current UPS DIP switch settings
98 REG1 : Fault register 1 in hex
99 REG2 : Fault register 2 in hex
100 REG3 : Fault register 3 in hex
101 MANDATE : UPS date of manufacture
102 SERIALNO : UPS serial number
103 BATTDATE : Date battery last replaced (if set)
104 NOMOUTV : Nominal output voltage to supply when on battery power
105 NOMBATTV : Nominal battery voltage
106 EXTBATTS : Number of external batteries (for XL models)
107 BADBATTS : Number of bad external battery packs (for XL models)
108 FIRMWARE : UPS firmware version
109 APCMODEL : APC model information
110 Newer Back-UPS Pro (Smart Signalling)
112 LINEV : Current input line voltage
113 LOADPCT : Percentage of UPS load capacity used
114 MBATTCHG : Min battery charge % (BCHARGE) required for system shutdown
115 MINTIMEL : Min battery runtime (MINUTES) required for system shutdown
116 MAXTIME : Max battery runtime (TIMEOUT) after which system is shutdown
117 MAXLINEV : Maximum input line voltage since apcupsd startup
118 MINLINEV : Minimum input line voltage since apcupsd startup
119 OUTPUTV : Current UPS output voltage
120 BATTV : Current battery charge voltage
121 STATFLAG : UPS status flag in hex
122 Back-UPS RS 1500 (USB)
124 LINEV : Current input line voltage
125 LOADPCT : Percentage of UPS load capacity used
126 BCHARGE : Current battery capacity charge percentage
127 TIMELEFT : Remaining runtime left on battery as estimated by UPS
128 MBATTCHG : Min battery charge % (BCHARGE) required for system shutdown
129 MINTIMEL : Min battery runtime (MINUTES) required for system shutdown
130 MAXTIME : Max battery runtime (TIMEOUT) after which system is shutdown
131 *OUTPUTV : Current UPS output voltage
132 *DWAKE : Time UPS waits after power off when the power is restored
133 *DSHUTD : Delay before UPS powers down after command received
134 LOTRANS : Input line voltage below which UPS will switch to battery
135 HITRANS : Input line voltage above which UPS will switch to battery
136 *RETPCT : Battery charge % required after power off to restore power
137 *ITEMP : UPS internal temperature in degrees Celcius
138 ALARMDEL : Delay period before UPS starts sounding alarm
139 BATTV : Current battery voltage
140 *LINEFREQ : Current line frequency in Hertz
141 *LASTXFER : Reason for last transfer to battery since apcupsd startup
142 NUMXFERS : Number of transfers to battery since apcupsd startup
143 XONBATT : Date, time of last transfer to battery since apcupsd startup
144 TONBATT : Seconds currently on battery
145 CUMONBATT : Cumulative seconds on battery since apcupsd startup
146 XOFFBAT : Date, time of last transfer off battery since apcupsd startup
147 SELFTEST : Date and time of last self test since apcupsd startup
148 STATFLAG : UPS status flag in hex
149 MANDATE : UPS date of manufacture
150 SERIALNO : UPS serial number
151 BATTDATE : Date battery last replaced (if set)
152 NOMBATTV : Nominal battery voltage
153 FIRMWARE : UPS firmware version
154 APCMODEL : APC model information
155 * presence dependant on USB firmware version.
156 Web/SNMP (AP9716) or PowerNet SNMP (AP9605) SmartSlot Card
158 LINEV : Current input line voltage
159 LOADPCT : Percentage of UPS load capacity used as estimated by UPS
160 BCHARGE : Current battery capacity charge percentage
161 TIMELEFT : Remaining runtime left on battery as estimated by UPS
162 MBATTCHG : Min battery charge % (BCHARGE) required for system shutdown
163 MINTIMEL : Min battery runtime (MINUTES) required for system shutdown
164 MAXTIME : Max battery runtime (TIMEOUT) after which system is shutdown
165 MAXLINEV : Maximum input line voltage since apcupsd startup
166 MINLINEV : Minimum input line voltage since apcupsd startup
167 OUTPUTV : UPS output voltage
168 SENSE : Current UPS sensitivity setting for voltage fluctuations
169 DWAKE : Time UPS waits after power off when the power is restored
170 DSHUTD : Delay before UPS powers down after command received
171 DLOWBATT : Low battery signal sent when this much runtime remains
172 LOTRANS : Input line voltage below which UPS will switch to battery
173 HITRANS : Input line voltage above which UPS will switch to battery
174 RETPCT : Battery charge % required after power off to restore power
175 ITEMP : UPS internal temperature in degrees Celcius
176 ALARMDEL : Delay period before UPS starts sounding alarm
177 LINEFREQ : Current line frequency in Hertz
178 NUMXFERS : Number of transfers to battery since apcupsd startup
179 TONBATT : Seconds currently on battery
180 CUMONBATT : Cumulative seconds on battery since apcupsd startup
181 XOFFBATT : Date, time of last transfer off battery since apcupsd startup
182 STESTI : Self-test interval
183 STATFLAG : UPS status flag in hex
184 DIPSW : Current UPS DIP switch settings
185 MANDATE : UPS date of manufacture
186 SERIALNO : UPS serial number
187 BATTDATE : Date battery last replaced (if set)
188 NOMOUTV : Nominal output voltage to supply when on battery power
189 NOMPOWER : Nominal power output in watts
190 EXTBATTS : Number of external batteries (for XL models)
191 BADBATTS : Number of bad external battery packs (for XL models)
192 FIRMWARE : UPS firmware version
193 APCMODEL : APC model information
194 Share-UPS (AP9270) (Basic port)
196 MBATTCHG : Min battery charge % (BCHARGE) required for system shutdown
197 MINTIMEL : Min battery runtime (MINUTES) required for system shutdown
198 MAXTIME : Max battery runtime (TIMEOUT) after which system is shutdown
199 NUMXFERS : Number of transfers to battery since apcupsd startup
200 TONBATT : Seconds currently on battery
201 CUMONBATT : Cumulative seconds on battery since apcupsd startup
202 XOFFBATT : Date, time of last transfer off battery since apcupsd startup
203 STATFLAG : UPS status flag in hex
204 UPS Environmental Monitoring SmartSlot Card (AP9612TH)
206 HUMIDITY : Ambient humidity
207 AMBTEMP : Ambient temperature
208 Back-UPS Pro and Smart-UPS v/s (Smart Signalling)
210 LINEFAIL : Input line voltage status.
211 BATTSTAT : Battery status.
212 LASTXFER : Last (observed) transfer to battery.
213 Back-UPS and Net-UPS (Simple Signalling)
215 LINEFAIL : Input line voltage status.
216 BATTSTAT : Battery status.
217 STATFLAG : UPS status flag in hex.
218
220 /etc/apcupsd/apcupsd.conf
221
223 apcupsd.conf(5), apcupsd(8).
224 The HTML apcupsd manual installed on your system or available online at
226 http://www.apcupsd.org/
227
229 This page
230 Trevor Roydhouse
231 Software
233 Adam Kropelin (current Project Manager and Code Maintainer)
234 Kern Sibbald (former Project Manager and Code Maintainer)
235 Riccardo Facchetti (former Project Manager and Code Maintainer)
236 Andre M. Hedrick (Project Founder and former Code Maintainer)
237 Contributors
239 An enormous number of users who have devoted their time and energy to
240 this project -- thanks.
241apcaccess v3.14.6 January 10, 2009 apcaccess v3.14.6