FieldServer FS-8704-09 SNMP Release note

-
A Sierra Monitor Company
APPLICABILITY & EFFECTIVITY
Effective for all systems manufactured after Septem er 2008
Driver Manual
(Supplement to the FieldServer Instruction Manual)
FS-8704-09 SNMP Version 1
Driver Version:
1.03
Document Revision: 8

FS-8704-09 SNMP Driver Manual Ta le of Contents
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA We : www.fiel server.com
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fiel server.com
TABLE OF CONTENTS
1. SNMP DESCRIPTION ...................................................................................................................... 3
2. DRIVER SCOPE OF SUPPLY.......................................................................................................... 4
2.1. Supplie by Fiel Server Technologies for this river .................................................................4
2.1.1. Required 3
rd
Party Hardware................................................................................................... 4
3. HARDWARE CONNECTIONS ......................................................................................................... 5
3.1. Har ware Connection Tips / Hints .............................................................................................. 5
4. CONFIGURING THE FIELDSERVER AS A SNMP CLIENT ...........................................................6
4.1. Data Arrays/Descriptors .............................................................................................................. 6
4.2. Client Si e Connection Descriptors ............................................................................................ 7
4.3. Client Si e No e Descriptors......................................................................................................8
4.4. Client Si e Map Descriptors ....................................................................................................... 9
4.4.1. FieldServer Related Map Descriptor Parameters ................................................................... 9
4.4.2. Driver Related Map Descriptor Parameters ............................................................................ 9
4.4.3. iming Parameters ..................................................................................................................9
4.4.4. Map Descriptor Example ....................................................................................................... 10
5. CONFIGURING THE FIELDSERVER AS A SNMP SERVER/AGENT ......................................... 11
5.1. Server Si e Data Arrays ........................................................................................................... 11
5.2. Server Si e Connection Descriptors......................................................................................... 12
5.3. Server Si e No e Descriptors .................................................................................................. 12
5.4. Server Si e Map Descriptors .................................................................................................... 12
APPENDIX A. ADVANCED TOPICS....................................................................................................13
Appen ix A.1. Receiving SNMP TRAPS ........................................................................................... 13
Appendix A.1.1. rap Source IP Address ...................................................................................... 13
Appendix A.1.2. Receiving SNMP RAPs using the SNMP Client ...............................................14
Appendix A.1.3. Receiving SNMP raps – Storing using a Lookup able.................................... 15
Appen ix A.2. Sen ing SNMP TRAPS using the SNMP Server/Agent ............................................18
Appendix A.2.1. COV Map Descriptor Example ............................................................................ 19
Appendix A.2.2. Polling for Integer bound Data............................................................................. 20
Appen ix A.3. MIB File Generation for the SNMP Server/Agent ...................................................... 22
Appendix A.3.1. Customizing the MIB File Header: ...................................................................... 23
Appen ix A.4. Controlling how a MIB file reports traps ..................................................................... 24
Appendix A.4.1. Mib_Style_for_ raps' = 'Style2' – rap Descriptions........................................... 32
APPENDIX B. TROUBLESHOOTING TIPS......................................................................................... 33
Appen ix B.1. HP Openview: ............................................................................................................33
APPENDIX C. DRIVER ERROR MESSAGES ..................................................................................... 34
Appen ix C.1. Exposing Driver Statistics ..........................................................................................39

