1
Desc: New naming scheme
4
Auth: Russell Kroll <rkroll@exploits.org>
6
*** Note: for the current list, check the development tree
8
This is a dump of the planning page for the variable and instant
9
command renaming effort. Don't use a name with any of the dstate
10
functions unless it exists here.
12
If you need a new variable or command name, contact me first.
16
+------------------------------------------------------------------------+
17
| ups - General unit information |
18
|------------------------------------------------------------------------|
19
| Old name | New name | Description |Typical value| In |
21
|----------+--------------------+-----------------+-------------+--------|
22
|STATUS |ups.status |UPS status |OL |yes |
23
|----------+--------------------+-----------------+-------------+--------|
24
|n/a |ups.alarm |UPS alarms |OVERHEAT |n/a |
25
|----------+--------------------+-----------------+-------------+--------|
26
|n/a |ups.time |Internal UPS |n/a | |
28
|----------+--------------------+-----------------+-------------| |
29
|n/a |ups.date |Internal UPS |n/a | |
31
|----------+--------------------+-----------------+-------------+--------|
32
|MODEL |ups.model |UPS model |SMART-UPS 700|yes |
33
|----------+--------------------+-----------------+-------------+--------|
34
|MFR |ups.mfr |UPS manufacturer |APC |yes |
35
|----------+--------------------+-----------------+-------------+--------|
36
| | |UPS manufacturing| | |
37
|MFRDATE |ups.mfr.date |date (opaque |10/17/96 |yes |
39
|----------+--------------------+-----------------+-------------+--------|
40
|SERIAL |ups.serial |UPS serial number|WS9643050926 |yes |
41
| | |(opaque string) | | |
42
|----------+--------------------+-----------------+-------------+--------|
43
|FIRMREV |ups.firmware |UPS firmware |50.9.D |yes |
44
| | |(opaque string) | | |
45
|----------+--------------------+-----------------+-------------+--------|
46
|FIRMREV2 |ups.firmware.aux |Auxiliary device |4Kx |yes |
48
|----------+--------------------+-----------------+-------------+--------|
49
|UPSTEMP |ups.temperature |UPS temperature |042.7 |yes |
50
| | |(degrees C) | | |
51
|----------+--------------------+-----------------+-------------+--------|
52
|LOADPCT |ups.load |Load on UPS |023.4 |yes |
54
|----------+--------------------+-----------------+-------------+--------|
56
|UPSIDENT |ups.id |identifier |Sierra |yes |
57
| | |(opaque string) | | |
58
|----------+--------------------+-----------------+-------------+--------|
59
| | |Interval to wait | | |
60
|WAKEDELAY |ups.delay.start |before restarting|0 |yes |
63
|----------+--------------------+-----------------+-------------+--------|
64
| | |Interval to wait | | |
65
|n/a |ups.delay.reboot |before rebooting |60 |n/a |
66
| | |the UPS (seconds)| | |
67
|----------+--------------------+-----------------+-------------+--------|
68
| | |Interval to wait | | |
69
|PDNGRACE |ups.delay.shutdown |after shutdown |20 |yes |
70
|GRACEDELAY| |with delay | | |
71
| | |command (seconds)| | |
72
|----------+--------------------+-----------------+-------------+--------|
73
| | |Interval between |1209600 (two | |
74
|SLFTSTINT |ups.test.interval |self tests |weeks) |yes |
76
|----------+--------------------+-----------------+-------------+--------|
77
| | |Results of last |Bad battery | |
78
|SLFTSTRES |ups.test.result |self test (opaque|pack |yes |
80
|----------+--------------------+-----------------+-------------+--------|
81
| | |Language to use | | |
82
|LANGUAGE |ups.display.language|on front panel |E |yes |
83
| | |(*** opaque) | | |
84
|----------+--------------------+-----------------+-------------+--------|
85
| | |UPS external | | |
86
|CONTACTS |ups.contacts |contact sensors |F0 |yes |
87
| | |(*** opaque) | | |
88
+------------------------------------------------------------------------+
90
+------------------------------------------------------------------------+
91
| input - Incoming line/power information |
92
|------------------------------------------------------------------------|
93
| Old name | New name | Description |Typical | In |
94
| | | | value |var_map?|
95
|-----------+-------------------------+----------------+--------+--------|
96
|UTILITY |input.voltage |Input voltage |121.5 |yes |
97
|-----------+-------------------------+----------------+--------+--------|
98
|MAXUTIL |input.voltage.maximum |Maximum incoming|130 |yes |
99
| | |voltage seen | | |
100
|-----------+-------------------------+----------------+--------+--------|
101
|MINUTIL |input.voltage.minimum |Minimum incoming|100 |yes |
102
| | |voltage seen | | |
103
|-----------+-------------------------+----------------+--------+--------|
104
|n/a |input.voltage.nominal |Nominal input |120 |n/a |
106
|-----------+-------------------------+----------------+--------+--------|
107
| | |Reason for last | | |
108
|XFERWHY |input.transfer.reason |transfer to |T |yes |
109
| | |battery (*** | | |
111
|-----------+-------------------------+----------------+--------+--------|
112
|LOWXFER |input.transfer.low |Low voltage |103 |yes |
113
| | |transfer point | | |
114
|-----------+-------------------------+----------------+--------+--------|
115
|HIGHXFER |input.transfer.high |High voltage |132 |yes |
116
| | |transfer point | | |
117
|-----------+-------------------------+----------------+--------+--------|
118
|LINESENS |input.sensitivity |Input power |H (high)|yes |
119
| | |sensitivity | | |
120
|-----------+-------------------------+----------------+--------+--------|
121
| | |Input power | | |
122
|LINEQUAL |input.quality |quality (*** |FF |yes |
124
|-----------+-------------------------+----------------+--------+--------|
125
|ACFREQ |input.frequency |Input line |60.00 |yes |
126
| | |frequency (Hz) | | |
127
|-----------+-------------------------+----------------+--------+--------|
128
| | |Low voltage | | |
129
|LOBOOSTXFER|input.transfer.boost.low |boosting |190 |yes |
130
| | |transfer point | | |
131
|-----------+-------------------------+----------------+--------+--------|
132
| | |High voltage | | |
133
|HIBOOSTXFER|input.transfer.boost.high|boosting |210 |yes |
134
| | |transfer point | | |
135
|-----------+-------------------------+----------------+--------+--------|
136
| | |Low voltage | | |
137
|LOTRIMXFER |input.transfer.trim.low |trimming |230 |yes |
138
| | |transfer point | | |
139
|-----------+-------------------------+----------------+--------+--------|
140
| | |High voltage | | |
141
|HITRIMXFER |input.transfer.trim.high |trimming |240 |yes |
142
| | |transfer point | | |
143
+------------------------------------------------------------------------+
145
+------------------------------------------------------------------------+
146
| output - Outgoing power/inverter information |
147
|------------------------------------------------------------------------|
148
|Old name | New name | Description |Typical| In |
149
| | | | value |var_map?|
150
|---------+-----------------------------+---------------+-------+--------|
151
|OUTVOLT |output.voltage |Output voltage |120.9 |yes |
152
|---------+-----------------------------+---------------+-------+--------|
153
|n/a |output.frequency |Output |60 |n/a |
154
| | |frequency (Hz) | | |
155
|---------+-----------------------------+---------------+-------+--------|
156
| | |Target output | | |
157
|OUTVLTSEL|output.voltage.target.line |voltage when on|120 |yes |
159
|---------+-----------------------------+---------------+-------+--------|
160
| | |Target output | | |
161
|REQVOLT |output.voltage.target.battery|voltage when on|120 |yes |
163
|---------+-----------------------------+---------------+-------+--------|
164
|CURRENT |output.current |Output current |4.25 |yes |
166
+------------------------------------------------------------------------+
168
+------------------------------------------------------------------------+
169
| battery - Any battery details |
170
|------------------------------------------------------------------------|
171
|BATTPCT |battery.charge |Battery charge |100.0 |yes|
173
|------------+-----------------------+-----------------+-------------+---|
174
| | |Remaining battery| | |
175
|LOBATTPCT |battery.charge.low |level when UPS |20 |yes|
176
| | |switches to LB | | |
178
|------------+-----------------------+-----------------+-------------+---|
179
| | |Minimum battery | | |
180
|WAKETHRSH |battery.charge.restart |level for UPS |20 |yes|
181
|RTHRESH | |restart after | | |
183
|------------+-----------------------+-----------------+-------------+---|
184
|BATTVOLT |battery.voltage |Battery charge |24.84 |yes|
186
|------------+-----------------------+-----------------+-------------+---|
187
|BATT_CURRENT|battery.current |Battery current |1.19 |yes|
189
|------------+-----------------------+-----------------+-------------+---|
191
|BATT_TEMP |battery.temperature |temperature |050.7 |yes|
192
| | |(degrees C) | | |
193
|------------+-----------------------+-----------------+-------------+---|
194
|NOMBATVLT |battery.voltage.nominal|Nominal battery |024 |yes|
196
|------------+-----------------------+-----------------+-------------+---|
197
|BATT_RUNTIME|battery.runtime |Battery runtime |1080 |yes|
198
|RUNTIME | |(seconds) | | |
199
|------------+-----------------------+-----------------+-------------+---|
200
| | |Remaining battery| | |
201
|LOBATTIME |battery.runtime.low |runtime when UPS |180 |yes|
202
| | |switches to LB | | |
204
|------------+-----------------------+-----------------+-------------+---|
205
|ALRMDELAY |battery.alarm.threshold|Battery alarm |0 (immediate)|yes|
206
|ALRMDEL | |threshold | | |
207
|------------+-----------------------+-----------------+-------------+---|
208
| | |Battery change | | |
209
|BATTDATE |battery.date |date (opaque |11/14/00 |yes|
211
|------------+-----------------------+-----------------+-------------+---|
212
|BATTPACKS |battery.packs |Number of battery|001 |yes|
214
|------------+-----------------------+-----------------+-------------+---|
215
|BADPACKS |battery.packs.bad |Number of bad |000 |yes|
216
| | |battery packs | | |
217
+------------------------------------------------------------------------+
219
+------------------------------------------------------------------------+
220
| ambient - Conditions from external probe equipment |
221
|------------------------------------------------------------------------|
222
|Old name| New name |Description |Typical| In |
223
| | | | value |var_map?|
224
|--------+---------------------------------+------------+-------+--------|
226
|AMBTEMP |ambient.temperature |temperature |25.40 |yes |
227
| | |(degrees C) | | |
228
|--------+---------------------------------+------------+-------+--------|
231
|n/a |ambient.temperature.alarm |temperature |0 |n/a |
234
|--------+---------------------------------+------------+-------+--------|
236
|TEMPMAX |ambient.temperature.alarm.maximum|allowed |NO,NO |yes |
237
| | |temperature | | |
238
| | |(*** opaque)| | |
239
|--------+---------------------------------+------------+-------+--------|
241
|TEMPMIN |ambient.temperature.alarm.minimum|allowed |NO,NO |yes |
242
| | |temperature | | |
243
| | |(*** opaque)| | |
244
|--------+---------------------------------+------------+-------+--------|
245
| | |Enable alarm| | |
246
|n/a |ambient.temperature.alarm.enable |for ambient |1 |n/a |
247
| | |temperature | | |
248
|--------+---------------------------------+------------+-------+--------|
250
|AMBHUMID|ambient.humidity |relative |038.8 |yes |
253
|--------+---------------------------------+------------+-------+--------|
256
|n/a |ambient.humidity.alarm |humidity |0 |n/a |
259
|--------+---------------------------------+------------+-------+--------|
261
|HUMDMAX |ambient.humidity.alarm.maximum |allowed |NO,NO |yes |
263
| | |(*** opaque)| | |
264
|--------+---------------------------------+------------+-------+--------|
266
|HUMDMIN |ambient.humidity.alarm.minimum |allowed |NO,NO |yes |
268
| | |(*** opaque)| | |
269
|--------+---------------------------------+------------+-------+--------|
270
| | |Enable alarm| | |
271
|n/a |ambient.humidity.alarm.enable |for ambient |1 |n/a |
273
+------------------------------------------------------------------------+
275
+------------------------------------------------------------------------+
276
| outlet - Smart outlet management (smart on/off switch, ...) |
277
|------------------------------------------------------------------------|
278
|Old | New name | Description |Typical| In |
279
|name| | | value |var_map?|
280
|----+------------------------------+-------------------+-------+--------|
281
| | |Outlet system | | |
282
|n/a |outlet.n.id |identifier (opaque |1 |no |
284
|----+------------------------------+-------------------+-------+--------|
285
|n/a |outlet.n.desc |Outlet description |Main |no |
286
| | |(opaque string) |outlet | |
287
|----+------------------------------+-------------------+-------+--------|
288
|n/a |outlet.n.switch |Outlet switch |on |no |
289
| | |control (on/off) | | |
290
|----+------------------------------+-------------------+-------+--------|
291
|n/a |outlet.n.status |Outlet switch |on |no |
292
| | |status (on/off) | | |
293
|----+------------------------------+-------------------+-------+--------|
294
|n/a |outlet.n.switchable |Outlet switch |yes |no |
295
| | |ability (yes/no) | | |
296
|----+------------------------------+-------------------+-------+--------|
297
| | |Remaining battery | | |
298
|n/a |outlet.n.autoswitch.charge.low|level to power off |90 |no |
299
| | |this outlet | | |
301
|----+------------------------------+-------------------+-------+--------|
302
| | |Interval to wait | | |
303
|n/a |outlet.n.delay.shutdown |before shutting |180 |no |
304
| | |down this outlet | | |
306
|----+------------------------------+-------------------+-------+--------|
307
| | |Interval to wait | | |
308
|n/a |outlet.n.delay.start |before restarting |120 |no |
309
| | |this outlet | | |
311
+------------------------------------------------------------------------+
313
+------------------------------------------------------------------------+
314
| driver - Internal driver information |
315
|------------------------------------------------------------------------|
316
| Old | New name | Description | Typical | In |
317
| name | | | value | var_map? |
318
|------+-------------------------+-----------------+----------+----------|
319
| n/a | driver.name | Driver name | apcsmart | n/a |
320
|------+-------------------------+-----------------+----------+----------|
321
| n/a | driver.version | Driver version | X.Y.Z | n/a |
322
| | | (NUT release) | | |
323
|------+-------------------------+-----------------+----------+----------|
324
| | | Internal driver | | |
325
| n/a | driver.version.internal | version (if | 1.23.45 | n/a |
327
| | | separately) | | |
328
|------+-------------------------+-----------------+----------+----------|
329
| | | Parameter xxx | | |
330
| n/a | driver.parameter.xxx | (ups.conf or | (varies) | n/a |
331
| | | cmdline -x) | | |
333
|------+-------------------------+-----------------+----------+----------|
334
| | | Flag xxx | enabled | |
335
| n/a | driver.flag.xxx | (ups.conf or | (or not | n/a |
336
| | | cmdline -x) | present) | |
338
+------------------------------------------------------------------------+
340
+------------------------------------------------------------------------+
341
| server - Internal server information |
342
|------------------------------------------------------------------------|
343
|Old | New name |Description| Typical value | In |
344
|name| | | |var_map?|
345
|----+--------------+-----------+-------------------------------+--------|
346
|n/a |server.info |Server |Network UPS Tools upsd vX.Y.Z -|n/a |
347
| | |information|http://www.exploits.org/nut/ | |
348
|----+--------------+-----------+-------------------------------+--------|
349
|n/a |server.version|Server |X.Y.Z |n/a |
351
+------------------------------------------------------------------------+
355
+------------------------------------------------------------------------+
356
| Old name | New name | Description | In |
358
|-----------+--------------------------+----------------------+----------|
359
| OFF | load.off | Turn off the load | yes |
360
| | | immediately | |
361
|-----------+--------------------------+----------------------+----------|
362
| ON | load.on | Turn on the load | yes |
363
| | | immediately | |
364
|-----------+--------------------------+----------------------+----------|
365
| | | Turn off the load | |
366
| SOFTDOWN | shutdown.return | possibly after a | yes |
367
| | | delay and return | |
368
| | | when power is back | |
369
|-----------+--------------------------+----------------------+----------|
370
| | | Turn off the load | |
371
| | | possibly after a | |
372
| SHUTDOWN | shutdown.stayoff | delay and remain off | yes |
373
| | | even if power | |
375
|-----------+--------------------------+----------------------+----------|
376
| STOPSHUTD | shutdown.stop | Stop a shutdown in | yes |
378
|-----------+--------------------------+----------------------+----------|
379
| | | Shut down the load | |
380
| n/a | shutdown.reboot | briefly while | yes |
381
| | | rebooting the UPS | |
382
|-----------+--------------------------+----------------------+----------|
383
| | | After a delay, shut | |
384
| n/a | shutdown.reboot.graceful | down the load | yes |
385
| | | briefly while | |
386
| | | rebooting the UPS | |
387
|-----------+--------------------------+----------------------+----------|
388
| FPTEST | test.panel.start | Start testing the | yes |
390
|-----------+--------------------------+----------------------+----------|
391
| n/a | test.panel.stop | Stop a UPS panel | n/a |
393
|-----------+--------------------------+----------------------+----------|
394
| SIMPWF | test.failure.start | Start a simulated | yes |
395
| | | power failure | |
396
|-----------+--------------------------+----------------------+----------|
397
| n/a | test.failure.stop | Stop simulating a | n/a |
398
| | | power failure | |
399
|-----------+--------------------------+----------------------+----------|
400
| BTEST1 | test.battery.start | Start a battery test | yes |
401
|-----------+--------------------------+----------------------+----------|
402
| BTEST0 | test.battery.stop | Stop the battery | yes |
404
|-----------+--------------------------+----------------------+----------|
405
| CAL1 | calibrate.start | Start runtime | yes |
406
| | | calibration | |
407
|-----------+--------------------------+----------------------+----------|
408
| CAL0 | calibrate.stop | Stop runtime | yes |
409
| | | calibration | |
410
|-----------+--------------------------+----------------------+----------|
411
| BYPASS | bypass.start | Put the UPS in | yes |
412
| | | bypass mode | |
413
|-----------+--------------------------+----------------------+----------|
414
| n/a | bypass.stop | Take the UPS out of | n/a |
415
| | | bypass mode | |
416
|-----------+--------------------------+----------------------+----------|
417
| | | Reset minimum and | |
418
| n/a | reset.input.minmax | maximum input | n/a |
419
| | | voltage status | |
420
|-----------+--------------------------+----------------------+----------|
421
| | | Reset watchdog timer | |
422
| WATCHDOG | reset.watchdog | (forced reboot of | yes |
424
|-----------+--------------------------+----------------------+----------|
425
| n/a | beeper.on | Enable UPS | n/a |
426
| | | beeper/buzzer | |
427
|-----------+--------------------------+----------------------+----------|
428
| n/a | beeper.off | Disable UPS | n/a |
429
| | | beeper/buzzer | |
430
+------------------------------------------------------------------------+