banshee/hardware-collection/hardware/ups/snmp/
status
The power source, battery, runtime, load, self-test and alarms of a UPS of any brand by SNMP (UPS-MIB).
par banshee1 installation2 versions
v2Dernière
Publiée le 28 octobre 2026. One naming convention across collections; documentation completed.
UPS, by SNMP (UPS-MIB)
Returns, for an uninterruptible power supply of any brand, what feeds its output (mains, battery, bypass), the state of its battery, the time spent on battery, the runtime and the charge left, the battery temperature, the load of its most loaded output line, the result of its last self-test, and the alarms it raises. Eight watches are offered, each one set on the probe.
Versions
Generic: written for UPS-MIB, the standard MIB of RFC 1628 (1994), unchanged since. It is the MIB a UPS network card serves whatever its brand, often beside a MIB of its own; which card serves it, and whether it must be turned on, is not checked here. Hence the common level. What a brand adds to it is read by its own collector (ups/apc/snmp/status, ups/eaton/snmp/status).
How it works
The collector walks upsObjects (1.3.6.1.2.1.33.1), a branch of a few dozen values, and reads:
| Object | OID | Read as |
|---|---|---|
upsOutputSource | .4.1.0 | source: other (1), none (2), normal (3), bypass (4), battery (5), booster (6), reducer (7) |
upsBatteryStatus | .2.1.0 | battery: unknown (1), normal (2), low (3), depleted (4) |
upsSecondsOnBattery | .2.2.0 | on-battery, in seconds, 0 on mains |
upsEstimatedMinutesRemaining | .2.3.0 | runtime, in minutes |
upsEstimatedChargeRemaining | .2.4.0 | charge, in % |
upsBatteryTemperature | .2.7.0 | temperature, in °C |
upsOutputPercentLoad | .4.4.1.5.<line> | load: the highest of the output lines, in % of their capacity |
upsTestResultsSummary | .7.3.0 | self-test: pass (1), warning (2), error (3), aborted (4), in-progress (5), none (6, never run) |
upsAlarmsPresent | .6.1.0 | alarms |
upsAlarmDescr | .6.2.1.2.<id> | alarm-list: the name of each well-known alarm of the MIB (1.3.6.1.2.1.33.1.6.3.<n>: on battery, low battery, output overload, fan failure…), or the OID of a brand's own, joined by , |
boosterandreducerare the UPS correcting a low or a high mains voltage on its own (line-interactive UPS): they raise nothing.- A value the UPS does not serve (the battery temperature, the self-test) is not returned.
- An agent that serves neither
upsOutputSourcenorupsBatteryStatusstops the collectormisconfigured. - The collector only reads: SNMP sends nothing but reads. No self-test is started.
Prerequisites
- The SNMP agent of the UPS's network card enabled, its UPS-MIB (RFC 1628) turned on where the card makes it optional, reachable from the poller (UDP 161), its access restricted to the poller.
- Read-only access, SNMPv2c or SNMPv3, set on the host or one of its folders (
protocol:snmp:*variables).
Outputs
| Name | Label | Unit | Per instance |
|---|---|---|---|
source | Output source | — | no |
battery | Battery state | — | no |
on-battery | Time on battery | s | no |
runtime | Runtime left | min | no |
charge | Battery charge | % | no |
temperature | Battery temperature | °C | no |
load | Load | % | no |
self-test | Last self-test | — | no |
alarms | Alarms | — | no |
alarm-list | Alarms raised | — | no |
Watches
| Name | Title | Kind | Defaults | Checked by default |
|---|---|---|---|---|
on-battery | On battery, bypass or off | state to avoid, on source | warning on battery, bypass; critical on none (nothing feeds the output) | yes |
battery | Battery low or depleted | state to avoid, on battery | warning on low, critical on depleted | yes |
runtime | Little runtime left | below a threshold, on runtime | warning below 15 min, critical below 5 min | yes |
charge | Battery not charged | below a threshold, on charge | warning below 50 %, critical below 20 %, for 2 runs | yes |
temperature | Battery too hot | above a threshold, on temperature | warning above 40 °C, critical above 50 °C, for 3 runs | yes |
load | Overloaded | above a threshold, on load | warning above 80 %, critical above 95 %, for 3 runs | yes |
self-test | Self-test failed | state to avoid, on self-test | warning on warning, critical on error | yes |
alarms | Alarms raised | above a threshold, on alarms | warning above 0 | yes |
- A battery that ages shows first by its runtime, which shortens, and by a failed self-test.
Limits
- The runtime and the charge are the UPS's estimates: a UPS that has not discharged for long may overestimate them.
- An alarm of a brand's own is listed by its OID: the brand's collector names it, when there is one.
- Not checked against a UPS: the OIDs and values are those of RFC 1628.