FS-8704-09 SNMP Driver Manual Page 3 of 39
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA We : www.fiel server.com
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fiel server.com
1. SNMP Description
The SNMP river allows the Fiel Server to transfer ata to an from evices over Ethernet using the
SNMP version 1 protocol. The Fiel Server can emulate either a Server (SNMP Agent) or Client.
Max Nodes Supported:
FieldServer Mode Nodes Comments
Client 25 Each No e is specifie by a unique IP a ress
Server 1 As a Server the SNMP river can act as a single No e only
The Client can be configure to rea values specifie by their SNMP Object I entifiers (OID’s), which are
efine in the MIB file (Management Information Base) of the target evice. When acting as an SNMP
Agent (Server), the river makes the contents of specifie integer ata arrays available to any SNMP
Client. The Fiel Server MIB file sets out the OIDs to use.
The current version of the river can sen an receive SNMP traps. The following SNMP ata types are
supporte :
• INTEGER
• OCTET_STREAM
• TIMER_TICKS
• STRING
The maximum number of traps currently supporte is 255.
The Fiel Server Enterprise ID is 6347. MIB files are generate automatically from the Fiel Server
configuration files. A selection of stan ar MIB-2 OIDs are supporte to allow interaction with popular
Network Management packages.

FS-8704-09 SNMP Driver Manual Page 4 of 39
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA We : www.fiel server.com
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fiel server.com
2. Driver Scope of Supply
2.1. Supplied y 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 3
rd
Party Hardware
Part # Description
Ethernet 10/100 BaseT hub
1
1
Not all Fiel Server mo els support 100BaseT. Consult the appropriate instruction manual for etails of
the Ethernet spee supporte by specific har ware.

FS-8704-09 SNMP Driver Manual Page 5 of 39
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA We : www.fiel server.com
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fiel server.com
3. Hardware Connections
The Fiel Server is connecte to the Ethernet using the UTP cable supplie . Two typical har ware
configurations are shown below:
1. FieldServer as SNMP Agent (Server)
2. FieldServer as SNMP Client
3.1. Hardware Connection Tips / Hints
The Fiel Server utility program Ruinet will connect to the Fiel Server even if the Netmask setting on
the PC iffers from the setting on the Fiel Server. SNMP will only work between No es for which
these settings correspon , however, thus all No es require to communicate using SNMP must have
the same Netmask setting.
Network Management
Station
Fiel Server SNMP
Agent/Server
TCP/IP Clou
3
r
Party No es
(non-SNMP)
Fiel Server
(SNMP Client)
TCP/IP Clou
Manage No es
(SNMP Agents)
SCADA
(3
r
Party Client)

FS-8704-09 SNMP Driver Manual Page 6 of 39
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA We : www.fiel server.com
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fiel server.com
4. Configuring the FieldServer as a SNMP Client
For a etaile iscussion on Fiel Server configuration, please refer to the Fiel Server Configuration
manual. The information that follows escribes how to expan upon the factory efaults provi e in the
configuration files inclu e with the Fiel Server (See “.csv” sample files provi e with the Fiel Server).
This section ocuments an escribes the parameters necessary for configuring the Fiel Server to
communicate with a SNMP Agent/Server. Please refer to Appen ix A: for a iscussion of how to receive
SNMP TRAPS.
4.1. Data Arrays/Descriptors
The configuration file tells the Fiel Server about its interfaces, an the routing of ata require . In
or er to enable the Fiel Server for SNMP communications, the river in epen ent Fiel Server
buffers nee to be eclare in the “Data Arrays” section, the estination evice a resses nee to be
eclare in the “Client Si e No es” section, an the ata require from the servers nee s to be
mappe in the “Client Si e Map Descriptors” section. Details on how to o this can be foun below.
Note that in the tables, * in icates an optional parameter, with the bol legal value being the efault.
Section Title
Data_Arrays
Column Title Function Legal Values
Data_Array_Name Provi e name for Data Array Up to 15 alphanumeric
characters
Data_Array_Format Provi e ata format. Each Data Array
can only take on one format.
Float, Bit, UInt16, SInt16,
Packe _Bit, Byte,
Packe _Byte,
Swappe _Byte
Data_Array_Length
Number of Data Objects. Must be
larger than the ata storage area
require by the map escriptors for the
ata being place in this array.
1-10,000
Example
// Data Arrays
Data_Arrays
Data_Array_Name, Data_Format, Data_Array_Length
DA_AI_01, UInt16, 200
DA_AO_01, UInt16, 200
DA_DI_01, Bit, 200
DA_DO_01, Bit, 200

