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:
16
17       ietf
18           UPS that is RFC 1628 (UPS MIB) compliant, e.g. MGE UPS SYSTEMS,
19           Liebert, perhaps others (default)
20
21       mge
22           MGE UPS SYSTEMS and MGE Office Protection Systems devices with SNMP
23           cards (ref 66062, 66045, 66074 and 66244)
24
25       apcc
26           APC AP9605, AP9606, AP9617, and AP9618 APC network management
27           cards, as well as any others supporting the APC POWERNET MIB
28
29       netvision
30           Socomec Sicon UPS with Netvision Web/SNMP management card/external
31           box
32
33       pw
34           Powerware devices with ConnectUPS SNMP cards
35
36       pxgx_ups
37           Eaton devices with Power Xpert Gateway UPS Card
38
39       aphel_genesisII
40           Eaton Powerware ePDU Monitored
41
42       aphel_revelation
43           Eaton Powerware ePDU Managed
44
45       raritan
46           Various Raritan PDUs
47
48       baytech
49           Various BayTech PDUs
50
51       cpqpower
52           HP/Compaq AF401A management card, perhaps others
53
54       cyberpower
55           Cyberpower RMCARD201. Should also support RMCARD100 (net version),
56           RMCARD202 and RMCARD301
57
58       huawei
59           Huawei UPS5000-E, perhaps others
60

EXTRA ARGUMENTS

62       This driver supports the following optional settings in the
63       ups.conf(5):
64
65       mibs=name
66           Set MIB compliance (default=auto, allowed entries: refer to
67           SUPPORTED HARDWARE above). With "auto", the driver will try a
68           select set of SNMP objects until it finds one that the device
69           responds to. Note that since NUT 2.6.2, snmp-ups has a new method
70           that uses sysObjectID (which is a pointer to the prefered MIB of
71           the device) to detect supported devices. This renders void the use
72           of "mibs" option.
73
74       community=name
75           Set community name (default = public). Note that a RW community
76           name is required to change UPS settings (as for a powerdown).
77
78       snmp_version=version
79           Set SNMP version (default = v1, allowed: v2c, v3)
80
81       snmp_retries=retries
82           Specifies the number of Net-SNMP retries to be used in the requests
83           (default=5)
84
85       snmp_timeout=timeout
86           Specifies the Net-SNMP timeout in seconds between retries
87           (default=1)
88
89       pollfreq=value
90           Set polling frequency in seconds, to reduce network flow
91           (default=30)
92
93       notransferoids
94           Disable the monitoring of the low and high voltage transfer OIDs in
95           the hardware. This will remove input.transfer.low and
96           input.transfer.high from the list of variables. This should only be
97           used on APCC Symmetra equipment which has strangeness in the
98           three-phase power reporting.
99
100       secLevel=value
101           Set the securityLevel used for SNMPv3 messages
102           (default=noAuthNoPriv, allowed: authNoPriv,authPriv)
103
104       secName=value
105           Set the securityName used for authenticated SNMPv3 messages (no
106           default)
107
108       authPassword=value
109           Set the authentication pass phrase used for authenticated SNMPv3
110           messages (no default)
111
112       privPassword=value
113           Set the privacy pass phrase used for encrypted SNMPv3 messages (no
114           default)
115
116       authProtocol=value
117           Set the authentication protocol (MD5 or SHA) used for authenticated
118           SNMPv3 messages (default=MD5)
119
120       privProtocol=value
121           Set the privacy protocol (DES or AES) used for encrypted SNMPv3
122           messages (default=DES)
123

REQUIREMENTS

125       You will need to install the Net-SNMP package from
126       http://www.net-snmp.org/ before building this driver.
127
128       SNMP v3 also requires OpenSSL support from http://www.openssl.org.
129

LIMITATIONS

131   Shutdown
132       The shutdown sequence should be tested before relying on NUT to send a
133       shutdown command to the UPS. The problem is that the host network stack
134       may have been torn down by the time the driver is invoked to send the
135       shutdown command. The driver attempts to send shutdown.return,
136       shutdown.reboot, and load.off.delay commands to the UPS in sequence,
137       stopping after the first supported command.
138

INSTALLATION

140       This driver is only built if the Net-SNMP development files are present
141       at configuration time. You can also force it to be built by using
142       configure --with-snmp=yes before calling make.
143

EXAMPLES

145       The hostname of the UPS is specified with the "port" value in ups.conf:
146
147           [snmpv1]
148                   driver = snmp-ups
149                   port = snmp-ups.example.com
150                   community = public
151                   snmp_version = v1
152                   pollfreq = 15
153                   desc = "Example SNMP v1 device"
154
155           [snmpv3]
156                   driver = snmp-ups
157                   port = 166.99.224.132
158                   snmp_version = v3
159                   secLevel = authPriv
160                   secName = mysecurityname
161                   authPassword = myauthenticationpassphrase
162                   privPassword = myprivatepassphrase
163                   desc = "Example SNMP v3 device, with the highest security level"
164

AUTHORS

166       Arnaud Quette, Dmitry Frolov
167