Utilities to control data collection and data transfer
UDR Collection Manager (UCM) is used to control data collection and data transfer. UCM includes the following command-line utilities to customize and improve the efficiency of the reporting process:
- udrCollectFilter.exe - Used to create filters for metric groups that are generally not expected to return data.
- udrCollectMgr.exe - Used to run UCM from the command line.
- udrCollectStat.exe - Used to create reports or to display the status information from the command line.
The default location of these utilities is C:\Program Files\BMC Software\Patrol3\BEST1\NTC\bgs\bin.
UDR Collect Filter utility
This utility creates filters for metric groups that are generally not expected to return data. With the filter, the metric groups are ignored to determine the status of a data collection request.
Before creating any filters, we recommend that you examine all warning messages in the report to verify that only the expected (or "normal") warning messages based on the system configuration are being reported. After you have determined that the messages are expected, create filters by running udrCollectFilter.exe from the following location: baseInstallationDirectory\NTC\bgs\bin
Commands and flags
The following commands work together to create the list of filters by reading the status logs from the previous Manager runs. A separate file (.flt) is created for each node at the following path: C:\Program Files\BMC Software\Patrol3\BEST1\NTC\local\manager\filters
UDR Collect Filter commands
Use the following command syntax to run the utility:
udrCollectFilter.exe [-b performAgentDirectory] [-c consoleDirectory] [-n nodeName] [-r] [-z]
For example:
UDR Collect Mgr utility
The UDR Collect Mgr utility enables you to run UCM from a command line. Use udrCollectMgr.exe to invoke a Manager run, manage files generated in prior runs, or stop a current run.
The following table describes the commands and parameters used when you run UCM from the command line:
Use the following command syntax to run the utility:
udrCollectMgr.exe [-b consoleDirectory] -d runDate -v managerRunName [-k | -c | -r]
Task | Description | Command |
|---|---|---|
To stop a Manager run | The collect script checks for the existence of the run.quit file for the specified run. If the file exists, the script issues a termination request to UDR Collection Manager. Terminating a run requires the run date, Manager run file name, and use of the -k command. After execution, the command returns TERMINATE if successful, and issues a request to terminate the running UCM for the associated run date and Manager run name. | udrCollectMgr.exe -b C:\Program Files\BMC Software\Patrol3\BEST1\NTC -d <runDate> -v <managerRunName> -k |
To remove UCM files | The cleanup command removes all the status, context, and log files for the expired entries in the collection manager registration file. It also removes all of the expired entries in the collection manager registration file. After execution, the command returns CLEANUP and generates a log file (udrCollectMgrCleanup.log), which is located in the same log directory. | udrCollectMgr.exe -b C:\Program Files\BMC Software\Patrol3\BEST1\NTC -c |
UDR Collect Stat utility
The UDR Collect Stat utility enables you to create a Data Collection Status report from the command line, or to display a variety of status information for Manager runs. Begin by running udrCollectStat.exe from the following location:
baseInstallationDirectory\NTC\bgs\bin
The default location for this utility is: C:\Program Files\BMC Software\Patrol3\BEST1\NTC\bgs\bin
The following table describes the commands and parameters used when you run UDR Collect Stat:
Use the following command syntax to run the utility:
udrCollectStat.exe [-O or -D or -G or -E] [-b consoleDirectory] [-s scriptName] [-r managerRunName] [-d runDate] [-f outputFormat] [-e] [-w] [-o]
Task | Command | |
|---|---|---|
To display an overview of a specific run | Use the following command to display an overview of a specific run: udrCollectStat.exe -O -r <managerRunName> | |
To display the details of a specific run with formatted output | Use the following command to display the details of a specific run using the -f flag to display the state of the run, the data collection health, and the total number of errors: udrCollectStat.exe -D -r <managerRunName> -f %s, %ch, %e | |
To generate status reports | Use the following command to update the .xml pages in the status directory for the web-based Data Collection Status report: udrCollectStat.exe -G -s <managerRunName> -d <runDate> | |
To output a comma-separated list of all error messages | Use the following command to display a comma-separated list of all error IDs, error levels, and descriptor strings: udrCollectStat.exe -E |
Format tokens for -O command
The following table lists the tokens that can be used by the UDR Collect Stat utility for the -O command:
Format tokens for -D command
The following table lists the tokens that can be used by the UDR Collect Stat utility for the -D command: