HCL Workload Automation, Version 9.4

Installing and configuring the Tivoli Monitoring agent for HCL Workload Automation

Procedure to install the agent on Windows and non-Windows workstations.

About this task

Follow these steps to install and configure the Tivoli Monitoring agent for HCL Workload Automation.

Installing and configuring on Windows workstations

Before you begin

The workstation where you install the Tivoli Monitoring agent for HCL Workload Automation depends on how you set up your topology. Two environments are supported: remote and local.

In a local environment, the Tivoli® Enterprise Monitoring server and Tivoli Enterprise Portal server must be installed on the same workstation as the HCL Workload Automation master domain manager. The Tivoli Monitoring agent for HCL Workload Automation is installed on the same workstation as the HCL Workload Automation master domain manager.

In a remote environment, the Tivoli Enterprise Monitoring server and Tivoli Enterprise Portal server are installed on different workstation than the HCL Workload Automation master domain manager. In this type of environment, you must first install the Tivoli Monitoring OS agent on the same workstation as the HCL Workload Automation master domain manager before installing the Tivoli Monitoring agent for HCL Workload Automation. When installing the OS agent, in addition to selecting the Tivoli Enterprise Monitoring Agent for your OS, select all of the associated subcomponents in the list.

Procedure

To install and configure the Tivoli Monitoring agent for HCL Workload Automation on Windows workstations in both a local and remote environment:
Local environment
1. To install the agent, submit the following command from the ITM folder located in <TWS_HOME>:
```
installIra.bat <ITM_installation_directory>
 [[-h <HUB_TEMS_hostname>]
   -u <HUB_TEMS_username>
 [-p <HUB_TEMS_password>]] [-r]
```
where:
<ITM_ installation_directory>

The Tivoli Monitoring installation directory. This value is optional and if it is not specified, then the value of the Tivoli Enterprise Monitoring server installation directory is used. The default value for this directory is: C:\IBM\ITM.

-h <HUB_TEMS_hostname>

The host name of the Tivoli Enterprise Monitoring server.

-u <HUB_TEMS_username>

The user name of the user accessing the Tivoli Enterprise Monitoring server.

-p <HUB_TEMS_password>

The password for the user accessing the Tivoli Enterprise Monitoring server.

-r

Restarts the Tivoli Enterprise Portal server.

In a local environment, even if the host name, username and password are not specified when you submit the command, the Tivoli Monitoring agent is installed successfully because it assumes the localhost as the host name and proceeds with the installation.
Remote environment
Before installing the Tivoli Monitoring agent for HCL Workload Automation you must first install the Tivoli Enterprise Monitoring Server and the Tivoli Enterprise Portal server support files on the workstation where the Tivoli Enterprise Monitoring Server and the Tivoli Enterprise Portal server are installed.
1. Copy the ITM folder located in <TWS_HOME> to the workstation where the Tivoli Enterprise Monitoring Server and Tivoli Enterprise Portal server are installed.
2. Submit the following command to install the Tivoli Enterprise Monitoring Server support files:
```
installIraAgentTEMS.bat <ITM_installation directory> 
```
3. Submit the following command to install the Tivoli Enterprise Portal server support files:
```
installIraAgentTEPS.bat <ITM_installation directory> 
```
4. From the ITM folder located in your <TWS_HOME> path, submit the following command to install the agent:
```
installIraAgent.bat <ITM_OS_agent_installation_directory> 
```
where,
<ITM_installation_directory>

The Tivoli Monitoring installation directory. In a remote environment, this value is obligatory and corresponds to the installation directory of the Tivoli Monitoring OS agent. The default value for this directory is: C:\IBM\ITM.

<ITM_OS_agent_installation_directory>

The directory where the Tivoli Monitoring OS agent is installed. The Tivoli Monitoring OS agent is installed on the same workstation as the HCL Workload Automation master domain manager.
The Tivoli Monitoring agent for HCL Workload Automation is listed in the Manage Tivoli Enterprise Monitoring Services.
Right-click the entry Monitoring Agent for HCL Workload Automation and select Configure Using Defaults. The Monitoring Agent for Windows OS: Agent Advanced Configuration window is displayed.
In the Primary TEMS Connection section, leave the default setting for Protocol 1 to IP.PIPE.
In the Advanced settings section, specify the hostname or IP Address for the Tivoli Enterprise Monitoring Server and then click OK. You are prompted to enter values for various agent configuration parameters.

Set the values for the following agent configuration parameters. Click Next to continue with the next set of parameters.

