108
BlackBerry Enterprise Server Resource Kit Version 4.1 Service Pack 2 User Guide

User Guide

Embed Size (px)

Citation preview

BlackBerry Enterprise Server Resource KitVersion 4.1 Service Pack 2

User Guide

BlackBerry Enterprise Server Resource Kit Version 4.1 Service Pack 2 User Guide

Last modified: 13 February 2007

Document ID: 11573821 Version 2

At the time of publication, this documentation is based on the BlackBerry Enterprise Server Version 4.1 Service Pack 2.

©2007 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.

IBM, Lotus, Lotus Notes, Domino, DB2, and DB2 Universal Database are trademarks of International Business Machines. Microsoft, Windows, Excel, and SQL Server are trademarks of Microsoft Corporation. Novell and GroupWise are trademarks of Novell, Inc. GSM is a trademark of GSM MOU Association. 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 for a 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 ITS 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 RIM's 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 RIM's 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 Third-Party Information even if RIM has been advised of the possibility of such damages or can anticipate such damages.

Published in Canada

Research In Motion Limited 295 Phillip Street Waterloo, ON N2L 3W8 Canada

Research In Motion UK Limited Centrum House, 36 Station Road Egham, Surrey TW20 9LF United Kingdom

Contents1 BlackBerry Enterprise Server Resource Kit..................................................................................................... 11

Product overview...............................................................................................................................................11BlackBerry Domain Administration History tool ..................................................................................11BlackBerry Syslog tool ..............................................................................................................................11Log analysis tools...................................................................................................................................... 12Log Monitor tool........................................................................................................................................ 12Message Receipt Confirmation tool ...................................................................................................... 13Upgrade IT Policy Template tool............................................................................................................ 13User Administration tool .........................................................................................................................14

Support for the BlackBerry Enterprise Server Resource Kit ......................................................................15

2 BlackBerry Domain Administration History tool ...........................................................................................17Requirements and considerations................................................................................................................. 17Download the BlackBerry Enterprise Server Resource Kit ........................................................................ 17 Prepare to run the BlackBerry Domain Administration History tool .......................................................18Generating a report of changes made in your BlackBerry environment.................................................18

Generate a report .....................................................................................................................................18Interpreting the configuration changes in the .csv file output messages.......................................19Interpreting debug log file messages....................................................................................................19

3 BlackBerry Syslog tool........................................................................................................................................21Requirements and considerations................................................................................................................. 21Download the BlackBerry Enterprise Server Resource Kit ........................................................................ 21Installing the BlackBerry Syslog tool ............................................................................................................ 21

Install the BlackBerry Syslog service..................................................................................................... 21Configure the notification delivery settings........................................................................................ 22Specify the port numbers on which the BlackBerry Syslog tool listens .......................................... 22

Preparing to monitor the BlackBerry Enterprise Server ........................................................................... 23Change who receives notification messages and nightly reports ................................................... 23Specify which BlackBerry services and events to monitor ................................................................ 24Interpreting notification messages....................................................................................................... 25Interpreting nightly reports ...................................................................................................................26

Output files...............................................................................................................................................26

4 Log analysis tools ...............................................................................................................................................29Requirements and considerations................................................................................................................29Download the BlackBerry Enterprise Server Resource Kit files...............................................................29Prepare to run the log analysis tools ...........................................................................................................30Tracking message flow through the BlackBerry Enterprise Server.........................................................30

Run the Messageflow tool......................................................................................................................30Interpreting the results of the Messageflow query .............................................................................31

Differentiating nonresponsive threads from slow threads....................................................................... 32Run the NoResponseCheck tool............................................................................................................ 33Interpreting the results of the NoResponseCheck query.................................................................. 33

Identifying notification delays...................................................................................................................... 34Run the DelayedNotifications tool ....................................................................................................... 34Interpreting the results of the DelayedNotifications query ............................................................. 35

Identifying user accounts that might be outside of a wireless coverage area ...................................... 35Run the OutofCoverage tool.................................................................................................................. 35Interpreting the results of the OutofCoverage query........................................................................36

Monitoring the number of messages in the queue....................................................................................36 Run the Pending tool .............................................................................................................................. 37Interpreting the results of the Pending query .................................................................................... 38

Identifying Microsoft Exchange MAPI/CDO issues .................................................................................. 38Run the MapiCdoErrors tool .................................................................................................................. 38Interpreting the results of the MapiCdoError query ..........................................................................39

Checking timing statistics on rescan events ..............................................................................................39Run the AvailIndex tool ..........................................................................................................................39Interpreting the results of the AvailIndex query ................................................................................40

Generating detailed statistics........................................................................................................................41Run the HistoricalStats tool....................................................................................................................41Interpreting the results of the HistoricalStats query......................................................................... 42

Determining BlackBerry MDS Connection Service use patterns ............................................................ 43Run the MDSPushvsPull tool ................................................................................................................. 43Interpreting the results of the MDSPushvsPull query .......................................................................44

5 Log Monitor tool..................................................................................................................................................45Requirements and considerations................................................................................................................45

Download the BlackBerry Enterprise Server Resource Kit files...............................................................45Prepare to run the Log Monitor tool ............................................................................................................45Preparing to monitor the BlackBerry Enterprise Server ...........................................................................45

Environment variables that the Log Monitor tool uses......................................................................46 Run the Log Monitor tool........................................................................................................................ 47Log Monitor tool examples..................................................................................................................... 47

6 Message Receipt Confirmation tool............................................................................................................... 49Requirements and considerations................................................................................................................49Download the BlackBerry Enterprise Server Resource Kit files...............................................................49Install the Message Receipt Confirmation tool..........................................................................................49

Install the Message Receipt Confirmation service.............................................................................50Preparing to monitor the BlackBerry Enterprise Server ............................................................................51

Set up the Message Receipt Confirmation tool ...................................................................................51Viewing the status of messages sent to BlackBerry devices.................................................................... 52

Message Receipt Confirmation client status fields............................................................................ 52Sample Message Receipt Confirmation tool messages..................................................................... 53

Message Receipt Confirmation tool log files.............................................................................................. 53

7 Upgrade IT Policy Template tool .....................................................................................................................55Requirements and considerations................................................................................................................55Download the BlackBerry Enterprise Server Resource Kit files...............................................................55Preparing the input file..................................................................................................................................55

Upgrade IT Policy Template tool input file requirements .................................................................55Prepare the input file in SQL format ....................................................................................................56Prepare the input file in CSV format .................................................................................................... 57

Run the Upgrade IT Policy Template tool ...................................................................................................58Upgrade IT Policy Template log files ...........................................................................................................59

8 User Administration tool................................................................................................................................... 61Requirements and considerations.................................................................................................................61Download the BlackBerry Enterprise Server Resource Kit files...............................................................62Installing the User Administration tool.......................................................................................................62

Install the User Administration service................................................................................................62User Administration service log files....................................................................................................64User Administration audit log files.......................................................................................................65

Prepare to run the User Administration client....................................................................................65Specify a local system account to run the User Administration tool ..............................................65Client password authentication ........................................................................................................... 66User Administration tool authentication for role-based administration........................................67

Managing user accounts................................................................................................................................67Add a user account to the BlackBerry Enterprise Server...................................................................67Add a user account to a group...............................................................................................................68Add an existing user account to a group ............................................................................................ 69Remove a user account from the BlackBerry Enterprise Server...................................................... 69Remove a user account from a group................................................................................................... 70Move a user account to a different BlackBerry Enterprise Server ................................................... 70Move a user account to a different group............................................................................................. 71Find a user account on a BlackBerry Enterprise Server..................................................................... 72Change user account settings ............................................................................................................... 72Add a user account to a software configuration................................................................................. 73Remove a user account from a software configuration ..................................................................... 73List the groups in a BlackBerry Domain............................................................................................... 74

Managing BlackBerry devices....................................................................................................................... 74Set the BlackBerry device password..................................................................................................... 74Set owner information on a BlackBerry device ................................................................................... 75Delete data from the BlackBerry device memory and make the BlackBerry device unavailable76Purge pending messages ....................................................................................................................... 76Resend the peer-to-peer encryption key to the BlackBerry device................................................. 77Resend a service book............................................................................................................................. 77

Obtain or clear user account statistics........................................................................................................ 78Interpreting the results of a statistics query for a user account ...................................................... 78Clear user account statistics..................................................................................................................80

Sending notification messages to BlackBerry devices..............................................................................80Send a PIN message ...............................................................................................................................80Send an email message ...........................................................................................................................81

Managing email and folder redirection....................................................................................................... 82Turn on email redirection ....................................................................................................................... 82Turn off email redirection....................................................................................................................... 82List the folders available for redirection .............................................................................................. 83Turn on folder redirection ...................................................................................................................... 83Turn off folder redirection ......................................................................................................................84

Managing IT policies and IT policy rules .....................................................................................................85

List the IT policy rules in the BlackBerry Configuration Database ..................................................85 Set IT policy rules for a user account....................................................................................................85List the IT policies in the BlackBerry Configuration Database.........................................................86

Obtaining BlackBerry device information................................................................................................... 87List the applications that are available on one or more BlackBerry devices.................................. 87 List the BlackBerry devices on which a specified application is installed ...................................... 87List the statistics for BlackBerry devices..............................................................................................88List the modules and .cod files that are available on a BlackBerry device .....................................89

Obtain BlackBerry Enterprise Server statistics ..........................................................................................90 Interpreting the results of a statistics query for a BlackBerry Enterprise Server ..........................91

Display the status of the User Administration service...............................................................................91Parameters available for the User Administration tool ............................................................................92

9 Upgrading and removing the BlackBerry Enterprise Server Resource Kit ..............................................97Upgrading the BlackBerry Enterprise Server Resource Kit tools ............................................................97

Upgrade the BlackBerry Syslog tool.....................................................................................................97Upgrade the log analysis tools..............................................................................................................97Upgrade the User Administration tool.................................................................................................98

Removing the BlackBerry Enterprise Server Resource Kit tools..............................................................98Remove the BlackBerry Domain Administration History tool ..........................................................98Remove the BlackBerry Syslog tool ..................................................................................................... 99Remove the log analysis files................................................................................................................ 99Remove the Log Monitor tool................................................................................................................ 99Remove the Message Receipt Confirmation tool .............................................................................. 99Remove the Upgrade IT Policy Template tool................................................................................... 100Remove the User Administration tool ................................................................................................ 100

A Appendix A: Error codes for the User Administration tool......................................................................... 101

1

BlackBerry Enterprise Server Resource Kit

Product overviewThe BlackBerry® Enterprise Server Resource Kit is a collection of tools that you download from the BlackBerry web site. You can use the BlackBerry Enterprise Server Resource Kit to streamline management tasks, administer user accounts, monitor events, collect statistics, troubleshoot issues with the BlackBerry Enterprise Server, and analyze the BlackBerry Enterprise Server performance.

You can use the BlackBerry Enterprise Server Resource Kit tools with the BlackBerry® Enterprise Server for Microsoft® Exchange, the BlackBerry® Enterprise Server for IBM® Lotus® Domino®, the BlackBerry® Enterprise Server for Novell® GroupWise®, or the BlackBerry® Enterprise Server for MDS Applications.

BlackBerry Domain Administration History toolThe BlackBerry Domain Administration History tool is an auditing tool that reads the ServerConfigHistory table in the BlackBerry Configuration Database and displays the configuration changes in a .csv file.

Examples of changes include adding user accounts or applying policy or security settings. The tool records the date and time of each change and the name of the user who made the change.

BlackBerry Enterprise Server for MDS Applications supportIn BlackBerry Enterprise Server Resource Kit Version 4.1 Service Pack 2, the BlackBerry Domain Administration History tool supports the BlackBerry Enterprise Server for MDS Applications.

IBM DB2 UDB supportIn BlackBerry Enterprise Server Resource Kit Version 4.1 SP2, the BlackBerry Domain Administration History tool supports IBM® DB2 Universal Database™ (IBM® DB2® UDB®) with the BlackBerry Enterprise Server for IBM Lotus Domino.

BlackBerry Syslog toolYou can use the BlackBerry Syslog tool, previously named the BESSysLog tool, to monitor the BlackBerry Enterprise Server log events as they are written to the log file. You can specify which BlackBerry Enterprise Server to monitor, the events that the BlackBerry Syslog tool tracks, and the types of notifications and reports that the BlackBerry Syslog tool sends to recipients.

The BlackBerry Syslog tool consists of the following components:

Product overviewSupport for the BlackBerry Enterprise Server Resource Kit

BlackBerry Enterprise Server Resource Kit User Guide

• BlackBerry Syslog service (BESSyslog.exe), which runs as a Microsoft® Windows® service.

• BlackBerry Syslog client (BESysLogConfig.exe), which you install on and run from the same computer as the BlackBerry Syslog service. The BlackBerry Syslog client opens as a configuration window in which you can configure nightly reports, notifications, and alerts; customize event ID descriptions; and specify recipients of the notifications and nightly reports. You can also specify the BlackBerry services and each BlackBerry Enterprise Server that the BlackBerry Syslog tool monitors.

Log analysis toolsThe following log analysis tools check the BlackBerry log files and provide output files that contain data including information about user accounts, message flow, BlackBerry Enterprise Server performance, and historical statistics.

Log Monitor toolThe Log Monitor tool monitors the text that is written to the end of a text file. You can use the Log Monitor tool to monitor a text file for one or more events by specifying numeric event IDs or text strings at the command prompt or by using an input file. You can also specify actions that you want the tool to perform after it finds a value that meets the set criteria, and then exit optionally. For example, you can configure the tool to run a batch file or to create an output file with specific information after it finds a specified value.

You can use the environment variables that you define for the Log Monitor tool to produce various queries. The tool can search on multiple strings at the same time, and the batch file can direct the tool to perform a different action for each string; for example, you can create separate text files in which to store the information for each specified event or text string. You can use regular expressions in the input file.

Use To

AvailIndex.exe Produce a snapshot report of user account activity over a period of days.

Platform: Use this tool with the BlackBerry Enterprise Server for Microsoft Exchange only.

DelayedNotifications.exe Detect when the BlackBerry Enterprise Server is no longer receiving notifications in a timely fashion for new messages and calendar items.

Platform: Use this tool with the BlackBerry Enterprise Server for Microsoft Exchange only.

HistoricalStats.exe Provide statistics on use patterns for each user account for each day.

MapiCdoErrors.exe Identify common Messaging Application Programming Interface (MAPI) and Collaboration Data Object (CDO) errors and custom events.

Platform: Use this tool with the BlackBerry Enterprise Server for Microsoft Exchange only.

MDSPushvsPull.exe Determine whether the BlackBerry MDS Services processes more data from push applications or browser requests.

Messageflow.exe Track the flow of messages from the messaging and collaboration server through the BlackBerry Enterprise Server to the BlackBerry device.

NoResponseCheck.exe Identify threads that are reporting as nonresponsive and distinguish true nonresponsive threads from slow threads.

OutOfCoverage.exe Check for BlackBerry users that do not send or receive data in a specified period of time.

Pending.exe Track user accounts with a pending count that is higher than the pending count that you specify.

12

1: BlackBerry Enterprise Server Resource Kit

BlackBerry Enterprise Server for MDS Applications supportIn BlackBerry Enterprise Server Resource Kit Version 4.1 SP2, the Log Monitor tool supports the BlackBerry Enterprise Server for MDS Applications.

Message Receipt Confirmation toolYou can use the Message Receipt Confirmation tool to verify that the BlackBerry Enterprise Server is sending messages to BlackBerry devices.

At an interval that you specify, the Message Receipt Confirmation tool sends a message to the specified user account, monitors the status of that message, and checks for confirmation that the BlackBerry device receives the message.

You can set whether the Message Receipt Confirmation tool sends you a message when there is a delay in the delivery of a message to a BlackBerry device.

The Message Receipt Confirmation tool consists of the Message Receipt Confirmation service and the Message Receipt Confirmation client.

The Message Receipt Confirmation service (MessageConfirmService.exe) performs the following functions:

• checks the registry approximately every 10 seconds for new configuration information, such as a new set of message addresses, that the Message Receipt Confirmation client writes

• sends messages to specified user accounts

• confirms whether the BlackBerry Enterprise Server delivers messages to BlackBerry devices successfully

• writes status information to the registry after sending a message to check for delivery of the message, and after a delivery timeout, if necessary; the Message Receipt Confirmation client reads this status information

• sends a message failure notification to a defined Simple Mail Transfer Protocol (SMTP) email address if the Message Receipt Confirmation service component does not confirm a successful delivery within the specified time

You use the Message Receipt Confirmation client (MessageConfirmConfig.exe) to perform the following functions:

• set the configuration information that the Message Receipt Confirmation service uses; for example, you can set the user accounts that you want the Message Receipt Confirmation service to monitor, how it monitors those accounts, how frequently it sends messages, and how it delivers timeout notifications

• monitor the status of the messages that the Message Receipt Confirmation service sends to BlackBerry devices

Upgrade IT Policy Template toolYou can use the Upgrade IT Policy Template tool to upgrade the IT policy template for the BlackBerry Configuration Database with new BlackBerry device policy rules.

13

BlackBerry Enterprise Server Resource Kit User Guide

You can upgrade the IT policy template using the Upgrade IT Policy Template tool from a local or client computer without upgrading the BlackBerry Enterprise Server. The tool is designed to back up the template table before it makes any changes.

BlackBerry Enterprise Server for MDS Applications supportIn BlackBerry Enterprise Server Resource Kit Version 4.1 SP2, the Upgrade IT Policy Template tool supports the BlackBerry Enterprise Server for MDS Applications.

IBM DB2 UDB supportIn BlackBerry Enterprise Server Resource Kit Version 4.1 SP2, the Upgrade IT Policy Template tool supports IBM DB2 UDB with the BlackBerry Enterprise Server for IBM Lotus Domino.

User Administration toolThe User Administration tool, previously named the BESUserAdmin tool, consists of the following components:

• User Administration service, which runs as a Microsoft Windows service named the BlackBerry User Administration Service

• User Administration client, which you can install on the same computer as the User Administration service or on a different computer; you run the User Administration client from a command prompt to perform BlackBerry Enterprise Server administration tasks or to gather BlackBerry Enterprise Server statistics

BlackBerry device managementIn BlackBerry Enterprise Server Resource Kit Version 4.1 SP1 and later, you can use the -handheld_info parameter in the User Administration tool to gather information about the BlackBerry device statistics, applications, and modules, and .cod files.

BlackBerry Enterprise Server for MDS Applications supportIn BlackBerry Enterprise Server Resource Kit Version 4.1 SP2, the User Administration tool supports the BlackBerry Enterprise Server for MDS Applications.

Gather statistics about user accounts, BlackBerry devices, and the BlackBerry Enterprise ServerYou can use the User Administration tool to obtain statistics about user accounts, BlackBerry devices, and the BlackBerry Enterprise Server. For example, you can obtain statistics for individual user accounts, all user accounts on a BlackBerry Enterprise Server, or all user accounts in a group.

Gather information from the BlackBerry Configuration DatabaseIn BlackBerry Enterprise Server Resource Kit Version 4.1 SP2, you can use the User Administration tool to list the IT policies in the BlackBerry Configuration Database. You can also list groups in a BlackBerry Domain, IT policy rules for a specific IT policy, and folders available for a specific user.

14

1: BlackBerry Enterprise Server Resource Kit

IBM DB2 UDB supportIn BlackBerry Enterprise Server Resource Kit Version 4.1 SP2, the User Administration tool supports IBM DB2 UDB with the BlackBerry Enterprise Server for IBM Lotus Domino.

Manage user accountsYou can use the User Administration tool to manage user accounts on the BlackBerry Enterprise Server on a large scale. For example, you can add, move, find, and remove user accounts, or change user account configurations.

Software configuration managementIn BlackBerry Enterprise Server Resource Kit Version 4.1 SP1 and later, you can use the -assign_swconfig command in the User Administration tool to manage push applications for user accounts. Using this command, you can assign a user account to a software configuration or remove a software configuration setting from a user account.

Support for the BlackBerry Enterprise Server Resource KitTechnical support for the BlackBerry Enterprise Server Resource Kit is available for all registered Technical Support Services customers on the BlackBerry web site in the Technical Support downloads area.

Visit www.blackberry.com/support/downloads/resourcekit.shtml for information about reporting issues and requesting support for the BlackBerry Enterprise Server Resource Kit.

15

BlackBerry Enterprise Server Resource Kit User Guide

16

2

BlackBerry Domain Administration History tool

Requirements and considerations

Download the BlackBerry Enterprise Server Resource Kit1. Visit www.blackberry.com/support/downloads/resourcekit.shtml to download the appropriate version of the

BlackBerry Enterprise Server Resource Kit.

2. Double-click the .exe file that you downloaded.

3. In the Unzip to folder field, create a folder in which to extract the files.

4. Click Unzip.

Requirements and considerationsDownload the BlackBerry Enterprise Server Resource KitPrepare to run the BlackBerry Domain Administration History toolGenerating a report of changes made in your BlackBerry environment

Requirements and considerations

! Do not run the BlackBerry Domain Administration History tool on the same computer on which the BlackBerry Enterprise Server resides.

! Verify that your environment uses Microsoft® SQL Server™ Desktop Engine (MSDE) or Microsoft® SQL Server™ for the BlackBerry Configuration Database. The BlackBerry Domain Administration tool also support IBM DB2 UDB for the BlackBerry Enterprise Server for IBM Lotus Domino.

! The BlackBerry Domain Administration History tool must have a connection to the BlackBerry Configuration Database.

! You must have the Server Administrator permission for the BlackBerry Configuration Database.

! If you use an IBM DB2 UDB, you must install an IBM DB2 UDB client on the computer on which you plan to run the BlackBerry Domain History tool.

! If you use an IBM DB2 UDB, verify that the BlackBerry Configuration Database belongs to the database catalog that resides on the same computer on which you plan to run the BlackBerry Domain History tool.

BlackBerry Enterprise Server Resource Kit User Guide

