You are on page 1of 66

BlackBerry Enterprise Server Resource Kit

Version 4.1 Service Pack 5


User Guide for the BlackBerry Enterprise Server User
Administration Tool

BlackBerry Enterprise Server Resource Kit version 4.1 Service Pack 5 User Guide for the BlackBerry Enterprise Server User Administration Tool
Last modified: 15 February 2008
Part number: 15136533 version 10
At the time of publication, this documentation is based on BlackBerry Enterprise Server version 4.1 Service Pack 5.
Send us your comments on product documentation: https://www.blackberry.com/DocsFeedback.
2008 Research In Motion Limited. All rights reserved. BlackBerry, RIM, Research In Motion, SureType and related trademarks, names,
and logos are the property of Research In Motion Limited and are registered and/or used as trademarks in the U.S., Canada, and countries
around the world.
IBM, Domino, DB2, DB2 Universal Database, Lotus, and Lotus Notes are trademarks of International Business Machines Corporation. GSM and
Global System for Mobile Communication are trademarks of the GSM MOU Association. Microsoft, Windows, and SQL Server are trademarks of
Microsoft Corporation. Novell and GroupWise are trademarks of Novell, Inc. All other trademarks are the properties of their respective owners.
The BlackBerry smartphone and other devices 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 the U.S. and in various countries around the world. Visit www.rim.com/patents for a list of
RIM (as hereinafter defined) patents.
This documentation including all documentation incorporated by reference herein such as documentation provided or made available at
www.blackberry.com/go/docs is provided or made accessible "AS IS" and "AS AVAILABLE" and without condition, endorsement, guarantee,
representation, or warranty of any kind by Research In Motion Limited and its affiliated companies ("RIM") and RIM assumes no responsibility
for any typographical, technical, or other inaccuracies, errors, or omissions in this documentation. In order to protect RIM proprietary and
confidential information and/or trade secrets, this documentation may describe some aspects of RIM technology in generalized terms. RIM
reserves the right to periodically change information that is contained in this documentation; however, RIM makes no commitment to provide
any such changes, updates, enhancements, or other additions to this documentation to you in a timely manner or at all.
This documentation might contain references to third-party sources of information, hardware or software, products or services including
components and content such as content protected by copyright and/or third-party web sites (collectively the "Third Party Products and
Services"). RIM does not control, and is not responsible for, any Third Party Products and Services including, without limitation the content,
accuracy, copyright compliance, compatibility, performance, trustworthiness, legality, decency, links, or any other aspect of Third Party Products
and Services. The inclusion of a reference to Third Party Products and Services in this documentation does not imply endorsement by RIM of
the Third Party Products and Services or the third party in any way.
EXCEPT TO THE EXTENT SPECIFICALLY PROHIBITED BY APPLICABLE LAW IN YOUR JURISDICTION, ALL CONDITIONS, ENDORSEMENTS,
GUARANTEES, REPRESENTATIONS, OR WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION, ANY
CONDITIONS, ENDORSEMENTS, GUARANTEES, REPRESENTATIONS OR WARRANTIES OF DURABILITY, FITNESS FOR A PARTICULAR
PURPOSE OR USE, MERCHANTABILITY, MERCHANTABLE QUALITY, NON-INFRINGEMENT, SATISFACTORY QUALITY, OR TITLE, OR ARISING
FROM A STATUTE OR CUSTOM OR A COURSE OF DEALING OR USAGE OF TRADE, OR RELATED TO THE DOCUMENTATION OR ITS USE,
OR PERFORMANCE OR NON-PERFORMANCE OF ANY SOFTWARE, HARDWARE, SERVICE, OR ANY THIRD PARTY PRODUCTS AND
SERVICES REFERENCED HEREIN, ARE HEREBY EXCLUDED. YOU MAY ALSO HAVE OTHER RIGHTS THAT VARY BY STATE OR PROVINCE.
SOME JURISDICTIONS MAY NOT ALLOW THE EXCLUSION OR LIMITATION OF IMPLIED WARRANTIES AND CONDITIONS. TO THE EXTENT
PERMITTED BY LAW, ANY IMPLIED WARRANTIES OR CONDITIONS RELATING TO THE DOCUMENTATION TO THE EXTENT THEY CANNOT
BE EXCLUDED AS SET OUT ABOVE, BUT CAN BE LIMITED, ARE HEREBY LIMITED TO NINETY (90) DAYS FROM THE DATE YOU FIRST
ACQUIRED THE DOCUMENTATION OR THE ITEM THAT IS THE SUBJECT OF THE CLAIM.
TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW IN YOUR JURISDICTION, IN NO EVENT SHALL RIM BE LIABLE FOR ANY TYPE
OF DAMAGES RELATED TO THIS DOCUMENTATION OR ITS USE, OR PERFORMANCE OR NON-PERFORMANCE OF ANY SOFTWARE,

HARDWARE, SERVICE, OR ANY THIRD PARTY PRODUCTS AND SERVICES REFERENCED HEREIN INCLUDING WITHOUT LIMITATION ANY
OF THE FOLLOWING DAMAGES: DIRECT, CONSEQUENTIAL, EXEMPLARY, INCIDENTAL, INDIRECT, SPECIAL, PUNITIVE, OR AGGRAVATED
DAMAGES, DAMAGES FOR LOSS OF PROFITS OR REVENUES, FAILURE TO REALIZE ANY EXPECTED SAVINGS, BUSINESS INTERRUPTION,
LOSS OF BUSINESS INFORMATION, LOSS OF BUSINESS OPPORTUNITY, OR CORRUPTION OR LOSS OF DATA, FAILURES TO TRANSMIT OR
RECEIVE ANY DATA, PROBLEMS ASSOCIATED WITH ANY APPLICATIONS USED IN CONJUNCTION WITH RIM PRODUCTS OR SERVICES,
DOWNTIME COSTS, LOSS OF THE USE OF RIM PRODUCTS OR SERVICES OR ANY PORTION THEREOF OR OF ANY AIRTIME SERVICES,
COST OF SUBSTITUTE GOODS, COSTS OF COVER, FACILITIES OR SERVICES, COST OF CAPITAL, OR OTHER SIMILAR PECUNIARY LOSSES,
WHETHER OR NOT SUCH DAMAGES WERE FORESEEN OR UNFORESEEN, AND EVEN IF RIM HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW IN YOUR JURISDICTION, RIM SHALL HAVE NO OTHER OBLIGATION, DUTY,
OR LIABILITY WHATSOEVER IN CONTRACT, TORT, OR OTHERWISE TO YOU INCLUDING ANY LIABILITY FOR NEGLIGENCE OR STRICT
LIABILITY.
THE LIMITATIONS, EXCLUSIONS, AND DISCLAIMERS HEREIN SHALL APPLY: (A) IRRESPECTIVE OF THE NATURE OF THE CAUSE OF
ACTION, DEMAND, OR ACTION BY YOU INCLUDING BUT NOT LIMITED TO BREACH OF CONTRACT, NEGLIGENCE, TORT, STRICT LIABILITY
OR ANY OTHER LEGAL THEORY AND SHALL SURVIVE A FUNDAMENTAL BREACH OR BREACHES OR THE FAILURE OF THE ESSENTIAL
PURPOSE OF THIS AGREEMENT OR OF ANY REMEDY CONTAINED HEREIN; AND (B) TO RIM AND ITS AFFILIATED COMPANIES, THEIR
SUCCESSORS, ASSIGNS, AGENTS, SUPPLIERS (INCLUDING AIRTIME SERVICE PROVIDERS), AUTHORIZED RIM DISTRIBUTORS (ALSO
INCLUDING AIRTIME SERVICE PROVIDERS) AND THEIR RESPECTIVE DIRECTORS, EMPLOYEES, AND INDEPENDENT CONTRACTORS.
IN ADDITION TO THE LIMITATIONS AND EXCLUSIONS SET OUT ABOVE, IN NO EVENT SHALL ANY DIRECTOR, EMPLOYEE, AGENT,
DISTRIBUTOR, SUPPLIER, INDEPENDENT CONTRACTOR OF RIM OR ANY AFFILIATES OF RIM HAVE ANY LIABILITY ARISING FROM OR
RELATED TO THE DOCUMENTATION.
Prior to subscribing for, installing, or using any Third Party Products and Services, it is your responsibility to ensure that your airtime service
provider has agreed to support all of their features. Installation or use of Third Party Products and Services with RIM's products and services
may require one or more patent, trademark, copyright, or other licenses in order to avoid infringement or violation of third party rights. You are
solely responsible for determining whether to use Third Party Products and Services and if any third party licenses are required to do so. If
required you are responsible for acquiring them. You should not install or use Third Party Products and Services until all necessary licenses
have been acquired. Any Third Party Products and Services that are provided with RIM's products and services are provided as a convenience to
you and are provided "AS IS" with no express or implied conditions, endorsements, guarantees, representations, or warranties of any kind by
RIM and RIM assumes no liability whatsoever, in relation thereto. Your use of Third Party Products and Services shall be governed by and
subject to you agreeing to the terms of separate licenses and other agreements applicable thereto with third parties, except to the extent
expressly covered by a license or other agreement with RIM.
The terms of use of any RIM product or service are set out in a separate license or other agreement with RIM applicable thereto. NOTHING IN
THIS DOCUMENTATION IS INTENDED TO SUPERSEDE ANY EXPRESS WRITTEN AGREEMENTS OR WARRANTIES PROVIDED BY RIM FOR
PORTIONS OF ANY RIM PRODUCT OR SERVICE OTHER THAN THIS DOCUMENTATION.

Research In Motion Limited


295 Phillip Street
Waterloo, ON N2L 3W8
Canada
Published in Canada

Research In Motion UK Limited


200 Bath Road
Slough, Berkshire SL1 3XE
United Kingdom

Contents
BlackBerry Enterprise Server User Administration Tool ...............................................................................9
BlackBerry Enterprise Server User Administration Tool overview ............................................................ 9
Requirements and considerations .........................................................................................................10
Download the BlackBerry Enterprise Server Resource Kit files.................................................................11
Installing the BlackBerry Enterprise Server User Administration Tool ....................................................11
Install the BlackBerry Enterprise Server User Administration Tool service .....................................11
BlackBerry Enterprise Server User Administration Tool service log files ........................................14
BlackBerry Enterprise Server User Administration Tool audit log files............................................14
Prepare to run the BlackBerry Enterprise Server User Administration Tool client ........................14
Specify a local system account to run the BlackBerry Enterprise Server User Administration Tool
15
Client password authentication .............................................................................................................16
BlackBerry Enterprise Server User Administration Tool authentication for role-based administration..............................................................................................................................................................16
Managing user accounts................................................................................................................................. 17
Add a user account to the BlackBerry Enterprise Server.................................................................... 17
Add a user account to a group................................................................................................................18
Add an existing user account to a group ..............................................................................................19
Remove a user account from the BlackBerry Enterprise Server........................................................19
Remove a user account from a group...................................................................................................20
Move a user account to a different BlackBerry Enterprise Server ...................................................20
Move a user account to a different group............................................................................................. 21
Find a user account on a BlackBerry Enterprise Server...................................................................... 21
Change user account settings ............................................................................................................... 22
Add a user account to a software configuration................................................................................. 23
Remove a user account from a software configuration ..................................................................... 23
List the groups in a BlackBerry Domain............................................................................................... 24
Managing BlackBerry devices....................................................................................................................... 24
Set the BlackBerry device password..................................................................................................... 24
Set owner information on a BlackBerry device ................................................................................... 25
Delete data from the BlackBerry device memory and make the BlackBerry device unavailable26
Purge pending messages .......................................................................................................................26
Resend the peer-to-peer encryption key to the BlackBerry device................................................. 27

Resend a service book............................................................................................................................. 27


Obtain or clear user account statistics........................................................................................................ 28
Obtain user account statistics............................................................................................................... 28
Interpreting the results of a statistics query for a user account ......................................................29
Clear user account statistics..................................................................................................................30
Sending notification messages to BlackBerry devices..............................................................................30
Send a PIN message ...............................................................................................................................30
Send an email message ...........................................................................................................................31
Managing email and folder redirection....................................................................................................... 32
Turn on email redirection ....................................................................................................................... 32
Turn off email redirection....................................................................................................................... 33
List the folders available for redirection .............................................................................................. 33
Turn on folder redirection ...................................................................................................................... 34
Turn off folder redirection ...................................................................................................................... 35
Managing IT policies and IT policy rules ..................................................................................................... 35
List the IT policy rules in an IT policy ................................................................................................... 35
Set IT policy rules for a user account....................................................................................................36
List the IT policies in the BlackBerry Configuration Database.........................................................36
Obtaining BlackBerry device information................................................................................................... 37
List the applications that are available on one or more BlackBerry devices.................................. 37
List the BlackBerry devices on which a specified application is installed ...................................... 38
List the statistics for BlackBerry devices.............................................................................................. 38
List the modules and .cod files that are available on a BlackBerry device .....................................40
Obtain BlackBerry Enterprise Server statistics ..........................................................................................40
Interpreting the results of a statistics query for a BlackBerry Enterprise Server instance .......... 42
Display the status of the BlackBerry Enterprise Server User Administration Tool service ................. 42
Upgrade the BlackBerry Enterprise Server User Administration Tool.................................................... 43
Remove the BlackBerry Enterprise Server User Administration Tool ..................................................... 43
Parameters available for use with the BlackBerry Enterprise Server User Administration Tool ........45
All parameters..........................................................................................................................................45
-add............................................................................................................................................................45
-assign_swconfig..................................................................................................................................... 47
-change .....................................................................................................................................................48
-delete .......................................................................................................................................................50
-find ...........................................................................................................................................................50
-handheld_info .........................................................................................................................................51
-kill_handheld.......................................................................................................................................... 52

-list............................................................................................................................................................. 52
-it_policy................................................................................................................................................... 53
-move......................................................................................................................................................... 53
-resend_peer_to_peer_key ...................................................................................................................54
-resend_service_book ............................................................................................................................54
-send_email..............................................................................................................................................55
-send_pin..................................................................................................................................................56
-set_folder_redirection ..........................................................................................................................56
-set_owner_info ...................................................................................................................................... 57
-set_password..........................................................................................................................................58
-set_user_itpolicy_rule ..........................................................................................................................58
-stats..........................................................................................................................................................59
-status .......................................................................................................................................................59
Error codes for the BlackBerry Enterprise Server User Administration Tool ........................................60

BlackBerry Enterprise Server User


Administration Tool
BlackBerry Enterprise Server User Administration Tool overview
Download the BlackBerry Enterprise Server Resource Kit files
Installing the BlackBerry Enterprise Server User Administration Tool
Managing user accounts
Managing BlackBerry devices
Obtain or clear user account statistics
Sending notification messages to BlackBerry devices
Managing email and folder redirection
Managing IT policies and IT policy rules
Obtaining BlackBerry device information
Obtaining BlackBerry Enterprise Server statistics
Display the status of the BlackBerry Enterprise Server User Administration Tool service
Upgrade the BlackBerry Enterprise Server User Administration Tool
Remove the BlackBerry Enterprise Server User Administration Tool
Parameters available for use with the BlackBerry Enterprise Server User Administration Tool
Error codes for the BlackBerry Enterprise Server User Administration Tool

BlackBerry Enterprise Server User Administration Tool


overview
You can use the BlackBerry Enterprise Server 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.
The BlackBerry Enterprise Server User Administration Tool, previously named the BESUserAdmin tool, consists of
the following components:

BlackBerry Enterprise Server User Administration Tool service

BlackBerry Enterprise Server User Administration Tool client; you run the BlackBerry Enterprise Server User
Administration Tool client from a command prompt to perform BlackBerry Enterprise Server administration
tasks or to gather BlackBerry Enterprise Server statistics

Analysis, monitoring and troubleshooting tools and documentation are included in a separate file that you can
download. For more information, visit na.blackberry.com/eng/support/server_resourcekit.jsp.

User Guide for the BlackBerry Enterprise Server User Administration Tool

Requirements and considerations


Requirements and considerations

Do not run the BlackBerry Enterprise Server Administration Tool on the same computer on which the BlackBerry Enterprise Server
runs.

The BlackBerry Enterprise Server User Administration Tool supports mixed environments using BlackBerry Enterprise Server version
4.1 SP2 and later. Although the BlackBerry Enterprise Server User Administration Tool might appear to perform tasks on BlackBerry
Enterprise Server version 4.1 SP1 and earlier, the results are unpredictable.

The BlackBerry Enterprise Server User Administration Tool does not support changing an IT policy using BlackBerry Enterprise Server
versions earlier than 4.0.

The BlackBerry Enterprise Server User Administration Tool runs as a Microsoft Windows service named the BlackBerry Enterprise
Server User Administration Tool service.

You must install Microsoft XML Parser version 4.0 on the computer on which you plan to run the BlackBerry Enterprise Server User
Administration Tool service.

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

The BlackBerry Enterprise Server User Administration Tool service and the BlackBerry Enterprise Server User Administration Tool
client components that you use must be the same version.

The BlackBerry Enterprise Server and the computers on which the BlackBerry Enterprise Server User Administration Tool components
run must be located in the same Microsoft Windows domain.

To connect remotely to the computer on which the BlackBerry Enterprise Server User Administration Tool service runs, you must turn
on the printer and file-sharing features on the computer on which the BlackBerry Enterprise Server User Administration Tool service
runs.

For IBM Lotus Domino, you must install IBM Lotus Notes on the computer on which you plan to run the BlackBerry Enterprise
Server User Administration Tool service.

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

If you are using IBM DB2 Universal Database (IBM DB2 UDB), you must install an IBM DB2 UDB client on the computer on
which you plan to run the BlackBerry Enterprise Server User Administration Tool.

If you are using IBM DB2 UDB, verify that the BlackBerry Configuration Database belongs to the database catalog that is located on
the computer on which the BlackBerry Enterprise Server User Administration Tool service runs.

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 BlackBerry Enterprise Server User Administration Tool does not support Microsoft Windows
authentication.

10

BlackBerry Enterprise Server User Administration Tool

Download the BlackBerry Enterprise Server Resource Kit files


1.

Visit na.blackberry.com/eng/support/server_resourcekit.jsp 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 Enterprise Server User


Administration Tool
The BlackBerry Enterprise Server User Administration Tool consists of the BlackBerry Enterprise Server User
Administration Tool service (BESUserAdminService.exe) and the BlackBerry Enterprise Server User Administration
Tool client (BESUserAdminClient.exe), and system files.

Install the BlackBerry Enterprise Server User Administration Tool service


1.

On the computer on which you plan to install the BlackBerry Enterprise Server User Administration Tool
service, create a folder in which to store the BlackBerry Enterprise Server User Administration Tool 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 is located.


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

exchange

domino

groupwise

mdsapplications

11

User Guide for the BlackBerry Enterprise Server User Administration Tool

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


Task

12

Steps

Choose whether to start the BlackBerry Enterprise >


Server User Administration Tool 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 user password.

>

Type the password for the current user account, or if you do not have a
password, leave the password field empty; otherwise, type N to start a new
installation.

Choose whether to use the BlackBerry Enterprise


Server User Administration Tool 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 BlackBerry Enterprise Server User
Administration Tool 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 BlackBerry


Enterprise Server User Administration Tool 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 is located.

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 is
located.

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 Microsoft SQL Server authentication or IBM DB2 UDB authentication,


type Y; to use Microsoft Windows authentication, type N.

>

BlackBerry Enterprise Server User Administration Tool

Task

Steps

If the BlackBerry Manager runs on the same


>
computer, the BlackBerry Enterprise Server User
Administration Tool 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 BlackBerry Enterprise Server User Administration Tool service detects.

If the BlackBerry Manager is not running on the


same computer, specify the database
authentication credentials.

Type the login name, if applicable.

1.

2. Type the password, if applicable.

Set the client password that the BlackBerry


>
Enterprise Server User Administration Tool client
uses to authenticate with the BlackBerry Enterprise
Server User Administration Tool service.

Type a password that is up to 32 characters long.

Set restrictions for the hosts that can run the


BlackBerry Enterprise Server User Administration
Tool client.

>

To restrict the computers that you permit to run the BlackBerry Enterprise
Server User Administration Tool client, type a comma-separated list of
computer names. To permit all computers to run the BlackBerry Enterprise
Server User Administration Tool 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 example, type BlackBerryServer.

For the BlackBerry Enterprise Server for IBM Lotus 1. Type the full path name of the Notes ID file.
Domino, specify the path to and the password for 2. Type the password for the Notes ID file.
the Notes ID file that you want the BlackBerry
Enterprise Server User Administration Tool to use.
Note: The user account that appears in the Notes
ID file must belong to the BlackBerryAdmins group.
For the BlackBerry Enterprise Server for IBM Lotus >
Domino, specify the messaging server that you
want the BlackBerry Enterprise Server 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
BlackBerry Enterprise Server User Administration
Tool to use.

>

Type the user ID. For example, type Admin.

Set access rights that the BlackBerry Enterprise


Server User Administration Tool clients can use to
connect to the BlackBerry Enterprise Server.

>

Type Y to permit access to only BlackBerry Enterprise Server User


Administration Tool clients that are logged in with the same account ID that
you set to start the BlackBerry Enterprise Server User Administration Tool
service; otherwise, type N.

6. In the Microsoft Windows Services window, start the BlackBerry Enterprise Server User Administration Tool
service.

13

User Guide for the BlackBerry Enterprise Server User Administration Tool

BlackBerry Enterprise Server User Administration Tool service log files


If you run the BlackBerry Enterprise Server User Administration Tool service on a computer on which the
BlackBerry Manager runs, the BlackBerry Enterprise Server User Administration Tool service creates log files that
are located in the same folder as the BlackBerry log files. Otherwise, the BlackBerry Enterprise Server User
Administration Tool creates log files in the same folder in which the BESUserAdminService.exe file is located. The
BlackBerry Enterprise Server User Administration Tool service saves the log files in a text file named
<hostname>_BBUA_<##>_<date>_<xxxx>.txt.

BlackBerry Enterprise Server User Administration Tool audit log files


You can configure the BlackBerry Enterprise Server User Administration Tool service to create BlackBerry
Enterprise Server User Administration Tool audit files. If you run the BlackBerry Enterprise Server User
Administration Tool service on a computer on which the BlackBerry Manager runs, the BlackBerry Enterprise
Server User Administration Tool creates audit log files that are located in the same folder as the BlackBerry log
files. Otherwise, the BlackBerry Enterprise Server User Administration Tool creates audit log files in the same
folder in which the BESUserAdminService.exe file is located. The BlackBerry Enterprise Server User
Administration Tool saves the audit log files in a text file named
<hostname>_BBUA_AUDT_<##>_<date>_<xxxx>.txt.
By default, the BlackBerry Enterprise Server User Administration Tool audit logging feature is turned off.

Set up the BlackBerry Enterprise Server User Administration Tool audit logging
1.

On the computer on which the BlackBerry Enterprise Server User Administration Tool 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:


Task

Steps

Turn on the BlackBerry Enterprise Server User


Administration Tool 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 BlackBerry Enterprise


1. Double-click the AuditLogDir value.
Server User Administration Tool creates the audit log files. 2. In the Value data field, type the location in which to create the audit log
files.
3. Click OK.

Prepare to run the BlackBerry Enterprise Server User Administration Tool


client
>

14

Copy BESUserAdminClient.exe and CE.dll to a folder on the computer on which you plan to run the
BlackBerry Enterprise Server User Administration Tool client.

BlackBerry Enterprise Server User Administration Tool

Specify a local system account to run the BlackBerry Enterprise Server User
Administration Tool
During the installation of the BlackBerry Enterprise Server User Administration Tool service component,
administrator permissions are given to the user account logged in at the time of installation. You must use the
BlackBerry Enterprise Server User Administration Tool with this account. If you want to specify a local system
account to run the BlackBerry Enterprise Server User Administration Tool, you must change the registry settings
for the BlackBerry Enterprise Server User Administration Tool and then change the BlackBerry Enterprise Server
User Administration Tool service to log in using the local system account.

Change the BlackBerry Enterprise Server User Administration Tool service registry settings
1.

Log in to the Microsoft Windows account that you use to run the BlackBerry Enterprise Server User
Administration Tool 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 registration file (*.reg).
5. In the registration 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. In the registration file, remove any line break after a hashed password where the closing quotation mark is on
the next line.
7. Save the file.
8. In the Registry Editor, import the registration file.

Change the BlackBerry Enterprise Server User Administration Tool service to log in using a
local system account
1.

Stop the BlackBerry Enterprise Server User Administration Tool service.

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

15

User Guide for the BlackBerry Enterprise Server User Administration Tool

Client password authentication


The BlackBerry Enterprise Server User Administration Tool client uses the client password to authenticate with
the BlackBerry Enterprise Server User Administration Tool service. When the BlackBerry Enterprise Server User
Administration Tool client starts, it obtains tokenized data from the BlackBerry Enterprise Server User
Administration Tool service. The BlackBerry Enterprise Server User Administration Tool client uses this unique
login data to create an encrypted password that it sends to the BlackBerry Enterprise Server User Administration
Tool service. The BlackBerry Enterprise Server User Administration Tool service uses this same tokenized data and
client password to create an encrypted password locally. The BlackBerry Enterprise Server User Administration
Tool service compares its encrypted password to the value that the BlackBerry Enterprise Server User
Administration Tool 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 BlackBerry Enterprise Server User Administration Tool client can process more
commands:

Restart the BlackBerry Enterprise Server User Administration Tool service.

Reactivate the client password without restarting the BlackBerry Enterprise Server User Administration Tool
service.

Reactivate the client password


1.

On the computer on which the BlackBerry Enterprise Server User Administration Tool 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 BlackBerry Enterprise Server User Administration Tool
client runs.
5. Close the Registry Editor.
6. In the BlackBerry Enterprise Server User Administration Tool client, type the command and the client
password.

BlackBerry Enterprise Server User Administration Tool authentication for rolebased administration
To permit role-based administration, the user account that you use to run the BlackBerry Enterprise Server User
Administration Tool client must authenticate with the BlackBerry Configuration Database. The user account for
the BlackBerry Enterprise Server User Administration Tool must be given permissions for the database, and it must
have system administrator access and security administration access.

16

BlackBerry Enterprise Server User Administration Tool

The BlackBerry Enterprise Server User Administration Tool supports role-based administration for client user
accounts using Microsoft Windows authentication, Microsoft SQL Server authentication, and IBM DB2 UDB
authentication. After the BlackBerry Enterprise Server User Administration Tool service determines the role
assigned to the client user account, the BlackBerry Enterprise Server User Administration Tool service determines
whether the user role permits the action that the client user account invokes. If the user role does not have
permission to perform the action, the BlackBerry Enterprise Server User Administration Tool service reports that
the operation cannot complete because of insufficient permissions. The BlackBerry Enterprise Server User
Administration Tool service checks for changes made to role-based administration, such as when user accounts
added or roles assigned, at 5-minute intervals.

Managing user accounts


The 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 BlackBerry Enterprise Server User Administration Tool client uses the Microsoft Windows
authentication credentials that you type when you log in to your computer. If the BlackBerry Enterprise Server
User Administration Tool client uses Microsoft SQL Server authentication or IBM DB2 UDB authentication to
authenticate with the BlackBerry Configuration Database, you must specify the database user name and password
in the BlackBerry Enterprise Server User Administration Tool client commands.
You can identify the role assigned to the user account for which you are logged in to the BlackBerry Enterprise
Server User Administration Tool client by using the verbose logging parameter (-v).
Note: The database authentication information is encrypted when it passes from the BlackBerry Enterprise Server
User Administration Tool client to the BlackBerry Enterprise Server User Administration Tool service and to the
BlackBerry Configuration Database.

Add a user account to the BlackBerry Enterprise Server


1.

At the command prompt, switch to the folder in which BESUserAdminClient.exe is located.

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_BlackBerry_Enterprise_Server_User_Administration_Tool_service> (if the


BlackBerry Enterprise Server User Administration Tool service and the BlackBerry Enterprise Server User
Administration Tool client do not run on the same computer)

17

User Guide for the BlackBerry Enterprise Server User Administration Tool

See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for
more information.
Example: Adding a user account to a BlackBerry Enterprise Server for Microsoft Exchange

besuseradminclient -add -p password1 -u cwarren@test.rim.net -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 204FEA39 -pin xxxxxxxx -b server01 -n computer01


-it_policy User Can Change Timeout

Add a user account to a group


1.

At the command prompt, switch to the folder in which BESUserAdminClient.exe is located.

2. Type besuseradminclient -add and the following parameters:

-p <client_password>

-u <user_name>

-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_BlackBerry_Enterprise_Server_User_Administration_Tool_service> (if the


BlackBerry Enterprise Server User Administration Tool service and the BlackBerry Enterprise Server User
Administration Tool client do not run on the same computer)

See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for
more information.

18

BlackBerry Enterprise Server User Administration Tool

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

besuseradminclient -add -p password1 -u cwarren@test.rim.net -b server01 -n computer01 -pin xxxxxxx


-group administrators -it_policy User Can Change Timeout

Add an existing user account to a group


1.

At the command prompt, switch to the folder in which BESUserAdminClient.exe is located.

2. Type besuseradminclient -change and the following parameters:

-p <client_password>

-u <user_name>

-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_BlackBerry_Enterprise_Server_User_Administration_Tool_service> (if the


BlackBerry Enterprise Server User Administration Tool service and the BlackBerry Enterprise Server User
Administration Tool client do not run on the same computer)

See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for
more information.
Example: Adding an existing user to a group

besuseradminclient -change -p password1 -u cwarren@rim.test.net -b server01 -group administrators

Remove a user account from the BlackBerry Enterprise Server


1.

At the command prompt, switch to the folder in which BESUserAdminClient.exe is located.

2. Type besuseradminclient -delete 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_password> (if you use database authentication)

19

User Guide for the BlackBerry Enterprise Server User Administration Tool

-n <network_address_of_BlackBerry_Enterprise_Server_User_Administration_Tool_service> (if the


BlackBerry Enterprise Server User Administration Tool service and the BlackBerry Enterprise Server User
Administration Tool client do not run on the same computer)

See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for
more information.
Example: Removing a user from the BlackBerry Enterprise Server for Microsoft Exchange

besuseradminclient -delete -p password1 -u cwarren@rim.test.net -b server01

Remove a user account from a group


1.

At the command prompt, switch to the folder in which BESUserAdminClient.exe is located.

2. Type besuseradminclient -change and the following parameters:

-p <client_password>

-u <user_name>

-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_BlackBerry_Enterprise_Server_User_Administration_Tool_service> (if the


BlackBerry Enterprise Server User Administration Tool service and the BlackBerry Enterprise Server User
Administration Tool client do not run on the same computer)

See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for
more information.
Example: Removing a user account from a group on the BlackBerry Enterprise Server for Microsoft Exchange

besuseradminclient -change -p password1 -u cwarren@rim.test.net -b server01 -cgroup

Move a user account to a different BlackBerry Enterprise Server


Both BlackBerry Enterprise Server computers must use the same BlackBerry Configuration Database.
1.

At the command prompt, switch to the folder in which BESUserAdminClient.exe is located.

2. Type besuseradminclient -move and the following parameters:

20

-p <client_password>

-u <user_name>

BlackBerry Enterprise Server User Administration Tool

-b <source_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_BlackBerry_Enterprise_Server_User_Administration_Tool_service> (if the


BlackBerry Enterprise Server User Administration Tool service and the BlackBerry Enterprise Server User
Administration Tool client do not run on the same computer)

See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for
more information.
Example: Moving a user account to a different BlackBerry Enterprise Server for Microsoft Exchange

besuseradminclient -move -p password1 -u cwarren@rim.test.net -b server01 -t server02

Move a user account to a different group


1.

At the command prompt, switch to the folder in which BESUserAdminClient.exe is located.

2. Type besuseradminclient -change and the following parameters:

-p <client_password>

-u <user_name>

-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_BlackBerry_Enterprise_Server_User_Administration_Tool_service> (if the


BlackBerry Enterprise Server User Administration Tool service and the BlackBerry Enterprise Server User
Administration Tool client do not run on the same computer)

See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for
more information.
Example: Moving a user account to a different group

besuseradminclient -change -p password1 -u cwarren@rim.test.net -b server01 -group security

Find a user account on a BlackBerry Enterprise Server


1.

At the command prompt, switch to the folder in which BESUserAdminClient.exe is located.


21

User Guide for the BlackBerry Enterprise Server User Administration Tool

2. Type besuseradminclient -find and the following parameters:

-p <client_password>

-u <user_name>

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

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

-n <network_address_of_BlackBerry_Enterprise_Server_User_Administration_Tool_service> (if the


BlackBerry Enterprise Server User Administration Tool service and the BlackBerry Enterprise Server User
Administration Tool client do not run on the same computer)

See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for
more information.
Example: Finding a user account on the BlackBerry Enterprise Server for Microsoft Exchange

besuseradminclient -find -p password1 -u cwarren@rim.test.net

Change user account settings


The BlackBerry Enterprise Server for MDS Applications does not support this task.
1.

At the command prompt, switch to the folder in which BESUserAdminClient.exe is located.

2. Type besuseradminclient -change 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_password> (if you use database authentication)

-n <network_address_of_BlackBerry_Enterprise_Server_User_Administration_Tool_service> (if the


BlackBerry Enterprise Server User Administration Tool service and BlackBerry Enterprise Server User
Administration Tool client do not run on the same computer)

See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for
more information.
Example: Clearing the user account filters

besuseradminclient -change -p password1 -u cwarren@rim.test.net -b server01 -cf

22

BlackBerry Enterprise Server 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 cwarren@rim.test.net -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 configuration


1.

At the command prompt, switch to the folder in which BESUserAdminClient.exe is located.

2. Type besuseradminclient -assign_swconfig -sw <configuration name> 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_password> (if you use database authentication)

-n <network_address_of_BlackBerry_Enterprise_Server_User_Administration_Tool_service> (if the


BlackBerry Enterprise Server User Administration Tool service and the BlackBerry Enterprise Server User
Administration Tool client do not run on the same computer)

See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 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 configuration


1.

At the command prompt, switch to the folder in which BESUserAdminClient.exe is located.

2. Type besuseradminclient -assign_swconfig -csw 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_password> (if you use database authentication)


23

User Guide for the BlackBerry Enterprise Server User Administration Tool

-n <network_address_of_BlackBerry_Enterprise_Server_User_Administration_Tool_service> (if the


BlackBerry Enterprise Server User Administration Tool service and the BlackBerry Enterprise Server User
Administration Tool client do not run on the same computer)

See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 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 Domain


1.

At the command prompt, switch to the folder in which BESUserAdminClient.exe is located.

2. Type besuseradminclient -list -groups and the following parameters:

-p <client_password>

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

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

-n <network_address_of_BlackBerry_Enterprise_Server_User_Administration_Tool_service> (if the


BlackBerry Enterprise Server User Administration Tool service and the BlackBerry Enterprise Server User
Administration Tool client do not run on the same computer)

See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for
more information.
Example: Listing the groups in a BlackBerry Domain

besuseradminclient -p password -list -groups

Managing BlackBerry devices


Set the BlackBerry device password
1.

At the command prompt, switch to the folder in which BESUserAdminClient.exe is located.

2. Type besuseradminclient -set_password <password> and the following parameters:

24

-p <client_password>

-u <user_name>

-b <BlackBerry_Enterprise_Server_service_name>

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

BlackBerry Enterprise Server User Administration Tool

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

-n <network_address_of_BlackBerry_Enterprise_Server_User_Administration_Tool_service> (if the


BlackBerry Enterprise Server User Administration Tool service and the BlackBerry Enterprise Server User
Administration Tool client do not run on the same computer)

See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for
more information.
Example: Setting the BlackBerry device password

besuseradminclient -set_password devicepassword1 -p password1 -u cwarren@rim.test.net -b server01

Set owner information on a BlackBerry device


To 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 is located.

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>

-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_BlackBerry_Enterprise_Server_User_Administration_Tool_service> (if the


BlackBerry Enterprise Server User Administration Tool service and the BlackBerry Enterprise Server User
Administration Tool client do not run on the same computer)

See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for
more information.
Example: Setting owner information on a BlackBerry device

besuseradminclient -set_owner_info -info Clyde Warren -p password -u cwarren@rim.test.net -b server01


Example: Setting owner information on a BlackBerry device using an input file

besuseradminclient -set_owner_info -infofile userinformation.txt -p password -u cwarren@rim.test.net


-b server01

25

User Guide for the BlackBerry Enterprise Server User Administration Tool

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 is located.

2. Type besuseradminclient -kill_handheld 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_password> (if you use database authentication)

-n <network_address_of_BlackBerry_Enterprise_Server_User_Administration_Tool_service> (if the


BlackBerry Enterprise Server User Administration Tool service and the BlackBerry Enterprise Server User
Administration Tool client do not run on the same computer.)

See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for
more information.
Example: Deleting data from the BlackBerry device memory and making the BlackBerry device unavailable

besuseradminclient -kill_handheld -p password1 -u cwarren@rim.test.net -b server01

Purge pending messages


The BlackBerry Enterprise Server for MDS Applications does not support this task.
1.

At the command prompt, switch to the folder in which BESUserAdminClient.exe is located.

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_password> (if you use database authentication)

-n <network_address_of_BlackBerry_Enterprise_Server_User_Administration_Tool_service> (if the


BlackBerry Enterprise Server User Administration Tool service and the BlackBerry Enterprise Server User
Administration Tool client do not run on the same computer)

See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for
more information.

26

BlackBerry Enterprise Server User Administration Tool

Example: Purging pending messages for a user account

besuseradminclient -change -purge_pending_messages -p password1 -u cwarren@rim.test.net -b server01

Resend the peer-to-peer encryption key to the BlackBerry device


1.

At the command prompt, switch to the folder in which BESUserAdminClient.exe is located.

2. Type besuseradminclient -resend_peer_to_peer_key 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_password> (if you use database authentication)

-n <network_address_of_BlackBerry_Enterprise_Server_User_Administration_Tool_service> (if the


BlackBerry Enterprise Server User Administration Tool service and the BlackBerry Enterprise Server User
Administration Tool client do not run on the same computer)

See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 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 cwarren@rim.test.net -b server01

Resend a service book


1.

At the command prompt, switch to the folder in which BESUserAdminClient.exe is located.

2. Type besuseradminclient -resend_service_book 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_password> (if you use database authentication)

-n <network_address_of_BlackBerry_Enterprise_Server_User_Administration_Tool_service> (if the


BlackBerry Enterprise Server User Administration Tool service and the BlackBerry Enterprise Server User
Administration Tool client do not run on the same computer)

27

User Guide for the BlackBerry Enterprise Server User Administration Tool

See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for
more information.
Example: Resending a service book to the BlackBerry device

besuseradminclient -p password -u cwarren@<domain>.com -b server1 -resend_service_book

Obtain or clear user account statistics


Obtain user account statistics
1.

At the command prompt, switch to the folder in which BESUserAdminClient.exe is located.

2. Type besuseradminclient -stats 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_password> (if you use database authentication)

-n <network_address_of_BlackBerry_Enterprise_Server_User_Administration_Tool_service>(if the
BlackBerry Enterprise Server User Administration Tool service and the BlackBerry Enterprise Server User
Administration Tool client do not run on the same computer)

See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 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

28

BlackBerry Enterprise Server User Administration Tool

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.

ServerDN

canonical name of the BlackBerry Enterprise Server on which the BlackBerry device user account is located
Platform: This column does not apply to the BlackBerry Enterprise Server for MDS Applications.

PIN

BlackBerry device PIN (personal information number>

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 is located


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 organizer data 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 organizer data 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 organizer data 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 organizer data 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 organizer data 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

29

User Guide for the BlackBerry Enterprise Server User Administration Tool

Column

Description

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

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

Encryption Type

encryption type set on the BlackBerry device

Service Name

name of the BlackBerry Enterprise Server on which the user account is located

Group Name

name of the group to which the user account belongs

Platform: This column does not apply to the BlackBerry Enterprise Server for MDS Applications.

Clear user account statistics


1.

At the command prompt, switch to the folder in which BESUserAdminClient.exe is located.

2. Type besuseradminclient -change -cs 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_password> (if you use database authentication)

-n <network_address_of_BlackBerry_Enterprise_Server_User_Administration_Tool_service> (if the


BlackBerry Enterprise Server User Administration Tool service and the BlackBerry Enterprise Server User
Administration Tool client do not run on the same computer)

See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for
more information.
Example: Clearing user account statistics

besuseradminclient -change -p password1 -u cwarren@rim.test.net -b server01 -cs

Sending notification messages to BlackBerry devices


Send a PIN message
1.

At the command prompt, switch to the folder in which BESUserAdminClient.exe is located.

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:

30

-p <client_password>

BlackBerry Enterprise Server User Administration Tool

-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_password> (if you use database authentication)

-n <network_address_of_BlackBerry_Enterprise_Server_User_Administration_Tool_service> (if the


BlackBerry Enterprise Server User Administration Tool service and the BlackBerry Enterprise Server User
Administration Tool client do not run on the same computer)

See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for
more information.
Note: Using an input file overrides the -u, -b, -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 message


The BlackBerry Enterprise Server for MDS Applications does not support this task.
1.

At the command prompt, switch to the folder in which BESUserAdminClient.exe is located.

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_password> (if you use database authentication)

31

User Guide for the BlackBerry Enterprise Server User Administration Tool

-n <network_address_of_BlackBerry_Enterprise_Server_User_Administration_Tool_service> (if the


BlackBerry Enterprise Server User Administration Tool service and the BlackBerry Enterprise Server User
Administration Tool client do not run on the same computer)

Using an input file overrides the -u, -b, -subject and -body parameters.
See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for
more information.
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 redirection
The BlackBerry Enterprise Server for MDS Applications does not support this task.
1.

At the command prompt, switch to the folder in which BESUserAdminClient.exe is located.

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_password> (if you use database authentication)

-n <network_address_of_BlackBerry_Enterprise_Server_User_Administration_Tool_service> (if the


BlackBerry Enterprise Server User Administration Tool service and the BlackBerry Enterprise Server User
Administration Tool client do not run on the same computer)

-er

See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for
more information.

32

BlackBerry Enterprise Server User Administration Tool

Example: Turning on email redirection for a user account

besuseradminclient -change -p password1 -u cwarren@rim.test.net -b server01 -er

Turn off email redirection


The BlackBerry Enterprise Server for MDS Applications does not support this task.
1.

At the command prompt, switch to the folder in which BESUserAdminClient.exe is located.

2. Type besuseradminclient -change -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_password> (if you use database authentication)

-n <network_address_of_BlackBerry_Enterprise_Server_User_Administration_Tool_service> (if the


BlackBerry Enterprise Server User Administration Tool service and the BlackBerry Enterprise Server User
Administration Tool client do not run on the same computer)

-dr

See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for
more information.
Example: Turning off email redirection for a user account

besuseradminclient -change -p password1 -u cwarren@rim.test.net -b server01 -dr

List the folders available for redirection


The BlackBerry Enterprise Server for MDS Applications does not support this task.
1.

At the command prompt, switch to the folder in which BESUserAdminClient.exe is located.

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_password> (if you use database authentication)

33

User Guide for the BlackBerry Enterprise Server User Administration Tool

-n <network_address_of_BlackBerry_Enterprise_Server_User_Administration_Tool_service> (if the


BlackBerry Enterprise Server User Administration Tool service and the BlackBerry Enterprise Server User
Administration Tool client do not run on the same computer)

See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for
more information.
Example: Listing the folders available for redirection

besuseradminclient -p password -u clydewarren -b server01 -list -folders

Turn on folder redirection


The 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 is located.

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_password> (if you use database authentication)

-n <network_address_of_BlackBerry_Enterprise_Server_User_Administration_Tool_service> (if the


BlackBerry Enterprise Server User Administration Tool service and the BlackBerry Enterprise Server User
Administration Tool client do not run on the same computer)

-foldername <folder_name>

-er

See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for
more information.
Example: Turning on folder redirection with a folder name that contains a slash mark

besuseradminclient -set_folder_redirection -p password1 -u cwarren@rim.test.net -b server01 -foldername Inbox/


subfolder1/sub\/folder2 -er

34

BlackBerry Enterprise Server User Administration Tool

Turn off folder redirection


The 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 is located.

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_password> (if you use database authentication)

-n <network_address_of_BlackBerry_Enterprise_Server_User_Administration_Tool_service> (if the


BlackBerry Enterprise Server User Administration Tool service and the BlackBerry Enterprise Server User
Administration Tool client do not run on the same computer)

-foldername <folder_name>

-dr

See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for
more information.
Example: Turning off folder redirection

besuseradminclient -set_folder_redirection -p password1 -u cwarren@rim.test.net -b server01


-foldername Inbox -dr

Managing IT policies and IT policy rules


List the IT policy rules in an IT policy
1.

At the command prompt, switch to the folder in which BESUserAdminClient.exe is located.

2. Type besuseradminclient -list -it_policy_rules 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_password> (if you use database authentication)

35

User Guide for the BlackBerry Enterprise Server User Administration Tool

-n <network_address_of_BlackBerry_Enterprise_Server_User_Administration_Tool_service> (if the


BlackBerry Enterprise Server User Administration Tool service and the BlackBerry Enterprise Server User
Administration Tool client do not run on the same computer)

-it_policy <policy_name>

See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 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 account


1.

At the command prompt, switch to the folder in which BESUserAdminClient.exe is located.

2. Type besuseradminclient -set_user_itpolicy_rule 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_password> (if you use database authentication)

-n <network_address_of_BlackBerry_Enterprise_Server_User_Administration_Tool_service> (if the


BlackBerry Enterprise Server User Administration Tool service and the BlackBerry Enterprise Server User
Administration Tool client do not run on the same computer)

-policyrule <rulename>

-policyvalue <value>

See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for
more information.
Example: Setting IT policy rules for a user account

besuseradminclient -set_user_itpolicy_rule -p password1 -u cwarren@rim.test.net -b server01 -policyrule VPN


User Name -policyvalue cwarren

List the IT policies in the BlackBerry Configuration Database


1.

At the command prompt, switch to the folder in which BESUserAdminClient.exe is located.

2. Type besuseradminclient -list -it_policies and the following parameters:

36

BlackBerry Enterprise Server User Administration Tool

-p <client_password>

-u <user_name>

-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_BlackBerry_Enterprise_Server_User_Administration_Tool_service> (if the


BlackBerry Enterprise Server User Administration Tool service and the BlackBerry Enterprise Server User
Administration Tool client do not run on the same computer)

See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for
more information.
Example: Listing the IT policies in your environment

besuseradminclient -p password -list -it_policies

Obtaining BlackBerry device information


List the applications that are available on one or more BlackBerry devices
1.

At the command prompt, switch to the folder in which BESUserAdminClient.exe is located.

2. Type -handheld_info -apps 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_password> (if you use database authentication)

-n <network_address_of_BlackBerry_Enterprise_Server_User_Administration_Tool_service> (if the


BlackBerry Enterprise Server User Administration Tool service and the BlackBerry Enterprise Server User
Administration Tool client do not run on the same computer)

See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 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

37

User Guide for the BlackBerry Enterprise Server User Administration Tool

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 installed


1.

At the command prompt, switch to the folder in which BESUserAdminClient.exe is located.

2. Type besuseradminclient -handheld_info - appname <application_name> 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_password> (if you use database authentication)

-n <network_address_of_BlackBerry_Enterprise_Server_User_Administration_Tool_service> (if the


BlackBerry Enterprise Server User Administration Tool service and the BlackBerry Enterprise Server User
Administration Tool client do not run on the same computer)

See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 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 devices


1.

At the command prompt, switch to the folder in which BESUserAdminClient.exe is located.

2. Type besuseradminclient -handheld_info -hhstats and the following parameters:

38

-p <client_password>

-u <user_name>

-b <BlackBerry_Enterprise_Server_service_name>

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

BlackBerry Enterprise Server User Administration Tool

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

-n <network_address_of_BlackBerry_Enterprise_Server_User_Administration_Tool_service> (if the


BlackBerry Enterprise Server User Administration Tool service and the BlackBerry Enterprise Server User
Administration Tool client do not run on the same computer)

See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 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

Interpreting the results of a statistics query for a BlackBerry device


Column

Description

User Name

name of the user account

PIN

PIN (personal information number) 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 the BlackBerry device uses

BlackBerry Version

version of the applications that the BlackBerry device uses

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 (Global System for Mobile
Communications) 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

39

User Guide for the BlackBerry Enterprise Server User Administration Tool

Column

Description

Battery Level

current battery capacity level in percentage

Uptime

time since the BlackBerry device was last reset

List the modules and .cod files that are available on a BlackBerry device
1.

At the command prompt, switch to the folder in which BESUserAdminClient.exe is located.

2. Type besuseradminclient -handheld_info -modules 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_password> (if you use database authentication)

-n <network_address_of_BlackBerry_Enterprise_Server_User_Administration_Tool_service> (if the


BlackBerry Enterprise Server User Administration Tool service and the BlackBerry Enterprise Server User
Administration Tool client do not run on the same computer)

See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 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 statistics


1.

At the command prompt, switch to the folder in which BESUserAdminClient.exe is located.

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:

40

-p <client_password>

-u <user_name>

-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_BlackBerry_Enterprise_Server_User_Administration_Tool_service> (if the


BlackBerry Enterprise Server User Administration Tool service and the BlackBerry Enterprise Server User
Administration Tool client do not run on the same computer)

BlackBerry Enterprise Server User Administration Tool

See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for
more information.
Example: Obtaining statistics for a BlackBerry Enterprise Server instance

besuseradminclient -p password1 -stats -b server01


Example: Obtaining statistics for multiple BlackBerry Enterprise Server instances

besuseradminclient -p password1 -stats -servers -i serverfile.txt -o output.csv


Example: Obtaining statistics for all BlackBerry Enterprise Server instances

besuseradminclient -p password1 -stats -servers

41

User Guide for the BlackBerry Enterprise Server User Administration Tool

Interpreting the results of a statistics query for a BlackBerry Enterprise Server


instance
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 organizer data 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 organizer data 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 organizer data 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 organizer data 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 Enterprise Server runs

Server Version

version of the BlackBerry Enterprise Server

Display the status of the BlackBerry Enterprise Server User


Administration Tool service
1.

At the command prompt, switch to the folder in which BESUserAdminClient.exe is located.

2. Type besuseradminclient -status and the following parameter:

-p <client_password>

See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for
more information.
Example: Checking the status of the BlackBerry Enterprise Server User Administration Tool service

besuseradminclient -p password -status

42

BlackBerry Enterprise Server User Administration Tool

Upgrade the BlackBerry Enterprise Server User


Administration Tool
1.

Stop the BlackBerry Enterprise Server User Administration Tool service.

2. On the computers on which the BlackBerry Enterprise Server User Administration Tool service and BlackBerry
Enterprise Server User Administration Tool client components are located, replace the following files:

BESUserAdminService.exe

BESUserAdminClient.exe

CE.dll

BESUserAdminX.dll (Microsoft Exchange environments only)

BESUserAdminD.dll (IBM Lotus Domino environments only)

BESUserAdminG.dll (Novell GroupWise environments only)

BESUserAdminAudit.dll

3. Remove the following files, if they are present:

ClientAuthentication8.dll

ServerAuthentication8.dll

4. In the Microsoft Windows Services window, start the BlackBerry Enterprise Server User Administration Tool
service.

Remove the BlackBerry Enterprise Server User


Administration Tool
1.

Stop the BlackBerry Enterprise Server User Administration Tool service.

2. At the command prompt, switch to the folder in which BESUserAdminService.exe and the associated .dll files
are located.
3. Type besuseradminservice -remove. This command removes the service only from the computer.
4. On the computer on which the BlackBerry Enterprise Server User Administration Tool service files are located,
remove the following files:

BESUserAdminService.exe

CE.dll

BESUserAdminX.dll (Microsoft Exchange environments only)

BESUserAdminD.dll (IBM Lotus Domino environments only)

BESUserAdminG.dll (Novell GroupWise environments only)

BESUserAdminAudit.dll

43

User Guide for the BlackBerry Enterprise Server User Administration Tool

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 BlackBerry Enterprise Server User Administration Tool client component is
located, remove the following files:

44

BESUserAdminClient.exe

CE.dll.

BlackBerry Enterprise Server User Administration Tool

Parameters available for use with the BlackBerry Enterprise


Server User Administration Tool
All parameters
Use with

Description

-?

displays help information for the tool

Notes

2> <filename.txt>

redirects text that displays on the screen to the specified text file

-help <command>

displays help information for a specific command

-o <outputfilename>

specifies the file in which to save output information

-p <clientpassword>

specifies the client password that the BlackBerry Enterprise Server


User Administration Tool client uses to authenticate with the
BlackBerry Enterprise Server User Administration Tool service

The BlackBerry Enterprise Server User


Administration Tool service prompts you to
create and type the client password during
the installation process.

-sqluser
<database_user_name
>

specifies the database login account for Microsoft SQL Server


authentication or IBM DB2 UDB authentication

For role-based administration, you must


use this parameter if you use database
authentication to connect to the
BlackBerry Configuration Database.

-sqlpass
<database_password>

specifies the database password

For role-based administration, you must


use this parameter if you use database
authentication to connect to the
BlackBerry Configuration Database.

-v

provides detailed feedback about the steps for the performed action; By default, the parameter is terse, which
also provides the role assigned to the user account for which you are provides error and completion messages.
logged in to the BlackBerry Enterprise Server User Administration
Tool client when you are using the BlackBerry Enterprise Server User
Administration Tool

-add
Use the -add parameter to add a user account to the BlackBerry Enterprise Server instance.
Use with

Description

Notes

-addrsub
<address_book_name>

specifies the address book of a user account

Use this parameter with the BlackBerry


Enterprise Server for Novell GroupWise
only.

-b

specifies the BlackBerry Enterprise Server service on which to perform For the name of the BlackBerry Enterprise
Server, use the name as it appears in the
<BlackBerry_Enterprise the action
BlackBerry Manager, on the Servers tab in
_Server_service_name>
the Service Name column.
-cs

clears the account statistics of an existing user account

By default, when you add a user account,


the BlackBerry Enterprise Server User
Administration Tool reads the existing
statistics for the user account.

45

User Guide for the BlackBerry Enterprise Server User Administration Tool

Use with

Description

Notes

-domaddrsvr
<servername>

adds foreign users who do not exist in the address book

Use this parameter with the BlackBerry


Enterprise Server for IBM Lotus
Domino only.

-group <group_name>

specifies the name of the group in which to add a new user account

-i <filename.txt>

specifies the name of the newline delimited input file; use the
following format for each line in the input file:
<user_name>,<BlackBerryEnterpriseServer_name>
[,<PIN>[,<password>[,<ITpolicy>,[<groupname>[,<pimadd>
[,<pimmemo>[,<addrsub>]]]]]]]

[-infofile <filename>]

overrides the enterprise activation email values (use only with


-wrandom); the file uses the following format; in the <value> of the
body, the tool replaces $p by the password and $x by the expiry
time:

This parameter overrides the -u, -b, -group,


-it_policy, -pimaddr, -pimmemo, -addrsub,
-pin, and -w parameters.

[Subject=<value>]
{[[Body=]<value>]}
-it_policy
<policy_name>

specifies the name of the IT policy to apply to the user account

-n <network_address>

specifies the network address (IP address or computer host name) of Use this parameter only if the BlackBerry
the computer on which the BlackBerry Enterprise Server User
Enterprise Server User Administration Tool
Administration Tool service runs
client and the BlackBerry Enterprise Server
User Administration Tool service do not run
on the same computer.

-pimaddr
specifies the BlackBerry Enterprise Server name and the relative
<servername>!!<datapa path to the IBM Lotus Notes Data folder for storing the organizer
data address book when you add a user account
th>

A list of valid IT policies is available in the


BlackBerry Manager. You can also obtain
the list if you run the BlackBerry Enterprise
Server User Administration Tool client with
the -list -it_policies parameter.

Use this parameter with the BlackBerry


Enterprise Server for IBM Lotus Domino
only.

-pimmemo
specifies the BlackBerry Enterprise Server name and the relative path Use this parameter with the BlackBerry
<servername>!!<datapa to the IBM Lotus Notes Data folder for storing the memo database
Enterprise Server for IBM Lotus Domino
when you add a user account
only.
th>
-pin <PIN>

specifies the PIN of the BlackBerry device assigned to the user

-u <user_name>

specifies the user account on which to perform the action

-w <password>

46

Microsoft Exchange: mailbox name; for example,


cwarren@test.rim.net
IBM Lotus Domino: canonical name; for example,
CN=Clyde Warren/O=Server01
Novell GroupWise: User ID, for example; clydewarren
BlackBerry MDS Applications: display name of the BlackBerry
device

specifies the password for wireless activation

BlackBerry Enterprise Server User Administration Tool

Use with

Description

-wrandom

generates and emails a random enterprise activation password, in the This parameter is not allowed when adding
form of eight lower case characters in the range a-z; the default
a list of users.
format of the email is as follows, with the tool replacing $p by the
password and $x by the expiry time.

Notes

SUBJECT=BlackBerry enterprise activation password


BODY=Hello,
To activate your BlackBerry device over the wireless network, in the
device Options screen select Enterprise Activation. In that screen,
enter your corporate email address and the following password:
$p
This password will expire in $x hours.
-wt
specifies a password expiration time, in hours (between 1 and 720);
<password_expiry_time the default expiration time is 48 hours
>

Use this parameter with the -w parameter


or the -wrandom parameter.

-assign_swconfig
Use the -assign_swconfig parameter to assign a software configuration to a user or a group of users.
Use with

Description

Notes

-b

specifies the BlackBerry Enterprise Server service name on which to For the name of the BlackBerry Enterprise
Server, use the name as it appears in the
<BlackBerry_Enterprise perform the action
BlackBerry Manager, on the Servers tab in
_Server_name>
the Service Name column.
-csw

removes a user account from a software configuration

-g <group_name>

specifies the name of the group on which to perform the action

-i <filename.txt>

specifies the name of the newline delimited input file; the file uses the This parameter overrides the -u, -b, -g, and
following format:
-sw parameters.

This parameter overrides the -u and -b


parameters.

<user_name>,
<BlackBerryEnterpriseServer_name>[,<configuration_name>]
The configuration name is not required with the -csw parameter but
is required with all others.
-sw
<configuration_name>

specifies the name of the software configuration to which you want to


add the user account

-u <user_name>

specifies the user account on which to perform the action

Microsoft Exchange: mailbox name; for example,


cwarren@test.rim.net
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

47

User Guide for the BlackBerry Enterprise Server User Administration Tool

-change
Use the -change parameter to make changes to user account settings and purge pending messages.
Use with

Description

Notes

-addrsub
<address_book_name>

specifies the address book of a user

Use this parameter with the BlackBerry


Enterprise Server for Novell GroupWise
only.

-b

specifies the BlackBerry Enterprise Server service name on which to


<BlackBerry_Enterprise perform the action
_Server_name>

For the name of the BlackBerry Enterprise


Server, use the name as it appears in the
BlackBerry Manager, on the Servers tab in
the Service Name column.

-cf

clears the user filters

-cgroup

removes the specified user account from the group

-cpin

clears the PIN for the user account from the BlackBerry Enterprise
Server

Use this parameter with the BlackBerry


Enterprise Server for Microsoft Exchange,
and the BlackBerry Enterprise Server for
Novell GroupWise only.

-cs

clears the account statistics of an existing user account

By default, when you add a user account,


the BlackBerry Enterprise Server User
Administration Tool reads the existing
statistics for the user account.

-dm

makes the BlackBerry MDS Services unavailable

-dr

turns off message and folder redirection

-em

makes the BlackBerry MDS Connection Service available

-er

turns on message and folder redirection

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.

-g <group_name>

specifies the name of the group on which to perform the action

This parameter overrides the -u and -b


parameters.

-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)

-infofile <filename>

overrides the enterprise activation email values (use only with


-wrandom); the file uses the following format; in the <value> of the
body, the tool replaces $p by the password and $x by the expiry
time:

[Subject=<value>]
{[[Body=]<value>]}

48

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.

BlackBerry Enterprise Server User Administration Tool

Use with

Description

Notes

-it_policy
<policy_name>

specifies the name of the IT policy to apply to the user account

A list of valid IT policies is available in the


BlackBerry Manager. You can also obtain
the list if you run the BlackBerry Enterprise
Server User Administration Tool client with
the -list it_policies parameter.

-n <network_address>

specifies the network address (IP address or computer host name) of Use this parameter only if the BlackBerry
the computer on which the BlackBerry Enterprise Server User
Enterprise Server User Administration Tool
Administration Tool service runs
client and the BlackBerry Enterprise Server
User Administration Tool service do not run
on the same computer.

-pimaddr
specifies the BlackBerry Enterprise Server name and the relative path Use this parameter with the BlackBerry
<servername>!!<datapa to the IBM Lotus Notes Data folder for storing the organizer data Enterprise Server for IBM Lotus Domino
address book when you add a user account
only.
th>
-pimmemo
specifies the BlackBerry Enterprise Server name and the relative path Use this parameter with the BlackBerry
<servername>!!<datapa to the IBM Lotus Notes Data folder for storing the memo database
Enterprise Server for IBM Lotus Domino
when you add a user account
only.
th>
-purge_pending_
messages

specifies the user account from which to purge pending messages

-u <user_name>

specifies the user account on which to perform the action

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.

Microsoft Exchange: mailbox name; for example,


cwarren@test.rim.net
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; for
example, 20587AB9

-w <password>

specifies the password for wireless activation

-wrandom

generates and emails a random enterprise activation password, in the The tool does not accept this parameter
form of eight lower case characters in the range a-z; the default
when adding a list of users.
format for the email message follows, where the tool replaces $p
with the password and $x with the expiry time:

SUBJECT=BlackBerry enterprise activation password


BODY=Hello,
To activate your BlackBerry device over the wireless network, in the
device Options screen select Enterprise Activation. In that screen,
enter your corporate email address and the following password:
$p
This password will expire in $x hours.
-wt <password_expiry_ specifies a password expiration time, in hours (between 1 and 720);
the default expiration time is 48 hours
time>

Use this parameter with the -w parameter


or the -wrandom parameter.

49

User Guide for the BlackBerry Enterprise Server User Administration Tool

-delete
Use the -delete parameter to delete a user account from the BlackBerry Enterprise Server.
Use with

Description

-b

specifies the BlackBerry Enterprise Server service name on which to


<BlackBerry_Enterprise perform the action
_Server_name>

Notes
For the name of the BlackBerry Enterprise
Server, use the name as it appears in the
BlackBerry Manager, on the Servers tab in
the Service Name column.

-f

removes all user account information

-hard

removes a user account, even if the tool does not find the mailbox

Use this parameter with the BlackBerry


Enterprise Server for Microsoft Exchange
only.

-i <filename.txt>

specifies the name of the newline delimited input file; use the
following format:

This parameter overrides the -u and -b


parameters.

<username>, <BlackBerryEnterpriseServerservice_name>
-n <network_address>

specifies the network address (IP address or computer host name) of Use this parameter only if the BlackBerry
the computer on which the BlackBerry Enterprise Server User
Enterprise Server User Administration Tool
Administration Tool service runs
client and the BlackBerry Enterprise Server
User Administration Tool service do not run
on the same computer.

-u <user_name>

specifies the user account on which to perform the action

Microsoft Exchange: mailbox name; for example,


cwarren@test.rim.net
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

-find
Use the -find parameter to find a user account in a BlackBerry Domain.
Use with

Description

-n <network_address>

specifies the network address (IP address or computer host name) of Use this parameter only if the BlackBerry
the computer on which the BlackBerry Enterprise Server User
Enterprise Server User Administration Tool
Administration Tool service runs
client and the BlackBerry Enterprise Server
User Administration Tool service do not run
on the same computer.

-u <user_name>

specifies the user account on which to perform the action

50

Microsoft Exchange: mailbox name; for example,


cwarren@test.rim.net
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

Notes

BlackBerry Enterprise Server User Administration Tool

-handheld_info
Use the -handheld_info parameter to display BlackBerry device statistics and applications.
Use with

Description

Notes

-apps

lists the applications on a BlackBerry device; when using -i, use the
following format for the input file:

If you use -i with -apps, it overrides the -u


and -b parameters

<username>,<BlackBerryEnterpriseServer_name>
-appname

specifies the application name to display

-appsfull

lists the applications in verbose detail for a user account

-b

specifies the BlackBerry Enterprise Server service name on which to For the name of the BlackBerry Enterprise
Server, use the name as it appears in the
<BlackBerry_Enterprise perform the action
BlackBerry Manager, on the Servers tab in
_Server_name>
the Service Name column.
-hhstats

displays the BlackBerry device statistics; use with the following


parameters:

If you use -i with -hhstats, it overrides -u, b, -g, and -users parameters.

-u <user_name> -b <BlackBerry_Enterprise_Server_name> to
display statistics for one user account
-users to display statistics for all users
-g <group_name> -b <BlackBerry_Enterprise_Server_name> to
display statistics for a specific group
-i <input_file_name> to specify a number of user accounts; use
the following format:
<username>,<BlackBerryEnterpriseServer_name>

-i <filename.txt>

specifies the name of the newline delimited input file to use with
either -apps or -hhstats; use the following format:

When used with -apps, this parameter


overrides the -u and -b parameters.

<username>, <BlackBerryEnterpriseServerservice_name>

When used with -hhstats, this parameter


overrides the -u, -b, -g, and -users
parameters.

-modules

specifies the module or .cod file to display

-n <network_address>

specifies the network address (IP address or computer host name) of Use this parameter only if the BlackBerry
the computer on which the BlackBerry Enterprise Server User
Enterprise Server User Administration Tool
Administration Tool service runs
client and the BlackBerry Enterprise Server
User Administration Tool service do not run
on the same computer.

-u <user_name>

specifies the user account on which to perform the action

Microsoft Exchange: mailbox name; for example,


cwarren@test.rim.net
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

51

User Guide for the BlackBerry Enterprise Server User Administration Tool

-kill_handheld
Use the -kill_handheld parameter to delete data from the BlackBerry device and make the Blackberry device
unavailable.
Use with

Description

Notes

-b

specifies the BlackBerry Enterprise Server service name on which to For the name of the BlackBerry Enterprise
Server, use the name as it appears in the
<BlackBerry_Enterprise perform the action
BlackBerry Manager, on the Servers tab in
_Server_name>
the Service Name column.
-u <user_name>

specifies the user account on which to perform the action

Microsoft Exchange: mailbox name; for example,


cwarren@test.rim.net
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

-list
Use the -lists parameter to list folder information, groups, IT policies and rules.
Use with

Description

-appconpolicies

lists the applications that control policies

Notes

-appconpolicy
<policy_name>

lists the details about <policy_name>

-b

specifies the BlackBerry Enterprise Server service name on which to For the name of the BlackBerry Enterprise
Server, use the name as it appears in the
<BlackBerry_Enterprise perform the action
BlackBerry Manager, on the Servers tab in
_Server_name>
the Service Name column.
-folders

lists the folder name and redirection states

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.

-groups

lists the groups in the BlackBerry Domain

-it_policies

specifies which IT policies in the BlackBerry Configuration Database


to display

-it_policy
<policy_name>

specifies the name of the IT policy to apply to the user account

-swconfigs

lists the software configurations available

-sw <config_name>

lists information about the software configuration <config_name>

52

A list of valid IT policies is available in the


BlackBerry Manager. You can also obtain
the list if you run the BlackBerry
Enterprise Server User Administration Tool
client with the -list it_policies parameter.

BlackBerry Enterprise Server User Administration Tool

-it_policy
Use the -it_policy parameter to list the IT policy rules for a particular IT policy.
Use with

Description

-it_policy_rules
<policy_name>

lists the IT policy rules for a particular IT policy

-u <user_name>

specifies the user account on which to perform the action

Notes

Microsoft Exchange: mailbox name; for example,


cwarren@test.rim.net
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

-move
Use the -move parameter to move a user account to another BlackBerry Enterprise Server.
Use with

Description

Notes

-b

specifies the BlackBerry Enterprise Server service name from which to For the name of the BlackBerry Enterprise
Server, use the name as it appears in the
<BlackBerry_Enterprise move the account
BlackBerry Manager, on the Servers tab in
_Server_name>
the Service Name column.
[-i <filename.txt>]

specifies the name of the newline delimited input file; use the
following format:

This parameter overrides the -u, -b, -pin,


and -t parameters.

<username>, <sourceBlackBerryEnterpriseServerservicename>,
<targetBlackBerryEnterpriseServerservicename>[,<PIN>]
[-pin <PIN>]

specifies the PIN for this user

-t
specifies the BlackBerry Enterprise Server service name to which to
<BlackBerry_Enterprise move the account
_Server_name>
-u <user_name>

specifies the user account on which to perform the action

For the name of the BlackBerry Enterprise


Server, use the name as it appears in the
BlackBerry Manager, on the Servers tab in
the Service Name column.

Microsoft Exchange: mailbox name; for example,


cwarren@test.rim.net
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

53

User Guide for the BlackBerry Enterprise Server User Administration Tool

-resend_peer_to_peer_key
Use the -resend_peer_to_peer_key parameter to resend a peer-to-peer encryption key to the BlackBerry device.
Use with

Description

Notes

-b

specifies the BlackBerry Enterprise Server service name on which to For the name of the BlackBerry Enterprise
Server, use the name as it appears in the
<BlackBerry_Enterprise perform the action
BlackBerry Manager, on the Servers tab in
_Server_name>
the Service Name column.
-i <filename.txt>

specifies the name of the newline delimited input file; use the
following format:

This parameter overrides the -u and -b


parameters.

<username>, <BlackBerryEnterpriseServer_name>
-u <user_name>

specifies the user account on which to perform the action

Microsoft Exchange: mailbox name; for example,


cwarren@test.rim.net
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

-resend_service_book
Use the resend_service_book parameter to resend a service book to the BlackBerry device.
Use with

Description

Notes

-b

specifies the BlackBerry Enterprise Server service name on which to For the name of the BlackBerry Enterprise
Server, use the name as it appears in the
<BlackBerry_Enterprise perform the action
BlackBerry Manager, on the Servers tab in
_Server_name>
the Service Name column.
-i <filename.txt>

specifies the name of the newline delimited input file; use the
following format:

This parameter overrides the -u and -b


parameters.

<username>, <BlackBerryEnterpriseServer_name>
-u <user_name>

specifies the user account on which to perform the action

54

Microsoft Exchange: mailbox name; for example,


cwarren@test.rim.net
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

BlackBerry Enterprise Server User Administration Tool

-send_email
Use the -send_email parameter to send a message to the BlackBerry device.
Use with

Description

-b

specifies the BlackBerry Enterprise Server service name on which to


<BlackBerry_Enterprise perform the action
_Server_name>

Notes
For the name of the BlackBerry Enterprise
Server, use the name as it appears in the
BlackBerry Manager, on the Servers tab in
the Service Name column.

-body <body_text>

specifies the body of the email message

-g <group_name>

specifies the name of the group on which to perform the action

This parameter overrides the -u and -b


parameters.

-i <filename.txt>

specifies the name of the newline delimited input file; use the
following format:

This parameter overrides the -u, -b, and -g


parameters.

<username>, <BlackBerryEnterpriseServer_name>
-infofile <infofile.txt>

specifies the name of the file that contains the owner information;
enables you to insert line breaks in the owner information; use the
following format:

This parameter overrides the -subject and


-body parameters.

Subject= <value>
Body= <value>
-subject <subject>

specifies the subject of the email message

-u <user_name>

specifies the user account on which to perform the action

Microsoft Exchange: mailbox name; for example,


cwarren@test.rim.net
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

55

User Guide for the BlackBerry Enterprise Server User Administration Tool

-send_pin
Use the -send_pin parameter to send a PIN message to the BlackBerry device.
Use with

Description

Notes

-b

specifies the BlackBerry Enterprise Server service name on which to For the name of the BlackBerry Enterprise
Server, use the name as it appears in the
<BlackBerry_Enterprise perform the action
BlackBerry Manager, on the Servers tab in
_Server_name>
the Service Name column.
-body <body_text>

specifies the body of the PIN message

-g <group_name>

specifies the name of the group on which to perform the action

This parameter overrides the -u and -b


parameters.

-i <filename.txt>

specifies the name of the newline delimited input file; use the
following format:

This parameter overrides the -u, -b, and -g


parameters.

<username>, <BlackBerryEnterpriseServer_name>
-infofile <infofile.txt>
use the following format:
Subject= <value>
Body= <value>

specifies the name of the file that contains the owner information;
enables you to insert line breaks in the owner information

This parameter overrides the -subject and


-body parameters.

-subject <subject>

specifies the subject of the PIN message

-u <user_name>

specifies the user account on which to perform the action

Microsoft Exchange: mailbox name; for example,


cwarren@test.rim.net
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

-set_folder_redirection
Use the -set_folder_redirection parameter to turn on or turn off folder redirection for a user account.
Use with

Description

Notes

-b

specifies the BlackBerry Enterprise Server service name on which to For the name of the BlackBerry Enterprise
Server, use the name as it appears in the
<BlackBerry_Enterprise perform the action
BlackBerry Manager, on the Servers tab in
_Server_name>
the Service Name column.
-dr

56

turns off message and folder redirection

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.

BlackBerry Enterprise Server User Administration Tool

Use with

Description

Notes

-er

turns on message and folder redirection

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.

-foldername
<folder_name>

specifies the name of the folder on which to perform the action

-u <user_name>

specifies the user account on which to perform the action

Microsoft Exchange: mailbox name; for example,


cwarren@test.rim.net
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

-set_owner_info
Use the -set_owner_info parameter to specify the owner information that displays on the BlackBerry device.
Use with

Description

Notes

-b

specifies the BlackBerry Enterprise Server service name on which to For the name of the BlackBerry Enterprise
Server, use the name as it appears in the
<BlackBerry_Enterprise perform the action
BlackBerry Manager, on the Servers tab in
_Server_name>
the Service Name column.
-i <filename.txt>

specifies the name of the newline delimited input file; use the
following format:

This parameter overrides the -u, -b, -info,


-infofile, and -name parameters.

<username>,
<BlackBerryEnterpriseServer>[,<name>[,<info>[,<infofile>]]]
-info <info>

specifies the owner information for a BlackBerry device

-infofile <infofile.txt>

specifies the name of the file that contains the owner information;
enables you to insert line breaks in the owner information

-name <name>

specifies the user name to appear on the BlackBerry device

-u <user_name>

specifies the user account on which to perform the action

This parameter overrides the -subject and


-body parameters.

Microsoft Exchange: mailbox name; for example,


cwarren@test.rim.net
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

57

User Guide for the BlackBerry Enterprise Server User Administration Tool

-set_password
Use the -set_password parameter to set a password for a BlackBerry device.
Use with

Description

Notes

-b

specifies the BlackBerry Enterprise Server service name on which to For the name of the BlackBerry Enterprise
Server, use the name as it appears in the
<BlackBerry_Enterprise perform the action
BlackBerry Manager, on the Servers tab in
_Server_name>
the Service Name column.
-u <user_name>

specifies the user account on which to perform the action

Microsoft Exchange: mailbox name; for example,


cwarren@test.rim.net
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

-set_user_itpolicy_rule
Use the -set_user_itpolicy_rule parameter to set an IT policy rule for a user account.
Use with

Description

Notes

-b

specifies the BlackBerry Enterprise Server service name on which to For the name of the BlackBerry Enterprise
Server, use the name as it appears in the
<BlackBerry_Enterprise perform the action
BlackBerry Manager, on the Servers tab in
_Server_name>
the Service Name column.
-policyrule
<policy_rule_name>

specifies the IT policy rule name in the IT policy

-policyvalue <value>

specifies the value for the specified IT policy rule

-u <user_name>

specifies the user account on which to perform the action

58

Microsoft Exchange: mailbox name; for example,


cwarren@test.rim.net
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

BlackBerry Enterprise Server User Administration Tool

-stats
Use the -stats parameter to obtain the BlackBerry Enterprise Server and user account statistics.
Use with

Description

-b

specifies the BlackBerry Enterprise Server service name on which to


<BlackBerry_Enterprise perform the action
_Server_name>
-g <group_name> -b
lists the BlackBerry Enterprise Server, group, and user account
<BlackBerry_Enterprise statistics
_Server_name>
-i <filename.txt>

specifies the name of the newline delimited input file; use the
following format:

Notes
For the name of the BlackBerry Enterprise
Server, use the name as it appears in the
BlackBerry Manager, on the Servers tab in
the Service Name column.

This parameter overrides the -u, -b, and -g


parameters.

[<username>,]<BlackBerryEnterpriseServer_name>
-o <filename.txt>

writes the output to the file named by filename.txt; by default, the


output is displayed on the screen

-servers

specifies all BlackBerry Enterprise Server instances

-u <user_name>

specifies the user account on which to perform the action

-users -g
<group_name>

Microsoft Exchange: mailbox name; for example,


cwarren@test.rim.net
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

specifies all user accounts in the specified group

-status
Use the -status parameter to display the BlackBerry Enterprise Server User Administration Tool service status.

59

User Guide for the BlackBerry Enterprise Server User Administration Tool

Error codes for the BlackBerry Enterprise Server User


Administration Tool
Error code Error message

Description of error message

Environment

-2

Service busy adding

The BlackBerry Enterprise Server User Administration Tool is


adding user accounts.

Microsoft Exchange

-3

Service busy deleting

The BlackBerry Enterprise Server User Administration Tool is


removing user accounts.

Microsoft Exchange

-4

Service busy initializing

The BlackBerry Enterprise Server User Administration Tool


service is starting.

Microsoft Exchange

-5

No profile for server

The MAPI profile for the specified BlackBerry Enterprise Server Microsoft Exchange
does not exist.

-6

Problem retrieving ServerDN

The BlackBerry Enterprise Server User Administration Tool


could not retrieve the distinguished name of the messaging
server.

Microsoft Exchange

-7

MAPILOGON failed

The BlackBerry Enterprise Server User Administration Tool


service could not log in to the MAPI subsystem.

Microsoft Exchange

-8

GETMSGSTORESTABLE failed

The BlackBerry Enterprise Server User Administration Tool


could not retrieve the message stores table.

Microsoft Exchange

-9

HRQUERYALLROWS failed

The BlackBerry Enterprise Server User Administration Tool


could not query all message stores.

Microsoft Exchange

-10

OPENMSGSTORE failed

The BlackBerry Enterprise Server User Administration Tool


could not open the message store.

Microsoft Exchange

-11

No default MSGSTORE found

The BlackBerry Enterprise Server User Administration Tool


could not find the message store.

Microsoft Exchange

-12

QUERYINTERFACE failed

The BlackBerry Enterprise Server User Administration Tool


could not query the message store.

Microsoft Exchange

-13

CREATEPMDATABASE failed

The BlackBerry Enterprise Server User Administration Tool


could not retrieve settings for the user account.

Microsoft Exchange

-14

Open server database failed

The BlackBerry Enterprise Server User Administration Tool


could not open the BlackBerry Configuration Database.

Microsoft Exchange

-15

Open address book failed

The BlackBerry Enterprise Server 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 BlackBerry Enterprise Server User Administration Tool


could not open the server manager.

All

-18

Initialize failed

The BlackBerry Enterprise Server User Administration Tool


service could not start successfully.

All

-19

Get user info failed

The BlackBerry Enterprise Server 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

60

BlackBerry Enterprise Server User Administration Tool

Error code Error message

Description of error message

Environment

-22

Get user list failed

The BlackBerry Enterprise Server 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 BlackBerry Enterprise Server User Administration Tool is


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 BlackBerry Enterprise Server User Administration Tool


service is busy and cannot respond to the request from the
BlackBerry Enterprise Server User Administration Tool client.

All

-28

License count exceeded

The BlackBerry Enterprise Server User Administration Tool


could not add the user account. The license count for the
BlackBerry Enterprise Server is exceeded.

All

-30

Ambiguous mailbox name

The BlackBerry Enterprise Server User Administration Tool


could not retrieve information for the specified user account;
multiple user accounts are returned.

Microsoft Exchange

-31

MGMT_DATABASE not found

The BlackBerry Enterprise Server User Administration Tool


service could not connect to the BlackBerry Configuration
Database.

All

-32

License key not found

The BlackBerry Enterprise Server 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 All
been exceeded.

-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 BlackBerry Enterprise Server User Administration Tool


could not remove the user account from the BlackBerry
Enterprise Server.

All

-40

Database update failed

The BlackBerry Enterprise Server User Administration Tool


could not update the BlackBerry Configuration Database.

All

-42

Load server failed

The BlackBerry Enterprise Server User Administration Tool


could not load information for the specified BlackBerry
Enterprise Server.

All

-43

Cannot get peer to peer key

The BlackBerry Enterprise Server User Administration Tool


could not retrieve the peer-to-peer encryption key.

All

61

User Guide for the BlackBerry Enterprise Server User Administration Tool

Error code Error message

Description of error message

-44

ITPolicy does not exist

The specified IT policy does not exist in the BlackBerry Domain. All

Environment

-45

Failed to set OTA password in


database

The BlackBerry Enterprise Server User Administration Tool


could not set the enterprise activation password.

All

-46

No results found

The BlackBerry Enterprise Server User Administration Tool


could not find the user account when it performed a -find user
task.

All

-47

Load user failed

The BlackBerry Enterprise Server User Administration Tool


could not load information for the specified user account.

All

-48

Could not open pager info

The BlackBerry Enterprise Server User Administration Tool


could not load information for the user account.

Microsoft Exchange

-49

An error occurred when setting the A problem occurred while the BlackBerry Enterprise Server User All
ITPolicy
Administration Tool was attempting to assign an IT policy to the
user account.

-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 BlackBerry Enterprise Server User Administration Tool


could not load the IT policies list.

All

-52

Invalid Microsoft SQL


authentication parameters

Authentication with the BlackBerry Configuration Database


using Microsoft SQL Server authentication is unsuccessful.

All

Verify that the correct parameters are specified for the


-sqluser or -sqlpass parameters.
-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 BlackBerry Enterprise Server User Administration Tool


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 All
established.

-60

Group does not exist

The specified group does not exist on the BlackBerry Enterprise All
Server.

-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
BlackBerry Enterprise Server User Administration Tool service
account.

All

-65

Client verification failed

All

62

A problem occurred when trying to authenticate the client.

BlackBerry Enterprise Server User Administration Tool

Error code Error message

Description of error message

Environment

-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 address book


location.

Microsoft Exchange

-69

PIM address book location change An error occurred while attempting to change a users address
failed
book location.

-70

PIM memo location change failed An error occurred while attempting to change the users memo IBM Lotus Domino
location.

-71

Submit message failed

An error occurred while attempting to send a message to a user Microsoft Exchange


account.
IBM Lotus Domino

-72

User does not have a valid PIN

The user account does not have a valid user account PIN.

-73

Submit message failed for all users An error occurred while attempting to send a message to
multiple user accounts.

Novell GroupWise
IBM Lotus Domino

Novell GroupWise
All
Microsoft Exchange
IBM Lotus Domino
Novell GroupWise
-74

Set address book subscribed


change failed

An error occurred while attempting to change the address book Novell GroupWise
subscription setting.

-75

Set address book subscribed


change not supported

An attempt to change the address book subscription setting was Microsoft Exchange
unsuccessful because the task is not supported.
IBM Lotus Domino

-76

Purge pending messages failed

An error occurred while attempting to purge a pending message Microsoft Exchange


for a user account.
IBM Lotus Domino
Novell GroupWise

-77

Purge pending messages failed for An error occurred while attempting to purge a pending message Microsoft Exchange
all users
for a group.
IBM Lotus Domino

-78

The task is not supported by the


BlackBerry Enterprise Server for
MDS Applications

The specified task is not supported by the BlackBerry Enterprise MDS Applications
Server for MDS Applications.

-79

User PIN required

The users 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

Novell GroupWise

63

User Guide for the BlackBerry Enterprise Server User Administration Tool

Error code Error message

Description of error message

-85

Full erase not supported

The BlackBerry Enterprise Server for MDS Applications does not MDS Applications
support the full deletion of mailstore information.

Environment

-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 an IBM Lotus 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

-89

Folder synchronization
information not found in the
BlackBerry Configuration
Database.

An attempt to locate folder synchronization information in the


BlackBerry Configuration Database failed.

-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 The specified IT policy is not a per-user IT policy.
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 BlackBerry


Enterprise Server User Administration Tool 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 failed.

All

-98

Remote address book server not


supported

The address book entry specified could not be found.

All

-99

Email redirection disabled

Cannot set folder redirection because email redirection for the


user is turned off.

All

-100

Failed to display software


configurations

An attempt to display the software configurations failed.

All

-101

No software configurations found An attempt to find the software configurations failed.

All

-102

Failed to display application


control policies

An attempt to display the application control policies failed.

All

-103

No application control policies


found

An attempt to find the application control policies failed.

All

64

Microsoft Exchange
IBM Lotus Domino
Novell GroupWise

2008 Research In Motion Limited


Published in Canada.

You might also like