Technical Document: Niagara SNMP Guide

Download as pdf or txt
Download as pdf or txt
You are on page 1of 54

Technical Document

NiagaraAX Snmp Guide

Revised: April 18, 2006


NiagaraAX Snmp Guide
Copyright © 2006 Tridium, Inc.
All rights reserved.
3951 Westerre Pkwy, Suite 350
Richmond
Virginia
23233
U.S.A.

Copyright Notice
The software described herein is furnished under a license agreement and may be used only in accordance with the terms
of the agreement.
This document may not, in whole or in part, be copied, photocopied, reproduced, translated, or reduced to any electronic
medium or machine-readable form without prior written consent from Tridium, Inc.
The confidential information contained in this document is provided solely for use by Tridium employees, licensees, and
system owners; and is not to be released to, or reproduced for, anyone else; neither is it to be used for reproduction of this
Control System or any of its components.
All rights to revise designs described herein are reserved. While every effort has been made to assure the accuracy of this
document, Tridium shall not be held responsible for damages, including consequential damages, arising from the applica-
tion of the information contained herein. Information and specifications published here are current as of the date of this pub-
lication and are subject to change without notice.
The release and technology contained herein may be protected by one or more U.S. patents, foreign patents, or pending
applications.

Trademark Notices
BACnet and ASHRAE are registered trademarks of American Society of Heating, Refrigerating and Air-Conditioning Engi-
neers. Microsoft and Windows are registered trademarks, and Windows NT, Windows 2000, Windows XP Professional,
and Internet Explorer are trademarks of Microsoft Corporation. Java and other Java-based names are trademarks of Sun
Microsystems Inc. and refer to Sun's family of Java-branded technologies. Mozilla and Firefox are trademarks of the Mozilla
Foundation. Echelon, LON, LonMark, LonTalk, and LonWorks are registered trademarks of Echelon Corporation. Tridium,
JACE, Niagara Framework, NiagaraAX and Vykon are registered trademarks, and Workbench, WorkPlaceAX, and AXSuper-
visor, are trademarks of Tridium Inc. All other product names and services mentioned in this publication that is known to be
trademarks, registered trademarks, or service marks are the property of their respective owners.The software described
herein is furnished under a license agreement and may be used only in accordance with the terms of the agreement.
Contents

Contents
Document Change Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii

SNMP Driver Installation 1

SNMP Quick Start 3

Configure the SnmpNetwork. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3


Adding an SnmpNetwork . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Designing an Snmp network application . . . . . . . . . . . . . . . . . . . . . . . . 4

Create Snmp proxy points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Niagara SNMP Concepts 11

About SNMP network architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

About SNMP palette components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

SNMP network configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13


SnmpNetwork component properties . . . . . . . . . . . . . . . . . . . . . . . . . . 14

SNMP device configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

About SNMP proxy points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18


SNMP client proxy points. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
SNMP agent proxy points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
SNMP proxy point extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

SnmpRecipient configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
SnmpRecipient properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

About SNMP alarms (traps) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24


Generating SNMP traps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Receiving SNMP traps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Viewing Received Traps. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
About SNMP alarmData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
SNMP alarm device extension properties. . . . . . . . . . . . . . . . . . . . . . . 29

About SNMP manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

About MIBs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

About the Tridium MIB. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

SNMP point manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34


About the SNMP point manager Discover pane. . . . . . . . . . . . . . . . . . 35
About the SNMP point manager Database pane. . . . . . . . . . . . . . . . . . 36
About SNMP “Discover” . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

SNMP point discover options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37


Loading the MIB. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

NiagaraAX
i
Snmp Guide Revised: April 18, 2006
Contents

Configuring auto-loaded MIBs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Troubleshooting and debugging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Using the Plugin Guides 41

Plugin Guides Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

snmp-MIBPointListManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

snmp-SnmpAgentPointManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

snmp-SnmpDeviceManager. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

snmp-SnmpPointManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

snmp-SnmpTrapManager. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Using the Component Guides 43

Component Reference Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

snmp-MIBListTable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

snmp-SnmpAgent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

snmp-SnmpAgentBooleanProxyExt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

snmp-SnmpAgentPointDeviceExt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

snmp-SnmpAgentPointFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

snmp-SnmpAgentNumericProxyExt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

snmp-SnmpAgentStringProxyExt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

snmp-SnmpBooleanProxyExt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

snmp-SnmpDevice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

snmp-SnmpDeviceFolder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

snmp-SnmpNetwork . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

snmp-SnmpNumericProxyExt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

snmp-SnmpPointDeviceExt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

snmp-SnmpPointFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

snmp-SnmpPollScheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

snmp-SnmpRecipient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

snmp-SnmpStringProxyExt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

snmp-TrapTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

snmp-TrapType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

NiagaraAX
ii Revised: April 18, 2006 Snmp Guide
Preface

Preface
Document Change Log

Document Change Log


Updates (changes/additions) to this NiagaraAX SNMP Guide document are listed below.
• Publication: June 24, 2005
(Initial change log) Added Copyright and Trademarks to preface.
• Revised: September 15+, 2005
Changed to new cover design.
• Revised: December 16, 2005
Added “SNMP Quick Start” and “Niagara SNMP Concepts” chapters.
• Revised: April 18, 2006
Editorial and formatting changes.

NiagaraAX
iii
Snmp Guide Revised: April 18, 2006
Preface

NiagaraAX
iv Revised: April 18, 2006 Snmp Guide
Chapter 1 — SNMP Driver Installation

SNMP Driver Installation


The following list describes the items that you need to consider for installation of the SNMP driver.
• Licensing
To use the NiagaraAX SNMP driver, you must have a target JACE host that is licensed with the
“SNMP” feature. In addition, other SNMP device limits or proxy point limits may exist in your
license.
• Workbench install tool option (“dist” files installed)
From your PC, use the Niagara Workbench 3.n.nn that was installed with the “installation tool”
option selected, as shown in Figure 1. This option installs the needed distribution files (.dist files)
for commissioning various models of remote JACE platforms. If installed, the dist files are
located under your Niagara installation directory under a “sw” subdirectory. For details, see
“About your software database” in the Platform Guide.
Figure 1 Installing Workbench installation tool option

*.dist files

• SNMP module
Apart from installing the 3.n.nn version of the Niagara distribution in the JACE, make sure to also
install the SNMP module plus any specific MIB files and required MIB dependency files.
The MIB files are used in discovering SNMP device data points.
Upgrade any modules shown as “out of date”. For instructions about updating your modules, see
“Software Manager” in the Platform Guide.
The remote JACE is now ready for SNMP Network configuration in its running station, as
described in “Configure the SnmpNetwork” on page 3.
Note: Basic procedures for using the online features of the driver, including discovery of online
SNMP devices and points, is discussed in “Create Snmp proxy points” on page 5.

NiagaraAX
1
Snmp Guide Revised: April 18, 2006
Chapter 1 — SNMP Driver Installation

NiagaraAX
2 Revised: April 18, 2006 Snmp Guide
Chapter 2 — SNMP Quick Start
Configure the SnmpNetwork Adding an SnmpNetwork

SNMP Quick Start


This section provides procedures and descriptions that are commonly required and used with the Nia-
garaAX SNMP driver in typical online scenarios. Like other NiagaraAX drivers, you can do most
configuration from special “manager” views and property sheets using Workbench. The procedures
are grouped in the following sections:
• Configure the SnmpNetwork
• Create Snmp proxy points

Configure the SnmpNetwork


To configure the SnmpNetwork, perform the following main tasks:
• Adding an SnmpNetwork
• Designing an Snmp network application

Adding an SnmpNetwork
When you add an SnmpNetwork to a station, a “local device” component comes with the SnmpNet-
work component.This local device (also referred to as an “Snmp Agent”) allows you to expose data to
outside Snmp sources (managers). Only one local device is allowed under the SnmpNetwork and is
pre-configured as “enabled”, by default.

To add an SnmpNetwork in the station


Use the following procedure to add an SnmpNetwork component under the station Drivers container.
To add an SnmpNetwork in the station:
1. Double-click the station Drivers container. The Driver Manager view appears in the view pane.
2. Click the New button to bring up the New DeviceNetwork dialog box. For more details, see
“Driver Manager New and Edit” in the User Guide.
3. Select “SnmpNetwork,” number to add: 1 and click OK.
Note: You can add only one SnmpNetwork object to a station.
This brings up the New dialog box. Type a name in the name field (or accept the default name)
and select enable to enable the network.
4. Click OK to add the SnmpNetwork to the station.
The SnmpNetwork appears in the Drive Manager view with the name that you assigned in the
previous step. The Status should be “{ok}” and Enabled field set to “true.” The Snmp-
Network node should also appear under your Drivers node in the Workbench nav side bar.
Note: You must save and restart the station before the SnmpNetwork object will start network
communications.

NiagaraAX
3
Snmp Guide Revised: April 18, 2006
Chapter 2 — SNMP Quick Start
Configure the SnmpNetwork Designing an Snmp network application

Designing an Snmp network application


There are two types of Snmp applications. Depending on how you plan to use the Niagara Snmp inte-
gration, you need to set up at least one or possibly both of these applications. Use the appropriate pro-
cedure or procedures to design the Snmp network, as described below:
• Snmp Local Device (Agent)
Set up and use this application for creating a “virtual” Snmp agent device that can expose data
from outside Niagara to Snmp Managers. Every SnmpNetwork has a local device and only one
SnmpAgent object may be added to an SnmpNetwork.
• Snmp Manager
Set up and use this application for creating a “client” type application that you use to manage one
or more Snmp Agent devices on your network. Under the Snmp Manager, SnmpDevice objects
represent remote SnmpAgent devices that are configured to expose data from an actual Snmp
device. You can add many SnmpDevice objects under your SnmpNetwork.

To set up an Snmp local device (agent application)


When you add an SnmpNetwork object, as described in “To add an SnmpNetwork in the station” on
page 3, a Local Device component comes with it.
To set up an Snmp local device, do the following:
1. Right-click on the SnmpNetwork node and select Views > Property Sheet to display the
SnmpNetwork property sheet in the view pane.
2. The Enabled property should be set to True. If not, select True from the option list.
3. Set the Snmp Receive Requests property to Enabled (can send traps). This
allows the local device to receive outside request messages from external SNMP sources and to
send trap messages.
4. Click the property sheet Save button.
You are now ready to add Snmp Agent Points under the local device in order to expose Niagara
data to SNMP requests from outside sources.
Refer to “Create Snmp proxy points” on page 5 for details about adding Snmp Agent Points.

To set up an Snmp manager application


