-
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.03
8
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
Server
25
1
Each Node is specified by a unique IP address
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.
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 #
FS-8915-10
FS-8704-09
Description
Ethernet cable, 7 foot, RJ45
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.
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
3rd Party Nodes
(non-SNMP)
2. FieldServer as SNMP Client
SCADA
(3rd Party Client)
Managed Nodes
(SNMP Agents)
TCP/IP Cloud
FieldServer
(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 setting.
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
Up to 15 alphanumeric
characters
Data_Array_Name
Provide name for Data Array
Float, Bit, UInt16, SInt16,
Provide data format. Each Data Array Packed_Bit,
Byte,
Data_Array_Format
Data_Array_Length
can only take on one format.
Packed_Byte,
Swapped_Byte
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.
1-10,000
Example
// Data Arrays
Data_Arrays
Data_Array_Name,
DA_AI_01,
DA_AO_01,
DA_DI_01,
Data_Format,
UInt16,
UInt16,
Bit,
Data_Array_Length
200
200
200
200
DA_DO_01,
Bit,
FS-8704-09 SNMP Driver Manual
Page 7 of 39
4.2.
Client Side Connection Descriptors
Section Title
Adapter
Column Title
Adapter
Function
Legal Values
N1, N22
Adapter Name
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),
Length_Encode_Method
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 Any string up to
SNMP_Community*
“Community” be a different name in order to receive 255 characters,
traps.
Public
Example
// Client Side Connections
Adapters
Adapter,
N1,
Protocol,
SNMP,
Length_Encode_Method
1
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.
FS-8704-09 SNMP Driver Manual
Page 8 of 39
Legal Values
4.3.
Client Side Node Descriptors
Section Title
Nodes
Column Title
Function
Provide name for Node
Up
to
alphanumeric
characters
32
Node_Name
Identifies Node; needed only if Node Online/Offline
monitoring is used.
Node_ID*
1-255
Protocol
Adapter
Specify protocol used
Specify network adapter
SNMP
N1, N22
Legal 4 byte IP
address on the
same subnet.
‘Standard’;
‘Custom’;
IP Address of remote Agent. Refer to Appendix A.1
for more information.
IP_Address
Controls how MIB file is formatted. Refer to
Appendix A.3 for more info.
MIB_Style
‘NuDesign’
Controls how traps are reported in MIB file. Refer to Style1;
Style2;
MIB_Style_for_Traps
Appendix A.3 for more info.
Style3
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
Do_not_MIB_this_Node not contribute to the MIB file. Review the example 0; 1
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.
SNMP_Read_Method*
Walk, -
Example
// Client Side Nodes
Nodes
Node_Name,
Agent 1,
Node_ID,
1,
Protocol,
SNMP,
Adapter,
N1,
IP_Address,
192.168.1.174,
SNMP_Read_Method
Walk
FS-8704-09 SNMP Driver Manual
Page 9 of 39
4.4.
4.4.1.
Client Side Map Descriptors
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
Starting location in Data Array
Function of Client Map Descriptor
“Data Array” section above
0 to maximum specified in “Data
Array” section above
Data_Array_Offset
Function
RDBC, WRBC, WRBX
4.4.2.
Driver Related Map Descriptor Parameters
Section Title
Map Descriptors
Column Title
Function
Legal Values
One of the Node names
specified in “Client Node
Descriptor” above
Node_Name
Name of Node to fetch data from
Length
Length of Map Descriptor
1
Refer to the MIB file of the
particular SNMP Agent
SNMP_OID
Specify the Object ID to be read/written
Used to send non COV (Change of
Value) Traps
Used to send non COV Traps. Tells
the Driver to send a trap containing Ascii, numeric
numeric or Ascii data.
SNMP_Write_as_Trap
Data_Type
Yes, No
4.4.3.
Timing Parameters
Section Title
Map Descriptors
Column Title
Scan_Interval
Function
Rate at which data is polled
Legal Values
≥0.001s
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,
SNMP_DA_1,
SNMP_DA_2,
Data_Format,
Int,
Float,
Data_Array_Length
20
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.
FS-8704-09 SNMP Driver Manual
Page 12 of 39
5.2.
Server Side Connection Descriptors
Section Title
Adapter
Column Title
Adapter
Function
Adapter Name
Specify protocol used
This parameter
configured if it is required that Any string up to 255 characters,
Legal Values
N1, N23
SNMP
Protocol
can
be
SNMP_Community*
Public
“Community” be a different name
in order to receive traps.
Example
// Server Side Connections
Adapters
Adapter,
N1,
Protocol
SNMP
5.3.
Server Side Node Descriptors
Section Title
Nodes
Column Title
Function
Legal Values
to 32 alphanumeric
characters
Up
Node_Name
Protocol
Provide name for Node
Specify protocol used
SNMP
Example
// Server Side Nodes
Nodes
Node_Name,
Agent 1,
Protocol
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 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.
FS-8704-09 SNMP Driver Manual
Appendix A. Advanced Topics
Page 13 of 39
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 address information 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 IP address of
the Node associated with the Map Descriptor.
A trap may originate from one IP address, and contain an alternative source IP Address within the
message. In this case, the FieldServer will use the IP_Address contained within the message as
the source rather than the IP address of the sending device. When this situation occurs the driver
prints a message to the error log so that you know why, perhaps, the trap was ignored/processed
differently from your expectations."
FS-8704-09 SNMP Driver Manual
Page 22 of 39
Appendix A.3.
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. 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 three options for creating the MIB file.
•
•
•
Standard - this is the same as omitting the parameter
NuDesign the MIB file produced is suitable for compilation by the NuDesign Browser.
Custom - the file MIBhead.ini is used in preparing the MIB file.
Adapters
Adapter,
N1,
Protocol,
SNMP,
MIB_Style
Standard
NuDesign
Custom
FS-8704-09 SNMP Driver Manual
Page 23 of 39
Appendix A.3.1.
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.
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
DESCRIPTION
"FieldServer Technologies"
::= { enterprises 6347 }
snmp_server_v1_00a OBJECT IDENTIFIER ::= { fieldserver_technologies 1 }
dataArray1 OBJECT IDENTIFIER ::= { snmp_server_v1_00a 1 }
dataValue1_0 OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Data value."
::= { dataArray1 0 }
…………………………………… remainder of file omitted from this example …
FS-8704-09 SNMP Driver Manual
Page 24 of 39
Appendix A.4.
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.1s,
MIB_Style_for_Traps
Style1
Permitted Values for the parameter are:
Style1 (Default)
Style2
Style3
Style2 and 3 add information to the 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
Description is the Map
Descriptor Name and also
contains information on the Same as Style 2
data source and the
Description
the
Descriptor
Name
is
Map
Trap
Descriptions.
originating event.
Trap
Parameters
Not defined in
MIB File
Trap Parameters defined in MIB
File.
Same as Style 1
Fixed hard coded trap
parameters.
Based on trap
OID
Two parameters Same as Style 1
Trap
Parameters
OID’s
1.2.6.1.4.1.6347.1.1 (Parameter
contains a string that describes
event)
per trap.
BaseOID.
1.2.6.1.4.1.6347.1.21
(Parameter contains a numeric
that contains data point value).
Comparison of Style1 to Style2
FS-8704-09 SNMP Driver Manual
Page 25 of 39
Comparison of Style2 to Style3
FS-8704-09 SNMP Driver Manual
Page 26 of 39
Comparison of Style1 to Style3
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
DESCRIPTION
"FieldServer Technologies"
::= { enterprises 6347 }
spr5519c OBJECT IDENTIFIER ::= { fieldservertechnologies 1 }
bdc2_d1_smoke_alarm TRAP-TYPE
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
ENTERPRISE fieldservertechnologies
DESCRIPTION
"BDC2 D5 SMOKE ALARM"
::= 10
bdc2_d6_smoke_alarm TRAP-TYPE
ENTERPRISE fieldservertechnologies
DESCRIPTION
"BDC2 D6 SMOKE ALARM"
::= 11
bdc2_d7_smoke_alarm TRAP-TYPE
ENTERPRISE fieldservertechnologies
DESCRIPTION
"BDC2 D7 SMOKE ALARM"
::= 12
bdc2_d8_smoke_alarm TRAP-TYPE
ENTERPRISE fieldservertechnologies
DESCRIPTION
"BDC2 D8 SMOKE ALARM"
::= 13
bdc2_d9_smoke_alarm TRAP-TYPE
ENTERPRISE fieldservertechnologies
DESCRIPTION
"BDC2 D9 SMOKE ALARM"
::= 14
END
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
DESCRIPTION
"FieldServer Technologies"
::= { enterprises 6347 }
spr5519c OBJECT IDENTIFIER ::= { fieldservertechnologies 1 }
bdc2_d1_smoke_alarm TRAP-TYPE
ENTERPRISE fieldservertechnologies
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
DESCRIPTION
"BDC2 D2 SMOKE ALARM Served from DA=DA_N2L1 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 fieldservertechnologies
DESCRIPTION
"BDC2 D5 SMOKE ALARM Served from DA=DA_N2L1 offset=5
Based on Cos_Normal=0 "
::= 10
bdc2_d6_smoke_alarm TRAP-TYPE
ENTERPRISE fieldservertechnologies
DESCRIPTION
"BDC2 D6 SMOKE ALARM Served from DA=DA_N2L1 offset=6
Based on Cos_Normal=0 "
::= 11
bdc2_d7_smoke_alarm TRAP-TYPE
ENTERPRISE fieldservertechnologies
DESCRIPTION
"BDC2 D7 SMOKE ALARM Served from DA=DA_N2L1 offset=7
Based on Cos_Normal=0 "
::= 12
bdc2_d8_smoke_alarm TRAP-TYPE
ENTERPRISE fieldservertechnologies
DESCRIPTION
"BDC2 D8 SMOKE ALARM Served from DA=DA_N2L1 offset=8
Based on Cos_Normal=0 "
::= 13
bdc2_d9_smoke_alarm TRAP-TYPE
ENTERPRISE fieldservertechnologies
DESCRIPTION
"BDC2 D9 SMOKE ALARM Served from DA=DA_N2L1 offset=9
Based on Cos_Normal=0 "
::= 14
END
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
DESCRIPTION
"FieldServer Technologies"
::= { enterprises 6347 }
spr5519c OBJECT IDENTIFIER ::= { fieldservertechnologies 1 }
fstTrapBaseOID OBJECT IDENTIFIER ::= { fieldservertechnologies 6 }
fstTrapParameters OBJECT IDENTIFIER ::= { fstTrapBaseOID 1 }
fstTrapasInt OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS current
DESCRIPTION
"Reports the current state as an Integer."
::={ fstTrapParameters 1 }
fstTrapasString OBJECT-TYPE
SYNTAX OCTET STRING
ACCESS read-only
STATUS current
DESCRIPTION
"Reports the 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 offset=2
Based on Cos_Normal=0 "
::= 7
bdc2_d3_smoke_alarm TRAP-TYPE
ENTERPRISE fieldservertechnologies
VARIABLES { fstTrapasString , fstTrapasInt }
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
VARIABLES { fstTrapasString , fstTrapasInt }
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 fieldservertechnologies
VARIABLES { fstTrapasString , fstTrapasInt }
DESCRIPTION
"BDC2 D5 SMOKE ALARM Served from DA=DA_N2L1 offset=5
Based on Cos_Normal=0 "
::= 10
bdc2_d6_smoke_alarm TRAP-TYPE
ENTERPRISE fieldservertechnologies
VARIABLES { fstTrapasString , fstTrapasInt }
DESCRIPTION
"BDC2 D6 SMOKE ALARM Served from DA=DA_N2L1 offset=6
Based on Cos_Normal=0 "
::= 11
FS-8704-09 SNMP Driver Manual
Style3 Traps
Page 31 of 39
FS-8704-09 SNMP Driver Manual
Page 32 of 39
Appendix A.4.1.
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.
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_technologies
DESCRIPTION
"temp out of range Served from DA=SNMP_DA_1 offset=1
Based on COS_HI_Alarm=4.0000 COS_Deadband=0.0000
Based on Cos_Hi_Warn=3.0000 COS_Deadband=0.0000"
::= 7
FS-8704-09 SNMP Driver Manual
Appendix B. Troubleshooting Tips
Page 33 of 39
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.
FS-8704-09 SNMP Driver Manual
Page 34 of 39
Appendix C. Driver Error Messages
Message
Description/Action
A response from the remote device reports an error. The message
SNMP:#01 Err. Response report is good but inside the message there is a field reporting an error.
err=%d
Consult the vendor for the meaning of the printed SNMP error
number.
The driver found an error in the message structure preventing it from
extracting the SNMP version number. See msg #05 for follow up
actions.
SNMP:#02a/b Err. Could not
read SNMP response version
SNMP:#03a/b
Expected=1 Rcvd=%d
Err.
Version. This driver only supports SNMP version #1. See msg #05 for follow
up actions
SNMP:#04a Err. Extract Int
Failed. Index=%d
SNMP:#04b Err. Expected INT.
Found NULL. Index=%d
The driver is extracting an integer value from the SNMP message
but the field was incorrectly formatted. Formatting can be checked
using Ethreal4
The driver is attempting to process a SNMP message that is not
correctly formatted; contains an error or contains unsupported
SNMP elements. Immediately after the message has been printed
the driver does a hexadecimal dump of the message.
If you see this message rarely and data is being transferred correctly
then ignore it. If it is repeated or affects data transfer 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:#05 Err. Parse Failed.
MD=%s Msg Buffer
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 for confirmation
only.
The configuration has told the driver to build a customized MIB file.
This requires that a file called MIBHead.ini is present on the
FieldServer. Refer to the configuration manual and Appendix A.3 for
more information.
SNMP:#11 Err. Can’t open
MIBHead.ini. Producing std MIB
file
SNMP:#12 Err. Bad MD length - A MD was found where the length was not specified or specified as
defaulting to 1
zero. Specify the length setting it to one. 5
SNMP:#13
number
Err.
TRAP
descriptors exceeded
Max=255
of
map The default maximum number of trap Map Descriptors is 255.
SNMP:#14 Err. SNMP_TRAP
map descriptor must have OID
specified
You must specify the ‘SNMP_OID” parameter on a Map Descriptor
SNMP:#15 Err. Passive_Client used for a trap. Read Appendix A for more information on Traps5
map descriptor must have OID
specified
SNMP:#16
SNMP_Read_Method value: %s ‘walk’Error! Bookmark not defined.
The driver has executed an internal diagnostic. If this message is
printed please call Tech Support.
unknown The only permitted value for the SNMP_Read_Method is
SNMP:#17 Err. Diagnostic 1
4 Refer to Enote 63 on the Website for more information.
5 Edit the configuration file, downloaded the modified file to the FieldServer and restart the FieldServer for
the changes to take effect.
FS-8704-09 SNMP Driver Manual
Page 35 of 39
Message
Description/Action
The IP address for a remote SNMP server (agent) has probably
been incorrectly specified. Check the configuration file.5
The FieldServer cannot reach the specified remote Node. The
message prints the Node name and the IP address. This message is
most commonly printed when:
SNMP:#18 Err. Bad Send IP=%s
SNMP:#19 Err. Can’t send to
Agent/Trap Dest. %s at %s
•
•
The wrong IP address has been specified.
The remote Node is off or in an error state6
The Client side of the driver has received a request. It should only
SNMP:#20
set/get/getnext request
Err.
Received
receive responses.6
SNMP:#21 Err. Bad community The SNMP message contains a badly formatted community string or
string
the community string is absent. Read notes for msg#23
A response to a poll from the FieldServer contains a bound variable
that is not supported or expected. For example an IP_ADDRESS
and OPAQUE variable or a TRAP. Immediately after this message
the driver prints a hex dump of the offending message. Ensure that
the remote SNMP server is correctly configured. Review the Driver
fact Sheet for supported features. If you are confident that the FS
should process the message correctly then capture a log and call
tech Support. 5
SNMP:#22 Err: Cant parse msg:
found %#x at %d
The Server side of the driver has received a message from a SNMP
client which is not correctly formatted or which 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:#23 Err. Invalid Msg
The SNMP message indicates that a message length is different to
SNMP:#24 Err. Message length
error
the number of bytes received. 5
SNMP:#25 Err. Could not get
Request ID
SNMP:#26 Could not get Error
Status
SNMP:#27 Could not get Error
Index
The SNMP message number is badly formatted or absent. 5
The SNMP error status field is badly formatted or absent. 5
The SNMP error id field is badly formatted or absent5
The message header is correctly formatted but as the driver
continues parsing the message it can’t find the bound variables. 6
Immediately after this message the driver prints the value of the
offending OID. The driver can only serve data for configured OID
points.
SNMP:#28
SNMP_TYPE_SEQ
Expected
SNMP:#29
respond to Get Request for OID
ERR.
Couldn’t
The OID must correspond to a FST system OID. 1.3.6.1.4.1.6347
and there must be a data array to serve the point (read Appendix A
for more information). To resolve this problem you will have to
reconfigure the remote client or the FS. 5
The Server side of the FieldServer can discover the IP address of
the source Node from the IP packet header. The source Node IP
address can also be reported inside the SNMP portion of the
Int Ethernet message. This message is pronted if the tow IP addresses
are different and is for information only. The driver uses the IP
address contained in the SNMP portion of the message to locate a
matching Node in the configuration. You may need to edit the
configuration and change the IP address of the Node which sends
SNMP:#30
IP=%d.%d.%d.%d.%d Ext=%s
FYI
6 Edit the configuration file, downloaded the modified file to the FieldServer and restart the FieldServer for
the changes to take effect.
FS-8704-09 SNMP Driver Manual
Page 36 of 39
Message
Description/Action
the traps for the FS to catch the traps. The driver only catches traps
for configured Nodes. 5
The server side of the driver could not complete parsing a message.
SNMP:#31 Err Couldnt parse Immediately after this message the driver prints a hex dump of the
msg: found %#x at %d
offending message. The driver prints this error when the SNMP
message contains a field that is not supported by the driver.7
If the driver is configured as a Server agent then a remote Client
may try and walk the FieldServer. To do this the driver requires one
or more specially named Data Arrays.
DA_SNMP_n where n=1,2,3,4 etc
•
•
DA_SNMP_1 corresponds to 1.3.6.1.4.1.6347.1
1.3.6.1.4.1.6347.1.0 corresponds to the 1st element of
DA_SNMP_1; 1.3.6.1.4.1.6347.1.1 corresponds to the 2nd
element of DA_SNMP_1, etc.
SNMP:#33 Err. Too many DA's
to validate for SNMP. Max=%d
•
•
DA_SNMP_2 corresponds to 1.3.6.1.4.1.6347.2
The length of the DA determines how many OID’s correspond to
each DA.
To allow a walk the FS must, have at least DA_SNMP_1. There is a
maximum limit of 1000 on the number of these DA’s. The DA’s must
be numbered sequentially.Error! Bookmark not defined.
If the FieldServer is configured as a SNMP Client you may ignore
this message, If you have configured the FieldServer is configured
SNMP:#34 FYI. No DA's for walk as a Server then any attempt by a remote client to ‘walk’ the
by remote browser
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
SNMP:#37 FYI. No SNMP DA's Read the notes for Msg #33. There are no DA’s suitable for a walk
for walk by remote browser.
SNMP:#38 FYI. DA names
suitable for walk by remote
browser
by a remote client.
If the FieldServer is configured as a SNMP client, ignore the
message. If the driver is configured as a Server then read MSg #33.
SNMP:#39 FYI. Use an array
called
<%s>
to
expose Read 0
diagnostic info
If you allocate a Node_ID to the SNMP Node it must be a number in
SNMP:#40 Err. Bad Node_ID - the range 1-255 inclusive. The driver has changed the Node_ID to
forcing to 11
11. Node_ID’s are used when Node_Status bits are prepared.
Refer to Enote43 on the FST Web Site.
The driver has rejected a Map Descriptor because the parameter
Undefined called ‘SNMP_Trap_Store_Method’ has been set to indexed/lookup
and the driver requires that the parameter ‘SNMP_OID_Index1’ is
defined. Refer to Appendix A.28
SNMP:#41
SNMP_OID_Index1
Err
SNMP:#42
SNMP_OID_Index2
Err
Undefined The driver has rejected a Map Descriptor because the parameter
called ‘SNMP_Trap_Store_Method’ has been set to indexed/lookup
7 Refer to Enote 63 on the Website for more information
8
Edit the configuration file, download the modified file to the FieldServer and restart the FieldServer for
the changes to take effect
FS-8704-09 SNMP Driver Manual
Page 37 of 39
Message
Description/Action
and the driver requires that the parameter ‘SNMP_OID_Index2’ is
defined. Refer to Appendix A.2
The driver found
a
Map Descriptor parameter heading
SNMP:#43
SNMP_Trap_Store_Method
Err
Undefined
‘SNMP_Trap_Store_Method’ but could not find a value for it.. Refer
to Appendix A.28
The driver found a MD parameter heading ‘SNMP_Write_as_Trap’
but could not find a value for it. Refer to Appendix A.2Refer to
Appendix A.28
The driver found a MD parameter heading ‘SNMP_Read_Method’
but could not find a value for it. Refer to Appendix A.28
Refer to Appendix A.2. When adding entries to the driver lookup
table a duplicate lookup string was found. You probably did not
intend this. 8
SNMP:#44
SNMP_Write_as_Trap
Err
Undefined
Undefined
Duplicate
SNMP:#45 Err.
SNMP_Read_Method
SNMP:#46
state=<%s>
FYI.
SNMP:#47 Err. No space. Driver Refer to Appendix. You are adding entries to the driver lookup table
rejects
value=%d
value
state=<%s> and the driver has run out of space. If you need more entries
contact the FST sales group.
SNMP:#48
FYI.
Added This message is for information only. The driver prints it each time a
state=<%s> value=%d
new entry is added to the lookup table. Refer to Appendix A.2
Refer to Appendix A.2. The driver has been told to store data from a
trap using the lookup method. The search string was extracted from
the trap but a matching entry could not be found in the table. If the
data is required, a new entry for the table will need to be created. 8
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:#49 Err. Cant find lookup
table entry below
SNMP:#50 Err. Found non-string
data while extracting string
Refer to Appendix A.2. The driver is storing data using the lookup
method. The offset into the data Array that corresponds to the
search string points beyond the end of the Data Array. You may
need to increase the length of the Data Array or change the offset
value associated with the search string. 8
SNMP:#51 Err Indexed Store.
Offset too big to store
DAOffset=%d IndexOffset=%d
Off=%d DA=%s Len=%d
This message is for information only. Each time the driver stores
data using the lookup method this message is printed so that you
can see the effect of the trap.
SNMP:#52 FYI. Lookup=%s:%s
Value=%d DA:Off=%s:%d
You are trying to send a trap with Ascii string data but the when the
SNMP:#53 FYI Cant send trap Data Array was inspected for data to form the string it found a zero
with null string. DA=%s Off=%d
in the 1st location and hence it thinks the string is empty. Make sure
the data array has some data to form the string.
SNMP:#54
DIAG_USER_1
Length
Err.
Diagnostic
Bad TRAP
An internal diagnostic has been generated. Take a log and call Tech
Support.9
-
SNMP:#55 Err. Multiple Objects The server can respond to polls for multiple objects in one SNMP
Rquested.
message. Re-configure your SNMP client.
The server has received a poll for data. The polled OID corresponds
SNMP:#56 Err. Needs Data to the named Data Array. The driver can’t find the Data Array. Either
Array with name=%s
reconfigure the remote client to poll for an appropriate point. Read
Appendix A or correct the configuration adding the new Data Array.
9 Refer to Enote 63 on the Website for more information
FS-8704-09 SNMP Driver Manual
Page 38 of 39
Message
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
Data Node is offline and hence the FieldServer cannot update the data. A
SNMP:#57
Err.
offline/expired. DA=%s Off=%d
parameter called ‘Cache_Age_Timeout’ controls how old the data
can be before the FieldServer refuses to serve it. Check the
connection used to obtain the original data.
The server side of the driver has received a message which requires
SNMP:#58 Err. Needs Data data to be stored in the named Data Array but the Data Array cannot
Array with name %
be found. Check the configuration of the FieldServer vs. the
configuration of the remote client.
The server side of the driver has received a message which requires
SNMP:#59 Err. Store index %d data to be stored in the named Data Array at the specified offset.
exceeds Data Array %s length
The Data Array is too short. Check the configuration of the
FieldServer vs. the configuration of the remote client.
Refer to Appendix A.2. The driver is storing data using the lookup
method. The data that is stored is the data associated with the
‘SNMP_OID” parameter in the configuration file. This OID must be
bound to integer data. Check and correct the configuration of the
FieldServer or the remote agent that produces the trap.
SNMP:#60 Err. Index Storage
can only store Integer Values
SNMP:#61
FYI
Store
Int.
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.
DA=%s:%d value=%d gen=%d
SNMP:#61 FYI Store ! String
DA=%s:%d value=%d
The driver is storing data but the data type is not supported. Check
SNMP:#62 Err. Unsupported the Driver fact sheet to see what data types are supported and then
data_type: 0x%x
correct the configuration of the remote client/agent that produced the
trap.
SNMP:#63a Err. Cant open %s
SNMP:#63b FYI. Response was
sent from %s (Hex file)
SNMP:#63b FYI. Response was
sent from %s (Hex file)
These messages should only be printed during the execution of QA
script. If you see this message call tech Support.
SNMP:#63c FYI. Looking for
file=<%s> for response.
Take
a
log including an ethereal log. Then restart the
SNMP:#64 Err. Could not free FieldServer with the log running. If the error is repeated then stop
socket handle %x
the log. If the error doesn't repeat let the log run for 5 minutes and
then stop. Now call Tech support.
If this message is printed, please take a log and contact tech
SNMP:#65a/b Err. Diagnostic 5 - support. The driver has executed a diagnostic that should only occur
Response suppressed.
during factory testing. The a/b in the message indicate the reason
the response was suppressed
This message is for your information only. If it confirms your
SNMP:#66 FYI. Writing traps to expectation then ignore this message. The message is printed each
Mib file using 'style2'
time a MIB file is produced and 'style2' is used to document the trap
section of the Mib File. Refer to Appendix A.4 for more information.
FS-8704-09 SNMP Driver Manual
Page 39 of 39
Appendix C.1.
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.
Data_Arrays
Data_Array_Name,
snmp-stats,
Data_Format,
UINT32,
Data_Array_Length
200
The following statistics are exposed. The table below provides the offset into the Data Array where
you will find the statistic.
Offset Stat
1
There are Server Data Arrays suitable for a walk. The driver sets this offset non-zero if this
is true. Read Error message #33 in Appendix C
2
3
4
5
6
7
Increments each time a lookup store tries to store at an index > DA length
Counts the number of bytes sent by FS in the form of non-COV traps
Counts the number of messages sent by FS in the form of non-COV traps
Counts the number of bytes sent by FS in the form of COV traps
Counts the number of messages sent by FS in the form of COV traps
Counts the number of bytes sent by FS in the form of polls
8
9
Counts the number of messages sent by FS in the form of reads
Counts the number of messages sent by FS in the form of writes
Counts the number of bytes received by the server. (Excludes Traps)
Counts the number of messages received by the server. (Excludes Traps)
Counts the number of tap message bytes received by the server.
Counts the number of trap messages received by the server.
Counts the number of server messages that were received and parsed without error
Counts the number of server messages that were received and parsed with error (excludes
multiples object requests)
10
11
12
13
14
15
16
17
Counts the number of server messages that were received and parsed and rejected
because they requested multiple objects
Counts the number of client side responses that were parsed without error
|