-delete

Syntax: -delete

You can use the -delete parameter to remove a user account from the BlackBerry Device Service.

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

-delete : delete user
    -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
    [-wipe] : wipe activated device(s) before deleting user
        -all_device_data : erase all device data
        or
        -organization_data_only : erase organization data only

Subparameter

Description

-all_device_data

This subparameter deletes the organization's data and the user's personal data from the device, returning the device to its original "out of the box" state.

Use with the -wipe subparameter.

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

-organization_data_only

This subparameter deletes the organization's data from the device, leaving the user's personal data intact. The organization's data includes email messages, calendar data, organizer data that is associated with the user's work email account, encryption keys, IT policies, and any applications that were installed on the device using the BlackBerry Device Service (including work applications that were distributed using BlackBerry World).

Use with the -wipe subparameter.

-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

[-wipe]

This subparameter deletes the data from the user's BlackBerry device.

Use this subparameter with the -all_device_data or -organization_data_only subparameters.



Was this information helpful? Send us your comments.