For SNMP manager applications, you add SnmpDevice objects to your SnmpNetwork to represent
actual SNMP agent devices that you want to manage.
To set up an Snmp manager application, do the following:
1. Under the Drivers node of your station, double click on the SnmpNetwork node in the nav side
bar. The Snmp Device manager view displays.
2. Using the palette side bar controls, open the local SNMP module palette, expand the Client
folder and copy-and-paste (or drag and drop) an SnmpDevice object into the view pane. The
Name dialog box appears.
3. Name the SnmpDevice, as desired and click the OK button. The device is added to the Snmp
Device Manager view and represents one SNMP agent device on your network. You can add
more of these objects, if needed, each representing a single SNMP agent device under your Snmp
manager application.
4. Double click on the added device in the Snmp Device Manager view. The Edit dialog appears.

NiagaraAX
4 Revised: April 18, 2006 Snmp Guide
Chapter 2 — SNMP Quick Start
Create Snmp proxy points Designing an Snmp network application

5. In the Edit dialog box, set the Snmp Version and Ip Address (actual device Ip address) fields.
Refer to “SNMP device configuration” on page 18 for more complete Snmp device configuration
information.

Create Snmp proxy points


As with device objects in other drivers, each SnmpDevice has a Points extension that serves as the
container for proxy points. In an Snmp Network, the default view for the Points extension is the
Snmp Point Manager for a Manager application or the Snmp Agent Point Manager for
an Agent (Local Device) application. You use this Point Manager view to add Snmp proxy points
under any SnmpDevice.
For general information about using the Point Manager view, refer to “About the Point Manager” in
the User Guide.
Note: The Snmp Agent Point Manager works differently than Snmp Point Manager.
For example, Snmp Agent Point Manager does not have a Discover button for add-
ing proxy points. Typically, you add new points by copying Agent Points from the SNMP pal-
ette. In a Manager (Client) Snmp application, candidates for Snmp proxy points are always
determined by using the Discover button and MIB files to find valid points and values on
an Snmp Agent on the network. Once you discover these points, this information is then
known to Niagara, and can be added using the Add or Match buttons.
The following procedures describe how to add proxy points:
• To create Snmp Agent proxy points
• To create Snmp Client proxy points
• To create Snmp Client proxy points manually

To create Snmp Agent proxy points


Snmp Agent proxy points are typical point types with a special Snmp Agent extension included. To
add Snmp Client proxy points, refer to “To create Snmp Client proxy points” on page 6.
To create Snmp Agent proxy points in a device, do the following:
1. In the nav side bar, under the station Snmp Network node, expand the Local Device node
and double-click on the Points node.
The Snmp Agent Point Manager displays.
2. In the Snmp Agent Point Manager, click the New button at the bottom of the view (or
right-click in the view and select New from the popup menu). The New dialog box appears.
3. In the New dialog box, do the following:
• in the Type to Add field, select the type of proxy point that you want to add from the option
list.
• in the Number to Add field, type in a number to indicate the quantity of proxy points that
you want to add.
• click the OK button.
The Add dialog box appears.

NiagaraAX
5
Snmp Guide Revised: April 18, 2006
Chapter 2 — SNMP Quick Start
Create Snmp proxy points Designing an Snmp network application

4. In the Add dialog box, you can edit proxy point properties before each point is added in the Nia-
gara station. OID values are automatically assigned for each point.
Note the following about entries in the Add dialog box:
• Name
This property is the unique point name. This is the Niagara point name only—change if needed
(does not affect the actual SNMP node).
• Type
It is a Niagara control point type to use for the proxy point.
Note: Unlike other editable entries in the Add dialog, you cannot edit Type later.
• Index
As SnmpAgent proxy points are added to the SnmpAgent device, they are automatically as-
signed an index value that corresponds to the column index of the object created for it in the
Tridium Input or Output Table.
• Default Value
The default value is used for the output of the proxy point on startup prior to being set (by an
external SNMP SET request). You can manually reset the proxy point output to the default val-
ue at any time by selecting the Action > Reset Point To Default action.
• Enabled
This property allows you to set the proxy point in service (with a true value) or to set it out
of service (with a false value).
• Device Facets
This property represents the device proxy point facets that affect how the value should be dis-
played in Niagara.
• Facets
This property represents the parent Niagara proxy point’s facets, that affect how the value
should be displayed in Niagara.
• Conversion
This property specifies the conversion to use between the “read value” (in Device Facets) and
the parent point facets, where “Default” is typically used.
• Tuning Policy Name
This property specifies the Snmp service type to use when binding to this item.
5. When you have Snmp proxy point(s) configured properly for your usage, click OK.
The proxy points are added to the station, and appear listed in the Snmp Manager view as well as
under the Points node in the nav side bar.
• If online with the SnmpNetwork, points will poll for current values.
• If programming offline, all proxy points appear down (yellow).

To create Snmp Client proxy points


Snmp Client proxy points are typical point types with a special Snmp Client extension included. To
add Snmp Agent proxy points, refer to “To create Snmp Agent proxy points” on page 5.
To create Snmp Client proxy points in a device, do the following:
1. In the nav side bar, under the station Snmp Network node, expand the Snmp Device node
that you are using and double-click on the Points node. The Snmp Point Manager dis-
plays.

NiagaraAX
6 Revised: April 18, 2006 Snmp Guide
Chapter 2 — SNMP Quick Start
Create Snmp proxy points Designing an Snmp network application

2. In the Snmp Point Manager, click the Discover button at the bottom of the view. The
MIB options dialog box appears.
3. In the MIB options dialog box, select one of the following options and click the OK button to
initiate the action (or actions) associated with that option:
• Load MIB and walk MIB
Choose this option if you want to both load a MIB file (or files) and collect the data values.
When this option has finished running, the Discovered pane is populated with the MIB
Point List and values that are found.
• Load MIB only
Select this option if you only want to load the MIB file but do not want to collect values yet.
When this option has finished running, the Discovered pane is populated with the MIB
Point List, but no values.
• Walk current MIB only
Select this option if you want to only collect values but do not need to load a new MIB file.
When this option has finished running, the Discovered pane is populated with the MIB
Point List, including point values.
The Job Status Bar, at the top of the view, indicates the progress and completion of the job
or jobs that you just initiated.
4. In the Discovered pane, select one or more of the discovered points that you want to add as
proxy points and click the Add button. The Add dialog box appears.
In the Add dialog box, you can edit proxy point properties before each point is added in the Nia-
gara station. OID values are automatically assigned for each point. Refer to “About Device Dis-
cover, Add and Match (Learn Process)” in the User Guide for more details about using the Add
dialog box.
Note the following about entries in the Add dialog box:
• Name
This property is the unique point name. This is the Niagara point name only—change if needed
(does not affect the actual SNMP node).
• Type
It is a Niagara control point type to use for the proxy point.
Note: Unlike other editable entries in the Edit dialog, you cannot edit Type later.
• Object Identifier
As SnmpAgent proxy points are added to the SnmpAgent device, they are automatically as-
signed an index value that corresponds to the column index of the object created for it in the
Tridium Input or Output Table.
• Variable Type
This property specifies the value type that is written out to the SNMP device at the location of
the OID specified in the Object Identifier property. This property is usually automat-
ically set when the Snmp proxy point is automatically created but must be typed in when cre-
ating the proxy point manually.
• Enabled
This property allows you to set the proxy point in service (with a true value) or to set it out
of service (with a false value).
• Device Facets
This property represents the device proxy point facets for how the value should be displayed in

NiagaraAX
7
Snmp Guide Revised: April 18, 2006
Chapter 2 — SNMP Quick Start
Create Snmp proxy points Designing an Snmp network application

Niagara.
• Facets
This property represents the parent Niagara proxy point’s facets, for how the value should be
displayed in Niagara.
• Conversion
This property specifies the conversion to use between the “read value” (in Device Facets) and
the parent point facets, where “Default” is typically used.
• Tuning Policy Name
This property specifies the Snmp service type to use when binding to this item.
5. When you have the proxy point(s) configured properly for your usage, click OK.
The points are added to the station, and appear listed in the Database pane of the Snmp Point
Manager view.
• If online with the SnmpNetwork, points will poll for current values.
• If programming offline, all proxy points appear down (yellow).

To create Snmp Client proxy points manually


Snmp Client proxy points are typical point types with a special Snmp Client extension included. To
add Snmp Agent proxy points, refer to “To create Snmp Agent proxy points” on page 5.
To manually create Snmp Client proxy points in a device, do the following:
1. In the nav side bar, under the station Snmp Network node, expand the Snmp Device node
that you are using and double-click on the Points node. The Snmp Point Manager dis-
plays.
2. In the Snmp Point Manager, click the New button at the bottom of the view. The New dialog
box appears.
3. In the New dialog box:
• in the Type to Add field, select the type of proxy point that you want to add from the option
list.
• in the Number to Add field, type in a number to indicate the quantity of proxy points that
you want to add.
• click the OK button.
The Add dialog box appears.
4. In the Add dialog box, you can edit proxy point properties before each point is added in the Nia-
gara station. OID values are NOT automatically assigned for the added point because the point
has not been “discovered”.
Note the following about entries in the Add dialog box:
• Name
This property is the unique point name. This is the Niagara point name only—change if needed
(does not affect the actual SNMP node).
• Type
It is a Niagara control point type to use for the proxy point.
Note: Unlike other editable entries in the Add dialog, you cannot edit Type later.
• Object Identifier
Because the Snmp proxy points are not “discovered” when you use the New button, the OID
values must be typed in manually.

NiagaraAX
8 Revised: April 18, 2006 Snmp Guide
Chapter 2 — SNMP Quick Start
Create Snmp proxy points Designing an Snmp network application

• Variable Type
This property specifies the type of the value written out to the SNMP device at the location of
the OID specified in the Object Identifier property. This property is usually automat-
ically set when the Snmp proxy point is automatically created but must be typed in when cre-
ating the proxy point manually.
• Enabled
This property allows you to set the proxy point in service (with a true value) or to set it out
of service (with a false value).
• Device Facets
This property represents the device proxy point facets that affect how the value should be dis-
played in Niagara.
• Facets
This property represents the parent Niagara proxy point’s facets that affect how the value
should be displayed in Niagara.
• Conversion
This property specifies the conversion to use between the “read value” (in Device Facets) and
the parent point facets, where “Default” is typically used.
• Tuning Policy Name
This property specifies the Snmp service type to use when binding to this item.
5. When you have the proxy point(s) configured properly for your usage, click OK.
The points are added to the station, and appear listed in the Database pane of the Snmp Point
Manager view.
• If online with the SnmpNetwork, points will poll for current values.
• If programming offline, all proxy points appear down (yellow).

NiagaraAX
9
Snmp Guide Revised: April 18, 2006
Chapter 2 — SNMP Quick Start
Create Snmp proxy points Designing an Snmp network application

NiagaraAX
10 Revised: April 18, 2006 Snmp Guide
Chapter 3 — Niagara SNMP Concepts
About SNMP network architecture

Niagara SNMP Concepts


