← Back to branch summary

~ubuntu-branches/ubuntu/saucy/nut/saucy

« back to all changes in this revision

Viewing changes to man/snmp-ups.8

  • Committer: Bazaar Package Importer
  • Author(s): Arnaud Quette
  • Date: 2004-05-28 13:10:01 UTC
  • mto: (16.1.1 squeeze)
  • mto: This revision was merged to the branch mainline in revision 3.
  • Revision ID: james.westby@ubuntu.com-20040528131001-yj2m9qcez4ya2w14
Tags: upstream-1.4.2
Import upstream version 1.4.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/snmp-ups.8
 
1
.TH snmp-ups 8 "Sat Mar 15 2003" "" "Network UPS Tools (NUT)"
 
2
.SH NAME
 
3
snmp-ups \- Multi-MIB Driver for SNMP UPS equipment
 
4
.SH NOTE
 
5
This man page only documents the hardware-specific features of the
 
6
snmp-ups driver.  For information about the core driver, see
 
7
\fBnutupsdrv\fR(8).
 
8
 
 
9
.SH SUPPORTED HARDWARE
 
10
The new snmp-ups driver supports a wide range of devices by loading various MIBS:
 
11
.IP "ietf:"
 
12
UPS that is RFC 1628 (UPS MIB) compliant, ie MGE UPS SYSTEMS, Liebert, perhaps others (default)
 
13
.IP "mge:"
 
14
MGE UPS SYSTEMS devices with SNMP cards (ref 66062, 66045, 66074 and 66244)
 
15
.IP "apcc:"
 
16
APC AP9606 APC Web/SNMP management card, perhaps others
 
17
 
 
18
.SH EXTRA ARGUMENTS
 
19
 
 
20
This driver supports the following optional settings in the
 
21
\fBups.conf\fR(5):
 
22
 
 
23
.IP "mibs=\fIname\fR"
 
24
Set MIB compliance (default=ietf, allowed mge,apcc)
 
25
 
 
26
.IP "community=\fIname\fR"
 
27
Set community name (default = public).
 
28
Note that you require a RW community name to perform UPS settings (as for a powerdown).
 
29
 
 
30
.IP "snmp_version=\fIversion\fR"
 
31
Set SNMP version (default = v1, the other allowed value is v2c)
 
32
 
 
33
.IP "pollfreq=\fIvalue\fR"
 
34
Set polling frequency in seconds, to reduce network flow (default=30)
 
35
 
 
36
.SH REQUIREMENTS
 
37
You will need to install the Net-SNMP package from 
 
38
http://www.net-snmp.org/ before building this driver.
 
39
 
 
40
.SH EXPERIMENTAL DRIVER
 
41
This driver has been tagged experimental, even if it has been reported
 
42
to be stable. Thus it is not suitable for production systems and it is
 
43
not built by default. This is mainly due to the fact that there is still
 
44
no proper upsdrv_shutdown() function implemented !
 
45
 
 
46
.SH INSTALLATION
 
47
This driver is not built by default.  You can build it by using
 
48
"configure --with-drivers=snmp-ups" before calling make.
 
49
 
 
50
.SH IMPLEMENTATION
 
51
The hostname of the UPS is specified with the "port" value in
 
52
\fBups.conf\fR, i.e.:
 
53
 
 
54
.nf
 
55
        [snmp]
 
56
                driver = snmp-ups
 
57
                port = snmp-ups.example.com
 
58
                community = public
 
59
                snmp_version = v1
 
60
                mibs = ietf
 
61
                pollfreq = 15
 
62
.fi
 
63
 
 
64
.SH AUTHORS
 
65
.SS Sponsored by MGE UPS SYSTEMS <http://www.mgeups.com/opensource/>
 
66
Dmitry Frolov, Hans Ekkehard Plesser, Arnaud Quette
 
67
 
 
68
.SH SEE ALSO
 
69
 
 
70
.SS The core driver:
 
71
\fBnutupsdrv\fR(8)
 
72
 
 
73
.SS NUT SNMP Protocols Library
 
74
Available at: http://random.networkupstools.org/protocols/snmp/
 
75
 
 
76
.SS Internet resources:
 
77
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/