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, such as:
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 (Dominion PX, PM, RPC)
47
48       raritan-px2
49           Various Raritan PDUs (Dominion PX2)
50
51       baytech
52           Various BayTech PDUs
53
54       cpqpower
55           HP/Compaq AF401A management card, perhaps others
56
57       cyberpower
58           Cyberpower RMCARD201. Should also support RMCARD100 (net version),
59           RMCARD202 and RMCARD301
60
61       huawei
62           Huawei UPS5000-E, perhaps others
63
64       tripplite
65           TrippLite UPSes; at this time this is the IETF MIB mapping with
66           just the Tripplite entry point OID to verify the device vendor, and
67           a real hardware-specific configuration will be added in the future
68           development.
69
70       For a complete and up-to-date listing, you can query the driver by
71       passing the mibs=--list argument (see below).
72

EXTRA ARGUMENTS

74       This driver supports the following optional settings in the
75       ups.conf(5):
76
77       port=hostname[:port]
78           Set SNMP hostname, or IP address, and port number of the peer SNMP
79           agent. There is no default for the hostname, but the default port
80           is 161.
81
82       mibs=--list
83           A special option which allows to list the currently known
84           MIB-to-NUT mappings and exit the driver binary, intended for
85           command-line usage like this:
86
87           $ snmp-ups -a snmp-test -x mibs=--list
88
89       mibs=name
90           Set MIB compliance (default=auto, allowed entries: refer to
91           SUPPORTED HARDWARE above).
92
93           With "auto", the driver will try a select set of SNMP objects until
94           it finds one that the device responds to.
95
96           Note that since NUT 2.6.2, snmp-ups has a new method that uses
97           sysObjectID (which is a pointer to the preferred MIB of the device)
98           to detect supported devices. This renders void the requirement to
99           use the "mibs" option.
100
101       community=name
102           Set community name (default = public). Note that a RW community
103           name is required to change UPS settings and send commands (as for a
104           powerdown).
105
106       snmp_version=version
107           Set SNMP version (default = v1, allowed: v2c, v3)
108
109       snmp_retries=retries
110           Specifies the number of Net-SNMP retries to be used in the requests
111           (default=5)
112
113       snmp_timeout=timeout
114           Specifies the Net-SNMP timeout in seconds between retries
115           (default=1)
116
117       symmetrathreephase
118           Enable APCC three phase Symmetra quirks (use on APCC three phase
119           Symmetras): Convert from three phase line-to-line voltage to
120           line-to-neutral voltage (default: not enabled)
121
122       pollfreq=num
123           Set polling interval for full updates, in seconds, to reduce SNMP
124           network traffic relative to the quick updates performed every
125           "pollinterval" (the latter option is described in ups.conf(5)). The
126           default value is 30 (in seconds).
127
128       notransferoids
129           Disable the monitoring of the low and high voltage transfer OIDs in
130           the hardware. This will remove input.transfer.low and
131           input.transfer.high from the list of variables. This should only be
132           used on APCC Symmetra equipment which has strangeness in the
133           three-phase power reporting.
134
135       secLevel=value
136           Set the securityLevel used for SNMPv3 messages
137           (default=noAuthNoPriv, allowed: authNoPriv,authPriv)
138
139       secName=value
140           Set the securityName used for authenticated SNMPv3 messages (no
141           default)
142
143       authPassword=value
144           Set the authentication pass phrase used for authenticated SNMPv3
145           messages (no default)
146
147       privPassword=value
148           Set the privacy pass phrase used for encrypted SNMPv3 messages (no
149           default)
150
151       authProtocol=value
152           Set the authentication protocol (MD5, SHA, SHA256, SHA384 or
153           SHA512) used for authenticated SNMPv3 messages (default=MD5). Note
154           that the exact protocol list depends on Net-SNMP library
155           capabilities; check help of the snmp-ups binary program for the
156           run-time supported list.
157
158       privProtocol=value
159           Set the privacy protocol (DES, AES, AES192 or AES256) used for
160           encrypted SNMPv3 messages (default=DES). Note that the exact
161           protocol list depends on Net-SNMP library capabilities; check help
162           of the snmp-ups binary program for the run-time supported list.
163

REQUIREMENTS

165       You will need to install the Net-SNMP package from
166       http://www.net-snmp.org/ before building this driver.
167
168       SNMP v3 also requires OpenSSL support from http://www.openssl.org.
169

LIMITATIONS

171   Shutdown
172       The shutdown sequence should be tested before relying on NUT to send a
173       shutdown command to the UPS. The problem is that the host network stack
174       may have been torn down by the time the driver is invoked to send the
175       shutdown command. The driver attempts to send shutdown.return,
176       shutdown.reboot, and load.off.delay commands to the UPS in sequence,
177       stopping after the first supported command.
178

INSTALLATION

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

EXAMPLES

185       The hostname of the UPS is specified with the "port" value in ups.conf,
186       and may include a non-standard (161) remote peer port:
187
188                   [snmpv1]
189                           driver = snmp-ups
190                           port = snmp-ups.example.com
191                           community = public
192                           snmp_version = v1
193                           pollfreq = 15
194                           desc = "Example SNMP v1 device"
195
196                   [snmpv3]
197                           driver = snmp-ups
198                           port = 166.99.224.132:170
199                           snmp_version = v3
200                           secLevel = authPriv
201                           secName = mysecurityname
202                           authPassword = myauthenticationpassphrase
203                           privPassword = myprivatepassphrase
204                           desc = "Example SNMP v3 device, with the highest security level"
205

AUTHORS

207       •   Arnaud Quette
208
209       •   Dmitry Frolov
210
211       •   Jim Klimov
212