This section describes the SNMP concepts that comprise NiagaraAX SNMP.
The following main sections are included:
• About SNMP network architecture
• About SNMP palette components
• SNMP network configuration
• SNMP device configuration
• About SNMP proxy points
• SnmpRecipient configuration
• About SNMP alarms (traps)
• About SNMP manager
• About MIBs
• About the Tridium MIB
• SNMP point manager
• Troubleshooting and debugging

About SNMP network architecture


Simple Network Management Protocol (SNMP) is a network-management protocol used almost
exclusively in TCP/IP networks. SNMP provides a means to monitor and control network devices,
and to manage configurations, statistics collection, performance and security on a network. SNMP
uses a distributed architecture consisting of entities called “managers” and “agents”.
The SNMP agent exchanges network management information with SNMP manager software run-
ning on a network management system (NMS), or host. The agent responds to requests for informa-
tion and actions from the manager. The agent also controls access to the agent's Management
Information Base (MIB), the collection of objects that can be viewed or changed by the SNMP man-
ager (see Figure 1).
Figure 1 SNMP communication

Communication between the agent and the manager occurs in one of the following forms:
• Get, GetBulk, and GetNext requests
The manager requests information from the agent; the agent returns the information in a Get
response message.

NiagaraAX
11
Snmp Guide Revised: April 18, 2006
Chapter 3 — Niagara SNMP Concepts
About SNMP network architecture

• Set requests
The manager changes the value of a MIB object controlled by the agent; the agent indicates status
in a Set response message.
• Traps notification
The agent sends traps to notify the manager of significant events that occur on the network device.
In Niagara, the SNMP driver uses the standard NiagaraAX network architecture. See “About Net-
work architecture” in the User Guide for more details. The SNMP driver provides the components
necessary to integrate SNMP devices and data into the Niagara environment. This driver currently
supports SNMP versions 1 and 2. The SNMP Driver can be used to set up and serve both the manager
and the agent applications:
• SNMP Manager
A manager is an SNMP application that generates queries to SNMP agent applications and
receives traps from SNMP agent applications.
The Niagara SNMP Driver can be set up as a “Manager” (or “Client”) to monitor a network of
SNMP devices. This configuration includes a view for compiling MIB files (MIB files not sup-
plied with the Niagara SNMP driver) to determine the data that is contained within an SNMP
device. Once “discovered”, the data points can be set up to monitor and control the SNMP
devices. The driver can also handle receiving and processing unsolicited SNMP Trap Messages.
• SNMP Agent
An agent is an SNMP application that responds to queries from SNMP manager applications. The
SNMP agent is responsible for retrieving and updating local management information based on
the requests of the SNMP manager. The agent also notifies registered managers when significant
events or traps occur.
The Niagara SNMP Driver can be set up to act as an SNMP agent on a network to serve informa-
tion to an outside SNMP manager. The SNMP Agent is typically configured to expose Niagara
data to the SNMP data requests and can also generate SNMP v1 trap messages based on Niagara
alarms. Every SnmpNetwork component has a “Local Device” component. The local device is a
frozen slot on the SnmpNetwork component that can be “disabled” but cannot be removed.

NiagaraAX
12 Revised: April 18, 2006 Snmp Guide
Chapter 3 — Niagara SNMP Concepts
About SNMP palette components

About SNMP palette components


Open the SNMP palette in Workbench to view components used in an SnmpNetwork.
Figure 2 SNMP palette

Following is a summary of the palette contents:


• SnmpNetwork
This component contains the required Local Device component and its child components:
• Alarm Source Info component
• Points component.
• Client components
This container holds the components that are typically used for setting up a client SNMP network,
including the SnmpDevice component and its child components:
• Alarm Source Info component
• Points component
• Traps component
Additionally, a specially marked SnmpPointFolder is provided for organizing points, if desired.
The standard point types are located in the palette as well. Most of the time you will probably use
the Point Manager View to add points under the client device.
• Agent components
The agent components include Agent Points that are standard point types with proxy extensions
pre-configured for an SNMP device.
• Trap generation
This folder contains the SnmpRecipient component.

NiagaraAX
13
Snmp Guide Revised: April 18, 2006
Chapter 3 — Niagara SNMP Concepts
SNMP network configuration

SNMP network configuration


SNMP devices communicate using the SNMP protocol over a network. The SnmpNetwork is
designed to handle multiple SnmpDevices using the SNMP version 1 or SNMPv2 protocol (the proto-
col version can be selected by the user for each SnmpDevice independently). Configuration of the
SnmpNetwork object is done through changing its properties to fit the SNMP integration. Only one
SnmpNetwork object can be placed in a station.

SnmpNetwork component properties


By selecting the Property Sheet view of an SnmpNetwork object, you can view and configure the fol-
lowing SNMP properties that apply to the entire network:
Figure 3 SNMP network properties

A description of each of the SNMP specific properties follows. For more details on properties specific
to all types of network objects, refer to the User Guide.
• Poll Scheduler
Used to configure device-level polling. See the User Guide for details on configuring the Poll
Scheduler.
• Enterprise
Displays the enterprise OID (Object Identifier) information for the station.

NiagaraAX
14 Revised: April 18, 2006 Snmp Guide
Chapter 3 — Niagara SNMP Concepts
SNMP network configuration

• Contact
Specifies the system contact information for the station. This contact information is stored for the
station and is read/write accessible via SNMP requests made to the station for OID
1.3.6.1.2.1.1.4.0.
• System Name
Specifies the system name information for the station. This name information is stored for the sta-
tion and is read/write accessible via SNMP requests made to the station for OID 1.3.6.1.2.1.1.5.0.
• Location
Specifies the system location information for the station. This location information is stored for
the station and is read/write accessible via SNMP requests made to the station for OID
1.3.6.1.2.1.1.6.0.
• SNMP Receive Requests
Specifies whether the ability for SNMP request messages to be received by the station (only sup-
ports receiving GET, GETNEXT, or SET SNMPv1 or SNMPv2 messages) is enabled or disabled.
When enabled, reception of SNMP request messages from external SNMP sources is possible
(subject to the constraints placed on the reception of SNMP requests by the next six property
fields). When disabled, reception of SNMP requests is not possible and any requests sent to it will
be dropped.
When the ability to receive SNMP request messages (or SNMP trap messages) is enabled, your
station (JACE) may become insecure and subject to unauthorized SNMP requests from other
sources. The additional properties for limiting the SNMP requests processed (by restricting the
source IPs that may send SNMP requests and adding the ability to change the community string
fields for read/write access) do not ensure the security of your station (JACE) since no encryption
is used. It is highly recommended that you only enable the reception of SNMP requests (or SNMP
traps) when your station (JACE) is on a secure network where SNMP requests from unauthorized
sources are restricted.
• SNMP Receive Port
Specifies the port that the station (or JACE) uses to receive SNMP requests from external SNMP
sources (such as a network manager). The default is port 161, the standard SNMP port.
• Ignore Requests From Unrecognized Sources
Specifies whether to enable or disable the ability for SNMP request messages to be received from
only recognized sources (specified in the 'Recognized Sources' property). When enabled, a
received SNMP request message is first checked for its source IP, and if this source IP matches
any one of the source IP addresses specified in the 'Recognized Sources' field, the request is pro-
cessed. If the source IP does not match, then the request is disregarded. When this property is dis-
abled, SNMP requests from any source IP will be processed.
• Recognized Sources
This component can be configured with source IP addresses to specify a list of recognized net-
work managers. This list is used if the 'SNMP Receive Requests' and 'Only Accept Requests From
Recognized Sources' properties are both enabled. It contains a list of source IP addresses that will
be searched whenever an incoming SNMP request is received, and if the source of that request
matches a source IP in this list, then the request will be processed. Otherwise, the request will be
dropped. Useful for security purposes to ensure that the station only responds to known sources.
This component has two actions used to configure the source IP address list:
• Add Address

NiagaraAX
15
Snmp Guide Revised: April 18, 2006
Chapter 3 — Niagara SNMP Concepts
SNMP network configuration

Prompts the user to enter a source IP address to add to the list. As source IP are added, they
appear in the list as 'Source_IP_Address' entries under the component. These entries are edit-
able.
• Clear All Addresses
Clears the list of source IP addresses. All 'Source_IP_Address' entries will be removed.
• Check Community On Requests
Specifies whether to enable or disable checking the community string field on a received SNMP
request message before processing the request. When enabled, a received SNMP request message
is first checked for its community string, and if this community string matches the community
string specified in the 'Read Only Community' field (for GET or GETNEXT requests) or the
'Read Write Community' field (for GET, GETNEXT, or SET requests), the request is processed.
If the community string does not match for the appropriate read/write access, then the request is
disregarded. When this property is disabled, SNMP requests with any community string field will
be processed.
• Read Only Community
Only valid if the 'Check Community On Requests' property is enabled, this property specifies the
community string field that incoming SNMP request messages must contain in order to process a
read-only request (GET or GETNEXT request). The default value is “public”.
• Read Write Community
Only valid if the 'Check Community On Requests' property is enabled, this property specifies the
community string field that incoming SNMP request messages must contain in order to process a
read-write request (GET, GETNEXT, or SET request). The default value is “public”. NOTE: This
property has priority over the 'Read Only Community' property.
• SNMP Receive Traps
Specifies whether to enable or disable the ability for SNMP trap messages to be received by the
station. When enabled, reception of SNMP trap messages from external SNMP devices is
enabled, and any received trap messages will be routed to the Alarm Class specified by the 'Alarm
Class For Received Traps' property, subject to the constraints of the 'Only Process Recognized
Traps' property.
When the ability to receive SNMP request messages (or SNMP trap messages) is enabled, your
station (JACE) may become insecure and subject to unauthorized SNMP requests from other
sources. The additional properties for limiting the SNMP requests processed (by restricting the
source IPs that may send SNMP requests and adding the ability to change the community string
fields for read/write access) do not ensure the security of your station (JACE) since no encryption
is used. It is highly recommended that you only enable the reception of SNMP requests (or SNMP
traps) when your station (JACE) is on a secure network where SNMP requests from unauthorized
sources are restricted.
• SNMP Receive Traps Port
Specifies the port that the station (or JACE) uses to receive SNMP trap messages from external
SNMP devices. The default is port 162, the standard SNMP traps port.
• Default Network Manager Ip Address
Specifies the default IP address of the network manager to use for reporting information. Any
SnmpRecipients configured to use the SnmpNetwork's default network manager will report
SNMP trap messages generated by the station to the host at this IP address (see SnmpRecipient

NiagaraAX
16 Revised: April 18, 2006 Snmp Guide
Chapter 3 — Niagara SNMP Concepts
SNMP network configuration

Configuration). This default network manager IP will also get sent a 'Cold Start' trap message
from the Niagara station when the station first starts.
• Default Network Manager Traps Port
Specifies the port to use for outgoing SNMP trap messages sent to the default network manager
(i.e. the port on the default network manager where SNMP trap messages are received). This field
defaults to port 162 - the standard SNMP traps port.
• Default Network Manager Traps Community
Specifies the community string field to use for outgoing SNMP trap messages (sent to the default
network manager). The default value is “public”.