FS-8704-09 SNMP Driver Manual Page 7 of 39
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA We : www.fiel server.com
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fiel server.com
4.2. Client Side Connection Descriptors
Section Title
A apter
Column Title Function Legal Values
A apter A apter Name N1, N2
2
Protocol Specify protocol use SNMP
Length_Enco e_Metho
If this parameter is omitte or set to 0 the short form of
enco ing length will be use . If the parameter is set to
1 (an the Length is ≤ 127) the long form of enco ing
length will be use . For Length >127 short form will
be use regar less of the setting.
Long form: an extra byte will be inserte to in icate
the number of following bytes which in icates the
length of the following section in message.
Short form: only length value will be inserte .
0 (default),
1
SNMP_Community*
This parameter can be configure if it is require that
“Community” be a ifferent name in or er to receive
traps.
Any string up to
255 characters,
Pu lic
Example
// Client Si e Connections
A apters
A apter, Protocol, Length_Enco e_Metho
N1, SNMP, 1
2
Not all ports shown are necessarily supporte by the har ware. Consult the appropriate Instruction
manual for etails of the ports available on specific har ware.

FS-8704-09 SNMP Driver Manual Page 8 of 39
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA We : www.fiel server.com
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fiel server.com
4.3. Client Side Node Descriptors
Section Title
No es
Column Title Function Legal Values
No e_Name Provi e name for No e
Up to 32
alphanumeric
characters
No e_ID* I entifies No e; nee e only if No e Online/Offline
monitoring is use . 1-255
Protocol Specify protocol use SNMP
A apter Specify network a apter N1, N2
2
IP_A ress IP A ress of remote Agent. Refer to Appen ix A.1
for more information.
Legal 4 byte IP
a ress on the
same subnet.
MIB_Style Controls how MIB file is formatte . Refer to
Appen ix A.3 for more info.
‘Standard’;
‘Custom’;
‘NuDesign’
MIB_Style_for_Traps Controls how traps are reporte in MIB file. Refer to
Appen ix A.3 for more info.
Style1; Style2;
Style3
Do_not_MIB_this_No e
Controls whether a No e’s traps contribute to the
MIB file. Where uplicate traps are sent to more
than one No e, secon an subsequent No es will
not contribute to the MIB file. Review the example
MIB files an configuration file in Appen ix A.3.
0 – No e’s traps contribute to MIB File.
1 – No e’s traps o not contribute to MIB file.
0; 1
SNMP_Rea _Metho *
If this parameter is set it is possible for the
Fiel Server to sequentially rea (walk) the SNMP
Server in the same way as the snmpwalk parameter
works on SNMP.
Walk, -
Example
// Client Si e No es
No es
No e_Name, No e_ID, Protocol, A apter, IP_A ress, SNMP_Rea _Metho
Agent 1, 1, SNMP, N1, 192.168.1.174, Walk

FS-8704-09 SNMP Driver Manual Page 9 of 39
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA We : www.fiel server.com
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fiel server.com
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
Data_Array_Name Name of Data Array where ata is
to be store in the Fiel Server
One of the Data Array names from
“Data Array” section above
Data_Array_Offset Starting location in Data Array 0 to maximum specifie 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
No e_Name Name of No e to fetch ata from
One of the No e names
specifie in “Client No e
Descriptor” above
Length Length of Map Descriptor 1
SNMP_OID Specify the Object ID to be rea /written Refer to the MIB file of the
particular SNMP Agent
SNMP_Write_as_Trap
Use to sen non COV (Change of
Value) Traps Yes, No
Data_Type
Use to sen non COV Traps. Tells
the Driver to sen a trap containing
numeric or Ascii ata.
Ascii, numeric
4.4.3. Timing Parameters
Section Title
Map Descriptors
Column Title Function Legal Values
Scan_Interval Rate at which ata is polle ≥0.001s

