.TH snmp-ups 8 "Tue Oct 22 2002" "" "Network UPS Tools (NUT)"
.SH NAME
snmp-ups \- Driver for RFC 1628 SNMP UPS equipment
.SH NOTE
This man page only documents the hardware-specific features of the
snmp-ups driver.  For information about the core driver, see
\fBnutupsdrv\fR(8).

.SH SUPPORTED HARDWARE
Any UPS that is RFC 1628 (UPS MIB) compliant.

.SH EXPERIMENTAL DRIVER

This driver has been tagged experimental and is not built by default.

.SH REQUIREMENTS

This driver needs UCD SNMP, aka Net-SNMP installed to compile successfully.
See http://www.net-snmp.org/ for more information.

On Red Hat 7.2, these packages are required:

	ucd-snmp-devel-4.2.3-1, ucd-snmp-4.2.3-1, ucd-snmp-utils-4.2.3-1

You must install SNMP-UPS-MIB.txt in your MIBs directory - typically
/usr/share/snmp/mibs/, but it may vary from system to system.  You can
generate this from chapter 4 of RFC 1628 (see http://www.faqs.org).

.SH EXTRA ARGUMENTS

This driver supports the following optional settings in the
\fBups.conf\fR(5):

.IP "community=\fIname\fR"
Set community name (default = public)

.IP "snmp_version=\fIversion\fR"
Set SNMP version (default = v1, the other allowed value is v2c)

.SH INSTALLATION
This driver is not built by default.  You can build it by using
"configure --with-drivers=snmp-ups" before calling make.

.SH IMPLEMENTATION
The hostname of the UPS is specified with the "port" value in
\fBups.conf\fR, i.e.:

.nf
	[snmp]
		driver = snmp-ups
		port = snmp-ups.example.com
		community = public
		snmp_version = v1
.fi

.SH SUPPORTED VARIABLES

.nf
	INFO_MFR	UPS Manufacturer
	INFO_MODEL	UPS Model
	INFO_FIRMREV	Firmware/Software Version
	INFO_STATUS	OFF, OL, OB, BOOST, TRIM
	INFO_BATTPCT	Battery percentage
	INFO_RUNTIME	Predicted runtime on battery
	INFO_BATTVOLT	Battery Voltage
	INFO_OUTVOLT	Output Voltage
.fi

.SH PLANNED SUPPORT

.nf
	INFO_UTILITY	Input Voltage
	INFO_ACFREQ	AC Frequency
	INFO_UPSTEM	UPS Temperature
	INFO_LOADPCT	Load Percentage
	CMD_?		Not determined
.fi

.SH AUTHORS
Arnaud Quette, Hans Ekkehard Plesser

.SH SEE ALSO

.SS The core driver:
\fBnutupsdrv\fR(8)

.SS Internet resources:
The NUT (Network UPS Tools) home page: http://www.exploits.org/nut/

NUT mailing list archives and information: http://lists.exploits.org/