-change

Syntax: -change

You can use the -change parameter to configure and make changes to user accounts.

Optional parameters and subparameters are enclosed in square brackets ( [ ] ).

-change : change user configuration
    -u <user name> : user name
       [-b <instance>] : instance name of the BlackBerry Device Service component
       [-utype <type>] : user type - display_name, email_address, login_name
       [-group <group name>] : assign group name
       or
       [-cgroup <group name>] : remove user from group
       [-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
       [-cw] : clear enterprise activation password
       [-it_policy <IT policy name>] : IT policy name
    or
    -g <group name> : 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

Subparameter

Description

[-b <server_name>]

This subparameter specifies the BlackBerry Device Service instance for the action (for example, server1).

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

[-cgroup <group_name>]

This subparameter removes the specified user account from the group.

[-cw] This subparameter clears the activation password for the specified user account.

-g <group_name>

This subparameter specifies the name of the group that you want to assign an activation password to.

Use this parameter with the -w and -wt subparameters, or with the -wrandom subparameter.

[-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 assign to the user account.

You can view a list of the IT policies available in the BlackBerry Enterprise Service 10 domain if you use the -list -it_policies parameter.

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

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

[-w <password>]

This subparameter specifies the activation password that you want to assign to a user account or group.

[-wrandom]

This subparameter generates and emails a random activation password to a user account or to the members of a group. You can use this subparameter instead of the -w and -wt subparameters.

[-wt <expiry_time>]

This subparameter specifies the number of hours before the activation password for a user account expires. The default expiry time is 48 hours. Use this subparameter with the -w subparameter.



Was this information helpful? Send us your comments.