Prepare to run the BlackBerry Domain Administration History tool1. On the computer on which you plan to run the BlackBerry Enterprise Server, create a folder in which to store

the BlackBerry Domain Administration History tool.

2. Copy AdminHistory.exe to the folder that you created in step 1.

Generating a report of changes made in your BlackBerry environmentYou can use the BlackBerry Domain Administration History tool to run reports changes to the ServerConfigHistory table in the BlackBerry Configuration Database.

You can also configure the BlackBerry Domain Administration History tool to create a debug.txt file.

Generate a report1. At the command prompt, switch to the folder in which AdminHistory.exe resides.

2. Run the BlackBerry Domain Administration History tool with the following parameters. The parameters listed in brackets are optional.

Parameter Steps

-n <database address> > Type the host name, computer name, or IP address of the computer that hosts the BlackBerry Configuration Database. You do not require this parameter if you use an IBM DB2 UDB.

-db <database name> > Type the name of the BlackBerry Configuration Database. By default, the name is BESMgmt.

[-SQLAuth] > Type -sqlauth to use SQL authentication or IBM DB2 UDB authentication. By default, the BlackBerry Domain Administration History tool uses Microsoft Windows authentication.

[-login] <database login name> > Type the login name, if applicable.

[-password] <database password> > Type the password, if applicable.

[-db2] <database name> > Type -db2 if the BlackBerry Configuration Database runs on an IBM DB2 UDB server.

Platform: This parameter applies to the BlackBerry Enterprise Server for IBM Lotus Domino only.

[-db2schema] <schema name> > Type the IBM DB2 UDB schema name. By default, the name is BESADMIN.

Platform: This parameter applies to the BlackBerry Enterprise Server for IBM Lotus Domino only.

[-o] <output file name> > Type the output file path and name. By default, the BlackBerry Domain Administration History tool uses the name AdminHistory<MMDDYY>.csv. The output file resides in the same folder as the tool.

[-l] <limit> > Specify the number of rows to process. By default, the tool processes all the data in the ServerConfigHistory table. If you do not remove the previous output file, the new output file appends to the previous file. The average limit is 1000 to 2000 lines.

[-x] <log file name> > Type -x to start logging to the specified file.

18

2: BlackBerry Domain Administration History tool

Example: Running the BlackBerry Domain Administration History tool using SQL authentication

adminhistory -n server01 -db kmtestd -sqlauth -login “clyde warren” -password password1 -o output.csv -l 1000 -x C:\logs\logfilename.txt

Example: Running the BlackBerry Domain Administration History tool using IBM DB2 UDB authentication

adminhistory -db kmtestd -sqlauth -db2 -db2schema <schema name> -login “clyde warren” -password password1 -o output.csv -l 1000 -x C:\logs\logfilename.txt

Interpreting the configuration changes in the .csv file output messages

Interpreting debug log file messagesThe debug log file reports the time at which the event occurred and a description of the event.

Example: Debug log file entries for a successful connection to the BlackBerry Configuration Database

<09:14:22> Attempting Database Connection...<09:14:22> Database Connection Successful!<09:14:22> Attempting To Create/Open Output CSV File...<09:14:22> Performing SELECT On ServerConfigHistory Table...<09:14:22> Retrieving the recordset size. This may take a few minutes...<09:14:22> 264 Records Returned.<09:14:23> 264 Total Entries Processed.<09:14:23> CSV Write Operation Complete!<09:14:23> Attempting To Write Debug Log...

[-?] > Type -? to receive information about the BlackBerry Domain Administration History tool. The BlackBerry Domain Administration History tool does not require other parameters when you use this parameter.

Item Description

Time time that the configuration change occurred

Table table that changed

ServerName BlackBerry Enterprise Server that made the change to the BlackBerry Configuration Database

DisplayName display name of the user account whose data changed

UserName name of the user account whose data changed

Operation type of change

Details description of the change

SecDisplayName name of the Microsoft SQL Server that hosts the BlackBerry Configuration Database

Parameter Steps

19

BlackBerry Enterprise Server Resource Kit User Guide

Example: Debug log file entries for an unsuccessful connection attempt to the BlackBerry Configuration Database

<12:10:30> Attempting Database Connection...<12:11:38> Database Connection Failed!<12:11:38> Database Error: COM Error 0x80004005 in ADOConnectionItem:ConnectToDB() - [Microsoft][ODBC SQL Server Driver][DBNETLIB]SQL Server does not exist or access denied. - Unspecified error<12:11:38> BlackBerry Domain Administration History Tool Terminating...<12:11:38> Attempting To Write Debug Log...

20

3

BlackBerry Syslog tool

Requirements and considerations

Download the BlackBerry Enterprise Server Resource Kit1. Visit www.blackberry.com/support/downloads/resourcekit.shtml to download the appropriate version of the

BlackBerry Enterprise Server Resource Kit, preferably to the computer on which you plan to run the tools.

2. Double-click the .exe file that you downloaded.

3. In the Unzip to folder field, create a folder in which to store the files.

4. Click Unzip.

Installing the BlackBerry Syslog toolThe BlackBerry Syslog tool consists of the BlackBerry Syslog service (BESSysLog.exe) and the BlackBerry Syslog client (BESSysLogConfig.exe). When you install the BlackBerry Syslog tool, it creates a folder called Logs. Each day, the BlackBerry Syslog tool creates a log file in the Logs folder, unless otherwise specified.

Install the BlackBerry Syslog service1. On the computer on which you plan to run the BlackBerry Syslog tool, create a folder in which to store the

BlackBerry Syslog files.

2. Copy BESSysLog.exe and BESSysLogConfig.exe to the new folder.

Requirements and considerationsDownload the BlackBerry Enterprise Server Resource KitInstalling the BlackBerry Syslog toolPreparing to monitor the BlackBerry Enterprise Server

Requirements and considerations

! Do not run the BlackBerry Syslog tool on the same computer on which the BlackBerry Enterprise Server runs.

! The BlackBerry Syslog tool must run as a Microsoft Windows service.

! BESSysLog.exe and BESSysLogConfig.exe must be the same version and reside in the same folder on the same computer.

! If you have an environment with different BlackBerry Enterprise Server platforms, you must install and configure a separate copy of the BlackBerry Syslog tool for each platform. Only one instance of the BlackBerry Syslog tool can run on a computer.

! The BlackBerry Dispatcher and the BlackBerry Messaging Agent log files must be set to level 3.

BlackBerry Enterprise Server Resource Kit User Guide

3. At the command prompt, switch to the folder in which the BlackBerry Syslog tool resides.

4. Type bessyslog -install <platform>, where <platform> is one of the following values:

• exchange

• domino

• groupwise

5. On the same line, type any of the following additional parameters:

6. In the Microsoft Windows Services window, start the BlackBerry Syslog Service.

Example: Installing the BlackBerry Syslog service with a login account and starting the BlackBerry Syslog tool automatically

bessyslog -install exchange -login=test\cwarren -password=password1 -auto

Configure the notification delivery settingsThe notification delivery information resides in the registry at HKEY_LOCAL_MACHINE\SOFTWARE\Research In Motion\BlackBerry SysLog Server.

1. To open the BlackBerry Syslog client, double-click BESSysLogConfig.exe.

2. In the SMTP Host name field, type the full computer name of the outgoing messaging server that delivers the notification messages and nightly reports.

3. Type the SMTP email address of the identity from which the notification messages appear.

4. Type the SMTP account name of the identity from which the notification messages appear.

5. Click OK.

Specify the port numbers on which the BlackBerry Syslog tool listensThe BlackBerry Syslog service receives syslog messages on a socket. You must configure the SyslogLevel and SysLogHost registry keys on the BlackBerry Enterprise Server to enable the BlackBerry services to write to this socket.

Parameter Description

-login=<domain\account> specifies the Microsoft Windows domain and account ID

-password=<password> specifies the account password

-auto or -manual specifies whether the tool starts automatically; by default, you must start the BlackBerry Syslog service manually

-debug runs the BlackBerry Syslog service in debug mode, which provides extra information

-console runs the BlackBerry Syslog service in the command prompt window

-b <broadcast port> specifies the port number that the BlackBerry Syslog service should monitor for events from the BlackBerry Enterprise Server; the port number resides in the registry; by default, the port number is 514

22

3: BlackBerry Syslog tool

1. In the Registry Editor, browse to HKEY_LOCAL_MACHINE\Software\Research In Motion\BlackBerry Enterprise Server\Logging Info.

2. For each BlackBerry service that you want to monitor, change the SysLogLevel and SysLogHost registry keys for that service.

Preparing to monitor the BlackBerry Enterprise ServerYou can use the BlackBerry Syslog tool to monitor the BlackBerry Enterprise Server log files for events that the BlackBerry Dispatcher and the BlackBerry Messaging Agent send. Use the BlackBerry Syslog client to

• specify who receives notification messages and nightly reports

• specify which BlackBerry services and events to monitor

• customize the description of the events that the service monitors

If you monitor a large number of events, the events can create a high volume of traffic on the BlackBerry Enterprise Server. Monitor level 3 events to avoid a high volume of traffic.

By default, the BlackBerry Syslog tool limits the number of notification messages sent to users in a specified period of time. The notification message frequency information resides at HKEY_LOCAL_MACHINE\SOFTWARE\Research In Motion\BlackBerry Syslog Server in the following registry keys:

Change who receives notification messages and nightly reportsBy default, users receive all notification messages and nightly reports for all BlackBerry services from all computers on which the BlackBerry Enterprise Server runs.

1. To open the BlackBerry Syslog client, double-click BESSysLogConfig.exe.

Key Steps

SysLogLevel 1. If the SysLogLevel registry key does not exist, create a DWORD value called SysLogLevel.

2. Right-click SysLogLevel. Type 3.

SysLogHost > To change the existing registry key, add the host name or IP address and port number (514) of the computer on which the BlackBerry Syslog service runs, using one of the following formats:

• <ip address>:514

• <hostname>:514

• <localhost>:4071, <localhost>:4070, <xx.xx.xx.xx>:514.

Note: If the SysLogHost key already exists, append the entries to the existing key; do not remove the original registry key information from the SysLogHost key. You must separate each entry with a comma.

Key Default value

OneMinuteThreshold 5

FiveMinuteThreshold 10

FifteenMinuteThreshold 15

SixtyMinuteThreshold 30

23

BlackBerry Enterprise Server Resource Kit User Guide

2. Perform one of the following tasks:

Specify which BlackBerry services and events to monitorYou can create custom descriptions of events or configure specified events, ranges of events, and specified computers on which the BlackBerry Enterprise Server runs.

Specify filters and customized event descriptions for each user account1. To open the BlackBerry Syslog client, double-click BESSysLogConfig.exe.

2. In the list of user accounts, click a user name.

3. Click Edit.

4. Perform any of the following tasks:

Task Steps

Add a user account to the list of users who receive notification messages and nightly reports.

1. Click Add.

2. Type the user name and email address in the appropriate fields.

3. If you do not want a user to receive nightly reports, clear the Nightly Reports check box.

4. Click OK.

Remove a user account from the list of users who receive notification messages.

1. In the list of users, click a user name.

2. Click Remove.

Task Steps

Add an alert to the BlackBerry services. 1. In the BlackBerry Services list, click a service.

Note: Only alerts based on actual BlackBerry service alerts trigger a message.

2. Click Alerts.

3. Click Add Alert.

4. Type a BlackBerry service event ID and description.

5. Click OK.

Delete an alert from the BlackBerry services.

1. In the BlackBerry Services list, click a service.

2. Click Alerts.

3. In the list of alerts, click an alert.

4. Click Delete Alert.

Task Steps

Create a customized subject line for a notification message for the user account.

1. Click Alerts.

2. Click Add.

3. Type a BlackBerry service event ID and customized description.

Note: Only event IDs corresponding to actual BlackBerry service event IDs trigger a notification message.

4. Click OK.

5. Select a range of events to exclude from the notification messages.

24

3: BlackBerry Syslog tool

Interpreting notification messagesAn event that matches a configured alert triggers a notification message to all user accounts, unless a user specified a filter for that event. The notification message contains the following information:

Example: Notification message sent to a specified user account

To: [email protected]

Subject: 50001 - SERVER1 - Starting BlackBerry Server...

