Upload
neilyw
View
215
Download
3
Tags:
Embed Size (px)
Citation preview
BlaVers
UseAdmckBerry Enterprise Server Resource Kit ion 4.1 Service Pack 5
r Guide for the BlackBerry Enterprise Server User inistration 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 num
At the tim
Send us y
2008 Rand logosaround th
IBM, DomGlobal SyMicrosoft
The Blackpatents, iD416,256RIM (as h
This docuwww.blacrepresentfor any tyconfidentreserves tany such
This docucomponeServices"accuracy,and Servithe Third
EXCEPT TGUARANCONDITIPURPOSFROM A OR PERFSERVICESSOME JUPERMITTBE EXCLUACQUIRE
TO THE MOF DAMAber: 15136533 version 10
e of publication, this documentation is based on BlackBerry Enterprise Server version 4.1 Service Pack 5.
our comments on product documentation: https://www.blackberry.com/DocsFeedback.
esearch In Motion Limited. All rights reserved. BlackBerry, RIM, Research In Motion, SureType and related trademarks, names, are the property of Research In Motion Limited and are registered and/or used as trademarks in the U.S., Canada, and countries e world.
ino, DB2, DB2 Universal Database, Lotus, and Lotus Notes are trademarks of International Business Machines Corporation. GSM and stem for Mobile Communication are trademarks of the GSM MOU Association. Microsoft, Windows, and SQL Server are trademarks of Corporation. Novell and GroupWise are trademarks of Novell, Inc. All other trademarks are the properties of their respective owners.
Berry smartphone and other devices and/or associated software are protected by copyright, international treaties, and various ncluding 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; . 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 ereinafter defined) patents.
mentation including all documentation incorporated by reference herein such as documentation provided or made available at kberry.com/go/docs is provided or made accessible "AS IS" and "AS AVAILABLE" and without condition, endorsement, guarantee, ation, or warranty of any kind by Research In Motion Limited and its affiliated companies ("RIM") and RIM assumes no responsibility pographical, technical, or other inaccuracies, errors, or omissions in this documentation. In order to protect RIM proprietary and ial information and/or trade secrets, this documentation may describe some aspects of RIM technology in generalized terms. RIM he right to periodically change information that is contained in this documentation; however, RIM makes no commitment to provide changes, updates, enhancements, or other additions to this documentation to you in a timely manner or at all.
mentation might contain references to third-party sources of information, hardware or software, products or services including nts and content such as content protected by copyright and/or third-party web sites (collectively the "Third Party Products and ). RIM does not control, and is not responsible for, any Third Party Products and Services including, without limitation the content, copyright compliance, compatibility, performance, trustworthiness, legality, decency, links, or any other aspect of Third Party Products ces. The inclusion of a reference to Third Party Products and Services in this documentation does not imply endorsement by RIM of Party Products and Services or the third party in any way.
O THE EXTENT SPECIFICALLY PROHIBITED BY APPLICABLE LAW IN YOUR JURISDICTION, ALL CONDITIONS, ENDORSEMENTS, TEES, REPRESENTATIONS, OR WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION, ANY ONS, ENDORSEMENTS, GUARANTEES, REPRESENTATIONS OR WARRANTIES OF DURABILITY, FITNESS FOR A PARTICULAR E OR USE, MERCHANTABILITY, MERCHANTABLE QUALITY, NON-INFRINGEMENT, SATISFACTORY QUALITY, OR TITLE, OR ARISING STATUTE OR CUSTOM OR A COURSE OF DEALING OR USAGE OF TRADE, OR RELATED TO THE DOCUMENTATION OR ITS USE, ORMANCE OR NON-PERFORMANCE OF ANY SOFTWARE, HARDWARE, SERVICE, OR ANY THIRD PARTY PRODUCTS AND
REFERENCED HEREIN, ARE HEREBY EXCLUDED. YOU MAY ALSO HAVE OTHER RIGHTS THAT VARY BY STATE OR PROVINCE. RISDICTIONS MAY NOT ALLOW THE EXCLUSION OR LIMITATION OF IMPLIED WARRANTIES AND CONDITIONS. TO THE EXTENT ED BY LAW, ANY IMPLIED WARRANTIES OR CONDITIONS RELATING TO THE DOCUMENTATION TO THE EXTENT THEY CANNOT
DED AS SET OUT ABOVE, BUT CAN BE LIMITED, ARE HEREBY LIMITED TO NINETY (90) DAYS FROM THE DATE YOU FIRST D THE DOCUMENTATION OR THE ITEM THAT IS THE SUBJECT OF THE CLAIM.
AXIMUM EXTENT PERMITTED BY APPLICABLE LAW IN YOUR JURISDICTION, IN NO EVENT SHALL RIM BE LIABLE FOR ANY TYPE GES 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 DOWNTICOST OFWHETHESUCH DA
TO THE MOR LIABILIABILITY
THE LIMIACTION,OR ANY PURPOSSUCCESSINCLUDI
IN ADDITDISTRIBURELATED
Prior to sprovider hmay requsolely resrequired have beeyou and aRIM and subject toexpressly
The termTHIS DOPORTION
Published
Research295 PhillWaterlooCanadaANY DATA, PROBLEMS ASSOCIATED WITH ANY APPLICATIONS USED IN CONJUNCTION WITH RIM PRODUCTS OR SERVICES, ME COSTS, LOSS OF THE USE OF RIM PRODUCTS OR SERVICES OR ANY PORTION THEREOF OR OF ANY AIRTIME SERVICES, SUBSTITUTE GOODS, COSTS OF COVER, FACILITIES OR SERVICES, COST OF CAPITAL, OR OTHER SIMILAR PECUNIARY LOSSES, R OR NOT SUCH DAMAGES WERE FORESEEN OR UNFORESEEN, AND EVEN IF RIM HAS BEEN ADVISED OF THE POSSIBILITY OF MAGES.
AXIMUM EXTENT PERMITTED BY APPLICABLE LAW IN YOUR JURISDICTION, RIM SHALL HAVE NO OTHER OBLIGATION, DUTY, LITY WHATSOEVER IN CONTRACT, TORT, OR OTHERWISE TO YOU INCLUDING ANY LIABILITY FOR NEGLIGENCE OR STRICT .
TATIONS, EXCLUSIONS, AND DISCLAIMERS HEREIN SHALL APPLY: (A) IRRESPECTIVE OF THE NATURE OF THE CAUSE OF DEMAND, OR ACTION BY YOU INCLUDING BUT NOT LIMITED TO BREACH OF CONTRACT, NEGLIGENCE, TORT, STRICT LIABILITY OTHER LEGAL THEORY AND SHALL SURVIVE A FUNDAMENTAL BREACH OR BREACHES OR THE FAILURE OF THE ESSENTIAL E OF THIS AGREEMENT OR OF ANY REMEDY CONTAINED HEREIN; AND (B) TO RIM AND ITS AFFILIATED COMPANIES, THEIR ORS, ASSIGNS, AGENTS, SUPPLIERS (INCLUDING AIRTIME SERVICE PROVIDERS), AUTHORIZED RIM DISTRIBUTORS (ALSO
NG AIRTIME SERVICE PROVIDERS) AND THEIR RESPECTIVE DIRECTORS, EMPLOYEES, AND INDEPENDENT CONTRACTORS.
ION TO THE LIMITATIONS AND EXCLUSIONS SET OUT ABOVE, IN NO EVENT SHALL ANY DIRECTOR, EMPLOYEE, AGENT, TOR, SUPPLIER, INDEPENDENT CONTRACTOR OF RIM OR ANY AFFILIATES OF RIM HAVE ANY LIABILITY ARISING FROM OR
TO THE DOCUMENTATION.
ubscribing for, installing, or using any Third Party Products and Services, it is your responsibility to ensure that your airtime service as agreed to support all of their features. Installation or use of Third Party Products and Services with RIM's products and services
ire one or more patent, trademark, copyright, or other licenses in order to avoid infringement or violation of third party rights. You are ponsible for determining whether to use Third Party Products and Services and if any third party licenses are required to do so. If you are responsible for acquiring them. You should not install or use Third Party Products and Services until all necessary licenses n acquired. Any Third Party Products and Services that are provided with RIM's products and services are provided as a convenience to re provided "AS IS" with no express or implied conditions, endorsements, guarantees, representations, or warranties of any kind by
RIM assumes no liability whatsoever, in relation thereto. Your use of Third Party Products and Services shall be governed by and you agreeing to the terms of separate licenses and other agreements applicable thereto with third parties, except to the extent
covered by a license or other agreement with RIM.
s of use of any RIM product or service are set out in a separate license or other agreement with RIM applicable thereto. NOTHING IN CUMENTATION IS INTENDED TO SUPERSEDE ANY EXPRESS WRITTEN AGREEMENTS OR WARRANTIES PROVIDED BY RIM FOR S OF ANY RIM PRODUCT OR SERVICE OTHER THAN THIS DOCUMENTATION.
in Canada
In Motion Limited ip Street , ON N2L 3W8
Research In Motion UK Limited 200 Bath Road Slough, Berkshire SL1 3XE United Kingdom
ContentsBlackBerry Enterprise Server User Administration Tool ...............................................................................9
BlackBerry Enterprise Server User Administration Tool overview ............................................................ 9Requirements and considerations .........................................................................................................10
Download the BlackBerry Enterprise Server Resource Kit files.................................................................11Installing the BlackBerry Enterprise Server User Administration Tool ....................................................11
Install the BlackBerry Enterprise Server User Administration Tool service .....................................11BlackBerry Enterprise Server User Administration Tool service log files ........................................14BlackBerry Enterprise Server User Administration Tool audit log files............................................14Prepare to run the BlackBerry Enterprise Server User Administration Tool client ........................14Specify a local system account to run the BlackBerry Enterprise Server User Administration Tool15Client password authentication .............................................................................................................16BlackBerry Enterprise Server User Administration Tool authentication for role-based administra-tion..............................................................................................................................................................16
Managing user accounts................................................................................................................................. 17Add a user account to the BlackBerry Enterprise Server.................................................................... 17Add a user account to a group................................................................................................................18Add an existing user account to a group ..............................................................................................19Remove a user account from the BlackBerry Enterprise Server........................................................19Remove a user account from a group...................................................................................................20Move a user account to a different BlackBerry Enterprise Server ...................................................20Move a user account to a different group............................................................................................. 21Find a user account on a BlackBerry Enterprise Server...................................................................... 21Change user account settings ............................................................................................................... 22Add a user account to a software configuration................................................................................. 23Remove a user account from a software configuration ..................................................................... 23List the groups in a BlackBerry Domain............................................................................................... 24
Managing BlackBerry devices....................................................................................................................... 24Set the BlackBerry device password..................................................................................................... 24Set owner information on a BlackBerry device ................................................................................... 25Delete data from the BlackBerry device memory and make the BlackBerry device unavailable26Purge pending messages .......................................................................................................................26Resend 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............................................................................................................... 28Interpreting the results of a statistics query for a user account ......................................................29Clear user account statistics..................................................................................................................30
Sending notification messages to BlackBerry devices..............................................................................30Send a PIN message ...............................................................................................................................30Send an email message ...........................................................................................................................31
Managing email and folder redirection....................................................................................................... 32Turn on email redirection ....................................................................................................................... 32Turn off email redirection....................................................................................................................... 33List the folders available for redirection .............................................................................................. 33Turn on folder redirection ...................................................................................................................... 34Turn off folder redirection ...................................................................................................................... 35
Managing IT policies and IT policy rules ..................................................................................................... 35List the IT policy rules in an IT policy ................................................................................................... 35Set IT policy rules for a user account....................................................................................................36List the IT policies in the BlackBerry Configuration Database.........................................................36
Obtaining BlackBerry device information................................................................................................... 37List the applications that are available on one or more BlackBerry devices.................................. 37List the BlackBerry devices on which a specified application is installed ...................................... 38List the statistics for BlackBerry devices.............................................................................................. 38List the modules and .cod files that are available on a BlackBerry device .....................................40
Obtain BlackBerry Enterprise Server statistics ..........................................................................................40Interpreting 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 ................. 42Upgrade the BlackBerry Enterprise Server User Administration Tool.................................................... 43Remove the BlackBerry Enterprise Server User Administration Tool ..................................................... 43Parameters 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
BlaAdm
BlacoverYou canBlackBechange
The Blathe follo
Bla
BlaAdmtas
Analysidownlo
BlaDowInsMaMaObSenMaMaObObDisUpRemParErrckBerry Enterprise Server User inistration Tool
kBerry Enterprise Server User Administration Tool view use the BlackBerry Enterprise Server User Administration Tool to manage user accounts on the rry Enterprise Server on a large scale. For example, you can add, move, find, and remove user accounts, or
user account configurations.
ckBerry Enterprise Server User Administration Tool, previously named the BESUserAdmin tool, consists of wing components:
ckBerry Enterprise Server User Administration Tool service
ckBerry Enterprise Server User Administration Tool client; you run the BlackBerry Enterprise Server User inistration Tool client from a command prompt to perform BlackBerry Enterprise Server administration
ks or to gather BlackBerry Enterprise Server statistics
s, monitoring and troubleshooting tools and documentation are included in a separate file that you can ad. For more information, visit na.blackberry.com/eng/support/server_resourcekit.jsp.
ckBerry Enterprise Server User Administration Tool overviewnload the BlackBerry Enterprise Server Resource Kit files
talling the BlackBerry Enterprise Server User Administration Toolnaging user accountsnaging BlackBerry devicestain or clear user account statistics ding notification messages to BlackBerry devices
naging email and folder redirectionnaging IT policies and IT policy rulestaining BlackBerry device informationtaining BlackBerry Enterprise Server statisticsplay the status of the BlackBerry Enterprise Server User Administration Tool servicegrade the BlackBerry Enterprise Server User Administration Tool
ove the BlackBerry Enterprise Server User Administration Toolameters available for use with the BlackBerry Enterprise Server User Administration Toolor codes for the BlackBerry Enterprise Server User Administration Tool
10
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.
BlackBerry Enterprise Server User Administration Tool
Download the BlackBerry Enterprise Server Resource Kit files1. 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. Dou
3. In t
4. Clic
InstAdmThe BlaAdminiTool clie
Insta1. On
ser
2. Cop
3. At t
4. Typ
11
ble-click the .exe file that you downloaded.
he Unzip to folder field, create a folder in which to store the files.
k Unzip.
alling the BlackBerry Enterprise Server User inistration Tool
ckBerry Enterprise Server User Administration Tool consists of the BlackBerry Enterprise Server User stration Tool service (BESUserAdminService.exe) and the BlackBerry Enterprise Server User Administration nt (BESUserAdminClient.exe), and system files.
ll the BlackBerry Enterprise Server User Administration Tool service the computer on which you plan to install the BlackBerry Enterprise Server User Administration Tool vice, create a folder in which to store the BlackBerry Enterprise Server User Administration Tool files.
y 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)
he command prompt, switch to the folder in which BESUserAdminService.exe is located.
e besuseradminservice -install where is one of the following values:
exchange
domino
groupwise
mdsapplications
12
User Guide for the BlackBerry Enterprise Server User Administration Tool
5. Consider the following information as you complete the installation:
Task Steps
Choose whether to start the BlackBerry Enterprise Seau
> Type Y to start the service automatically; otherwise, type N. The default setting
Sp
ChSese
If tcoAdexseBla[D
FoLorunMiseDa
FoMiSeEnBlacowhloc
Spna
FoDotheCo
FoDothe
Spwarver User Administration Tool service tomatically or manually.
is to start the service manually.
ecify 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.
oose whether to use the BlackBerry Enterprise rver User Administration Tool service registry ttings that already exist on the computer.
> Type Y to use existing registry settings; otherwise, type N to start a new installation.
he BlackBerry Manager runs on the same mputer, the BlackBerry Enterprise Server User ministration Tool service attempts to detect the isting BlackBerry Configuration Database ttings and displays the message Found ckBerry Manager settings: DB Server:
atabase Server], DB Name: [Database Name].
> Type Y to confirm the BlackBerry Configuration Database that the BlackBerry Enterprise Server User Administration Tool service detects.
r the BlackBerry Enterprise Server for IBM tus Domino, if the BlackBerry Manager is not ning on the same computer, specify the
crosoft SQL Server or an IBM DB2 UDB rver on which the BlackBerry Configuration tabase is located.
> Type 1 to use a Microsoft SQL Server; type 2 to use an IBM DB2 UDB server.
r the BlackBerry Enterprise Server for crosoft Exchange, the BlackBerry Enterprise rver for Novell GroupWise, or the BlackBerry terprise Server for MDS Applications, if the ckBerry Manager is not running on the same
mputer, specify the Microsoft SQL Server on ich the BlackBerry Configuration Database is ated.
> Type the host name of the Microsoft SQL Server computer.
ecify the BlackBerry Configuration Database me.
> Type the BlackBerry Configuration Database name.
r the BlackBerry Enterprise Server for IBM Lotus mino, if you are using an IBM DB2 UDB, specify IBM DB2 UDB schema name of the BlackBerry
nfiguration Database.
> Type the IBM DB2 UDB schema name. By default, the database schema name is BESADMIN.
r the BlackBerry Enterprise Server for IBM Lotus mino, if you are using an IBM DB2 UDB, specify IBM DB2 UDB port number.
> Type the IBM DB2 UDB port number. By default, the port number is 50000.
ecify the type of database authentication you nt 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
6. In tser
If the BlackBerry Manager runs on the same computer, the BlackBerry Enterprise Server User Administration Tool service attempts to detect the expaBlaUD
> Type Y to confirm the database authentication user name and password that the BlackBerry Enterprise Server User Administration Tool service detects.
If tsaau
SeEnusSe
SeBlaTo
FoExco
FoDotheEn
NoID
FoDowaAd
FoGrBlaTo
SeSeco
Task Steps13
he Microsoft Windows Services window, start the BlackBerry Enterprise Server User Administration Tool vice.
isting database authentication user name and ssword and displays the message Found ckBerry Manager settings: Login: [SQL/DB2 B Authentication User], Password: ***.
he BlackBerry Manager is not running on the me computer, specify the database thentication credentials.
1. Type the login name, if applicable.
2. Type the password, if applicable.
t the client password that the BlackBerry terprise Server User Administration Tool client es to authenticate with the BlackBerry Enterprise rver User Administration Tool service.
> Type a password that is up to 32 characters long.
t restrictions for the hosts that can run the ckBerry Enterprise Server User Administration
ol 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.
r the BlackBerry Enterprise Server for Microsoft change, specify the name of the MAPI profile to nnect to the BESAdmin mailbox.
> Type the name of the MAPI profile. For example, type BlackBerryServer.
r the BlackBerry Enterprise Server for IBM Lotus mino, specify the path to and the password for Notes ID file that you want the BlackBerry
terprise Server User Administration Tool to use.
te: The user account that appears in the Notes file must belong to the BlackBerryAdmins group.
1. Type the full path name of the Notes ID file.
2. Type the password for the Notes ID file.
r the BlackBerry Enterprise Server for IBM Lotus mino, specify the messaging server that you nt the BlackBerry Enterprise Server User ministration 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.
r BlackBerry Enterprise Server for Novell oupWise, specify the user ID that you want the ckBerry Enterprise Server User Administration
ol to use.
> Type the user ID. For example, type Admin.
t access rights that the BlackBerry Enterprise rver User Administration Tool clients can use to nnect 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.
14
User Guide for the BlackBerry Enterprise Server User Administration Tool
BlackBerry Enterprise Server User Administration Tool service log filesIf 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 locaAdminiBlackBe_BBUA___.txt.
Berry Enterprise Server User Administration Tool audit log files configure the BlackBerry Enterprise Server User Administration Tool service to create BlackBerry ise Server User Administration Tool audit files. If you run the BlackBerry Enterprise Server User stration Tool service on a computer on which the BlackBerry Manager runs, the BlackBerry Enterprise
ser Administration Tool creates audit log files that are located in the same folder as the BlackBerry log herwise, the BlackBerry Enterprise Server User Administration Tool creates audit log files in the same which the BESUserAdminService.exe file is located. The BlackBerry Enterprise Server User
stration Tool saves the audit log files in a text file named me>_BBUA_AUDT___.txt.
ult, the BlackBerry Enterprise Server User Administration Tool audit logging feature is turned off.
the BlackBerry Enterprise Server User Administration Tool audit logging the computer on which the BlackBerry Enterprise Server User Administration Tool service runs, in the istry Editor, browse to HKEY_CURRENT_USER\Software\Research In Motion\BlackBerry Enterprise ver\Admin.
form any of the following tasks:
re to run the BlackBerry Enterprise Server User Administration Tool
y BESUserAdminClient.exe and CE.dll to a folder on the computer on which you plan to run the ckBerry Enterprise Server User Administration Tool client.
sk Steps
rn on the BlackBerry Enterprise Server User ministration Tool audit logging feature.
1. Double-click the AuditLogEnabled value.
2. In the Value data field, type 1.
3. Click OK.
ange the location in which the BlackBerry Enterprise rver User Administration Tool creates the audit log files.
1. Double-click the AuditLogDir value.
2. In the Value data field, type the location in which to create the audit log files.
3. Click OK.
BlackBerry Enterprise Server User Administration Tool
Specify a local system account to run the BlackBerry Enterprise Server User Administration ToolDuring the installation of the BlackBerry Enterprise Server User Administration Tool service component, adminisBlackBeaccounfor the User Ad
Chang1. Log
Adm
2. OpEnt
3. Rig
4. Sav
5. In tMoMo
6. In tthe
7. Sav
8. In t
Changlocal s1. Sto
2. In tser15
trator permissions are given to the user account logged in at the time of installation. You must use the rry Enterprise Server User Administration Tool with this account. If you want to specify a local system
t to run the BlackBerry Enterprise Server User Administration Tool, you must change the registry settings BlackBerry Enterprise Server User Administration Tool and then change the BlackBerry Enterprise Server ministration Tool service to log in using the local system account.
e the BlackBerry Enterprise Server User Administration Tool service registry settings in to the Microsoft Windows account that you use to run the BlackBerry Enterprise Server User inistration Tool service.
en the Registry Editor and browse to HKEY_CURRENT _USER\Software\Research In Motion\BlackBerry erprise Server\Admin.
ht-click Admin. Select Export.
e the registry settings to a registration file (*.reg).
he registration file, change the text from HKEY_CURRENT _USER\Software\Research In tion\BlackBerry Enterprise Server\Admin to HKEY_USERS\.DEFAULT\Software\Research In tion\BlackBerry Enterprise Server\Admin.
he registration file, remove any line break after a hashed password where the closing quotation mark is on next line.
e the file.
he Registry Editor, import the registration file.
e the BlackBerry Enterprise Server User Administration Tool service to log in using a ystem accountp the BlackBerry Enterprise Server User Administration Tool service.
he Microsoft Windows Services window, in the BlackBerry Enterprise Server User Administration Tool vice properties, change the login account to the local system account.
16
User Guide for the BlackBerry Enterprise Server User Administration Tool
Client password authenticationThe 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 AdminiAdminilogin daTool serclient pTool serAdmini
If you tyfollowincomma
Res
Reaser
Reacti1. On
RegSer
2. Cre
3. Rig
4. Typclie
5. Clo
6. In tpas
BlackbasedTo permAdminithe Blachave systration Tool client starts, it obtains tokenized data from the BlackBerry Enterprise Server User stration Tool service. The BlackBerry Enterprise Server User Administration Tool client uses this unique ta to create an encrypted password that it sends to the BlackBerry Enterprise Server User Administration vice. The BlackBerry Enterprise Server User Administration Tool service uses this same tokenized data and assword to create an encrypted password locally. The BlackBerry Enterprise Server User Administration vice compares its encrypted password to the value that the BlackBerry Enterprise Server User stration Tool client created. The encrypted passwords must match exactly for authentication to succeed.
pe the client password incorrectly three times (in total, not consecutively), you must perform one of the g actions before the BlackBerry Enterprise Server User Administration Tool client can process more
nds:
tart the BlackBerry Enterprise Server User Administration Tool service.
ctivate the client password without restarting the BlackBerry Enterprise Server User Administration Tool vice.
vate the client password the computer on which the BlackBerry Enterprise Server User Administration Tool service runs, in the istry Editor, browse to HKEY_CURRENT_USER\SOFTWARE\Research In Motion\BlackBerry Enterprise ver\Admin.
ate a new String Value called ReallowHostnames.
ht-click ReallowHostnames. Click Modify.
e the host name of the computer on which the BlackBerry Enterprise Server User Administration Tool nt runs.
se the Registry Editor.
he BlackBerry Enterprise Server User Administration Tool client, type the command and the client sword.
Berry Enterprise Server User Administration Tool authentication for role- administration
it role-based administration, the user account that you use to run the BlackBerry Enterprise Server User stration Tool client must authenticate with the BlackBerry Configuration Database. The user account for kBerry Enterprise Server User Administration Tool must be given permissions for the database, and it must
stem administrator access and security administration access.
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 whethepermissthe opeAdminiadded o
ManThe Blaroles, to
By defaauthentUser Adauthentin the B
You canServer U
Note: TUser AdBlackBe
Add a1. At t
2. Typ
17
r the user role permits the action that the client user account invokes. If the user role does not have ion to perform the action, the BlackBerry Enterprise Server User Administration Tool service reports that ration cannot complete because of insufficient permissions. The BlackBerry Enterprise Server User stration Tool service checks for changes made to role-based administration, such as when user accounts r roles assigned, at 5-minute intervals.
aging user accountsckBerry Enterprise Server uses predefined roles, which correspond to common corporate administrative control who can perform specific tasks and limit who can access sensitive data.
ult, the BlackBerry Enterprise Server User Administration Tool client uses the Microsoft Windows ication credentials that you type when you log in to your computer. If the BlackBerry Enterprise Server ministration Tool client uses Microsoft SQL Server authentication or IBM DB2 UDB authentication to icate with the BlackBerry Configuration Database, you must specify the database user name and password lackBerry Enterprise Server User Administration Tool client commands.
identify the role assigned to the user account for which you are logged in to the BlackBerry Enterprise ser Administration Tool client by using the verbose logging parameter (-v).
he database authentication information is encrypted when it passes from the BlackBerry Enterprise Server ministration Tool client to the BlackBerry Enterprise Server User Administration Tool service and to the rry Configuration Database.
user account to the BlackBerry Enterprise Serverhe command prompt, switch to the folder in which BESUserAdminClient.exe is located.
e besuseradminclient -add and the following parameters:
-p
-u
-PIN (use in conjunction with the -u parameter for the BlackBerry Enterprise Server for MDS Applications only)
-b
-sqluser (if you use database authentication)
-sqlpass (if you use database authentication)
-n (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)
18
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
besuser-it_poli
Example
besuser-n xx.xx
Example
besuser-it_poli
Example
besuser-it_poli
Add a1. At t
2. Typ
See Pamore in: Adding a user account to a BlackBerry Enterprise Server for Microsoft Exchange
adminclient -add -p password1 -u [email protected] -b -n computer01 -pin xxxxxxxx cy User Can Change Timeout
: Adding a user account to a BlackBerry Enterprise Server for IBM Lotus Domino
adminclient -add -p password1 -u CN=Clyde Warren/O=Server01 -b CN=Server01/O=test.rim.net .xx.xx -pin xxxxxxxx -it_policy User Can Change Timeout
: Adding a user account to a BlackBerry Enterprise Server for Novell GroupWise
adminclient -add -p password1 -u clydewarren -b server01 -n computer01 -pin xxxxxxxx cy User Can Change Timeout
: Adding a user account to a BlackBerry Enterprise Server for MDS Applications
adminclient -add -p password1 -u 204FEA39 -pin xxxxxxxx -b server01 -n computer01 cy User Can Change Timeout
user account to a grouphe command prompt, switch to the folder in which BESUserAdminClient.exe is located.
e besuseradminclient -add and the following parameters:
-p
-u
-b
-group
-sqluser (if you use database authentication)
-sqlpass (if you use database authentication)
-n (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)
rameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for formation.
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 [email protected] -b server01 -n computer01 -pin xxxxxxx -group
Add a1. At t
2. Typ
See Pamore in
Example
besuser
Remo1. At t
2. Typ
19
administrators -it_policy User Can Change Timeout
n existing user account to a grouphe command prompt, switch to the folder in which BESUserAdminClient.exe is located.
e besuseradminclient -change and the following parameters:
-p
-u
-b
-group
-sqluser (if you use database authentication)
-sqlpass (if you use database authentication)
-n (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)
rameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for formation.
: Adding an existing user to a group
adminclient -change -p password1 -u [email protected] -b server01 -group administrators
ve a user account from the BlackBerry Enterprise Serverhe command prompt, switch to the folder in which BESUserAdminClient.exe is located.
e besuseradminclient -delete and the following parameters:
-p
-u
-b
-sqluser (if you use database authentication)
-sqlpass (if you use database authentication)
20
User Guide for the BlackBerry Enterprise Server User Administration Tool
-n (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 Pamore in
Example
besuser
Remo1. At t
2. Typ
See Pamore in
Example
besuser
MoveBoth Bl
1. At t
2. Typ
rameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for formation.
: Removing a user from the BlackBerry Enterprise Server for Microsoft Exchange
adminclient -delete -p password1 -u [email protected] -b server01
ve a user account from a grouphe command prompt, switch to the folder in which BESUserAdminClient.exe is located.
e besuseradminclient -change and the following parameters:
-p
-u
-b
-cgroup
-sqluser (if you use database authentication)
-sqlpass (if you use database authentication)
-n (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)
rameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for formation.
: Removing a user account from a group on the BlackBerry Enterprise Server for Microsoft Exchange
adminclient -change -p password1 -u [email protected] -b server01 -cgroup
a user account to a different BlackBerry Enterprise ServerackBerry Enterprise Server computers must use the same BlackBerry Configuration Database.
he command prompt, switch to the folder in which BESUserAdminClient.exe is located.
e besuseradminclient -move and the following parameters:
-p
-u
BlackBerry Enterprise Server User Administration Tool
-b
-t
-sqluser (if you use database authentication)
See Pamore in
Example
besuser
Move1. At t
2. Typ
See Pamore in
Example
besuser
Find 1. At t21
-sqlpass (if you use database authentication)
-n (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)
rameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for formation.
: Moving a user account to a different BlackBerry Enterprise Server for Microsoft Exchange
adminclient -move -p password1 -u [email protected] -b server01 -t server02
a user account to a different grouphe command prompt, switch to the folder in which BESUserAdminClient.exe is located.
e besuseradminclient -change and the following parameters:
-p
-u
-b
-group
-sqluser (if you use database authentication)
-sqlpass (if you use database authentication)
-n (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)
rameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for formation.
: Moving a user account to a different group
adminclient -change -p password1 -u [email protected] -b server01 -group security
a user account on a BlackBerry Enterprise Serverhe command prompt, switch to the folder in which BESUserAdminClient.exe is located.
22
User Guide for the BlackBerry Enterprise Server User Administration Tool
2. Type besuseradminclient -find and the following parameters:
-p
-u
See Pamore in
Example
besuser
ChanThe Bla
1. At t
2. Typ
See Pamore in
Example
besuser-sqluser (if you use database authentication)
-sqlpass (if you use database authentication)
-n (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)
rameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for formation.
: Finding a user account on the BlackBerry Enterprise Server for Microsoft Exchange
adminclient -find -p password1 -u [email protected]
ge user account settingsckBerry Enterprise Server for MDS Applications does not support this task.
he command prompt, switch to the folder in which BESUserAdminClient.exe is located.
e besuseradminclient -change and the following parameters:
-p
-u
-b
-sqluser (if you use database authentication)
-sqlpass (if you use database authentication)
-n (if the BlackBerry Enterprise Server User Administration Tool service and BlackBerry Enterprise Server User Administration Tool client do not run on the same computer)
rameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for formation.
: Clearing the user account filters
adminclient -change -p password1 -u [email protected] -b server01 -cf
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 [email protected] -b server01 -dm -w password3 -wt 96
Example
besuser
Add a1. At t
2. Typ
See Pamore in
Example
besuser
Remo1. At t
2. Typ
23
: Specifying the activation password and activation password expiry time for a group of users
adminclient -change -p password1 -g administrators -w password3 -wt 120
user account to a software configurationhe command prompt, switch to the folder in which BESUserAdminClient.exe is located.
e besuseradminclient -assign_swconfig -sw and the following parameters:
-p
-u
-b
-sqluser (if you use database authentication)
-sqlpass (if you use database authentication)
-n (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)
rameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for formation.
: Adding a user account to a software configuration
adminclient -p password -u Clyde Warren -b server1 -assign_swconfig -sw games
ve a user account from a software configurationhe command prompt, switch to the folder in which BESUserAdminClient.exe is located.
e besuseradminclient -assign_swconfig -csw and the following parameters:
-p
-u
-b
-sqluser (if you use database authentication)
-sqlpass (if you use database authentication)
24
User Guide for the BlackBerry Enterprise Server User Administration Tool
-n (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 Pamore in
Example
besuser
List t1. At t
2. Typ
See Pamore in
Example
besuser
Man
Set th1. At t
2. Typ
rameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for formation.
: Removing a user account from a software configuration
adminclient -p password -u Clyde Warren -b server1 -assign_swconfig -csw
he groups in a BlackBerry Domainhe command prompt, switch to the folder in which BESUserAdminClient.exe is located.
e besuseradminclient -list -groups and the following parameters:
-p
-sqluser (if you use database authentication)
-sqlpass (if you use database authentication)
-n (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)
rameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for formation.
: Listing the groups in a BlackBerry Domain
adminclient -p password -list -groups
aging BlackBerry devices
e BlackBerry device passwordhe command prompt, switch to the folder in which BESUserAdminClient.exe is located.
e besuseradminclient -set_password and the following parameters:
-p
-u
-b
-sqluser (if you use database authentication)
BlackBerry Enterprise Server User Administration Tool
-sqlpass (if you use database authentication)
-n (if the BlackBerry Enterprise Server User Administration Tool service and the BlackBerry Enterprise Server User
See Pamore in
Example
besuser
Set oTo set tinformaspecify
1. At t
2. Typinp
See Pamore in
Example
besuser
Example
besuser-b serve25
Administration Tool client do not run on the same computer)
rameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for formation.
: Setting the BlackBerry device password
adminclient -set_password devicepassword1 -p password1 -u [email protected] -b server01
wner information on a BlackBerry devicehe owner information that appears on the BlackBerry device, you can use a command to specify the tion in quotes, or you can create an input file to contain the information and then use a command to the input file.
he command prompt, switch to the folder in which BESUserAdminClient.exe is located.
e besuseradminclient -set_owner_info and the following parameters:
-p
-u
-b
-sqluser (if you use database authentication)
-sqlpass (if you use database authentication)
-n (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)
rameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for formation.
: Setting owner information on a BlackBerry device
adminclient -set_owner_info -info Clyde Warren -p password -u [email protected] -b server01
: Setting owner information on a BlackBerry device using an input file
adminclient -set_owner_info -infofile userinformation.txt -p password -u [email protected] r01
26
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. Typ
See Pamore in
Example
besuser
PurgeThe Bla
1. At t
2. Typ
See Pamore ine besuseradminclient -kill_handheld and the following parameters:
-p
-u
-b
-sqluser (if you use database authentication)
-sqlpass (if you use database authentication)
-n (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.)
rameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for formation.
: Deleting data from the BlackBerry device memory and making the BlackBerry device unavailable
adminclient -kill_handheld -p password1 -u [email protected] -b server01
pending messagesckBerry Enterprise Server for MDS Applications does not support this task.
he command prompt, switch to the folder in which BESUserAdminClient.exe is located.
e besuseradminclient -change -purge_pending_messages and the following parameters:
-p
-u
-b
-sqluser (if you use database authentication)
-sqlpass (if you use database authentication)
-n (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)
rameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for formation.
BlackBerry Enterprise Server User Administration Tool
Example: Purging pending messages for a user account
besuseradminclient -change -purge_pending_messages -p password1 -u [email protected] -b server01
Resen1. At t
2. Typ
See Pamore in
Example
besuser
Resen1. At t
2. Typ
27
d the peer-to-peer encryption key to the BlackBerry devicehe command prompt, switch to the folder in which BESUserAdminClient.exe is located.
e besuseradminclient -resend_peer_to_peer_key and the following parameters:
-p
-u
-b
-sqluser (if you use database authentication)
-sqlpass (if you use database authentication)
-n (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)
rameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for formation.
: Resending the peer-to-peer encryption key to the BlackBerry device for a user
adminclient -resend_peer_to_peer_key -p password1 -u [email protected] -b server01
d a service bookhe command prompt, switch to the folder in which BESUserAdminClient.exe is located.
e besuseradminclient -resend_service_book and the following parameters:
-p
-u
-b
-sqluser (if you use database authentication)
-sqlpass (if you use database authentication)
-n (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)
28
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
besuser
Obt
Obta1. At t
2. Typ
See Pamore in
Example
besuser
Example
besuser
Example
besuser
Example
besuser: Resending a service book to the BlackBerry device
adminclient -p password -u [email protected] -b server1 -resend_service_book
ain or clear user account statistics
in user account statisticshe command prompt, switch to the folder in which BESUserAdminClient.exe is located.
e besuseradminclient -stats and the following parameters:
-p
-u
-b
-sqluser (if you use database authentication)
-sqlpass (if you use database authentication)
-n (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)
rameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for formation.
: Obtaining statistics for a user account
adminclient -p password1 -stats -u clyde warren -b server1
: Obtaining statistics for multiple user accounts
adminclient -p password1 -stats -i userinfo.txt -o output.csv
: Obtaining statistics for all user accounts on a BlackBerry Enterprise Server
adminclient -p password1 -stats -users -b server1 -o output.csv
: Obtaining statistics for all users in a group
adminclient -p password1 -stats -users -g administrators -o output.csv
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
MailBox
ServerD
PIN
Device
State
Messag
Forward
Sent
Pending
Filtered
Expired
Status
Last fwd
Last sen
Last con
Last res
SMTP a
BlackBeConnec
OTA Ca
ITPolicy
ITPolicy
ITPolicy
ITPolicy29
DN mailbox of the user
Platform: This column does not apply to the BlackBerry Enterprise Server for MDS Applications.
N 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.
BlackBerry device PIN (personal information number>
Type BlackBerry device model number
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.
e 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.
ed number of messages that the BlackBerry device forwarded
Platform: This column does not apply to the BlackBerry Enterprise Server for MDS Applications.
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.
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.
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.
number of expired messages and organizer data items
Platform: This column does not apply to the BlackBerry Enterprise Server for MDS Applications.
configuration status of the BlackBerry device
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.
t 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.
tact time (h) time when the BlackBerry device was last in contact with the BlackBerry Enterprise Server
ult result of the last BlackBerry device contact with the BlackBerry Enterprise Server
ddress SMTP email address of the user account
Platform: This column does not apply to the BlackBerry Enterprise Server for MDS Applications.
rry MDS tion Service
whether the BlackBerry MDS Connection Service is available or unavailable
lendar whether wireless calendar synchronization is available or unavailable
Platform: This column does not apply to the BlackBerry Enterprise Server for MDS Applications.
name IT policy applied to the BlackBerry device
status status of the IT policy applied to the BlackBerry device
time applied time when the IT policy was applied to the BlackBerry device
time sent time when the BlackBerry Enterprise Server sent the IT policy to the BlackBerry device
30
User Guide for the BlackBerry Enterprise Server User Administration Tool
Clear1. At t
2. Typ
See Pamore in
Example
besuser
Send
Send1. At t
2. Typtexme
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
Creatio
EA Pass
Encrypt
Service
Group N
Column Description user account statisticshe command prompt, switch to the folder in which BESUserAdminClient.exe is located.
e besuseradminclient -change -cs and the following parameters:
-p
-u
-b
-sqluser (if you use database authentication)
-sqlpass (if you use database authentication)
-n (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)
rameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for formation.
: Clearing user account statistics
adminclient -change -p password1 -u [email protected] -b server01 -cs
ing notification messages to BlackBerry devices
a PIN messagehe command prompt, switch to the folder in which BESUserAdminClient.exe is located.
e besuseradminclient -send_pin with the following parameters:
-p
Platform: This column does not apply to the BlackBerry Enterprise Server for MDS Applications.
n Time time that the BlackBerry device user account was created on the BlackBerry Enterprise Server
word Expiry Time expiry time of the enterprise activation password if the password is set; otherwise,N/A appears
ion Type encryption type set on the BlackBerry device
Name name of the BlackBerry Enterprise Server on which the user account is located
ame name of the group to which the user account belongs
BlackBerry Enterprise Server User Administration Tool
-u or -infofile
-b
-subject
See Pamore in
Note: U
Example
besuser
: Sending a PIN message using an input file
adminclient -p password -u Clyde Warren -b server01 -send_pin -infofile userinformation.txt
an email messageckBerry Enterprise Server for MDS Applications does not support this task.
he command prompt, switch to the folder in which BESUserAdminClient.exe is located.
e besuseradminclient -send_email and the following ameters:
-p
-u or -infofile
-b
-subject
-body
-sqluser (if you use database authentication)
-sqlpass (if you use database authentication)
32
User Guide for the BlackBerry Enterprise Server User Administration Tool
-n (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 a
See Pamore in
Example
besuser
: Sending an email message using an input file
adminclient -p password -u Clyde Warren -b server01 -send_email -infofile userinformation.txt
aging email and folder redirection
on email redirectionckBerry Enterprise Server for MDS Applications does not support this task.
he command prompt, switch to the folder in which BESUserAdminClient.exe is located.
e besuseradminclient -change -er and the following parameters:
-p
-u
-b
-sqluser (if you use database authentication)
-sqlpass (if you use database authentication)
-n (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
rameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for formation.
BlackBerry Enterprise Server User Administration Tool
Example: Turning on email redirection for a user account
besuseradminclient -change -p password1 -u [email protected] -b server01 -er
Turn The Bla
1. At t
2. Typ
See Pamore in
Example
besuser
List tThe Bla
1. At t
2. Typ
33
off email redirectionckBerry Enterprise Server for MDS Applications does not support this task.
he command prompt, switch to the folder in which BESUserAdminClient.exe is located.
e besuseradminclient -change -dr and the following parameters:
-p
-u
-b
-sqluser (if you use database authentication)
-sqlpass (if you use database authentication)
-n (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
rameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for formation.
: Turning off email redirection for a user account
adminclient -change -p password1 -u [email protected] -b server01 -dr
he folders available for redirectionckBerry Enterprise Server for MDS Applications does not support this task.
he command prompt, switch to the folder in which BESUserAdminClient.exe is located.
e besuseradminclient -list -folders and the following parameters:
-p
-u
-b
-sqluser (if you use database authentication)
-sqlpass (if you use database authentication)
34
User Guide for the BlackBerry Enterprise Server User Administration Tool
-n (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 Pamore in
Example
besuser
Turn The Bla
For thespecify
1. At t
2. Typ
See Pamore in
Example
besusersubfoldrameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for formation.
: Listing the folders available for redirection
adminclient -p password -u clydewarren -b server01 -list -folders
on folder redirectionckBerry Enterprise Server for MDS Applications does not support this task.
BlackBerry Enterprise Server for Microsoft Exchange, a folder name can contain a slash mark (/). To the folder, the slash mark must be preceded by the escape character backslash (\).
he command prompt, switch to the folder in which BESUserAdminClient.exe is located.
e besuseradminclient -set_folder_redirection -er and the following parameters:
-p
-u
-b
-sqluser (if you use database authentication)
-sqlpass (if you use database authentication)
-n (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
-er
rameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for formation.
: Turning on folder redirection with a folder name that contains a slash mark
adminclient -set_folder_redirection -p password1 -u [email protected] -b server01 -foldername Inbox/er1/sub\/folder2 -er
BlackBerry Enterprise Server User Administration Tool
Turn off folder redirectionThe BlackBerry Enterprise Server for MDS Applications does not support this task.
For the BlackBerry Enterprise Server for Microsoft Exchange, a folder name can contain a slash mark (/). To specify
1. At t
2. Typ
See Pamore in
Example
besuser-foldern
Man
List t1. At t
2. Typ
35
the folder, the slash mark must be preceded by the escape character backslash (\).
he command prompt, switch to the folder in which BESUserAdminClient.exe is located.
e besuseradminclient -set_folder_redirection -dr and the following parameters:
-p
-u
-b
-sqluser (if you use database authentication)
-sqlpass (if you use database authentication)
-n (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
-dr
rameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for formation.
: Turning off folder redirection
adminclient -set_folder_redirection -p password1 -u [email protected] -b server01 ame Inbox -dr
aging IT policies and IT policy rules
he IT policy rules in an IT policyhe command prompt, switch to the folder in which BESUserAdminClient.exe is located.
e besuseradminclient -list -it_policy_rules and the following parameters:
-p
-u
-b
-sqluser (if you use database authentication)
-sqlpass (if you use database authentication)
36
User Guide for the BlackBerry Enterprise Server User Administration Tool
-n (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 Pamore in
Example
besuser
Set IT1. At t
2. Typ
See Pamore in
Example
besuserUser Na
List t1. At t
2. Typ-it_policy
rameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for formation.
: Listing the IT policy rules for an IT policy
adminclient -p password1 -list -it_policy_rules -it_policy WLAN
policy rules for a user accounthe command prompt, switch to the folder in which BESUserAdminClient.exe is located.
e besuseradminclient -set_user_itpolicy_rule and the following parameters:
-p
-u
-b
-sqluser (if you use database authentication)
-sqlpass (if you use database authentication)
-n (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
-policyvalue
rameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for formation.
: Setting IT policy rules for a user account
adminclient -set_user_itpolicy_rule -p password1 -u [email protected] -b server01 -policyrule VPN me -policyvalue cwarren
he IT policies in the BlackBerry Configuration Databasehe command prompt, switch to the folder in which BESUserAdminClient.exe is located.
e besuseradminclient -list -it_policies and the following parameters:
BlackBerry Enterprise Server User Administration Tool
-p
-u
-b
See Pamore in
Example
besuser
Obt
List t1. At t
2. Typ
See Pamore in
Example
besuser37
-sqluser (if you use database authentication)
-sqlpass (if you use database authentication)
-n (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)
rameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for formation.
: Listing the IT policies in your environment
adminclient -p password -list -it_policies
aining BlackBerry device information
he applications that are available on one or more BlackBerry deviceshe command prompt, switch to the folder in which BESUserAdminClient.exe is located.
e -handheld_info -apps and the following parameters:
-p
-u
-b
-sqluser (if you use database authentication)
-sqlpass (if you use database authentication)
-n (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)
rameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for formation.
: Viewing the applications that are available on a BlackBerry device
adminclient -p password1 -handheld_info -apps -u clyde warren -b server1
38
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
besuser
List t1. At t
2. Typ
See Pamore in
Example
besuser
List t1. At t
2. Typ
: Viewing the applications available for multiple BlackBerry devices using an input file
adminclient -p password1 -handheld_info -apps -i users.txt
he BlackBerry devices on which a specified application is installedhe command prompt, switch to the folder in which BESUserAdminClient.exe is located.
e besuseradminclient -handheld_info - appname and the following parameters:
-p
-u
-b
-sqluser (if you use database authentication)
-sqlpass (if you use database authentication)
-n (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)
rameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for formation.
: Listing the BlackBerry devices on which the specified application is installed
adminclient -p password -handheld_info -appname sports_scores -o sportscores.txt
he statistics for BlackBerry deviceshe command prompt, switch to the folder in which BESUserAdminClient.exe is located.
e besuseradminclient -handheld_info -hhstats and the following parameters:
-p
-u
-b
-sqluser (if you use database authentication)
BlackBerry Enterprise Server User Administration Tool
-sqlpass (if you use database authentication)
-n (if the BlackBerry Enterprise Server User Administration Tool service and the BlackBerry Enterprise Server User
See Pamore in
Example
besuser
Example
besuser
Interp
Column
User Na
PIN
Service
BlackBe
Platform
BlackBe
Phone N
Serial N
Active C
Home C
Security
Networ
Frequen
Memory
Direct C
IT Polic
IT Polic
Configu
Configu
System
Applica
Availab39
Administration Tool client do not run on the same computer)
rameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for formation.
: Viewing statistics for a user account
adminclient -p password1 -handheld_info -hhstats -u clyde warren -b server1
: Viewing statistics for all user accounts in a group
adminclient -p password1 -handheld_info -hhstats -users -b server1
reting the results of a statistics query for a BlackBerry device
Description
me name of the user account
PIN (personal information number) of the BlackBerry device
Name service name of the BlackBerry Enterprise Server
rry Device Model model of the BlackBerry device
Version version of the platform that the BlackBerry device uses
rry Version version of the applications that the BlackBerry device uses
umber phone number of the BlackBerry device
umber International Mobile Equipment Identity (IMEI) number of the BlackBerry device
arrier current wireless service provider to which the BlackBerry device is registered
arrier the initial wireless service provider to which the BlackBerry device was assigned
Password whether the BlackBerry device password is set or not set
k Type network type for the BlackBerry device; for example, GPRS or CDMA
cies wireless frequencies that the BlackBerry device supports; for example, GSM (Global System for Mobile Communications) 900
total flash memory size for the BlackBerry device
onnect ID direct connect identification (DCID) for the BlackBerry device, if available
y Name name of the IT policy on the BlackBerry device
y Time time that the BlackBerry Enterprise Server last sent the IT policy to the BlackBerry device
ration Name name of the software configuration that is assigned to the BlackBerry device
ration Status overall status of the defined software configuration of the software that exists on the BlackBerry device
Status status of the BlackBerry Device Software on the BlackBerry device with respect to the software configuration that the user defined
tion Status status of the third-party applications on the BlackBerry device
le Space available space on the BlackBerry device
40
User Guide for the BlackBerry Enterprise Server User Administration Tool
List t1. At t
2. Typ
See Pamore in
Example
besuser
Obt1. At t
2. Typtha
Battery Level current battery capacity level in percentage
Uptime time since the BlackBerry device was last reset
Column Descriptionhe modules and .cod files that are available on a BlackBerry devicehe command prompt, switch to the folder in which BESUserAdminClient.exe is located.
e besuseradminclient -handheld_info -modules and the following parameters:
-p
-u
-b
-sqluser (if you use database authentication)
-sqlpass (if you use database authentication)
-n (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)
rameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for formation.
: Viewing the modules and .cod files on a BlackBerry device
adminclient -p password -handheld_info -modules -u clyde warren -b server1
ain BlackBerry Enterprise Server statisticshe command prompt, switch to the folder in which BESUserAdminClient.exe is located.
e besuseradminclient -stats and the following parameters:
-p
-u
-b
-sqluser (if you use database authentication)
-sqlpass (if you use database authentication)
-n (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
besuser
Example
besuser
Example
besuser41
: Obtaining statistics for a BlackBerry Enterprise Server instance
adminclient -p password1 -stats -b server01
: Obtaining statistics for multiple BlackBerry Enterprise Server instances
adminclient -p password1 -stats -servers -i serverfile.txt -o output.csv
: Obtaining statistics for all BlackBerry Enterprise Server instances
adminclient -p password1 -stats -servers
42
User Guide for the BlackBerry Enterprise Server User Administration Tool
Interpreting the results of a statistics query for a BlackBerry Enterprise Server instance
DispAdm1. At t
2. Typ
See Pamore in
Example
besuser
Column
Server N
Server S
SRP Sta
# Users
Forward
Sent
Pending
Filtered
Expired
BlackBe
PID
Platform
Server Vlay the status of the BlackBerry Enterprise Server User inistration Tool service
he command prompt, switch to the folder in which BESUserAdminClient.exe is located.
e besuseradminclient -status and the following parameter:
-p
rameters available for use with the BlackBerry Enterprise Server User Administration Tool on page 45 for formation.
: Checking the status of the BlackBerry Enterprise Server User Administration Tool service
adminclient -p password -status
Description
ame name of the BlackBerry Enterprise Server
tatus status of the BlackBerry Enterprise Server
tus status of the BlackBerry Enterprise Server SRP information
number of user accounts on the BlackBerry Enterprise Server
ed number of messages that the BlackBerry Enterprise Server forwarded
Platform: This column does not apply to the BlackBerry Enterprise Server for MDS Applications.
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.
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.
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.
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.
rry MDS Connection Service whether the BlackBerry MDS Connection Service is available or unavailable
BlackBerry Dispatcher process ID
platform on which the BlackBerry Enterprise Server runs
ersion version of the BlackBerry Enterprise Server