SNMP Monitoring for the BlackBerry Enterprise Server

Contents
Using SNMP to monitor the BlackBerry Enterprise Server........................................................................... 5 SNMP components for the BlackBerry Enterprise Server........................................................................... 5 Enhanced BlackBerry service and component SNMP monitoring..................................................... 5 Enhanced BlackBerry service and component SNMP traps ............................................................... 6 Supported SNMP functions ..................................................................................................................... 6 SNMP monitoring software requirements..............................................................................................7 Setting up SNMP monitoring...........................................................................................................................7 Install the SNMP service and SNMP management tool.......................................................................7 Register the SNMP agent......................................................................................................................... 8 Set up the SNMP service .......................................................................................................................... 8 Compile the MIB file ................................................................................................................................. 8 Setting up SNMP traps .................................................................................................................................... 9 Prerequisites for setting up SNMP traps ............................................................................................... 9 Set up the SNMP trap service.................................................................................................................. 9 Install the standalone SNMP trap management tool .......................................................................... 9 Customizing SNMP trap monitoring.............................................................................................................10 Create custom SNMP traps.....................................................................................................................10 Turn off specific SNMP traps ..................................................................................................................10 Return SNMP traps to their default values............................................................................................11

SNMP components for the BlackBerry Enterprise Server

Using SNMP to monitor the BlackBerry Enterprise Server

SNMP components for the BlackBerry Enterprise Server Setting up SNMP monitoring Setting up SNMP traps Customizing SNMP trap monitoring

SNMP components for the BlackBerry Enterprise Server

You can use Simple Network Management Protocol (SNMP) to assess the configuration, health, and status of your BlackBerry Enterprise Server and BlackBerry user accounts. SNMP monitoring consists of multiple components. An SNMP service is a Microsoft Windows service that you can run on the BlackBerry Enterprise Server. An SNMP service contains an SNMP agent that sends notifications, or traps, to an SNMP trap management tool when certain conditions are met. These conditions are described in the Management Information Base (MIB) file, a definition file that describes, in text format, what each numerical SNMP trap value represents. A .mib file is included with any application that supports SNMP. The MIB file for the BlackBerry Enterprise Server is named BlackBerryServer.mib, and it is located on the computer on which the BlackBerry Enterprise Server is installed (at C:\Program Files\Research In Motion\BlackBerry Enterprise Server\). You use an SNMP management tool, such as an SNMP (MIB) browser, to view information from the SNMP agent. By default, the SNMP management tool displays the object identifier (OID) of a condition. An OID is a sequence of integers that uniquely identifies a value within a class of values by defining the path to that value through a registration tree. All BlackBerry Enterprise Server SNMP OIDs and traps begin with the class value 1.3.6.1.4.1.3530.5. To uniquely identify a value within a class, each OID value is distinguished by a suffix, such as 25.1.1. To view descriptive names instead of OIDs for the conditions, compile and register the BlackBerryServer.mib file.
Tip: Some OID values are designed to monitor components of the BlackBerry Enterprise Server for certain messaging platforms only. Check the OID value properties to verify that the value applies to your BlackBerry environment.

Enhanced BlackBerry service and component SNMP monitoring

In addition to the SNMP monitoring capabilities that are available in the BlackBerry Enterprise Server Version 4.0, the BlackBerry Enterprise Server Version 4.1 includes new and enhanced SNMP monitoring for the following BlackBerry services and components: BlackBerry Router: configuration and system health BlackBerry Dispatcher: configuration and system health BlackBerry Enterprise Server: system health and status user accounts: health, status, email address, messaging server on which the user resides
5

SNMP Monitoring for the BlackBerry Enterprise Server

The BlackBerryServer.mib file logs the date and time for SNMP values that report date and time information (for example, SNMP value routConfigLastModified) in the number of milliseconds that have elapsed since midnight on January 1, 1970 (for example, 1,127,919,375).

Enhanced BlackBerry service and component SNMP traps

SNMP traps monitor certain BlackBerry Enterprise Server Event IDs that are written in the BlackBerry Enterprise Server log files. In addition to the SNMP traps that are available in the BlackBerry Enterprise Server Version 4.0, the BlackBerry Enterprise Server Version 4.1 includes new SNMP traps that monitor and notify you whether the following BlackBerry services and components are running, stopped, or changed: BlackBerry Enterprise Server SRP connection BlackBerry Dispatcher BlackBerry Dispatcher connection to and from the BlackBerry Router BlackBerry Dispatcher connection to the BlackBerry Configuration Database BlackBerry Router BlackBerry Mobile Data System (BlackBerry MDS) Connection Service BlackBerry MDS Connection Service connection to the BlackBerry Configuration Database BlackBerry Messaging Agent

