SNMP-UPS(8) | NUT Manual | SNMP-UPS(8) |
NAME
snmp-ups - Multi-MIB Driver for SNMP UPS equipment
SYNOPSIS
snmp-ups -h
snmp-ups -a UPS_NAME [OPTIONS]
Note
This man page only documents the hardware-specific features of the snmp-ups driver. For information about the core driver, see nutupsdrv(8).
SUPPORTED HARDWARE
The snmp-ups driver automatically detects and supports a wide range of devices by loading various MIBS, such as:
ietf
mge
apcc
netvision
eaton_pw_nm2
eaton_pxg_ups
aphel_genesisII
aphel_revelation
raritan
raritan-px2
baytech
cpqpower
cyberpower
huawei
tripplite
For a complete and up-to-date listing, you can query the driver by passing the mibs=--list argument (see below).
EXTRA ARGUMENTS
This driver supports the following optional settings in the ups.conf(5):
port=hostname[:port]
mibs=--list
$ snmp-ups -a snmp-test -x mibs=--list
mibs=name
With "auto", the driver will try a select set of SNMP objects until it finds one that the device responds to.
Note that since NUT 2.6.2, snmp-ups has a new method that uses sysObjectID (which is a pointer to the preferred MIB of the device) to detect supported devices. This renders void the requirement to use the "mibs" option.
community=name
snmp_version=version
snmp_retries=retries
snmp_timeout=timeout
symmetrathreephase
pollfreq=num
notransferoids
secLevel=value
secName=value
authPassword=value
privPassword=value
authProtocol=value
privProtocol=value
REQUIREMENTS
You will need to install the Net-SNMP package from http://www.net-snmp.org/ before building this driver.
SNMP v3 also requires OpenSSL support from http://www.openssl.org.
LIMITATIONS
Shutdown
The shutdown sequence should be tested before relying on NUT to send a shutdown command to the UPS. The problem is that the host network stack may have been torn down by the time the driver is invoked to send the shutdown command. The driver attempts to send shutdown.return, shutdown.reboot, and load.off.delay commands to the UPS in sequence, stopping after the first supported command.
INSTALLATION
This driver is only built if the Net-SNMP development files are present at configuration time. You can also force it to be built by using configure --with-snmp=yes before calling make.
EXAMPLES
The hostname of the UPS is specified with the "port" value in ups.conf, and may include a non-standard (161) remote peer port:
[snmpv1] driver = snmp-ups port = snmp-ups.example.com community = public snmp_version = v1 pollfreq = 15 desc = "Example SNMP v1 device" [snmpv3] driver = snmp-ups port = 166.99.224.132:170 snmp_version = v3 secLevel = authPriv secName = mysecurityname authPassword = myauthenticationpassphrase privPassword = myprivatepassphrase desc = "Example SNMP v3 device, with the highest security level"
AUTHORS
SEE ALSO
The core driver:
NUT SNMP Protocols Library
Available at: https://www.networkupstools.org/ups-protocols.html#_snmp
Internet resources:
The NUT (Network UPS Tools) home page: https://www.networkupstools.org/
05/20/2024 | Network UPS Tools 2.8.2 |