NiagaraAX
17
Snmp Guide Revised: April 18, 2006
Chapter 3 — Niagara SNMP Concepts
SNMP device configuration

SNMP device configuration


You place SnmpDevice objects under an SnmpNetwork to represent actual SNMP devices that you
want to communicate with. Then you configure the SnmpDevice object by setting its properties to
match the settings for the actual SNMP device. After device configuration, you can configure proxy
points (at the device-level) for reading and writing actual data values on the SNMP device.
Figure 4 SNMP device properties

Note: SnmpDevice objects may only exist under an SnmpNetwork object.


You can view and edit the following SnmpDevice specific properties in the property sheet view of the
SnmpDevice:
A description of the SNMP specific properties follows (displayed in the property sheet view). For
more details on properties that are common to all types of device objects, please refer to the User
Guide documentation.
• Actions
The SnmpDevice object has one visible action:
• Ping
This action manually initiates a “ping” (check device status) on the actual SNMP device that
the SnmpDevice object represents.
• Retry Count
Specifies the number of times any individual SNMP request made to this SNMP Device will be
retried when receiving a null response before considering the request to be a communication fail-
ure.
• Response Time Out
Specifies the maximum amount of time to wait for a response after sending an SNMP request to
this SNMP device. If no response is received in this amount of time after sending a request, the
request will be considered failed, and the driver will either retry the request (per the 'Retry Count'
property) or consider the transaction a failure.
• Ip Address
Specifies the IP address of the actual SNMP device for which this SnmpDevice represents.

NiagaraAX
18 Revised: April 18, 2006 Snmp Guide
Chapter 3 — Niagara SNMP Concepts
SNMP device configuration

• Port
Specifies the port to use for outgoing SNMP requests to the corresponding SNMP device for this
SnmpDevice (i.e. the port on the external SNMP device where SNMP requests are received). The
default is port 161 - the standard SNMP port.
• SNMP Version
Specifies the version of the SNMP protocol to use for communication with this SNMP device.
The default is 2 (representing SNMPv2), and the only other option is 1 (representing SNMPv1).
• Community
Specifies the community string field to use for outgoing SNMP request messages sent to the
SNMP device. The default value is “public”.
• Max Variable Bindings Per Request
Specifies the maximum number of variable bindings to include in each SNMP request message
sent to the SNMP device. The default value is 10, however, this value can be any integer value
greater than or equal to 1. This is useful if the SNMP request messages sent during device-level
polling become too large (due to a large number of subscribed SNMP proxy points for the Snmp-
Device), and you would like to split up the request messages into multiple requests (of shorter
length). A value of 1 would cause individual requests for each subscribed SNMP proxy point's
data value within the SnmpDevice on each poll cycle for the SnmpDevice.
• Traps
This editable component stores a list of SNMP trap notification types created for this SnmpDe-
vice using the MIBPointListManager. If the SnmpNetwork is configured to receive SNMP trap
messages, any trap received from this SNMP device will first check to see if it has a correspond-
ing trap notification type in this list in order to describe the meaning of the received trap. This
component has one action:
• Clear - Deletes the list of stored SNMP trap/notification types. All entries will be removed.
For more information about the Trap device extension, including traps property descriptions, refer
to “SNMP alarm device extension properties” on page 31.

NiagaraAX
19
Snmp Guide Revised: April 18, 2006
Chapter 3 — Niagara SNMP Concepts
About SNMP proxy points

About SNMP proxy points


There are two basic categories of SNMP proxy points, as described below and in the following sec-
tions:
• SNMP client (manager) proxy points
Client proxy points are used under an SNMP client (manager) application.
Refer to “SNMP client proxy points” for more information.
• SNMP agent (server) proxy points
Agent SNMP proxy points are used under an SNMP agent (local device) application.
SnmpAgent proxy points are used to expose read-write and read-only Niagara data to an outside
SNMP manager making requests to the station. A running station with an SnmpNetwork includes
a Tridium Input and Output Table that contains objects that can be exposed through GET, GET-
NEXT, or SET requests sent to it from an outside SNMP device (usually an outside SNMP man-
ager). When SnmpAgent proxy points are added to an SnmpAgent under the SnmpNetwork, the
Tridium Input Table (for read-write objects) or Output Table (for read-only objects) is populated
and thus accessible via SNMP requests (supports both SNMPv1 and SNMPv2 GET, GETNEXT,
or SET requests).
To get a list of all of the Tridium agent data in the Tridium Input Table, you have to perform a
series of GETNEXT and/or GET requests starting from the following root OID:
1.3.6.1.4.1.4131.1.4.
Note: The data contained in the Tridium Input Table will also accept SET requests to change the
value of the data and the corresponding SnmpAgent proxy point.
To get a list of all of the Tridium agent data in the Tridium Output Table, perform a series of
GETNEXT and/or GET requests starting from the following root OID: 1.3.6.1.4.1.4131.1.5.
Note: The data contained in the Tridium Output Table will not accept SET requests as it contains
read-only data.
As SnmpAgent proxy points are added to the SnmpAgent device, they are automatically assigned
an index value that corresponds to the column index of the object created for it in the Tridium
Input or Output Table.
Refer to “SNMP agent proxy points” for more information.

SNMP client proxy points


SNMP client proxy points must be located under the SNMP point device extension. SNMP proxy
points are comprised of standard Niagara control points with unique SNMP proxy point extensions
that define the SNMP-specific behavior of the point.
See the appropriate User Guide documentation for details on the basic control point types themselves.
You typically add SNMP client points under the SNMP points container during a “discovery” process
using the SNMP Point Manager view. Use the Add or Match buttons to bring the points into the
SNMP client application with the correct proxy point extension, based on your Type selection in the
Add dialog box. Refer to “SNMP point manager” on page 36 for more information about the Point
Manager view. The client proxy points and extensions are also available in the Client folder of the

NiagaraAX
20 Revised: April 18, 2006 Snmp Guide
Chapter 3 — Niagara SNMP Concepts
About SNMP proxy points

SNMP palette, as shown in Figure 5.


Figure 5 SNMP client proxy points

Following is a list of the SNMP client proxy points:

NiagaraAX
21
Snmp Guide Revised: April 18, 2006
Chapter 3 — Niagara SNMP Concepts
About SNMP proxy points

• SnmpBooleanPoint
This read-only control point type contains the SNMP Boolean proxy point extension.
• SnmpBooleanWritable
This writable control point type contains the SNMP Boolean proxy point extension.
• SnmpNumericPoint
This read-only control point type contains the Numeric SNMP proxy point extension.
• SnmpNumericWritablePoint
This writable control point type contains the Numeric SNMP proxy point extension.
• SnmpStringPoint
This read-only control point type contains the String SNMP proxy point extension.
• SnmpStringWritable
This writable control point type contains the String SNMP proxy point extension.
These SNMP proxy points support reading or writing the following SNMP variable types:
• Integer
• String (OCTET STRING)
• Object Identifier
• IpAddress
• Counter (both Counter32 and Counter64)
• Gauge
• TimeTicks

SNMP agent proxy points


SnmpAgent proxy points must be located under an SNMP Point Device Extension. SnmpAgent proxy
points consist of standard Niagara control points with unique SnmpAgent Proxy Point Extensions
which define the SnmpAgent-specific behavior of the point.
The SnmpAgent proxy points leverage off the following standard Niagara control point types (see the
appropriate Niagara documentation for details on the control point types themselves).
Figure 6 SNMP agent proxy points

See the appropriate User Guide documentation for details on the basic control point types themselves.
Following is a list of the SNMP agent proxy points:

NiagaraAX
22 Revised: April 18, 2006 Snmp Guide
Chapter 3 — Niagara SNMP Concepts
About SNMP proxy points

• SnmpAgentBooleanPoint
This control point type hosts the following read-write SnmpAgent proxy point extension that pop-
ulates the Tridium Input Table: SnmpAgentBooleanProxyExt.
• SnmpAgentBooleanWritable
These control point types host the following read-only SnmpAgent proxy point extensions that
populate the Tridium Output Table: SnmpAgentBooleanProxyExt.
• SnmpAgentNumericPoint
This control point type hosts the following read-write SnmpAgent proxy point extension that pop-
ulates the Tridium Input Table: SnmpAgentNumericProxyExt
• SnmpAgentNumericWritablePoint
These control point types host the following read-only SnmpAgent proxy point extensions that
populate the Tridium Output Table: SnmpAgentNumericWritableProxyExt.
• SnmpAgentStringPoint
This control point type hosts the following read-write SnmpAgent proxy point extension that pop-
ulates the Tridium Input Table: SnmpAgentStringProxyExt
• SnmpAgentStringWritable
These control point types host the following read-only SnmpAgent proxy point extensions that
populate the Tridium Output Table: SnmpAgentStringWritableProxyExt.

SNMP proxy point extensions


Each SNMP proxy point type contains a corresponding proxy point extension. SNMP proxy point
extensions have the same core properties as other proxy point extensions (described in the User
Guide), plus some SNMP-specific properties, which are described here. These extension properties
are similar for both client and agent proxy point application. There are some differences that are noted
in the following list of property descriptions:
Figure 7 SNMP proxy point extension properties

Client
Properties

Agent
Properties

• Object Identifier (Client)


Specifies the OID of the actual SNMP device where the data is to be read from or written to.

NiagaraAX
23
Snmp Guide Revised: April 18, 2006
Chapter 3 — Niagara SNMP Concepts
SnmpRecipient configuration

• Object Identifier (Agent)


Displays the full OID to use for accessing the data value for this point from the Tridium Input
Table (or Output Table) by an outside SNMP manager. SNMP GET or SET requests would use
this full OID to access the value of the proxy point.
• Variable Type
This property specifies the variable type of the value that is written out to the SNMP device at the
location of the OID specified in the 'Object Identifier' property.
Note: This property is usually automatically set when the SNMP proxy point is created from the
SnmpPointManager (as long as the type field for the MIB entry created matches one of the
known types). Otherwise the user will have to manually set this property for the appropri-
ate variable type before input values are properly written to this point in the actual SNMP
device.
• Index (Agent)
The column index in the Tridium Input Table (or Output Table) used to locate the value of the
proxy point. It is simply the last number in the 'Object Identifier' (OID) value. For example, if the
index has a value of 1, then the OID containing the value of the point is 1.3.6.1.4.1.4131.1.4.1.3.1.
If the index is 2, this corresponds to an OID of 1.3.6.1.4.1.4131.1.4.1.3.2, and so on.
• Default Value (Agent)
This property is the default value used for the output of the proxy point on startup prior to being
set (by an external SNMP SET request). If 'autoSet' is checked, then the default value is automat-
ically set (changed) whenever a new external SNMP SET request is received. If 'autoSet' is
unchecked, then the Niagara user can specify a permanent default value (any external SNMP SET
request will not change the default value). The Niagara user can manually reset the proxy point's
output to the default value at any time by selecting the 'Reset Point To Default' action.

