-list

Syntax: -list

You can use the -list parameter to collect information about servers, groups, IT policies, IT policy rules, application control policies, software configurations, mailbox folders, and user activations.

-list : list information specified
    -it_policies : display IT policies
    or
    -it_policy_rules : display policy rules
        [-it_policy <IT policy name>] : IT policy name
    or
    -it_policy_templates : display IT policy templates
    or
    -groups : display groups
    or
    -folders : display folders
        -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
    -swconfigs : list all software configurations in the BlackBerry domain
    or
    -sw <configuration name> : list applications and associated application
                               control policy for a software configuration
    or
    -appconpolicies : list all application control policies
    or
    -appconpolicy <app policy name> : list policy values for an application
                                      control policy
    or
    -servers : list all servers
    or
    -eastatus : Enterprise Activation status
        -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
        [-from <date>] : from date, format: YYYYMMDD
        [-to <date>] : to date, format YYYYMMDD
    or
    -ha_status <host instance name> : display High Availability Status
    or
    -cal : display license information
        -summary : show summary
        or
        -details : show details
    or
    -roles : display roles

Subparameter

Description

-appconpolicies

This subparameter lists all of the application control policies that are available in an MDM domain.

-appconpolicy <app_policy_name>

This subparameter lists information about the specified application control policy.

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

-cal

This subparameter lists information about BlackBerry CAL keys for a BlackBerry Enterprise Server.

-details

This subparameter is used with the -cal subparameter to list detailed information about the BlackBerry CAL keys for a BlackBerry Enterprise Server.

-eastatus

This subparameter lists the activation status of a user's device.

If you want to return a list of every available user account, type the following subparameter with -eastatus: -u " ".

-folders

Does not apply to the BlackBerry Enterprise Server for MDS Applications.

This subparameter lists the mailbox folders name that are available for email redirection.

-from <date>

This subparameter is used with -eastatus to specify the start date for collecting activation statistics. This subparameter uses the format yyyymmdd.

-groups

This subparameter lists the groups in the MDM domain.

-ha_status <host_instance_name>

This subparameter lists the high availability status of a BlackBerry Enterprise Server.

-it_policy <IT policy_name>

This subparameter is used with the -it_policy_rules subparameter to list the IT policy rules that have been configured in a specific IT policy.

-it_policies

This subparameter lists the IT policies available in the BlackBerry Configuration Database.

A list of valid IT policies is also available in the BlackBerry Administration Service.

-it_policy_rules

This subparameter lists the IT policy rules in the BlackBerry Configuration Database or in a specific IT policy.

-it_policy_templates

This subparameter lists the IT policy templates that are available.

-roles

This subparameter lists the BlackBerry Administration Service roles.

-servers

This subparameter lists all BlackBerry Enterprise Server instances in the MDM domain.

-summary

This subparameter is used with the -cal subparameter to list summary information about the BlackBerry CAL keys for a BlackBerry Enterprise Server.

-swconfigs

This subparameter lists all the software configurations that are available in the MDM domain.

-sw <configuration_name>

This subparameter lists information about the specified software configuration.

-to <date>

This subparameter is used with -eastatus to specify the end date for collecting activation statistics. This subparameter uses the format yyyymmdd.

-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


Was this information helpful? Send us your comments.