APC UPS Status Check - G2 | OpsRamp Documentation

Description

Template for monitoring APC UPS. Monitors battery capacity, battery status, run time remaining, temperature, input line voltage, output line voltage, etc. Tested on APC Web/SNMP Management Card. System Object Id: 1.3.6.1.4.1.318.1.3.27.

Prerequisites

SNMP should be enabled in end device and device should support Powernet-MIB OIDs and SNMP credentials should be attached against the device in portal.

How to Apply: This template is All instance selection based. It will not ask user to select any instance (s) while assigning it to a device.

Metric Parameters

Metric Parameters
Parameter	Description
Frequency	Frequency is the interval in which you want to probe and collect metric data from the target device/resource Frequency is defined in minutes (min).
Warning Threshold	If the metric value satisfies the condition defined along with Warning Threshold value, then a notification is sent to the user.
Critical Threshold	If the metric value satisfies the condition defined along with Critical Threshold value, then a notification is sent to the user.
Alert	The alert value can be set to either Yes or No. If it is Yes, then an alert message is sent to the user.

Metrics

ups.battery.status

Metric Details

Metric Details
Applicable for	Device
SNMP OID	1.3.6.1.4.1.318.1.1.1.2.1.1.0
Expression	NULL
Description	Indicates the status of the UPS batteries. Possible status values are 1 - Unknown, 2 - Battery Normal, 3 - Battery Low. [OID: 1.3.6.1.4.1.318.1.1.1.2.1.1 ]
Category	SNMP monitors
Collector Type	Gateway
Monitor Name	APC UPS Monitors
Unit

Possible Inputs

Possible Inputs
Metric	Input Value	Range of Values
Frequency	5	1 – 1440 (mins)
Filter
Warning Operator	EQUAL	Ends with, ==, !=, >=, <=, >, <, In Range, Out of range, Equals, Not equals, Equals Ignore Case, Not Equals Ignore Case, Contains, Not contains, Regex match, Regex no match, In string list, Not in string list, In List, Not in list, Starts with
Warning Threshold	1	[{"1":"unknown"},{"2":"batteryNormal"},{"3":"batteryLow"}]
Warning Repeat Count	1	1-12
Critical Operator	EQUAL	Ends with, ==, !=, >=, <=, >, <, In Range, Out of range, Equals, Not equals, Equals Ignore Case, Not Equals Ignore Case, Contains, Not contains, Regex match, Regex no match, In string list, Not in string list, In List, Not in list, Starts with
Critical Threshold	3	[{"1":"unknown"},{"2":"batteryNormal"},{"3":"batteryLow"}]
Critical Repeat Count	1	1-12
Alert	Yes	Yes/No
Graph (Yes/No)	Yes	Yes/No

Sample Output

ups.no.of.batter.packs.bad

Metric Details

Metric Details
Applicable for	Device
SNMP OID	1.3.6.1.4.1.318.1.1.1.2.2.6.0
Expression	NULL
Description	The number of external battery packs connected to the UPS that are defective. [OID: 1.3.6.1.4.1.318.1.1.1.2.2.6]
Category	SNMP monitors
Collector Type	Gateway
Monitor Name	APC UPS Monitors
Unit

Possible Inputs

Possible Inputs
Metric	Input Value	Range of Values
Frequency	5	1 – 1440 (mins)
Filter
Warning Operator
Warning Threshold
Warning Repeat Count
Critical Operator	GREATER_THAN_EQUAL	Ends with, ==, !=, >=, <=, >, <, In Range, Out of range, Equals, Not equals, Equals Ignore Case, Not Equals Ignore Case, Contains, Not contains, Regex match, Regex no match, In string list, Not in string list, In List, Not in list, Starts with
Critical Threshold	1	0 - 2147483647
Critical Repeat Count	1	1-12
Alert	Yes	Yes/No
Graph (Yes/No)	Yes	Yes/No

Sample Output

ups.battery.capacity

Metric Details

Metric Details
Applicable for	Device
SNMP OID	1.3.6.1.4.1.318.1.1.1.2.2.1.0
Expression	NULL
Description	The remaining battery capacity expressed in percent of full capacity. Alert is generated when the battery capacity is less than 99%. [OID: 1.3.6.1.4.1.318.1.1.1.2.2.1.0]
Category	SNMP monitors
Collector Type	Gateway
Monitor Name	APC UPS Monitors
Unit	%

Possible Inputs

Possible Inputs
Metric	Input Value	Range of Values
Frequency	5	1 – 1440 (mins)
Filter
Warning Operator
Warning Threshold
Warning Repeat Count
Critical Operator	LESS_THAN	Ends with, ==, !=, >=, <=, >, <, In Range, Out of range, Equals, Not equals, Equals Ignore Case, Not Equals Ignore Case, Contains, Not contains, Regex match, Regex no match, In string list, Not in string list, In List, Not in list, Starts with
Critical Threshold	99	0-100
Critical Repeat Count	1	1-12
Alert	Yes	Yes/No
Graph (Yes/No)	Yes	Yes/No

Sample Output

ups.battery.replace.indicator

Metric Details

