1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
|
Desc: New command and variable naming scheme
File: new-names.txt
Date: 29 September 2004
Auth: Russell Kroll <rkroll@exploits.org>
This is a dump of the planning page for variables and command names.
Don't use a name with any of the dstate functions unless it exists here.
If you need a new variable or command name, contact me first.
Put another way: if you make up a name that's not in this list and it
gets into the tree, and then we come up with a better name later, clients
that use the undocumented variable will break when it is changed.
Note: "opaque" means programs should not attempt to parse the value for
that variable as it may vary greatly from one UPS to the next. These
strings are best handled directly by the user.
Variables
ups: General unit information
+------------------------------------------------------------------------+
| Name | Description | Typical value |
|----------------------+------------------------------+------------------|
| ups.status | UPS status | OL |
|----------------------+------------------------------+------------------|
| ups.alarm | UPS alarms | OVERHEAT |
|----------------------+------------------------------+------------------|
| ups.time | Internal UPS clock time | 12:34 |
| | (opaque string) | |
|----------------------+------------------------------+------------------|
| ups.date | Internal UPS clock date | 01-02-03 |
| | (opaque string) | |
|----------------------+------------------------------+------------------|
| ups.model | UPS model | SMART-UPS 700 |
|----------------------+------------------------------+------------------|
| ups.mfr | UPS manufacturer | APC |
|----------------------+------------------------------+------------------|
| ups.mfr.date | UPS manufacturing date | 10/17/96 |
| | (opaque string) | |
|----------------------+------------------------------+------------------|
| ups.serial | UPS serial number (opaque | WS9643050926 |
| | string) | |
|----------------------+------------------------------+------------------|
| ups.firmware | UPS firmware (opaque string) | 50.9.D |
|----------------------+------------------------------+------------------|
| ups.firmware.aux | Auxiliary device firmware | 4Kx |
|----------------------+------------------------------+------------------|
| ups.temperature | UPS temperature (degrees C) | 042.7 |
|----------------------+------------------------------+------------------|
| ups.load | Load on UPS (percent) | 023.4 |
|----------------------+------------------------------+------------------|
| ups.id | UPS system identifier | Sierra |
| | (opaque string) | |
|----------------------+------------------------------+------------------|
| | Interval to wait before | |
| ups.delay.start | restarting the load | 0 |
| | (seconds) | |
|----------------------+------------------------------+------------------|
| ups.delay.reboot | Interval to wait before | 60 |
| | rebooting the UPS (seconds) | |
|----------------------+------------------------------+------------------|
| | Interval to wait after | |
| ups.delay.shutdown | shutdown with delay command | 20 |
| | (seconds) | |
|----------------------+------------------------------+------------------|
| ups.test.interval | Interval between self tests | 1209600 (two |
| | (seconds) | weeks) |
|----------------------+------------------------------+------------------|
| ups.test.result | Results of last self test | Bad battery pack |
| | (opaque string) | |
|----------------------+------------------------------+------------------|
| ups.display.language | Language to use on front | E |
| | panel (*** opaque) | |
|----------------------+------------------------------+------------------|
| ups.contacts | UPS external contact sensors | F0 |
| | (*** opaque) | |
|----------------------+------------------------------+------------------|
| ups.power | Current value of apparent | 500 |
| | power (Volt-Amps) | |
|----------------------+------------------------------+------------------|
| ups.power.nominal | Nominal value of apparent | 500 |
| | power (Volt-Amps) | |
+------------------------------------------------------------------------+
input: Incoming line/power information
+------------------------------------------------------------------------+
| Name | Description | Typical value |
|---------------------------+----------------------------+---------------|
| input.voltage | Input voltage | 121.5 |
|---------------------------+----------------------------+---------------|
| input.voltage.maximum | Maximum incoming voltage | 130 |
| | seen | |
|---------------------------+----------------------------+---------------|
| input.voltage.minimum | Minimum incoming voltage | 100 |
| | seen | |
|---------------------------+----------------------------+---------------|
| input.voltage.nominal | Nominal input voltage | 120 |
|---------------------------+----------------------------+---------------|
| input.transfer.reason | Reason for last transfer | T |
| | to battery (*** opaque) | |
|---------------------------+----------------------------+---------------|
| input.transfer.low | Low voltage transfer point | 103 |
|---------------------------+----------------------------+---------------|
| input.transfer.high | High voltage transfer | 132 |
| | point | |
|---------------------------+----------------------------+---------------|
| input.sensitivity | Input power sensitivity | H (high) |
|---------------------------+----------------------------+---------------|
| input.quality | Input power quality (*** | FF |
| | opaque) | |
|---------------------------+----------------------------+---------------|
| input.frequency | Input line frequency (Hz) | 60.00 |
|---------------------------+----------------------------+---------------|
| input.transfer.boost.low | Low voltage boosting | 190 |
| | transfer point | |
|---------------------------+----------------------------+---------------|
| input.transfer.boost.high | High voltage boosting | 210 |
| | transfer point | |
|---------------------------+----------------------------+---------------|
| input.transfer.trim.low | Low voltage trimming | 230 |
| | transfer point | |
|---------------------------+----------------------------+---------------|
| input.transfer.trim.high | High voltage trimming | 240 |
| | transfer point | |
+------------------------------------------------------------------------+
output: Outgoing power/inverter information
+------------------------------------------------------------------------+
| output.voltage | Output voltage | 120.9 |
|-------------------------------+--------------------------------+-------|
| output.frequency | Output frequency (Hz) | 60 |
|-------------------------------+--------------------------------+-------|
| output.voltage.target.line | Target output voltage when on | 120 |
| | line | |
|-------------------------------+--------------------------------+-------|
| output.voltage.target.battery | Target output voltage when on | 120 |
| | battery | |
|-------------------------------+--------------------------------+-------|
| output.current | Output current (amps) | 4.25 |
+------------------------------------------------------------------------+
battery: Any battery details
+------------------------------------------------------------------------+
| battery.charge | Battery charge (percent) | 100.0 |
|-------------------------+------------------------------+---------------|
| battery.charge.low | Remaining battery level when | 20 |
| | UPS switches to LB (percent) | |
|-------------------------+------------------------------+---------------|
| battery.charge.restart | Minimum battery level for | 20 |
| | UPS restart after power-off | |
|-------------------------+------------------------------+---------------|
| battery.voltage | Battery charge (volts) | 24.84 |
|-------------------------+------------------------------+---------------|
| battery.current | Battery current (amps) | 1.19 |
|-------------------------+------------------------------+---------------|
| battery.temperature | Battery temperature (degrees | 050.7 |
| | C) | |
|-------------------------+------------------------------+---------------|
| battery.voltage.nominal | Nominal battery voltage | 024 |
|-------------------------+------------------------------+---------------|
| battery.runtime | Battery runtime (seconds) | 1080 |
|-------------------------+------------------------------+---------------|
| | Remaining battery runtime | |
| battery.runtime.low | when UPS switches to LB | 180 |
| | (seconds) | |
|-------------------------+------------------------------+---------------|
| battery.alarm.threshold | Battery alarm threshold | 0 (immediate) |
|-------------------------+------------------------------+---------------|
| battery.date | Battery change date (opaque | 11/14/00 |
| | string) | |
|-------------------------+------------------------------+---------------|
| battery.packs | Number of battery packs | 001 |
|-------------------------+------------------------------+---------------|
| battery.packs.bad | Number of bad battery packs | 000 |
+------------------------------------------------------------------------+
ambient: Conditions from external probe equipment
+------------------------------------------------------------------------+
| ambient.temperature | Ambient temperature | 25.40 |
| | (degrees C) | |
|-----------------------------------+----------------------------+-------|
| ambient.temperature.alarm | Set if ambient temperature | 0 |
| | alarm is active | |
|-----------------------------------+----------------------------+-------|
| ambient.temperature.alarm.maximum | Maximum allowed | NO,NO |
| | temperature (*** opaque) | |
|-----------------------------------+----------------------------+-------|
| ambient.temperature.alarm.minimum | Minimum allowed | NO,NO |
| | temperature (*** opaque) | |
|-----------------------------------+----------------------------+-------|
| ambient.temperature.alarm.enable | Enable alarm for ambient | 1 |
| | temperature | |
|-----------------------------------+----------------------------+-------|
| ambient.humidity | Ambient relative humidity | 038.8 |
| | (percent) | |
|-----------------------------------+----------------------------+-------|
| ambient.humidity.alarm | Set if ambient humidity | 0 |
| | alarm is active | |
|-----------------------------------+----------------------------+-------|
| ambient.humidity.alarm.maximum | Maximum allowed humidity | NO,NO |
| | (*** opaque) | |
|-----------------------------------+----------------------------+-------|
| ambient.humidity.alarm.minimum | Minimum allowed humidity | NO,NO |
| | (*** opaque) | |
|-----------------------------------+----------------------------+-------|
| ambient.humidity.alarm.enable | Enable alarm for ambient | 1 |
| | humidity | |
+------------------------------------------------------------------------+
output: Smart outlet management (smart on/off switch, ...)
+------------------------------------------------------------------------+
| | Outlet system | |
| outlet.n.id | identifier (opaque | 1 |
| | string) | |
|--------------------------------+-------------------------+-------------|
| outlet.n.desc | Outlet description | Main outlet |
| | (opaque string) | |
|--------------------------------+-------------------------+-------------|
| outlet.n.switch | Outlet switch control | on |
| | (on/off) | |
|--------------------------------+-------------------------+-------------|
| outlet.n.status | Outlet switch status | on |
| | (on/off) | |
|--------------------------------+-------------------------+-------------|
| outlet.n.switchable | Outlet switch ability | yes |
| | (yes/no) | |
|--------------------------------+-------------------------+-------------|
| | Remaining battery level | |
| outlet.n.autoswitch.charge.low | to power off this | 90 |
| | outlet (percent) | |
|--------------------------------+-------------------------+-------------|
| | Interval to wait before | |
| outlet.n.delay.shutdown | shutting down this | 180 |
| | outlet (seconds) | |
|--------------------------------+-------------------------+-------------|
| | Interval to wait before | |
| outlet.n.delay.start | restarting this outlet | 120 |
| | (seconds) | |
+------------------------------------------------------------------------+
driver: Internal driver information
+------------------------------------------------------------------------+
| driver.name | Driver name | apcsmart |
|-------------------------+----------------------------+-----------------|
| driver.version | Driver version (NUT | X.Y.Z |
| | release) | |
|-------------------------+----------------------------+-----------------|
| driver.version.internal | Internal driver version | 1.23.45 |
| | (if tracked separately) | |
|-------------------------+----------------------------+-----------------|
| driver.parameter.xxx | Parameter xxx (ups.conf or | (varies) |
| | cmdline -x) setting | |
|-------------------------+----------------------------+-----------------|
| driver.flag.xxx | Flag xxx (ups.conf or | enabled (or not |
| | cmdline -x) status | present) |
+------------------------------------------------------------------------+
server: Internal server information
+------------------------------------------------------------------------+
| server.info | Server | Network UPS Tools upsd vX.Y.Z - |
| | information | http://www.networkupstools.org/ |
|----------------+----------------+--------------------------------------|
| server.version | Server version | X.Y.Z |
+------------------------------------------------------------------------+
Instant commands
+------------------------------------------------------------------------+
| Name | Description |
|--------------------------+---------------------------------------------|
| load.off | Turn off the load immediately |
|--------------------------+---------------------------------------------|
| load.on | Turn on the load immediately |
|--------------------------+---------------------------------------------|
| shutdown.return | Turn off the load possibly after a delay |
| | and return when power is back |
|--------------------------+---------------------------------------------|
| shutdown.stayoff | Turn off the load possibly after a delay |
| | and remain off even if power returns |
|--------------------------+---------------------------------------------|
| shutdown.stop | Stop a shutdown in progress |
|--------------------------+---------------------------------------------|
| shutdown.reboot | Shut down the load briefly while rebooting |
| | the UPS |
|--------------------------+---------------------------------------------|
| shutdown.reboot.graceful | After a delay, shut down the load briefly |
| | while rebooting the UPS |
|--------------------------+---------------------------------------------|
| test.panel.start | Start testing the UPS panel |
|--------------------------+---------------------------------------------|
| test.panel.stop | Stop a UPS panel test |
|--------------------------+---------------------------------------------|
| test.failure.start | Start a simulated power failure |
|--------------------------+---------------------------------------------|
| test.failure.stop | Stop simulating a power failure |
|--------------------------+---------------------------------------------|
| test.battery.start | Start a battery test |
|--------------------------+---------------------------------------------|
| test.battery.stop | Stop the battery test |
|--------------------------+---------------------------------------------|
| calibrate.start | Start runtime calibration |
|--------------------------+---------------------------------------------|
| calibrate.stop | Stop runtime calibration |
|--------------------------+---------------------------------------------|
| bypass.start | Put the UPS in bypass mode |
|--------------------------+---------------------------------------------|
| bypass.stop | Take the UPS out of bypass mode |
|--------------------------+---------------------------------------------|
| reset.input.minmax | Reset minimum and maximum input voltage |
| | status |
|--------------------------+---------------------------------------------|
| reset.watchdog | Reset watchdog timer (forced reboot of |
| | load) |
|--------------------------+---------------------------------------------|
| beeper.on | Enable UPS beeper/buzzer |
|--------------------------+---------------------------------------------|
| beeper.off | Disable UPS beeper/buzzer |
+------------------------------------------------------------------------+
|