-
A Sierra Monitor Company
APPLICABILITY & EFFECTIVITY
Effective for all systems manufactured after September 2008
Driver Manual
(Supplement to the FieldServer Instruction Manual)
FS-8704-09 SNMP Version 1
Driver Version:
1.03
Document Revision: 8
Страница 1: ...ompany APPLICABILITY EFFECTIVITY Effective for all systems manufactured after September 2008 Driver Manual Supplement to the FieldServer Instruction Manual FS 8704 09 SNMP Version 1 Driver Version 1 03 Document Revision 8 ...
Страница 2: ...scriptor Example 10 5 CONFIGURING THE FIELDSERVER AS A SNMP SERVER AGENT 11 5 1 Server Side Data Arrays 11 5 2 Server Side Connection Descriptors 12 5 3 Server Side Node Descriptors 12 5 4 Server Side Map Descriptors 12 APPENDIX A ADVANCED TOPICS 13 Appendix A 1 Receiving SNMP TRAPS 13 Appendix A 1 1 Trap Source IP Address 13 Appendix A 1 2 Receiving SNMP TRAPs using the SNMP Client 14 Appendix A ...
Страница 3: ...e Node only The Client can be configured to read values specified by their SNMP Object Identifiers OID s which are defined in the MIB file Management Information Base of the target device When acting as an SNMP Agent Server the driver makes the contents of specified integer data arrays available to any SNMP Client The FieldServer MIB file sets out the OIDs to use The current version of the driver ...
Страница 4: ... 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 2 1 1 Required 3rd Party Hardware Part Description Ethernet 10 100 BaseT hub 1 1 Not all FieldServer models support 100BaseT Consult the appropriate instruction manual for details...
Страница 5: ...rver as SNMP Agent Server 2 FieldServer as SNMP Client 3 1 Hardware Connection Tips Hints The FieldServer utility program Ruinet will connect to the FieldServer even if the Netmask setting on the PC differs from the setting on the FieldServer SNMP will only work between Nodes for which these settings correspond however thus all Nodes required to communicate using SNMP must have the same Netmask se...
Страница 6: ...f data required In order to enable the FieldServer for SNMP communications the driver independent FieldServer buffers need to be declared in the Data Arrays section the destination device addresses need to be declared in the Client Side Nodes section and the data required from the servers needs to be mapped in the Client Side Map Descriptors section Details on how to do this can be found below Not...
Страница 7: ... is 127 the long form of encoding length will be used For Length 127 short form will be used regardless of the setting Long form an extra byte will be inserted to indicate the number of following bytes which indicates the length of the following section in message Short form only length value will be inserted 0 default 1 SNMP_Community This parameter can be configured if it is required that Commun...
Страница 8: ...trols how MIB file is formatted Refer to Appendix A 3 for more info Standard Custom NuDesign MIB_Style_for_Traps Controls how traps are reported in MIB file Refer to Appendix A 3 for more info Style1 Style2 Style3 Do_not_MIB_this_Node Controls whether a Node s traps contribute to the MIB file Where duplicate traps are sent to more than one Node second and subsequent Nodes will not contribute to th...
Страница 9: ...tarting location in Data Array 0 to maximum specified in Data Array section above Function Function of Client Map Descriptor RDBC WRBC WRBX 4 4 2 Driver Related Map Descriptor Parameters Section Title Map Descriptors Column Title Function Legal Values Node_Name Name of Node to fetch data from One of the Node names specified in Client Node Descriptor above Length Length of Map Descriptor 1 SNMP_OID...
Страница 10: ..._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 The Data Array to which the Read Data will be stored or from which Write Data will be fetched at the location specified by Data_Array_Offset Read functions are implemented as SNMP Get Requests Write functions are implemented as SNMP Set Requests The OID is derived from the MIB file of th...
Страница 11: ...rays section the FieldServer virtual Node s needs to be declared in the Server Side Nodes section and the data to be provided to the clients needs to be mapped in the Server Side Map Descriptors section Details on how to do this can be found below Note that in the tables indicates an optional parameter with the bold legal value being the default 5 1 Server Side Data Arrays A special Data Array nam...
Страница 12: ...e Descriptors Section Title Nodes Column Title Function Legal Values Node_Name Provide name for Node Up to 32 alphanumeric characters Protocol Specify protocol used SNMP Example Server Side Nodes Nodes Node_Name Protocol Agent 1 SNMP 5 4 Server Side Map Descriptors No Server Side Map Descriptors are required by SNMP for Get or Set requests since the mapping of FieldServer Data Arrays into the SNMP...
Страница 13: ...on within the UDP packet header It is possible for a trap to reveal its source IP address by coding an IP_ADDRESS field inside the trap To catch a trap it is necessary to define Map Descriptors containing the OID s of the trap Map Descriptors are associated with a Node A Node is defined by its IP address amongst other parameters When a trap is received the source of the IP address must match the I...
Страница 14: ...ingle 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 Side Map Descriptors Map Descriptors Map_Descriptor_Name Data_Array_Name Data_Array_Offset Function Node_Name SNMP_OID A1 DA_AI3 0 Passive_Client Agent 1 1 3 6 1 4 1 6347 1 1 0 A2 DA_A...
Страница 15: ... 3 6 1 4 1 290 1 0 contains the event state 1 3 6 1 4 1 290 2 0 contains the 1 st part of identifier of the event source 1 3 6 1 4 1 290 3 0 contains the 2 nd part of identifier of the event source When configured correctly the driver will concatenate the values of the two source OID s to form a search string for a lookup table An offset value extracted from a matching entry is used to determine t...
Страница 16: ...on file create a Driver Table section Driver_Table SNMP_Lookup_Table_Offset SNMP_Lookup_Table_String Protocol 1 Sandhill_KDA 24V_CHARGER SNMP 2 BIG_BEND_DVA_02_102 AC_POWER_FAILURE SNMP 3 CROSSTWN_KDA EMS_84_900MHZ_RADIO_B SNMP 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 ...
Страница 17: ... OID Map_Descriptor_Name Data_Array_Name Data_Array_Offset Function Node_Name SNMP_OID SNMP_Trap_Store_Method SNMP_OID_Index1 SNMP_OID_Index2 MD1 DA_TRAPS 0 Passive_Client Agent 1 1 3 6 1 4 1 290 1 0 Lookup 1 3 6 1 4 1 290 2 1 3 6 1 4 1 290 3 The following notes refer to the decoded SNMP trap message shown above in this section Driver receives trap and starts extracting data from the message Drive...
Страница 18: ...arning Low Warning threshold applies to numerical values COS_Lo_Alm Low Alarm threshold applies to numerical values COS_Deadband Deadband value which must be crossed for Alarm or Warning states to toggle prevents chatter COS_Normal Normal value for a digital point 1 or 0 when the value changes to or from Normal a Trap is sent For an analog point set the COS_Normal parameter COS_Server_Event and th...
Страница 19: ... trap OID s as follows The 1st trap found in the configuration file is allocated OID 1 3 6 1 4 1 6347 6 6 Subsequent traps are allocated 6347 6 7 6347 6 8 etc Each COS trap contains two bound variables The first bound variable has its OID equal to the OID specified in the configuration file It contains an Integer reporting the value of the variable at the time the trap is generated The second boun...
Страница 20: ... 1 1 0 0 String ambTemp Status HI ALARM 1 3 6 1 4 1 6347 1 1 1 0 Integer 120 Trap OID s Appendix A 2 2 Polling for Integer bound Data It is possible for the remote SNMP Client to poll for the data as well as listen for the traps This is achieved by setting the OID to a value that corresponds to a pollable point in a SNMP_DA_xx Data Array In the example below the Data Array name is SNMP_DA_02 This ...
Страница 21: ...set up as follows Remote_Client_Node_Descriptors Node_Name Node_ID Protocol Adapter IP_Address NM_1 1 SNMP N1 192 168 1 174 The Trap Map Descriptors are then configured as below Map_Descriptors Map_Descriptor_Name Data_Array_Name Data_Array_Offset Function Node_Name SNMP_OID SNMP_Write_as_Trap Data_Type Length PSU_Voltage_Alarm DA_AI3 0 Wrbx NM_1 1 3 6 1 4 1 6347 1 1 0 0 Yes Integer 1 Wrbx to writ...
Страница 22: ...ieldServer 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 The program will have created a file called FServer MIB which may be compiled into the SNMP Management application of choice When the MIB File is created the driver prints a message to the Error log The MIB_Style parameter specified in Section 4 3 provides t...
Страница 23: ... file into the header In the example below the section in blue italics would be replaced with the contents of the MIBhead ini file FIELDSERVER MIB DEFINITIONS BEGIN IMPORTS enterprises OBJECT TYPE MODULE IDENTITY FROM SNMPv2 SMI TRAP TYPE FROM RFC 1215 fieldserver_technologies MODULE IDENTITY LAST UPDATED 200308121338Z ORGANIZATION FieldServer Technologies CONTACT INFO info fieldserver com DESCRIP...
Страница 24: ...he trap description on the trap origin Style3 defines the parameters contained in each trap and assigns these parameters hard coded OID s which are fixed for all traps In Style 1 and 2 the parameters are not reported in the MIB file and the parameter OID s are based on the trap OID Thus style 3 changes the structure and data of the MIB from Style1 2 Trap reporting Style Style 1 Style 2 Style 3 Tra...
Страница 25: ...l Page 25 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 Comparison of Style2 to Style3 ...
Страница 26: ...l Page 26 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 Comparison of Style1 to Style3 ...
Страница 27: ...P_TRAP SNMP1 1 0 1 3 6 1 4 1 6347 6 BDC2 D2 SMOKE ALARM DA_N2L1 2 SNMP_TRAP SNMP1 1 0 1 3 6 1 4 1 6347 7 BDC2 D3 SMOKE ALARM DA_N2L1 3 SNMP_TRAP SNMP1 1 0 1 3 6 1 4 1 6347 8 BDC2 D4 SMOKE ALARM DA_N2L1 4 SNMP_TRAP SNMP1 1 0 1 3 6 1 4 1 6347 9 BDC2 D5 SMOKE ALARM DA_N2L1 5 SNMP_TRAP SNMP1 1 0 1 3 6 1 4 1 6347 10 BDC2 D6 SMOKE ALARM DA_N2L1 6 SNMP_TRAP SNMP1 1 0 1 3 6 1 4 1 6347 11 BDC2 D7 SMOKE ALA...
Страница 28: ... ENTERPRISE fieldservertechnologies DESCRIPTION BDC2 D1 SMOKE ALARM 6 bdc2_d2_smoke_alarm TRAP TYPE ENTERPRISE fieldservertechnologies DESCRIPTION BDC2 D2 SMOKE ALARM 7 bdc2_d3_smoke_alarm TRAP TYPE ENTERPRISE fieldservertechnologies DESCRIPTION BDC2 D3 SMOKE ALARM 8 bdc2_d4_smoke_alarm TRAP TYPE ENTERPRISE fieldservertechnologies DESCRIPTION BDC2 D4 SMOKE ALARM 9 bdc2_d5_smoke_alarm TRAP TYPE ENT...
Страница 29: ... offset 2 Based on Cos_Normal 0 7 bdc2_d3_smoke_alarm TRAP TYPE ENTERPRISE fieldservertechnologies DESCRIPTION BDC2 D3 SMOKE ALARM Served from DA DA_N2L1 offset 3 Based on Cos_Normal 0 8 bdc2_d4_smoke_alarm TRAP TYPE ENTERPRISE fieldservertechnologies DESCRIPTION BDC2 D4 SMOKE ALARM Served from DA DA_N2L1 offset 4 Based on Cos_Normal 0 9 bdc2_d5_smoke_alarm TRAP TYPE ENTERPRISE fieldservertechnolo...
Страница 30: ... current state as an String fstTrapParameters 2 bdc2_d1_smoke_alarm TRAP TYPE ENTERPRISE fieldservertechnologies VARIABLES fstTrapasString fstTrapasInt DESCRIPTION BDC2 D1 SMOKE ALARM Served from DA DA_N2L1 offset 1 Based on Cos_Normal 0 6 bdc2_d2_smoke_alarm TRAP TYPE ENTERPRISE fieldservertechnologies VARIABLES fstTrapasString fstTrapasInt DESCRIPTION BDC2 D2 SMOKE ALARM Served from DA DA_N2L1 o...
Страница 31: ...ver Manual Page 31 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 Style3 Traps ...
Страница 32: ...duce 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 delta1 TRAP TYPE ENTERPRISE fieldserver_technologies DESCRIPTION delta1 Served from DA SNMP_DA_1 offset 0 Based on COS_Normal COS_Server_Event with COS_Deadband 1 000000 6 temp_out_of_range TRAP TYPE ENTERPRISE fieldserver_technologie...
Страница 33: ...dserver com Tel 408 262 2299 Fax 408 262 9042 Toll Free 888 509 1970 email support fieldserver com 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 ...
Страница 34: ...nsfer then take a log and call tech Support This message is usually preceded by a message which provides a more specific clue as to why the parse failed 4 SNMP 10 FYI NuDesign MIB File s created Tier d SNMP 10 FYI Custom MIB File s created Tier d SNMP 10 FYI MIB File s created Tier d These messages do not require any corrective action provided that they report what you expected They are printed fo...
Страница 35: ... contains bound variables features not supported by the driver This particular error message is printed when the SNMP message does not begin with 0x30 5 SNMP 24 Err Message length error The SNMP message indicates that a message length is different to the number of bytes received 5 SNMP 25 Err Could not get Request ID The SNMP message number is badly formatted or absent 5 SNMP 26 Could not get Erro...
Страница 36: ... as a SNMP Client you may ignore this message If you have configured the FieldServer is configured as a Server then any attempt by a remote client to walk the FieldServer will fail because there are none of the specially named Data Array s required to respond to the walk Read the notes for Msg 33 SNMP 35 FYI DA SNMP_DA_1 is missing Walk will fail SNMP 36 FYI SNMP_DA_ d is missing Walk will fail SN...
Страница 37: ...reated 8 SNMP 50 Err Found non string data while extracting string Refer to Appendix A 2 The driver is building the search string by extracting data from the trap The search string is built by extracting data from two OID fields which should be formatted as strings A non string has been found To resolve this issue you will need to reconfigure the agent that produced the trap SNMP 51 Err Indexed St...
Страница 38: ...and correct the configuration of the FieldServer or the remote agent that produces the trap SNMP 61 FYI Store Int DA s d value d gen d SNMP 61 FYI Store String DA s d value d The driver is storing data This message is for information only The message tells you where the data was stored It is intended as a debugging tool SNMP 62 Err Unsupported data_type 0x x The driver is storing data but the data...
Страница 39: ...kup store tries to store at an index DA length 3 Counts the number of bytes sent by FS in the form of non COV traps 4 Counts the number of messages sent by FS in the form of non COV traps 5 Counts the number of bytes sent by FS in the form of COV traps 6 Counts the number of messages sent by FS in the form of COV traps 7 Counts the number of bytes sent by FS in the form of polls 8 Counts the numbe...
