FieldServer FS-8704-09 SNMP User Manual

-

Driver Version:

1.03

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

Document Revision: 8

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

2.1.1. Required 3rd Party Hardware................................................................................................... 4

3.

HARDWARE CONNECTIONS ......................................................................................................... 5

3.1.

Hardware Connection Tips / Hints .............................................................................................. 5

4.

CONFIGURING THE FIELDSERVER AS A SNMP CLIENT........................................................... 6

4.1.

Data Arrays/Descriptors .............................................................................................................. 6

4.2.

Client Side Connection Descriptors ............................................................................................ 7

4.3.

Client Side Node Descriptors...................................................................................................... 8

4.4.

Client Side Map Descriptors .......................................................................................................9

4.4.1. FieldServer Related Map Descriptor Parameters ................................................................... 9

4.4.2. Driver Related Map Descriptor Parameters ............................................................................9

4.4.3. Timing Parameters ..................................................................................................................9

4.4.4. Map Descriptor 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.1.3. Receiving SNMP Traps – Storing using a Lookup Table.................................... 15

Appendix A.2. Sending 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

Appendix A.3. MIB File Generation for the SNMP Server/Agent ...................................................... 22

Appendix A.3.1. Customizing the MIB File Header: ...................................................................... 23

Appendix A.4. Controlling how a MIB file reports traps ..................................................................... 24

Appendix A.4.1. Mib_Style_for_Traps' = 'Style2' – Trap Descriptions........................................... 32

APPENDIX B. TROUBLESHOOTING TIPS......................................................................................... 33

Appendix B.1. HP Openview: ............................................................................................................33

APPENDIX C. DRIVER ERROR MESSAGES ..................................................................................... 34

Appendix C.1. Exposing Driver Statistics ..........................................................................................39

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

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 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 can send and receive SNMP traps. The following SNMP data types are
supported:

• INTEGER

• OCTET_STREAM

• TIMER_TICKS

• STRING

The maximum number of traps currently supported is 255.

The FieldServer Enterprise ID is 6347. MIB files are generated automatically from the FieldServer
configuration files. A selection of standard MIB-2 OIDs are supported to allow interaction with popular
Network Management packages.

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

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

2.1.1. Required 3rd Party Hardware

Part # Description

Ethernet 10/100 BaseT hub1

1

Not all FieldServer models support 100BaseT. Consult the appropriate instruction manual for details of

the Ethernet speed supported by specific hardware.

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

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

2. FieldServer as SNMP Client

(3rd Party Client)

(SNMP Client)

TCP/IP Cloud

SCADA

FieldServer

TCP/IP Cloud

3rd

Party

Nodes

(non-SNMP)

Managed Nodes

(SNMP Agents)

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 setting.

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

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 FieldServer to
communicate with a SNMP Agent/Server. Please refer to Appendix A: for a discussion of how to receive
SNMP TRAPS.

4.1. Data Arrays/Descriptors

The configuration file tells the FieldServer about its interfaces, and the routing of 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.

Note that in the tables, * indicates an optional parameter, with the bold legal value being the default.

Section Title

Data_Arrays

Column Title Function Legal Values

Data_Array_Name Provide name for Data Array

Data_Array_Format

Data_Array_Length

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

Provide data format. Each Data Array
can only take on one format.

Number of Data Objects. Must be
larger than the data storage area
required by the map descriptors for the
data being placed in this array.

Up to 15 alphanumeric
characters
Float, Bit, UInt16, SInt16,
Packed_Bit, Byte,
Packed_Byte,
Swapped_Byte

1-10,000

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

FS-8704-09 SNMP Driver Manual Page 7 of 39

4.2. Client Side Connection Descriptors

Section Title

Adapter

Column Title Function Legal Values

Adapter Adapter Name N1, N22
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.

Length_Encode_Method

SNMP_Community*

Example

// Client Side Connections

Adapters
Adapter, Protocol, Length_Encode_Method
N1, SNMP, 1

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.
This parameter can be configured if it is required that
“Community” be a different name in order to receive
traps.

0 (default),

1

Any string up to
255 characters,

Public

2

Not all ports shown are necessarily supported by the hardware. Consult the appropriate Instruction

manual for details of the ports available on specific hardware.

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

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

Node_ID*

Protocol Specify protocol used SNMP
Adapter Specify network adapter N1, N22

IP_Address

MIB_Style

MIB_Style_for_Traps

Do_not_MIB_this_Node

SNMP_Read_Method*

Example

// Client Side Nodes

Nodes
Node_Name, Node_ID, Protocol, Adapter, IP_Address, SNMP_Read_Method
Agent 1, 1, SNMP, N1, 192.168.1.174, Walk

