Input rules for the BlackBerry Enterprise Server User Administration Tool

Item

Description

Strings with spaces

If you type a text string that contains spaces (for example, the user name "Julie Palmer"), you must enclose the string in quotation marks (" ").

Authentication credentials

Throughout this document, the variable <credentials> represents the login information that you specify for the BlackBerry Administration Service administrator account. For more information about how to specify authentication credentials, see Authentication methods for the BlackBerry Enterprise Server User Administration Tool.

If you specify the -username <user_name> and -password <password> parameters without specifying -bas_auth, -ad_auth, -mailbox_auth, or -gw_auth, the tool assumes that the account uses BlackBerry Administration Service authentication (-bas_auth). The examples throughout this document use BlackBerry Administration Service authentication, and include the -username and -password parameters only.

-u <user_name>

This subparameter specifies the user account for the action. Searches are not case-sensitive.

Examples of searching for user accounts:
  • -u "Julie Palmer" -utype display_name
  • -u jpalmer@test.rim.net -utype email_address
  • -u “CN=Julie Palmer/O=Server01” -utype canonical_name
  • -u "Julie Palmer" -login_name

If you do not specify a type using the -utype subparameter, the tool searches for user accounts using the display name first, then email address, then login name, and then canonical name. Searching by canonical name is available for the BlackBerry Enterprise Server for IBM Lotus Domino only, and is the least preferred method of searching for user accounts.

Searches (except by canonical name) match on substrings. For example, if you specify -u jpalmer@test.rim.net, and your organization's environment contains the user accounts jpalmer@test.rim.net, ojpalmer@test.rim.net, and rjpalmer@test.rim.net, the search identifies all three user accounts as valid results. If the tool finds more than one user account, the tool selects the user account that matches the value that you specified exactly (in this case, jpalmer@test.rim.net).

If the tool finds more than one user account, and none of the user accounts match the value that you specified exactly, the tool returns an error message stating that multiple matches were found.

If you do not want searches to match on substrings, specify the value using the following format: "\"<email_address_or_display_name>\"". For example, "\"jpalmer@test.rim.net\"".

-b <server_name>

This subparameter specifies the BlackBerry Enterprise Server instance for the action.

You use the name of the BlackBerry Enterprise Server instance as it appears in the BlackBerry Administration Service.

This subparameter is mandatory if the command requires you to specify a BlackBerry Enterprise Server for the action. In most cases, this is an optional subparameter that you can use to specify the BlackBerry Enterprise Server that hosts the specified user account for the action.



Was this information helpful? Send us your comments.