Body: <7>Nov 11 10:54:30 SERVER1 BlackBerry messaging agent SERVER1 {0x10F4} 0000: (#50001) Starting BlackBerry Server...

Remove a customized subject line for a notification message for the user account.

1. Click Alerts.

2. In the list of notification messages, click a notification message.

3. Click Delete.

Create a filter to prevent a specific BlackBerry Enterprise Server from sending a specific event to the user account.

1. Click Alerts.

2. Click Add.

3. Type -<event ID>.

4. Click OK.

Remove a filter that prevents a user from receiving notification messages about a specific event.

1. Click Alerts.

2. In the list of notification messages, click a notification message.

3. Click Delete.

4. Click OK.

Create a filter to prevent a specific BlackBerry Enterprise Server from sending notification messages to the user account.

1. Click Servers.

2. Click Add.

3. Type the BlackBerry Enterprise Server information as it appears in the List of Known BlackBerry Servers.

4. In the Description field, type remove.

Remove a filter that prevents a specific BlackBerry Enterprise Server from sending notification messages to the user account.

1. Click Servers.

2. Click a BlackBerry Enterprise Server.

3. Click Delete.

Item Description

subject • event ID number

• host name of the BlackBerry Enterprise Server that sent the message

• description of the event

body • log entry from the BlackBerry Dispatcher or BlackBerry Messaging Agent

Task Steps

25

BlackBerry Enterprise Server Resource Kit User Guide

Interpreting nightly reportsThe nightly report is a summary of the messages that the BlackBerry Syslog tool receives from the BlackBerry services that it monitors.

Example: Nightly report

Messages Logged at Error, Warning and Other:

Host Name: SERVER1Service: BlackBerry Dispatcher CN=SERVER1/OU=SERVERS/O=TEST

Event Occ. Description----- ----- --------------------10000 1 CRITICAL ERROR in the BlackBerry Dispatcher50000 150075 1 Starting BlackBerry Dispatcher %s - Version %s

Service: BlackBerry Messaging Agent SERVER1

Event Occ. Description----- ----- --------------------10398 1 Unable to open mail database for user %s (server=%s) (db=%s)20000 120089 1 Unable to open %s DB for %s50001 2 Starting BlackBerry Server ...50002 1 Shutting down BlackBerry ServerMessages

Messages Logged at Information, Debug and Trace Level:

Output filesThe BlackBerry Syslog service creates the following log files:

Item Description

Host name host name of the BlackBerry Enterprise Server that sent the syslog message

Service BlackBerry Messaging Agent or BlackBerry Dispatcher

Event event ID number

Occ. number of occurrences of the event

Description event description

Location File name Details

Logs folder bessyslog<YYYYMMDD>.txt The BlackBerry Syslog service creates the Logs folder.

folder in which the BESSysLog.exe file resides

msgs_<hostname><YYYYMMDD>.txt The log file contains detailed information about all messages that the BlackBerry Enterprise Server processes.

The BlackBerry Syslog service writes message information to the file every 10 minutes. This interval is not configurable.

26

3: BlackBerry Syslog tool

folder in which the BESSysLog.exe file resides

rescan_<hostname><YYYYMMDD>.txt The log file contains a summary of scan averages for the past hour plus detailed information about any scan that takes longer than 5 seconds. The file is created in the same folder as the bessyslog.exe file. The BlackBerry Syslog service prints rescan information every hour.

folder in which the BESSysLog.exe file resides

bessyslogerror<YYYYMMDD>.txt The BlackBerry Syslog service uses this log file to generate nightly reports.

folder in which the BESSysLog.exe file resides

bessyslogdebug<YYYYMMDD>.txt The BlackBerry Syslog service uses this log file to generate nightly reports.

Location File name Details

27

BlackBerry Enterprise Server Resource Kit User Guide

28

4

Log analysis tools

Requirements and considerations

Download the BlackBerry Enterprise Server Resource Kit files1. Visit www.blackberry.com/support/downloads/resourcekit.shtml to download the appropriate version of the

BlackBerry Enterprise Server Resource Kit, preferably to the computer on which you plan to run the tools.

2. Double-click the .exe file that you downloaded.

3. In the Unzip to folder field, create a folder in which to store the files.

4. Click Unzip.

Requirements and considerationsDownload the BlackBerry Enterprise Server Resource Kit filesPrepare to run the log analysis toolsTracking message flow through the BlackBerry Enterprise ServerDifferentiating nonresponsive threads from slow threadsIdentifying notification delaysIdentifying user accounts that might be outside of a wireless coverage areaMonitoring the number of messages in the queueIdentifying Microsoft Exchange MAPI/CDO issuesChecking timing statistics on rescan eventsGenerating detailed statisticsDetermining BlackBerry MDS Connection Service use patterns

Requirements and considerations

! Do not run the log analysis tools on the same computer on which the BlackBerry Enterprise Server runs.

! The BlackBerry log files that you analyze must reside on the same computer as the log analysis tools.

! The computer on which you run the log analysis tools must have a large volume of free disk space to accommodate the size of the BlackBerry log files and the log analysis output files.

! The log analysis tools are version specific and must run on the specified BlackBerry Enterprise Server log files. Although the log analysis tools run on different versions of the BlackBerry log files, the results might be unpredictable.

BlackBerry Enterprise Server Resource Kit User Guide

Prepare to run the log analysis tools1. Set the relevant BlackBerry Enterprise Server logging level to 4 for each of the following log analysis tools:

2. Copy the BlackBerry log files to the computer on which you plan to run the log analysis tools.

3. Note the path and folder at which the BlackBerry log files reside; you must provide the location if it is different from the folder in which the log analysis tools reside.

See the BlackBerry Enterprise Server System Administration Guide for more information about how to change the BlackBerry Enterprise Server logging levels.

Tracking message flow through the BlackBerry Enterprise ServerTrack the flow of messages through the BlackBerry Enterprise Server using the Messageflow tool. The Messageflow tool helps you troubleshoot message flow and provides statistical data for finding message flow trends.

Run the Messageflow tool1. Copy the BlackBerry Messaging Agent, BlackBerry Dispatcher, and BlackBerry Router log files to the

computer on which the Messageflow tool resides.

2. At the command prompt, switch to the folder in which Messageflow.exe resides.

3. Run the Messageflow tool with the following parameters. The parameters listed in brackets are optional.

Log analysis tool BlackBerry log files

Messageflow.exe BlackBerry Messaging Agent (MAGT), BlackBerry Dispatcher (DISP), and BlackBerry Router (ROUT) log files

NoResponseCheck.exe all BlackBerry log files except the BlackBerry® MDS Connection Service (MDAT) and BlackBerry® Instant Messaging log files; the log file logging levels do not have to be set to 4

DelayedNotifications.exe MAGT log file

OutOfCoverage.exe DISP log file

Pending.exe MAGT log file

MapiCdoErrors.exe MAGT log file

AvailIndex.exe MAGT log file

HistoricalStats.exe MAGT and DISP log files

MDSPushvsPull.exe MDAT log file

Parameter Steps

-p <e/d/g> > Indicate the platform.

• Microsoft® Exchange: Type e.

• IBM® Lotus® Domino®: Type d.

• Novell® GroupWise®: Type g.

30

4: Log analysis tools

Example: Querying all user accounts and creating the report in a specified location

messageflow -p e -u all -l C:\logs

Interpreting the results of the Messageflow queryResults of the query are in a .csv file named MessageFlow_<user_name>_<start_date><end_date>.<#>.csv, where <start_date><end_date> appears only when you use the multi-day parameter. The start and end dates use the format <YYYYMMDD>. <#> is the number of BlackBerry Messaging Agent restarts that the tool finds in the log files.

If you queried a single user account or a number of user accounts using the -input parameter, the tool creates an individual file for each user account that you queried.

-u all/<username> > Type all to query all user accounts in the log files, or type the user name in the appropriate format to query a specific user account.

• Microsoft Exchange: Type the SMTP email address; for example, cwarren@<domain>.net.

• IBM Lotus Domino: Type the hierarchical name; for example, Clyde Warren/Organization.

• Novell GroupWise: Type the first name and last name; for example, Clyde Warren.

[-input] <userlist.txt> > Type the name of a user list file to check a group of user accounts. The list file must be new-line delimited and contain the same user name format used with the -u option.

Note: This parameter overrides the value specified with the -u parameter.

[-agent] <acronym> > Type the acronym for the BlackBerry Messaging Agent log files if it is not MAGT.

[-dispatcher] <acronym> > Type the acronym that identifies the BlackBerry Dispatcher log file if it is not DISP.

[-router] <acronym> > Type the acronym that identifies the BlackBerry Router if it is not ROUT.

[-multiday] <start_date> <end_date> > To check message flow across multiple days, type a date value to specify which log file subdirectories to check. The Messageflow tool checks subdirectories from the current date. Use the format <YYYYMMDD-YYYYMMDD> for the date range or <YYYYMMDD> for a single date.

If you do not type a date value, the Messageflow tool cannot check the subdirectories.

[-l] <C:\folder\> > Specify the location of the log files if they are not in the same folder as the Messageflow tool.

[-output] user/all > Type user to create one file for each user account or all to create one file for all user accounts. If you do not specify a user account, the user name does not appear in the .csv file name.

[-ol] <path> > Type the location where you want to place the output files.

[-debug] <filename.txt> > Type -debug and a file name to produce more detailed output for debugging purposes.

Note: If you do not specify a file name, the debug information appears on the screen.

[-?/-help] > Type either -? or -help for information about the Messageflow tool. The Messageflow tool does not require other parameters when you use this parameter.

Column Description

Server displays the BlackBerry Enterprise Server on which the user account resides

Platform: This column applies to the BlackBerry Enterprise Server for Microsoft Exchange and the BlackBerry Enterprise Server for IBM Lotus Domino.

Parameter Steps

31

BlackBerry Enterprise Server Resource Kit User Guide

Differentiating nonresponsive threads from slow threadsThe NoResponseCheck tool is designed to indicate how well a BlackBerry Enterprise Server runs, based on the number of nonresponsive threads.

If the BlackBerry Enterprise Server appears to have a number of nonresponsive threads, you can determine the status of the threads by running the NoResponseCheck tool. The NoResponseCheck tool reports whether a thread is a false positive. A false positive thread is one that reports as nonresponsive but continues to do work, performing a single task for a long time.

Running the NoResponseCheck tool should be your first point of monitoring the BlackBerry Enterprise Server. Running the tool gives you an overview of the health of a thread. You can then explore the log files further.

User displays the user name

EntryID/NoteID identifier that tracks the message from its initial stages

RefID unique identifier assigned to messages and calendar appointments that the BlackBerry Enterprise Server or the BlackBerry device uses to track messages

AGT Tag identifier that tracks the message between the BlackBerry Messaging Agent and the BlackBerry Dispatcher; assigned by the BlackBerry Messaging Agent

Disp Tag identifier that tracks the message from the BlackBerry Dispatcher to the wireless network; assigned by the BlackBerry Dispatcher

Total Time total time (in minutes) between the messaging server receiving the message and the BlackBerry Enterprise Server completing the processing (can be a negative value when the BlackBerry device sends a message)

Server Time time it takes the BlackBerry Enterprise Server to process a message and deliver it to the BlackBerry device

Posted time when the messaging server posts the message to the mailstore

Mail Del time when the messaging server indicates that the message is delivered

Queue 1 time when the BlackBerry Enterprise Server first recognizes the message

Queue out time when the message enters the second queue stage

Sending time when the BlackBerry Messaging Agent sends the message to the BlackBerry Dispatcher

Disp Recv time when the BlackBerry Dispatcher receives the message

Router Recv time when the BlackBerry Router receives the message

Router Del time when the BlackBerry Router sends the message

Disp Del time when the BlackBerry Dispatcher receives the delivery notification message

Agt Status status of whether the BlackBerry Messaging Agent receives the delivery notification message

Status time time of the message delivery

Retry CNT number of times the BlackBerry Enterprise Server attempts to send the message

Discovery how the BlackBerry Enterprise Server discovers the message

Platform: This column applies to the BlackBerry Enterprise Server for Microsoft Exchange only.

Path whether the message is sent over the wireless network or through the bypass router (wired) path

Pending number of pending messages

Column Description

32

4: Log analysis tools

Run the NoResponseCheck tool1. Copy any of the BlackBerry log files (except the BlackBerry MDS Connection Service log file) to the computer

on which the NoResponseCheck tool resides.2. At the command prompt, switch to the folder in which NoResponseCheck.exe resides.

3. Run the NoResponseCheck tool with the following parameters. The parameters listed in brackets are optional.

Example: Producing detailed output for the BlackBerry Enterprise Server for IBM Lotus Domino

noresponsecheck -p d -debug -l C:\logs

Interpreting the results of the NoResponseCheck queryResults of the query are in a .csv file named NoResponseCheck_<MMDD>.<#>.csv, where <MMDD> is the month and day, and <#> is the number of restarts for all BlackBerry Enterprise Server components (except the BlackBerry MDS Connection Service) that the tool finds in the log files.

A blank .csv file indicates that no threads have stopped responding in the log files that you checked.

Parameter Steps

-p <e/d/g> > Indicate the platform.

• Microsoft Exchange: Type e.

• IBM Lotus Domino: Type d.

• Novell GroupWise: Type g.

[-mds] <acronym> > Type the acronym that identifies the BlackBerry MDS Connection Service log file if it is not MDAT.

Note: This parameter is necessary to bypass any reference to the BlackBerry MDS Connection Service log files in the other BlackBerry log files. If the NoResponseCheck tool picks up reference to the BlackBerry MDS Connection Service log files, the tool stops running.

[-l] <C:\folder\> > Specify the location of the log files if they are not in the same folder as the tool.

[-type] <acronym> > Specify the type of log file to query.

[-NoFP] > Type -nofp to prevent checking for false positives.

[-ol] <path> > Type the location where you want to place the output files. The default location is in the same folder as the NoResponseCheck tool.

[-debug] <filename.txt> > Type -debug and a file name if you want to produce more detailed output for debugging purposes.

Note: If you do not specify a file name, the debug information appears on the screen.

[-?/-help] > Type either -? or -help for information about the NoResponseCheck tool. The NoResponseCheck tool does not require other parameters when you use this parameter.

Column Description

ThreadID ID of a reporting thread

Start Time time when the failure started

End Time time when the failure ended; if the field is empty, the thread did not recover

Total Time total time of the failure (in minutes); if the field is empty, the thread did not recover

33

BlackBerry Enterprise Server Resource Kit User Guide

Identifying notification delaysThe DelayedNotifications tool provides you with a quick overview of the performance of the BlackBerry Enterprise Server and the Microsoft Exchange Server. If a user account is in a delayed-notification state, the BlackBerry Enterprise Server might not receive notification for new messages and calendar items from the Microsoft Exchange Server. The BlackBerry Enterprise Server is designed to use rescans to detect messages and calendar items.

Run the DelayedNotifications tool1. Copy the BlackBerry Messaging Agent log files to the computer on which the DelayedNotifications tool

resides.2. At the command prompt, switch to the folder in which DelayedNotifications.exe resides.

3. Run the DelayedNotifications tool with the following parameters. The parameters listed in brackets are optional.

Example: Identifying all user accounts that are in a delayed-notification state.

delayednotifications -p e -u all -input users.txt

Wait Count incrementing number that equals x multiplied by the BlackBerry Enterprise Server health-check interval (usually 10 minutes); for example, if the wait count equals 2, the thread has been unresponsive or slow for 20 minutes

False Positive whether the NoResponseCheck tool reported a false positive (a slow thread instead of a nonresponsive thread)

Activity last activity before the failure, user account associated with the failure, and the BlackBerry Enterprise Server

File file name in which the thread reported as nonresponsive

Last Activity entry from the log file for the failure

Parameter Steps

-p <e> > Type e for Microsoft Exchange.

-u all/<SMTPaddress> > Type all to query all user accounts in the log files, or type the SMTP email address of the user account to query a specific user account.

[-input] <userlist.txt> > Type the name of a user list file to check a group of user accounts. The list file can only contain the SMTP email address of user accounts and must be new-line delimited.

Note: This parameter overrides the value specified with the -u parameter.

[-agent] <acronym> > Type the acronym that identifies the BlackBerry Messaging Agent log files if it is not MAGT.

[-l] <c:\folder\> > Type the location of the log files if they are not in the same folder as the tool.

[-ol] <path> > Type the location where you want to place the output files.

[-debug] <filename.txt> > Type -debug and a file name if you want to produce more detailed output for debugging purposes.

Note: If you do not specify a file, the debug information appears on the screen.

[-?/-help] > Type either -? or -help for information about the DelayedNotifications tool. The DelayedNotifications tool does not require other parameters when you use this parameter.

Column Description

34

4: Log analysis tools

Interpreting the results of the DelayedNotifications queryResults of the query are in a .csv file named DelayedNotifications_<MMDD>.<#>.csv, where <MMDD> is the month and day, and <#> is the number of agent restarts that the tool finds in the log files.

High counts of delayed notifications indicate that the Microsoft Exchange Server is no longer providing universal datagram protocol (UDP) notifications to the BlackBerry Enterprise Server for new messages in a timely fashion.

Identifying user accounts that might be outside of a wireless coverage areaThe OutofCoverage tool is designed to identify user accounts that have not sent or received packets for a specified period of time.

Run the OutofCoverage tool1. Copy the BlackBerry Dispatcher log files to the computer on which the OutofCoverage tool resides. To

process multiple days, you must copy log files from multiple days to the same folder.

2. At the command prompt, switch to the folder in which OutofCoverage.exe resides.

3. Run the OutofCoverage tool with the following parameters. The parameters listed in brackets are optional.

Column Description

Server Microsoft Exchange Server on which the user account resides

Email Address email address of the user

DeviceID BlackBerry device PIN

SRPid BlackBerry Enterprise Server SRP identifier

MAPISession MAPI session on which the delayed notifications were reported

Start time at which the delayed notification occurred

Stop time at which multiple occurrences of delayed notifications completed; for a single occurrence, this matches the start time

Count count of a reported delay

Type mail or calendar

File file name from which this record is pulled

Parameter Steps

-p <e/d/g> > Indicate the platform.

• Microsoft Exchange: Type e.

• IBM Lotus Domino: Type d.

• Novell GroupWise: Type g.

-u all/<username> > Type all to query all user accounts in the log files, or type the user name in the appropriate format to query a specific user account.

• Microsoft Exchange: Type the SMTP email address; for example, cwarren@<domain>.net.

• IBM Lotus Domino: Type the hierarchical name; for example, Clyde Warren/Organization.

• Novell GroupWise: Type the first name and last name; for example, Clyde Warren.

-t <time> > Type the frequency (in minutes) at which the tool checks for gaps (between 10 and 1440 minutes).

35

BlackBerry Enterprise Server Resource Kit User Guide

Example: Checking if the user account has not sent or received packets for 25 minutes

outofcoverage -p e -u [email protected] -t 25 -l C:\logs

Interpreting the results of the OutofCoverage queryResults of the query are in a .csv file named OutofCoverage_<MMDD>.<#>.csv, where <MMDD> is the month and day, and <#> is the number of BlackBerry Dispatcher restarts that the tool finds in the log files.

Monitoring the number of messages in the queueYou can use the Pending tool to detect an increase in the number of messages in the queue.

[-input] <userlist.txt> > Type the name of a user list file to check a group of user accounts. The list file must contain the same user name formats as used with the -u parameter and must be new-line delimited.

Note: This parameter overrides the value specified with the -u parameter.

[-dispatcher] <acronym> > Type the acronym that identifies the BlackBerry Dispatcher log file if it is not DISP.

[-l] <C:\folder\> > Specify the location of the log files if they are not in the same folder as the tool.

[-ol] <path> > Type the location where you want to place the output files.

[-output] user/all > Type user to create one file for each user account or type all to create one file for all user accounts.

[-debug] <filename.txt> > Type -debug and a file name to produce more detailed output for debugging purposes.

Note: If you do not specify a file name, the debug information appears on the screen.

[-?/-help] > Type either -? or -help for information about the OutofCoverage tool. The OutofCoverage tool does not require other parameters when you use this parameter.

Column Description

Email address SMTP email address of the user

Platform: This column applies to the BlackBerry Enterprise Server for Microsoft Exchange and the BlackBerry Enterprise Server for IBM Lotus Domino only.

Disp name display name of the user account

DeviceID BlackBerry device personal identification number (PIN)

SRPid BlackBerry Enterprise Server SRP identifier

Length length of the outage in minutes (0.5 equals 30 seconds)

Start when the window for being outside of a wireless coverage area starts

Stop when the window for being outside of a wireless coverage area stops

Multi-day an asterisk indicates a multi-day gap; this column appears only if you process log files from multiple days or from multiple files from the same day

Parameter Steps

36

4: Log analysis tools

Run the Pending tool1. Copy the BlackBerry Messaging Agent log files to the computer on which the Pending tool resides.2. At the command prompt, switch to the folder in which Pending.exe resides.

3. Run the Pending tool with the following parameters. The parameters listed in brackets are optional.

Example: Querying all user accounts for more than one pending message and print out the user account with the highest pending count

pending -p e -u all -output all -pending 1 -onlyhigh

Parameter Steps

-p <e/d/g> > Indicate the platform.

• Microsoft Exchange: Type e.

• IBM Lotus Domino: Type d.

• Novell GroupWise: Type g.

-u all/<username> > Type all to query all user accounts in the log files, or type the user name in the appropriate format to query a specific user account.

• Microsoft Exchange: Type the SMTP email address; for example, cwarren@<domain>.net.

• IBM Lotus Domino: Type the hierarchical name; for example, Clyde Warren/Organization.

• Novell GroupWise: Type the first name and last name; for example, Clyde Warren.

[-input] <userlist.txt> > Type the name of a user list file to check a group of user accounts. The list file can only contain the same user name formats as used with the -u parameter and must be new-line delimited.

Note: This parameter overrides the value specified in -u.

[-time] <start-stop time>

or

[-time] <start time>

> Type -time and either the start and stop times or the start time at which to track pending messages in the BlackBerry Messaging Agent log file.

For example, type pending -p e -u all -time 16:00:00. This processes log entries after 16:00:00.

For example, type pending -p e -u all -time 16:00:00-17:00:00 to process log entries between 16:00:00 and 17:00:00.

[-agent] <acronym> > Type the acronym for the BlackBerry Messaging Agent log file if it is not MAGT.

[-l] <C:\folder\> > Specify the location of the log files if they are not in the same folder as the tool.

[-output] user/all > Type user to create one file for each user account, or all to create one file for all user accounts.

[-pending] <count> > Use this parameter if you want to specify a minimum pending count to track. By default, the count setting is 0.

[-onlyhigh] > Type this parameter to print the single highest pending count for a user account greater than the count you specify for -pending.

[-ol] <path> > Type the location where you want to place the output files.

[-debug] <filename.txt> > Type -debug and a file name to produce more detailed output for debugging purposes.

Note: If you do not specify a file name, the debug information appears on the screen.

[-?/-help] > Type either -? or -help for information about the Pending tool. The Pending tool does not require other parameters when you use this parameter.

37

BlackBerry Enterprise Server Resource Kit User Guide

Interpreting the results of the Pending queryResults are in a .csv file named Pending_<MMDD>.<#>.csv, where <MMDD> is the month and day, and <#> is the number of BlackBerry Messaging Agent restarts that the tool finds in the log files.

Identifying Microsoft Exchange MAPI/CDO issuesThe MapiCdoErrors tool helps you to troubleshoot Microsoft Exchange MAPI/CDO issues for the BlackBerry Enterprise Server for Microsoft Exchange.

Run the MapiCdoErrors tool 1. Copy the BlackBerry Messaging Agent log files to the computer on which the MapiCdoErrors tool resides.2. At the command prompt, switch to the folder in which MapiCdoErrors.exe resides.

3. Run the MapiCdoErrors tool with the following parameters. The parameters listed in brackets are optional.

Column Description

Server messaging server on which the user account resides

Common Name hierarchical name of the user (for IBM Lotus Domino only)

Email Address SMTP email address of the user

DeviceID BlackBerry device PIN; if the PIN has changed, this is the last PIN

SRPid BlackBerry Enterprise Server SRP identifier

Pending pending count detected

Time time when the pending count was detected

High an asterisk indicates that this was the highest pending count for a user account

Parameter Steps

-p <e> > Type e for the Microsoft Exchange platform.

-u all/<SMTPaddress> > Type all to query all user accounts in the log files, or type the SMTP email address of a user to query a specific user account.

[-input] <userlist.txt> > Type the name of a user list file to check a group of user accounts. The list file can contain only a list of SMTP names of users accounts and must be new-line delimited.

Note: This parameter overrides the value specified in -u.

[-agent] <acronym> > Type the acronym for the BlackBerry Messaging Agent log file if it is not MAGT.

[-l ]<C:\folder\> > Specify the location of the log files if they are not in the same folder as the tool.

[-output] <user/all> > Type user to create one file for each user account, or all to create one file for all user accounts.

[-list] > Type this parameter to display the default list of events monitored on the screen.

[-events] “eventids” > Specify additional events to check; events must be comma-delimited.

[-override] > Type this parameter in conjunction with the -events parameter to ignore the default events list and process only specified events.

38

4: Log analysis tools

Example: Running the MapiCdoErrors tool

mapicdoerrors -p e -u all -input users.txt -l C:\logs -output all -events “20018,20055” -override -raw

Interpreting the results of the MapiCdoError queryResults of the query are in a .csv file named MapiCdoErrors_<MMDD>.<#>.csv, where <MMDD> is the month and day, and <#> is the number of BlackBerry Messaging Agent restarts that the tool finds in the log files.

You can use the tool to scan the log files quickly for MAPI/CDO errors and the affected user accounts. Running the MapiCdoErrors tool is a starting point for debugging purposes, but further investigation into the log files is necessary.

Checking timing statistics on rescan eventsYou can use the AvailIndex tool to check the statistics on rescan events for the BlackBerry Enterprise Server for Microsoft Exchange.

Run the AvailIndex tool1. Copy the BlackBerry Messaging Agent log files to the computer on which the AvailIndex tool resides.

[-eventsfile] <filename.txt> > Type this parameter to specify a file of new-line delimited events to search for.

Notes: This parameter overrides the default list. The tool does not check for duplicates or valid events; however, it does verify that events are numerical. The tool uses events to monitor the BlackBerry Enterprise Server starts, versions, and user account settings.

[-raw] > Type this parameter to output the results to a .txt file instead of a .csv file.

[-ol] <path> > Type the location in which you want to place the output files.

[-debug] <filename.txt> > Type -debug and a file name if you want to produce more detailed output for debugging purposes. If you do not specify a file, the debug information appears on the screen.

[-?/-help] > Type either -? or -help for information about the MapiCdoErrors tool. The MapiCdoErrors tool does not require other parameters when you use this parameter.

Column Description

Server messaging server on which the user account resides

Email Address SMTP email address of the user

DeviceID BlackBerry device PIN; if the PIN has changed, the last PIN is displayed

SRPid BlackBerry Enterprise Server SRP identifier

Mailbox mailbox name of the user

Error captured error log line

Parameter Steps

39

BlackBerry Enterprise Server Resource Kit User Guide

2. At the command prompt, switch to the folder in which AvailIndex.exe resides.

3. Run the tool with the following parameters. The parameters listed in brackets are optional.

Example: Running the AvailIndex tool to produce detailed outputs

availindex -p e -debug -l C:\BRK

Interpreting the results of the AvailIndex queryResults of the query are in a .csv file named AvailIndex_<MMDD>.<#>.csv, where <MMDD> is the month and day, and <#> is the number of BlackBerry Messaging Agent restarts that the tool finds in the log file.

Parameter Steps

-p <e> > Type e to specify the Microsoft Exchange platform.

[-l] <C:\folder\> > Type the location of the BlackBerry Messaging Agent log files if it is different from the location of the AvailIndex tool.

[-agent] <acronym> > Type the acronym for the BlackBerry Messaging Agent if it is not MAGT.

[-ol <path>] > Type the location in which to save the output files.

[-debug] <filename.txt> > Type -debug and a file name to produce more detailed output for debugging purposes.

Note: If you do not specify a file name, the debug information appears on the screen.

[-?/-help] > Type either -? or -help for information about the AvailIndex tool. The AvailIndex tool does not require other parameters when you use this parameter.

Column Description

Server Microsoft Exchange Server on which the BlackBerry device user account resides

Email Address SMTP email address of the BlackBerry device user account

Availability percentage of the total busy time divided by the total log time of the BlackBerry device user account

Note: The higher this number is, the better.

Busy Time total time for all the rescan events

Outages (>15min) number of times that a BlackBerry device user account performed rescans that took longer than 15 minutes

Longest Outage count, in seconds, for the longest rescan over 15 minutes

Operation Count number of rescan events of all types that the users performed

Most Frequent Event most frequent type of rescan and the number of times it occurred

Longest Event type of rescan that took the longest time and the number of seconds that the rescan lasted

MESSAGE_RESCAN count number of times the MESSAGE_RESCAN event occurred

MESSAGE_RESCAN Total in seconds total time of MESSAGE_RESCAN events, in seconds

CALENDAR_RESCAN count number of times the CALENDAR_RESCAN event occurred

CALENDAR_RESCAN Total in seconds total time of CALENDAR_RESCAN events, in seconds

MESSAGE_DELETED_RESCAN count number of times the MESSAGE_DELETED_RESCAN event occurred

40

4: Log analysis tools

Generating detailed statisticsUse the HistoricalStats tool to obtain detailed statistical information on a specific user account for a single day. You can use this information to chart BlackBerry Enterprise Server and BlackBerry device use trends.

Run the HistoricalStats tool1. Copy the BlackBerry Messaging Agent and the BlackBerry Dispatcher log files to the computer on which the

HistoricalStats tool resides.

2. At the command prompt, switch to the folder in which HistoricalStats.exe resides.

3. Run the HistoricalStats tool with the following parameters. The parameters listed in brackets are optional.

MESSAGE_DELETED_RESCAN Total in seconds

total time of MESSAGE_DELETED_RESCAN events, in seconds

MESSAGE_MOVED_RESCAN count number of times the MESSAGE_MOVED_RESCAN event occurred

MESSAGE_MOVED_RESCAN Total in seconds

total time of MESSAGE_MOVED_RESCAN events, in seconds

MESSAGE_STATUS_RESCAN count number of times the MESSAGE_STATUS_RESCAN event occurred

MESSAGE_STATUS_RESCAN Total in seconds

total time of MESSAGE_STATUS_RESCAN events, in seconds

RELOAD_FOLDERS count number of times the RELOAD_FOLDERS event occurred

RELOAD_FOLDERS Total in seconds total time of RELOAD_FOLDERS events, in seconds

GENERATE_FOLDER_LIST count number of times the GENERATE_FOLDER_LIST event occurred

GENERATE_FOLDER_LIST Total in seconds total time of GENERATE_FOLDER_LIST events, in seconds

PIM_ADDRESSBOOK_RESCAN count number of times the PIM_ADDRESSBOOK_RESCAN event occurred

PIM_ADDRESSBOOK_RESCAN Total in seconds

total time of PIM_ADDRESSBOOK_RESCAN events, in seconds

PIM_MEMO_RESCAN count number of times the PIM_MEMO_RESCAN event occurred

PIM_MEMO_RESCAN Total in seconds total time of PIM_MEMO_RESCAN events, in seconds

PIM_TASK_RESCAN count number of times the PIM_TASK_RESCAN event occurred

PIM_TASK_RESCAN Total in seconds total time of PIM_TASK_RESCAN events, in seconds

CALENDAR_SLOWSYNC count number of times the CALENDAR_SLOWSYNC event occurred

CALENDAR_SLOWSYNC Total in seconds total time of CALENDAR_SLOWSYNC events, in seconds

EMAIL_RECONCILIATION count number of times the EMAIL_RECONCILIATION event occurred

EMAIL_RECONCILIATION Total in seconds total time of EMAIL_RECONCILIATION events, in seconds

Log total in seconds total number of rescan events for the BlackBerry device user account

Parameter Steps

-p <e/d/g> > Indicate the platform.

• Microsoft Exchange: Type e.

• IBM Lotus Domino: Type d.

• Novell GroupWise: Type g.

Column Description

41

BlackBerry Enterprise Server Resource Kit User Guide

Example: Querying for historical statistics for a BlackBerry Enterprise Server for Microsoft Exchange

historicalstats -p e -u all -l C:\BRK -output all

Interpreting the results of the HistoricalStats queryResults of the query are in a .csv file named HistoricalStats_<MMDD>.<#>.csv, where <MMDD> is the month and day, and <#> is the number of BlackBerry Messaging Agent restarts that the tool finds in the log files. If you specified to query all BlackBerry device user accounts, the file name is HistoricalStats_<MMDD>.<#>.csv.

-u all/<username> > Type all to query all user accounts in the log files, or type the user name in the appropriate format to query a specific user account.

• Microsoft Exchange: Type the SMTP email address; for example, cwarren@<domain>.net.

• IBM Lotus Domino: Type the hierarchical name; for example, Clyde Warren/Organization.

• Novell GroupWise: Type the first name and last name; for example, Clyde Warren.

[-input] <userlist.txt> > Specify a user list file to check a group of user accounts. The list file can contain only the names of the BlackBerry device user account and must be new-line delimited. Use the same format as shown with the -u option.

Note: Use this parameter overrides the value specified in -u.

[-agent] <acronym> > Type the acronym for the BlackBerry Messaging Agent log files if it is not MAGT.

[-dispatcher] <acronym> > Type the acronym for the BlackBerry Dispatcher log files if it is not DISP.

[-l] <C:\folder\> > Type the location of the log files if they are not in the same folder as the tool.

[-output] user/all > Type user to create one file for each BlackBerry device user account, or type all to create one file for all BlackBerry device user accounts.

[-ol] <path> > Type the location where you want to place the output files.

[-debug] <filename.txt> > Type -debug and a file name if you want to produce more detailed output for debugging purposes. By default, the debug information appears on the screen.

[-?/-help] > Type either -? or -help for information about the HistoricalStats tool. The HistoricalStats tool does not require other parameters when you use this parameter.

Column Description

Server messaging server on which the BlackBerry device user account resides

Platform: This column applies to the BlackBerry Enterprise Server for Microsoft Exchange and the BlackBerry Enterprise Server for IBM Lotus Domino only.

User name of the user

• Microsoft Exchange: SMTP email address

• IBM Lotus Domino: canonical name

• Novell GroupWise: first name and last name

Email address SMTP email address of the user

Platform: This column applies to the BlackBerry Enterprise Server for IBM Lotus Domino.

Display name display name of the user account

DeviceID PIN of the BlackBerry device

Parameter Steps

42

4: Log analysis tools

Determining BlackBerry MDS Connection Service use patternsUse the MDSPushvsPull tool to determine whether the BlackBerry MDS Connection Service is processing more data by pushing applications to the BlackBerry device or by the BlackBerry device pulling data.

Run the MDSPushvsPull tool1. Copy the BlackBerry MDS Connection Service log files to the computer on which the MDSPushvsPull tool

runs.

2. At the command prompt, switch to the folder in which MDSPushvsPull.exe resides.

3. Run the MDSPushvsPull tool with the following parameters. The parameters listed in the brackets are optional.

SRPID SRP identifier for the BlackBerry Enterprise Server on which the user account resides

Messages to number of messages sent to the BlackBerry device

Messages from number of messages sent from the BlackBerry device

replied to/forwarded from number of messages replied to or forwarded from the BlackBerry device; this is a subset of the messages sent from BlackBerry device

Attachment requests number of attachment requests sent from the BlackBerry device

OTAFM TO number of wireless message reconciliation requests sent to the BlackBerry device; this is wireless folder management data

OTAFM FROM number of wireless message reconciliation requests sent from the BlackBerry device

CICAL TO (in bytes) number of compressed ICAL (CICAL) bytes sent to the BlackBerry device; this is wireless calendar data

CICAL FROM (in bytes) number of CICAL bytes sent from the BlackBerry device

CMIME TO (in bytes) number of compressed MIME (CMIME) bytes sent to the BlackBerry device

CMIME FROM (in bytes) number of CMIME bytes sent from the BlackBerry device

MDS TO (in bytes) number of BlackBerry MDS Connection Service bytes sent to the BlackBerry device; you can find this statistic in the BlackBerry Dispatcher log file

MDS FROM (in bytes) number of BlackBerry MDS Connection Service bytes sent from the BlackBerry device; you can find this statistic in the BlackBerry Dispatcher log file

OTASYNC TO (in bytes) number of synchronized bytes sent over the wireless network to the BlackBerry device (wireless personal information management (PIM) synchronization data); you can find this statistic in the BlackBerry Dispatcher log file

OTASYNC FROM (in bytes) number of synchronized bytes sent over the wireless network from the BlackBerry device; you can find this statistic in the BlackBerry Dispatcher log file

Parameter Steps

-p <e/d/g> > Indicate the platform.

• Microsoft Exchange: Type e.

• IBM Lotus Domino: Type d.

• Novell GroupWise: Type g.

Column Description

43

BlackBerry Enterprise Server Resource Kit User Guide

Example: Obtaining push results

mdspushvspull -p e -type push -l C:\BRK

Interpreting the results of the MDSPushvsPull queryResults of the query are in a .csv file named MDSPushPull_<MMDD>.<#>.csv, where <MMDD> is the month and day, and <#> is the number of BlackBerry MDS Connection Service restarts that the tool finds in the log files.

[-type] <push or pull> > Type push or pull to see results for one type only. If you do not specify a type, the tool returns results for both types.

[-mds] <acronym> > Type the acronym that identifies the BlackBerry MDS Connection Service log file if it is not MDAT.

[-l] <C:\folder\> > Specify the location of the log files if they are not in the same folder as the tool.

[-debug] <filename.txt> > Type -debug and a file name if you want to produce more detailed output for debugging purposes. By default, the debug information appears on the screen.

[-ol] <path> > Type the location in which you want to place the output files.

[-?/-help] > Type either -? or -help for information about the MDSPushvsPull tool. The MDSPushvsPull tool does require other parameters when you use this parameter.

Column Description

Type type of request, either push or pull

Source source of the request

• pull: the PIN of the BlackBerry device making the request

• push: the BlackBerry Enterprise Server making the request

Destination destination of the request

• pull: the web site that the BlackBerry device requests

• push: the BlackBerry device or email address of the user

Date date the request was made

Time time the request was made

Port port number of the request

Size size of the request in bytes

Parameter Steps

44

5

Log Monitor tool

Requirements and considerations

Download the BlackBerry Enterprise Server Resource Kit files1. Visit www.blackberry.com/support/downloads/resourcekit.shtml to download the appropriate version of the

BlackBerry Enterprise Server Resource Kit, preferably to the computer on which you plan to run the tools.

2. Double-click the .exe file that you downloaded.

3. In the Unzip to folder field, create a folder in which to store the files.

4. Click Unzip.

Prepare to run the Log Monitor tool1. On the computer on which you plan to run the BlackBerry Enterprise Server, create a folder in which to store

the Log Monitor tool.

2. Copy LogMonitor.exe to the folder that you created in step 1.

Preparing to monitor the BlackBerry Enterprise Server You can specify the text or an event in a log file that you want the Log Monitor tool to monitor and which action you want it to perform after it finds the search criteria. When a log message is written to the log file, the Log Monitor tool compares the message against each event that you specified. When a match occurs, the Log Monitor tool performs that associated action. The Log Monitor tool monitors one file at a time and monitors the text as the log entries are written to the log file.

Requirements and considerationsDownload the BlackBerry Enterprise Server Resource Kit filesPrepare to run the Log Monitor toolPreparing to monitor the BlackBerry Enterprise Server

Requirements and considerations

! The Log Monitor tool must run on the same computer on which the BlackBerry Enterprise Server runs.

! The Log Monitor tool can monitor only one log file at a time.

BlackBerry Enterprise Server Resource Kit User Guide

You can specify the values to monitor and actions to perform in the following ways:

• At the command prompt, type a list of event IDs or a text string that you want to monitor and an action that you want the Log Monitor tool to perform, such as running a customized batch file or creating text files that contain the information that you requested the Log Monitor tool to gather.

When you request that the Log Monitor tool monitor for event IDs, it monitors the log file for entries that begin with the given event IDs enclosed in brackets. For example, the Log Monitor tool finds event 40805 in the log entry [40805] (01/26 00:00:05):{0x10FC} and then performs the specified action for the event.

You can specify event IDs as five- or six-digit numbers. You must type the event IDs in a comma-separated list at the command prompt. When you use a comma-separated list of events, specified with the -events parameter, the Log Monitor tool treats the event individually with an assigned action for that specific event.

• In an input file, specify sets of actions and event IDs or text strings that trigger the Log Monitor tool to perform the actions. The input file contains events (text values or regular expressions) that you want the Log Monitor tool to monitor, and new actions that the tool performs when it finds the event or text string.

Action lines in the input file begin with the text action= (where the text action is case-insensitive). When the Log Monitor tool finds an action line, that action becomes the current action to associate with subsequent events. The Log Monitor tool treats input lines that contain exactly five or six digits as event IDs and searches for them at the beginning of log lines enclosed in brackets. For multiple event IDs, you must specify one event ID on each line. You can specify text strings for the Log Monitor tool to monitor. The Log Monitor tool treats the text strings as case-insensitive regular expressions.

Environment variables that the Log Monitor tool usesThe Log Monitor tool sets the following environment variables before performing any actions that you specify:

A sample batch script that accesses and displays these environment variables on the screen might include the following lines:

• @echo off

• echo "LogMonitorEncoding=%LogMonitorEncoding%"

• echo "LogMonitorEvent=%LogMonitorEvent%"

• echo "LogMonitorAction=%LogMonitorAction%"

• echo "LogMonitorText=%LogMonitorText%"

• echo "LogMonitorValue=%LogMonitorValue%"

Variable Value

LogMonitorEncoding type of encoding used for the file; for example, the value might be “ ” or UTF-8 encoded

LogMonitorEvent event ID of the log file

LogMonitorAction action that the tool performs after it finds the requested event or text

LogMonitorText text string

LogMonitorValue the value that the Log Monitor tool returns that matched the event or text

46

5: Log Monitor tool

Run the Log Monitor tool 1. At the command prompt, switch to the folder in which LogMonitor.exe resides.

2. Run the Log Monitor tool with the following parameters. The parameters listed in brackets are optional.

Log Monitor tool examplesSteps 4 through 7 simulate new messages written to a log file. In a real environment, it is not necessary to append data to the log file as shown in the examples.

Example 1: Run the Log Monitor tool so that it creates a separate file for each user account that contains the log messages specific to that user

1. Create a batch file named cmd.bat that contains the following text:

@echo off

echo %LogMonitorText% >>%LogMonitorValue%.txt

2. Create an input file named input.txt that contains the following string (regular expression) that the tool monitors:

?:}{([^}]*)

