Installation and Configuration

TIBCO Hawk installer installs Enterprise Message Service Plug-in microagent in TIBCO_HOME/hawk/<version>/plugin/ems folder.

To configure the plug-in, follow these steps:

1. Make sure that TIBCO Enterprise Message Service is installed and running.
2. Ensure that the TIBCO Enterprise Message Service installation path is set in the hawkemsadmin.hma file(located in TIBCO_HOME/hawk/<version>/plugin/ems folder).
3. Copy the file hawkemsadmin.hma from TIBCO_HOME/hawk/<version>/plugin/ems to CONFIG_FOLDER/plugin.
4. Edit hawkagent.cfg in CONFIG_FOLDER/bin and set the following option:

-hma_plugin_dir CONFIG_FOLDER/plugin

5. Navigate to CONFIG_FOLDER/plugin directory and open the hawkemsadmin.hma file in a text editor.
6. Specify the TIBCO Hawk microagent class you wish to use in the <classname> element. You can use either the HawkListener class if you only want to monitor the server, or you can specify the HawkController class if you want to monitor and manage the server.
7. Specify the username and password and server URL to use to connect to the TIBCO Enterprise Message Service server in the appropriate <arg> elements. See Parameters.

For example:

<arguments>
<arg>-user</arg>
<arg>admin</arg>
<arg>-password</arg>
<arg>MyPassword</arg>
<arg>-server</arg>
<arg>tcp://server1.yourcompany.com:7222</arg>
<arg>-timeout</arg>
<arg>5</arg>
</arguments>

Note 

To use an SSL connection to the TIBCO Enterprise Message Service server, set the additional SSL arguments in the hawkemsadmin.hma file.
8. Restart the Hawk Agent.

Parameters

Parameters

Parameter

Description

-user

-password

The MicroAgent identifies itself with this user name and password when it connects to the EMS server.

When absent, the default user name is admin. When absent, the default password is the empty string.

-user

-encryptedPassword

To use an encrypted password, specify this pair. As the value for -encryptedPassword, supply the output you obtain by running the Hawk utility program tibhawkpassword located in your CONFIG_FOLDER/bin directory:

   tibhawkpassword -encrypt

Enter your current password when prompted. See the TIBCO Hawk Installation and Configuration Guide for details.

-server

The MicroAgent connects to the EMS server at this URL (host computer and port). When absent, the default is tcp://localhost:7222.

-timeout

Limits the time (in seconds) that the MicroAgent waits for the EMS server to respond to queries.

Acceptable values are in the range [5, 3600]. When absent, the default is 60.

-version

EMS server version

-server_in_agent_name

Includes the server url with the microagent name.

To monitor multiple servers on one Hawk agent, you must include the -server_in_agent_name argument in the hawkemsadmin.hma file.

-ssl_trace

Prints the certificates loaded by the server and do more detailed tracing of SSL-related situation.

-ssl_vendor

The name of the vendor of the SSL implementation. The valid choices are:

• j2se-default—Use this option when you want to use the default JCE bundled with the
• Java JRE
• j2se
• entrust61—Use this option when you want to use the Entrust libraries.
• ibm—On non-IBM platforms, this option can be used only if the IBM version of JCE is installed.

-ssl_trusted

Specifies the file name of the server certificates. This option can be repeated if more than one certificate file is used.

-ssl_identity

Specifies the digital certificate of the TIBCO Hawk components.

-ssl_expected_hostname

The name that is expected in the name of the CN field of the server certificates is specified by this option. The value of this option is used when the -ssl_no_verify_hostname option is absent from the configuration file.

-ssl_password

The password to decrypt the identity file of the Hawk component.

-traceDir

Path of EMS plugin trace directory default is <CONFIG_FOLDER>/logs

-traceFilename

Name of the trace file. Default is emshma.log.

-traceLevel

Trace log level. The default value is 7, that is info.