FS-8704-09 SNMP Driver Manual Page 10 of 39
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA We : www.fiel server.com
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fiel server.com
4.4.4. Map Descriptor Example
// Client Si e Map Descriptors Map Descriptors Map_Descriptor_Name,
Data_Array_Name,
Data_Array_Offset, Function,
No e_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, -
The Data Array to which the Rea Data will be store , or from which Write Data will be fetche , at the location specifie by Data_Array_Offset
Rea functions are implemente as SNMP Get Requests. Write functions are implemente as SNMP Set Requests.
The OID is erive from the MIB file of the No e you are talking to. It is easiest to loa the MIB file in a MIB browser (e.g. MG-Soft) which converts the text name to the OID format
Specifies how often to perform this transaction, in secon s.

FS-8704-09 SNMP Driver Manual Page 11 of 39
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA We : www.fiel server.com
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fiel server.com
5. Configuring the FieldServer as a SNMP Server/Agent
For a etaile iscussion on Fiel Server configuration, please refer to the Fiel Server Configuration
Manual. The information that follows escribes how to expan upon the factory efaults provi e in the
configuration files inclu e with the Fiel Server. (See “.csv” sample files provi e with the Fiel Server).
This section ocuments an escribes the parameters necessary for configuring the Fiel Server to
communicate with a SNMP Client such as a Network Management application. Please refer to Appen ix
A: for a iscussion of how to configure SNMP TRAPS.
The configuration file tells the Fiel Server about its interfaces, an the routing of ata require . In or er to
enable the Fiel Server for SNMP communications, the river in epen ent Fiel Server buffers nee to be
eclare in the “Data Arrays” section, the Fiel Server virtual No e(s) nee s to be eclare in the “Server
Si e No es” section, an the ata to be provi e to the clients nee s to be mappe in the “Server Si e
Map Descriptors” section. Details on how to o this can be foun below.
Note that in the tables, * in icates an optional parameter, with the old legal value being the efault.
5.1. Server Side Data Arrays
A special Data Array naming convention is use to map Fiel Server Data Arrays into the SNMP OID
a ressing scheme. Any ata arrays that are to be visible via SNMP have to be name in the
following way:
Data_Arrays
Data_Array_Name, Data_Format, Data_Array_Length
SNMP_DA_1, Int, 20
SNMP_DA_2, Float, 20
The Data_Format an Data_Array_Length may be freely chosen, but the name has to be in the
format SNMP_DA_x, where x is sequential from one Data Array to the next. The correspon ing
entries in the automatically generate MIB file woul appear as shown below.
SNMP_DA_1 appears in the MIB thus:
ataArray1 OBJECT IDENTIFIER ::= { snmp_server_v1_00a 1 }
The first ata value in SNMP_DA_1 appears in the MIB thus (note Integer Data Type):
ataValue1_0 OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS rea -write
STATUS current
DESCRIPTION
"Data value."
::= { ataArray1 0 }
The resulting OID for this ata value is 1.3.6.1.4.1.6347.1.1.0.

FS-8704-09 SNMP Driver Manual Page 12 of 39
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA We : www.fiel server.com
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fiel server.com
5.2. Server Side Connection Descriptors
Section Title
A apter
Column Title Function Legal Values
A apter A apter Name N1, N2
3
Protocol Specify protocol use SNMP
SNMP_Community*
This parameter can be
configure if it is require that
“Community” be a ifferent name
in or er to receive traps.
Any string up to 255 characters,
Pu lic
Example
// Server Si e Connections
A apters
A apter, Protocol
N1, SNMP
5.3. Server Side Node Descriptors
Section Title
No es
Column Title Function Legal Values
No e_Name Provi e name for No e Up to 32 alphanumeric
characters
Protocol Specify protocol use SNMP
Example
// Server Si e No es
No es
No e_Name, Protocol
Agent 1, SNMP
5.4. Server Side Map Descriptors
No Server Si e Map Descriptors are require by SNMP for Get or Set requests, since the mapping of
Fiel Server Data Arrays into the SNMP OID a ressing scheme follows the metho outline in
Section 5.1 above. Server Si e Map Descriptors are require to configure SNMP TRAPS as outline
in Appen ix A.
Scaling on Client si e is per normal mo el but on Server si e, normal mo el only applies if a Map
Descriptor is use .
3
Not all ports shown are necessarily supporte by the har ware. Consult the appropriate Instruction
manual for etails of the ports available on specific har ware.