BlackBerry Enterprise Server SNMP trap categories

SNMP traps for the BlackBerry Enterprise Server are organized into the following categories: CriticalTraps: critical or other significant events logged with a 1xxxx or 5xxxx event ID V1Traps: available in the BlackBerry Enterprise Server Version 4.0 and earlier V3Traps: new in the BlackBerry Enterprise Server Version 4.1 UserDefinedTraps: traps that you define in the Windows Registry Editor

Supported SNMP functions

The BlackBerryServer.mib file supports the typical SNMP functions that you use to monitor the BlackBerry Enterprise Server.
Function Get Description This function retrieves a specified value that is stored in a table on the BlackBerry Enterprise Server. For example, a Get request for the MIB variable besTotMsgsPending returns the total number of messages that are queued for delivery to BlackBerry devices on the BlackBerry Enterprise Server. This function fetches the next sequential MIB variable. This function extracts all BlackBerry Enterprise Server and user account information to the SNMP management tool. This function sends messages triggered by defined events; the BlackBerry Enterprise Server sends messages to the computer on which the SNMP trap management tool is installed.

Get Next Walk Trap

Setting up SNMP monitoring

SNMP monitoring software requirements

To view the BlackBerry Enterprise Server statistics in an SNMP management tool, you must install the following software: SNMP service SNMP management tool MIB compiler

Setting up SNMP monitoring

To monitor your BlackBerry Enterprise Server using SNMP, you must install and configure an SNMP service and an SNMP management tool to view SNMP values and events. Several free SNMP management tools are available on the Internet that you can download to your computer. After you install the SNMP management tool, you use the MIB compiler that is included in the SNMP management tool to compile the BlackBerryServer.mib file. If you install the BlackBerry Enterprise Server before you install the SNMP service, verify that the SNMP agent is registered in the registry. If you register the SNMP agent in the registry after you install the BlackBerry Enterprise Server and the SNMP service, restart the SNMP service for the change to take effect.

Install the SNMP service and SNMP management tool

1. On the computer on which the BlackBerry Enterprise Server is installed, on the taskbar, click Control Panel > Add/Remove Programs > Add/Remove Windows Components > Management and Monitoring Tools > Details.

2. Install the SNMP service. See the Windows or Microsoft Windows Server documentation for more information. 3. To verify that the SNMP service was installed, perform one of the following actions: Windows Server 2003: In Windows Services, verify that the SNMP service appears. Windows 2000: On the taskbar, click Control Panel > Add/Remove Programs > Add/Remove Windows Components > Management and Monitoring Tools > Details. Verify that the SNMP service appears.

4. On the computer on which the BlackBerry Enterprise Server is installed, install the SNMP management tool. 5. Start the SNMP service and the BlackBerry Enterprise Server services.
Tip: Check the Windows Event Viewer system log for SNMP service startup failures.

SNMP Monitoring for the BlackBerry Enterprise Server

Register the SNMP agent

1. Verify that the correct SNMP registry keys were installed in the registry when you installed the BlackBerry Enterprise Server. If the keys were not installed automatically, create them manually.
Registry key HKEY_LOCAL_MACHINE\SOFTWARE\Research In Motion\BlackBerry Enterprise Server\SNMPAgent\CurrentVersion String value Pathname Value data C:\Program Files\Research In Motion\BlackBerry Enterprise Server\BlackBerryServerSNMPAgent.dll Note: The string value must be the directory path to the BlackBerryServerSNMPAgent.dll file. SOFTWARE\Research In Motion\BlackBerry Enterprise Server\SNMPAgent\CurrentVersion

HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\ Server Services\SNMP\Parameters\ExtensionAgents

2. If you created the SNMP registry keys manually, restart the SNMP service.

Set up the SNMP service

You must create a community name and assign permissions to the community name to view SNMP events. At a minimum, Research In Motion (RIM) requires that you to assign read-only permissions to the community name. 1. Right-click the SNMP service. Click Properties. 2. On the Security tab, in the Accepted Community Names section, click Add. 3. In the Community rights drop-down list, click the desired permission. 4. In the Community name field, type public. 5. Select the desired hosts to accept SNMP packets from. 6. Click OK.

Compile the MIB file

Depending on the third-party SNMP management tool that you use, the MIB compiler generates a BlackBerryServermib-smiv2.smidb file. After you have compiled the file, point the SNMP management tool to the BlackBerry Enterprise Server to view SNMP values and events. 1. Using a third-party SNMP management tool, open the MIB compiler tool. 2. At C:\Program Files\Research In Motion\BlackBerry Enterprise Server, browse to the BlackBerryServer.mib file. 3. Compile the BlackBerryServer.mib file. 4. Save the BlackBerryServermib-smiv2.smidb file. 5. In the SNMP management tool, load the compiled BlackBerryServermib-smiv2.smidb file. 6. In the appropriate field, type the IP address of the computer on which the BlackBerry Enterprise Server is installed.

