Installing and Configuring TIBCO EMS Plug-in Microagent

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

To configure the plug-in microagent, follow these steps:

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

-hma_plugin_dir CONFIG_FOLDER/plugin

5. Navigate to CONFIG_FOLDER/plugin directory, open the hawkemsadmin.hma file in a text editor, and specify the following details:

In the <classname> element, specify the Hawk microagent class that must be used.

— To only monitor the server, use the HawkListener class.
— To monitor and manage the server, use the HawkController class.
— Specify the username, password, and server URL that must be used to connect to the TIBCO Enterprise Message Service server in the appropriate <arg> elements. For description of the parameters, 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.
6. Restart the Hawk agent.

Parameters

Parameter

Description

-user

-password

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

When unspecified, the default user name is admin and the default password is an 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 tibhawkpassword Hawk utility program located in the CONFIG_FOLDER/bin directory:

   tibhawkpassword -encrypt

Enter your current password when prompted. For details, see TIBCO® Operational Intelligence Hawk® RedTail Installation, Configuration, and Administration.

-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 TIBCO EMS server to respond to queries.

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

-version

TIBCO 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 situations.

-ssl_vendor

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

• j2se-default—Use this option to use the default JCE bundled with the TIBCO EMS.
• Java JRE—On IBM platforms (such as AIX), this option defaults to ibm.
• j2se
• entrust61—Use this option 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 OI Hawk RedTail components.

-ssl_expected_hostname

The name that is expected in the name of the CN field of the server certificates are 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 TIBCO OI Hawk RedTail component.

-traceDir

Path of the TIBCO EMS plug-in trace directory default is CONFIG_FOLDER/logs

-traceFilename

Name of the trace file.

Default value: emshma.log.

-traceLevel

Trace log level.

Default value: 7, that is info.