- A Sierra Monitor Company Driver Manual (Supplement to the FieldServer Instruction Manual) FS-8704-09 SNMP Version 1 APPLICABILITY & EFFECTIVITY Effective for all systems manufactured after September 2008 Driver Version: Document Revision: 1.
FS-8704-09 SNMP Driver Manual Table of Contents TABLE OF CONTENTS 1. 2. SNMP DESCRIPTION ...................................................................................................................... 3 DRIVER SCOPE OF SUPPLY.......................................................................................................... 4 2.1. Supplied by FieldServer Technologies for this driver ................................................................. 4 rd 2.1.1. Required 3 Party Hardware.......
FS-8704-09 SNMP Driver Manual 1. Page 3 of 39 SNMP Description The SNMP driver allows the FieldServer to transfer data to and from devices over Ethernet using the SNMP version 1 protocol. The FieldServer can emulate either a Server (SNMP Agent) or Client.
FS-8704-09 SNMP Driver Manual 2. Page 4 of 39 Driver Scope of Supply 2.1. Supplied by FieldServer Technologies for this driver FieldServer Technologies PART # FS-8915-10 FS-8704-09 FS-8704-09 2.1.1. Part # Description Ethernet cable, 7 foot, RJ45 Driver Manual. mb8sim.exe. SNMP utility for generating MIB files Required 3rd Party Hardware Description 1 Ethernet 10/100 BaseT hub 1 Not all FieldServer models support 100BaseT.
FS-8704-09 SNMP Driver Manual 3. Page 5 of 39 Hardware Connections The FieldServer is connected to the Ethernet using the UTP cable supplied. Two typical hardware configurations are shown below: 1. FieldServer as SNMP Agent (Server) Network Management Station FieldServer SNMP Agent/Server TCP/IP Cloud 3rd Party Nodes (non-SNMP) 2. FieldServer as SNMP Client SCADA (3rd Party Client) TCP/IP Cloud Managed Nodes (SNMP Agents) FieldServer (SNMP Client) 3.1.
FS-8704-09 SNMP Driver Manual 4. Page 6 of 39 Configuring the FieldServer as a SNMP Client For a detailed discussion on FieldServer configuration, please refer to the FieldServer Configuration manual. The information that follows describes how to expand upon the factory defaults provided in the configuration files included with the FieldServer (See “.csv” sample files provided with the FieldServer).
FS-8704-09 SNMP Driver Manual 4.2. Page 7 of 39 Client Side Connection Descriptors Section Title Adapter Column Title Adapter Protocol Function Adapter Name Specify protocol used If this parameter is omitted or set to 0 the short form of encoding length will be used. If the parameter is set to 1 (and the Length is ≤ 127) the long form of encoding length will be used. For Length >127 short form will be used regardless of the setting.
FS-8704-09 SNMP Driver Manual 4.3. Page 8 of 39 Client Side Node Descriptors Section Title Nodes Column Title Node_Name Function Legal Values Up to 32 alphanumeric characters Provide name for Node Identifies Node; needed only if Node Online/Offline monitoring is used. Specify protocol used Specify network adapter Node_ID* Protocol Adapter IP_Address IP Address of remote Agent. Refer to Appendix A.1 for more information. MIB_Style Controls how MIB file is formatted. Refer to Appendix A.
FS-8704-09 SNMP Driver Manual 4.4. Page 9 of 39 Client Side Map Descriptors 4.4.1. FieldServer Related Map Descriptor Parameters Section Title Map Descriptors Column Title Map_Descriptor_Name Data_Array_Name Function Name of this Map Descriptor Name of Data Array where data is to be stored in the FieldServer Data_Array_Offset Starting location in Data Array Function Function of Client Map Descriptor 4.4.2.
Read functions are implemented as SNMP Get Requests. Write functions are implemented as SNMP Set Requests. Function, RDBC, WRBX, Node_Name, Agent 1, Agent 1, The OID is derived from the MIB file of the Node you are talking to. It is easiest to load the MIB file in a MIB browser (e.g. MG-Soft) which converts the text name to the OID format SNMP_OID, 1.3.6.1.4.1.6347.1.1.0, 1.3.6.1.4.1.6347.1.1.0, Page 10 of 39 Scan_Interval 5 - Specifies how often to perform this transaction, in seconds.
FS-8704-09 SNMP Driver Manual 5. Page 11 of 39 Configuring the FieldServer as a SNMP Server/Agent For a detailed discussion on FieldServer configuration, please refer to the FieldServer Configuration Manual. The information that follows describes how to expand upon the factory defaults provided in the configuration files included with the FieldServer. (See “.csv” sample files provided with the FieldServer).
FS-8704-09 SNMP Driver Manual 5.2. Page 12 of 39 Server Side Connection Descriptors Section Title Adapter Column Title Adapter Protocol SNMP_Community* Function Adapter Name Specify protocol used This parameter can be configured if it is required that “Community” be a different name in order to receive traps. Legal Values N1, N2 SNMP 3 Any string up to 255 characters, Public Example // Server Side Connections Adapters Adapter, N1, 5.3.
FS-8704-09 SNMP Driver Manual Page 13 of 39 Appendix A. Advanced Topics Appendix A.1. Receiving SNMP TRAPS A trap can reveal the causal event in two ways: • The cause can be indicated by the OID number inside the trap with the event state reported by the associated data value. • The cause can be indicated by the value of one OID field and the event state by the value of another OID field. Appendix A.1.1.
Data_Array_Offset, 0, 1, Node_Name, Agent 1, Agent 1, SNMP_OID 1.3.6.1.4.1.6347.1.1.0, 1.3.6.1.4.1.6347.1.1.1, The OID specifies the value that will be stored by this Map Descriptor following a TRAP update. Function, Passive_Client, Passive_Client, FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com Tel: (408) 262 2299 Fax: (408) 262 9042 Toll Free: (888) 509 1970 email: support@fieldserver.
Receiving SNMP Traps – Storing using a Lookup Table Page 15 of 39 FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com Tel: (408) 262 2299 Fax: (408) 262 9042 Toll Free: (888) 509 1970 email: support@fieldserver.com The example below illustrates how to configure the FieldServer to achieve this: When configured correctly the driver will concatenate the values of the two source OID’s to form a search string for a lookup table.
Page 16 of 39 Protocol SNMP SNMP SNMP FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com Tel: (408) 262 2299 Fax: (408) 262 9042 Toll Free: (888) 509 1970 email: support@fieldserver.com There are some limitations to the table: • it can hold a maximum of 200 entries. • Each string entry can be a maximum of 59 characters. • When the driver searches the table looking for a match it ignores the case of the entries.
Page 17 of 39 Data_Array_Name, DA_TRAPS, Data_Array_Offset, 0, Function, Passive_Client, Node_Name, Agent 1, SNMP_OID, 1.3.6.1.4.1.290.1.0, SNMP_Trap_Store_Method, Lookup, SNMP_OID_Index1, 1.3.6.1.4.1.290.2, SNMP_OID_Index2 1.3.6.1.4.1.290.3 FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com Tel: (408) 262 2299 Fax: (408) 262 9042 Toll Free: (888) 509 1970 email: support@fieldserver.
Sending SNMP TRAPS using the SNMP Server/Agent Page 18 of 39 High Alarm threshold, applies to numerical values High Warning threshold, applies to numerical values Low Warning threshold, applies to numerical values Low Alarm threshold, applies to numerical values Deadband value which must be crossed for Alarm or Warning states to toggle (prevents chatter) Normal value for a digital point (1 or 0) – when the value changes to or from Normal, a Trap is sent.
COV Map Descriptor Example Page 19 of 39 Data_Array_Offset, 0, Function, SNMP_TRAP, Node_Name, NM_1, SNMP_OID, 1.3.6.1.4.1.6347.1.1.0.0, COS_Normal, COS_Server_Event, COS_Deadband 0.2 FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com Tel: (408) 262 2299 Fax: (408) 262 9042 Toll Free: (888) 509 1970 email: support@fieldserver.com e.g.
Page 20 of 39 Polling for Integer bound Data So most likely from the MIB it would compile as Data_Array_Name, SNMP_DA_2, Data_Array_Offset, 01, Function, SNMP_TRAP, Node_Name, Trap_1, SNMP_OID, 1.3.6.1.4.1.6347.1.2.1.0, FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com Tel: (408) 262 2299 Fax: (408) 262 9042 Toll Free: (888) 509 1970 email: support@fieldserver.
Page 21 of 39 Protocol, SNMP, Adapter, N1, Use Wrbc and add a Scan_Interval to have the trap send periodically. Function, Wrbx, Node_Name, NM_1, This is what tells the driver that this is not a normal write and that the message should be sent as a trap. Data_Array_Offset, 0, Wrbx to write on update. Data_Array_Name, DA_AI3, IP_Address 192.168.1.174 SNMP_Write_as_Trap, Yes, Data_Type, Integer, Length 1 Integer value or ASCII strings may be sent.
FS-8704-09 SNMP Driver Manual Appendix A.3. Page 22 of 39 MIB File Generation for the SNMP Server/Agent It is necessary to create an updated MIB file corresponding to the available Data Arrays and Traps configured in the Server configuration (*.csv) file. To create this MIB file, run the mb8sim.exe utility supplied with the FieldServer in a DOS command window as follows: • • mb8sim –cmy_config.csv where my_config.csv is the newly created configuration file. hit ‘Q’ to quit.
FS-8704-09 SNMP Driver Manual Appendix A.3.1. Page 23 of 39 Customizing the MIB File Header: Use the ‘Custom’ MIB_Style. The MB8Sim.exe application looks for a file called ‘MIBhead.ini”. If the file is absent or cannot be opened then a standard MIB file is produced. If the file can be opened then the application inserts the contents of the file into the header. In the example below the section in blue italics would be replaced with the contents of the MIBhead.ini file.
FS-8704-09 SNMP Driver Manual Appendix A.4. Page 24 of 39 Controlling how a MIB file reports traps The connection parameter ‘Do_not_MIB_this_Node’ controls whether a Node’s traps contribute to the MIB file. This parameter is useful where duplicate traps are being sent to more than one destination. Some aspects of how traps are reported in the MIB file may be controlled with a Node parameter called ‘MIB_Style_for_Traps’ Adapters Adapter, N1, Protocol, SNMP, Poll_Delay, 0.
FS-8704-09 SNMP Driver Manual Page 25 of 39 Comparison of Style2 to Style3 FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com Tel: (408) 262 2299 Fax: (408) 262 9042 Toll Free: (888) 509 1970 email: support@fieldserver.
FS-8704-09 SNMP Driver Manual Page 26 of 39 Comparison of Style1 to Style3 FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com Tel: (408) 262 2299 Fax: (408) 262 9042 Toll Free: (888) 509 1970 email: support@fieldserver.
SNMP2, SNMP2, SNMP2, SNMP2, SNMP2, SNMP2, SNMP2, SNMP2, SNMP2, Node_Name, SNMP1, SNMP1, SNMP1, SNMP1, SNMP1, SNMP1, SNMP1, SNMP1, SNMP1, 1 1 1 1 1 1 1 1 1 Length, 1 1 1 1 1 1 1 1 1 -, -, -, -, -, -, -, -, -, -, -, -, -, -, -, -, -, -, Cos_Hi_Warn, -, -, -, -, -, -, -, -, -, -, -, -, -, -, -, -, -, -, COS_Hi_Alm, -, -, -, -, -, -, -, -, -, Do_not_MIB_this_Node 0(Ok to MIB) COS_Deadband, -, -, -, -, -, -, -, -, -, Max_Trap_Count, Extended, MIB_Style_for_Traps Style3 Data_Array_Length 3500 3500 350
FS-8704-09 SNMP Driver Manual Page 28 of 39 Style1 MIB File based on above configuration FIELDSERVER-MIB DEFINITIONS ::= BEGIN IMPORTS enterprises, OBJECT-TYPE, MODULE-IDENTITY FROM SNMPv2-SMI TRAP-TYPE FROM RFC-1215; fieldservertechnologies MODULE-IDENTITY LAST-UPDATED "200308121338Z" ORGANIZATION "FieldServer Technologies" CONTACT-INFO "info@fieldserver.
FS-8704-09 SNMP Driver Manual Page 29 of 39 Style2 MIB File based on above configuration FIELDSERVER-MIB DEFINITIONS ::= BEGIN IMPORTS enterprises, OBJECT-TYPE, MODULE-IDENTITY FROM SNMPv2-SMI TRAP-TYPE FROM RFC-1215; fieldservertechnologies MODULE-IDENTITY LAST-UPDATED "200308121338Z" ORGANIZATION "FieldServer Technologies" CONTACT-INFO "info@fieldserver.
FS-8704-09 SNMP Driver Manual Page 30 of 39 Style3 MIB File based on above configuration FIELDSERVER-MIB DEFINITIONS ::= BEGIN IMPORTS enterprises, OBJECT-TYPE, MODULE-IDENTITY FROM SNMPv2-SMI TRAP-TYPE FROM RFC-1215; fieldservertechnologies MODULE-IDENTITY LAST-UPDATED "200308121338Z" ORGANIZATION "FieldServer Technologies" CONTACT-INFO "info@fieldserver.
FS-8704-09 SNMP Driver Manual Page 31 of 39 Style3 Traps FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com Tel: (408) 262 2299 Fax: (408) 262 9042 Toll Free: (888) 509 1970 email: support@fieldserver.
FS-8704-09 SNMP Driver Manual Appendix A.4.1. Page 32 of 39 Mib_Style_for_Traps' = 'Style2' – Trap Descriptions Where the Node parameter 'Mib_Style_for_Traps' = 'Style2' then the driver will produce trap descriptions which indicate what will cause the trap to be generated. The examples below illustrate the kind of information provided in the trap description.
FS-8704-09 SNMP Driver Manual Page 33 of 39 Appendix B. Troubleshooting Tips Appendix B.1. HP Openview: If the FieldServer is running and is not visible in the network topology, try restarting the network discovery as described in the HP Openview Network Node Manager User Manual. FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com Tel: (408) 262 2299 Fax: (408) 262 9042 Toll Free: (888) 509 1970 email: support@fieldserver.
FS-8704-09 SNMP Driver Manual Page 34 of 39 Appendix C. Driver Error Messages Message SNMP:#01 Err. Response report err=%d SNMP:#02a/b Err. Could not read SNMP response version SNMP:#03a/b Err. Version. Expected=1 Rcvd=%d SNMP:#04a Err. Extract Int Failed. Index=%d SNMP:#04b Err. Expected INT. Found NULL. Index=%d Description/Action A response from the remote device reports an error. The message is good but inside the message there is a field reporting an error.
FS-8704-09 SNMP Driver Manual Message SNMP:#18 Err. Bad Send IP=%s SNMP:#19 Err. Can’t send to Agent/Trap Dest. %s at %s SNMP:#20 Err. Received set/get/getnext request SNMP:#21 Err. Bad community string SNMP:#22 Err: Cant parse msg: found %#x at %d SNMP:#23 Err. Invalid Msg SNMP:#24 Err. Message length error SNMP:#25 Err. Could not get Request ID SNMP:#26 Could not get Error Status SNMP:#27 Could not get Error Index SNMP:#28 Expected SNMP_TYPE_SEQ SNMP:#29 ERR.
FS-8704-09 SNMP Driver Manual Message SNMP:#31 Err Couldnt parse msg: found %#x at %d SNMP:#33 Err. Too many DA's to validate for SNMP. Max=%d SNMP:#34 FYI. No DA's for walk by remote browser SNMP:#35 FYI. DA 'SNMP_DA_1' is missing. Walk will fail SNMP:#36 FYI. 'SNMP_DA_%d' is missing. Walk will fail SNMP:#37 FYI. No SNMP DA's for walk by remote browser. SNMP:#38 FYI. DA names suitable for walk by remote browser SNMP:#39 FYI. Use an array called <%s> to expose diagnostic info SNMP:#40 Err.
FS-8704-09 SNMP Driver Manual Message SNMP:#43 Err Undefined SNMP_Trap_Store_Method SNMP:#44 Err Undefined SNMP_Write_as_Trap SNMP:#45 Err. Undefined SNMP_Read_Method SNMP:#46 state=<%s> FYI. Duplicate SNMP:#47 Err. No space. Driver rejects value state=<%s> value=%d SNMP:#48 FYI. Added state=<%s> value=%d SNMP:#49 Err. Cant find lookup table entry below SNMP:#50 Err. Found non-string data while extracting string SNMP:#51 Err Indexed Store.
FS-8704-09 SNMP Driver Manual Message SNMP:#57 Err. Data offline/expired. DA=%s Off=%d SNMP:#58 Err. Needs Array with name % Data SNMP:#59 Err. Store index %d exceeds Data Array %s length SNMP:#60 Err. Index Storage can only store Integer Values Page 38 of 39 Description/Action A remote client has polled for data. The data at the location specified it ‘too old’ to serve. This usually means that the Client Node is offline and hence the FieldServer cannot update the data.
FS-8704-09 SNMP Driver Manual Appendix C.1. Page 39 of 39 Exposing Driver Statistics In addition to the standard FieldServer operating statistics the driver exposes certain key statistics in a Data Array if required. A Server device can then monitor these stats. Add the following to your configuration file to activate these statistics if the driver is configured as a Client. // Expose Driver Operating Stats.