Setting up SNMP traps

Setting up SNMP traps

To monitor your BlackBerry Enterprise Server using SNMP traps, you must install and configure an SNMP trap management tool. You can use the SNMP trap management tool that is included in the SNMP management tool that you downloaded from the Internet or a standalone SNMP trap management tool. Several free SNMP trap management tools are available on the Internet that you can download to your computer. If you use a standalone SNMP trap management tool, you must make sure that no SNMP trap services are running on the BlackBerry Enterprise Server.

Prerequisites for setting up SNMP traps

> On the computer on which the BlackBerry Enterprise Server is installed, verify the SNMP service is installed and running by performing the following actions: Windows Server 2003: In Windows Services, verify that the SNMP service appears. Windows 2000: On the taskbar, click Control Panel > Add/Remove Programs > Add/Remove Windows Components > Management and Monitoring Tools > Details. Verify that the SNMP service appears.

Set up the SNMP trap service

To use the SNMP trap management tools that are included in the SNMP management tool, you must assign trap destinations to which the SNMP trap service sends SNMP trap notifications. 1. On the computer on which the BlackBerry Enterprise Server is installed, right-click the SNMP service. Click Properties.

2. On the Traps tab, in the Community name field, type blackberry. 3. In the Trap destinations field, type the IP address or name of the computer on which the SNMP management tool is installed. The SNMP agent sends SNMP notifications to this IP address or computer name. 4. Click OK.

Install the standalone SNMP trap management tool

When you install standalone SNMP trap management tools, the Error binding to Trap Port (162), it may already be in use message might display when you start the SNMP trap management tool. To resolve this issue, stop any SNMP trap services on the BlackBerry Enterprise Server. 1. On the computer on which the BlackBerry Enterprise Server is installed, install the SNMP trap management tool.

2. If installed and running, stop the SNMP trap service. 3. Restart the SNMP trap management tool.

SNMP Monitoring for the BlackBerry Enterprise Server

Customizing SNMP trap monitoring

To monitor BlackBerry Enterprise Server events that are not defined in the default BlackBerryServer.mib file, define your own SNMP traps. To further customize how you monitor the BlackBerry Enterprise Server, you can enable the SNMP agent to generate specific SNMP trap categories and suppress SNMP trap categories that you do not want the SNMP agent to generate and monitor. By default, all SNMP traps for the BlackBerry Enterprise Server are turned on. To turn off SNMP trap categories, you must create values for the SNMP trap categories in the registry.

Create custom SNMP traps

1. On the computer on which the BlackBerry Enterprise Server is installed, open the Windows Registry Editor. 2. Browse to HKEY_LOCAL_MACHINE\SOFTWARE\Research In Motion\BlackBerry Enterprise Server\SNMPAgent. 3. Right-click SNMPAgent. Click New > Key. 4. Type Traps. 5. Right-click the Traps folder. Click New > DWORD Value. 6. Type a name for the SNMP trap. The value name must be sequential. 7. Double-click the new trap value. 8. In the Value data field, type a value. 9. In the Base section, select the Decimal option. 10. Click OK. 11. Restart the SNMP service.

Turn off specific SNMP traps

1. On the computer on which the BlackBerry Enterprise Server is installed, open the Windows Registry Editor. 2. Browse to HKEY_LOCAL_MACHINE\SOFTWARE\Research In Motion\BlackBerry Enterprise Server\SNMPAgent. 3. Right-click SNMPAgent. Click New > DWORD Value. 4. Perform one of the following actions:
Action Turn off traps in the CriticalTraps category. Turn off traps in the V1Traps category. Turn off traps in the V3Traps category. Turn off traps that you defined previously. Procedure > > > > In the Name column, in the new field, type AllowCriticalTraps. In the Name column, in the new field, type AllowV1Traps. In the Name column, in the new field, type AllowV3Traps. In the Name column, in the new field, type AllowUserDefinedTraps.

10

Customizing SNMP trap monitoring

5. Double-click the new value. 6. In the Value data field, type 0. 7. In the Base section, select the Decimal option. 8. Click OK. 9. Restart the SNMP service.

Return SNMP traps to their default values

To turn SNMP traps back on, you must change the values for the SNMP trap categories in the registry. 1. On the computer on which the BlackBerry Enterprise Server is installed, open the Windows Registry Editor. 2. Browse to HKEY_LOCAL_MACHINE\SOFTWARE\Research In Motion\BlackBerry Enterprise Server\SNMPAgent. 3. Click SNMPAgent. 4. Perform one of the following actions:
Action Turn on traps in the CriticalTraps category. Turn on traps in the V1Traps category. Turn on traps in the V3Traps category. Turn on traps that you defined previously. Procedure > > > > In the Name column, double-click the AllowCriticalTraps value. In the Name column, double-click the AllowV1Traps value. In the Name column, double-click the AllowV3Traps value. In the Name column, double-click the AllowUserDefinedTraps value.