FS-8704-09 SNMP Driver Manual Page 13 of 39
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA We : www.fiel server.com
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fiel server.com
Appendix A. Advanced Topics
Appendix A.1. Receiving SNMP TRAPS
A trap can reveal the causal event in two ways:
• The cause can be in icate by the OID number insi e the trap with the event state reporte by
the associate ata value.
• The cause can be in icate by the value of one OID fiel an the event state by the value of
another OID fiel .
Appendix A.1.1. Trap Source IP Address
When a trap is receive it contains its source IP a ress information within the UDP packet
hea er. It is possible for a trap to reveal its source IP a ress by co ing an IP_ADDRESS fiel
insi e the trap.
To catch a trap it is necessary to efine Map Descriptors containing the OID’s of the trap. Map
Descriptors are associate with a No e. A No e is efine by its IP a ress amongst other
parameters. When a trap is receive the source of the IP a ress must match the IP a ress of
the No e associate with the Map Descriptor.
A trap may originate from one IP a ress, an contain an alternative source IP A ress within the
message. In this case, the Fiel Server will use the IP_A ress containe within the message as
the source rather than the IP a ress of the sen ing evice. When this situation occurs the river
prints a message to the error log so that you know why, perhaps, the trap was ignore /processe
ifferently from your expectations."

FS-8704-09 SNMP Driver Manual Page 14 of 39
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA We : www.fiel server.com
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fiel server.com
Appendix A.1.2. Receiving SNMP TRAPs using the SNMP Client In or er to receive Traps, the SNMP Client requires a Map Descriptor to be configure for each OID that is to be up ate via a Trap. Note that a single Trap message may contain multiple OID’s, epen ing 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 Si e Map Descriptors Map Descriptors Map_Descriptor_Name, Data_Array_Name, Data_Array_Offset, Function, No e_Name, SNMP_OID
A1, DA_AI3, 0, Passive_Client, Agent 1, 1.3.6.1.4.1.6347.1.1.0, A2, DA_AI3, 1, Passive_Client, Agent 1, 1.3.6.1.4.1.6347.1.1.1,
The OID specifies the value that will be store by this Map Descriptor following a TRAP up ate.
Traps can only be receive by Map Descriptors with the Function set to Passive_Client.

