205 lines
6.2 KiB
Groff
205 lines
6.2 KiB
Groff
'\" t
|
|
.\" Title: snmp-ups
|
|
.\" Author: [see the "AUTHORS" section]
|
|
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
|
|
.\" Date: 05/31/2011
|
|
.\" Manual: NUT Manual
|
|
.\" Source: Network UPS Tools
|
|
.\" Language: English
|
|
.\"
|
|
.TH "SNMP\-UPS" "8" "05/31/2011" "Network UPS Tools" "NUT Manual"
|
|
.\" -----------------------------------------------------------------
|
|
.\" * Define some portability stuff
|
|
.\" -----------------------------------------------------------------
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.\" http://bugs.debian.org/507673
|
|
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\" -----------------------------------------------------------------
|
|
.\" * set default formatting
|
|
.\" -----------------------------------------------------------------
|
|
.\" disable hyphenation
|
|
.nh
|
|
.\" disable justification (adjust text to left margin only)
|
|
.ad l
|
|
.\" -----------------------------------------------------------------
|
|
.\" * MAIN CONTENT STARTS HERE *
|
|
.\" -----------------------------------------------------------------
|
|
.SH "NAME"
|
|
snmp-ups \- Multi\-MIB Driver for SNMP UPS equipment
|
|
.SH "NOTE"
|
|
.sp
|
|
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"
|
|
.sp
|
|
The snmp\-ups driver automatically detects and supports a wide range of devices by loading various MIBS: \fBietf\fR:: UPS that is RFC 1628 (UPS MIB) compliant, e\&.g\&. MGE UPS SYSTEMS, Liebert, perhaps others (default)
|
|
.PP
|
|
\fBmge\fR
|
|
.RS 4
|
|
MGE UPS SYSTEMS and MGE Office Protection Systems devices with SNMP cards (ref 66062, 66045, 66074 and 66244)
|
|
.RE
|
|
.PP
|
|
\fBapcc\fR
|
|
.RS 4
|
|
APC AP9606 APC Web/SNMP management card, perhaps others
|
|
.RE
|
|
.PP
|
|
\fBnetvision\fR
|
|
.RS 4
|
|
Socomec Sicon UPS with Netvision Web/SNMP management card/external box
|
|
.RE
|
|
.PP
|
|
\fBpw\fR
|
|
.RS 4
|
|
Powerware devices with ConnectUPS SNMP cards
|
|
.RE
|
|
.PP
|
|
\fBaphel_genesisII\fR
|
|
.RS 4
|
|
Eaton Powerware ePDU Monitored
|
|
.RE
|
|
.PP
|
|
\fBaphel_revelation\fR
|
|
.RS 4
|
|
Eaton Powerware ePDU Managed
|
|
.RE
|
|
.PP
|
|
\fBraritan\fR
|
|
.RS 4
|
|
Various Raritan PDUs
|
|
.RE
|
|
.PP
|
|
\fBbaytech\fR
|
|
.RS 4
|
|
Various BayTech PDUs
|
|
.RE
|
|
.PP
|
|
\fBcpqpower\fR
|
|
.RS 4
|
|
HP/Compaq AF401A management card, perhaps others
|
|
.RE
|
|
.SH "EXTRA ARGUMENTS"
|
|
.sp
|
|
This driver supports the following optional settings in the \fBups.conf\fR(5):
|
|
.PP
|
|
\fBmibs\fR=\fIname\fR
|
|
.RS 4
|
|
Set MIB compliance (default=auto, allowed entries: refer to the above SUPPORTED HARDWARE)\&. With "auto", the driver will try a select set of SNMP objects until it finds one that the device responds to\&.
|
|
.RE
|
|
.PP
|
|
\fBcommunity\fR=\fIname\fR
|
|
.RS 4
|
|
Set community name (default = public)\&. Note that you require a RW community name to change UPS settings (as for a powerdown)\&.
|
|
.RE
|
|
.PP
|
|
\fBsnmp_version\fR=\fIversion\fR
|
|
.RS 4
|
|
Set SNMP version (default = v1, the other allowed value is v2c)
|
|
.RE
|
|
.PP
|
|
\fBpollfreq\fR=\fIvalue\fR
|
|
.RS 4
|
|
Set polling frequency in seconds, to reduce network flow (default=30)
|
|
.RE
|
|
.PP
|
|
\fBnotransferoids\fR
|
|
.RS 4
|
|
Disable the monitoring of the low and high voltage transfer OIDs in the hardware\&. This will remove input\&.transfer\&.low and input\&.transfer\&.high from the list of variables\&. This should only be used on APCC Symmetra equipment which has strangeness in the three\-phase power reporting\&.
|
|
.RE
|
|
.PP
|
|
\fBsecLevel\fR=\fIvalue\fR
|
|
.RS 4
|
|
Set the securityLevel used for SNMPv3 messages (default=noAuthNoPriv, allowed: authNoPriv,authPriv)
|
|
.RE
|
|
.PP
|
|
\fBsecName\fR=\fIvalue\fR
|
|
.RS 4
|
|
Set the securityName used for authenticated SNMPv3 messages (no default)
|
|
.RE
|
|
.PP
|
|
\fBauthPassword\fR=\fIvalue\fR
|
|
.RS 4
|
|
Set the authentication pass phrase used for authenticated SNMPv3 messages (no default)
|
|
.RE
|
|
.PP
|
|
\fBprivPassword\fR=\fIvalue\fR
|
|
.RS 4
|
|
Set the privacy pass phrase used for encrypted SNMPv3 messages (no default)
|
|
.RE
|
|
.PP
|
|
\fBauthProtocol\fR=\fIvalue\fR
|
|
.RS 4
|
|
Set the authentication protocol (MD5 or SHA) used for authenticated SNMPv3 messages (default=MD5)
|
|
.RE
|
|
.PP
|
|
\fBprivProtocol\fR=\fIvalue\fR
|
|
.RS 4
|
|
Set the privacy protocol (DES or AES) used for encrypted SNMPv3 messages (default=DES)
|
|
.RE
|
|
.SH "REQUIREMENTS"
|
|
.sp
|
|
You will need to install the Net\-SNMP package from http://www\&.net\-snmp\&.org/ before building this driver\&.
|
|
.sp
|
|
SNMP v3 also requires OpenSSL support from http://www\&.openssl\&.org\&.
|
|
.SH "LIMITATION"
|
|
.SS "Shutdown"
|
|
.sp
|
|
This driver does not provide a proper upsdrv_shutdown() function\&. There probably never will be one, since at the time this script should run (near the end of the system halt script), there will be no network capabilities anymore\&. Probably the only way to shutdown an SNMP UPS is by sending it a shutdown with delay command through \fBupscmd\fR(8) and hope for the best that the system will have finished shutting down before the power is cut\&.
|
|
.SH "INSTALLATION"
|
|
.sp
|
|
This driver is only built if the Net\-SNMP development files are present on the system\&. You can also force it to be built by using "configure \-\-with\-snmp=yes" before calling make\&.
|
|
.SH "IMPLEMENTATION"
|
|
.sp
|
|
The hostname of the UPS is specified with the "port" value in ups\&.conf, i\&.e\&.:
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
[snmpv1]
|
|
driver = snmp\-ups
|
|
port = snmp\-ups\&.example\&.com
|
|
community = public
|
|
snmp_version = v1
|
|
mibs = ietf
|
|
pollfreq = 15
|
|
desc = "Example SNMP v1 device"
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
[snmpv3]
|
|
driver = snmp\-ups
|
|
port = 166\&.99\&.224\&.132
|
|
mibs = mge
|
|
secLevel = authPriv
|
|
secName = mysecurityname
|
|
authPassword = myauthenticationpassphrase
|
|
privPassword = myprivatepassphrase
|
|
desc = "Example SNMP v3 device, with the highest security level"
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.SH "AUTHORS"
|
|
.sp
|
|
Arnaud Quette, Dmitry Frolov
|
|
.sp
|
|
Sponsored by Eaton http://www\&.eaton\&.com and originally by MGE UPS SYSTEMS http://www\&.mgeups\&.com/
|
|
.SH "SEE ALSO"
|
|
.SS "The core driver:"
|
|
.sp
|
|
\fBnutupsdrv\fR(8)
|
|
.SS "NUT SNMP Protocols Library"
|
|
.sp
|
|
Available at: http://www\&.networkupstools\&.org/protocols/snmp/
|
|
.SS "Internet resources:"
|
|
.sp
|
|
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/
|