Identifies Node; needed only if Node Online/Offline
monitoring is used.

IP Address of remote Agent. Refer to Appendix A.1
for more information.

Controls how MIB file is formatted. Refer to
Appendix A.3 for more info.

Controls how traps are reported in MIB file. Refer to
Appendix A.3 for more info.
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 the MIB file. Review the example
MIB files and configuration file in Appendix A.3.
0 – Node’s traps contribute to MIB File.
1 – Node’s traps do not contribute to MIB file.
If this parameter is set it is possible for the
FieldServer to sequentially read (walk) the SNMP
Server in the same way as the snmpwalk parameter
works on SNMP.

alphanumeric
characters

1-255

Legal 4 byte IP
address on the
same subnet.
‘Standard’;
‘Custom’;
‘NuDesign’
Style1; Style2;
Style3

0; 1

Walk, -

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

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

Data_Array_Name

Data_Array_Offset Starting location in Data Array

Function Function of Client Map Descriptor RDBC, WRBC, WRBX

Name of Data Array where data is
to be stored in the FieldServer

One of the Data Array names from
“Data Array” section above
0 to maximum specified in “Data
Array” section above

4.4.2. Driver Related Map Descriptor Parameters

Section Title

Map Descriptors

Column Title Function Legal Values

One of the Node names

Node_Name Name of Node to fetch data from

Length Length of Map Descriptor 1

SNMP_OID Specify the Object ID to be read/written

SNMP_Write_as_Trap

Data_Type

Used to send non COV (Change of
Value) Traps
Used to send non COV Traps. Tells
the Driver to send a trap containing
numeric or Ascii data.

specified in “Client Node
Descriptor” above

Refer to the MIB file of the
particular SNMP Agent

Yes, No

Ascii, numeric

4.4.3. Timing Parameters

Section Title

Map Descriptors

Column Title Function Legal Values

Scan_Interval Rate at which data is polled ≥0.001s

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

Scan_Interval

Specifies how

often to perform

this transaction,

1, 5

1, -

The OID is

in seconds.

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, Length,

Node_Name,

Read functions are

implemented as

SNMP Get Requests.

Write functions are

implemented as

SNMP Set Requests.

Data_Array_Offset, Function,

Data_Array_Name,

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

4.4.4. Map Descriptor Example

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

FS-8704-09 SNMP Driver Manual Page 10 of 39

// Client Side Map Descriptors

Map Descriptors

Map_Descriptor_Name,

A1, DA_AI3, 0, RDBC, Agent 1, 1.3.6.1.4.1.6347.1.1.0,

A2, DA_AI3, 1, WRBX, Agent 1, 1.3.6.1.4.1.6347.1.1.0,

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 configuring the FieldServer to
communicate with a SNMP Client such as a Network Management application. Please refer to Appendix
A: for a discussion of how to configure SNMP TRAPS.

The configuration file tells the FieldServer about its interfaces, and the routing of 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 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 naming convention is used to map FieldServer Data Arrays into the SNMP OID
addressing scheme. Any data arrays that are to be visible via SNMP have to be named 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 and 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 corresponding
entries in the automatically generated MIB file would appear as shown below.

SNMP_DA_1 appears in the MIB thus:

dataArray1 OBJECT IDENTIFIER ::= { snmp_server_v1_00a 1 }

The first data value in SNMP_DA_1 appears in the MIB thus (note Integer Data Type):

dataValue1_0 OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Data value."
::= { dataArray1 0 }

The resulting OID for this data value is 1.3.6.1.4.1.6347.1.1.0.

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

FS-8704-09 SNMP Driver Manual Page 12 of 39

5.2. Server Side Connection Descriptors

Section Title

Adapter

Column Title Function Legal Values

Adapter Adapter Name N1, N23
Protocol Specify protocol used SNMP

This parameter can be

SNMP_Community*

Example

// Server Side Connections

Adapters
Adapter, Protocol
N1, SNMP

configured if it is required that
“Community” be a different name
in order to receive traps.

Any string up to 255 characters,

Public

5.3. Server Side Node Descriptors

Section Title

Nodes

Column Title Function Legal Values

Node_Name Provide name for Node

Protocol Specify protocol used SNMP

Example

// Server Side Nodes

Nodes
Node_Name, Protocol
Agent 1, SNMP

Up to 32 alphanumeric
characters

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 OID addressing scheme follows the method outlined in
Section 5.1 above. Server Side Map Descriptors are required to configure SNMP TRAPS as outlined
in Appendix A.

Scaling on Client side is per normal model but on Server side, normal model only applies if a Map
Descriptor is used.

3

Not all ports shown are necessarily supported by the hardware. Consult the appropriate Instruction

manual for details of the ports available on specific hardware.

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]