APC UPS Check Reference

Parameters, thresholds, and config options for the APC UPS check in octoja — SNMP polling of battery status, load, runtime, voltage, and self-test results.

Written By Erdinc Akay

Last updated About 2 months ago

APC UPS Check Reference

The APC UPS Check monitors APC uninterruptible power supplies via SNMP and collects battery status, load, runtime, voltage, and self-test results.

Configuration fields

FieldTypeRequiredDefaultDescription
HostStringYes—Hostname or IP address of the UPS
SNMP versionSelect (v2c / v3)Yesv2cSNMP protocol version used to query the device
SNMP CommunityStringNopublicSNMP v2c community string. Only shown when SNMP version is v2c.
SNMPv3 userStringNo—USM user name. Only shown when SNMP version is v3.
Authentication protocolSelect (None / SHA-1 / SHA-256)NoNoneMessage authentication algorithm. Only shown when SNMP version is v3.
Authentication passwordPasswordNo—Only shown when an authentication protocol is selected.
Privacy protocolSelect (None / AES-128 / AES-192 / AES-256)NoNonePayload encryption algorithm (requires authentication). Only shown when an authentication protocol is selected.
Privacy passwordPasswordNo—Only shown when a privacy protocol is selected.
Battery Thresholds
Battery warning (%)PercentNo50Battery charge below this value triggers a warning
Battery critical (%)PercentNo25Battery charge below this value triggers a critical result
Runtime Thresholds
Runtime warning (min)MinutesNo15Estimated runtime below this value triggers a warning
Runtime critical (min)MinutesNo5Estimated runtime below this value triggers a critical result
Load Thresholds
Load warning (%)PercentNo80Output load above this value triggers a warning
Load critical (%)PercentNo95Output load above this value triggers a critical result
Voltage Thresholds
Input voltage low (V)VoltsNo210Input voltage below this value triggers a warning
Input voltage high (V)VoltsNo250Input voltage above this value triggers a warning

Collected metrics

  • Model
  • Firmware version
  • UPS status (online, on battery, etc.)
  • Battery charge (%)
  • Estimated runtime (minutes)
  • Output load (%)
  • Input voltage (V)
  • Output voltage (V)
  • Input frequency (Hz)
  • Output frequency (Hz)
  • Output current (A)
  • Temperature (°C)
  • Last self-test result and date
  • Last transfer reason
  • Battery needs replacement (true/false)
  • Communication OK (true/false)

Platform support

The check is network-based and runs on any agent device that can reach the UPS over the network via SNMP. Availability on a given platform follows whichever agent runtimes are shipped in your octoja release.

Notes

  • Requires SNMP (v2c or v3) enabled on the UPS network management card.
  • The check runs every 5 minutes by default.
  • The check uses standard APC SNMP OIDs. It works with APC Smart-UPS, Back-UPS Pro, and Symmetra models equipped with a network management card.
  • Voltage thresholds should be adjusted to match your local power grid standard (e.g. 230 V ± 10 % in Europe, 120 V ± 10 % in North America).

See also: Configure an APC UPS Check