Administration Guide

BlackBerry Manuals & Help  >  Administrator Documentation  >  BlackBerry Enterprise Server 5  >  BlackBerry Enterprise Server Resource Kit  >  Administration Guide BlackBerry Analysis, Monitoring, and Troubleshooting Tools - BlackBerry Enterprise Server Resource Kit - 5.0.4

Run the BlackBerry Domain Administration History Reporting Tool

  1. On the computer that hosts the BlackBerry Domain Administration History Reporting Tool, on the taskbar, click Start > All Programs > BlackBerry Enterprise Server Resource Kit > BlackBerry Analysis Monitoring and Troubleshooting Tools > BlackBerry Domain Administration History Reporting Tool.
  2. In the command prompt window, type AdminHistory and the following parameters:

    Parameter

    Description

    -db <database_name>

    Use this parameter if the BlackBerry Configuration Database is installed on a Microsoft SQL Server database engine.

    This parameter specifies the host name or IP address of the BlackBerry Configuration Database.

    -db2 -db2schema <schema>

    Use these parameters if the BlackBerry Configuration Database is installed on an database engine. This configuration is supported in an IBM Lotus Domino environment only.

    Specify the schema name of the BlackBerry Configuration Database. By default, the tool uses the schema name BESADMIN.

    -n <database_server>

    This parameter specifies the host name, computer name, or IP address of the server that hosts the BlackBerry Configuration Database.

    By default, the tool uses the name localhost.
  3. Type any of the following optional parameters:

    Parameter

    Description

    -date

    This parameter is used to specify the date range for the report.

    If you specify this parameter, you must also specify the -f <from_date> and -t <to_date> parameters.

    -f <from_date>

    This parameter specifies the start date (from date) for the report, using the format yyyymmdd. For example, 20120522.

    If you specify this parameter, you must also specify the -date and -t <to_date> parameters.

    -t <to_date>

    This parameter specifies the end date (to date) for the report, using the format yyyymmdd. For example, 20120525.

    If you specify this parameter, you must also specify the -date and -f <from_date> parameters.

    -l <limit>

    This parameter specifies the maximum number of records to retrieve from the BlackBerry Configuration Database. By default, the tool processes all of the records in the ServerConfigHistory table.

    If you do not remove the previous output file, the tool appends the new output file to the previous file. The average limit is 1000 to 2000 lines.

    -SQLAuth

    Use this parameter if you want the tool to use database authentication. By default, the tool uses Windows authentication.

    If you specify this parameter, you must also specify the -login <database_login_name> and -password <database_password> parameters.

    -login <database_login_name>

    If you want the tool to use database authentication, this parameter specifies the login name that the tool uses.

    If you specify this parameter, you must also specify the -SQLAuth and -password <database_password> parameters.

    -password <database_password>

    If you want the tool to use database authentication, this parameter specifies the password that the tool uses.

    If you specify this parameter, you must also specify the -SQLAuth and -login <database_login_name> parameters.

    -o <output_filename>

    This parameter specifies the name of the output file that the tool creates.

Example: Running the tool using Windows authentication

AdminHistory -db BESMgmt -n server01 -o output.csv -l 1000

AdminHistory -db BESMgmt -n server01 -date -f 20120420 -t 20120425 -o output.csv

AdminHistory -db BESMgmt -n server01 -SQLAuth -login “Julie Palmer” -password password1 -o output.csv -l 1000

AdminHistory -db BESMgmt -n server01 -db2 -db2schema besadmin -SQLAuth -login “Julie Palmer” -password password1 -o output.csv -l 1000

  • If you want to view the help information for the tool, including the list of available parameters, in the command window, type AdminHistory -?.
  • If you configured the tool to use a UAC-compliant file path, the output file is located at <drive>:\Users\<user_name>\AppData\Roaming\Research In Motion\AMT\ or <drive>:\Documents and Settings\user_name\Application Data\Research In Motion\AMT\. If you did not configure the tool to use a UAC-compliant file path, the output file is located in a file path relative to the current working directory, for example, <drive>:\Program Files\Research In Motion\BlackBerry Enterprise Server Resource Kit \BlackBerry AMT Tools.

Next topic: Interpreting configuration changes that are reported in the log file
Previous topic: Example: Output file

Was this information helpful? Send us your comments.