Input rules

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.

If you specify -username <user_name> and -password <password> without specifying -bas_auth or -ad_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 -username and -password only.

-u <user_name>

This subparameter specifies the user account for an 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

If you do not specify a type using the -utype subparameter (display_name or email_address), the tool searches for user accounts using the display name first, then the email address. By default, searches 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 a 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\"".

The -u subparameter functions differently when used with the -add and -find_mail_store_user parameters. In these cases, the -u subparameter uses ANR search functionality.

-b <server_name>

This subparameter specifies the BlackBerry Device Service instance for the action.

Use the name of the BlackBerry Device Service instance as it appears in the BlackBerry Administration Service.

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



Was this information helpful? Send us your comments.