Table 1. Agent configuration parameters
Agent configuration parameters	Value
TWS HOME	The path to the HCL Workload Automation home directory. If you accepted the default values when you installed HCL Workload Automation then by default, this path is: C:\Program Files\IBM\TWA\TWS.
TWS LOG FILE	TWS_LOG_FILE The name of the log file, event.log, that is to be monitored for job events and workstation status. You must specify its complete path in the BmEvents.conf file.
TWS_INSTANCE	TWS_MASTER_NAME The value for the thiscpu attribute in the localopts file located in the HCL Workload Automation installation directory on the host. TWS_INSTANCE_NAME The name of your subdomain manager if you have one. If not, it is the same as TWS_MASTER_NAME. TWS_MASTER_DOMAIN The domain name of your master domain manager.
TWS_INFO	TWS_MDM The fully qualified host name of the master domain manager. TWS_BMDM The fully qualified host name of the backup master domain manager. MDMPORT The port number of the master domain manager. TDWC1 The fully qualified host name of the primary Dynamic Workload Console. TDWC2 Optional, the fully qualified host name of the secondary Dynamic Workload Console.
Application Status	To monitor applications, click New for each application you want to monitor and enter the host short name of the workstation on which you want to monitor applications.
Job Status	If the BmEvents.conf file has been modified to write job, job stream, and workstation status to a file, then click New to monitor job, job stream and workstation status and enter the short host name of the workstation where the BmEvents.conf file is located.
Workstations	To monitor workstations, click New for each workstation you want to monitor and enter the short host name of the workstation.

After you have finished specifying the agent configuration parameters, click OK. The status of the agent is Stopped.

By default, the Tivoli Enterprise Portal shows a maximum of 100 events. To increase this number, right-click the entry Monitoring Agent for HCL Workload Automation and select Advanced > Edit ENV File to modify the following environment variable to the value you want:
```
CDP_PURE_EVENT_CACHE_SIZE
```
If you make this change while the HCL Workload Automation agent is running, to make it effective you must restart the agent.
To start the agent, from the Manage Tivoli Enterprise Monitoring Services window, right-click the entry Monitoring Agent for HCL Workload Automation and select Start.
Note: In a remote environment where HCL Workload Automation and Tivoli Enterprise Monitoring server are installed on different workstations, ensure that the Tivoli Monitoring OS agent is started before you start the Tivoli Monitoring agent for HCL Workload Automation.
Launch the Tivoli Enterprise Portal. The agent is displayed in the Navigator pane together with any agent configuration settings.

Installing and configuring on non-Windows workstations

Before you begin

The workstation where you install the Tivoli Monitoring agent for HCL Workload Automation depends on how you set up your topology. Two environments are supported: remote and local.

In a local environment, the Tivoli Enterprise Monitoring server and Tivoli Enterprise Portal server must be installed on the same workstation as the HCL Workload Automation master domain manager. The Tivoli Monitoring agent for HCL Workload Automation is installed on the same workstation as the HCL Workload Automation master domain manager.

About this task

The Tivoli Monitoring agent for HCL Workload Automation on non-Windows workstations:

Procedure

To install and configure the Tivoli Monitoring agent for HCL Workload Automation on non-Windows workstations in both a local and remote environment:
Local environment
1. From the ITM folder located in your <TWS_HOME> path, submit the following command to install the agent:
```
installIra.sh <ITM_installation_directory>
 [[-h <HUB_TEMS_hostname>]
   -u <HUB_TEMS_username>
 [-p <HUB_TEMS_password>]] [-r]
```
where:
<ITM_installation_directory>

The Tivoli Monitoring installation directory. This value is optional and if it is not specified, then the value of the Tivoli Enterprise Monitoring server installation directory is used. The default value for this directory is: opt/IBM/ITM.

-h <HUB_TEMS_hostname>

The host name of the Tivoli Enterprise Monitoring server.

-u <HUB_TEMS_username>

The user name of the user accessing the Tivoli Enterprise Monitoring server.

-p <HUB_TEMS_password>

The password for the user accessing the Tivoli Enterprise Monitoring server.

-r

Restarts the Tivoli Enterprise Portal server.

In a local environment, even if the host name, username and password are not specified when you submit the command, the Tivoli Monitoring agent is installed successfully because it assumes the localhost as the host name and proceeds with the installation.
Remote environment
Before installing the Tivoli Monitoring agent for HCL Workload Automation you must first install the Tivoli Enterprise Monitoring Server and the Tivoli Enterprise Portal server support files on the workstation where the Tivoli Enterprise Monitoring Server and the Tivoli Enterprise Portal server are installed.
1. Copy the ITM folder located in your <TWS_HOME> path to the workstation where the Tivoli Enterprise Monitoring Server and the Tivoli Enterprise Portal server are installed.
2. Submit the following command to install the Tivoli Enterprise Monitoring Server support files:
```
installIraAgentTEMS.sh <ITM_installation directory> 
```
3. Submit the following command to install the Tivoli Enterprise Portal server support files:
```
installIraAgentTEPS.sh <ITM_installation directory> 
```
4. From the ITM folder located in your <TWS_HOME> path, submit the following command to install the agent on the HCL Workload Automation master domain manager:
```
installIraAgent.sh <ITM_OS_agent_installation_directory> 
```
where,
<ITM_installation_directory>

