SNMP Driver

[wuench]

Simple Network Management Protocol (SNMP) Driver
Version 1.9

Description:

This driver controls devices using the Simple Network Management protocol.  The driver is capable of communicating with any network device supporting SNMPv1 or SNMPv2.  (SNMPv3 is not supported).  

All configuration is done via an XML file located under MacroFileRoot\SNMP, when loading the driver you will be prompted for the filename.  Please see the attached PDF file for information on how to build the XML file.

The driver supports polling of, writing commands to, and asynchronous SNMP traps from network devices.  Multiple devices may be polled from a single driver instance, or you can run multiple driver instances.  However, only one trap receiver may be configured per system on specific port (usually UDP 161).  You can have multiple trap receivers in different driver instances on different ports.

Release Info
[indent]Version 1.0 - Original Version
Version 1.1 - Moved SNMP methods to separate Class
Version 1.2

• SNMPDB Implementation
  
• CQC Events for Traps
  

Version 1.3

• SNMP Type Discovery
  
• Critical Error Detection
  

Version 1.4

• SNMP Version Configruation <SNMPVersion>
  
• Logging of skipped fields during polling (Poll.SkipField, MED)
  
• Automatically creates \\SNMP directory under MacroFileRoot
  

Version 1.5

• Fixed Issue with leading ÔÇ£.ÔÇØ in OID in StaticTables
  
• Fixed Issue with no initial poll after reload
  

Version 1.6

• Fixed Issue with Nulls (0x00) in OctetStrings
  
• Forced Poll on ReloadConfig
  

Version 1.7    

• Purge socket buffer on Error
  
• Purge socket buffer before Send
  
• Disable Critical Error Detection
  
• Fixed CQCType Validation Issue
  
• Added StaticTable Calc Index/Key Tokens
  
• Added moniker token replacement in all parm values
  
• Set ReloadConfig to Reload Driver
  

Version 1.8

• Fixed IntervalFormat Mins=Moniker Bug
  
• Moniker Repl now uses %(moniker) (was %(m))
  

Version 1.9

• Version 1.9 ┬á ┬á Fixed - Malformed Tokens not triggering Loadfile exception (ConfigFile)
  

[/indent]

Default Fields
[indent]

• SNMP_DebugMode - Boolean R/W - Turns on the driver's debug mode. ┬áThis will output extensive information to a log file for troubleshooting purposes. ┬áSee configuration guide for details. ┬áUse sparingly, this generates a lot of info.
  
• SNMP_Filename - String R/W - The name of the configuration file. ┬áThis can be changed and the driver reloaded using the SNMP_ReloadConfig field.
  
• SNMP_Interval - Integer R/W - Default polling interval in seconds.
  
• SNMP_ReloadConfig - Boolean R/W - Setting this to True will reload the driver/configuration.
  

[/indent]

Examples
[indent]I will be adding several examples and would also like to ask that other users to contribute their XML configuration files.  They will be listed here.

[post=96467]APC Masterswitch 9210[/post]
APC Masterswitch AP9224 Vertical Mount Controller
[post=95875]APC UPS[/post]
Nortel Switches
Microsoft Windows
OpenWrt/Linux


[/indent]

Available in CQC 4.2.922+

[SomeWhatLost]

just curious, but what home automationy type equipment uses snmp?

[wuench]

APC UPS Example

Description
In this example I will show you how to manage an APC UPS. Usually you will need a management card for your APC UPS in order for it to support SNMP. The MIB used for APC UPS's is the Powernet MIB (also attached).

Installation
You will need to copy the XML file to the CQC\CQCData\MacroFileRoot\SNMP directory, and enter the location \\SNMP\APCUPS-SNMP.xml when loading the driver. Before loading you will need to change the <Device>AVUPS</Device> entry in the XML file to the name or IP Address of your UPS, and configure the <ReadCommunity> and/or <WriteCommunity> if it is not the defaults of public and private.

Sample Template
The template below assumes the driver's name is UPS

[wuench]

just curious, but what home automationy type equipment uses snmp?

Lots of network equipment support SNMP, like router and switches, etc. Including those made by Linksys. Also, most operating systems support it, including Windows and Unix/Linux. My Epson projector and UPS support it as well.

[znelbok]

Congrats on a great driver.

Although I have not used it yet, building a driver based on an already established comms system is common sense at its best.

Now to play with it with my switches, ups and router.

Mick

[bph]

Congrats on a great driver.

Although I have not used it yet, building a driver based on an already established comms system is common sense at its best.

Now to play with it with my switches, ups and router.

Mick

This should also be the better way to talk to the MasterSwitch. That will probably be easier than debugging what's going on with the HTML scraping in some installs.

[znelbok]

Working on that right now. I need to ask some questions, do you want me to ask them here or in a new thread.

Mick

[wuench]

Working on that right now. I need to ask some questions, do you want me to ask them here or in a new thread.

Mick

You can ask them here...

[znelbok]

This is for an APC Master Switch

I have set up two XML file's to get the system up time and system name, one for the Masterswitch and the other for my Nortel Baystack switches. The Nortel works fine and returns values accordingly, the MS does not.

I get a SendGet failed for some reason.

Log file and xml file are attached (the log file has some extra fields from my original set-up, but the results are the same.)

Here is the screen shot from the MIB Browser. The OID shown [at the top] is the system up time and the OID used in the xml file.




Here are two shots of the SNMP setup for the Maserswitch. I will confess I do not know what they all mean, the Trap Receiver IP was originally 0.0.0.0 in all fields (with same results) and so I changed the IP to the test server which is where I had the CQC driver installed with no change.

Community access 3 & 4 were both originally set to disabled as well.




Any help appreciated

Thanks

Mick

[bph]

This is for an APC Master Switch
Mick

I haven't been able to get my Masterswitch to respond at all to SNMP, so I'm about to try checking the serial port connection to make sure SNMP is properly enabled.

Did your MS respond to the MIB browser outside of the driver?