<!--startmeta
custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/snmp/npm-catalog/integrations/eaton_ups.md"
meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/snmp/npm-catalog/metadata.yaml"
sidebar_label: "Eaton UPS"
learn_status: "Published"
learn_rel_path: "Network Performance Monitoring/Device Metrics/Integrations"
keywords: ['eaton', 'ups', 'snmp', 'ups', 'npm']
message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE NPM CATALOG metadata.yaml FILE"
endmeta-->

<!-- markdownlint-disable-file -->

# Eaton UPS


<img src="https://netdata.cloud/img/SNMP.png" width="150"/>


Plugin: go.d.plugin
Module: snmp

<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />

## Overview

Monitor Eaton UPS (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 **eaton-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 Eaton UPS 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:

| Method                | Best for                                                                                 | How to                                                                                                                                 |
|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
| [**UI**](#via-ui)     | Fast setup without editing files                                                         | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **snmp**, then click **+** to add a job. |
| [**File**](#via-file) | If 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 :gear: (**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:

```yaml
update_every: 1
autodetection_retry: 0
jobs:
  - name: some_name1
  - name: some_name2
```
You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).

```bash
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 Eaton UPS 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.

**68 metrics** in 14 groups; each row is a chart context usable in alerts.

| Group | Metrics |
|---|---|
| Environment / Humidity | 1 |
| Environment / Temperature | 1 |
| Hardware / Battery | 7 |
| PowerFlow / Bypass | 9 |
| PowerFlow / Input | 14 |
| PowerFlow / Output | 17 |
| PowerFlow / Receptacle | 4 |
| System / Alarm | 2 |
| System / Battery | 2 |
| System / Config | 4 |
| System / Control | 1 |
| System / Test | 2 |
| System / Topology | 3 |
| System / Uptime | 1 |

### Environment / Humidity

| Metric (chart context) | Unit | Scope | Description |
|---|---|---|---|
| `snmp.device_prof_xupsEnvAmbientHumidity` | `%` | device | Ambient humidity near UPS |

### Environment / Temperature

| Metric (chart context) | Unit | Scope | Description |
|---|---|---|---|
| `snmp.device_prof_xupsEnvAmbientTemp` | `Cel` | device | Ambient temperature near UPS |

### Hardware / Battery

| Metric (chart context) | Unit | Scope | Description |
|---|---|---|---|
| `snmp.device_prof_xupsBatCurrent` | `A` | device | Battery current (positive=discharging, negative=charging) |
| `snmp.device_prof_xupsBatVoltage` | `V` | device | Battery voltage |
| `snmp.device_prof_xupsBatteryAbmStatus` | `{status}` | device | Advanced Battery Management status |
| `snmp.device_prof_xupsBatteryAged` | `{status}` | device | Battery age indicator |
| `snmp.device_prof_xupsBatteryFailure` | `{status}` | device | Battery fault or test failure indicator |
| `snmp.device_prof_xupsBatteryLowCapacity` | `{status}` | device | Battery low capacity indicator |
| `snmp.device_prof_xupsBatteryNotPresent` | `{status}` | device | Battery presence indicator |

### PowerFlow / Bypass

| Metric (chart context) | Unit | Scope | Description |
|---|---|---|---|
| `snmp.device_prof_xupsBypassAveragePowerFactor` | — | device | Average bypass power factor |
| `snmp.device_prof_xupsBypassAverageVoltage` | `V` | device | Average bypass voltage |
| `snmp.device_prof_xupsBypassCurrentHighPrecision` | `A` | per phase, phase_name | Bypass current per phase (high precision) |
| `snmp.device_prof_xupsBypassFrequency` | `Hz` | device | Bypass frequency |
| `snmp.device_prof_xupsBypassTotalCurrent` | `A` | device | Total bypass current |
| `snmp.device_prof_xupsBypassTotalVA` | `VA` | device | Total bypass apparent power |
| `snmp.device_prof_xupsBypassTotalWatts` | `W` | device | Total bypass active power |
| `snmp.device_prof_xupsBypassVoltage` | `V` | per phase, phase_name | Bypass voltage per phase |
| `snmp.device_prof_xupsBypassWatts` | `W` | per phase, phase_name | Bypass real power per phase |

### PowerFlow / Input

| Metric (chart context) | Unit | Scope | Description |
|---|---|---|---|
| `snmp.device_prof_xupsDualInputStatus` | `{status}` | device | Dual input source status |
| `snmp.device_prof_xupsInputAveragePowerFactor` | — | device | Average input power factor |
| `snmp.device_prof_xupsInputAverageVoltage` | `V` | device | Average input voltage (single phase) or average across phases |
| `snmp.device_prof_xupsInputCurrent` | `A` | per phase, phase_name | Input current per phase |
| `snmp.device_prof_xupsInputCurrentHighPrecision` | `A` | per phase, phase_name | Input current per phase (high precision) |
| `snmp.device_prof_xupsInputFrequency` | `Hz` | device | Input line frequency |
| `snmp.device_prof_xupsInputLineBads` | `{event}` | device | Count of input out-of-tolerance events |
| `snmp.device_prof_xupsInputSource` | `{source}` | device | Current input power source |
| `snmp.device_prof_xupsInputStatus` | `{status}` | device | Primary AC input status |
| `snmp.device_prof_xupsInputTotalCurrent` | `A` | device | Total input current |
| `snmp.device_prof_xupsInputTotalVA` | `VA` | device | Total input apparent power |
| `snmp.device_prof_xupsInputTotalWatts` | `W` | device | Total input active power |
| `snmp.device_prof_xupsInputVoltage` | `V` | per phase, phase_name | Input voltage per phase |
| `snmp.device_prof_xupsInputWatts` | `W` | per phase, phase_name | Input real power per phase |

### PowerFlow / Output

| Metric (chart context) | Unit | Scope | Description |
|---|---|---|---|
| `snmp.device_prof_xupsOutputAveragePowerFactor` | — | device | Average output power factor |
| `snmp.device_prof_xupsOutputAverageVoltage` | `V` | device | Average output voltage |
| `snmp.device_prof_xupsOutputCumulativePowerUsage` | `Wh` | device | Cumulative energy consumed since last reset |
| `snmp.device_prof_xupsOutputCurrent` | `A` | per phase, phase_name | Output current per phase |
| `snmp.device_prof_xupsOutputCurrentHighPrecision` | `A` | per phase, phase_name | Output current per phase (high precision) |
| `snmp.device_prof_xupsOutputFrequency` | `Hz` | device | Output frequency |
| `snmp.device_prof_xupsOutputHourlyPowerUsage` | `Wh` | device | Energy consumed during the last hour |
| `snmp.device_prof_xupsOutputLoad` | `%` | device | UPS output load percentage |
| `snmp.device_prof_xupsOutputPercentLoad` | `%` | per phase, phase_name | Output load percentage per phase |
| `snmp.device_prof_xupsOutputSource` | `{source}` | device | Current output power source |
| `snmp.device_prof_xupsOutputStatus` | `{status}` | device | AC output protection status |
| `snmp.device_prof_xupsOutputTotalCurrent` | `A` | device | Total output current |
| `snmp.device_prof_xupsOutputTotalVA` | `VA` | device | Total output apparent power |
| `snmp.device_prof_xupsOutputTotalWatts` | `W` | device | Total output active power |
| `snmp.device_prof_xupsOutputVA` | `VA` | per phase, phase_name | Output apparent power per phase |
| `snmp.device_prof_xupsOutputVoltage` | `V` | per phase, phase_name | Output voltage per phase |
| `snmp.device_prof_xupsOutputWatts` | `W` | per phase, phase_name | Output real power per phase |

### PowerFlow / Receptacle

| Metric (chart context) | Unit | Scope | Description |
|---|---|---|---|
| `snmp.device_prof_xupsNumReceptacles` | `{receptacle}` | device | Number of controllable receptacles |
| `snmp.device_prof_xupsRecepCumulativePowerUsage` | `Wh` | per receptacle | Receptacle cumulative energy consumption |
| `snmp.device_prof_xupsRecepHourlyPowerUsage` | `Wh` | per receptacle | Receptacle hourly energy consumption |
| `snmp.device_prof_xupsRecepStatus` | `{status}` | per receptacle | Receptacle power status |

### System / Alarm

| Metric (chart context) | Unit | Scope | Description |
|---|---|---|---|
| `snmp.device_prof_xupsAlarmNumEvents` | `{event}` | device | Number of entries in UPS event history |
| `snmp.device_prof_xupsAlarms` | `{alarm}` | device | Current number of active alarm conditions |

### System / Battery

| Metric (chart context) | Unit | Scope | Description |
|---|---|---|---|
| `snmp.device_prof_xupsBatCapacity` | `%` | device | Battery charge level |
| `snmp.device_prof_xupsBatTimeRemaining` | `s` | device | Battery runtime remaining before UPS shutdown |

### System / Config

| Metric (chart context) | Unit | Scope | Description |
|---|---|---|---|
| `snmp.device_prof_xupsConfigInputVoltage` | `V` | device | Nominal input voltage |
| `snmp.device_prof_xupsConfigOutputFreq` | `Hz` | device | Nominal output frequency |
| `snmp.device_prof_xupsConfigOutputVoltage` | `V` | device | Nominal output voltage |
| `snmp.device_prof_xupsConfigOutputWatts` | `W` | device | Nominal output power capacity |

### System / Control

| Metric (chart context) | Unit | Scope | Description |
|---|---|---|---|
| `snmp.device_prof_xupsSwitchable` | `{status}` | device | Whether UPS accepts remote control commands |

### System / Test

| Metric (chart context) | Unit | Scope | Description |
|---|---|---|---|
| `snmp.device_prof_xupsLastGeneralTestResult` | `{status}` | device | Last general test result |
| `snmp.device_prof_xupsTestBatteryStatus` | `{status}` | device | Last battery test status |

### System / Topology

| Metric (chart context) | Unit | Scope | Description |
|---|---|---|---|
| `snmp.device_prof_xupsTopoPowerStrategy` | `{strategy}` | device | Current power strategy setting |
| `snmp.device_prof_xupsTopoUnitNumber` | `{unit}` | device | Unit number in parallel system (0=standalone or system view) |
| `snmp.device_prof_xupsTopologyType` | `{type}` | device | UPS power topology type |

### System / Uptime

| Metric (chart context) | Unit | Scope | Description |
|---|---|---|---|
| `snmp.device_prof_systemUptime` | `s` | device | Time since the system was last rebooted or powered on. |
