-handheld_info

Syntax: -handheld_info

You can use the -handheld_info parameter to display BlackBerry device statistics and applications.

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

-handheld_info : display device stats/applications
    -hhstats : device stats
        -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
            [-pin <PIN>] : device PIN
        or
        -users : users device information
            -g <group name> : group name
            or
            -b <instance> : instance name of the BlackBerry Device Service
                            component
    or
    -apps : display user device applications
        -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
            [-pin <PIN>] : device PIN
    or
    -appsfull : display user device applications in full detail
        -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
            [-pin <PIN>] : device PIN
    or
    -modules : display device modules
        -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
            [-pin <PIN>] : device PIN
    or
    -appname <application name> : show users with a specified application

Subparameter

Description

-appname <application_name>

This subparameter specifies the application name to display. This subparameter does not work with the -u or -b subparameters.

-apps

This subparameter lists the applications on a device using the standard level of detail.

-appsfull

This subparameter lists the applications on a device using the verbose level of detail.

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

-g <group_name>

This subparameter restricts the -hhstats -users search to a specific group.

-hhstats

This subparameter retrieves device statistics for a specific user account (-u) or for multiple user accounts (-users, -b, -g).

-modules

This subparameter lists the application files on a BlackBerry device.

[-pin <PIN>]

This subparameter specifies the device for the action. If the user has multiple devices and you do not use this subparameter, data is retrieved for all of the user's devices.

-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

-users

This subparameter works with the -hhstats subparameter to specify all user accounts instead of one user account.

You can restrict this option by group (-g) or server instance (-b).



Was this information helpful? Send us your comments.