FS-8704-09 SNMP Driver Manual Page 15 of 39
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA We : www.fiel server.com
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fiel server.com
Appendix A.1.3. Receiving SNMP Traps – Storing using a Lookup Ta le Some evices sen trap messages with the same OID’s irrespective of the causal events. The OID contents provi e event specific information such as event origin an state. Consi er a trap containing 3 OID’s. One has an integer value (event state) an the other two have strings reporting the event source. The SNMP river is capable of using the two string OID’s to form a search string to search a lookup table. The river uses the in ex value associate with a matching entry to etermine a Data Array location to store the event state. Thus a single trap message can be use to populate a Data Array in such a way that the location in the DA in icates the event source an the value foun at that location in icates the event state.
Example:
In the trap below ; • 1.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 i entifier of the event source
• 1.3.6.1.4.1.290.3.0 contains the 2
n
part of i entifier of the event source
When configure correctly the river will concatenate the values of the two source OID’s to form a search string for a lookup table. An offset value extracte from a matching entry is use to etermine the location to store the event state value.
The example below illustrates how to configure the Fiel Server to achieve this:
Simple Network Management Protocol Version: 1 (0) Community: public PDU type: RAP-V1 (4) Enterprise: 1.3.6.1.4.1.290 (SNMPv2-SMI::enterprises.290) Agent address: 10.32.6.3 (10.32.6.3) rap type: EN ERPRISE SPECIFIC (6) Specific trap type: 70000000 imestamp: 0 Object identifier 1: 1.3.6.1.4.1.290.1.0 (SNMPv2-SMI::enterprises.290.1.0) Value: IN EGER: 4 Object identifier 2: 1.3.6.1.4.1.290.2.0 (SNMPv2-SMI::enterprises.290.2.0) Value: S RING: "CROSS WN_KDA" Object identifier 3: 1.3.6.1.4.1.290.3.0 (SNMPv2-SMI::enterprises.290.3.0) Value: S RING: "EMS_84_900MHZ_RADIO_B" Object identifier 4: 1.3.6.1.4.1.290.4.0 (SNMPv2-SMI::enterprises.290.4.0) Value: S RING: "EMS 84 900MHZ RADIO B" Object identifier 5: 1.3.6.1.4.1.290.5.0 (SNMPv2-SMI::enterprises.290.5.0)
Value: IN EGER: 0

FS-8704-09 SNMP Driver Manual Page 16 of 39
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA We : www.fiel server.com
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fiel server.com
Step 1: Define the Lookup Ta le
The river loa s the table into memory an uses it when a new trap is receive . If the search string is forme by concatenating two OID Sting fiel s then the river places a colon, thus a colon shoul be place between the two substrings. If the search string forme from the
trap contents oes not match an entry in the table the river prints a message in the error log at an offset of zero. For this reason you cannot use a value of zero for the parameter calle ‘SNMP_Lookup_Table_Offset’. In the configuration file create a Driver Table section.
Driver_Table SNMP_Lookup_Table_Offset, SNMP_Lookup_Table_String, Protocol 1, San hill_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 hol a maximum of 200 entries. • Each string entry can be a maximum of 59 characters.
• When the river searches the table looking for a match it ignores the case of the entries.
Storage Offset: If the lookup string matches a row in the table then the value of the parameter calle ‘SNMP_Lookup_Table_Offset’ is use as an offset into the Data Array Do not use values of zero. Take care to ensure that the offset will not result in an offset that is beyon the en of the Data
Array.
Lookup String: The String contents of up to two OID’s are concatenate to form a search string. Place a colon ‘:’ between each part of the search string if two OID’s are use to form the string. Searches are case insensitive