SnmpRecipient configuration
SnmpRecipient components extend from standard Niagara AlarmRecipients. They function the same
as the standard AlarmRecipient component (see “Types of alarm recipients” in the Niagara User
Guide) except that the SnmpRecipient has added properties for configuring and handling the SNMP
specific behavior. In order to use the SnmpRecipient, you must place the SnmpRecipient component
under the station Alarm Service, as shown in Figure 8.
Note: A configured SnmpNetwork object must exist in the station in order for the SnmpRecipient to
function properly.
Figure 8 SnmpRecipient under the AlarmService

NiagaraAX
24 Revised: April 18, 2006 Snmp Guide
Chapter 3 — Niagara SNMP Concepts
SnmpRecipient configuration

Notice that the Alarm slot of the Alarm Class component is linked to the Route Alarm slot of the
SnmpRecipient component (see Figure 10). This ensures that Niagara alarms are routed to the Snm-
pRecipient appropriately. Be sure to use this connection for each Alarm Class-to-SnmpRecipient link
in your station.
SnmpRecipient-specific properties are described in the “SnmpRecipient properties” on page 25. Con-
figure the SnmpRecipient component to generate and receive SNMP traps as described in the follow-
ing sections:
• Generating SNMP traps
Use the SnmpRecipient component to generate and send Niagara alarms (in the form of SNMPv1
traps) to a defined SNMP manager whenever a new Niagara alarm record is routed to the Snm-
pRecipient.
• Receiving SNMP traps
Use the SnmpRecipient to store any received Niagara alarm records in the Tridium Alarm Table
of the SnmpNetwork. The SnmpRecipient receives the alarm record from the linked Alarm Class
and packages it into an SNMPv1 trap message to send to the network manager.

SnmpRecipient properties
By selecting the Property Sheet view of an SnmpRecipient component, you can view and configure
the SnmpRecipient properties, as shown in Figure 9.
Figure 9 SnmpRecipient properties

The Time Range, Days of Week, and Transitions properties are standard to all Alarm Recipients and
detailed in the Niagara User Guide. The SNMP-specific properties are described in the following list:
• Route Acks
Enable this property by selecting the true option. Trap acknowledgements are not routed if the
False option is selected.
• Route Alarms To Network Manager As Traps
When selected, this property option enables generating and sending SNMP version1 trap mes-
sages to the specified SNMP network manager whenever a new Niagara alarm record is re-
ceived. It this option is not selected, then this service is not enabled and any received Niagara
alarm record dies not generate or send an SNMP version 1 trap message.
• Use SnmpNetwork’s Default Network Manager
When this property option is selected, Niagara alarms that are reported as traps, report using

NiagaraAX
25
Snmp Guide Revised: April 18, 2006
Chapter 3 — Niagara SNMP Concepts
About SNMP alarms (traps)

the network manager that is defined in the Default Network Manager properties. If this
property option is not selected, then the alarms are reported as traps using the network manager
that is defined in the Network Manager Config properties.
• Network Manager Config
The following three properties are available only when the Use SnmpNetwork’s Default
Network Manager property option (check box) is not selected.
• Network Manager Ip Address
This property is a text field for defining the IP address of the network manager that is used for
reporting the generated SNMP version 1 traps.
• Network Manager Traps Port
This property specifies the port to use for outgoing SNMP version 1 trap messages sent to the
specified network manager (i.e. the port on the network manager where SNMP trap messages
are received). This field defaults to port 162 - the standard SNMP traps port.
• Network Manager Traps Community
This property specifies the community string field to use for outgoing SNMP version 1 trap
messages (sent to the network manager). The default value is “public”.

About SNMP alarms (traps)


Niagara handles alarms using the station alarming service and its alarm classes. The SNMP driver
uses these alarm classes in generating and receiving SNMP traps. Because alarm classes are standard
Niagara objects, all Niagara alarms that generate trap messages (or all received SNMP trap messages
that generate Niagara alarms) can be viewed in a Niagara alarm console. In order to generate and
receive SNMP traps, you must properly configure the SnmpNetwork and SnmpRecipient compo-
nents.
Refer to the following sections for more information about configuring the SNMP network for trap
generation and trap reception:
• Generating SNMP traps
• Receiving SNMP traps
For additional information about Niagara alarming and the Niagara alarm console, refer to “About
alarms” and “About the alarm console” in the Niagara User Guide.

Generating SNMP traps


You can generate and send Niagara alarms (in the form of SNMPv1 traps) to a defined SNMP man-
ager whenever a new Niagara alarm record is routed to the SnmpRecipient. In order to generate
SNMP traps you must setup and configure the SnmpRecipient on a station running an SnmpNetwork.
This includes placing an SnmpRecipient component under the AlarmService component, configuring
it to enable trap generation and designating a valid SNMP network manager. Refer to “SnmpRecipi-
ent configuration” on page 24 for details.
Once the proper IP address and port are assigned for the SNMP network manager, the SnmpRecipient
component must have a link to an appropriate Alarm Class under the Alarming Service in order to

NiagaraAX
26 Revised: April 18, 2006 Snmp Guide
Chapter 3 — Niagara SNMP Concepts
About SNMP alarms (traps)

provide the Niagara Alarm source for the generation and routing of SNMP trap messages to the net-
work manager. You add SnmpRecipient components under the AlarmService by copy-and-paste from
the SNMP module palette. You can add as many SnmpRecipients as you need to configure your
SNMP integration. Figure 10 shows an SnmpRecipient component linked to the Default Alarm Class.
In this example, any Niagara alarms routed to the Default Alarm Class are also be routed to the Snm-
pRecipient. The SnmpRecipient then packages the alarms into SNMP trap messages and sends them
to the specified SNMP network manager.
Figure 10 SnmpRecipient linked to default alarm class

Note: All SNMP traps generated and sent by the SnmpRecipient are SNMPv1 messages. The SNMP
driver currently does not support generating and sending SNMPv2 trap messages.

To configure a station for SNMP trap generation


To configure a station for SNMP trap generation, you must first have an SNMP network established
and running in your station. (See “Adding an SnmpNetwork” on page 3).
1. Open the SNMP palette in the Workbench palette side bar.
2. Under the Trap Generation folder, drag and drop an SnmpRecipient component onto the
AlarmService property sheet or onto the AlarmService component in the nav tree.
3. Select the property sheet view of the SnmpRecipient and set the Time Range, Days of Week, and
Transitions properties as desired. See “SnmpRecipient properties” on page 25 for details.
4. On the SnmpRecipient property sheet, set the Rout Acks property to True and choose the fol-
lowing options:
• Route Alarms To Network Manager As Traps
If this option is not selected, traps are not routed.
• Use SnmpNetwork’s Default Network Manager
If this option is selected, traps report using the network manager that is defined in the De-
fault Network Manager properties. If this property option is not selected, then the
alarms are reported as traps using the network manager that is defined in the Network Man-
ager Config properties.
5. Set the following Network Manager Config properties if you choose to use an SnmpNetwork
Manager other than the SnmpNetwork’s Default Network Manager.
Note: These properties are read-only unless you clear (do not select) the SnmpNetwork’s
Default Network Manager option field under the Rout Acks property.
• Network Manager IP Address
Type in the address of the SnmpNetwork manager that you want to use.
• Use SnmpNetwork’s Default Network Manager
If this option is selected, traps report using the network manager that is defined in the De-
fault Network Manager properties. If this property option is not selected, then the

NiagaraAX
27
Snmp Guide Revised: April 18, 2006
Chapter 3 — Niagara SNMP Concepts
About SNMP alarms (traps)

alarms are reported as traps using the network manager that is defined in the Network Man-
ager Config properties.
• Network Manager Traps Community
This property provides a field for you to specify a string value to use for outgoing SNMP ver-
sion 1 trap messages (sent to the network manager). The default value is “public”.
6. On the SnmpRecipient property sheet, click the Save button. SNMP trap generation is con-
figured and enabled.

Receiving SNMP traps


In order to receive SNMP traps you must configure the SnmpNetwork to receive traps. This includes
setting the enabling property and specifying the port that listens for traps, as shown in Figure 11. You
also need to configure properties that specify whether or not you want to receive traps from unrecog-
nized sources. Refer to the following sections for more details about configuring SNMP components
for receiving traps:
• “To configure a network manager (station) to receive SNMP traps” on page 28
• “SnmpRecipient properties” on page 25
Figure 11 Configure SNMP network to receive traps

Received trap messages are also routed to the SnmpDevice object and displayed in string form in the
object’s Last Trap Received property field.

To configure a network manager (station) to receive SNMP traps


To configure a station for receiving SNMP traps, you must first have an SNMP network established
and running in your station (see “Adding an SnmpNetwork” on page 3). You also need to have an
SnmpDevice component in your network application for any devices that may potentially send out
trap messages (see “Designing an Snmp network application” on page 4).
To configure a network manager to receive SNMP traps, do the following:
1. Select the property sheet view of the SnmpNetwork component.
2. Set the SNMP Receive Traps property, to True.
3. Set the SNMP Receive Traps Port property to the desired port number. (Port 162 is the
default value).
4. On the SnmpNetwork property sheet, click the Save button. SNMP traps that are directed to
the SnmpNetwork manager are received and routed to the alarm class specified under the “Traps”
device extension Alarm Class property of the client device.
5. In the property sheet view of any potential trap-generating SNMP device, expand the Traps
device extension component and set the following two properties, as desired:
• Alarm Class
Set this property to the alarm class that you want to use to route traps that are received from the
parent device.
• Ignore Unrecognized Traps

NiagaraAX
28 Revised: April 18, 2006 Snmp Guide
Chapter 3 — Niagara SNMP Concepts
About SNMP alarms (traps)

Set this property to True if you want to disregard trap messages (no alarm generation) that con-
tain an unrecognized trap type. Set the property to False if you want to route all received traps
to the designated alarm class, even if the trap type is not recognized.
6. On the SnmpDevice property sheet, click the Save button. SNMP trap generation is configured
and enabled.

Viewing Received Traps


Traps information may be viewed in the alarm console. Route traps to the alarm console by linking
the ConsoleRecipient to the appropriate AlarmClass component, as shown in Figure 12.
Figure 12 ConsoleRecipient linked to default alarm class