3. Create a text file named log.txt to store and append the log information.

4. Run the following command:

LogMonitor.exe �l log.txt �input input.txt �Action cmd.bat

5. Create a text file named SampleMessage.txt.

Parameter Steps

-l <filename> > Type the location and name of the log file that you want the Log Monitor tool to monitor.

[-events] <events> > Type the text strings or events that you want the Log Monitor tool to check; events must be comma-delimited.

[-action] <action> > Type the action that you want the Log Monitor tool to perform after it finds the event ID or text string that you specified.

Note: To close the Log Monitor tool after it performs a specified action, precede the action with a tilde character (~) or use the tilde character only.

[-input] <filename> > Type the name of the input file.

[-debug] <filename> > Type -debug and a file name to create a more detailed output file for debugging purposes.

[-help or -?] > Type either -? or -help for information about the Log Monitor tool. The Log Monitor tool does not require other parameters when you use this parameter.

47

BlackBerry Enterprise Server Resource Kit User Guide

6. Copy the following log lines to SampleMessages.txt:

[40702] (08/16 00:00:11):{0x12E8} {[email protected]} Starting message rescan

[40703] (08/16 00:00:12):{0x12E8} {[email protected]} Message rescan completed

[40702] (08/16 00:00:12):{0x12E8} {[email protected]} Starting message rescan

[40703] (08/16 00:00:12):{0x12E8} {[email protected]} Message rescan completed

7. At the command prompt, type type SampleMessages.txt >>log.txt to append the contents of SampleMessages.txt to log.txt.

When the Log Monitor tool finds the newly added log entries in the log.txt file, the tool creates files named [email protected] and [email protected].

Example 2: Run the Log Monitor tool so that when it finds events 40702 or 40703, it executes a cmd.bat file and exits

1. Create a file named cmd.bat.

2. Create a text file named log.txt to store and append the log information.

3. Run the following command:

LogMonitor �l log.txt �events 40702,40703 �action ~cmd.bat

4. Create a text file named SampleMessage.txt.

5. Copy the following log lines to SampleMessages.txt:

[40702] (08/16 00:00:11):{0x12E8} {[email protected]} Starting message rescan

[40703] (08/16 00:00:12):{0x12E8} {[email protected]} Message rescan completed

[40702] (08/16 00:00:12):{0x12E8} {[email protected]} Starting message rescan

[40703] (08/16 00:00:12):{0x12E8} {[email protected]} Message rescan completed

6. At the command prompt, type type SampleMessages.txt >>log.txt >>log.txt to append the contents of SampleMessages.txt to log.txt.

When the Log Monitor tool finds the newly added log entries in log.txt, the Log Monitor tool completes the action that you requested in cmd.bat. For example, if cmd.bat is the same file that you used in Sample 1, the Log Monitor tool creates files named 40702.txt and 40703.txt.

48

6

Message Receipt Confirmation tool

Requirements and considerations

Download the BlackBerry Enterprise Server Resource Kit files1. Visit www.blackberry.com/support/downloads/resourcekit.shtml to download the appropriate version of the

BlackBerry Enterprise Server Resource Kit, preferably to the computer on which you plan to run the tools.

2. Double-click the .exe file that you downloaded.

3. In the Unzip to folder field, create a folder in which to store the files.

4. Click Unzip.

Install the Message Receipt Confirmation toolThe Message Receipt Confirmation tool consists of the Message Receipt Confirmation service (MessageConfirmService.exe) and the Message Receipt Confirmation client (MessageConfirmConfig.exe), and system files.

1. On the computer on which you plan to run the Message Receipt Confirmation tool, create a folder in which to store the Message Receipt Confirmation tool files.

Requirements and considerationsDownload the BlackBerry Enterprise Server Resource Kit filesInstall the Message Receipt Confirmation toolPreparing to monitor the BlackBerry Enterprise ServerViewing the status of messages sent to BlackBerry devicesMessage Receipt Confirmation tool log files

Requirements and considerations

! Do not run the Message Receipt Confirmation tool on the same computer on which the BlackBerry Enterprise Server runs.

! The Message Receipt Confirmation service (messageconfirmservice.exe) and Message Receipt Confirmation client (messageconfirmconfig.exe) must run on the same computer.

! The Message Receipt Confirmation tool must have permission to write to and read from the hard disk and the registry.

! The Message Receipt Confirmation tool must run as a Microsoft Windows service; the Message Receipt Confirmation service can run as the local system account.

! You must select or create an email account from which the Message Receipt Confirmation tool can access and send messages.

! If you are using IBM DB2 UDB, you must install an IBM DB2 UDB client on the computer on which you plan to run the Message Receipt Confirmation service.

BlackBerry Enterprise Server Resource Kit User Guide

2. Copy the following files to the new folder:

• MessageConfirmService.exe

• MessageConfirmConfig.exe

• MessageConfirmX.dll (Microsoft Exchange environments only)

• MessageConfirmD.dll (IBM Lotus Domino environments only)

• MessageConfirmG.dll (Novell GroupWise environments only)

Install the Message Receipt Confirmation service1. At the command prompt, switch to the folder in which the Message Receipt Confirmation tool files reside.

2. Type messageconfirmservice -install <platform>, where <platform> is one of the following values:

• exchange

• domino

• groupwise

3. Consider the following information as you complete the installation prompts:

Task Steps

Choose whether to start the Message Receipt Confirmation service automatically or manually.

> Type Y to start the service automatically; otherwise, type N. The default setting is to start the service manually.

Specify the domain user account and password. 1. Type the name of the domain user account that the User Administration service uses to run. The domain user account should be the same account that the other BlackBerry services use.

2. Type the password for the domain user account, or if you do not have a password, leave the password field empty.

Specify the type of authentication to use. > To use SQL authentication or IBM DB2 UDB authentication, type Y; to use Microsoft Windows authentication, type N.

Specify the database authentication credentials, if applicable.

1. Type the login user name.

2. Type the password.

For Microsoft Exchange environments, identify the name of the MAPI profile to connect to the messaging server.

> Type the name of the MAPI profile.

For Novell GroupWise environments, specify the user ID and the MailServerName that the Message Receipt Confirmation tool uses to connect to the messaging server.

> Type the user ID.

> Type the MailServerName using one of the following formats:

<ipaddress>:<port> or <hostname>:<port>

For the BlackBerry Enterprise Server for IBM Lotus Domino, identify the path to and the password for the Notes ID file that the tool should use to perform tasks.

Note: The Notes ID file must have the same permissions as the BlackBerryAdmins group.

1. Type the full path name of the Notes ID file.

2. Type the password for the Notes ID file.

50

6: Message Receipt Confirmation tool

4. In the Microsoft Windows Services window, start the Message Receipt Confirmation service.

Preparing to monitor the BlackBerry Enterprise ServerYou can use the Message Receipt Confirmation tool to monitor whether the BlackBerry Enterprise Server is sending messages to BlackBerry devices successfully.

You define which user accounts the Message Receipt Confirmation tool should monitor. You also set the frequency at which the Message Receipt Confirmation tool sends delivery timeout notification messages. You can monitor up to five BlackBerry devices on different BlackBerry Enterprise Servers that use the same BlackBerry Configuration Database.

Set up the Message Receipt Confirmation tool1. At the command prompt, switch to the folder in which the Message Receipt Confirmation tool resides.

2. Type messageconfirmconfig.

3. Click Configuration.

4. Verify that the environment-specific information that displays at the bottom of the screen is correct.

5. Perform any of the following actions:

For the BlackBerry Enterprise Server for IBM Lotus Domino, specify the full path of the executable directory, Notes.ini file name, messaging server name, and name of the user’s mail file.

1. At the installation prompt Enter NotesDir, type the full path of the executable directory. For example, type C:\Lotus\Domino.

2. At the installation prompt NotesIniPath, type the full path of the notes.ini file name. For example, type C:\Lotus\Notes\notes.ini.

3. At the installation prompt Enter the MAILSERVER this service should use, type the messaging server name. For example, type CN=Server1/0=Organization.

4. At the installation prompt Enter the MAILFILE this service should use, type the name of the user’s mail file. For example, type mail\user1.nsf.

Task Steps

Define the subject of the messages that the Message Receipt Confirmation tool sends to the BlackBerry device.

> In the Subject of Message Send field, type a subject.

Specify how frequently to send messages to the BlackBerry device.

> In the Message Send Interval field, type a value in hours and minutes (for example, 1:30 or 0:30).

Specify how often the Message Receipt Confirmation service checks the specified administrator’s mailbox for a confirmation delivery notification message.

> In the Delivery Check Interval field, type a value in minutes (for example, 1 or 2).

Specify how long the tool should continue to check for delivery confirmation messages before the service notifies you of the timed-out message delivery.

> In the Delivery Timeout Interval field, type a value in minutes (for example, 5 or 10).

Task Steps

51

BlackBerry Enterprise Server Resource Kit User Guide

The monitoring information is available at HKEY_CURRENT_USER\SOFTWARE\Research In Motion\BlackBerry Message Receipt Confirmation tool, in the configuration and status subkeys.

Viewing the status of messages sent to BlackBerry devicesEach time the Message Receipt Confirmation tool starts, the Message Receipt Confirmation service clears the message delivery status values. The Message Receipt Confirmation service obtains the list of user accounts to monitor and sends a message to each user. When the Message Receipt Confirmation service sends a message to a BlackBerry device, it assigns a serial number to the message. The service maintains the serial numbers that the Message Receipt Confirmation tool assigns to the sent messages, and it increments that number by one each time it sends a new message. In the Message Receipt Confirmation client, the Last Message Send and Serial Number fields and the Deliveries list, which shows that the messages were sent, are updated with the status information. When the value set in the Delivery Check Interval field is reached, the Message Receipt Confirmation service checks for successful delivery of the messages and updates the Deliveries list. When the value set in the Delivery Timeout Interval field is reached, a timeout status message for the user account displays in the Deliveries list, and a delivery timeout notification message is sent to the defined SMTP email account to indicate the message delivery failure.

To confirm the message delivery, the Message Receipt Confirmation service uses the message subject line options (<$Confirm,RemoveOnDelivery,SuppressSaveInSentItems>).

Message Receipt Confirmation client status fields

Set the email account to which the Message Receipt Confirmation service sends the delivery timeout notification message.

> In the Send Notifications To field, type an SMTP email address.

Define the subject of the delivery timeout notification message that the Message Receipt Confirmation tool sends to the defined email account.

> In the Subject of Notifications field, type a subject.

Add the user account to monitor. 1. In the BlackBerry Enterprise Servers list, click a BlackBerry Enterprise Server.

2. Click the user account.

3. Click Monitor.

Stop monitoring a user account. 1. In the BlackBerry Enterprise Servers list, click a BlackBerry Enterprise Server.

2. Click the user account.

3. Click Remove.

Field Description

Service Start date when the Message Receipt Confirmation service started

