-add

Syntax: -add

You can use the -add parameter to add a user account to a BlackBerry Enterprise Server.

-add : add user
    -u <user name> : user name
        -b <instance> : instance name of the BlackBerry Enterprise Server
                           component
        [-utype <type>] : user type - display_name, email_address,
                             canonical_name
    [-group <group name>] : assign group name
    [-w <password>] : enterprise activation password
        [-wt <expiry time>] : enterprise activation password expiry time
                                 (number of hours)
    or
    [-wrandom] : generate and email a random enterprise activation password
    [-it_policy <IT policy name>] : IT policy name
    [-assign_static_mailbox_agent <agent Id>] : assign static mailbox agent

Subparameter

Description

-assign_static_mailbox_agent <agent ID>

Applies to the BlackBerry Enterprise Server for Microsoft Exchange only.

This subparameter specifies the static BlackBerry Messaging Agent that you want to associate the user account with. The user account remains associated with the static BlackBerry Messaging Agent and is not associated with any other instance in the MDM domain.

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

-group <group_name>

This subparameter specifies the name of the group that you want to add the user account to.

-it_policy <IT_policy_name>

This subparameter specifies the name of the IT policy that you want to apply to the user account.

You can view a list of valid IT policies in the BlackBerry Administration Service. You can also display the list if you use the -list -it_policies command.

-pin <PIN>

This subparameter specifies the PIN of the BlackBerry device that is associated with a user account.

You can use this subparameter only in a BlackBerry Enterprise Server for MDS Applications environment.

-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 specifying a user account:

  • -u "Julie Palmer" -utype display_name
  • -u jpalmer@test.net -utype email_address
  • -u JPalmer -utype login_name
  • -u “CN=Julie Palmer/O=Server01” -utype canonical_name

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, then the login name, and then the 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: "\"<user>\"" (for example, "\"jpalmer@test.rim.net\"").

-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
  • canonical_name

-w <password>

This subparameter specifies the password that is used to activate the device over the wireless network.

-wrandom

This subparameter generates a random activation password and sends it in an email message to the user.

The email message uses the following default format (the tool replaces “$p” with the password and “$x” with the password expiration time):

SUBJECT=BlackBerry activation password

BODY=Hello,

To activate your BlackBerry device over the wireless network, in the device Options screen, select Enterprise Activation. In that screen, enter your corporate email address and the following password:

$p

This password will expire in $x hours.

-wt <expiry time>

This subparameter specifies a password expiry time in hours (between 1 and 720). The default expiry time is 48 hours.

Use this subparameter with the -w parameter. You cannot use this subparameter with -wrandom.



Was this information helpful? Send us your comments.