snmp-ups(8)

1SNMP-UPS(8)                       NUT Manual                       SNMP-UPS(8)
2
3
4

NAME

6       snmp-ups - Multi-MIB Driver for SNMP UPS equipment
7

NOTE

9       This man page only documents the hardware-specific features of the
10       snmp-ups driver. For information about the core driver, see
11       nutupsdrv(8).
12

SUPPORTED HARDWARE

14       The snmp-ups driver automatically detects and supports a wide range of
15       devices by loading various MIBS: ietf:: UPS that is RFC 1628 (UPS MIB)
16       compliant, e.g. MGE UPS SYSTEMS, Liebert, perhaps others (default)
17
18       mge
19           MGE UPS SYSTEMS and MGE Office Protection Systems devices with SNMP
20           cards (ref 66062, 66045, 66074 and 66244)
21
22       apcc
23           APC AP9606 APC Web/SNMP management card, perhaps others
24
25       netvision
26           Socomec Sicon UPS with Netvision Web/SNMP management card/external
27           box
28
29       pw
30           Powerware devices with ConnectUPS SNMP cards
31
32       aphel_genesisII
33           Eaton Powerware ePDU Monitored
34
35       aphel_revelation
36           Eaton Powerware ePDU Managed
37
38       raritan
39           Various Raritan PDUs
40
41       baytech
42           Various BayTech PDUs
43
44       cpqpower
45           HP/Compaq AF401A management card, perhaps others
46

EXTRA ARGUMENTS

48       This driver supports the following optional settings in the
49       ups.conf(5):
50
51       mibs=name
52           Set MIB compliance (default=auto, allowed entries: refer to the
53           above SUPPORTED HARDWARE). With "auto", the driver will try a
54           select set of SNMP objects until it finds one that the device
55           responds to.
56
57       community=name
58           Set community name (default = public). Note that you require a RW
59           community name to change UPS settings (as for a powerdown).
60
61       snmp_version=version
62           Set SNMP version (default = v1, the other allowed value is v2c)
63
64       pollfreq=value
65           Set polling frequency in seconds, to reduce network flow
66           (default=30)
67
68       notransferoids
69           Disable the monitoring of the low and high voltage transfer OIDs in
70           the hardware. This will remove input.transfer.low and
71           input.transfer.high from the list of variables. This should only be
72           used on APCC Symmetra equipment which has strangeness in the
73           three-phase power reporting.
74
75       secLevel=value
76           Set the securityLevel used for SNMPv3 messages
77           (default=noAuthNoPriv, allowed: authNoPriv,authPriv)
78
79       secName=value
80           Set the securityName used for authenticated SNMPv3 messages (no
81           default)
82
83       authPassword=value
84           Set the authentication pass phrase used for authenticated SNMPv3
85           messages (no default)
86
87       privPassword=value
88           Set the privacy pass phrase used for encrypted SNMPv3 messages (no
89           default)
90
91       authProtocol=value
92           Set the authentication protocol (MD5 or SHA) used for authenticated
93           SNMPv3 messages (default=MD5)
94
95       privProtocol=value
96           Set the privacy protocol (DES or AES) used for encrypted SNMPv3
97           messages (default=DES)
98

REQUIREMENTS

100       You will need to install the Net-SNMP package from
101       http://www.net-snmp.org/ before building this driver.
102
103       SNMP v3 also requires OpenSSL support from http://www.openssl.org.
104

LIMITATION

106   Shutdown
107       This driver does not provide a proper upsdrv_shutdown() function. There
108       probably never will be one, since at the time this script should run
109       (near the end of the system halt script), there will be no network
110       capabilities anymore. Probably the only way to shutdown an SNMP UPS is
111       by sending it a shutdown with delay command through upscmd(8) and hope
112       for the best that the system will have finished shutting down before
113       the power is cut.
114

INSTALLATION

116       This driver is only built if the Net-SNMP development files are present
117       on the system. You can also force it to be built by using "configure
118       --with-snmp=yes" before calling make.
119

IMPLEMENTATION

121       The hostname of the UPS is specified with the "port" value in ups.conf,
122       i.e.:
123
124           [snmpv1]
125                   driver = snmp-ups
126                   port = snmp-ups.example.com
127                   community = public
128                   snmp_version = v1
129                   mibs = ietf
130                   pollfreq = 15
131                   desc = "Example SNMP v1 device"
132
133           [snmpv3]
134                   driver = snmp-ups
135                   port = 166.99.224.132
136                   mibs = mge
137                   secLevel = authPriv
138                   secName = mysecurityname
139                   authPassword = myauthenticationpassphrase
140                   privPassword = myprivatepassphrase
141                   desc = "Example SNMP v3 device, with the highest security level"
142

AUTHORS

144       Arnaud Quette, Dmitry Frolov
145
146       Sponsored by Eaton http://www.eaton.com and originally by MGE UPS
147       SYSTEMS http://www.mgeups.com/
148