Last Message Send time of the last attempt to send a message to the BlackBerry device

Serial Number unique number assigned automatically to each message that the Message Receipt Confirmation service sends

Task Steps

52

6: Message Receipt Confirmation tool

Sample Message Receipt Confirmation tool messages

Message Receipt Confirmation tool log filesThe Message Receipt Confirmation tool creates a daily log file named <hostname>_MRCT_<##>_<date>_<####>.txt in the root folder of the computer on which the Message Receipt Confirmation tool runs.

The registry stores log files at HKEY_CURRENT_USER\SOFTWARE\Research In Motion\BlackBerry Message Receipt Confirmation Tool\Configuration.

Last Message Delivery Check last time that the Message Receipt Confirmation service checked for a successful delivery notification message

Deliveries list of user accounts and the status of the message delivery to the BlackBerry device

Example: Successful Status/Deliveries display sequences

<User_account> / Message Send Successful

<User_account> / Delivery Confirmed

or

<User_account> / Message Send Successful

<User_account> / Delivery Unconfirmed

<User_account> / Delivery Confirmed

Example: Unsuccessful Status/Deliveries display sequence, which results in the Message Receipt Confirmation tool sending a delivery failure notification message

<User_account> / Message Send Successful

<User_account> / Delivery Unconfirmed

<User_account> / Delivery Timeout

Example: Unsuccessful Status/Deliveries, which does not result in the Message Receipt Confirmation tool sending a delivery failure notification message

<User_name> / Message Send Error

The “Message Send Error” message indicates that the Message Receipt Confirmation tool could not send a message to the user account.

Type of message Example

message sent to the BlackBerry device To: <User_account>

Subject: <$Confirm,RemoveOnDelivery,SuppressSaveInSentItems > MessageConfirm%d <Subject Of Message Send>

delivery timeout notification message sent to the defined SMTP email account

To: <Send Notifications To>

Subject: <Subject of Notifications>

Body: Could not confirm delivery to <User_account>

Field Description

53

BlackBerry Enterprise Server Resource Kit User Guide

54

7

Upgrade IT Policy Template tool

Requirements and considerations

Download the BlackBerry Enterprise Server Resource Kit files1. Visit www.blackberry.com/support/downloads/resourcekit.shtml to download the appropriate version of the

BlackBerry Enterprise Server Resource Kit, preferably to the computer on which you plan to run the tools.

2. Double-click the .exe file that you downloaded.

3. In the Unzip to folder field, create a folder in which to store the files.

4. Click Unzip.

Preparing the input fileBefore you run the Upgrade IT Policy Template tool, prepare the input file.

Upgrade IT Policy Template tool input file requirementsYou can provide an input file in .sql or .csv file format. Include the following information for both file formats:

Requirements and considerationsDownload the BlackBerry Enterprise Server Resource Kit filesPreparing the input fileRun the Upgrade IT Policy Template toolUpgrade IT Policy Template log files

Requirements and considerations

! Do not run the Upgrade IT Policy Template tool on the same computer on which the BlackBerry Enterprise Server runs.

Item Description

Command • INSERT: updates the existing record with the specified values if a record matches an existing record in the Tag, SubTag, and Name fields

• DELETE: deletes records that match the values on the delete line

Tag sets a number ID for the policy item; the default setting is 255 and is not required in the .csv file

SubTag sets a number for grouping items with the same Tag; the default setting is 255 and is not required in the .csv file

BlackBerry Enterprise Server Resource Kit User Guide

Prepare the input file in SQL formatSee “Upgrade IT Policy Template tool input file requirements” on page 55 for more information about how to create the input file.

1. If you plan to use the -db parameter in the input file, use _DATABASENAME_ as a placeholder for the name of the BlackBerry Configuration Database you specify. When you run the Upgrade IT Policy Template tool, it replaces all occurrences of the placeholder with the BlackBerry Configuration Database name before executing a command.

2. Use a GO line to prompt the Upgrade IT Policy Template tool to execute all buffered statements in a batch.

Name name of the policy item as it appears in the BlackBerry Manager Edit IT Policy window

Note: This field is mandatory.

Description description for a policy item as it appears in the BlackBerry Manager Edit IT Policy window; the maximum length is 2047 characters

Note: This field is mandatory.

Type data type for the item

• -1: folder

• 0: boolean (default)

• 1: integer

• 2: string

• 3: bitmask

• 4: multiline string

MinValue minimum value for the item; the default value is 0

Note: This value is applicable when Type is set to 1 (integer).

MaxValue the maximum value for the item; the default value is 0

Note: This value is applicable when Type is set to 1 (integer).

Destination destination for the item

• -1: no destination

• 0: BlackBerry device (default)

• 1: desktop

• 2: BlackBerry device and desktop

UIMask location of an item in the list of policy items in the BlackBerry Manager Edit IT Policy window

• 3: lists the item with user-defined and other IT policy rules (default)

• 2: lists the item in one of the other groupings

Note: This field is not required.

UserPolicyRule a flag to specify whether the IT policy will show up per user

• 0: non user specific

• 1: per user specific

Data names of the 8-bit options, separated by a vertical bar (|)

For example, option0|option1|option2|option3|option4|option5|option6|option7.

Note: The default value is empty.

Item Description

56

7: Upgrade IT Policy Template tool

3. Use only one INSERT, DELETE, or UPDATE command for each line.

4. Group the IT policy items together in brackets, separated by commas.

5. Group the values of the IT policy items together in brackets, separated by commas, and enclose each value in single quotation marks.

6. Indicate blank values using single quotation marks with no spaces between them.

7. Enclose comments in /* */ blocks. For example /* comments */.

Example .sql file/* * BlackBerry Enterprise Server ITPolicy Template * Copyright (C) 2006 Research In Motion Limited */USE "_DATABASENAME_"set nocount on

GO/* Delete all the rows in the table to be updated or removed. *//* (Note: Maintain SQL command format when adding new items to this list.) */

DELETE FROM ITPolicyTemplate2 WHERE Tag IN (1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20)

DELETE FROM ITPolicyTemplate2 WHERE Tag IN (21,22,23,24,28,29,30,32,33,34,80,81,82,83,84,85,86,87)

GO

INSERT INTO ITPolicyTemplate2(Tag,SubTag,Name, Description,Type,MinValue,MaxValue,Destination,UIMask,UserPolicyRule,Data) VALUES( '1','0','Allow Phone','Specifies whether users can use phone capabilities on the BlackBerry device.||If this rule is set to FALSE, the phone icon is still visible, but only emergency calls can be made.||Warning: Setting, modifying, or removing this rule causes the BlackBerry device to reset when the IT policy update is received.||In the absence of this rule, a default value of "TRUE" is used.||This rule applies only to Java�-based BlackBerry devices with BlackBerry Device software Version 3.6.0 and later.',0,0,0,2,2,'' )

Prepare the input file in CSV formatSee “Upgrade IT Policy Template tool input file requirements” on page 55 for more information about the IT policy items to include in the file.

1. Include all 11 IT policy items on each line.

2. Use 0 in INSERT commands to represent blank values, except with the Data.

3. In DELETE commands, include the Command and Tag policy items.

4. Separate IT policy item values with commas.

57

BlackBerry Enterprise Server Resource Kit User Guide

5. In the Description IT policy item, enclose descriptions that contain a comma or quotation marks in quotation marks.

Note: If you create the file in Microsoft® Excel®, the program adds the quotation marks for you. If you create the file using Microsoft® Notepad, insert the quotation marks at the beginning and end of the description and around text that appears in quotation marks. For example, “The default is ““TRUE”” for this policy.”

6. In the Description IT policy item, use two vertical bars to indicate line breaks.

Example .csv fileCommand,Tag,Tag,Name,Description,Type,MinValue,MaxValue,Destination,UIMask,UserPolicyRule,DataDELETE,36,,,,,,,,,,DELETE,37,,,,,,,,,,DELETE,38,,,,,,,,,,DELETE,40,,,,,,,,,,INSERT,36,0,VoIP Policy Group,VoIP Policy Group,-1,0,0,0,2,INSERT,36,1,Allow VoIP,"Specifies whether the ability to make VoIP calls is enabled||In the absence of this rule, a default value of ""TRUE"" is used.||This rule applies only to Java-based BlackBerry devices with BlackBerry Device Software Version 4.0.0 and later.",0,0,0,0,2,INSERT,36,2,VoIP Allow Handheld Changes, "Set to True if users can change elements of this IT Policy.|| If set to False, then users can still change user-specific elements.||In the absence of this rule, a default value of ""TRUE"" is used.||This rule applies only to Java-based handhelds with BlackBerry Device Software Version 4.0.0 and later.",0,0,0,0,2,

Run the Upgrade IT Policy Template tool1. Close the BlackBerry Manager.

2. At the command prompt, switch to the folder in which UpgradeITPolicyTemplate.exe resides.

3. Run the Upgrade IT Policy Template tool with the following optional parameters as required:

Parameter Steps

<input-file> > Specify a .csv or .sql file with the IT policy items.

[-SQLAuth] > Type this parameter to use SQL authentication or IBM DB2 UDB authentication. By default the Upgrade IT Policy Template uses Microsoft Windows authentication.

[-n] <address> > Type the network address (computer host name or IP address) on which the BlackBerry Configuration Database exists; the default address is the local computer.

[-db] <name> > Type the name of the BlackBerry Configuration Database in which to connect. By default the name is BESMgmt.

[-dbms] <database type> > Type SQL to use a database that exists on a Microsoft SQL Server; or, type db2 to use a database that exists on an IBM DB2 UDB server.

[-db2schema] <schema name>

> Type the IBM DB2 UDB schema name. By default, the schema name is BESADMIN.

Platform: This parameter applies to the BlackBerry Enterprise Server for IBM Lotus Domino only.

58

7: Upgrade IT Policy Template tool

Example: Upgrading the IT policy template with no confirmation prompt and no database backup, using SQL authentication

upgradeitpolicytemplate filename.csv -SQLAuth -n test.rim.net -db BESMgmt -dbms sql -noconfirm -nobackup -debug 2

Example: Upgrading the IT policy template with no confirmation prompt and no database backup, using IBM DB2 UDB authentication

upgradeitpolicytemplate filename.csv -dbms db2 -db2schema <schema name> -db2port <port number> -noconfirm -nobackup -debug 2

Upgrade IT Policy Template log filesThe Upgrade IT Policy Template tool creates an output file named UpgradeITPolicyTemplate_log_<MMDD>.txt, where <MMDD> is the month and the day that you ran the tool.

By default, the Upgrade IT Policy Template tool creates a log file each time you run it. The log file displays the events and activities that the Upgrade IT Policy Template tool performed when you ran it. The log file contains information about the events, and the corresponding time stamps.

[-db2port] <port number> > Type the IBM DB2 UDB port number. By default, the port number is 50000.

Platform: This parameter applies to the BlackBerry Enterprise Server for IBM Lotus Domino only.

[-noconfirm] > Type this parameter to bypass user confirmation for destructive actions (for example, deletions).

[-nobackup] > Type this parameter if you do not want to back up the existing IT policy template table before making changes.

[-debug] <level> > Type -debug to produce additional output to the log file for debugging purposes.

• 0: normal level; only essential status messages are logged (default)

• 1: mid level; more detailed logging

• 2: high level; detailed logging for in-depth analysis

[-?] > Type -? for information about the Upgrade IT Policy Template tool. No other parameters are required when you use this parameter.

Parameter Steps

59

BlackBerry Enterprise Server Resource Kit User Guide

60

8

User Administration tool

Requirements and considerations

Requirements and considerationsDownload the BlackBerry Enterprise Server Resource Kit filesInstalling the User Administration toolManaging user accountsManaging BlackBerry devicesSending notification messages to BlackBerry devicesManaging email and folder redirectionManaging IT policies and IT policy rulesObtaining BlackBerry device informationDisplay the status of the User Administration serviceParameters available for the User Administration tool

Requirements and considerations

! Do not run the User Administration tool on the same computer on which the BlackBerry Enterprise Server runs.

! The User Administration tool supports mixed environments with BlackBerry Enterprise Server Version 4.0 SP2 and later. Although the User Administration tool might appear to perform tasks on BlackBerry Enterprise Server Version 4.0 SP1 and earlier, the results are unpredictable.

! The User Administration tool does not support changing an IT policy with BlackBerry Enterprise Server versions earlier than 4.0.

! The User Administration tool runs as a Microsoft Windows service named the BlackBerry User Administration Service.

! You must install Microsoft® XML Parser 4.0 on the computer on which you plan to run the User Administration service.

! You can install the User Administration client on the same computer on which the User Administration service runs or on a different computer. The User Administration service must be running before you can use the User Administration client.

! The User Administration service and the User Administration client components that you use must be the same version.

! The BlackBerry Enterprise Server and the computers on which the User Administration components exist must reside in the same Microsoft Windows domain.

! To connect to the computer on which the User Administration service runs from a remote computer, you must turn on the printer and file-sharing features on the computer on which the User Administration service runs.

! For IBM Lotus Domino, you must install IBM® Lotus Notes® on the computer on which you plan to run the User Administration service.

! For IBM Lotus Domino, the Notes ID file that you use to run the User Administration client must have the same permissions as the BlackBerryAdmins group.

! If you are using IBM DB2 UDB, you must install an IBM DB2 UDB client on the computer on which you plan to run the User Administration tool.

! If you are using IBM DB2 UDB, verify that the BlackBerry Configuration Database belongs to the database catalog that resides on the same computer on which the User Administration service runs.

BlackBerry Enterprise Server Resource Kit User Guide

Download the BlackBerry Enterprise Server Resource Kit files1. Visit www.blackberry.com/support/downloads/resourcekit.shtml to download the appropriate version of the

BlackBerry Enterprise Server Resource Kit, preferably to the computer on which you plan to run the tools.

2. Double-click the .exe file that you downloaded.

3. In the Unzip to folder field, create a folder in which to store the files.

4. Click Unzip.

Installing the User Administration toolThe User Administration tool consists of the User Administration service (BESUserAdminService.exe) and the User Administration client (BESUserAdminClient.exe), and system files.

Install the User Administration service1. On the computer on which you plan to install the User Administration service, create a folder in which to store

the User Administration files.

2. Copy the following files to the new folder:

• BESUserAdminService.exe

• CE.dll

• ClientAuthentication8.dll

• ServerAuthentication8.dll

• BESUserAdminX.dll (Microsoft Exchange environments only)

• BESUserAdminD.dll (IBM Lotus Domino environments only)

• BESUserAdminG.dll (Novell GroupWise environments only)

• BESUserAdminAudit.dll

• BESUserAdminClient.exe (necessary if you run the client on the same computer as the service)

3. At the command prompt, switch to the folder in which BESUserAdminService.exe resides.

4. Type besuseradminservice -install <platform> where <platform> is one of the following values:

• exchange

• domino

! Verify that you configured the IBM DB2 UDB server to look up groups at the domain level. To verify this, check that the following parameter exists in the IBM DB2 UDB profile registry on the IBM DB2 UDB server:

DB2_GRP_LOOKUP=DOMAIN,TOKENDOMAIN

If this parameter is not set, the User Administration tool does not support Microsoft Windows authentication.

Requirements and considerations

62

8: User Administration tool

• groupwise

• mdsapplications

5. Consider the following information as you complete the installation:

Task Steps

Choose whether to start the User Administration service automatically or manually.

> Type Y to start the service automatically; otherwise, type N. The default setting is to start the service manually.

Specify the domain user account and password. 1. Type the name of the domain user account that the User Administration service uses to run. The domain user account should be the same account that the other BlackBerry services use.

2. Type the password for the domain user account, or if you do not have a password, leave the password field empty.

Choose whether to use User Administration service registry settings that already exist on the computer.

> Type Y to use existing registry settings; otherwise, type N to start a new installation.

If the BlackBerry Manager runs on the same computer, the User Administration service attempts to detect the existing BlackBerry Configuration Database settings and displays the message “Found BlackBerry Manager settings: DB Server: [Database Server], DB Name: [Database Name].”

> Type Y to confirm the BlackBerry Configuration Database that the User Administration service detects.

For the BlackBerry Enterprise Server for IBM Lotus Domino, if the BlackBerry Manager is not running on the same computer, specify the Microsoft SQL Server or an IBM DB2 UDB server on which the BlackBerry Configuration Database resides.

> Type 1 to use a Microsoft SQL Server; type 2 to use an IBM DB2 UDB server.

For the BlackBerry Enterprise Server for Microsoft Exchange, the BlackBerry Enterprise Server for Novell GroupWise, or the BlackBerry Enterprise Server for MDS Applications, if the BlackBerry Manager is not running on the same computer, specify the Microsoft SQL Server on which the BlackBerry Configuration Database resides.

> Type the host name of the Microsoft SQL Server computer.

Specify the BlackBerry Configuration Database name.

> Type the BlackBerry Configuration Database name.

For the BlackBerry Enterprise Server for IBM Lotus Domino, if you are using an IBM DB2 UDB, specify the IBM DB2 UDB schema name of the BlackBerry Configuration Database.

> Type the IBM DB2 UDB schema name. By default, the database schema name is BESADMIN.

For the BlackBerry Enterprise Server for IBM Lotus Domino, if you are using an IBM DB2 UDB, specify the IBM DB2 UDB port number.

> Type the IBM DB2 UDB port number. By default, the port number is 50000.

Specify the type of database authentication you want to use.

> To use SQL authentication or IBM DB2 UDB authentication (database authentication), type Y; to use Microsoft Windows authentication, type N.

63

BlackBerry Enterprise Server Resource Kit User Guide

6. In the Microsoft Windows Services window, start the BlackBerry User Administration Service.

User Administration service log filesIf you run the User Administration service on a computer on which the BlackBerry Manager runs, the User Administration service creates log files that reside in the same folder as the BlackBerry log files. Otherwise, the User Administration tool creates log files in the same folder in which the BESUserAdminService.exe file resides. The User Administration service saves the log files in a text file named <hostname>_BBUA_<##>_<date>_<xxxx>.txt.

If the BlackBerry Manager runs on the same computer, the User Administration service attempts to detect the existing database authentication user name and password and displays the message “Found BlackBerry Manager settings: Login: [SQL/DB2 UDB Authentication User], Password: ***.”

> Type Y to confirm the database authentication user name and password that the User Administration service detects.

If the BlackBerry Manager is not running on the same computer, specify the database authentication credentials.

1. Type the login name, if applicable.

2. Type the password, if applicable.

Set the client password that the User Administration client uses to authenticate with the User Administration service.

> Type a password up to 32 characters long.

Set restrictions for the hosts that can run the User Administration client.

> To restrict the computers that you permit to run the User Administration client, type a comma-separated list of computer names. To permit all computers to run the User Administration client, leave the field empty.

For the BlackBerry Enterprise Server for Microsoft Exchange, specify the name of the MAPI profile to connect to the BESAdmin mailbox.

> Type the name of the MAPI profile.

For the BlackBerry Enterprise Server for IBM Lotus Domino, specify the path to and the password for the Notes ID file that you want the User Administration tool to use.

Note: The Notes ID file must belong to the BlackBerryAdmins group.

1. Type the full path name of the Notes ID file.

2. Type the password for the Notes ID file.

For the BlackBerry Enterprise Server for IBM Lotus Domino, specify the messaging server that you want the User Administration tool to use.

> At the installation prompt Enter the MAILSERVER this service should use, type the messaging server name. For example, type CN=Server1/0=Organization.

For BlackBerry Enterprise Server for Novell GroupWise, specify the user ID that you want the User Administration tool to use.

> Type the user ID.

Set access rights that the User Administration clients can use to connect to the BlackBerry Enterprise Server.

> Type Y to permit access to only User Administration clients that are logged in with the same account ID that you set to start the User Administration service; otherwise, type N.

Task Steps

64

8: User Administration tool

User Administration audit log filesYou can enable the User Administration service to create User Administration audit files. If you run the User Administration service on a computer on which the BlackBerry Manager runs, the User Administration tool creates audit log files that reside in the same folder as the BlackBerry log files. Otherwise, the User Administration tool creates audit log files in the same folder in which the BESUserAdminService.exe file resides. The User Administration tool saves the audit log files in a text file named <hostname>_BBUA_AUDT_<##>_<date>_<xxxx>.txt.

By default, the User Administration audit logging feature is turned off.

Set up the User Administration audit logging1. On the computer on which the User Administration service runs, in the Registry Editor, browse to

HKEY_CURRENT_USER\Software\Research In Motion\BlackBerry Enterprise Server\Admin.

2. Perform any of the following tasks:

Prepare to run the User Administration client> Copy BESUserAdminClient.exe and CE.dll to a folder on the computer on which you plan to run the User

Administration client.

Specify a local system account to run the User Administration toolDuring the installation of the User Administration service component, administrator permissions are given to the user account logged in at the time of installation. If you want to specify a local system account to run the User Administration tool, you must change the registry settings for the User Administration tool and then change the User Administration service to log on using the local system account.

Change the User Administration service registry settings

1. Log in to the Microsoft Windows account that you use to run the User Administration service.

2. Open the Registry Editor and browse to HKEY_CURRENT _USER\Software\Research In Motion\BlackBerry Enterprise Server\Admin.

3. Right-click Admin. Select Export.

4. Save the registry settings to a text file.

Task Steps

Start the User Administration audit logging feature. 1. Double-click the AuditLogEnabled value.

2. In the Value data field, type 1.

3. Click OK.

Change the location in which the User Administration tool creates the audit log files.

1. Double-click the AuditLogDir value.

2. In the Value data field, type the location in which to create the audit log files.

3. Click OK.

65

BlackBerry Enterprise Server Resource Kit User Guide

5. In the text file, change the text from HKEY_CURRENT _USER\Software\Research In Motion\BlackBerry Enterprise Server\Admin to HKEY_USERS\.DEFAULT\Software\Research In Motion\BlackBerry Enterprise Server\Admin.

6. Save the file.

7. In the Registry Editor, import the file.

Change the User Administration service to log in using a local system account

