Skip to main content

Generic UPS (UPS-MIB)

Generic UPS (UPS-MIB)

Plugin: go.d.plugin Module: snmp

Maintained by Netdata

Overview​

Monitor Generic UPS (UPS-MIB) (ups) with Netdata over SNMP. Netdata recognizes the device automatically by its sysObjectID (recognized across 1 device identifiers) and collects the metrics this profile declares — on top of the generic SNMP baseline — with no manual OID configuration.

Netdata's SNMP collector matches the device to the generic-ups.yaml profile via sysObjectID/sysDescr, then polls the OIDs it declares.

This integration is supported on all platforms.

This integration supports multiple instances configured side-by-side.

Default Behavior​

Auto-Detection​

Auto-detected as Generic UPS (UPS-MIB) via sysObjectID/sysDescr.

Limits​

The default configuration for this integration does not impose any limits.

Performance Impact​

The default configuration for this integration is not expected to impose a significant performance impact on the system.

Setup​

You can configure the snmp collector in two ways:

MethodBest forHow to
UIFast setup without editing filesGo to Nodes → Configure this node → Collectors → Jobs, search for snmp, then click + to add a job.
FileIf you prefer configuring via file, or need to automate deployments (e.g., with Ansible)Edit go.d/snmp.conf and add a job.
important

UI configuration requires paid Netdata Cloud plan.

Prerequisites​

SNMP access​

SNMP must be enabled on the device and reachable from the Netdata Agent acting as the site's SNMP hub.

Configuration​

Options​

Configure the SNMP collector with the device hostname and SNMP credentials. See the SNMP collector reference for all options.

via UI​

Configure the snmp collector from the Netdata web interface:

  1. Go to Nodes.
  2. Select the node where you want the snmp data-collection job to run and click the ⚙ (Configure this node). That node will run the data collection.
  3. The Collectors → Jobs view opens by default.
  4. In the Search box, type snmp (or scroll the list) to locate the snmp collector.
  5. Click the + next to the snmp collector to add a new job.
  6. Fill in the job fields, then click Test to verify the configuration and Submit to save.
    • Test runs the job with the provided settings and shows whether data can be collected.
    • If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.

via File​

The configuration file name for this integration is go.d/snmp.conf.

The file format is YAML. Generally, the structure is:

update_every: 1
autodetection_retry: 0
jobs:
- name: some_name1
- name: some_name2

You can edit the configuration file using the edit-config script from the Netdata config directory.

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/snmp.conf
Examples​

There are no configuration examples.

Alerts​

There are no alerts configured by default for this integration.

Metrics​

On top of the generic SNMP baseline (the Generic SNMP Device integration — interfaces, system, IP/TCP/UDP, host resources), this Generic UPS (UPS-MIB) profile adds the metrics below. Each is collected only where the device exposes the matching OID — inclusion means the profile requests it; availability depends on the device model and software.

30 metrics in 8 groups; each row is a chart context usable in alerts.

GroupMetrics
Hardware / Battery4
PowerFlow / Bypass5
PowerFlow / Input6
PowerFlow / Output7
System / Alarm2
System / Battery3
System / Test2
System / Uptime1

Hardware / Battery​

Metric (chart context)UnitScopeDescription
snmp.device_prof_upsBatteryCurrentAdeviceThe present battery current
snmp.device_prof_upsBatteryStatus{status}deviceThe indication of the capacity remaining in the UPS system's batteries
snmp.device_prof_upsBatteryTemperatureCeldeviceThe ambient temperature at or near the UPS Battery casing
snmp.device_prof_upsBatteryVoltageVdeviceThe magnitude of the present battery voltage

PowerFlow / Bypass​

Metric (chart context)UnitScopeDescription
snmp.device_prof_upsBypassCurrentAper ups_bypass_line_indexThe present bypass current
snmp.device_prof_upsBypassFrequencyHzdeviceThe present bypass frequency
snmp.device_prof_upsBypassNumLines{line}deviceThe number of bypass lines utilized in this device. This entry indicates the number of rows in the bypass table
snmp.device_prof_upsBypassPowerWper ups_bypass_line_indexThe present true power conveyed by the bypass
snmp.device_prof_upsBypassVoltageVper ups_bypass_line_indexThe present bypass voltage

PowerFlow / Input​

Metric (chart context)UnitScopeDescription
snmp.device_prof_upsInputCurrentAper ups_input_line_indexThe magnitude of the present input current
snmp.device_prof_upsInputFrequencyHzper ups_input_line_indexThe present input frequency
snmp.device_prof_upsInputLineBads{transition}deviceA count of the number of times the input entered an out-of-tolerance condition as defined by the manufacturer. This count is incre…
snmp.device_prof_upsInputNumLines{line}deviceThe number of input lines utilized in this device. This variable indicates the number of rows in the input table
snmp.device_prof_upsInputTruePowerWper ups_input_line_indexThe magnitude of the present input true power
snmp.device_prof_upsInputVoltageVper ups_input_line_indexThe magnitude of the present input voltage

PowerFlow / Output​

Metric (chart context)UnitScopeDescription
snmp.device_prof_upsOutputCurrentAper ups_output_line_indexThe present output current
snmp.device_prof_upsOutputFrequencyHzdeviceThe present output frequency
snmp.device_prof_upsOutputNumLines{line}deviceThe number of output lines utilized in this device. This variable indicates the number of rows in the output table
snmp.device_prof_upsOutputPercentLoad%per ups_output_line_indexThe percentage of the UPS power capacity presently being used on this output line
snmp.device_prof_upsOutputPowerWper ups_output_line_indexThe present output true power
snmp.device_prof_upsOutputSource{status}deviceThe present source of output power
snmp.device_prof_upsOutputVoltageVper ups_output_line_indexThe present output voltage

System / Alarm​

Metric (chart context)UnitScopeDescription
snmp.device_prof_upsAlarmTimesper ups_alarm_descrThe value of sysUpTime when the alarm condition was detected. If the alarm condition was detected at the time of agent startup and…
snmp.device_prof_upsAlarmsPresent{alarm}deviceThe present number of active alarm conditions

System / Battery​

Metric (chart context)UnitScopeDescription
snmp.device_prof_upsEstimatedChargeRemaining%deviceAn estimate of the battery charge remaining expressed as a percent of full charge
snmp.device_prof_upsEstimatedMinutesRemainingmindeviceAn estimate of the time to battery charge depletion under the present load conditions if the utility power is off and remains off,…
snmp.device_prof_upsSecondsOnBatterysdeviceIf the unit is on battery power, the elapsed time since the UPS last switched to battery power, or the time since the network mana…

System / Test​

Metric (chart context)UnitScopeDescription
snmp.device_prof_upsTestResultsSummary{status}deviceThe results of the current or last UPS diagnostics test performed
snmp.device_prof_upsTestStartTimesdeviceThe value of sysUpTime at the time the test in progress was initiated, or, if no test is in progress, the time the previous test w…

System / Uptime​

Metric (chart context)UnitScopeDescription
snmp.device_prof_systemUptimesdeviceTime since the system was last rebooted or powered on.

Troubleshooting​

Other Problems​

Collect Diagnostics for Netdata Support​

For SNMP metrics, BGP, licensing, or topology issues, follow Collect SNMP troubleshooting data to include built-in diagnostics in a support bundle. SNMP evidence is unsanitized; share the bundle through a restricted Netdata Support ticket.


Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.