Parameters for the BlackBerry Enterprise Service 10 Log Monitoring Tool

The parameters listed in brackets ( [ ] ) are optional.

Parameter

Description

[-action <action>]

This parameter specifies the action or actions that you want the BlackBerry Enterprise Service 10 Log Monitoring Tool to perform when it finds the event IDs or text strings that you specify using the -events parameter or an input file.

You can specify any standard actions that the Windows command prompt supports. For example, you can type the name of an executable file or a batch file that you want the tool to open when it finds a specific event ID. By default, if you do not specify an action, the tool displays the output on the screen.

To stop the tool after it performs a specified action, precede the action with a tilde (~), or use the tilde only.

[-all]

This parameter specifies that the tool examines the entire contents of a log file, not just the information that is written to the log file after you run the tool.

[-debug <file_name>]

This parameter specifies that the tool creates a more detailed output file for debugging purposes, and also specifies the name of the debug file.

[-events <event_IDs>]

This parameter specifies the event IDs or text strings that you want the tool to find in the log file. You must use commas ( , ) to separate multiple event IDs. If a text string contains spaces, enclose the string in quotation marks (" ").

[-input <file_name>]

This parameter specifies the name of the input text file that you created. The input file contains the event IDs and text strings that you want the tool to find, and the actions that you want the tool to perform when it finds each value.

[-instance <instance>]

Use this parameter when you use the -L parameter to specify the folder that contains the log files, and the -type parameter to specify the type of component log file.

This parameter specifies the instance number of the log file (the last number in the name of a log file). The instance number indicates the order of the log files if more than one daily log file is created for a BlackBerry Device Service component. When a log file reaches the maximum size, an additional daily log file is created and the instance number in the file name is incremented by one. By default, the instance used by the tool is 0001.

-L <file_path>

This parameter specifies the file path of a specific log file that you want the tool to monitor, or the file path of the folder that contains the log files that you want the tool to monitor. If the file path contains spaces, enclose the file path in quotation marks.

If you specify the file path of a specific log file, the tool monitors the specified file only. It does not continue to monitor the log files that are generated by the BlackBerry Device Service component on a daily basis.

If you specify the file path of a folder (for example, C:\Program Files (x86)\Research In Motion\BlackBerry Device Service\Logs), the tool opens the specified folder and examines the contents of the latest <yyyymmdd> subfolder for new files that match the -type and -instance parameters that you specify. The tool continues to monitor the log files that the BlackBerry Device Service component creates on a daily basis.

[-timeout <time>]

This parameter specifies the length of time, in seconds, that the tool continues to run after no new messages are written to the log file that the tool is monitoring. By default, there is no timeout value.

[-type <pattern>]

Use this parameter when you use the -L parameter to specify the folder that contains the log files, and the -instance parameter to specify the instance number of the log files that you want to monitor.

This parameter uses a string value to specify the BlackBerry Device Service component that you want the tool to monitor log files for. For example, to monitor the log files for the BlackBerry Dispatcher, specify the component log file identifier DISP. For a full list of the component identifiers for the BlackBerry Device Service log files, visit www.blackberry.com/go/serverdocs to read the BlackBerry Device Service Administration Guide.

[/?]

[-?]

[-help]

These parameters provide more information about the tool and the parameters that you can use with the tool. No other parameters are required when you use one of these parameters.



Was this information helpful? Send us your comments.