Common parameters

The following subparameters can be used with many of the parameters in the BlackBerry Enterprise Service 10 User Administration Tool. You can use the command syntax to help you determine when to use each subparameter.

Subparameter

Description

-n <hostname>

This subparameter specifies the host name, IP address, or web address of the BlackBerry Administration Service that you want the BlackBerry Enterprise Service 10 User Administration Tool to connect to.

When you install the tool, you specify the default BlackBerry Administration Service that you want the tool to connect to. You can use this parameter if you want the tool to connect to a different BlackBerry Administration Service.

You can use the -n <hostname>:<port_number> subparameter to specify an alternate port number that you want the BlackBerry Enterprise Service 10 User Administration Tool to use to access the BlackBerry Administration Service.

-b <server_name>

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

You 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.

-u <user_name>

This subparameter specifies the user account for the action. Searches are not case-sensitive. If the value that you specify contains a space, enclose the value in quotation marks (for example, "Julie Palmer").

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, 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 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\"").

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.

-utype <type>

This subparameter specifies which of the following options the tool uses to search for the user account:
  • display_name
  • email_address
  • login_name: name that the account uses to log in to the BlackBerry Administration Service

-pin <PIN>

This subparameter specifies the device for the action. This subparameter is only required if the user account is associated with multiple devices. If the user has multiple devices and you do not use this subparameter, one of the following occurs:
  • If the command is designed to change user accounts or devices, an error message indicates that you must specify a device for the action.
  • If the command is designed to retrieve and display results or statistics, data is retrieved for all of the user's devices.


Was this information helpful? Send us your comments.