Summary of the content on the page No. 1
-
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: 1.03
Document Revision: 8
Summary of the content on the page No. 2
FS-8704-09 SNMP Driver Manual Table of Contents TABLE OF CONTENTS 1. SNMP DESCRIPTION ......................................................................................................................3 2. DRIVER SCOPE OF SUPPLY..........................................................................................................4 2.1. Supplied by FieldServer Technologies for this driver .................................................................4 rd 2.1.1. Required 3 P
Summary of the content on the page No. 3
FS-8704-09 SNMP Driver Manual Page 3 of 39 1. 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. Max Nodes Supported: FieldServer Mode Nodes Comments Client 25 Each Node is specified by a unique IP address Server 1 As a Server the SNMP driver can act as a single Node only The Client can be configured to read values s
Summary of the content on the page No. 4
FS-8704-09 SNMP Driver Manual Page 4 of 39 2. Driver Scope of Supply 2.1. Supplied by FieldServer Technologies for this driver FieldServer Technologies PART # Description FS-8915-10 Ethernet cable, 7 foot, RJ45 FS-8704-09 Driver Manual. FS-8704-09 mb8sim.exe. SNMP utility for generating MIB files rd 2.1.1. Required 3 Party Hardware Part # Description 1 Ethernet 10/100 BaseT hub 1 Not all FieldServer models support 100Bas
Summary of the content on the page No. 5
FS-8704-09 SNMP Driver Manual Page 5 of 39 3. 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 rd 3 Party Nodes (non-SNMP) 2. FieldServer as SNMP Client SCADA rd (3 Party Client) Managed Nodes TCP/IP Cloud (SNMP Agents)
Summary of the content on the page No. 6
FS-8704-09 SNMP Driver Manual Page 6 of 39 4. 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). This section documents and describes the parameters necessary for configuring the
Summary of the content on the page No. 7
FS-8704-09 SNMP Driver Manual Page 7 of 39 4.2. Client Side Connection Descriptors Section Title Adapter Column Title Function Legal Values 2 Adapter Adapter Name N1, N2 Protocol Specify protocol used SNMP 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. 0 (default)
Summary of the content on the page No. 8
FS-8704-09 SNMP Driver Manual Page 8 of 39 4.3. Client Side Node Descriptors Section Title Nodes Column Title Function Legal Values Up to 32 Node_Name Provide name for Node alphanumeric characters Identifies Node; needed only if Node Online/Offline Node_ID* 1-255 monitoring is used. Protocol Specify protocol used SNMP 2 Adapter Specify network adapter N1, N2 Legal 4 byte IP IP Address of remote Agent. Refer to Appendix A.1 IP_Address address on the for more information
Summary of the content on the page No. 9
FS-8704-09 SNMP Driver Manual Page 9 of 39 4.4. Client Side Map Descriptors 4.4.1. FieldServer Related Map Descriptor Parameters Section Title Map Descriptors Column Title Function Legal Values Map_Descriptor_Name Name of this Map Descriptor Up to 32 alphanumeric characters Name of Data Array where data is One of the Data Array names from Data_Array_Name to be stored in the FieldServer “Data Array” section above 0 to maximum specified in “Data Data_Array_Offset Starting loca
Summary of the content on the page No. 10
FS-8704-09 SNMP Driver Manual Page 10 of 39 4.4.4. Map Descriptor Example // Client Side Map Descriptors Map Descriptors Map_Descriptor_Name, Data_Array_Name, Data_Array_Offset, Function, Node_Name, SNMP_OID, Length, Scan_Interval A1, DA_AI3, 0, RDBC, Agent 1, 1.3.6.1.4.1.6347.1.1.0, 1, 5 A2, DA_AI3, 1, WRBX, Agent 1, 1.3.6.1.4.1.6347.1.1.0, 1, - Read functions are The OID is The Data Array to Specifies how implemented as derived from the which the Read
Summary of the content on the page No. 11
FS-8704-09 SNMP Driver Manual Page 11 of 39 5. 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). This section documents and describes the parameters necessary for config
Summary of the content on the page No. 12
FS-8704-09 SNMP Driver Manual Page 12 of 39 5.2. Server Side Connection Descriptors Section Title Adapter Column Title Function Legal Values 3 Adapter Adapter Name N1, N2 Protocol Specify protocol used SNMP This parameter can be configured if it is required that Any string up to 255 characters, SNMP_Community* “Community” be a different name Public in order to receive traps. Example // Server Side Connections Adapters Adapter, Protocol N1, SNMP 5.3. Serve
Summary of the content on the page No. 13
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. Trap Source IP Address When a trap is received it contains its source IP
Summary of the content on the page No. 14
FS-8704-09 SNMP Driver Manual Page 14 of 39 Appendix A.1.2. Receiving SNMP TRAPs using the SNMP Client In order to receive Traps, the SNMP Client requires a Map Descriptor to be configured for each OID that is to be updated via a Trap. Note that a single Trap message may contain multiple OID’s, depending on the Agent originating the Trap. Each OID of interest requires its own Map Descriptor. The Map Descriptor Function must be set to Passive_Client. Example: // Server
Summary of the content on the page No. 15
FS-8704-09 SNMP Driver Manual Page 15 of 39 Appendix A.1.3. Receiving SNMP Traps – Storing using a Lookup Table Some devices send trap messages with the same OID’s irrespective of the causal events. The OID contents provide event specific information such as event origin and state. Consider a trap containing 3 OID’s. One has an integer value (event state) and the other two have strings reporting the event source. The SNMP driver is capable of using the two string OID’s to form
Summary of the content on the page No. 16
FS-8704-09 SNMP Driver Manual Page 16 of 39 Step 1: Define the Lookup Table The driver loads the table into memory and uses it when a new trap is received. If the search string is formed by concatenating two OID Sting fields then the driver places a colon, thus a colon should be placed between the two substrings. If the search string formed from the trap contents does not match an entry in the table the driver prints a message in the error log at an offset of zero. For this r
Summary of the content on the page No. 17
FS-8704-09 SNMP Driver Manual Page 17 of 39 Step 2 : Create a Map Descriptor (MD) to catch the Trap Pay special consideration to the following parameters; • SNMP_OID: Specify the OID of the event state. The field must contain an integer value which is the value that will be stored. When st the trap is received the driver extracts the contents and takes the 1 OID in the message and looks for a MD whose ‘SNMP_OID’ matches. If it doesn’t find one then the trap is discarded. • S
Summary of the content on the page No. 18
FS-8704-09 SNMP Driver Manual Page 18 of 39 Appendix A.2. Sending SNMP TRAPS using the SNMP Server/Agent There are two ways to send traps using the driver • A rule based appoach – COV (Change of Value): Driver watches a data point. If the data changes and meets the condition of some rule then the trap is generated. • Non-rule – Driver sends the trap uncondionally based on a time interval or whenever the source data point is udpated (even if there is no change.) Change of Val
Summary of the content on the page No. 19
FS-8704-09 SNMP Driver Manual Page 19 of 39 Appendix A.2.1. COV Map Descriptor Example In this example each time the value found in Data Array 'DA_AI3' at offset 0 changes by at least 0.2 (COS_Deadband) then a trap will be sent. // Server Side Map Descriptors Map_Descriptors Map_Descriptor_Name, Data_Array_Name, Data_Array_Offset, Function, Node_Name, SNMP_OID, COS_Normal, COS_Deadband PSU_Voltage_Alarm, DA_AI3, 0, SNMP_TRAP, NM_1, 1.3.6.1.4.1.6347.1.1.0.0, COS_Ser
Summary of the content on the page No. 20
FS-8704-09 SNMP Driver Manual Page 20 of 39 Example of a Trap Sent: In this example the trap was the 1st trap defined in the configuration. That is why the Trap OID = 6. The MD name was 'ambTemp'. Its name begins with a lower case character to meet validation requirements. The configuration file definition for the trap had the OID set to 1.3.6.1.4.1.6347.1.1.1.0. When the trap was produced the value was 120 and the trap was produced because the value was above the Hi Alarm thr