You can use the alarm console to view the trap data in the Alarm Data column. However, the Alarm
Data column is very long and not totally viewable in the alarm console view. To read the Alarm Data
information, double-click on the row that you want to read, and display the Open Alarm
Sources view and then the Open Alarm Records dialog box, as shown in the Figure 13. The
Alarm Record dialog box provides a full description of the message.
Figure 13 Alarm console views

NiagaraAX
29
Snmp Guide Revised: April 18, 2006
Chapter 3 — Niagara SNMP Concepts
About SNMP alarms (traps)

For complete details about using the alarm console, including information about adding or removing
alarm console columns, refer to “About the alarm console” in the User Guide.

About SNMP alarmData


The Alarm Data field of the alarm console displays a received trap message using a Trap_Data
facet in one of the following forms, depending on SNMP version:
Note: The following typographical conventions apply to the examples:
• Italicized values in angle brackets (< >) represent values that are taken from the station such as
stored trap/notification type information and SnmpDevice IP addresses.
• Italicized values enclosed in brackets ([ ]) represent values that are taken from the received trap
message itself.
• Variable bindings are displayed in the following form:
[Variable Type]: [Value]
Where 'Variable Type' is one of the following: OID, COUNTER, GAUGE, INT, IP ADDRESS,
STRING, or TIMETICKS.
• For a null variable binding, the text is 'NULL OBJ '.
For a recognized SNMPv1 trap message from a known IP address:

"Received recognized v1 Trap from <SnmpDevice object name>(<IP


Address>):
NAME= <Trap Name>;
VARIABLES=
<variable name>([variable binding taken from received trap]),
… … …;
DESCRIPTION= <Trap Description>;
REFERENCE= <Trap Reference>;
[DETAILS=
enterprise: [oid];
agent-addr: [ipaddress];
generic-trap: [integer];
specific-trap: [integer];
time-stamp: [timeticks]]"
For a recognized SNMPv2 trap message from a known IP address:

"Received recognized v2 Trap from <SnmpDevice object name>(<IP


Address>):
NAME= <Trap Name>(<oid of trap>);
OBJECTS=
<variable name>([variable binding taken from received trap]),
… … …;
DESCRIPTION= <Trap Description>;
REFERENCE= <Trap Reference>"

NiagaraAX
30 Revised: April 18, 2006 Snmp Guide
Chapter 3 — Niagara SNMP Concepts
About SNMP alarms (traps)

SNMP alarm device extension properties


Common extension properties are described in the User Guide documentation. The following proper-
ties are SNMP-specific properties found under the SNMP Traps component:
• Alarm Class
This property displays an option list that allows you to choose the desired local AlarmClass for
routing traps that are received from this device.
• Time Of Last Trap Received
Displays a timestamp of the last time (since station startup) that an SNMP trap message was
received from the actual SNMP device represented by this SnmpDevice.
• Last Trap Received
This StringElement output displays the detailed message of the last received SNMP trap message
for this SnmpDevice since station startup.
• Ignore Unrecognized Traps
This True or False option allows you to filter out any traps that are not recognizable based on
the stored trap types for the source SnmpDevice. If this property is set to True, then the received
unrecognized trap message will be disregarded (no alarms generated). If this property is disabled,
then all received trap messages will be handled and routed to the specified Alarm Class whether
they are recognizable or not.

NiagaraAX
31
Snmp Guide Revised: April 18, 2006
Chapter 3 — Niagara SNMP Concepts
About SNMP manager

About SNMP manager


You may configure the Niagara SnmpNetwork as an SNMP Manager to view and control points on a
remote SnmpNetwork station. The remote station must contain an SNMP device component that is
configured as an SNMP agent. The SNMP agent exposes data through the use of an SnmpAgent
device and SnmpAgent proxy points (see “Configure the SnmpNetwork” on page 3 and “Create
Snmp proxy points” on page 5). In this case alarms generated by the station can be stored in a Trid-
ium Alarm Table (using an SnmpRecipient component) allowing the remote SNMP manager to
view and acknowledge Niagara alarms via SNMP requests.
Figure 14 SNMP manager devices

SNMP Device

SNMP Points

“About the Tridium MIB” on page 33 describes the Tridium MIB file (TridiumR3-MIB.my) for a
station running the SnmpNetwork. It also explains how it is used to view and control the station.

About MIBs
A Management Information Base (MIB) describes a database of objects that can be monitored by a
network management system. SNMP uses standardized MIB formats that allow any SNMP tool to
monitor any device defined by a MIB.
Each managed object in a MIB has a unique identifier that specifies things such as:
• object type (such as counter, string, or integer, for example)
• object access level (such as read or read/write)
• size restriction
• range information
The name space for MIB object identifiers is hierarchical. It is structured so that each manageable
object can be assigned a globally unique name. Authority for parts of the name space is assigned to
individual organizations. This allows organizations to assign names without consulting an Internet
authority for each assignment. For example, the name space assigned to a (fictional) Corporation X
might be 1.3.6.1.4.1.nnn (where n is an integer), which is defined in CORPX.MIB. Corporation X
then has the authority to assign names to objects anywhere below that name space. The object identi-
fier in the hierarchy is written as a sequence of sub identifiers beginning at the root and ending at the
object with sub identifiers separated by a period.

NiagaraAX
32 Revised: April 18, 2006 Snmp Guide
Chapter 3 — Niagara SNMP Concepts
About the Tridium MIB

About the Tridium MIB


The Tridium MIB defines the information that can be exposed for a station running the SnmpNet-
work. The Tridium MIB is contained in the TridiumR3-MIB.my file under the tridiumMib folder
of the SNMP module, as shown in Figure 15. After compiling the Tridium MIB, an SNMP manager
application can use the information to read and write data to and from the station.
Figure 15 Viewing a MIB file in Workbench text file editor view

In order to compile the Tridium MIB, you need to use the following three files:
• TridiumR3-MIB.my
This is the Tridium MIB. You must use the following two files with this file
• RFC1155-SMI.mib
• RFC1213-MIB.mib
These three files are used in the SNMP Point Manager view to “discover” and to “add” SNMP
points, as needed. Refer to “SNMP point manager” on page 36 for more information about the SNMP
Point Manager view.
Compiling the Tridium MIB using the SNMP Point Manager view reveals a list of points, as shown in
Figure 16. This illustration shows the SNMP Point Manager view displaying five columns. You can
show more columns or hide columns, as desired, using the table controls, as described in the User
Guide.

NiagaraAX
33
Snmp Guide Revised: April 18, 2006
Chapter 3 — Niagara SNMP Concepts
About the Tridium MIB

Figure 16 SNMP MIB compiled

The following list describes how the individual Tridium MIB entries are used:
• version (OID: 1.3.6.1.4.1.4131.1.1.0)
this read-only string object exposes the current software version that the station is running.
• action (OID: 1.3.6.1.4.1.4131.1.2.0)
this read-write integer object allows the manager to perform certain actions on the Tridium Alarm
Table. A value of 0 causes no action to be performed on the Tridium Alarm Table (remember to
always set the value back to 0 after performing any action, otherwise the action will be performed
repeatedly on any new alarm entries). A value of 1 causes all of the alarm entries in the Tridium
Alarm Table to be acknowledged (and also in the Niagara Alarming Service if the SnmpNetwork
for the station has the 'Synchronize Alarm Acks' property enabled - see SnmpNetwork Configura-
tion). A value of 2 causes all of the alarms to be cleared (the corresponding alarms in the Niagara
Alarming Service will be acknowledged if unacknowledged and if the SnmpNetwork for the sta-
tion has the 'Synchronize Alarm Acks' property enabled). A value of 3 causes all acknowledged
alarms in the Tridium Alarm Table to be cleared. Any other value (outside the range of 0-3) is not
valid for this object, and will be treated as no action.
• alarmTable (OID: 1.3.6.1.4.1.4131.1.3)
this sequence of alarmTableEntries represents the Tridium Alarm Table that is dynamically cre-
ated by the station whenever an alarm is generated in the station and routed to a Alarm Class that
has an SnmpRecipient object linked to it. The Tridium Alarm Table has a buffer size of 50 alarm
entries. Alarm entries that are not cleared from the Tridium Alarm Table when the buffer becomes
full will be removed on a FIFO (First In, First Out) basis as new alarm entries are added.
• alarmTableEntry (OID: 1.3.6.1.4.1.4131.1.3.1)
this represents an entry within the alarmTable containing the following data (all fields of an
Alarm Record):
• alarmId (OID: 1.3.6.1.4.1.4131.1.3.1.1)
this read-only integer object exposes the numerical identifier automatically assigned to the

NiagaraAX
34 Revised: April 18, 2006 Snmp Guide
Chapter 3 — Niagara SNMP Concepts
About the Tridium MIB

