2005-11-08
Jason Schoonover

APC Smart-UPS Unnoc plugin

	1. Introduction
	2. Configuration
	3. Display


This plugin is designed to be used with an APC Smart-UPS only, it has
support built in for an external temperature/humidity monitor attached.
NOTE: I've not tested it against anything else except a Smart-UPS.

I currently have 3 SU 2200 RM's with Web/SNMP cards in them, so that is
the hardware that I have tested it against.  Many more MIB's were added
in unnoc 1.0.6, so I have never tested it on anything except a Smart-UPS

MRTG is no longer required for APC's!  RRD is now integrated completely
with the APC's.  It currently monitors and graphs:

	- Input Voltage / Output Voltage
	- Internal Temperature
	- Probe Temperature
	- Load Watt Percentage

	And will also display something similar to this:

	Status
	Model:				SMART-UPS 2200 RM
	Internal Temperature: 		70.6° F
	Battery Status: 		Normal
	Battery Capacity 		100%
	Output Status 	  		Online
	Last transfer to battery 	None
	Time Remaining 	  		0:12:00
	Current Input Voltage:		117 VAC (min: 117, max: 118)
	Current Output Voltage: 	117 VAC
	Current Load:			79% 

	Probe Status:
	Current Temperature: 69 deg F

	[ probe temp graph ]

	Current Load

	[ load graph ]

	....

So far, the in/out voltage, internal temperature, probe temperature and
load percentage is graphed.  To see the Internal Temperature or the
Voltage graph, click on the labels in the above display (they are not
clearly marked as links right now, they kind of all flow together).

2. Configuration

The way to configure an apc is with the 'host' directive in the
unnoc.conf file.  See the README.hosts file for proper syntax, here is
an example config:

	host {
		hostname = apc-1
		community = public
		type = apc
	}

You can specify a different interval with the 'interval' directive.
Updates are very cheap and fast (depending on how many you have and what
the latency is between your unnoc server and the APC itself).  I run
them at an interval = 1.

If you would like to check the up/down status via 'ping' then specify
the 'updown' directive as 'ping'.  The default value of 'updown' is
'snmp' -- this means that if it does not get a response via snmp, then it
will consider it down, or will wait until 'fuzz' attempts before it
considers it down (if fuzz is defined).

I have not enabled humidity monitoring because for some strange reason 
either they don't work on my sensors, or my data center is below 10% 
humidity.  Either way I have no use for it and could not even test it 
out.  So if yours DOES work out there, please drop me a line and I'll 
do my best to get it to work

A new option, added to 1.0.8 is the option to receive on battery alerts.
Some UPS's to not have the capability of sending out alerts when power
fails (or there are simply too many to manage this), so Unnoc will alert
for you.  The option is

	on_battery_alerts = 1

The default is to not alert on battery.


3.  Display

To display a link on the main index page, use the print_href functions,
the valid argument for print_href_type is 'apc', like this:

	print_href_type ('apc');


vim:tw=72:wm=1