nutscan_scan_snmp(3) [debian man page]

NUTSCAN_SCAN_SNMP(3)						    NUT Manual						      NUTSCAN_SCAN_SNMP(3)

NAME

       nutscan_scan_snmp - Scan network for SNMP devices.

SYNOPSIS

       #include <nut-scan.h>

       nutscan_device_t * nutscan_scan_snmp(const char * start_ip,const char * stop_ip,long timeout, nutscan_snmp_t * sec);

DESCRIPTION

       The nutscan_scan_snmp() function try to detect NUT compatible SNMP devices. It tries SNMP queries on every IP ranging from start_ip to
       stop_ip. Those IP may be either IPv4 or IPv6 addresses or host names.

       You MUST call nutscan_init(3) before using this function.

       This function waits up to timeout microseconds before considering an IP address does not respond to SNMP queries.

       A valid nutscan_snmp_t structure must be passed to this function.

       The nutscan_snmp_t structure contains the following members which must be filled as described below:

	   char * 'community';
	   char * 'secLevel';
	   char * 'secName';
	   char * 'authPassword';
	   char * 'privPassword';
	   char * 'authProtocol';
	   char * 'privProtocol';

       If community is not NULL, SNMP v1 request are sent using this community.

       If community is NULL and secLevel is NULL, SNMP v1 is selected and community is set to "public".

       In the other cases, SNMP v3 is used. secLevel may be one of SNMP_SEC_LEVEL_NOAUTH, SNMP_SEC_LEVEL_AUTHNOPRIV or SNMP_SEC_LEVEL_AUTHPRIV.
       secName is the security name and must be non NULL.

       If secLevel is set to SNMP_SEC_LEVEL_AUTHNOPRIV, authPassword must be non NULL.

       If secLevel is set to SNMP_SEC_LEVEL_AUTHPRIV, authPassword and privPassword must be non NULL.

       If authProtocol is NULL, MD5 protocol is used. Else you can set authProtocol to either "MD5" or "SHA".

       If privProtocol is NULL, DES protocol is used. Else you can set privProtocol to either "AES" or "DES".

       peername and handle are used internally and do not need any initialization.

RETURN VALUE

       The nutscan_scan_snmp() function returns a pointer to a nutscan_device_t structure containing all found devices or NULL if an error occurs
       or no device is found.

SEE ALSO

       nutscan_init(3), nutscan_scan_usb(3), nutscan_scan_xml_http(3), nutscan_scan_nut(3), nutscan_scan_avahi(3), nutscan_scan_ipmi(3),
       nutscan_display_ups_conf(3), nutscan_display_parsable(3), nutscan_new_device(3), nutscan_free_device(3), nutscan_add_option_to_device(3),
       nutscan_add_device_to_device(3), nutscan_cidr_to_ip(3)

Network UPS Tools						    05/22/2012						      NUTSCAN_SCAN_SNMP(3)

SNMP-UPS(8)							    NUT Manual							       SNMP-UPS(8)

NAME

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

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: ietf:: UPS that is RFC 1628 (UPS
       MIB) compliant, e.g. MGE UPS SYSTEMS, Liebert, perhaps others (default)

       mge
	   MGE UPS SYSTEMS and MGE Office Protection Systems devices with SNMP cards (ref 66062, 66045, 66074 and 66244)

       apcc
	   APC AP9605, AP9606, AP9617, and AP9618 APC network management cards, as well as any others supporting the APC POWERNET MIB

       netvision
	   Socomec Sicon UPS with Netvision Web/SNMP management card/external box

       pw
	   Powerware devices with ConnectUPS SNMP cards

       aphel_genesisII
	   Eaton Powerware ePDU Monitored

       aphel_revelation
	   Eaton Powerware ePDU Managed

       raritan
	   Various Raritan PDUs

       baytech
	   Various BayTech PDUs

       cpqpower
	   HP/Compaq AF401A management card, perhaps others

       cyberpower
	   Cyberpower RMCARD201. Should also support RMCARD100 (net version), RMCARD202 and RMCARD301

EXTRA ARGUMENTS

       This driver supports the following optional settings in the ups.conf(5):

       mibs=name
	   Set MIB compliance (default=auto, allowed entries: refer to the above SUPPORTED HARDWARE). With "auto", the driver will try a select
	   set of SNMP objects until it finds one that the device responds to.

       community=name
	   Set community name (default = public). Note that you require a RW community name to change UPS settings (as for a powerdown).

       snmp_version=version
	   Set SNMP version (default = v1, the other allowed value is v2c)

       pollfreq=value
	   Set polling frequency in seconds, to reduce network flow (default=30)

       notransferoids
	   Disable the monitoring of the low and high voltage transfer OIDs in the hardware. This will remove input.transfer.low and
	   input.transfer.high from the list of variables. This should only be used on APCC Symmetra equipment which has strangeness in the
	   three-phase power reporting.

       secLevel=value
	   Set the securityLevel used for SNMPv3 messages (default=noAuthNoPriv, allowed: authNoPriv,authPriv)

       secName=value
	   Set the securityName used for authenticated SNMPv3 messages (no default)

       authPassword=value
	   Set the authentication pass phrase used for authenticated SNMPv3 messages (no default)

       privPassword=value
	   Set the privacy pass phrase used for encrypted SNMPv3 messages (no default)

       authProtocol=value
	   Set the authentication protocol (MD5 or SHA) used for authenticated SNMPv3 messages (default=MD5)

       privProtocol=value
	   Set the privacy protocol (DES or AES) used for encrypted SNMPv3 messages (default=DES)

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.

LIMITATION

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

INSTALLATION

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

IMPLEMENTATION

       The hostname of the UPS is specified with the "port" value in ups.conf, i.e.:

	   [snmpv1]
		   driver = snmp-ups
		   port = snmp-ups.example.com
		   community = public
		   snmp_version = v1
		   mibs = ietf
		   pollfreq = 15
		   desc = "Example SNMP v1 device"

	   [snmpv3]
		   driver = snmp-ups
		   port = 166.99.224.132
		   mibs = mge
		   secLevel = authPriv
		   secName = mysecurityname
		   authPassword = myauthenticationpassphrase
		   privPassword = myprivatepassphrase
		   desc = "Example SNMP v3 device, with the highest security level"

AUTHORS

       Arnaud Quette, Dmitry Frolov

       Sponsored by Eaton http://www.eaton.com and originally by MGE UPS SYSTEMS http://www.mgeups.com/

SEE ALSO

   The core driver:
       nutupsdrv(8)

   NUT SNMP Protocols Library
       Available at: http://www.networkupstools.org/protocols/snmp/

   Internet resources:
       The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

Network UPS Tools						    05/21/2012							       SNMP-UPS(8)