FS-8704-09 SNMP Driver Manual Page 17 of 39
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA We : www.fiel server.com
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fiel server.com
Step 2 : Create a Map Descriptor (MD) to catch the Trap
Pay special consi eration to the following parameters; • SNMP_OID: Specify the OID of the event state. The fiel must contain an integer value which is the value that will be store . When
the trap is receive the river extracts the contents an takes the 1
st
OID in the message an looks for a MD whose ‘SNMP_OID’
matches. If it oesn’t fin one then the trap is iscar e .
• SNMP_Trap_Store_Metho : Set the value of this parameter to ‘Lookup’. This tells the river to use the lookup table an also to use
the following two parameters;
o SNMP_OID_In ex1: Specify the OID of the fiel that contains the 1
st
part of the search/lookup string. Once the river sees
that a ‘Lookup’ store is to be one it extracts the string contents of this OID to form the 1
st
part of the search string.
o SNMP_OID_In ex2: Specify the OID of the fiel that contains the 2n part of the search/lookup string. Once the river sees
that a ‘Lookup’ store is to be one it extracts the string contents of this OID to form the search string by a ing a colon to the 1
st
part an then appen ing the string foun in this OID.
Map_Descriptor_Name, Data_Array_Name, Data_Array_Offset, Function, No e_Name, SNMP_OID, SNMP_Trap_Store_Metho , SNMP_OID_In ex1, SNMP_OID_In ex2 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 eco e SNMP trap message shown above in this section. • Driver receives trap an starts extracting ata from the message
• Driver fin s OID= 1.3.6.1.4.1.290.1, extracts the Integer value=4 an searches for an MD with SNMP_OID= 1.3.6.1.4.1.290.1
• The MD specifying Storage Metho =Lookup an Data Array Name = DA_TRAPS is foun . (If not foun , the message is iscar e .)
• Driver fin s IOD = 1.3.6.1.4.1.290.2 an extracts a string = CROSSTWN_KDA
• Driver compares the extracte OID to the OID specifie by ‘SNMP_OID_In ex1’. If it matches then it forms the 1st fragment of the
search string, otherwise the river continues extracting OID’s from the trap.
• Driver fin s IOD = 1.3.6.1.4.1.290.3 an extracts a string = EMS_84_900MHZ_RADIO_B
• Driver compares the extracte OID to the OID specifie by ‘SNMP_OID_In ex2’. If it matches then it forms the 2n fragment of the
search string, otherwise the river continues extracting OID’s from the trap.
• Once a complete search string is forme , the river starts searching the lookup table efine in step1. The search is case insensitive.
A match is ma e with offset 3 an the river stores the value 4 at offset 3 in DA_TRAPS. (If the search fails – there is no matching
entry then the river uses offset zero). The offsets are relative to the offset specifie by ‘Data_Array_Offset’.

FS-8704-09 SNMP Driver Manual Page 18 of 39
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA We : www.fiel server.com
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fiel server.com
Appendix A.2. Sending SNMP TRAPS using the SNMP Server/Agent
There are two ways to sen traps using the river • A rule base appoach – COV (Change of Value): Driver watches a ata point. If the ata changes an meets the con ition of some rule then
the trap is generate .
• Non-rule – Driver sen s the trap uncon ionally base on a time interval or whenever the source ata point is u pate (even if there is no
change.)
Change of Value (COV) Traps
Rules etermine when to sen an SNMP Trap. These rules are configure in Server Si e Map Descriptors, an are applie to the ata whenever it changes. Traps are sent on a Change of State (COS) of the relevant Data Array value, as etermine by the following configurable criteria:
COS_Hi_Alm High Alarm threshol , applies to numerical values COS_Hi_Warning
High Warning threshol , applies to numerical values
COS_Lo_Warning
Low Warning threshol , applies to numerical values
COS_Lo_Alm Low Alarm threshol , applies to numerical values COS_Dea ban Dea ban value which must be crosse for Alarm or Warning states to toggle (prevents chatter)
COS_Normal Normal value for a igital 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' an then specify the ea ban . Each time the the analog value changes by at the ea ban or more (absolute change) then a trap will be sent
Each Trap Map Descriptor must specify the estination of the Trap by configuring a Remote_Client_No e_Descriptor, as shown in the example below. The OID to which the ata value is to be boun in the Trap message is specifie in the Map Descriptor.
First, the Trap estination No e is set up as follows:
Remote_Client_No e_Descriptors No e_Name,
No e_ID,
Protocol, A apter,
IP_A ress
NM_1, 1, SNMP, N1, 192.168.1.174 The Trap Map Descriptors are then configure as below, using the esire COS rule parameters: // Server Si e Map Descriptors Map_Descriptors Map_Descriptor_Name, Data_Array_Name, Data_Array_Offset, Function, No e_Name, SNMP_OID, COS_Hi_Alm, COS_Lo_Alm, COS_Dea ban PSU_Voltage_Alarm, DA_AI3, 0, SNMP_TRAP, NM_1, 1.3.6.1.4.1.6347.1.1.0.0, 10.5, 7.3, 0.2

