-handheld_info

Syntax: -handheld_info

You can use the -handheld_info parameter to retrieve statistics for BlackBerry devices.

Before you run this parameter, you must run the BlackBerry Synchronization Service to populate the database.

-handheld_info : display handheld stats/applications
    -hhstats : device stats
        -u <user name> : user name
            [-b <instance>] : instance name of the BlackBerry Enterprise
                              Server component
            [-utype <type>] : user type - display_name, email_address,
                              login_name, canonical_name
        or
        -users : users device information
            -g <group name> : group name
            or
            -b <instance> : instance name of the BlackBerry Enterprise
                            Server component
    or
    -apps : display user device applications
        -u <user name> : user name
            [-b <instance>] : instance name of the BlackBerry Enterprise
                              Server component
            [-utype <type>] : user type - display_name, email_address,
                              login_name, canonical_name
    or
    -appsfull : display user device applications in full detail
        -u <user name> : user name
            [-b <instance>] : instance name of the BlackBerry Enterprise
                              Server component
            [-utype <type>] : user type - display_name, email_address,
                              login_name, canonical_name
    or
    -modules : display device modules
        -u <user name> : user name
            [-b <instance>] : instance name of the BlackBerry Enterprise
                              Server component
            [-utype <type>] : user type - display_name, email_address,
                              login_name, canonical_name
    or
    -appname <application name> : show users with a specified application

Subparameter

Description

-appname

This subparameter lists the user accounts that have the specified application installed on their BlackBerry devices.

This subparameter does not work with the -u or -b subparameters.

-apps

This subparameter lists the applications that are available on a user's device.

-appsfull

This subparameter lists the applications that are available on a user's device in verbose detail.

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

-g <group_name>

This subparameter restricts the search of the -hhstats -users command to a specified group.

-hhstats

This subparameter retrieves device statistics. You can use this subparameter with the following subparameters:

  • -u <user_name> -b <server_name> to display statistics for a specific user account.
  • -users -b <server_name> to display statistics for all users on a BlackBerry Enterprise Server.
  • -users -g <group_name> to display statistics for a specific group.

-modules

This subparameter retrieves information about the modules or .cod files on a user's device.

-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
-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 BlackBerry Enterprise Server instance (-b).



Was this information helpful? Send us your comments.