®
USER’S GUIDE
SNMP OPC Gateway
Contents
Introduction--1
Product definition 1 Implementing SNMP 2
Integrating SNMP into the user interface 3 Components of OPC SNMP Gateway 4
How to Obtain an OPC License--5
Creating a System Code 5 Entering an Authorization Code 6
Getting Started with SNMP Editor--7
Auto-discovery of Network Devices. . . 8
Before using the Auto-discovery feature of SNMP OPC Gateway 8
Using Auto-discovery in SNMP Editor 8
Setup for Auto-Discovered Unmanaged Devices . . . 10
Device tab 11 Advanced tab 11
Setup for Auto-Discovered SNMP-Managed Devices. . . 13
Device tab 13 Advanced tab 15
Manual Network Device Configuration--17
Manual Network Device Setup—Unmanaged. . . 18
Basic setup 18
Advanced tab—unmanaged device 18
Manual Network Device Setup—Managed. . . 20
®
USER’S GUIDE
SNMP OPC Gateway
Tag Configuration--22
Polled Tag Configuration 22
Creating Trap tags within SNMP 25 Finding tags 28
Filtering tags 29
Importing Templates--30
SNMP Traps and Event Notification--32
Advanced SNMP Settings--37
User-Defined Tag Setup--40
SNMP Communicator--42
Browsing an Existing SNMP OPC Gateway Database 43 Reading SNMP Data 48
Writing SNMP Data 48
Spot-Checking SNMP Data 48
SNMP Dataviewer--51
Reading Data 51 Writing Data 54
Saving and retrieving Dataview windows 55 Advanced settings 56
®
USER’S GUIDE
SNMP OPC Gateway
Introduction
Simple Network Management Protocol (SNMP) device management is one of the tools available from modern Ethernet devices such as APC
uninterruptible power supplies (UPSs). It offers the industrial user remote access to real-time performance and troubleshooting data. Implementing an SNMP-based network management system to monitor critical network infrastructure can help to ensure that Ethernet network-based control systems perform reliably.
Product definition
SNMP provides remote management access to an Ethernet network device. A microprocessor-based management agent in the manageable device gathers diagnostic and device configuration data from the device and stores this information in memory locations, similar to data registers in a Programmable Logic Controller (PLC). The data can be accessed by polling the SNMP agent in the network device from a remote computer, using the SNMP communication protocol. The database within the
manageable device is called a Management Information Base (MIB). There are two types of MIBs, public and private. Public MIBs contain information common among most network devices. Private MIBs contain information unique to a manufacturer’s products.
®
USER’S GUIDE
SNMP OPC Gateway
Currently, network administrators can use a variety of stand-alone network management software tools which allow them to display and historically record network status information. Information provided by an SNMP-manageable APC UPS includes online/battery status, battery maintenance notification, power conditioning, and more. In addition to providing
information, SNMP allows an administrator to configure devices remotely and perform management functions, such as setting a device name.
Implementing SNMP
Implementing SNMP device management into your network requires the following:
• The use of a TCP/IP-based Ethernet network.
• “Manageable” network devices. APC offers an optional slide-in UPS Network Management Card for many of its UPS products to convert the unmanaged UPS into a networked SNMP-manageable device. • A network management software package. Implementing the network
management software in a industrial control network is commonly accomplished by using a dedicated network administrator computer. Unfortunately, this method leads to a total control system that has two “dashboards.” One “dashboard” displays the SNMP management information. The other “dashboard” is the Human-Machine Interface (HMI) package, which displays real-time PLC and control system parameters.
®
USER’S GUIDE
SNMP OPC Gateway
Integrating SNMP into the user interface
Using the OPC Server within SNMP OPC Gateway, you can integrate APC UPS management data into any OPC-client control system. SNMP MIB data can be converted to user interface “tags” using this tool. This merging of the network and control system data into the same interface ensures that analysis of control system problems includes network status at the time the problem occurred. Operating two “dashboards” is no longer necessary. The historical data logging, trending, and graphical user interface tools that are part of modern user interface software can now be used to track UPS infrastructure as well.
®
USER’S GUIDE
SNMP OPC Gateway
Components of OPC SNMP Gateway
SNMP Editor. Use the Editor to configure the SNMP database.
SNMP OPC Gateway Communicator. Use the Communicator to verify
data directly from the Network Management Card.
SNMP OPC Gateway Dataviewer. Use the Dataviewer to verify that the
SNMP OPC Server is collecting and sharing data properly.
SNMP OPC Gateway OPC Server Interface. Use the Server Interface to
®
USER’S GUIDE
SNMP OPC Gateway
How to Obtain an OPC License
There are two steps to obtaining an OPC SNMP Gateway software license—first, create a system code and submit that code to APC, and second, enter the authorization code in the License Utility.
Creating a System Code
To create a system code for the computer that will be running the licensed software:
1. Open the License Utility using the following path: Start > Programs > American Power Conversion > SNMP OPC Gateway > License Utility.
2. Choose Step 1—Generate System Code, then click Next.
3. Type in the product serial number and click Next. The product serial number is located on the card enclosed with your SNMP OPC
Gateway software CD. This serial number generates your unique system code.
4. Call the APC Enterprise Account Team at 888-278-0350, or e-mail them at eas@apcc.com, and APC will generate your license code. 5. When you receive your license code from APC, enter an authorization
®
USER’S GUIDE
SNMP OPC Gateway
Entering an Authorization Code
To complete the licensing process:
1. Open the License Utility using the following path: Start > Programs > American Power Conversion > SNMP OPC Gateway > License Utility.
2. Choose Step 2—Enter Authorization Code and click Next. 3. Enter the license code you received from APC and click Next. 4. When the confirmation page appears, showing that licensing is
®
USER’S GUIDE
SNMP OPC Gateway
Getting Started with SNMP Editor
Before you can monitor your network devices, the Simple Network
Management Protocol (SNMP OPC Gateway) must first be made aware of the network devices to monitor.
To quickly set up a database of network data:
1. Auto-discover or manually define your network devices.
2. Define the data points you want to read from the network devices. 3. Do one of the following:
a. Monitor the configured devices in the SNMP Dataviewer.
b. Set up your user interface to read the OPC tags from the SNMP Server.
To define the UPSs or other APC devices in your network, either auto-discover the network devices (recommended), or define the network devices manually (advanced).
®
USER’S GUIDE
SNMP OPC Gateway
Auto-discovery of Network Devices
Before using the Auto-discovery feature of SNMP
OPC Gateway
Ensure that the IP address(es) of your APC devices are already assigned and the devices are on to the network.
Most Windows® 2000 and Windows XP Professional operating systems have SNMP services enabled by default, but to monitor SNMP data from Windows NT workstations, you may have to install SNMP services. Detailed instructions are available from the Microsoft help files.
Using Auto-discovery in SNMP Editor
Use the following path to open SNMP Editor: Start > Programs >
American Power Conversion > SNMP OPC Gateway > SNMP Editor. 1. Make sure that the SNMP computer is connected to the Ethernet
network on which you want to auto-discover network devices. 2. Click the green eye on the SNMP Editor taskbar, or select
Auto-discover from the Operations menu.
3. In the Search Network dialog box, enter the first and last IP address for the range of the Ethernet devices in your network, and click Begin.
See also
For help configuring your network devices, see the device’s network management manual, or contact your supplier for the hardware. For an APC UPS, see the Network Management Card Installation and Quick-Start manual, provided with network-manageable UPSs, with any separately ordered Network Management Card, and on the APC Web site,
®
USER’S GUIDE
SNMP OPC Gateway
4. After SNMP OPC Gateway searches the network, the Discovered Devices dialog box displays a list of both SNMP-manageable and currently unmanaged devices.
To add devices identified by the auto-discovery tool to SNMP Editor,
double-click the device’s IP address in the Discovered Devices dialog box. If you defined or auto-discovered a device previously, the
Current Devices dialog box lists it below Discovered Devices.
If the device is unmanaged, see Setup for Auto-Discovered
Unmanaged Devices. If the device is SNMP-manageable, see
®
USER’S GUIDE
SNMP OPC Gateway
Setup for Auto-Discovered Unmanaged Devices
If an unmanaged device is auto-discovered, SNMP assigns it the following default device name: (Unmanaged Device) - xxx.xxx.xxx.xxx. Use the Device Wizard to define the device’s name, description, and advanced settings. To access the Device Wizard (shown below), select the New Item
®
USER’S GUIDE
SNMP OPC Gateway
Device tab
1. Replace the default device name with a brief, logical Name (such as SNMP product 1).
2. Leave the Devicefield as (Unmanaged Device). 3. Leave the IP address field unchanged.
4. If desired, type a brief description of the device in the Description
field.
Advanced tab
The following Advanced tab settings define how the SNMP OPC Gateway reacts if a field device is not responding promptly. For APC devices, leave these settings at the default values unless an APC Enterprise Account Support technician asks you to make changes. If you have problems communicating with an APC field device, contact APC Enterprise Account Support.
®
USER’S GUIDE
SNMP OPC Gateway
• Device Time Out (ms): The amount of time allowed to complete an SNMP GET. In situations where there is heavy network traffic, the customer support technician may ask you to set a longer timeout before SNMP assumes a communication failure has occurred. The default setting of 500 ms is suitable for most applications.
• Device Retries: The number of times that SNMP attempts to retrieve data before assuming that the device has failed.
• Skip Count: The amount of time that SNMP waits before attempting another GET from a device that has failed. For example, an 800 ms device timeout with a skip count setting of 30 will result in a 24000 ms delay before a new GET attempt.
®
USER’S GUIDE
SNMP OPC Gateway
Setup for Auto-Discovered SNMP-Managed Devices
SNMP-manageable devices can provide much detailed network data. In addition, for APC network devices, SNMP can provide auto-discovered device data to monitor the communication status of the network devices during periods of inactivity. Use the SNMP Editor Device Wizard. To open the Device Wizard, select the New Item icon ( ), then select Managed (SNMP).
Device tab
If SNMP OPC Gateway recognizes the managed device from its pre-defined list of supported network devices, much of the required information is already displayed.
®
USER’S GUIDE
SNMP OPC Gateway
Complete the device configuration as follows:
1. By default, SNMP OPC Gateway creates a device name by merging the type of network device that it discovered with the device’s IP address. Since the device name often is used as part of an OPC address string in your user interface, change the Device Name to a shorter, unique string.
2. If the network device that you are configuring is one of the devices SNMP OPC Gateway has in its pre-defined device list, select it in the drop-down Devicemenu. The type of network device that SNMP detected will already be displayed. If the network device that you are setting up is not part of the pre-defined list, leave the Device field blank. You will have to create each SNMP data tag individually. 3. Do not change the address in the IP Address field. This address
follows standard IP addressing format (for example: 192.168.0.30). 4. Community is the control access level you will use when
communicating with the network device. In an SNMP-manageable device, you can limit the access that an SNMP manager application (such as SNMP itself) can have, based on the manager software’s password level. There are generally two default password (community) levels—Read-only and Read/Write. In most SNMP devices, including APC devices, the default community for Read-only privileges is Public, and the default community for Read/Write privileges is Private. Some SNMP-manageable devices can be configured to have custom levels of access. To limit access for only a few SNMP tags, select the highest access level for the device, and then limit the access level for specific SNMP tags within SNMP OPC Gateway Editor.
5. Specifying a value in the Descriptionfield is optional, but helps you recognize a device in the SNMP OPC Gateway Editor.
See the Tag Configuration help for more information on how to limit access on a tag-by-tag basis.
®
USER’S GUIDE
SNMP OPC Gateway
Advanced tab
The following Advanced tab settings define how the SNMP OPC Gateway reacts if a field device is not responding promptly. For APC devices, leave these settings at the default values unless an APC Enterprise Account Support technician asks you to make changes. If you have problems communicating with an APC device, contact APC Enterprise Account Support.
• Device Time Out (ms): The amount of time allowed to complete an SNMP GET. In situations where there is heavy network traffic, the customer
support technician may ask you to set a longer timeout before SNMP assumes a communication failure has occurred. The default setting of 800 ms is suitable for most applications.
®
USER’S GUIDE
SNMP OPC Gateway
• Device Retries: The number of times that SNMP attempts to retrieve data before assuming that the device has failed.
• Skip Count: The amount of time that SNMP waits before attempting another GET from a device that has failed. For example, defining an 800 ms device timeout with a skip count setting of 30 will result in a 24000 ms delay before a new GET attempt.
• No. of Items/Message: The SNMP OPC Gateway software requests data in groups of Object Identifiers (OIDs). Number of Items/Messages refers to the number of OIDs requested in one SNMP GET. For most networks, 25 items is the ideal message size for the best performance. When you finish configuring the field definitions, select OK. If you selected a pre-defined tag database from the drop-down menu, SNMP OPC Gateway prompts you to auto-import the tag database for the defined network device. Click OK.
SNMP will automatically populate the tag list for the device and will
automatically populate your tag database with all the SNMP data that can be accessed from the device.
If you have a pre-defined device tag database, this device is completely configured. You can either add additional network devices, or save your configuration and exit the SNMP Editor.
In some cases many tags may be imported, and in other cases only a few tags may be imported.
®
USER’S GUIDE
SNMP OPC Gateway
Manual Network Device Configuration
To define a device that has not yet been installed on the network or to list and set up a device without using Auto-Discovery, use the following procedure.
1. Place the mouse pointer over the Network Devices tab in SNMP Editor, and right-click the mouse.
2. Select New Device. Select either a managed device or an unmanaged device.
To set up an unmanaged device, see Manual Network
Device Setup—Unmanaged.
To set up an SNMP-manageable device, see Manual
®
USER’S GUIDE
SNMP OPC Gateway
Manual Network Device Setup—Unmanaged
Basic setup
1. Open the Device Wizard. Select the New Item icon ( ), then select
Managed (SNMP).
2. In the Device Wizard Name field, type a brief, logical alias for the device.
3. In the DeviceField, use the drop-down menu to select (Unmanaged Device).
4. Type the IP address of the unmanaged device into the IP Address
field.
5. Optionally, type a brief description of the device in the Description
field.
Advanced tab—unmanaged device
The following Advanced tab settings define how the SNMP OPC Gateway reacts if a field device is not responding promptly. For APC devices, leave these settings at the default values unless an APC Enterprise Account Support technician asks you to make changes. If you have problems communicating with an APC device, contact APC Enterprise Account Support.
The following list defines the Advanced tab fields:
• Device Time Out (ms): The amount of time allowed to complete an SNMP GET. In situations where there is heavy network traffic, the customer support technician may ask you to set a longer timeout before SNMP assumes a communication failure has occurred. The default setting of 500 ms is suitable for most applications.
• Device Retries: The number of times that SNMP attempts to retrieve data before assuming that the device has failed.
®
USER’S GUIDE
SNMP OPC Gateway
• Skip Count: The amount of time that SNMP waits before attempting another GET from a device that has failed. For example, defining an 800 ms device timeout with a skip count setting of 30 will result in a 24000 ms delay before a new GET attempt.
®
USER’S GUIDE
SNMP OPC Gateway
Manual Network Device Setup—Managed
If SNMP OPC Gateway recognizes the managed device from its
pre-defined list of supported network devices, much of the required information is already displayed.
Complete the device configuration as follows:
1. By default, SNMP OPC Gateway creates a device name by merging the type of network device that it discovered with the device’s IP address. Since the device name often is used as part of an OPC address string in your user interface, change the device name to a shorter, unique string.
2. If the network device that you are configuring is one of the devices SNMP OPC Gateway has in its pre-defined device list, select it from the drop-down Device menu. The type of network device that SNMP detected will already be displayed. If the network device that you are setting up is not part of the pre-defined list, leave the Device field blank. You will have to create each SNMP data tag individually. 3. Do not change the address in the IP Address field. This address
follows standard IP addressing format (for example: 192.168.0.30). 4. Community is the control access level you will use when
communicating to the network device. In an SNMP-manageable device, you can limit the access that an SNMP manager application (such as SNMP itself) can have, based on the manager software’s password level. There are generally two default password (community) levels—Read-only and Read/Write. In most SNMP devices, including APC devices, the default community for Read-only privileges is Public, and the default community for Read/Write privileges is Private. Some SNMP-manageable devices can be configured to have custom levels of access. To limit access for only a few SNMP tags, you can select the
®
USER’S GUIDE
SNMP OPC Gateway
highest access level for the device, and then limit the access level for specific SNMP tags within SNMP OPC Gateway Editor.
5. Specifying a value in the Descriptionfield is optional, but in larger networks, it may help you recognize the device you are looking at in the SNMP OPC Gateway Editor.
Managed device advanced tab
The following Advanced tab settings define how the SNMP OPC Gateway reacts if a field device is not responding promptly. For APC devices, leave these settings at the default values unless an APC Enterprise Account Support technician asks you to make changes. If you have problems communicating with an APC device, contact APC Enterprise Account Support.
• Device Time Out (ms): The amount of time allowed to complete an SNMP GET. In situations where there is heavy network traffic, the customer support technician may ask you to set a longer timeout before SNMP assumes a communication failure has occurred. The default setting of 500 ms is suitable for most applications.
• Device Retries: The number of times that SNMP attempts to retrieve data before assuming that the device has failed.
• Skip Count: The amount of time that SNMP waits before attempting another GET from a device that has failed. For example, defining an 800 ms device timeout with a skip count setting of 30 will result in a 24000 ms delay before a new GET attempt.
See the Tag Configuration help for more information on how to limit access on a tag-by-tag basis.
®
USER’S GUIDE
SNMP OPC Gateway
Tag Configuration
You can create two major types of tags within SNMP.
• Polled tags are tags that SNMP uses to retrieve data from network devices on a regular basis.
• Traps are tags that SNMP uses to retrieve data from devices that are not polled, and broadcast alarm messages.
Polled Tag Configuration
To define polled tags manually (if you are not auto-discovering your network devices or if auto-discovery did not find an OID that you need):
• Open SNMP Editor by selecting Programs from your computer’s Start
menu, then American Power Conversion, then OPC Gateway. Select Editor, then Device, and right click in the Description field. • Highlight the network device to which you want to add an SNMP tag in
the SNMP Editor’s left screen frame.
®
USER’S GUIDE
SNMP OPC Gateway
In the dialog box for creating a new SNMP database tag:
1. In the Name field, enter a logical and brief description of the MIB object data being read. (For example, if the MIB data represents the current link status for Port Number 1 on a network switch, a brief tag name might be PortLink1.)
2. In the ObjectID field, enter the specific data address for the information you are requesting from the SNMP agent. Most MIB
addresses use an Object ID nomenclature of a leading period, followed by a series of whole numbers separated by periods (for example: .1.3.6.1.2.1.2.2.1.7.1 ).
See also
For MIB information, see the APC MIB Guide supplied with your SNMP-manageable device.
®
USER’S GUIDE
SNMP OPC Gateway
If the Object ID for the tag does not reference a table, the offset is 0. In those cases where the Object ID references a table, the offset is the number of SNMP GET calls needed to access all the data of the table. For information on the structure of MIB, see the documentation
provided by the manufacturer of the device you are monitoring, or for APC devices, see the APC MIB Reference Guide.
3. In the Data Type drop-down list, select the data type for the MIB data you are requesting.
4. In the Descriptionfield, the tag description is optional, but helps identify the tag in the SNMP Editor.
5. As the Access selection for the tag, you can choose to limit
communication to the tag to allow only reading of the data. Some MIB data can be set, such as a System Contact field. Leaving this box un-checked will allow write commands to be sent to the MIB data point.
6. You can create additional OPC tags that can help in network History
applications. Selecting the Previous Value box creates an OPC tag that retains the previous SNMP GET value. The Delta time box
creates a tag based on the difference in time between the values of the For APC device Object ID addresses and descriptions, see
the APC PowerNet MIB.
The SNMP agent on the network device might only support read-only access for all or some tags, and selecting write privileges from within SNMP OPC Gateway does not guarantee that write commands will be executed. See the network management manual for your network device to determine the access it supports. The SNMP agent on APC devices supports different access for different tags. For APC devices, view the OIDs in the APC MIB through your MIB browser to determine access on a tag-by-tag basis.
®
USER’S GUIDE
SNMP OPC Gateway
current and last SNMP Object ID. The Moving Average section
creates an OPC tag for a moving average of a particular SNMP value.
After you finish the field definitions, click OK. The tag that you just created appears on the first line on the right frame of the SNMP OPC Gateway interface.
To add additional tags for this device, right-click on the right frame of the SNMP Editor interface and follow the preceding procedure (Polled Tag Configuration) again.
After you create all the tags for the network device, you can either add another network device or close the SNMP Editor and begin to view the SNMP data from your OPC client program by using SNMP Dataviewer. You can use this tool to view the SNMP data in your configured system.
Creating Trap tags within SNMP
If a network agent has been configured to generate traps, the network agent broadcasts a string of data to all configured SNMP manager applications whenever specified trap conditions occur. The trap string includes the unique SNMP object identifier (OID) address of the trap
condition. When SNMP receives a trap from a field device, it compares the incoming trap string to the defined Trap tags for that field device. For traps
In most applications, selecting any of the History options is unnecessary. For APC devices, consult APC Enterprise Account Support for assistance with these tags.
For more information on using SNMP Dataviewer, see SNMP Dataviewer
®
USER’S GUIDE
SNMP OPC Gateway
that have been defined within SNMP Editor, the incoming OID string is converted from the raw x.x.x.x.x.x format into the associated OPC tag name for the trap. SNMP makes the trap name available as part of the Event
string to be displayed within your user interface. If a matching OID address for an incoming trap cannot be found, SNMP displays the raw OID in the trap string alongside the time stamp and trap condition value.
If you do not want to receive a raw OID in the Event string from a trap, and want a Tag name instead, define the Trap tag manually.
1. Open SNMP Editor by selecting Programs from your computer’s Start
menu, then American Power Conversion, then OPC Gateway. Select Editor, then Device, and right click in the Description field. 2. First highlight the network device to which you want to add an SNMP
Trap tag to in the SNMP Editor left screen frame. With the correct device highlighted, move your mouse to the right screen frame, right-click, and select New Item.
3. The dialog box for creating a new SNMP database tag will appear. To configure the trap, you must do the following:
1. Give the trap a Name. The tag name should be a logical and brief description of the trap condition. ( For example, if the MIB data represents an overheat sensor, a simple name could be Overheat.) 2. Enter the value for the ObjectID field for the tag. The ObjectID is the
specific data address for the information that you are requesting from the SNMP agent. Trap addresses follow an OID nomenclature that has a series of whole numbers separated by periods. APC traps follow this data address: 1.3.6.1.4.4.318.
®
USER’S GUIDE
SNMP OPC Gateway
If the Object ID for the tag does not reference a table, the offset is 0. In those cases where the Object ID references a table, the offset is the number of SNMP GET calls needed to access all the data of the table. For information on the structure of MIB, see the documentation
provided by the manufacturer of the device you are monitoring, or for APC devices, see the APC MIB Reference Guide.
3. In the Data Type field, select the data type for the MIB data you are going to be requesting. Select Trap/Notification.
4. The fourth field is the Descriptionfield. Specifying a value in the Description field is optional, but it helps you recognize the device in the SNMP OPC Gateway Editor.
5. Make the Accessselection for the tag. If you click in this box, you can limit any communication to this tag to allow read-only access of the data. Some MIB data can be set, such as resetting a counter in the SNMP agent.
Leaving this box unchecked will allow write commands to be sent to the MIB data point.
You can find the Object ID addresses and descriptions in the network management manual supplied with your SNMP-manageable device. Be aware that some network component vendors have two product manuals—one for installing and operating the network device, the other detailing network management information.
The SNMP agent residing on the network device may support Read-Only access for all tags, or may support Read-Only access for some tags. Selecting write privileges from within SNMP OPC Gateway does not guarantee that write commands will be
executed. Consult the network management manual for your network device to be sure of the functionality supported.
®
USER’S GUIDE
SNMP OPC Gateway
6. The last section allows you to create some additional OPC tags that can help in network Historyapplications. The Historysection is not applicable to SNMP Traps.
After you have filled out the field definitions, click the OKbutton.
To add additional traps for this device, right click on the right frame of the SNMP Editor interface and repeat the preceding procedure.
Finding tags
To quickly locate an OID in the complete list of tags for that device, use the
FIND tag feature. Press the Find Tag button, as shown below:
Type all or part of the OID name in the dialog box and click Find Next. The find feature will display the next instance of the string of characters typed in the dialog box.
®
USER’S GUIDE
SNMP OPC Gateway
Filtering tags
To quickly locate a group of OIDs which include a specific string of
characters, select the Filter Tags feature by clicking the Filter Tags button on the interface.
Type all or part of the string in the dialog box and click OK.
SNMP OPC Gateway will return all tags for that device that include the string of characters you have defined.
®
USER’S GUIDE
SNMP OPC Gateway
Importing Templates
SNMP Editor enables you to import additional templates for devices into SNMP OPC Gateway. In SNMP Editor, select Operations, then Import Templates. Click Add to select the .csv file for the template you want to add.
®
USER’S GUIDE
SNMP OPC Gateway
The Import Templates tool allows you to select three options when adding templates:
• Prompt—If an imported template has the same name as an existing template in the template library, the system will prompt you to either overwrite the existing template with the imported template or leave the existing template in place (this is referred to as “skipping” the existing template).
• Overwrite—If an imported template has the same name as an existing template in the template library, the system will automatically overwrite the existing template.
• Skip—If an imported template has the same name as an existing template in the template library, the system will automatically skip the imported template.
®
USER’S GUIDE
SNMP OPC Gateway
SNMP Traps and Event Notification
SNMP supports both active polling of SNMP agents and the receipt of unsolicited event messages from SNMP agents. Unsolicited event messages sent by network agents to network manager applications are commonly called “traps”. A network agent transmits traps whenever a configured event, such as a link up/down change occurs.
To configure an SNMP Agent, and receive SNMP traps from it within SNMP, complete the following steps:
1. Configure the SNMP agents on the network manager(s) to send SNMP traps to the network manager application.
The network device should be receiving power. Access the device’s management menu. All devices are configured slightly differently, but the example on the next page shows a UPS being configured through its Web browser interface to send traps to an SNMP application
running on a PC with an IP address of 159.215.9.3.
APC network devices can be configured to send traps to more than one network agent, so if you are sharing network
hardware with your IT department, traps can be sent to both SNMP and the IT network management application
simultaneously. See the device’s manual for detailed instructions.
®
USER’S GUIDE
SNMP OPC Gateway
2. Verify that the network device and SNMP server are connected to the same network. Launch SNMP Editor and run the auto-discovery tool. (If you cannot run the auto-discovery tool, skip to step 3.)
If the network device has been correctly configured with an IP address, it will appear in the Discovered Devices window. If the device has a pre-defined SNMP MIB template, SNMP will recognize it and prebuild the tag database, including trap data. If the device is not supported as a pre-defined SNMP device, you will have to manually define the traps you wish to receive, and verify them as described in step 3, below.
®
USER’S GUIDE
SNMP OPC Gateway
3. Verify that SNMP is receiving the trap data from the target device. If you still have the SNMP Editor Application open, save and close it now. Launch the SNMP Dataviewer application using the following path:
Start > Programs > American Power Conversion > SNMP OPC Gateway > Tools > SNMP Dataviewer. Open the tree next to the device you wish to test, and scroll down until you see the Events group.
Select and move the Events Count and Event_xxx tags over to the active monitoring portion of the screen (the right frame).
For a description of the manual trap definition procedure, see
Creating Trap tags within SNMP.
There are often many tags; SNMP Dataviewer lists the tags and groups alphabetically.
®
USER’S GUIDE
SNMP OPC Gateway
Initially, you may not have any values in the trap tags to view. Begin to create trap conditions. For example, if the network device is a switch, and it is configured to send Link Up and Link Down traps, then you can connect and disconnect devices from the switch to create trap conditions. As trap conditions occur, you should see the trap counter increment, and the traps string sent by the network agent will be displayed in the value column of the Events detail tags. As SNMP traps are received from the network, SNMP places the most current trap in the Events_001 field, and moves the previous traps down by one on the range. This process enables a “first-in/first-out” alarm log history easily displayed in your user interface.
®
USER’S GUIDE
SNMP OPC Gateway
4. If you are receiving traps, you can now repeat the process for any other network devices from which you wish to receive traps.
The default number of Event strings is 10. If you wish to increase or decrease the number of Event strings available, open SNMP Editor, right click on the Events tab under the target device, and enter the number of notifications you need in the Notification box that appears.
®
USER’S GUIDE
SNMP OPC Gateway
Advanced SNMP Settings
To set advanced polling features:
1. Click Edit, then OPC Server Settings.
2. The OPC Server Settings page will appear (as pictured on the next page).
Warning
Do not change the default settings on the OPC Server Settings page unless you are experiencing problems with polling devices on your network.
®
USER’S GUIDE
SNMP OPC Gateway
®
USER’S GUIDE
SNMP OPC Gateway
Setting Description
Trace Level Select the level of communication fault reporting, if you
wish to maintain a file detailing COM problems. Default is
None.
Trace File Path Select the destination where the COM tracing file will be
stored.
COM Call Tracing Turn communication fault tracing on or off. Default is Off.
Base UDP Port First port in the multi-threaded polling sequence. The
default setting uses this port and up to 100 ports above it to execute the multi-threaded polling of network devices. Minimum SNMP Scan Rate
(ms)
Base rate for network polling; all devices are a multiple of this number. Default is 1000 ms.
Run Server as Windows Service
SNMP runs continuously as a Windows service, rather than starting when an OPC client requests information.
Run Server as Application Default setting; SNMP runs when an OPC client requests
data, and shuts down if there is no demand for several seconds.
Disable Auto Shutdown If SNMP is running as an application, the OPC server will
not shutdown once it is started, even if no OPC clients are requesting data.
Enable Initial Polling The SNMP OPC Server will not display a value to an OPC
client application until a verified value has been returned; this can increase server startup time significantly. Default setting is Off.
®
USER’S GUIDE
SNMP OPC Gateway
User-Defined Tag Setup
SNMP User-Defined SNMP tags are derived OPC tags that require the user to define a new tag by manipulating the value of existing SNMP tags. Use the following steps to add a user-defined tag.
1. Expand the device detail view of the target device, in the left-hand window of SNMP Editor.
2. Highlight the User-Defined icon, move your mouse to the right screen frame, right-click, and select New Item.
3. The dialog box for creating a new SNMP database derived tag will appear, as seen below:
®
USER’S GUIDE
SNMP OPC Gateway
SNMP uses Microsoft JScript® as the syntax for derived tags. This syntax offers tremendous flexibility for creating derived tag equations. SNMP has added an extension to Jscript in order to use the current values of certain OPC tags in the Jscript equations. To use the SNMP Jscript extension:
• The Val ( )function takes the name of an SNMP OPC tag and returns the value of that tag into the equation variable.
Example: x = val(ifOutUcastPkts.01);
• If the input to the Val ( )variable is a valid OPC tag name, Val ( )
returns the current value of that OPC tag into the equation.
• If the equation that is created in the derived tag includes tags from multiple devices, the full OPC tag name (< device>.< tag name>) will bring in the current values from multiple devices.
See also
For information on the syntax for Jscript, visit the Microsoft Web site and search for Jscript.
®
USER’S GUIDE
SNMP OPC Gateway
SNMP Communicator
During system troubleshooting, you may wish to communicate with your SNMP-manageable network devices without having to start the SNMP Server. One advantage of the Communicator is that you do not have to configure your SNMP database using the SNMP Editor. This allows you to retrieve and verify SNMP data directly from the field device, bypassing an HMI and the OPC server. If you have an existing SNMP Editor configuration set up, then you will be able to browse the tag database you have already set up.
To open SNMP Communicator, select Programs from your computer’s
Start menu. Select American Power Conversion, then OPC SNMP Gateway, then Tools, then SNMP Communicator.
When you start SNMP Communicator, the SNMP Server screen does not open. SNMP Communicator is a stand-alone SNMP communication product, and it accesses the field device directly over the network.
There are two ways to use Communicator. You may browse a network that has already been configured using SNMP Editor. Alternately, you may manually fill in the required SNMP MIB data fields. To browse an existing configuration, see Browsing an Existing SNMP OPC Gateway Database. To use SNMP Communicator without browsing, see Spot-Checking SNMP Data.
®
USER’S GUIDE
SNMP OPC Gateway
Browsing an Existing SNMP OPC Gateway Database
The Communicator screen is split into two major parts. The left screen is the device browser area; it shows a list of the available network devices and the tags that you have configured in SNMP Editor. The right side of the screen displays real-time data from any of the configured tags or from any tag for which you have the correct MIB address data.
To begin, browse the SNMP “tree” in the left screen. Click the mouse over the + sign to the left of the words “APC SNMP OPC Gateway” in the device browser area of the OPC Data Tree screen to display the configured devices on your network.
®
USER’S GUIDE
SNMP OPC Gateway
Click on the + sign to the left of a configured network device to view a list of all the tags configured for that device. If there is no + or – sign to the left of the “tree,” then youprobably have not configured any devices from within SNMP Editor. Exit SNMP Communicator and first configure the devices in your network, or skip ahead to the Spot-Checking
®
USER’S GUIDE
SNMP OPC Gateway
When all the tags that have been configured are displayed, it is possible to add individual tags to the Communicator real-time view area. To view any tag, first highlight the individual tag by clicking on it in the SNMP OPC Gatewaywindow (the left frame of the screen). The MIB data for that tag will be automatically entered into the data fields in the right frame of the screen.
SNMP Communicator allows access to one tag at a time; it is primarily meant as a troubleshooting tool. If you need to view multiple tags concurrently, use the SNMP Dataviewer utility.
®
USER’S GUIDE
SNMP OPC Gateway
Six items of information are displayed about each tag within the SNMP Communicator display windows.
1. The first window is the IP address of the SNMP agent that is being polled.
2. The second text box is the Communityfield. The Community field is essentially a password field. The community setting in this field must match the community that is set in the UPS or other APC network device.
3. The third field is the SNMP Object Identifierfor the tag. The SNMP Object Identifier is the specific data address for the information you are requesting from the SNMP agent embedded in your UPS or other APC network device. Most MIB addresses follow an Object ID
nomenclature that has a series of whole numbers separated by periods (for example: .1.3.6.1.2.1.2.2.1.7.1.).
To communicate with a manageable network device, you must first configure an SNMP address for it. If you are unsure whether this has been done, refer to the management manual for your network device.
Many device manufacturers will have a default community setting of Private for full access privileges to their network device. Often there is also a default Public community, which will allow read-only privileges from the SNMP agent. Many network devices will allow you to create a number of
communities, all of which have varying levels of access to that device’s MIB data. If an IT group maintains the network device that you are communicating to, you should coordinate with them to determine the correct community to use.
®
USER’S GUIDE
SNMP OPC Gateway
4. The fourth field is the Data Typefor the MIB data you are going to be requesting. MIB data is stored in a number of formats—various types of integers, strings, etc. Press the drop-down arrow on the right side of this dialog box to choose the data type from a pre-defined list.
5. The fifth field of data is the Current Valueof the tag.
6. The sixth field is the Descriptionfield. This field will be populated with the text that was set in the Description field of SNMP Editor. If there is no text, SNMP Communicator will still work.
See also
You can find the MIB Object ID addresses and descriptions in the network management manual supplied with your SNMP-manageable device. Be aware that some network component vendors have two product manuals—one for installing and operating the network device, the other detailing network management information.
The Data Type for your specific MIB data can be found in the management manual or in the MIB definition file for your network device.
SNMP Communicator only retrieves data from the
manageable network device when you press the Get Next or
Set button. It is normal to see a line of question marks until the Trigger button is pressed.
®
USER’S GUIDE
SNMP OPC Gateway
Reading SNMP Data
To initiate a poll of the SNMP MIB data, click on the Get button to poll the SNMP agent in the selected device. The Get Next button will increment through the MIB and retrieve the data. The Current Value text box will reflect the state of the requested SNMP MIB Object Identifier. The read function is only activated once, at the moment that the Get or Get Next
button is pressed. To update the data, you must press the Get or Get Next
button again.
Writing SNMP Data
To initiate a write to the SNMP MIB database, use the Set button on the bottom of the screen. You can change the value of an Object ID only if it is permitted by the configuration of the SNMP agent in the device you are interrogating. You also have to configure the tag for write ability in the SNMP Editor. You can view the status of the tag in the SNMP OPC Gateway Information section of the Communicator.
Spot-Checking SNMP Data
It is not necessary to set up a device in SNMP Editor to be able to communicate with any SNMP-manageable device using SNMP
Communicator. To spot-check SNMP MIB data on a network, you will need four pieces of information from the SNMP agent about the MIB data item that you want to read:
1. The IP address of the SNMP agent that is being polled. Enter this data in the SNMP Agent field on the right side of the Communicator
When attempting to set a value in the SNMP MIB, you must be at the proper community setting (either Read/Write or Write only). This community setting is configured when setting up the device.
®
USER’S GUIDE
SNMP OPC Gateway
interface. There are four boxes in this field, one for each of the four sections of the SNMP agent IP address.
2. The Community for which that the managed network device is configured. The Community is essentially a password field. The community setting in this field must match the community that is set in the SNMP manageable switch.
3. The SNMP Object Identifier for the tag. The SNMP Object Identifier is the specific data address for the information you are requesting from the SNMP agent embedded in your manageable network device. Most MIB addresses follow an Object ID nomenclature that has a series of whole numbers separated by periods (for example: .1.3.6.1.2.1.2.2.1.7.1.).
You must configure an SNMP address in the manageable network device to communicate to it. If you are unsure
whether this configuration has been done, refer to the network manual for the device and configure it before attempting to use SNMP Communicator.
Many device manufacturers will have a default community setting of Private for full access privileges to their network device. Often there is also a default Public community, which will allow read-only privileges from the SNMP agent. Many network devices will allow you to create a number of
communities, all of which have varying levels of access to the device’s MIB data. If the network device that you are
communicating to is maintained by an IT group, you should coordinate with that group to determine the correct
®
USER’S GUIDE
SNMP OPC Gateway
4. The Data Typefor the MIB data you are going to be requesting. MIB data is stored in a number of formats—various types of integers, strings, etc. Press the drop-down arrow on the right side of this dialog box to choose the data type from a pre-defined list.
See also
You can find the MIB Object ID addresses and descriptions in the network management manual supplied with your SNMP-manageable device. Be aware that some network component vendors have two product manuals—one for installing and operating the network device, the other detailing network management information.
See also
The Data Type for your specific MIB data can be found in the management manual or in the MIB definition file for your network device.
®
USER’S GUIDE
SNMP OPC Gateway
SNMP Dataviewer
SNMP Dataviewer is an OPC client application designed to help SNMP users verify that the SNMP OPC Server is collecting and sharing data properly. SNMP Dataviewer can be a useful tool in troubleshooting potential problems with OPC communication. When you first start SNMP Dataviewer, the SNMP Server screen will flash open and then will minimize to run as a service on your computer.
To open SNMP Dataviewer, select Programs from your computer’s Start
menu. Select American Power Conversion, then SNMP OPC Gateway, then Tools, then Dataviewer.
Reading Data
The Dataviewer screen is split into two windows. The left screen is the device browser area. This area will show a list of the available network devices and the tags that you have configured in SNMP Editor. The right side of the screen allows you to view real-time data from any of the
configured tags. To begin, you must browse the SNMP data tree in the left screen. Click the mouse over the + sign to the left of the phrase “APC SNMP OPC Gateway” on the OPC Data Tree screen; you will see a list of the configured devices on the network.
Before using SNMP Dataviewer, you must configure your SNMP database using the SNMP Editor. Refer to SNMP Editor in the Help menu for instructions.
®
USER’S GUIDE
SNMP OPC Gateway
Click on the + sign to the left of the network device you wish to receive data from. A list of all the tags configured for that device will appear, and you can add individual tags into the Dataviewer real-time view area. To view any tag, first click on the individual tag in the OPC Data Tree window, then press the
-> in the taskbar. (Double-clicking on the tag will also move the tag into the real-time viewing area.)
If there is no + or – sign to the left of the phrase “APC SNMP OPC Gateway”, you probably have not configured any
devices from within SNMP Editor. Exit SNMP Dataviewer and launch SNMP Editor to configure the devices in your network first.
®
USER’S GUIDE
SNMP OPC Gateway
You will note that there are four items of information displayed about each tag within the real-time display window:
1. First is the tag Name of the data.
2. The second column is the Read/Write column. This column displays whether the tag is configured for read-only or for read/write privileges. If the device has read/write privileges, then you can actually set the tag value from within SNMP Dataviewer. See Writing Data for details. 3. The third column of data is the current value of the tag. This column
displays the data in real-time as often as it is updated by the SNMP driver.
4. The fourth column shows the time stamp for the last update time the data was retrieved from the SNMP manageable device. To increase or decrease the frequency of the data update, see Advanced settings.
To give the OPC Data tree window a more organized appearance, you can press the – button to the left of any device’s icon. This will hide the list of tags from this device, and help you navigate to other network devices more easily.
The tag name from within the real-time window is displayed in OPC naming format, which is <Device>.<Tag name>.
If you are receiving values of 0 or *, the Dataviewer probably has a problem communicating to your SNMP manageable network devices. Verify that you are attached to the network and then verify that the network device you have configured is powered.
®
USER’S GUIDE
SNMP OPC Gateway
Now that you have begun to gather real-time data, you can easily change the data points that you are monitoring. To add a tag from another device, simply open the tag listing for that device by clicking on the + sign to the left of the device name as you did for the first device, highlight the tag that you want to monitor, and press the ->button on the taskbar above the Dataview windows.
To remove a tag from the real-time window, highlight it by clicking on it and then press the <- button on the taskbar. If you want to remove multiple tags, you can hold down the Ctrl key on your keyboard, and then click to select each desired tag. When you press the <- button on the taskbar, all
highlighted tags will be moved out of the real-time Dataview window.
Writing Data
To write data to a manageable network device from within SNMP
Dataviewer, first ensure that the point is read/writeable. You can do this by looking at the R/W column in Dataviewer. If the column has a R/W by the tag, then the tag was configured with Read/Write properties in SNMP Editor.
Assuming that you have configured the tag to be writeable, you can write a value by simply double clicking on the tag from within the real-time
Dataviewer window. When you double click on the point, a Write Value
pop-up window will appear.
The SNMP agent residing on the network device may only support read-only for all or some tags, and selecting write privileges from within SNMP Editor does not guarantee that write commands will be executed. Another factor that affects read/write privileges is the community “password” that you defined during the Network Device setup. Consult the network management manual for your network device to be sure of the functionality supported.
®
USER’S GUIDE
SNMP OPC Gateway
Type the new value that you want in the New Item Valuetext box, and click the OK button. Once you have done this, the new value should appear on the next scan of that tag.
Saving and retrieving Dataview windows
After you have selected the tags that you want to monitor, you may want to save the list, so that you do not have to re-browse and select the tags every time you restart SNMP Dataviewer. To save your list, press the Save
Dataview button (which looks like a floppy disk) located above the real-time Dataviewer window. A Save As window will appear. Type a file name for the Dataview that you want to be able to recall and then click the Save button. At this point the Dataview that you have created will be available any time you restart SNMP Dataviewer.
To recall a Dataview after restarting SNMP Dataviewer, press the Open
button, located above the real-time Dataviewer window, or select Open
from the File menu. An Open window will appear. Select the Dataview you want from the list and press the Open button. Your pre-selected tag
®
USER’S GUIDE
SNMP OPC Gateway
Advanced settings
SNMP Dataviewer allows you to make changes to the base SNMP OPC Gateway poll rate, as well as the SNMP Dataviewer OPC update rate. The difference between these two poll rates is as follows:
The Base SNMP Poll rate is the frequency with which the SNMP OPC Gateway driver will make requests of the network device for data. For example, a base SNMP poll rate of 1000 ms will ensure that the SNMP OPC Gateway driver will attempt to poll the network devices that have been configured no more than once every 1000 milliseconds.
The Sync Poll rate is the rate at which SNMP Dataviewer requests
information from the SNMP polling engine. There are two selections within the Sync poll rate. The default is the Cache setting. In most circumstances, the Cache is the preferred polling method. This allows the SNMP
Dataviewer to display a cached value if the SNMP polling engine does not have a refreshed value from the manageable network device. Selecting the device polling selection will make Dataviewer wait for a refreshed SNMP data value. This action can sometimes slow the performance of the application.
Do not change the base SNMP poll rate below 1000 ms, unless you have discussed your application with SNMP tech support.
®
USER’S GUIDE
SNMP OPC Gateway
SNMP OPC Gateway OPC Server Interface
The SNMP OPC Gateway OPC driver will be started by any OPC client that requests data from it. If there is not an OPC client requesting information, the SNMP Server will be inactive. You can verify that the SNMP Server is running by looking for a small SNMP icon in the lower right hand taskbar of your operating system. This icon shows that the OPC driver is running. If you minimize the OPC client software application (and any other software windows you may have opened), you will see the SNMP OPC Gateway OPC Engine interface.
This interface has a few important tools, as well as an event log that can assist you in troubleshooting your application. In the window, you will be told how many OPC clients are currently connected to the SNMP Server.
If any polling errors occur, they will be listed in the event log screen, with a date and time stamp for the event. You can easily view a history of the last 100 errors. The log will begin to overwrite the oldest error after reaching 100 events, to ensure that the event log does not become too large.
If you wish, you can save the event log at any time by pressing the Save button on the left side of the interface. This action will save the log file as a text file, which can be helpful to tech support staff, in the event you are having communication problems.
Multiple OPC clients can connect to the SNMP Server, so it is possible to have both SNMP Dataviewer and a user interface package communicating simultaneously to the
®
USER’S GUIDE
SNMP OPC Gateway
You can also print the event log out to a printer. Press the Print button on the left side of the interface, and follow the instructions to print to one of your pre-configured printers.
®
USER’S GUIDE
SNMP OPC Gateway
APC Enterprise Account Support
Customer support for this APC product is available at no charge when you contact an APC Enterprise Account Support center by telephone or e-mail.
– Telephone: (888)278-0350 – E-mail: eas@apcc.com
Contact the APC representative or other distributor from whom you purchased your APC product for information on how to obtain local customer support.
®
USER’S GUIDE
SNMP OPC Gateway
Copyright
Entire contents © 2005 American Power Conversion. All rights reserved. Reproduction in whole or in part without permission is prohibited. APC and the APC logo are trademarks of American Power Conversion Corporation and may be registered in some jurisdictions. All other trademarks, product names, and corporate names are the property of their respective owners and are used for informational purposes only.
