-stats

Syntax: -stats

You can use the -stats parameter to retrieve statistics for the BlackBerry Device Service and user accounts.

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

-stats : display user/service 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 information
		-g <group name> : group name
		or
		-b <instance> : instance name of the BlackBerry Device Service component
	or
	-service : service information
		-b <instance> : instance name of the BlackBerry Device Service component

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.

-g <group_name>

This subparameter restricts the statistics query to the specified group.

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

-service

This subparameter specifies that you want to collect statistics for a BlackBerry Device Service.

Use this subparameter with the -b 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\"").

-users

This subparameter specifies that you want to collect statistics for user accounts. You can restrict this option by group (-g) or BlackBerry Device Service instance (-b).

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


Was this information helpful? Send us your comments.