1. Stop the BlackBerry User Administration Service.

2. In the Microsoft Windows Services window, in the BlackBerry User Administration Service properties, change the login account to the local system account.

Client password authenticationThe User Administration client uses the client password to authenticate with the User Administration service. When the User Administration client starts, it obtains tokenized data from the User Administration service. The User Administration client uses this unique login data to create an encrypted password that it sends to the User Administration service. The User Administration service uses this same tokenized data and client password to create an encrypted password locally. The User Administration service compares its encrypted password to the value that the User Administration client created. The encrypted passwords must match exactly for authentication to succeed.

If you type the client password incorrectly three times (in total, not consecutively), you must perform one of the following actions before the User Administration client can process more commands:

• Restart the BlackBerry User Administration Service.

• Reactivate the client password without restarting the BlackBerry User Administration Service.

Reactivate the client password1. On the computer on which the User Administration service runs, in the Registry Editor, browse to

HKEY_CURRENT_USER\SOFTWARE\Research In Motion\BlackBerry Enterprise Server\Admin.

2. Create a new String Value called ReallowHostnames.

3. Right-click ReallowHostnames. Click Modify.

4. Type the host name of the computer on which the User Administration client runs.

5. Close the Registry Editor.

6. In the User Administration client, type the command and client password.

66

8: User Administration tool

User Administration tool authentication for role-based administrationTo permit role-based administration, the user account that you use to run the User Administration client must authenticate with the BlackBerry Configuration Database. The User Administration tool supports role-based administration for user accounts using Microsoft Windows authentication, SQL authentication, and IBM DB2 UDB authentication. After the User Administration service determines the role of the client user account, the User Administration service determines whether the role permits the command that the client user account invokes. If the command is not permitted, the User Administration service reports that the operation cannot complete because of insufficient rights. The User Administration service checks for changes made to role-based administration, such as when user accounts are added or assigned to roles, at 5-minute intervals.

Managing user accountsThe BlackBerry Enterprise Server uses predefined roles, which correspond to common corporate administrative roles, to control who can perform specific tasks and limit who can access sensitive data.

By default, the User Administration client uses the Microsoft Windows authentication credentials that you supply when you log in to your computer. If the User Administration clients use SQL authentication or IBM DB2 UDB authentication (database authentication) to authenticate with the BlackBerry Configuration Database, you must specify the user name (-sqluser <database_username>) and password (-sqlpass <database_password>) with the User Administration client commands.

You can identify the role for the user account with which you are logged in to the User Administration client by using the verbose logging option (-v).

Notes: The database authentication information is encrypted when passed from the User Administration client to the User Administration service and to the BlackBerry Configuration Database.

Add a user account to the BlackBerry Enterprise Server1. At the command prompt, switch to the folder in which BESUserAdminClient.exe resides.

2. Type besuseradminclient -add and the following parameters:

• -p <client_password>

• -u <user_name>

• -PIN <PIN> (use in conjunction with the -u parameter for the BlackBerry Enterprise Server for MDS Applications only)

• -b <BlackBerry_Enterprise_Server_service_name>

• -sqluser <database_username> (if you use database authentication)

• -sqlpass <database_password> (if you use database authentication)

• -n <network_address of the User Administration service> (if the User Administration service and User Administration client do not run on the same computer)

See “Parameters available for the User Administration tool” on page 92 for more information.

67

BlackBerry Enterprise Server Resource Kit User Guide

Example: Adding a user account to a BlackBerry Enterprise Server for Microsoft Exchange

besuseradminclient -add -p password1 -u [email protected] -b -n computer01 -pin xxxxxxxx -it_policy “User Can Change Timeout”

Example: Adding a user account to a BlackBerry Enterprise Server for IBM Lotus Domino

besuseradminclient -add -p password1 -u “CN=Clyde Warren/O=Server01” -b CN=Server01/O=test.rim.net -n xx.xx.xx.xx -pin xxxxxxxx -it_policy “User Can Change Timeout”

Example: Adding a user account to a BlackBerry Enterprise Server for Novell GroupWise

besuseradminclient -add -p password1 -u clydewarren -b server01 -n computer01 -pin xxxxxxxx -it_policy “User Can Change Timeout”

Example: Adding a user account to a BlackBerry Enterprise Server for MDS Applications

besuseradminclient -add -p password1 -u “clyde warren” -pin xxxxxxxx -b server01 -n computer01 -it_policy “User Can Change Timeout”

Add a user account to a group1. At the command prompt, switch to the folder in which BESUserAdminClient.exe resides.

2. Type besuseradminclient -add and the following parameters:

• -p <client_password>

• -u <user_name>

• -PIN <PIN> (use in conjunction with the -u parameter for the BlackBerry Enterprise Server for MDS Applications only)

• -b <BlackBerry_Enterprise_Server_service_name>

• -group <group_name>

• -sqluser <database_username> (if you use database authentication)

• -sqlpass <database_password> (if you use database authentication)

• -n <network_address of the User Administration service> (if the User Administration service and User Administration client do not run on the same computer)

See “Parameters available for the User Administration tool” on page 92 for more information.

68

8: User Administration tool

Example: Adding a user account to a BlackBerry Enterprise Server, a group, and an IT policy

besuseradminclient -add -p password1 -u [email protected] -b server01 -n computer01 -pin xxxxxxx -group administrators -it_policy “User Can Change Timeout”

Add an existing user account to a group1. At the command prompt, switch to the folder in which BESUserAdminClient.exe resides.

2. Type besuseradminclient -change and the following parameters:

• -p <client_password>

• -u <user_name>

• -PIN <PIN> (use in conjunction with the -u parameter for the BlackBerry Enterprise Server for MDS Applications only)

• -b <BlackBerry_Enterprise_Server_service_name>

• -group <group_name>

• -sqluser <database_username> (if you use database authentication)

• -sqlpass <database_password> (if you use database authentication)

• -n <network_address of the User Administration service> (if the User Administration service and User Administration client do not run on the same computer)

See “Parameters available for the User Administration tool” on page 92 for more information.

Example: Adding an existing user to a group

besuseradminclient -change -p password1 -u [email protected] -b server01 -group administrators

Remove a user account from the BlackBerry Enterprise Server1. At the command prompt, switch to the folder in which BESUserAdminClient.exe resides.

2. Type besuseradminclient -delete and the following parameters:

• -p <client_password>

• -u <user_name>

• -PIN <PIN> (use in conjunction with the -u parameter for the BlackBerry Enterprise Server for MDS Applications only)

• -b <BlackBerry_Enterprise_Server_service_name>

• -sqluser <database_username> (if you use database authentication)

69

BlackBerry Enterprise Server Resource Kit User Guide

• -sqlpass <database_password> (if you use database authentication)

• -n <network_address of the User Administration service> (if the User Administration service and User Administration client do not run on the same computer)

See “Parameters available for the User Administration tool” on page 92 for more information.

Example: Removing a user from the BlackBerry Enterprise Server

besuseradminclient -delete -p password1 -u [email protected] -b server01

Remove a user account from a group1. At the command prompt, switch to the folder in which BESUserAdminClient.exe resides.

2. Type besuseradminclient -change and the following parameters:

• -p <client_password>

• -u <user_name>

• -PIN <PIN> (use in conjunction with the -u parameter for the BlackBerry Enterprise Server for MDS Applications only)

• -b <BlackBerry_Enterprise_Server_service_name>

• -cgroup

• -sqluser <database_username> (if you use database authentication)

• -sqlpass <database_password> (if you use database authentication)

• -n <network_address of the User Administration service> (if the User Administration service and User Administration client do not run on the same computer)

See “Parameters available for the User Administration tool” on page 92 for more information.

Example: Removing a user account from a group on the BlackBerry Enterprise Server

besuseradminclient -change -p password1 -u [email protected] -b server01 -cgroup

Move a user account to a different BlackBerry Enterprise ServerBoth BlackBerry Enterprise Server computers must use the same BlackBerry Configuration Database.

1. At the command prompt, switch to the folder in which BESUserAdminClient.exe resides.

2. Type besuseradminclient -move and the following parameters:

• -p <client_password>

• -u <user_name>

70

8: User Administration tool

• -PIN <PIN> (use in conjunction with the -u parameter for the BlackBerry Enterprise Server for MDS Applications only)

• -b <BlackBerry_Enterprise_Server_service_name>

• -t <target_BlackBerry_Enterprise_Server_service_name>

• -sqluser <database_username> (if you use database authentication)

• -sqlpass <database_password> (if you use database authentication)

• -n <network_address of the User Administration service> (if the User Administration service and User Administration client do not run on the same computer)

See “Parameters available for the User Administration tool” on page 92 for more information.

Example: Moving a user account to a different BlackBerry Enterprise Server

besuseradminclient -move -p password1 -u [email protected] -b server01 -t server02

Move a user account to a different group1. At the command prompt, switch to the folder in which BESUserAdminClient.exe resides.

2. Type besuseradminclient -change and the following parameters:

• -p <client_password>

• -u <user_name>

• -PIN <PIN> (use in conjunction with the -u parameter for the BlackBerry Enterprise Server for MDS Applications only)

• -b <BlackBerry_Enterprise_Server_service_name>

• -group <group_name>

• -sqluser <database_username> (if you use database authentication)

• -sqlpass <database_password> (if you use database authentication)

• -n <network_address of the User Administration service> (if the User Administration service and User Administration client do not run on the same computer)

See “Parameters available for the User Administration tool” on page 92 for more information.

Example: Moving a user account to a different group

besuseradminclient -change -p password1 -u [email protected] -b server01 -group security

71

BlackBerry Enterprise Server Resource Kit User Guide

Find a user account on a BlackBerry Enterprise Server1. At the command prompt, switch to the folder in which BESUserAdminClient.exe resides.

2. Type besuseradminclient -find and the following parameters:

• -p <client_password>

• -u <user_name>

• -PIN <PIN> (use in conjunction with the -u parameter for the BlackBerry Enterprise Server for MDS Applications only)

• -sqluser <database_username> (if you use database authentication)

• -sqlpass <database_password> (if you use database authentication)

• -n <network_address of the User Administration service> (if the User Administration service and User Administration client do not run on the same computer)

See “Parameters available for the User Administration tool” on page 92 for more information.

Example: Finding a user account on the BlackBerry Enterprise Server

besuseradminclient -find -p password1 -u [email protected]

Change user account settingsThe BlackBerry Enterprise Server for MDS Applications does not support this task.

1. At the command prompt, switch to the folder in which BESUserAdminClient.exe resides.

2. Type besuseradminclient -change and the following parameters:

• -p <client_password>

• -u <user_name>

• -PIN <PIN>

• -b <BlackBerry_Enterprise_Server_service_name>

• -sqluser <database_username> (if you use database authentication)

• -sqlpass <database_password> (if you use database authentication)

• -n <network_address of the User Administration service> (if the User Administration service and User Administration client do not run on the same computer)

See “Parameters available for the User Administration tool” on page 92 for more information.

Example: Clearing the user account filters

besuseradminclient -change -p password1 -u [email protected] -b server01 -cf

72

8: User Administration tool

Example: Making the BlackBerry MDS Connection Service unavailable, changing the password, and specifying the password expiry time for the user account

besuseradminclient -change -p password1 -u [email protected] -b server01 -dm -w password3 -wt 96

Example: Specifying the activation password and activation password expiry time for a group of users

besuseradminclient -change -p password1 -g administrators -w password3 -wt 120

Add a user account to a software configuration1. At the command prompt, switch to the folder in which BESUserAdminClient.exe resides.

2. Type besuseradminclient -assign_swconfig -sw <configuration name> and the following parameters:

• -p <client_password>

• -u <user_name>

• -PIN <PIN> (use in conjunction with the -u parameter for the BlackBerry Enterprise Server for MDS Applications only)

• -b <BlackBerry_Enterprise_Server_service_name>

• -sqluser <database_username> (if you use database authentication)

• -sqlpass <database_password> (if you use database authentication)

• -n <network_address of the User Administration service> (if the User Administration service and User Administration client do not run on the same computer)

See “Parameters available for the User Administration tool” on page 92 for more information.

Example: Adding a user account to a software configuration

besuseradminclient -p password -u “Clyde Warren” -b server1 -assign_swconfig -sw games

Remove a user account from a software configuration1. At the command prompt, switch to the folder in which BESUserAdminClient.exe resides.

2. Type besuseradminclient -assign_swconfig -csw and the following parameters:

• -p <client_password>

• -u <user_name>

• -PIN <PIN> (use in conjunction with the -u parameter for the BlackBerry Enterprise Server for MDS Applications only)

• -b <BlackBerry_Enterprise_Server_service_name>

73

BlackBerry Enterprise Server Resource Kit User Guide

• -sqluser <database_username> (if you use database authentication)

• -sqlpass <database_username> (if you use database authentication)

• -n <network_address of the User Administration service> (if the User Administration service and User Administration client do not run on the same computer)

See “Parameters available for the User Administration tool” on page 92 for more information.

Example: Removing a user account from a software configuration

besuseradminclient -p password -u “Clyde Warren” -b server1 -assign_swconfig -csw

List the groups in a BlackBerry Domain1. At the command prompt, switch to the folder in which BESUserAdminClient.exe resides.

2. Type besuseradminclient -list -groups and the following parameters:

• -p <client_password>

• -sqluser <database_username> (if you use database authentication)

• -sqlpass <database_username> (if you use database authentication)

• -n <network_address of the User Administration service> (if the User Administration service and User Administration client do not run on the same computer)

See “Parameters available for the User Administration tool” on page 92 for more information.

Example: Listing the groups in a BlackBerry Domain

besuseradminclient -p password -list -groups

Managing BlackBerry devices

Set the BlackBerry device password1. At the command prompt, switch to the folder in which BESUserAdminClient.exe resides.

2. Type besuseradminclient -set_password <password> and the following parameters:

• -p <client_password>

• -u <user_name>

• -PIN <PIN> (use in conjunction with the -u parameter for the BlackBerry Enterprise Server for MDS Applications only)

• -b <BlackBerry_Enterprise_Server_service_name>

74

8: User Administration tool

• -sqluser <database_username> (if you use database authentication)

• -sqlpass <database_username> (if you use database authentication)

• -n <network_address of the User Administration service> (if the User Administration service and User Administration client do not run on the same computer)

See “Parameters available for the User Administration tool” on page 92 for more information.

Example: Setting the BlackBerry device password

besuseradminclient -set_password devicepassword1 -p password1 -u [email protected] -b server01

Set owner information on a BlackBerry deviceTo set the owner information that appears on the BlackBerry device, you can use a command to specify the information in quotes, or you can create an input file to contain the information and then use a command to specify the input file.

1. At the command prompt, switch to the folder in which BESUserAdminClient.exe resides.

2. Type besuseradminclient -set_owner_info <specify the owner information you want to set, or specify an input file that contains the information you want to set for the user account> and the following parameters:

• -p <client_password>

• -u <user_name>

• -PIN <PIN> (use in conjunction with the -u parameter for the BlackBerry Enterprise Server for MDS Applications only)

• -b <BlackBerry_Enterprise_Server_service_name>

• -sqluser <database_username> (if you use database authentication)

• -sqlpass <database_username> (if you use database authentication)

• -n <network_address of the User Administration service> (if the User Administration service and User Administration client do not run on the same computer)

See “Parameters available for the User Administration tool” on page 92 for more information.

Example: Setting owner information on a BlackBerry device

besuseradminclient -set_owner_info -info “Clyde Warren” -p password -u [email protected] -b server01

Example: Setting owner information on a BlackBerry device using an input file

besuseradminclient -set_owner_info -infofile userinformation.txt -p password -u [email protected] -b server01

75

BlackBerry Enterprise Server Resource Kit User Guide

Delete data from the BlackBerry device memory and make the BlackBerry device unavailable 1. At the command prompt, switch to the folder in which BESUserAdminClient.exe resides.

2. Type besuseradminclient -kill_handheld and the following parameters:

• -p <client_password>

• -u <user_name>

• -PIN <PIN> (use in conjunction with the -u parameter for the BlackBerry Enterprise Server for MDS Applications only)

• -b <BlackBerry_Enterprise_Server_service_name>

• -sqluser <database_username> (if you use database authentication)

• -sqlpass <database_username> (if you use database authentication)

