Help Center

Local Navigation

-add

Syntax: -add

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

-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
        or
        -pin <PIN> : PIN for the user
        [-group <group name>] : assign group name
        [-w <password>] : activation password
            [-wt <expiry time>] : 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
        [-cs] : clear user's stats if exist in database
        [-pimaddr <ServerName>!!<RelativePathToDataDirectory>] : address book
                                                                 database
                                                                 location for
                                                                 the user
        [-pimmemo <ServerName>!!<RelativePathToDataDirectory>] : memo database
                                                                 location for
                                                                 the user
        [-addrsub <AddressBookName>] : address book name to be synchronized

Subparameter

Description

-addrsub <address_book_name>

This subparameter specifies the name of the address book that you want to synchronize.

You can use this subparameter only with the BlackBerry® Enterprise Server for Novell® GroupWise®.

-b <instance>

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

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

-cs

This subparameter clears the account statistics of an existing user account.

By default, when you add a user account, the BlackBerry Enterprise Server User Administration Tool reads the existing statistics for the user account.

-group <group_name>

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

-it_policy <IT_policy_name>

This subparameter specifies the name of the IT policy 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 run the BlackBerry Enterprise Server User Administration Tool with the -list -it_policies parameter.

-pimaddr <server_name>!!<Relative_Path_To_Data_Directory>

This subparameter specifies the BlackBerry Enterprise Server instance name and the relative path to the IBM® Lotus Notes® Data folder where the organizer data address book for a user account is stored.

You can use this parameter only with the BlackBerry® Enterprise Server for IBM® Lotus® Domino®.

-pimmemo <server_name>!!<Relative_Path_To_Data_Directory >

This subparameter specifies the BlackBerry Enterprise Server name and the relative path to the IBM Lotus Notes Data folder where the memo database for a user account is stored.

You can use this subparameter only with the BlackBerry Enterprise Server for IBM Lotus Domino.

-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. Depending on the BlackBerry Enterprise Server environment, the user account uses one of the following formats:
  • for Microsoft® Exchange: mailbox name (for example, smoser@test.rim.net)
  • for IBM Lotus Domino: canonical name (for example, “CN=Sam Moser/O=Server01”)
  • for Novell GroupWise: user ID (for example, sammoser)
  • for MDS Applications: display name of the BlackBerry device

-utype <type>

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

Searches are not case sensitive and appear in the order DisplayName, EmailAddress, UserName, and MailboxId. Most matches are prefix matches.

-w <password>

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

-wrandom

This subparameter generates and sends an email message with a random enterprise activation password.

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. You can use this subparameter with the -w parameter.

You cannot use this subparameter with -wrandom.

Index


Was this information helpful? Send us your comments.