Metric Details
Applicable for	Device
SNMP OID	1.3.6.1.4.1.318.1.1.1.2.2.4.0
Expression	NULL
Description	Indicates whether the UPS batteries need replacing. Possible values are 1 - No Battery Needs Replacing, 2 - Battery Needs Replacing. [OID: 1.3.6.1.4.1.318.1.1.1.2.2.4]
Category	SNMP monitors
Collector Type	Gateway
Monitor Name	APC UPS Monitors
Unit

Possible Inputs

Possible Inputs
Metric	Input Value	Range of Values
Frequency	5	1 – 1440 (mins)
Filter
Warning Operator
Warning Threshold
Warning Repeat Count
Critical Operator	EQUAL	Ends with, ==, !=, >=, <=, >, <, In Range, Out of range, Equals, Not equals, Equals Ignore Case, Not Equals Ignore Case, Contains, Not contains, Regex match, Regex no match, In string list, Not in string list, In List, Not in list, Starts with
Critical Threshold	2	[{"1":"noBatteryNeedsReplacing"},{"2":"batteryNeedsReplacing"}]
Critical Repeat Count	1	1-12
Alert	Yes	Yes/No
Graph (Yes/No)	No	Yes/No

Sample Output

No graph

ups.battery.runtime.remaining

Metric Details

Metric Details
Applicable for	Device
SNMP OID	1.3.6.1.4.1.318.1.1.1.2.2.3.0
Expression	upsAdvBatteryRunTimeRemaining/100
Description	Indicates the UPS battery run time remaining before battery exhaustion. [OID: 1.3.6.1.4.1.318.1.1.1.2.2.3.0]
Category	SNMP monitors
Collector Type	Gateway
Monitor Name	APC UPS Monitors
Unit	s

Possible Inputs

Possible Inputs
Metric	Input Value	Range of Values
Frequency	5	1 – 1440 (mins)
Filter
Warning Operator
Warning Threshold
Warning Repeat Count
Critical Operator	LESS_THAN	Ends with, ==, !=, >=, <=, >, <, In Range, Out of range, Equals, Not equals, Equals Ignore Case, Not Equals Ignore Case, Contains, Not contains, Regex match, Regex no match, In string list, Not in string list, In List, Not in list, Starts with
Critical Threshold	1800	0 - 4294967295
Critical Repeat Count	1	1-12
Alert	Yes	Yes/No
Graph (Yes/No)	Yes	Yes/No

Sample Output

ups.battery.temperature

Metric Details

Metric Details
Applicable for	Device
SNMP OID	1.3.6.1.4.1.318.1.1.1.2.2.2.0
Expression	NULL
Description	The current internal UPS temperature expressed in Celsius. [OID: 1.3.6.1.4.1.318.1.1.1.2.2.2.0]
Category	SNMP monitors
Collector Type	Gateway
Monitor Name	APC UPS Monitors
Unit	Celsius

Possible Inputs

Possible Inputs
Metric	Input Value	Range of Values
Frequency	5	1 – 1440 (mins)
Filter
Warning Operator	GREATER_THAN	Ends with, ==, !=, >=, <=, >, <, In Range, Out of range, Equals, Not equals, Equals Ignore Case, Not Equals Ignore Case, Contains, Not contains, Regex match, Regex no match, In string list, Not in string list, In List, Not in list, Starts with
Warning Threshold	60	0 - 4294967295
Warning Repeat Count	1	1-12
Critical Operator	GREATER_THAN	Ends with, ==, !=, >=, <=, >, <, In Range, Out of range, Equals, Not equals, Equals Ignore Case, Not Equals Ignore Case, Contains, Not contains, Regex match, Regex no match, In string list, Not in string list, In List, Not in list, Starts with
Critical Threshold	70	0 - 4294967295
Critical Repeat Count	1	1-12
Alert	Yes	Yes/No
Graph (Yes/No)	Yes	Yes/No

Sample Output

ups.inputline.voltage

Metric Details

Metric Details
Applicable for	Device
SNMP OID	1.3.6.1.4.1.318.1.1.1.3.2.1.0
Expression	NULL
Description	Indicates the current utility line voltage in VAC. [OID: 1.3.6.1.4.1.318.1.1.1.3.2.1.0]
Category	SNMP monitors
Collector Type	Gateway
Monitor Name	APC UPS Monitors
Unit	v

Possible Inputs

Possible Inputs
Metric	Input Value	Range of Values
Frequency	5	1 – 1440 (mins)
Filter
Warning Operator
Warning Threshold
Warning Repeat Count
Critical Operator
Critical Threshold
Critical Repeat Count
Alert	No	Yes/No
Graph (Yes/No)	Yes	Yes/No

Sample Output

ups.frequency.output

Metric Details

Metric Details
Applicable for	Device
SNMP OID	1.3.6.1.4.1.318.1.1.1.4.2.2.0
Expression	NULL
Description	Indicates the current output frequency of the UPS system in Hz. [OID: 1.3.6.1.4.1.318.1.1.1.4.2.2]
Category	SNMP monitors
Collector Type	Gateway
Monitor Name	APC UPS Monitors
Unit	Hz

