-stats

Syntax: -stats

You can use the -stats parameter to retrieve the BlackBerry Enterprise Server and user account statistics.

-stats : display user/service 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 information
        -g <group name> : group name
        or
        -b <instance> : instance name of the BlackBerry Enterprise Server
                        component
    or
    -service : service information
        -b <instance> : instance name of the BlackBerry Enterprise Server
                        component
        or
        -email <instance> : instance name of the BlackBerry Messaging Agent
                            instance

Subparameter

Description

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

-email <email_instance>

This subparameter specifies the BlackBerry Messaging Agent instance.

-g <group_name>

This subparameter restricts the statistics to the specified group.

-service

This subparameter specifies that you want to collect statistics for a BlackBerry Enterprise Server or BlackBerry Messaging Agent.

Use this subparameter with the -b or -email subparameters.

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

-users

This subparameter specifies that you want to collect statistics for user accounts. You can restrict this option by group (-g) or by BlackBerry Enterprise Server 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
  • canonical_name


Was this information helpful? Send us your comments.