alarm entry in the Tridium Alarm Table. It is used as an index to address table entries.
• ackState (OID: 1.3.6.1.4.1.4131.1.3.1.2)
this read-write integer object allows the manager to acknowledge and view the acknowledge
state of the alarm entry. A value of 1 means that the alarm is unacknowledged. Setting the value
to 2 acknowledges the alarm. After setting the value to 2, the manager should re-read the value
of this object again to verify that the acknowledgement occurred (the value will be 2 when ac-
knowledged).
• ackRequired (OID: 1.3.6.1.4.1.4131.1.3.1.3)
this read-only integer object exposes whether an acknowledgement is required for this alarm
entry. A value of 1 (true) indicates that an acknowledgement is required, while a value of 2
(false) indicates that an acknowledgement is not required.
• timestamp (OID: 1.3.6.1.4.1.4131.1.3.1.4)
this read-only string object exposes the time when the alarm occurred (in the Niagara station's
timestamp form).
• recordType (OID: 1.3.6.1.4.1.4131.1.3.1.5)
this read-only string object exposes the type of the Niagara alarm record.
• source (OID: 1.3.6.1.4.1.4131.1.3.1.6)
this read-only string object exposes the path to the station object which generated the alarm.
• alarmFlags (OID: 1.3.6.1.4.1.4131.1.3.1.7)
this read-only string object exposes the flags associated with the alarm.
• alarmData (OID: 1.3.6.1.4.1.4131.1.3.1.8)
this read-only string object exposes the alarm data.
• uuid (OID: 1.3.6.1.4.1.4131.1.3.1.9)
this read-only string object exposes the unique universal identifier of the alarm.
• alarmClass (OID: 1.3.6.1.4.1.4131.1.3.1.10)
this read-only string object exposes the path to the Niagara Alarm Class of the alarm.
• priority (OID: 1.3.6.1.4.1.4131.1.3.1.11)
this read-only integer object exposes the priority of the alarm.
• ackTime (OID: 1.3.6.1.4.1.4131.1.3.1.12)
this read-only string object exposes the time at which the alarm was acked (in the Niagara sta-
tion's timestamp form). Note that interpretation of this value depends upon the state of the
alarm.
• user (OID: 1.3.6.1.4.1.4131.1.3.1.13)
this read-only string object exposes the name of the user who acknowledged the alarm.
• inputTable (OID: 1.3.6.1.4.1.4131.1.4)
this sequence of inputTableEntries represents the Tridium Input Table that is dynamically created
by the station whenever an input-type SnmpAgent proxy point is created in the station under an
SnmpAgent.
• inputTableEntry (OID: 1.3.6.1.4.1.4131.1.4.1)
represents an entry within the inputTable containing the following data:
• inputIndex (OID: 1.3.6.1.4.1.4131.1.4.1.1)
this read-only integer object exposes the index into the Tridium Input Table for a particular in-
put-type SnmpAgent proxy point's value. It is used as an index to address Tridium Input Table
entries.
• inputName (OID: 1.3.6.1.4.1.4131.1.4.1.2)

NiagaraAX
35
Snmp Guide Revised: April 18, 2006
Chapter 3 — Niagara SNMP Concepts
SNMP point manager

this read-only string object exposes the name of the input-type SnmpAgent proxy point supply-
ing the value of this Tridium Input Table entry.
• inputValue (OID: 1.3.6.1.4.1.4131.1.4.1.3)
this read-write string object allows the value stored in the corresponding input-type Sn-
mpAgent proxy point to be read or written. All values are read and written as string types, and
the input-type SnmpAgent proxy point on the station itself will handle conversions if necessary
(i.e. converting from string to integer or boolean type)
• outputTable (OID: 1.3.6.1.4.1.4131.1.5)
this sequence of outputTableEntries represents the Tridium Output Table that is dynamically cre-
ated by the station whenever an output-type SnmpAgent proxy point is created in the station.
• outputTableEntry (OID: 1.3.6.1.4.1.4131.1.5.1)
represents an entry within the outputTable containing the following data:
• outputIndex (OID: 1.3.6.1.4.1.4131.1.5.1.1)
this read-only integer object exposes the index into the Tridium Output Table for a particular
output-type SnmpAgent proxy point's value. It is used as an index to address Tridium Output
Table entries.
• outputName (OID: 1.3.6.1.4.1.4131.1.5.1.2)
this read-only string object exposes the name of the output-type SnmpAgent proxy point sup-
plying the value of this Tridium Output Table entry.
• outputValue (OID: 1.3.6.1.4.1.4131.1.5.1.3)
this read-only string object exposes the value stored in the corresponding output-type Sn-
mpAgent proxy point. All values are read as string types, and thus the manager must handle
conversions if necessary (i.e. converting from string to integer or boolean type).
• stationAlarm (OID: 1.3.6.1.4.1.4131.1)
this SNMP trap-type defines the form of outgoing SNMPv1 trap messages sent by the station. For
more details, see Generating SNMP Traps.

SNMP point manager


The SNMP point manager view is the default view on Snmp Point Device Extension. It is used to
compile and display the contents of MIB files for easy creation of SNMP proxy points that represent
data values in the actual SNMP device (based on the information contained in the compiled MIB file).
It is also used for viewing, storing, and removing SNMP trap and notification types learned for an
SnmpDevice from the compiled MIB file.
The SNMP point manager view is basically the same as the standard point manager view that is used
for most Niagara drivers and is described in detail in the User Guide.
The SNMP point manager view splits into two panes when you do a “Discover” (see Figure 17)
• Discover pane
This pane displays MIB entries from the last compiled MIB file.
• Database pane
This pane displays the points that are added to your station database.

NiagaraAX
36 Revised: April 18, 2006 Snmp Guide
Chapter 3 — Niagara SNMP Concepts
SNMP point manager

Figure 17 SNMP point manager view

Discover Pane

Database Pane

In addition to the standard point manager functions, the SNMP point manager view has some SNMP-
specific functions that are described in the following sections:
• “About SNMP “Discover”” on page 39
• “Loading the MIB” on page 40
• “Configuring auto-loaded MIBs” on page 41

About the SNMP point manager Discover pane


The discover pane displays MIB entries from the last compiled MIB file. These entries provide a tem-
plate for creating and pre-configuring SNMP proxy points for the SnmpDevice (in particular, it auto-
matically sets up such SNMP proxy point properties as the 'Object Identifier', or OID). The columns
of the table include:
• Name
The name of the OBJECT-TYPE of the MIB entry. This name will be used to give a name to any
created SNMP proxy points based on the entry.
• OID
The Object Identifier of the given entry. This OID will be pre-configured in the 'Object Identifier'
property of any created SNMP proxy points based on the entry.
• Type
The type of object given in the SYNTAX section of the MIB entry. Common examples are INTE-
GER, DisplayString, Gauge, IpAddress, Counter, TimeTicks, etc. This type is used to pre-config-
ure the 'Variable Type' property of any created writable SNMP proxy points based on the entry.
• Value
This column displays the point value. When the MIB is loaded but not “walked” the value column
is empty.
• Access
The accessibility of the MIB entry (read-only, read-write, not-accessible). Used to determine if
and what type (read-only or writable) of SNMP proxy points can be created for the given entry.

NiagaraAX
37
Snmp Guide Revised: April 18, 2006
Chapter 3 — Niagara SNMP Concepts
SNMP point manager

• Status
The current relevance of the MIB entry: mandatory, current, optional, deprecated, or obsolete. For
display purposes only, does not affect creation of SNMP proxy points based on the entry.
• ElementType
This column is only used internally by Niagara during creation of SNMP proxy points based on
selected entries in the table. It displays whether the MIB entry is a sequence element, trap-type,
notification-type, or non-sequence element.
• Description
Displays a summary of the function of the given MIB entry.

About the SNMP point manager Database pane


The SNMP point manager Database pane is located below the Discover pane. This pane lists the
proxy points that are currently in the database. You may edit some of the point values, depending on
the value type, by double clicking on the desired row and using the Edit dialog box. The columns of
the table include:
• Path
This column displays the ORD path, starting from the station database to the listed point.
• Name
This is the displayed point name.
• Type
This is the type of object given in the SYNTAX section of the MIB entry. Common examples are
Integer, DisplayString, Gauge, IpAddress, Counter, TimeTicks, etc. This type is used to pre-con-
figure the 'Variable Type' property of any created writable SNMP proxy points based on the entry.
• Out
This is the value of the point
• Object Identifier
The Object Identifier of the given point. This OID will be pre-configured in the 'Object Identifier'
property of any created SNMP proxy points based on the entry.
• Variable Type
This is the variable type of the proxy point. You can edit the variable type for input values but
cannot edit the variable type for output values.
• Enabled
This property allows you to set the proxy point in service (with a true value) or to set it out of
service (with a false value).
• Device Facets
This property represents the device proxy point facets for how the value should be displayed in
Niagara.
• Facets
This property represents the parent Niagara proxy point’s facets, for how the value should be dis-
played in Niagara.
• Conversion
This property specifies the conversion to use between the “read value” (in Device Facets) and the
parent point facets, where “Default” is typically used.

NiagaraAX
38 Revised: April 18, 2006 Snmp Guide
Chapter 3 — Niagara SNMP Concepts
SNMP point manager

• Read Value
(read only) This is the last value read from the device, expressed in device facets.
• Write Value
(read only) This is applies only if the point is writable. This is the last value written, using device
facets.
• Tuning Policy Name
This property specifies the SNMP service type to use when binding to this item.
• Value
This column displays the point value. When the MIB is loaded but not “walked” the value column
is empty.

About SNMP “Discover”


The SNMP point discovery (or “learn”) process includes two steps:
• Loading the MIB
“Loading the MIB” is the process where the point manager compiles, reads, and displays points in
the table pane of the SNMP point manager view. See “Loading the MIB” on page 40 for details.
• Walking the MIB
“Walking the MIB is where communication takes place between an agent (client) application and
a manager application to discover the point values for those loaded point types that have values
available.

SNMP point discover options


The SNMP point manager provides options for accomplishing proxy point discovery.
Figure 18 SNMP discover options

• Load MIB only


This option provides for loading the MIB and populating the point table based on the MIB file(s)
that you select (see “Loading the MIB” on page 40 for details). No data values are determined for
point types that are defined in the MIB. This might be an option that you use when you are devel-
oping an application offline. After developing your application, you can “walk” the MIB when
you can establish communication between the SNMP agent and manager applications.
• Walk current MIB only
This option allows you to discover and load values for the points in your SNMP point manager
table. These points must have already been defined by loading the MIB.
• Load MIB and Walk MIB
This option performs both of the processes consecutively. The selected MIB file(s) is loaded and
subsequently “walked” to determine the values for the points defined by the MIB.

NiagaraAX
39
Snmp Guide Revised: April 18, 2006
Chapter 3 — Niagara SNMP Concepts
SNMP point manager

• Configure Auto-loaded MIBs

You can set one or more files to load automatically every time you do a Discover action using the
Discover button on the SNMP point manager view. You enable this option by specifying
“dependent” files in the Auto-Loaded MIBs dialog box.

Loading the MIB


When a MIB file is “loaded”, the MIB file and any dependent files are read into memory. The object
types that are available for a device are limited to those types that are defined in the MIB file. Loading
the MIB is a client-side operation that does not require remote communication. When a MIB file load
is initiated using the Discover button, the Select MIB(s) to load dialog box appears, as
shown in Figure 20.
Figure 19 Selecting MIB files to load

In this dialog box, you can select all files that are required to load the MIB (including those MIB files
that satisfy dependencies). If you have not used the auto-loaded MIBs feature, you must select all of
the required files at the same time by holding down the Ctrl key and clicking and highlighting each
file to be loaded.
Note: The SNMP point manager can accept these MIB files in any order, so you do not have to
know the MIB's load order dependencies (however, you will need to know which MIB file
will be compiled and loaded last as this is the MIB file that will be displayed in the table)
Once you have highlighted all necessary MIB files, selecting the Open button in the dialog box
begins the compile process. The resulting table contains only MIB entries for the most recent MIB
file to be compiled and loaded.
If there are errors when trying to compile the MIB files that you selected, an error message displays to
indicate the errors encountered. For example, a missing dependent MIB file (if you forgot to highlight
a necessary dependent MIB file) would cause an exception pop-up similar to the one shown in Figure
20

NiagaraAX
40 Revised: April 18, 2006 Snmp Guide
Chapter 3 — Niagara SNMP Concepts
SNMP point manager

Figure 20 MIB compile error message

If no errors are encountered after issuing the LoadMIB command, the MIB entries contained in the
loaded MIB file appear in the table (as shown in Figure 16 and Figure 17).

Configuring auto-loaded MIBs