Possible Inputs

Possible Inputs
Metric	Input Value	Range of Values
Frequency	5	1 – 1440 (mins)
Filter
Warning Operator
Warning Threshold
Warning Repeat Count
Critical Operator
Critical Threshold
Critical Repeat Count
Alert	No	Yes/No
Graph (Yes/No)	Yes	Yes/No

Sample Output

ups.load.output

Metric Details

Metric Details
Applicable for	Device
SNMP OID	1.3.6.1.4.1.318.1.1.1.4.2.3.0
Expression	NULL
Description	Indicates the current UPS load expressed in percent of rated capacity. [OID: 1.3.6.1.4.1.318.1.1.1.4.2.3 ]
Category	SNMP monitors
Collector Type	Gateway
Monitor Name	APC UPS Monitors
Unit	%

Possible Inputs

Possible Inputs
Metric	Input Value	Range of Values
Frequency	5	1 – 1440 (mins)
Filter
Warning Operator
Warning Threshold
Warning Repeat Count
Critical Operator
Critical Threshold
Critical Repeat Count
Alert	No	Yes/No
Graph (Yes/No)	Yes	Yes/No

Sample Output

ups.status.output

Metric Details

Metric Details
Applicable for	Device
SNMP OID	1.3.6.1.4.1.318.1.1.1.4.1.1.0
Expression	NULL
Description	Indicates that the UPS is not supplying line voltage to any attached devices. Possible status values are 1 -Unknown, 2 - On Line, 3 - On Battery, 4 - On Smart boost, 5 - Timed Sleeping, 6 - Software Bypass, 7 - Off, 8 - Rebooting, 9 - Switched Bypass, 10-hardwareFailureBypass 11-SleepingUntilPowerReturn 12-onSmartTrim, 13-ecoMode, 14-hotStandby, 15-onBatteryTest. [OID: 1.3.6.1.4.1.318.1.1.1.4.1.1]
Category	SNMP monitors
Collector Type	Gateway
Monitor Name	APC UPS Monitors
Unit

Possible Inputs

Possible Inputs
Metric	Input Value	Range of Values
Frequency	5	1 – 1440 (mins)
Filter
Warning Operator
Warning Threshold
Warning Repeat Count
Critical Operator
Critical Threshold
Critical Repeat Count
Alert	No	Yes/No
Graph (Yes/No)	Yes	Yes/No

Sample Output

ups.voltage.output

Metric Details

Metric Details
Applicable for	Device
SNMP OID	1.3.6.1.4.1.318.1.1.1.4.2.1.0
Expression	NULL
Description	Indicates the output voltage of the UPS system in VAC. [OID: 1.3.6.1.4.1.318.1.1.1.4.2.1 ]
Category	SNMP monitors
Collector Type	Gateway
Monitor Name	APC UPS Monitors
Unit	v

Possible Inputs

Possible Inputs
Metric	Input Value	Range of Values
Frequency	5	1 – 1440 (mins)
Filter
Warning Operator
Warning Threshold
Warning Repeat Count
Critical Operator
Critical Threshold
Critical Repeat Count
Alert	No	Yes/No
Graph (Yes/No)	Yes	Yes/No

Sample Output

ups.battery.time

Metric Details

Metric Details
Applicable for	Device
SNMP OID	1.3.6.1.4.1.318.1.1.1.2.1.2.0
Expression	upsBasicBatteryTimeOnBattery/100
Description	The elapsed time since the UPS has switched to battery power. Alert is generated when the time on battery is greater than 0 seconds. [OID: 1.3.6.1.4.1.318.1.1.1.2.1.2 ]
Category	SNMP monitors
Collector Type	Gateway
Monitor Name	APC UPS Monitors
Unit	s

Possible Inputs

Possible Inputs
Metric	Input Value	Range of Values
Frequency	5	1 – 1440 (mins)
Filter
Warning Operator
Warning Threshold
Warning Repeat Count
Critical Operator	GREATER_THAN	Ends with, ==, !=, >=, <=, >, <, In Range, Out of range, Equals, Not equals, Equals Ignore Case, Not Equals Ignore Case, Contains, Not contains, Regex match, Regex no match, In string list, Not in string list, In List, Not in list, Starts with
Critical Threshold	1	0 - 4294967295
Critical Repeat Count	1	1-12
Alert	Yes	Yes/No
Graph (Yes/No)	Yes	Yes/No

Sample Output

APC UPS Status Check - G2

Description

Prerequisites

Metric Parameters

Metrics

ups.battery.status

UPS Battery Status

ups.no.of.batter.packs.bad

UPS No. of Bad Battery Packets

ups.battery.capacity

UPS Battery Capacity

ups.battery.replace.indicator

ups.battery.runtime.remaining

UPS Battery Runtime Remaining

ups.battery.temperature

UPS Battery Temperature

ups.inputline.voltage

UPS Input Line Voltage

ups.frequency.output

UPS Output Frequency

ups.load.output

UPS Output Load

ups.status.output

UPS Output Status

ups.voltage.output

UPS Voltage Output

ups.battery.time

UPS Battery Time