• -n <network_address of the User Administration service> (if the User Administration service and User Administration client do not run on the same computer.

See “Parameters available for the User Administration tool” on page 92 for more information.

Example: Deleting data from the BlackBerry device memory and making the BlackBerry device unavailable

besuseradminclient -kill_handheld -p password1 -u [email protected] -b server01

Purge pending messagesThe BlackBerry Enterprise Server for MDS Applications does not support this task.

1. At the command prompt, switch to the folder in which BESUserAdminClient.exe resides.

2. Type besuseradminclient -change -purge_pending_messages and the following parameters:

• -p <client_password>

• -u <user_name>

• -b <BlackBerry_Enterprise_Server_service_name>

• -sqluser <database_username> (if you use database authentication)

• -sqlpass <database_username> (if you use database authentication)

• -n <network_address of the User Administration service> (if the User Administration service and User Administration client do not run on the same computer)

See “Parameters available for the User Administration tool” on page 92 for more information.

Example: Purging pending messages for a user account

besuseradminclient -change -purge_pending_messages -p password1 -u [email protected] -b server01

76

8: User Administration tool

Resend the peer-to-peer encryption key to the BlackBerry device1. At the command prompt, switch to the folder in which BESUserAdminClient.exe resides.

2. Type besuseradminclient -resend_peer_to_peer_key and the following parameters:

• -p <client_password>

• -u <user_name>

• -PIN <PIN> (use in conjunction with the -u parameter for the BlackBerry Enterprise Server for MDS Applications only)

• -b <BlackBerry_Enterprise_Server_service_name>

• -sqluser <database_username> (if you use database authentication)

• -sqlpass <database_username> (if you use database authentication)

• -n <network_address of the User Administration service> (if the User Administration service and User Administration client do not run on the same computer)

See “Parameters available for the User Administration tool” on page 92 for more information.

Example: Resending the peer-to-peer encryption key to the BlackBerry device for a user

besuseradminclient -resend_peer_to_peer_key -p password1 -u [email protected] -b server01

Resend a service book1. At the command prompt, switch to the folder in which BESUserAdminClient.exe resides.

2. Type besuseradminclient -resend_service_book and the following parameters:

• -p <client_password>

• -u <user_name>

• -PIN <PIN> (use in conjunction with the -u parameter for the BlackBerry Enterprise Server for MDS Applications only)

• -b <BlackBerry_Enterprise_Server_service_name>

• -sqluser <database_username> (if you use database authentication)

• -sqlpass <database_username> (if you use database authentication)

• -n <network_address of the User Administration service> (if the User Administration service and User Administration client do not run on the same computer)

See “Parameters available for the User Administration tool” on page 92 for more information.

Example: Resending a service book to the BlackBerry device

besuseradminclient -p password -u cwarren@<domain>.com -b server1 -resend_service_book

77

BlackBerry Enterprise Server Resource Kit User Guide

Obtain or clear user account statistics1. At the command prompt, switch to the folder in which BESUserAdminClient.exe resides.

2. Type besuseradminclient -stats and the following parameters:

• -p <client_password>

• -u <user_name>

• -PIN <PIN> (use in conjunction with the -u parameter for the BlackBerry Enterprise Server for MDS Applications only)

• -b <BlackBerry_Enterprise_Server_service_name>

• -sqluser <database_username> (if you use database authentication)

• -sqlpass <database_username> (if you use database authentication)

• -n <network_address of the User Administration service> (if the User Administration service and User Administration client do not run on the same computer)

See “Parameters available for the User Administration tool” on page 92 for more information.

Example: Obtaining statistics for a user account

besuseradminclient -p password1 -stats -u “clyde warren” -b server1

Example: Obtaining statistics for multiple user accounts

besuseradminclient -p password1 -stats -i userinfo.txt -o output.csv

Example: Obtaining statistics for all user accounts on a BlackBerry Enterprise Server

besuseradminclient -p password1 -stats -users -b server1 -o output.csv

Example: Obtaining statistics for all users in a group

besuseradminclient -p password1 -stats -users -g administrators -o output.csv

Interpreting the results of a statistics query for a user account

Column Description

User name name of the user

MailBoxDN mailbox of the user

Platform: This column does not apply to the BlackBerry Enterprise Server for MDS Applications.

78

8: User Administration tool

ServerDN canonical name of the BlackBerry Enterprise Server on which the BlackBerry device user account resides

Platform: This column does not apply to the BlackBerry Enterprise Server for MDS Applications.

PIN BlackBerry device PIN

Device Type BlackBerry device model number

State state of messages on the BlackBerry device (turned on or turned off)

Platform: This column does not apply to the BlackBerry Enterprise Server for MDS Applications.

Message Server messaging server on which the BlackBerry user account resides

Platform: This column does not apply to the BlackBerry Enterprise Server for MDS Applications.

Forwarded number of messages that the BlackBerry device forwarded

Platform: This column does not apply to the BlackBerry Enterprise Server for MDS Applications.

Sent number of messages and PIM items that the BlackBerry device sent

Platform: This column does not apply to the BlackBerry Enterprise Server for MDS Applications.

Pending number of messages and PIM items pending for the user account

Platform: This column does not apply to the BlackBerry Enterprise Server for MDS Applications.

Filtered number of messages and PIM items that the BlackBerry Enterprise Server filtered

Platform: This column does not apply to the BlackBerry Enterprise Server for MDS Applications.

Expired number of expired messages and PIM items

Platform: This column does not apply to the BlackBerry Enterprise Server for MDS Applications.

Status configuration status of the BlackBerry device

Last fwd time time when the user forwarded a message from the BlackBerry device

Platform: This column does not apply to the BlackBerry Enterprise Server for MDS Applications.

Last sent time last time that the user sent a message or PIM item from the BlackBerry device

Platform: This column does not apply to the BlackBerry Enterprise Server for MDS Applications.

Last contact time (h) time when the BlackBerry device was last in contact with the BlackBerry Enterprise Server

Last result result of the last BlackBerry device contact with the BlackBerry Enterprise Server

SMTP address SMTP email address of the user account

Platform: This column does not apply to the BlackBerry Enterprise Server for MDS Applications.

BlackBerry MDS Connection Service

whether the BlackBerry MDS Connection Service is available or unavailable

OTA Calendar whether wireless calendar synchronization is available or unavailable

Platform: This column does not apply to the BlackBerry Enterprise Server for MDS Applications.

ITPolicy name IT policy applied to the BlackBerry device

ITPolicy status status of the IT policy applied to the BlackBerry device

ITPolicy time applied time when the IT policy was applied to the BlackBerry device

ITPolicy time sent time when the BlackBerry Enterprise Server sent the IT policy to the BlackBerry device

ITPolicy time received time when the BlackBerry device received the IT policy

Wireless Message Reconciliation

whether wireless message reconciliation is available or unavailable on the BlackBerry device

Platform: This column does not apply to the BlackBerry Enterprise Server for MDS Applications.

Creation Time time that the BlackBerry device user account was created on the BlackBerry Enterprise Server

EA Password Expiry Time expiry time of the enterprise activation password if the password is set; otherwise,“N/A” appears

Column Description

79

BlackBerry Enterprise Server Resource Kit User Guide

Clear user account statistics1. At the command prompt, switch to the folder in which BESUserAdminClient.exe resides.

2. Type besuseradminclient -change -cs and the following parameters:

• -p <client_password>

• -u <user_name>

• -PIN <PIN> (use in conjunction with the -u parameter for the BlackBerry Enterprise Server for MDS Applications only)

• -b <BlackBerry_Enterprise_Server_service_name>

• -sqluser <database_username> (if you use database authentication)

• -sqlpass <database_username> (if you use database authentication)

• -n <network_address of the User Administration service> (if the User Administration service and User Administration client do not run on the same computer

See “Parameters available for the User Administration tool” on page 92 for more information.

Example: Clearing user account statistics

besuseradminclient -change -p password1 -u [email protected] -b server01 -cs

Sending notification messages to BlackBerry devices

Send a PIN message1. At the command prompt, switch to the folder in which BESUserAdminClient.exe resides.

2. Type besuseradminclient -send_pin <specify the PIN message subject line text and the PIN message body text that you want to set, or specify an input file that contains the information you want to set for the PIN message> with the following parameters:

• -p <client_password>

• -u <user_name> or -infofile <file_name>

• -PIN <PIN> (use in conjunction with the -u parameter for the BlackBerry Enterprise Server for MDS Applications only)

• -b <BlackBerry_Enterprise_Server_service_name>

Encryption Type encryption type set on the BlackBerry device

Service Name name of the BlackBerry Enterprise Server on which the user account resides

Group Name name of the group to which the user account belongs

Column Description

80

8: User Administration tool

• -subject <subject_line_text>

• -body <message_body_text>

• -sqluser <database_username> (if you use database authentication)

• -sqlpass <database_username> (if you use database authentication)

• -n <network_address of the User Administration service> (if the User Administration service and User Administration client do not run on the same computer)

See “Parameters available for the User Administration tool” on page 92 for more information.

Note: Using an input file overrides the -subject and -body parameters.

Example: Sending a PIN message

besuseradminclient -p password -u “Clyde Warren” -b server01 -send_pin -subject <subject_line_text> -body <message_body_text>

Example: Sending a PIN message using an input file

besuseradminclient -p password -u “Clyde Warren” -b server01 -send_pin -infofile userinformation.txt

Send an email messageThe BlackBerry Enterprise Server for MDS Applications does not support this task.

1. At the command prompt, switch to the folder in which BESUserAdminClient.exe resides.

2. Type besuseradminclient -send_email <specify the subject line text and the body text you want to set, or specify an input file that contains the information you want to set for the email message> and the following parameters:

• -p <client_password>

• -u <user_name> or -infofile <file_name>

• -b <BlackBerry_Enterprise_Server_service_name>

• -subject <subject_line_text>

• -body <message_body_text>

• -sqluser <database_username> (if you use database authentication)

• -sqlpass <database_username> (if you use database authentication)

• -n <network_address of the User Administration service> (if the User Administration service and User Administration client do not run on the same computer)

Using an input file overrides the -subject and -body parameters.

See “Parameters available for the User Administration tool” on page 92 for more information.

81

BlackBerry Enterprise Server Resource Kit User Guide

Example: Sending an email message

besuseradminclient -p password -u “Clyde Warren” -b server01 -send_email -subject <subject_line_text> -body

<message_body_text>

Example: Sending an email message using an input file

besuseradminclient -p password -u “Clyde Warren” -b server01 -send_email -infofile userinformation.txt

Managing email and folder redirection

Turn on email redirectionThe BlackBerry Enterprise Server for MDS Applications does not support this task.

1. At the command prompt, switch to the folder in which BESUserAdminClient.exe resides.

2. Type besuseradminclient -change -er and the following parameters:

• -p <client_password>

• -u <user_name>

• -b <BlackBerry_Enterprise_Server_service_name>

• -sqluser <database_username> (if you use database authentication)

• -sqlpass <database_username> (if you use database authentication)

• -n <network_address of the User Administration service> (if the User Administration service and User Administration client do not run on the same computer)

• -er

See “Parameters available for the User Administration tool” on page 92 for more information.

Example: Turning on email redirection for a user account

besuseradminclient -change -p password1 -u [email protected] -b server01 -er

Turn off email redirectionThe BlackBerry Enterprise Server for MDS Applications does not support this task.

1. At the command prompt, switch to the folder in which BESUserAdminClient.exe resides.

2. Type besuseradminclient -change -dr and the following parameters:

• -p <client_password>

82

8: User Administration tool

• -u <user_name>

• -b <BlackBerry_Enterprise_Server_service_name>

• -sqluser <database_username> (if you use database authentication)

• -sqlpass <database_username> (if you use database authentication)

• -n <network_address of the User Administration service> (if the User Administration service and User Administration client do not run on the same computer)

• -dr

See “Parameters available for the User Administration tool” on page 92 for more information.

Example: Turning off email redirection for a user account

besuseradminclient -change -p password1 -u [email protected] -b server01 -dr

List the folders available for redirectionThe BlackBerry Enterprise Server for MDS Applications does not support this task.

1. At the command prompt, switch to the folder in which BESUserAdminClient.exe resides.

2. Type besuseradminclient -list -folders and the following parameters:

• -p <client_password>

• -u <user_name>

• -b <BlackBerry_Enterprise_Server_service_name>

• -sqluser <database_username> (if you use database authentication)

• -sqlpass <database_username> (if you use database authentication)

• -n <network_address of the User Administration service> (if the User Administration service and User Administration client do not run on the same computer)

See “Parameters available for the User Administration tool” on page 92 for more information.

Example: Listing the folders available for redirection

besuseradminclient -p password -u clydewarren -b server01 -list -folders

Turn on folder redirectionThe BlackBerry Enterprise Server for MDS Applications does not support this task.

83

BlackBerry Enterprise Server Resource Kit User Guide

For the BlackBerry Enterprise Server for Microsoft Exchange, a folder name can contain a slash mark (/). To specify the folder, the slash mark must be preceded by the escape character backslash (\).

1. At the command prompt, switch to the folder in which BESUserAdminClient.exe resides.

2. Type besuseradminclient -set_folder_redirection -er and the following parameters:

• -p <client_password>

• -u <user_name>

• -b <BlackBerry_Enterprise_Server_service_name>

• -sqluser <database_username> (if you use database authentication)

• -sqlpass <database_username> (if you use database authentication)

• -n <network_address of the User Administration service> (if the User Administration service and User Administration client do not run on the same computer)

• -foldername <folder_name>

• -er

See “Parameters available for the User Administration tool” on page 92 for more information.

Example: Turning on folder redirection with a folder name that contains a slash mark

besuseradminclient -set_folder_redirection -p password1 -u [email protected] -b server01 -foldername Inbox/subfolder1/sub\/folder2 -er

Turn off folder redirectionThe BlackBerry Enterprise Server for MDS Applications does not support this task.

For the BlackBerry Enterprise Server for Microsoft Exchange, a folder name can contain a slash mark (/). To specify the folder, the slash mark must be preceded by the escape character backslash (\).

1. At the command prompt, switch to the folder in which BESUserAdminClient.exe resides.

2. Type besuseradminclient -set_folder_redirection -dr and the following parameters:

• -p <client_password>

• -u <user_name>

• -b <BlackBerry_Enterprise_Server_service_name>

• -sqluser <database_username> (if you use database authentication)

• -sqlpass <database_username> (if you use database authentication)

• -n <network_address of the User Administration service> (if the User Administration service and User Administration client do not run on the same computer)

• -foldername <folder_name>

84

8: User Administration tool

• -dr

See “Parameters available for the User Administration tool” on page 92 for more information.

Example: Turning off folder redirection

besuseradminclient -set_folder_redirection -p password1 -u [email protected] -b server01 -foldername Inbox -dr

Managing IT policies and IT policy rules

List the IT policy rules in the BlackBerry Configuration Database1. At the command prompt, switch to the folder in which BESUserAdminClient.exe resides.

2. Type besuseradminclient -list -it_policy_rules and the following parameters:

• -p <client_password>

• -u <user_name>

• -PIN <PIN> (use in conjunction with the -u parameter for the BlackBerry Enterprise Server for MDS Applications only)

• -b <BlackBerry_Enterprise_Server_service_name>

• -sqluser <database_username> (if you use database authentication)

• -sqlpass <database_username> (if you use database authentication)

• -n <network_address of the User Administration service> (if the User Administration service and User Administration client do not run on the same computer)

• -it_policy <policy_name>

See “Parameters available for the User Administration tool” on page 92 for more information.

Example: Listing the IT policy rules for an IT policy

besuseradminclient -p password1 -list -it_policy_rules -it_policy WLAN

Set IT policy rules for a user account1. At the command prompt, switch to the folder in which BESUserAdminClient.exe resides.

2. Type besuseradminclient -set_user_itpolicy_rule and the following parameters:

85

BlackBerry Enterprise Server Resource Kit User Guide

• -p <client_password>

• -u <user_name>

• -PIN <PIN> (use in conjunction with the -u parameter for the BlackBerry Enterprise Server for MDS Applications only)

• -b <BlackBerry_Enterprise_Server_service_name>

• -sqluser <database_username> (if you use database authentication)

• -sqlpass <database_username> (if you use database authentication)

• -n <network_address of the User Administration service> (if the User Administration service and User Administration client do not run on the same computer)

• -policyrule <rulename>

• -policyvalue <value>

See “Parameters available for the User Administration tool” on page 92 for more information.

Example: Setting IT policy rules for a user account

besuseradminclient -set_user_itpolicy_rule -p password1 -u [email protected] -b server01 -policyrule “VPN User Name” -policyvalue cwarren

List the IT policies in the BlackBerry Configuration Database1. At the command prompt, switch to the folder in which BESUserAdminClient.exe resides.

2. Type besuseradminclient -list -it_policies and the following parameters:

• -p <client_password>

• -u <user_name>

• -PIN <PIN> (use in conjunction with the -u parameter for the BlackBerry Enterprise Server for MDS Applications only)

• -b <BlackBerry_Enterprise_Server_service_name>

• -sqluser <database_username> (if you use database authentication)

• -sqlpass <database_username> (if you use database authentication)

• -n <network_address of the User Administration service> (if the User Administration service and User Administration client do not run on the same computer)

See “Parameters available for the User Administration tool” on page 92 for more information.

Example: Listing the IT policies in your environment

besuseradminclient -p password -list -it_policies

86

8: User Administration tool

Obtaining BlackBerry device information

List the applications that are available on one or more BlackBerry devices1. At the command prompt, switch to the folder in which BESUserAdminClient.exe resides.

2. Type -handheld_info -apps and the following parameters:

• -p <client_password>

• -u <user_name>

• -PIN <PIN> (use in conjunction with the -u parameter for the BlackBerry Enterprise Server for MDS Applications only)

• -b <BlackBerry_Enterprise_Server_service_name>

• -sqluser <database_username> (if you use database authentication)

• -sqlpass <database_username> (if you use database authentication)

• -n <network_address of the User Administration service> (if the User Administration service and User Administration client do not run on the same computer)

See “Parameters available for the User Administration tool” on page 92 for more information.

Example: Viewing the applications that are available on a BlackBerry device

besuseradminclient -p password1 -handheld_info -apps -u “clyde warren” -b server1

Example: Viewing the applications that are available on the BlackBerry device in verbose detail

besuseradminclient -p password1 -handheld_info -appsfull -u “clyde warren” -b server1

Example: Viewing the applications available for multiple BlackBerry devices using an input file

besuseradminclient -p password1 -handheld_info -apps -i users.txt

List the BlackBerry devices on which a specified application is installed1. At the command prompt, switch to the folder in which BESUserAdminClient.exe resides.

2. Type besuseradminclient -handheld_info - appname <application_name> and the following parameters:

• -p <client_password>

• -u <user_name>

87

BlackBerry Enterprise Server Resource Kit User Guide

• -PIN <PIN> (use in conjunction with the -u parameter for the BlackBerry Enterprise Server for MDS Applications only)

• -b <BlackBerry_Enterprise_Server_service_name>

• -sqluser <database_username> (if you use database authentication)

• -sqlpass <database_username> (if you use database authentication)

• -n <network_address of the User Administration service> (if the User Administration service and User Administration client do not run on the same computer)

See “Parameters available for the User Administration tool” on page 92 for more information.

Example: Listing the BlackBerry devices on which the specified application is installed

besuseradminclient -p password -handheld_info -appname sports_scores -o sportscores.txt

List the statistics for BlackBerry devices1. At the command prompt, switch to the folder in which BESUserAdminClient.exe resides.

2. Type besuseradminclient -handheld_info -hhstats and the following parameters:

• -p <client_password>

• -u <user_name>

• -PIN <PIN> (use in conjunction with the -u parameter for the BlackBerry Enterprise Server for MDS Applications only)

• -b <BlackBerry_Enterprise_Server_service_name>

• -sqluser <database_username> (if you use database authentication)

• -sqlpass <database_username> (if you use database authentication)

• -n <network_address of the User Administration service> (if the User Administration service and User Administration client do not run on the same computer)

See “Parameters available for the User Administration tool” on page 92 for more information.

Example: Viewing statistics for a user account

besuseradminclient -p password1 -handheld_info -hhstats -u “clyde warren” -b server1

Example: Viewing statistics for all user accounts in a group

besuseradminclient -p password1 -handheld_info -hhstats -users -b server1

88

8: User Administration tool

Interpreting the results of a statistics query for a BlackBerry device

List the modules and .cod files that are available on a BlackBerry device1. At the command prompt, switch to the folder in which BESUserAdminClient.exe resides.

2. Type besuseradminclient -handheld_info -modules and the following parameters:

• -p <client_password>

• -u <user_name>

• -PIN <PIN> (use in conjunction with the -u parameter for the BlackBerry Enterprise Server for MDS Applications only)

• -b <BlackBerry_Enterprise_Server_service_name>

• -sqluser <database_username> (if you use database authentication)

• -sqlpass <database_username> (if you use database authentication)

Column Description

User Name name of the user account

PIN PIN of the BlackBerry device

Service Name service name of the BlackBerry Enterprise Server

BlackBerry Device Model model of the BlackBerry device

Platform Version version of the platform that resides on the BlackBerry device

BlackBerry Version version of the applications that reside on the BlackBerry device

Phone Number phone number of the BlackBerry device

Serial Number International Mobile Equipment Identity (IMEI) number of the BlackBerry device

Active Carrier current wireless service provider to which the BlackBerry device is registered

Home Carrier the initial wireless service provider to which the BlackBerry device was assigned

Security Password whether the BlackBerry device password is set or not set

Network Type network type for the BlackBerry device; for example, GPRS or CDMA

Frequencies wireless frequencies that the BlackBerry device supports; for example, GSM® 900

Memory total flash memory size for the BlackBerry device

Direct Connect ID direct connect identification (DCID) for the BlackBerry device, if available

IT Policy Name name of the IT policy on the BlackBerry device

IT Policy Time time that the BlackBerry Enterprise Server last sent the IT policy to the BlackBerry device

Configuration Name name of the software configuration that is assigned to the BlackBerry device

Configuration Status overall status of the defined software configuration of the software that exists on the BlackBerry device

System Status status of the BlackBerry Device Software on the BlackBerry device with respect to the software configuration that the user defined

Application Status status of the third-party applications on the BlackBerry device

Available Space available space on the BlackBerry device

Battery Level current battery capacity level in percentage

Uptime time since the BlackBerry device was last reset

89

BlackBerry Enterprise Server Resource Kit User Guide

• -n <network_address of the User Administration service> (if the User Administration service and User Administration client do not run on the same computer)

See “Parameters available for the User Administration tool” on page 92 for more information.

Example: Viewing the modules and .cod files on a BlackBerry device

besuseradminclient -p password -handheld_info -modules -u “clyde warren” -b server1

Obtain BlackBerry Enterprise Server statistics1. At the command prompt, switch to the folder in which BESUserAdminClient.exe resides.

2. Type besuseradminclient -stats <specify the BlackBerry Enterprise Server to query, or specify an input file that contains the information for more than one BlackBerry Enterprise Server> and the following parameters:

• -p <client_password>

• -u <user_name>

• -PIN <PIN> (use in conjunction with the -u parameter for the BlackBerry Enterprise Server for MDS Applications only)

• -b <BlackBerry_Enterprise_Server_service_name>

• -sqluser <database_username> (if you use database authentication)

• -sqlpass <database_username> (if you use database authentication)

• -n <network_address of the User Administration service> (if the User Administration service and User Administration client do not run on the same computer)

See “Parameters available for the User Administration tool” on page 92 for more information.

Example: Obtaining statistics for a BlackBerry Enterprise Server

besuseradminclient -p password1 -stats -b server01

Example: Obtaining statistics for multiple BlackBerry Enterprise Servers

besuseradminclient -p password1 -stats -servers -i serverfile.txt -o output.csv

Example: Obtaining statistics for all BlackBerry Enterprise Servers

besuseradminclient -p password1 -stats -servers

90

8: User Administration tool

Interpreting the results of a statistics query for a BlackBerry Enterprise Server

Display the status of the User Administration service1. At the command prompt, switch to the folder in which BESUserAdminClient.exe resides.

2. Type besuseradminclient -status and the following parameter:

• -p <client_password>

See “Parameters available for the User Administration tool” on page 92 for more information.

Example: Checking the status of the User Administration service

besuseradminclient -p password -status

Column Description

Server Name name of the BlackBerry Enterprise Server

Server Status status of the BlackBerry Enterprise Server

SRP Status status of the BlackBerry Enterprise Server SRP information

# Users number of user accounts on the BlackBerry Enterprise Server

Forwarded number of messages that the BlackBerry Enterprise Server forwarded

Platform: This column does not apply to the BlackBerry Enterprise Server for MDS Applications.

Sent number of messages and PIM items that the BlackBerry Enterprise Server sent

Platform: This column does not apply to the BlackBerry Enterprise Server for MDS Applications.

Pending number of messages and PIM items pending on the BlackBerry Enterprise Server

Platform: This column does not apply to the BlackBerry Enterprise Server for MDS Applications.

Filtered number of messages and PIM items that the BlackBerry Enterprise Server filtered

Platform: This column does not apply to the BlackBerry Enterprise Server for MDS Applications.

Expired number of expired messages and PIM items that the BlackBerry Enterprise Server processed

Platform: This column does not apply to the BlackBerry Enterprise Server for MDS Applications.

BlackBerry MDS Connection Service whether the BlackBerry MDS Connection Service is available or unavailable

PID BlackBerry Dispatcher process ID

Platform platform on which the BlackBerry Enteprise Server runs

Server Version version of the BlackBerry Enterprise Server

91

BlackBerry Enterprise Server Resource Kit User Guide

Parameters available for the User Administration toolParameter Description Use with

-? displays help information for the tool all

2> <filename.txt> redirects text that displays on the screen to the specified text file all

-addrsub <address_book_name>

specifies the address book of a user

Platform: Use this parameter with the BlackBerry Enterprise Server for Novell GroupWise only.

-add, -change

-appname specifies the application name to display -handheld_info

-appsfull lists the applications in verbose detail for a user account -handheld_info

-b

<BlackBerry_Enterprise _Server_service_name>

specifies the BlackBerry Enterprise Server service name on which to perform the action

Note: The service name appears in the BlackBerry Manager, on the Servers tab, in the Service Name column.

all, except -find

-cf clears the user filters

Platform: Use this parameter with the BlackBerry Enterprise Server for Microsoft Exchange, the BlackBerry Enterprise Server for IBM Lotus Domino, and the BlackBerry Enterprise Server for Novell GroupWise only.

-change

-cgroup removes the specified user account from the group -change, -group

-cpin clears the PIN for the user account from the BlackBerry Enterprise Server

Platform: Use this parameter with the BlackBerry Enterprise Server for Microsoft Exchange, the BlackBerry Enterprise Server for Novell GroupWise, and the BlackBerry Enterprise Server for MDS Applications only.

-change

-cs clears the account statistics of an existing user account

Note: By default, when you add a user account, the User Administration tool reads the existing statistics for the user account.

-add, -change

-csw specifies the name of the software configuration from which you want to remove the user account

-assign_swconfig

-dm makes the BlackBerry MDS Connection Service unavailable -change

-dr turns off message and folder redirection

Platform: Use this parameter with the BlackBerry Enterprise Server for Microsoft Exchange, the BlackBerry Enterprise Server for IBM Lotus Domino, and the BlackBerry Enterprise Server for Novell GroupWise only.

-change, -set_folder_redirection

-em makes the BlackBerry MDS Connection Service available -change

-er turns on message and folder redirection

Platform: Use this parameter with the BlackBerry Enterprise Server for Microsoft Exchange, the BlackBerry Enterprise Server for IBM Lotus Domino, and the BlackBerry Enterprise Server for Novell GroupWise only.

-change, -set_folder_redirection

92

8: User Administration tool

-f removes all user account information -delete

-foldername <folder_name> specifies the name of the folder on which to perform the action -set_folder_redirection

-folders lists the folder name and redirection states

Platform: Use this parameter with the BlackBerry Enterprise Server for Microsoft Exchange, the BlackBerry Enterprise Server for IBM Lotus Domino, and the BlackBerry Enterprise Server for Novell GroupWise only.

-list

-g <group_name> specifies the name of the group on which to perform the action

Note: This parameter overrides the -u and -b parameters.

-assign_swconfig; -change; -send_email; -send_pin; -stats

-group <group_name> specifies the name of the group in which to add a new user account (-add) or to add an existing user account (-change)

-add, -change

-groups lists the groups in the BlackBerry Domain -list

-hard removes a user account, even if the tool does not find the mailbox

Platform: Use this parameter with the BlackBerry Enterprise Server for Microsoft Exchange only.

-delete

-help <command> displays help information for a specific User Administration client command

all

-hhstats displays BlackBerry device statistics -hhstats

-i <filename.txt> specifies the name of the new-line delimited input file

Notes: This parameter overrides the -u, -b, -pin, it_policy, and -w parameters.

Use this parameter with -set_owner_info and -resend_peer_to_peer_key to set the information for multiple users at the same time.

-add; use the following format: <user name>, <BlackBerryEnterpriseServerservicename>,[<PIN>[,<password>[,<ITpolicy>, [<groupname>]]]]

-delete; use the following format:

<username>, <BlackBerryEnterpriseServerservicename>

-move; use the following format:

<username>, <source BlackBerryEnterpriseServerservicename>,<targetBlackBerryEnterpriseServerservicename>[,<PIN>]

-set_owner_info; use the following format:

<username>, <BlackBerryEnterpriseServerservicename>[,<name>[,<info>[,<infofile>]]]

-resend_peer_to_peer_key; use the following format:

<username>, <BlackBerryEnterpriseServerservicename>

-hhstats; -apps; -send_email; -send_pin; -resend_service_book; -assign_swconfig; -stats

-info <info> specifies the owner information for a BlackBerry device -set_owner_info

Parameter Description Use with

93

BlackBerry Enterprise Server Resource Kit User Guide

-infofile <infofile.txt> specifies the name of the file that contains the owner information; enables you to insert line breaks in the owner information

Note: This parameter overrides the -subject and -body parameters.

-set_owner_info;

-send_ email and -send_pin; use the following format:

Subject= <value>

Body= <value>

-it_policies <policy_name> specifies which IT policies in the BlackBerry Configuration Database to display

-list

-it_policy <policy_name> specifies the name of the IT policy to apply to the user account

Note: A lists of valid IT policies is available in the BlackBerry Manager. You can also obtain the list if you run the User Administration client with the -list it_policies option.

-add; -change; -it_policy_rules; -list

-it_policy_rules lists the IT policy rules for a particular IT policy -list

-modules specifies the module or .cod file to display -handheld_info

-n <network_address> specifies the network address (IP address or computer host name) of the computer on which the User Administration service runs

Note: Use this option only if the User Administration client and the User Administration service do not run on the same computer.

all

-name <name> specifies the user name to appear on the BlackBerry device -set_owner_info

-o <outputfilename> specifies the file in which to save output information all

-p <clientpassword> specifies the client password that the User Administration client should use to authenticate with the User Administration service

Note: The User Administration service prompts you to create and type the client password during the installation process.

all

-pin <PIN> specifies the BlackBerry device PIN of the user -add

-pimaddr <servername>!!<datapath>

specifies the BlackBerry Enterprise Server name and the relative path to the IBM Lotus Notes Data folder for storing the PIM address book when you add a user account

Platform: Use this parameter with the BlackBerry Enterprise Server for IBM Lotus Domino only.

-add, -change

-pimmemo <servername>!!<datapath>

specifies the BlackBerry Enterprise Server name and the relative path to the IBM Lotus Notes Data folder for storing the memo database when you add a user account.

Platform: Use this parameter with the BlackBerry Enteprise Server for IBM Lotus Domino only.

-add, -change

-policy_rule <policy_rule_name>

specifies the IT policy rule name in the IT policy -set_user_itpolicy_rule

-policy_value <value> specifies the value for the specified IT policy rule -set_user_itpolicy_rule

-purge_pending_messages specifies the user account on which to purge pending messages

Platform: Use this parameter with the BlackBerry Enterprise Server for Microsoft Exchange, the BlackBerry Enterprise Server for IBM Lotus Domino, and the BlackBerry Enterprise Server for Novell GroupWise only.

-change

-servers specifies all BlackBerry Enterprise Servers -stats

Parameter Description Use with

94

8: User Administration tool

-sqluser <database_user_name>

specifies the database login account for SQL authentication or IBM DB2 UDB authentication

Note: For role-based administration, you must use this parameter if you use database authentication to connect to the BlackBerry Configuration Database.

all

-sqlpass <database_password>

specifies the database password

Note: For role-based administration, you must use this parameter if you use database authentication to connect to the BlackBerry Configuration Database.

all

-sw <configuration_name> specifies the name of the software configuration to which you want to add the user account

-assign_swconfig

-t <target_BlackBerry_Enterprise_Server_service_name>

specifies the BlackBerry Enterprise Server service name to which you want to move the user

-move

-u <user_name> specifies the user account on which to perform the action

• Microsoft Exchange: mailbox name; for example, [email protected]

• IBM Lotus Domino: canonical name; for example, “CN=Clyde Warren/O=Server01”

• Novell GroupWise: User ID, for example; clydewarren

• BlackBerry MDS Applications: PIN of the BlackBerry device

-add; -change; -delete; -move; -find; -list -folders; -set_password; -set_owner_info; -kill_handheld; -resend_peer_to_peer_key; -resend_service_book; -assign_swconfig; -send_email; -send_pin; -purge_pending_messages; -set_folder_redirection; -set_user_itpolicy_rule -handheld_info

-users specifies all user accounts on which to perform the action -hhstats

-users -b <BlackBerry_Enterprise_Server_service_name>

specifies all user accounts on the specified BlackBerry Enterprise Server -stats

-users -g <group_name> specifies all user accounts in the specified group -stats

-v provides detailed feedback about the steps for the performed action; also provides the role assigned to the user account for which you are logged in to the User Administration client when you are using the User Administration tool

Note: By default, the parameter is terse, which provides error and completion messages.

all

-w <password> specifies the password for wireless activation -add; -change; -w

-wt <password_expiry_time>

specifies a password expiration time, in hours (between 1 and 720)

Note: The default expiration time is 48 hours. Use this parameter with the -w parameter.

-add; -change

Parameter Description Use with

95

BlackBerry Enterprise Server Resource Kit User Guide

96

9

Upgrading and removing the BlackBerry Enterprise Server Resource Kit

Upgrading the BlackBerry Enterprise Server Resource Kit tools> On the computer on which the BlackBerry Enterprise Server Resource Kit tools are running, download and

extract the new version of the BlackBerry Enterprise Server Resource Kit.

Upgrade the BlackBerry Syslog tool1. Stop the BlackBerry Syslog Service.

2. Replace BESSysLog.exe and BESSysLogConfig.exe with the new versions.

3. To upgrade the events that the BlackBerry Syslog service uses, browse to HKEY_LOCAL_MACHINE\SOFTWARE\Research In Motion\BlackBerry Syslog Server\Events.

4. Rename the Events registry key to Events.save.

5. In the Microsoft Windows Services window, start the BlackBerry Syslog Service.

Note: When you start the BlackBerry SysLog Service, it installs the new events.

Upgrade the log analysis tools> Overwrite the previous versions of the following BlackBerry Enterprise Resource Kit log analysis files:

• Messageflow.exe

• NoResponseCheck.exe

• DelayedNotifications.exe

• OutOfCoverage.exe

• Pending.exe

• LogMonitor.exe

• MapiCdoErrors.exe

• AvailIndex.exe

Upgrading the BlackBerry Enterprise Server Resource Kit toolsRemoving the BlackBerry Enterprise Server Resource Kit tools

BlackBerry Enterprise Server Resource Kit User Guide

• HistoricalStats.exe

• MDSPushvsPull.exe

Upgrade the User Administration toolIf you use an IBM DB2 UDB, you must remove the User Administration tool and install the new version. See “Remove the Upgrade IT Policy Template tool” on page 100 for more information about removing the User Administration tool.

1. Stop the BlackBerry User Administration Service.

2. On the computers on which the User Administration service and User Administration client components reside, replace the following files:

• BESUserAdminService.exe

• BESUserAdminClient.exe

• CE.dll

• ClientAuthentication8.dll

• ServerAuthentication8.dll

• BESUserAdminX.dll (Microsoft Exchange environments only)

• BESUserAdminD.dll (IBM Lotus Domino environments only)

• BESUserAdminG.dll (Novell GroupWise environments only)

• BESUserAdminAudit.dll

3. In the Microsoft Windows Services window, start the BlackBerry User Administration Service.

Removing the BlackBerry Enterprise Server Resource Kit tools

Remove the BlackBerry Domain Administration History tool> Remove AdminHistory.exe from the computer on which the BlackBerry Domain Administration History tool

resides.

98

9: Upgrading and removing the BlackBerry Enterprise Server Resource Kit

Remove the BlackBerry Syslog tool1. Stop the BlackBerry Syslog service.

2. At the command prompt, switch to the folder in which BESSysLog.exe resides.

3. Type bessyslog -remove. This command removes the service only from the computer.

4. Remove BESSysLog.exe and BESSysLogConfig.exe.

5. In the Registry Editor, browse to HKEY_LOCAL_MACHINE > Software > Research In Motion\.

6. Remove the BlackBerry Syslog Server key and subkeys.

Remove the log analysis files> Remove the following log analysis files from the computer on which they reside:

• Messageflow.exe

• NoResponseCheck.exe

• DelayedNotifications.exe

• OutOfCoverage.exe

• Pending.exe

• LogMonitor.exe

• MapiCdoErrors.exe

• AvailIndex.exe

• HistoricalStats.exe

• MDSPushvsPull.exe

Remove the Log Monitor tool> On the computer on which the Log Monitor tool resides, remove LogMonitor.exe.

Remove the Message Receipt Confirmation tool1. Stop the Message Receipt Confirmation service.

2. At the command prompt, switch to the folder in which MessageConfirmService.exe, MessageConfirmConfig.exe, and the associated .dll files reside.

3. Type messageconfirmservice -remove. This command removes the service only from the computer.

4. Remove MessageConfirmService.exe and MessageConfirmConfig.exe, and the associated .dll files.

99

BlackBerry Enterprise Server Resource Kit User Guide

Remove the Upgrade IT Policy Template tool> Remove UpgradeITPolicyTemplate.exe from the computer on which the Upgrade IT Policy Template tool

resides.

Remove the User Administration tool1. Stop the BlackBerry User Administration Service.

2. At the command prompt, switch to the folder in which BESUserAdminService.exe and the associated .dll files reside.

3. Type besuseradminservice -remove. This command removes the service only from the computer.

4. On the computer on which the User Administration service files reside, remove the following files:

• BESUserAdminService.exe

• CE.dll

• ClientAuthentication8.dll

• ServerAuthentication8.dll

• BESUserAdminX.dll (Microsoft Exchange environments only)

• BESUserAdminD.dll (IBM Lotus Domino environments only)

• BESUserAdminG.dll (Novell GroupWise environments only)

• BESUserAdminAudit.dll

5. In the Registry Editor, browse to HKEY_CURRENT_USER > Software > Research In Motion > BlackBerry Enterprise Server.

6. Remove the Admin key and subkeys.

7. On the computer on which the User Administration client component resides, remove BESUserAdminClient.exe and CE.dll.

100

A

Appendix A: Error codes for the User Administration tool

Error code Error message Description of error message Platform

-2 Service busy adding The User Administration tool is busy adding user accounts. Microsoft Exchange

-3 Service busy deleting The User Administration tool is busy removing user accounts.

Microsoft Exchange

-4 Service busy initializing The User Administration service is busy starting. Microsoft Exchange

-5 No profile for server The MAPI profile for the specified BlackBerry Enterprise Server does not exist.

Microsoft Exchange

-6 Problem retrieving ServerDN The User Administration tool could not retrieve the distinguished name of the messaging server.

Microsoft Exchange

-7 MAPILOGON failed The User Administration service could not log into the MAPI subsystem.

Microsoft Exchange

-8 GETMSGSTORESTABLE failed The User Administration tool could not retrieve the message stores table.

Microsoft Exchange

-9 HRQUERYALLROWS failed The User Administration tool could not query all message stores.

Microsoft Exchange

-10 OPENMSGSTORE failed The User Administration tool could not open the message store.

Microsoft Exchange

-11 No default MSGSTORE found The User Administration tool could not find the message store.

Microsoft Exchange

-12 QUERYINTERFACE failed The User Administration tool could not query the message store.

Microsoft Exchange

-13 CREATEPMDATABASE failed The User Administration tool could not retrieve settings for the user account.

Microsoft Exchange

-14 Open server database failed The User Administration tool could not open the BlackBerry Configuration Database.

Microsoft Exchange

-15 Open address book failed The User Administration tool could not open the Global Address Book.

Microsoft Exchange

-16 MAPIALLOCATERBUFFER failed A problem occurred in the MAPI subsystem. Microsoft Exchange

-17 Open server manager failed The User Administration tool failed to open the server manager.

All

-18 Initialize failed The User Administration service could not start successfully. All

-19 Get user info failed The User Administration tool could not find the user account in the address book.

All

-20 User exists The user account already exists on the BlackBerry Enterprise Server.

All

-21 User does not exist The user account does not exist on the BlackBerry Enterprise Server.

All

BlackBerry Enterprise Server Resource Kit User Guide

-22 Get user list failed The User Administration tool could not retrieve the user accounts from the BlackBerry Enterprise Server.

Microsoft Exchange

-23 User exists on another server The user account exists on another BlackBerry Enterprise Server.

All

-24 Service busy listing The User Administration tool is busy listing information. All

-25 Server does not exist The specified BlackBerry Enterprise Server does not exist. All

-26 No session ID A valid session was not found. All

-27 Service busy The User Administration service is busy and cannot respond to the request from the User Administration client.

All

-28 License count exceeded The User Administration tool could not add the user account. The license count for the BlackBerry Enterprise Server has been exceeded.

All

-30 Ambiguous mailbox name The User Administration tool could not retrieve information for the specified user account; multiple user accounts were returned.

Microsoft Exchange

-31 MGMT_DATABASE not found The User Administration service could not connect to the BlackBerry Configuration Database.

All

-32 License key not found The User Administration tool could not retrieve the license key from the BlackBerry Configuration Database.

All

-33 User license exceeded The user license count for the BlackBerry Enterprise Server has been exceeded.

All

-34 MDS license exceeded The license count for the BlackBerry MDS Connection Service has been exceeded.

All

-35 User and MDS license exceeded The license count for the BlackBerry Enterprise Server and BlackBerry MDS Connection Service has been exceeded.

All

-36 User does not exist on server The user account does not exist on the specified BlackBerry Enterprise Server.

All

-37 Invalid password The specified password is incorrect. All

-38 Server names match The source BlackBerry Enterprise Server and destination BlackBerry Enterprise Server are the same.

All

-39 REMOVEPAGER failed The User Administration tool could not remove the user account from the BlackBerry Enterprise Server.

All

-40 Database update failed The User Administration tool could not update the BlackBerry Configuration Database.

All

-42 Load server failed The User Administration tool could not load information for the specified BlackBerry Enterprise Server.

All

-43 Cannot get peer to peer key The User Administration tool could not retrieve the peer-to-peer encryption key.

All

-44 ITPolicy does not exist The specified IT policy does not exist in the BlackBerry Domain.

All

-45 Failed to set OTA password in database

The User Administration tool could not set the enterprise activation password.

All

-46 No results found The User Administration tool could not find the user account when it performed a -find user task.

All

Error code Error message Description of error message Platform

102

Appendix A: Error codes for the User Administration tool

-47 Load user failed The User Administration tool could not load information for the specified user account.

All

-48 Could not open pager info The User Administration tool could not load information for the user account.

Microsoft Exchange

-49 An error occurred when setting the ITPolicy

A problem occurred while the User Administration tool was attempting to assign an IT policy to the user account.

All

-50 Clear PIN not supported An attempt to clear a user account PIN was unsuccessful because the clear PIN task is not supported.

IBM Lotus Domino

-51 Load IT policies failed The User Administration tool could not load the IT policies list.

All

-52 Invalid SQL authentication parameters

Authentication with the BlackBerry Configuration Database using SQL authentication is unsuccessful.

Verify that the correct parameters are specified for the -sqluser or -sqlpass parameters.

All

-53 Insufficient permissions The current user role does not have permission to perform the action.

All

-54 Client database connect failed The client could not authenticate with the BlackBerry Configuration Database.

All

-55 Unable to determine client role The role of the client user could not be determined. All

-56 Unable to determine client user The user account of the client could not be determined. All

-57 Client is not logged in The client could not be authenticated. All

-58 Service database connect failed The User Administration service could not establish a connection with the BlackBerry Configuration Database.

All

-59 Cannot establish a secure connection A secure connection between the client and server could not be established.

All

-60 Group does not exist The specified group does not exist on the BlackBerry Enterprise Server

All

-61 Server could not create session id The session could not be created. All

-62 Group-based management not supported

An attempt to use group-based management features was unsuccessful because group-based management features are not supported.

All

-63 System request error A system request error occurred. All

-64 Client is not using service account The client is not logged in using the same user account as the User Administration service account.

All

-65 Client verification failed An error occurred when trying to authenticate the client. All

-66 Software configuration does not exist The specified software configuration does not exist. All

-67 Error assigning software configuration An error occurred while attempting to assign the software configuration to the user account.

All

-68 PIM location change not supported An error occurred while attempting to set the PIM address book location.

Microsoft Exchange

Novell GroupWise

-69 PIM address book location change failed

An error occurred while attempting to change a user’s PIM address book location.

IBM Lotus Domino

-70 PIM memo location change failed An error occurred while attempting to change the user’s PIM memo location.

IBM Lotus Domino

Error code Error message Description of error message Platform

103

BlackBerry Enterprise Server Resource Kit User Guide

-71 Submit message failed An error occurred while attempting to send a message to a user account.

Microsoft Exchange

IBM Lotus Domino

Novell GroupWise

-72 User does not have a valid PIN The user account does not have a valid user account PIN. All

-73 Submit message failed for all users An error occurred while attempting to send a message to multiple user accounts.

Microsoft Exchange

IBM Lotus Domino

Novell GroupWise

-74 Set address book subscribed change failed

An error occurred while attempting to change the PIM address book subscription setting.

Novell GroupWise

-75 Set address book subscribed change not supported

An attempt to change the PIM address book subscription setting was unsuccessful because the task is not supported.

Microsoft Exchange

IBM Lotus Domino

-76 Purge pending messages failed An error occurred while attempting to purge a pending message for a user account.

Microsoft Exchange

IBM Lotus Domino

Novell GroupWise

-77 Purge pending messages failed for all users

An error occurred while attempting to purge a pending message for a group.

Microsoft Exchange

IBM Lotus Domino

Novell GroupWise

-78 The task is not supported by the BlackBerry Enterprise Server for MDS Applications

The specified task is not supported by the BlackBerry Enterprise Server for MDS Applications.

MDS Applications

-79 User PIN required The user’s PIN is required for the specified task. MDS Applications

-80 Message redirection not supported Message redirection is not supported by the BlackBerry Enterprise Server for MDS Applications.

MDS Applications

-81 Purge pending messages not supported

Purging pending messages is not supported by the BlackBerry Enterprise Server for MDS Applications.

MDS Applications

-82 Clear filters not supported Clearing filters is not supported by the BlackBerry Enterprise Server for MDS Applications.

MDS Applications

-83 Send email message not supported Sending email messages is not supported by the BlackBerry Enterprise Server for MDS Applications.

MDS Applications

-84 Hard delete not supported Hard deletion is not supported by the BlackBerry Enterprise Server for MDS Applications.

MDS Applications

-85 Full erase not supported. Full deletion of mailstore information is not supported by the BlackBerry Enterprise Server for MDS Applications.

MDS Applications

-86 Folder not found An attempt to locate a folder failed. Microsoft Exchange

IBM Lotus Domino

Novell GroupWise

-87 Initialization of Notes session failed An attempt to start a Notes session failed. IBM Lotus Domino

-88 Set folder redirection failed An attempt to set the folder redirection state failed. Microsoft Exchange

IBM Lotus Domino

Novell GroupWise

Error code Error message Description of error message Platform

104

Appendix A: Error codes for the User Administration tool

-89 Folder synchronization information not found in the BlackBerry Configuration Database.

An attempt to locate folder synchronization information in the BlackBerry Configuration Database failed.

Microsoft Exchange

IBM Lotus Domino

Novell GroupWise

-90 Invalid PIN specified An invalid PIN was specified. All

-91 IT policy rule not found An attempt to locate an IT policy was unsuccessful. All

-92 IT policy specified is not a per-user IT policy

The specified IT policy is not a per-user IT policy. All

-93 Setting per-user IT policy for a user account failed

An error occurred while attempting to set a per-user IT policy rule for a user account.

All

-94 Set folder redirection not supported Setting folder redirection is not supported by the BlackBerry Enterprise Server for MDS Applications.

MDS Applications

-95 Display folders not supported Listing folders is not supported by the BlackBerry Enterprise Server for MDS Applications.

MDS Applications

-96 Failed to receive User Admin service status

An attempt to retrieve status information from the User Administration service failed.

All

-97 A user with the specified PIN already exists

An attempt to add a BlackBerry device to a user account that already exists on the BlackBerry Enterprise Server

All

Error code Error message Description of error message Platform

105

BlackBerry Enterprise Server Resource Kit User Guide

106

©2007 Research In Motion Limited

Published in Canada.