The Tivoli Monitoring installation directory. In a remote environment, this value is obligatory and corresponds to the installation directory of the Tivoli Monitoring OS agent. The default value for this directory is: opt/IBM/ITM.

<ITM_OS_agent_installation_directory>

The directory where the Tivoli Monitoring OS agent is installed. The Tivoli Monitoring OS agent is installed on the same workstation as the HCL Workload Automation master domain manager.
Configure the Tivoli Monitoring agent for HCL Workload Automation by submitting the following command from the <ITM_OS_agent_installation_directory>/bin directory:
```
./itmcmd config –A qs
```
where,
qs

Product code of the Tivoli Monitoring agent for HCL Workload Automation

Enter the host name or IP address of the remote workstation where Tivoli Enterprise Monitoring Server and Tivoli Enterprise Portal server are installed.

You are prompted to edit the settings for the following agent configuration parameters. Enter 1 to accept. After specifying each set of parameters, press Enter to continue to the next set.

Table 2. Agent configuration parameters
Agent configuration parameters	Value
TWS HOME	The path to the HCL Workload Automation home directory. If you accepted the default values when you installed HCL Workload Automation then by default, this path is: /opt/IBM/TWA/TWS.
TWS LOG FILE	TWS_LOG_FILE The path to the log file, event.log, that needs to be monitored for job events and workstation status. This is the value in the BmEvents.conf file.
TWS_INSTANCE	TWS_MASTER_NAME The value for the thiscpu attribute in the localopts file located in the HCL Workload Automation installation directory on the host. TWS_INSTANCE_NAME The name of your subdomain manager if you have one, if not, it is the same as TWS_MASTER_NAME. TWS_MASTER_DOMAIN The name of your master domain manager.
TWS_INFO	TWS_MDM The fully qualified host name of the master domain manager. TWS_BMDM The fully qualified host name of the backup master domain manager. MDMPORT The port number of the master domain manager. TDWC1 The fully qualified host name of the primary Dynamic Workload Console. TDWC2 Optional, the fully qualified host name of the secondary Dynamic Workload Console.
Application Status	To monitor applications, enter 1 in the Edit Application Status settings section. For each application you want to monitor, enter the host short name of the workstation on which you want to monitor applications. If you do not want to monitor application status on this host, enter 4 to point to the application status of the newly created instance. Enter 5 to move to the Job Status settings section.
Job Status	If the BmEvents.conf file has been modified to write job, job stream, and workstation status to a file, then enter 1 to monitor job, job stream, and workstation status and enter the short host name of the workstation where the BmEvents.conf file is located. If you do not want to perform this type of monitoring, enter 5 to move to the next settings section.
Workstations	To monitor workstations, enter 1 for each workstation you want to monitor and enter the short host name of the workstation. If you do not want to perform this type of monitoring, enter 5 to move to the next settings section.

When asked if the agent will connect to a Tivoli Enterprise Monitoring server, leave the default value 1=YES.
When prompted to specify the Network Protocol, leave the default value ip.pipe.
By default, the Tivoli Enterprise Portal shows a maximum of 100 events. To increase this number, edit the <ITM_installation_directory>/config/qs.ini file to modify the following environment variable to the value you want:
```
CDP_PURE_EVENT_CACHE_SIZE
```
If you make this change while the HCL Workload Automation agent is running, to make it effective you must restart the agent.
The Tivoli Monitoring agent for HCL Workload Automation is installed and configured and is visible from the Tivoli Enterprise Portal. Before starting the agent, ensure that the Tivoli Monitoring OS agent is started first. To start the Tivoli Monitoring OS agent on a Linux workstation, submit the following command:
```
./itmcmd agent start lz
```
where
lz

Product code of the Tivoli Monitoring OS agent On Linux.
To start the agent, submit the following command from the ITM_installation_directory/bin directory in a local environment for from the ITM_OS_agent_installation_directory/bin directory in a remote environment:
```
./itmcmd agent start qs
```
where,
qs

Product code of the Tivoli Monitoring agent for HCL Workload Automation.

To stop the agent, submit the following command:
```
./itmcmd agent stop qs
```
To ensure that the Tivoli Monitoring agent for HCL Workload Automation is running, submit the command:
```
./cinfo –r
```
Launch the Tivoli Enterprise Portal. The agent is displayed in the Navigator pane together with any agent configuration settings.