The Auto-Loaded MIBs dialog box provides an optional way to load MIB files that satisfy dependen-
cies of the primary MIB file. You can always simply select required dependency MIB files at the
same time that you select your primary MIB file. However, the auto-loading feature is a convenient
alternative way to load these files and is a time-saver if you need to repeatedly load the same depen-
dency MIB files. Once the auto-loading MIB files are defined in the Auto-Loaded MIBs dialog
box (as shown in Figure 21) they are loaded any time that a Load MIB type command is issued (for
example, Load MIB and Walk MIB or Load MIB only).
Note: The auto-loaded MIBs list configuration is saved as a user option. Therefore, running Work-
bench from a different platform may present you with a different MIB auto-load list.
Figure 21 Configuring auto-loaded MIBs

The Auto-Loaded MIBs dialog box allows you to add and remove MIB files from the MIB auto-
load list, as described below:
• Add MIB(s) to the auto-load list
Click the Add button to navigate to (and select) files to add to the auto-load list. Files selected
with this function are added to the list of auto-loaded MIBs that appear in the Auto-Loaded
MIBs dialog box, as shown in Figure 21.
• Remove MIB(s) from the auto-load list
Use the Remove button to take any selected MIB files off the auto-load list.

NiagaraAX
41
Snmp Guide Revised: April 18, 2006
Chapter 3 — Niagara SNMP Concepts
Troubleshooting and debugging

Troubleshooting and debugging


You can view debugging messages specific to the SNMP driver by configuring the diagnostics -
logSetup view of a running station with an SnmpNetwork (see example below).
A single log is created for an SnmpNetwork object existing in a running station (named SnmpNet-
work). This log is used for displaying SNMP-specific information to standard output. If you enable
Trace for this log, it displays all levels of debug information specific to the SNMP driver to the stan-
dard output, including SNMP communication (such as byte requests/responses).
Note: Enabling Trace for this log may lower performance due to the extra overhead of writing to
standard output. You should use this function when you need to debug your application and
then disable it when you are finished. The SnmpNetwork log only shows debug information
particular to its own network (and devices/proxy points underneath). You can use the Trace
feature to verify communications and polling of your devices/proxy points.
Figure 22 SNMP log setup

NiagaraAX
42 Revised: April 18, 2006 Snmp Guide
Chapter 4 — Using the Plugin Guides
Plugin Guides Summary

Using the Plugin Guides


Plugins provide a visualization of a Component.

Plugin Guides Summary


There are many ways to view plugins. One way is directly in the tree. In addition, you can right-click
on an item and select one of its views. Plugins provide views of Components. You can access docu-
mentation on a Plugin by selecting Help > On View (F1) from the menu or pressing F1 while the
Plugin is selected.

snmp-MIBPointListManager
Use MIBPointListManager to view a snmp Exports. The MIBPointListManager is a view on the
SnmpDevice. To view, right-click SnmpDevice and select Views > MIB Point List Man-
ager.

snmp-SnmpAgentPointManager
Use the SnmpAgentPointManager to create, edit, access, and delete SnmpAgent proxy points under a
SnmpAgent. The SnmpAgentPointManager is the default view for the SnmpAgentPointDeviceExt
(Points container) under an SnmpAgent. The SnmpAgentPointManager is also the default view for
any SnmpAgentPointFolder under the Points container of an SnmpAgent.
To view, right-click a SnmpAgentPointDeviceExt or SnmpAgentPointFolder and select Views >
SNMP Agent Point Manager

snmp-SnmpDeviceManager
Use the SnmpDeviceManager to create, edit, and view both SnmpDevices and SnmpAgents under a
SnmpNetwork. The SnmpDeviceManager is the default view on the SnmpNetwork. To view, right-
click SnmpNetwork and select Views > SNMP Device Manager

snmp-SnmpPointManager
Use the SnmpPointManager to create, edit, access, and delete SNMP proxy points under a SnmpDe-
vice. The SnmpPointManager is the default view for the SnmpPointDeviceExt (Points container)
under an SnmpDevice. The SnmpPointManager is also the default view for any SnmpPointFolder
under the Points container of an SnmpDevice.
To view, right-click a SnmpPointDeviceExt or SnmpPointFolder and select Views > SNMP
Point Manager

NiagaraAX
41
Snmp Guide Revised: April 18, 2006
Chapter 4 — Using the Plugin Guides
snmp-SnmpTrapManager

snmp-SnmpTrapManager
Use the SnmpTrapManager to discover, compile, display, and store traps from MIB files for an
SnmpDevice. The SnmpTrapManager is the default view for an SnmpDevice’s TrapTable slot
(default name Trap Types).
To view, right-click the TrapTable of an SnmpDevice and select Views > SNMP Trap Man-
ager

NiagaraAX
42 Revised: April 18, 2006 Snmp Guide
Chapter 5 — Using the Component Guides
Component Reference Summary

Using the Component Guides


The Component Guides provides help on common components. In addition, developer bajadoc help
is referenced.

Component Reference Summary


Summary provides summary information on the components.

snmp-MIBListTable
MIBListTable captures information about MIB entries within SnmpDevices. The MIBListTa-
ble is available in the snmp module. Bajadoc is available at BMIBListTable.bajadoc

snmp-SnmpAgent
SnmpAgent represents the local Niagara station as an SNMP agent device holding agent data
that can be viewed and changed via SNMP from an outside SNMP manager. The SnmpAgent is
available in the snmp module. Bajadoc is available at BSnmpAgent.bajadoc

snmp-SnmpAgentBooleanProxyExt
SnmpAgentBooleanProxyExt contains information necessary to hold a boolean data value
which can be set by an outside SNMP manager. Bajadoc is available at BSnmpAgentBoolean-
ProxyExt.bajadoc

snmp-SnmpAgentPointDeviceExt
SnmpAgentPointDeviceExt is the container for SNMP agent proxy points representing SNMP
agent data values. The SnmpAgentPointDeviceExt is available in the snmp module. Bajadoc is
available at BSnmpAgentPointDeviceExt.bajadoc

snmp-SnmpAgentPointFolder
SnmpAgentPointFolder is the SNMP implementation of a folder under a SnmpAgent’s Points
extension. You add such folders using the New Folder button in the view of the Points extension.
Each SnmpAgentPointFolder has its own view. The SnmpAgentPointFolder is also available in the
snmp palette. Bajadoc is available at BSnmpAgentPointFolder.bajadoc

NiagaraAX
43
Snmp Guide Revised: April 18, 2006
Chapter 5 — Using the Component Guides
snmp-SnmpAgentNumericProxyExt

snmp-SnmpAgentNumericProxyExt
SnmpAgentNumericProxyExt contains information necessary to hold a float (or integer) data
value which can be set by an outside SNMP manager. Bajadoc is available at BSnmpAgentNu-
mericProxyExt.bajadoc

snmp-SnmpAgentStringProxyExt
SnmpAgentStringProxyExt contains information necessary to hold string data value which can
be set by an outside SNMP manager. Bajadoc is available at BSnmpAgentStringProxyExt.baja-
doc

snmp-SnmpBooleanProxyExt
SnmpBooleanProxyExt contains information necessary to read a boolean data value from an
SNMP device. For numeric read SNMP data types, a value of zero is interpreted as a false, and
anything else is interpreted as a true. For a read String SNMP data type, the string read will be com-
pared with the true/false text for the point in order to determine the boolean value. The default is false
(also used if cannot interpret).
Each readonly proxy point that represents a readable boolean SNMP data quantity will have an
SnmpBooleanProxyExt to describe how to read the point. Bajadoc is available at BSnmpBoolean-
ProxyExt.bajadoc

snmp-SnmpDevice
SnmpDevice represents a remote SNMP device that is treated as an agent. The SnmpDevice is
available in the snmp module. Bajadoc is available at BSnmpDevice.bajadoc

snmp-SnmpDeviceFolder
SnmpDeviceFolder is the SNMP implementation of a folder under an SnmpNetwork. Typically,
you add such folders using the New Folder button in the SnmpDeviceManager view of the Snmp-
Network. Each SnmpDeviceFolder has its own SnmpDeviceManager view. Bajadoc is available at
BSnmpDeviceFolder.bajadoc

snmp-SnmpNetwork
SnmpNetwork represents a network of manageable SNMP devices. Can also be configured to
handle sending and receiving SNMP trap messages, as well as respond to SNMP requests from
outside managers. The SnmpNetwork is available in the snmp module. Bajadoc is available at BSn-
mpNetwork.bajadoc

NiagaraAX
44 Revised: April 18, 2006 Snmp Guide
Chapter 5 — Using the Component Guides
snmp-SnmpNumericProxyExt

snmp-SnmpNumericProxyExt
SnmpNumericProxyExt contains information necessary to read a float (or integer) data value
from a SNMP device.
Each read-only proxy point that represents a readable float (integer) SNMP data quantity will have a
SnmpNumericProxyExt to describe how to read the point. Bajadoc is available at BSnmpNumer-
icProxyExt.bajadoc

snmp-SnmpPointDeviceExt
SnmpPointDeviceExt is the container for SNMP proxy points representing SNMP device data
values. The SnmpPointDeviceExt is available in the snmp module. Bajadoc is available at BSn-
mpPointDeviceExt.bajadoc

snmp-SnmpPointFolder
SnmpPointFolder is the SNMP implementation of a folder under a SnmpDevice’s Points exten-
sion. You add such folders using the New Folder button in the view of the Points extension. Each
SnmpPointFolder has its own view. The SnmpPointFolder is also available in the snmp palette. Baja-
doc is available at BSnmpPointFolder.bajadoc

snmp-SnmpPollScheduler
SnmpPollScheduler. The SnmpPollScheduler is available in the snmp module. Bajadoc is avail-
able at BSnmpPollScheduler.bajadoc

snmp-SnmpRecipient
SnmpRecipient recipient class is used to send alarm traps to an snmp network manager and to
store alarms until acknowledged. The SnmpRecipient is available in the snmp module. Bajadoc
is available at BSnmpRecipient.bajadoc

snmp-SnmpStringProxyExt
BSnmpStringProxyExt contains information necessary to read a String data value from a
SNMP device.
Each readonly proxy point that represents a readable string SNMP data quantity will have an Snmp-
StringProxyExt to describe how to read the point. Bajadoc is available at BSnmpStringProxyExt.baja-
doc

NiagaraAX
45
Snmp Guide Revised: April 18, 2006
Chapter 5 — Using the Component Guides
snmp-TrapTable

snmp-TrapTable
TrapTable captures information about stored trap types within an SnmpDevice. It is a frozen
slot in an SnmpDevice (default name Trap Types), and contains child TrapType slots. The
default view for an SnmpDevice’s TrapTable is the SnmpTrapManager. Bajadoc is available at
BTrapTable.bajadoc

snmp-TrapType
TrapType stores a possible trap type for an SnmpDevice, and resides under an SnmpDevice’s
TrapTable. Bajadoc is available at BTrapType.bajadoc

NiagaraAX
46 Revised: April 18, 2006 Snmp Guide

You might also like