Using the Configure Monitoring Utility
The command-line utility, ConfigureMonitoring, provides an alternative mechanism for deploying and undeploying monitoring configurations. This utility is located in the CONFIG_FOLDER
/hawk/bin
directory. The log file for this utility is hawkconsole.log
, and is created in the directory from which this command is invoked.
See Security Considerations for the permissions required to use the ConfigureMonitoring utility.
Using the ConfigureMonitoring utility you can:
• | Upload a single MAR file into TIBCO Administrator |
The -upload
command uploads a single MAR file into TIBCO Administrator. If this is a new MAR file, a new monitoring application is created with the same name as the MAR file. If it already exists and if the contained monitoring configuration are in the Deployable state, the existing data is overwitten.It cannot update if any of the monitoring configurations in the deployed state.
Example: ConfigureMonitoring.exe -upload -mar myMarFile.mar -domain myHawkDomain -user admin -pw adminpw
Hawk RulebaseMaps and Schedules are also similarly deployed. Only one RulebaseMap and Schedule file can be deployed per domain. The RulebaseMap file has to be named rbmap.hrm
and the Schedules file has to be named schedules.hsf
.
Example: ConfigureMonitoring.exe -upload -mar rbmap.hrm -domain myHawkDomain -user admin -pw adminpw
• | Retrieve all potential targets for all monitoring configurations within the specified monitoring application. |
The -getTargets
command retrieves all potential targets for a given monitoring application in the TIBCO Administrator domain. An XML file containing the targets is created in the current directory. The name of the XML file has the format <MAR_file_name>-targets.xml
, where <MAR_file_name> is the MAR file for which the targets are retrieved.
Example: ConfigureMonitoring.exe -getTargets -monitoringAppName myMarFile -domain myHawkDomain -user admin -pw adminpw
This command creates the XML file myMarFile-targets.xml
.
Note |
You can edit the XML file created by the |
• | Deploy monitoring configurations |
The -deploy
command configures and deploys the monitoring configurations on the targets specified in the target file. The status of deploying each monitoring configuration on each identified target is displayed.
Example: ConfigureMonitoring.exe -deploy -targets myMarFile-targets.xml -monitoringAppName myMarFile -domain myHawkDomain -user admin -pw adminpw
• | Undeploy monitoring configurations |
The -undeploy
command undeploys the monitoring configurations from the targets specified in the target file. The status of undeploying each monitoring configuration from each identified target is displayed.
Example: ConfigureMonitoring.exe -undeploy -targets myMarFile-targets.xml -monitoringAppName myMarFile -domain myHawkDomain -user admin -pw adminpw
• | Delete monitoring applications (MAR file) |
The -delete
command deletes the specified monitoring application from the TIBCO Administrator domain. To remove a monitoring application, none of its monitoring configurations and its targets should be in the deployed state.
Example: ConfigureMonitoring.exe -delete -monitoringAppName myMarFile -domain myHawkDomain -user admin -pw adminpw
The following table describes the input parameters for the ConfigureMonitoring utility.
Input |
Description |
|
The TIBCO Administrator domain name. |
-targetDomains |
(Optional) The domains where you want to deploy the specified monitoring configurations. If this option is not specified, the monitoring configuration is deployed in the TIBCO Administrator domain. The domains are specified within double-quotes (""). Specify multiple domains using a comma separated list. For example, |
|
The MAR file name. If the MAR file is not located in the current directory, specify the complete path name.
|
-user |
An authenticated TIBCO Administrator user having Read-Write permissions. |
-pw |
The password for the TIBCO Administrator user specified by the |
|
The file containing targets for a MAR file. |
|
The monitoring application name. |
-initTime |
(optional) The default time, in seconds, to wait for the Hawk components to initialize before executing the ConfigureMonitoring command. The default value is |
|
The credential file containing user credentials (user and pw) specified as properties. The password can be specified either in plain text or encrypted form. Passwords can be encrypted using password encryption tool. On Microsoft Windows platforms, the tool is |