FS-8704-09 SNMP Driver Manual Page 19 of 39
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA We : www.fiel server.com
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fiel server.com
Appendix A.2.1. COV Map Descriptor Example
In this example each time the value foun in Data Array 'DA_AI3' at offset 0 changes by at least 0.2 (COS_Dea ban ) then a trap will be sent. // Server Si e Map Descriptors Map_Descriptors Map_Descriptor_Name, Data_Array_Name, Data_Array_Offset, Function, No e_Name, SNMP_OID, COS_Normal, COS_Dea ban PSU_Voltage_Alarm, DA_AI3, 0, SNMP_TRAP, NM_1, 1.3.6.1.4.1.6347.1.1.0.0, COS_Server_Event, 0.2 Content of Trap Messages:
Each trap has 3 OID's. THE OID of the trap itself an OID of the two boun variables (the payloa ). Systems that use traps are typically set up to
watch for OID's in the payloa s an the Trap’s OID is therefore not relevant. The river allocates trap OID's as follows: The 1st trap foun in the configuration file is allocate OID=1.3.6.1.4.1.6347.6.6. Subsequent traps are allocate ...6347.6.7 ...6347.6.8 etc. Each COS trap contains two boun variables. The first boun variable has its OID equal to the OID specifie in the configuration file. It contains
an Integer reporting the value of the variable at the time the trap is generate . The secon boun variable's OID is etermine by a ing '.0' to the OID specifie in the configuration file. It contains a string reporting the Map Descriptor name (Thus use the variable/tag name to name the Map Descriptor) an a short report on the event type. The following are possible escriptions; Status: HI ALARM Status: HI WARNING Status: LO ALARM Status: LO WARNING Status: ALARM Status: DELTA EVENT Status: NORMAL The actual states that can be reporte epen on the COS states efine in the MD's e.g. Where a Map Descriptor has COS_Normal efine then possible states are STATUS: NORMAL STATUS: ALARM e.g. Where a Map Descriptor has COS_Hi_Alm, COS_Lo_Alm efine then possible states are STATUS: NORMAL STATUS: LO ALARM STATUS: HI ALARM

FS-8704-09 SNMP Driver Manual Page 20 of 39
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA We : www.fiel server.com
Tel: [phone] Fax: [phone] Toll Free: [phone] email: support@fiel server.com
Example of a Trap Sent:
In this example the trap was the 1st trap efine 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 vali ation requirements. The configuration file efinition for the trap ha the OID set to
1.3.6.1.4.1.6347.1.1.1.0. When the trap was pro uce the value was 120 an the trap was pro uce because the value was above the Hi Alarm threshol specifie by the COS_HI_Alarm parameter in the configuration file. TrapOID: 1.3.6.1.4.1.6347.6.6 (Generic Trap 6 (enterprise), specific trap 6) So most likely from the MIB it woul compile as 1.3.6.1.4.1.6347.0.6 Varbin s: OID Format
Contents
1.3.6.1.4.1.6347.1.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 ound Data
It is possible for the remote SNMP Client to poll for the ata as well as listen for the traps. This is achieve by setting the OID to a value that correspon s to a pollable point in a 'SNMP_DA_xx' Data Array. In the example below, the Data Array name is SNMP_DA_02. This means that its points can be polle by polling for 1.3.6.1.4.1.6347.1.2.x.0 where x is the offset in the Data Array. When a trap is generate because of the COS event, the integer boun variable gets its OID from the configuration an thus is equal to 1.3.6.1.4.1.6347.1.2.1.0 . This correspon s to the OID for SNMP_DA_2:0 (DA:Offset). Thus if the remote client
wante to poll for the ata as well as listen for the traps it coul poll 1.3.6.1.4.1.6347.1.2.1.0 an it woul be serve the same ata as containe in the integer boun variable. Example:
Map_Descriptors Map_Descriptor_Name,
Data_Array_Name,
Data_Array_Offset, Function, No e_Name,
SNMP_OID, COS_Normal
WaterHA, SNMP_DA_2, 01, SNMP_TRAP,
Trap_1, 1.3.6.1.4.1.6347.1.2.1.0,
0