Professional Documents
Culture Documents
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.
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
-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 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
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
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.
BESUserAdminService.exe
CE.dll
ClientAuthentication8.dll
ServerAuthentication8.dll
BESUserAdminAudit.dll
BESUserAdminClient.exe (necessary if you run the client on the same computer as the service)
exchange
domino
groupwise
mdsapplications
11
User Guide for the BlackBerry Enterprise Server User Administration Tool
12
Steps
Type Y to start the service automatically; otherwise, type N. The default setting
is to start the service manually.
>
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.
>
Type 1 to use a Microsoft SQL Server; type 2 to use an IBM DB2 UDB server.
>
Type the IBM DB2 UDB schema name. By default, the database schema name
is BESADMIN.
Type the IBM DB2 UDB port number. By default, the port number is 50000.
>
Task
Steps
Type Y to confirm the database authentication user name and password that
the BlackBerry Enterprise Server User Administration Tool service detects.
1.
>
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.
>
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.
>
>
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
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.
Steps
1.
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.
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.
Change the BlackBerry Enterprise Server User Administration Tool service to log in using a
local system account
1.
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
Reactivate the client password without restarting the BlackBerry Enterprise Server User Administration Tool
service.
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.
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
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.
-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>
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
-p <client_password>
-u <user_name>
-b <BlackBerry_Enterprise_Server_service_name>
-group <group_name>
See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for
more information.
18
Example: Adding a user account to a BlackBerry Enterprise Server for Microsoft Exchange, a group, and an IT policy
-p <client_password>
-u <user_name>
-b <BlackBerry_Enterprise_Server_service_name>
-group <group_name>
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
-p <client_password>
-u <user_name>
-b <BlackBerry_Enterprise_Server_service_name>
19
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: Removing a user from the BlackBerry Enterprise Server for Microsoft Exchange
-p <client_password>
-u <user_name>
-b <BlackBerry_Enterprise_Server_service_name>
-cgroup
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
20
-p <client_password>
-u <user_name>
-b <source_BlackBerry_Enterprise_Server_service_name>
-t <target_BlackBerry_Enterprise_Server_service_name>
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
-p <client_password>
-u <user_name>
-b <BlackBerry_Enterprise_Server_service_name>
-group <group_name>
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
User Guide for the BlackBerry Enterprise Server User Administration Tool
-p <client_password>
-u <user_name>
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
-p <client_password>
-u <user_name>
-b <BlackBerry_Enterprise_Server_service_name>
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
22
Example: Making the BlackBerry MDS Connection Service unavailable, changing the password, and specifying the
password expiry time for the user account
2. Type besuseradminclient -assign_swconfig -sw <configuration name> and the following parameters:
-p <client_password>
-u <user_name>
-b <BlackBerry_Enterprise_Server_service_name>
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
-p <client_password>
-u <user_name>
-b <BlackBerry_Enterprise_Server_service_name>
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: Removing a user account from a software configuration
-p <client_password>
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
24
-p <client_password>
-u <user_name>
-b <BlackBerry_Enterprise_Server_service_name>
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
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>
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
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.
-p <client_password>
-u <user_name>
-b <BlackBerry_Enterprise_Server_service_name>
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
-p <client_password>
-u <user_name>
-b <BlackBerry_Enterprise_Server_service_name>
See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for
more information.
26
-p <client_password>
-u <user_name>
-b <BlackBerry_Enterprise_Server_service_name>
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
-p <client_password>
-u <user_name>
-b <BlackBerry_Enterprise_Server_service_name>
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
-p <client_password>
-u <user_name>
-b <BlackBerry_Enterprise_Server_service_name>
-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
28
Description
User name
MailBoxDN
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
Device Type
State
Message Server
Forwarded
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
Status
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 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.
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
BlackBerry MDS
Connection Service
OTA Calendar
ITPolicy name
ITPolicy status
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
Wireless Message
Reconciliation
Creation Time
time that the BlackBerry device user account was created on the BlackBerry Enterprise Server
expiry time of the enterprise activation password if the password is set; otherwise,N/A appears
Encryption Type
Service Name
name of the BlackBerry Enterprise Server on which the user account is located
Group Name
Platform: This column does not apply to the BlackBerry Enterprise Server for MDS Applications.
-p <client_password>
-u <user_name>
-b <BlackBerry_Enterprise_Server_service_name>
See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for
more information.
Example: Clearing user account statistics
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>
-b <BlackBerry_Enterprise_Server_service_name>
-subject <subject_line_text>
-body <message_body_text>
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
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>
-b <BlackBerry_Enterprise_Server_service_name>
-subject <subject_line_text>
-body <message_body_text>
31
User Guide for the BlackBerry Enterprise Server User Administration Tool
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
-p <client_password>
-u <user_name>
-b <BlackBerry_Enterprise_Server_service_name>
-er
See Parameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for
more information.
32
-p <client_password>
-u <user_name>
-b <BlackBerry_Enterprise_Server_service_name>
-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
-p <client_password>
-u <user_name>
-b <BlackBerry_Enterprise_Server_service_name>
33
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: Listing the folders available for redirection
-p <client_password>
-u <user_name>
-b <BlackBerry_Enterprise_Server_service_name>
-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
34
-p <client_password>
-u <user_name>
-b <BlackBerry_Enterprise_Server_service_name>
-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
-p <client_password>
-u <user_name>
-b <BlackBerry_Enterprise_Server_service_name>
35
User Guide for the BlackBerry Enterprise Server User Administration Tool
-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
-p <client_password>
-u <user_name>
-b <BlackBerry_Enterprise_Server_service_name>
-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
36
-p <client_password>
-u <user_name>
-b <BlackBerry_Enterprise_Server_service_name>
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
-p <client_password>
-u <user_name>
-b <BlackBerry_Enterprise_Server_service_name>
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
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
Example: Viewing the applications available for multiple BlackBerry devices using an input file
-p <client_password>
-u <user_name>
-b <BlackBerry_Enterprise_Server_service_name>
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
38
-p <client_password>
-u <user_name>
-b <BlackBerry_Enterprise_Server_service_name>
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
Description
User Name
PIN
Service Name
Platform Version
BlackBerry Version
Phone Number
Serial Number
Active Carrier
Home Carrier
the initial wireless service provider to which the BlackBerry device was assigned
Security Password
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
Direct Connect ID
IT Policy Name
IT Policy Time
time that the BlackBerry Enterprise Server last sent the IT policy to the BlackBerry device
Configuration Name
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
Available Space
39
User Guide for the BlackBerry Enterprise Server User Administration Tool
Column
Description
Battery Level
Uptime
List the modules and .cod files that are available on a BlackBerry device
1.
-p <client_password>
-u <user_name>
-b <BlackBerry_Enterprise_Server_service_name>
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
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>
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
41
User Guide for the BlackBerry Enterprise Server User Administration Tool
Description
Server Name
Server Status
SRP Status
# Users
Forwarded
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.
PID
Platform
Server Version
-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
42
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
BESUserAdminAudit.dll
ClientAuthentication8.dll
ServerAuthentication8.dll
4. In the Microsoft Windows Services window, start 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
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.
Description
-?
Notes
2> <filename.txt>
redirects text that displays on the screen to the specified text file
-help <command>
-o <outputfilename>
-p <clientpassword>
-sqluser
<database_user_name
>
-sqlpass
<database_password>
-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>
-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
45
User Guide for the BlackBerry Enterprise Server User Administration Tool
Use with
Description
Notes
-domaddrsvr
<servername>
-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>]
[Subject=<value>]
{[[Body=]<value>]}
-it_policy
<policy_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.
-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>
-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>
-u <user_name>
-w <password>
46
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
-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
-g <group_name>
-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.
<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>
-u <user_name>
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>
-b
-cf
-cgroup
-cpin
clears the PIN for the user account from the BlackBerry Enterprise
Server
-cs
-dm
-dr
-em
-er
-g <group_name>
-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>
[Subject=<value>]
{[[Body=]<value>]}
48
Use with
Description
Notes
-it_policy
<policy_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.
-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
-u <user_name>
-w <password>
-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:
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
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
-hard
removes a user account, even if the tool does not find the mailbox
-i <filename.txt>
specifies the name of the newline delimited input file; use the
following format:
<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>
-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>
50
Notes
-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:
<username>,<BlackBerryEnterpriseServer_name>
-appname
-appsfull
-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
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:
<username>, <BlackBerryEnterpriseServerservice_name>
-modules
-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>
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>
-list
Use the -lists parameter to list folder information, groups, IT policies and rules.
Use with
Description
-appconpolicies
Notes
-appconpolicy
<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
-groups
-it_policies
-it_policy
<policy_name>
-swconfigs
-sw <config_name>
52
-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>
-u <user_name>
Notes
-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:
<username>, <sourceBlackBerryEnterpriseServerservicename>,
<targetBlackBerryEnterpriseServerservicename>[,<PIN>]
[-pin <PIN>]
-t
specifies the BlackBerry Enterprise Server service name to which to
<BlackBerry_Enterprise move the account
_Server_name>
-u <user_name>
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:
<username>, <BlackBerryEnterpriseServer_name>
-u <user_name>
-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:
<username>, <BlackBerryEnterpriseServer_name>
-u <user_name>
54
-send_email
Use the -send_email parameter to send a message to the BlackBerry device.
Use with
Description
-b
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>
-g <group_name>
-i <filename.txt>
specifies the name of the newline delimited input file; use the
following format:
<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:
Subject= <value>
Body= <value>
-subject <subject>
-u <user_name>
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>
-g <group_name>
-i <filename.txt>
specifies the name of the newline delimited input file; use the
following format:
<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
-subject <subject>
-u <user_name>
-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
Use with
Description
Notes
-er
-foldername
<folder_name>
-u <user_name>
-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:
<username>,
<BlackBerryEnterpriseServer>[,<name>[,<info>[,<infofile>]]]
-info <info>
-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>
-u <user_name>
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>
-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>
-policyvalue <value>
-u <user_name>
58
-stats
Use the -stats parameter to obtain the BlackBerry Enterprise Server and user account statistics.
Use with
Description
-b
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.
[<username>,]<BlackBerryEnterpriseServer_name>
-o <filename.txt>
-servers
-u <user_name>
-users -g
<group_name>
-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
Environment
-2
Microsoft Exchange
-3
Microsoft Exchange
-4
Microsoft Exchange
-5
The MAPI profile for the specified BlackBerry Enterprise Server Microsoft Exchange
does not exist.
-6
Microsoft Exchange
-7
MAPILOGON failed
Microsoft Exchange
-8
GETMSGSTORESTABLE failed
Microsoft Exchange
-9
HRQUERYALLROWS failed
Microsoft Exchange
-10
OPENMSGSTORE failed
Microsoft Exchange
-11
Microsoft Exchange
-12
QUERYINTERFACE failed
Microsoft Exchange
-13
CREATEPMDATABASE failed
Microsoft Exchange
-14
Microsoft Exchange
-15
Microsoft Exchange
-16
MAPIALLOCATERBUFFER failed
Microsoft Exchange
-17
All
-18
Initialize failed
All
-19
All
-20
User exists
All
-21
All
60
Environment
-22
Microsoft Exchange
-23
All
-24
All
-25
All
-26
No session ID
All
-27
Service busy
All
-28
All
-30
Microsoft Exchange
-31
All
-32
All
-33
The user license count for the BlackBerry Enterprise Server has All
been exceeded.
-34
All
-35
All
-36
All
-37
Invalid password
All
-38
All
-39
REMOVEPAGER failed
All
-40
All
-42
All
-43
All
61
User Guide for the BlackBerry Enterprise Server User Administration Tool
-44
The specified IT policy does not exist in the BlackBerry Domain. All
Environment
-45
All
-46
No results found
All
-47
All
-48
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
-51
All
-52
All
Insufficient permissions
The current user role does not have permission to perform the
action.
All
-54
All
-55
All
-56
All
-57
All
-58
All
-59
A secure connection between the client and server could not be All
established.
-60
The specified group does not exist on the BlackBerry Enterprise All
Server.
-61
All
-62
All
-63
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
All
62
Environment
-66
All
-67
All
-68
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
-72
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
An error occurred while attempting to change the address book Novell GroupWise
subscription setting.
-75
An attempt to change the address book subscription setting was Microsoft Exchange
unsuccessful because the task is not supported.
IBM Lotus Domino
-76
-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 specified task is not supported by the BlackBerry Enterprise MDS Applications
Server for MDS Applications.
-79
MDS Applications
-80
MDS Applications
-81
MDS Applications
-82
MDS Applications
-83
MDS Applications
-84
MDS Applications
Novell GroupWise
63
User Guide for the BlackBerry Enterprise Server User Administration Tool
-85
The BlackBerry Enterprise Server for MDS Applications does not MDS Applications
support the full deletion of mailstore information.
Environment
-86
Microsoft Exchange
IBM Lotus Domino
Novell GroupWise
-87
-88
Microsoft Exchange
IBM Lotus Domino
Novell GroupWise
-89
Folder synchronization
information not found in the
BlackBerry Configuration
Database.
-90
All
-91
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
All
-94
MDS Applications
-95
MDS Applications
-96
All
-97
All
-98
All
-99
All
-100
All
-101
All
-102
All
-103
All
64
Microsoft Exchange
IBM Lotus Domino
Novell GroupWise