5. In the Value data field, type 1. 6. Click OK. 7. Restart the SNMP service.

11

SNMP Monitoring for the BlackBerry Enterprise Server

12

Part number: SWD_X_BES(EN)-208.000 At the time of publication, this documentation is based on the BlackBerry Enterprise Server Version 4.1. 2006 Research In Motion Limited. All Rights Reserved. The BlackBerry and RIM families of related marks, images, and symbols are the exclusive properties of Research In Motion Limited. RIM, Research In Motion, BlackBerry, Always On, Always Connected and the envelope in motion symbol are registered with the U.S. Patent and Trademark Office and may be pending or registered in other countries. Microsoft, Windows, and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. All other brands, product names, company names, trademarks and service marks are the properties of their respective owners. The BlackBerry device and/or associated software are protected by copyright, international treaties, and various patents, including one or more of the following U.S. patents: 6,278,442; 6,271,605; 6,219,694; 6,075,470; 6,073,318; D445,428; D433,460; D416,256. Other patents are registered or pending in various countries around the world. Visit www.rim.com/patents.shtml for a current list of RIM [as hereinafter defined] patents. This document is provided as is and Research In Motion Limited and its affiliated companies(RIM) assume no responsibility for any typographical, technical, or other inaccuracies in this document. In order to protect RIM proprietary and confidential information and/or trade secrets, this document may describe some aspects of RIM technology in generalized terms. RIM reserves the right to periodically change information that is contained in this document; however, RIM makes no commitment to provide any such changes, updates, enhancements, or other additions to this document to you in a timely manner or at all. RIM MAKES NO REPRESENTATIONS, WARRANTIES, CONDITIONS OR COVENANTS, EITHER EXPRESS OR IMPLIED (INCLUDING WITHOUT LIMITATION, ANY EXPRESS OR IMPLIED WARRANTIES OR CONDITIONS OF FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, MERCHANTABILITY, DURABILITY, TITLE, OR RELATED TO THE PERFORMANCE OR NON-PERFORMANCE OF ANY SOFTWARE REFERENCED HEREIN OR PERFORMANCE OF ANY SERVICES REFERENCED HEREIN). IN CONNECTION WITH YOUR USE OF THIS DOCUMENTATION, NEITHER RIM NOR THEIR RESPECTIVE DIRECTORS, OFFICERS, EMPLOYEES, OR CONSULTANTS SHALL BE LIABLE TO YOU FOR ANY DAMAGES WHATSOEVER BE THEY DIRECT, ECONOMIC, COMMERCIAL, SPECIAL, CONSEQUENTIAL, INCIDENTAL, EXEMPLARY, OR INDIRECT DAMAGES, EVEN IF RIM HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, INCLUDING WITHOUT LIMITATION, LOSS OF BUSINESS REVENUE OR EARNINGS, LOST DATA, DAMAGES CAUSED BY DELAYS, LOST PROFITS, OR A FAILURE TO REALIZE EXPECTED SAVINGS. This document might contain references to third-party sources of information, hardware or software, products or services and/or third-party web sites (collectively the Third-Party Information). RIM does not control, and is not responsible for, any Third-Party Information, including, without limitation the content, accuracy, copyright compliance, compatibility, performance, trustworthiness, legality, decency, links, or any other aspect of Third-Party Information. The inclusion of Third-Party Information in this document does not imply endorsement by RIM of the Third-Party Information or the third party in any way. Installation and use of Third-Party Information with RIMs products and services may require one or more patent, trademark, or copyright licenses in order to avoid infringement of the intellectual property rights of others. Any dealings with Third-Party Information, including, without limitation, compliance with applicable licenses and terms and conditions, are solely between you and the third party. You are solely responsible for determining whether such third-party licenses are required and are responsible for acquiring any such licenses relating to Third-Party Information. To the extent that such intellectual property licenses may be required, RIM expressly recommends that you do not install or use Third-Party Information until all such applicable licenses have been acquired by you or on your behalf. Your use of Third-Party Information shall be governed by and subject to you agreeing to the terms of the Third-Party Information licenses. Any Third-Party Information that is provided with RIMs products and services is provided as is. RIM makes no representation, warranty, or guarantee whatsoever in relation to the Third-Party Information and RIM assumes no liability whatsoever in relation to the ThirdParty Information even if RIM has been advised of the possibility of such damages or can anticipate such damages.

13