Prerequisites for installing OSLC Execute Automation Service Provider on IBM Tivoli Monitoring

Before you install OSLC Execute Automation Service Provider on IBM® Tivoli® Monitoring (ITM), you must configure your environment to meet all prerequisites.

ITM OSLC Execute Automation Service Provider must be installed on ITM Tivoli Enterprise Portal Server (TEPS) host. The supported version of IBM Tivoli Monitoring is IBM Tivoli Monitoring 6.3.

Configuring ITM Tivoli Enterprise Monitoring Server (TEMS) and ITM TEPS hosts

Fix Pack 5Step 1- Reconfiguring TEMS and TEPS
Fix Pack 5

The TEMS and TEPS configuration is best done using the Manage Tivoli Enterprise Monitoring Services (MTEMS) GUI.

For the Windows OS, start the ITM kinconfig .exe process to bring up he Manage Tivoli Enterprise Monitoring Services (MTEMS) GUI.

For Unix/Linux you can start the MTEMS GUI using the CLI command “./itmcmd manage”.

For each of the two ITM components (TEMS and TEPS) :
  • Highlight the component on the MTEMS UI
  • Right click and select Reconfigure

This will take you into the TEMS or the TEPS configuration window.

Provide all the TEMS parameters correctly (TEMS Type, TEMS Name and protocol in the main configuration settings and Hostname/IP Address and Port in the Advanced settings) and select “OK”.

Select “Enable the dashboard data provider” in the TEPS configuration window.

Fix Pack 5Step 2 - Executing TADDM Scripts and Configuration
Fix Pack 5This step includes the execution of two main TADDM scripts to help setup the integration of TADDM to ITM.
1. Configure the provider.properties file
ITM TEMS host
Enable KT1 commands (tacmd get/put/execute) by running one of the following scripts on ITM TEMS host:
  • For Linux® operating system:
    TADDM_CD_ISO/itm-discovery-support/configure_tems.sh <-i <ITM_HOME>> [-t <TEMP-DIR>
  • For Windows operating system:
    TADDM_CD_ISO/itm-discovery-support/configure_tems.ps1 <-i <ITM_HOME>> [-t <TEMP-DIR>
where <ITM_HOME> is the directory of ITM TEPS installation, for example /opt/IBM/ITM, and <TEMP-DIR> is the temporary files destination directory. The default value of the <TEMP-DIR> parameter is /var/log/automation_provider.
Fix Pack 5When completed you should see the following lines at the end of the script execution.
INFO: Stopping ITM TEPS...
INFO: ITM TEPS has stopped.
INFO: Starting ITM TEPS...
INFO: ITM TEPS has started.
INFO: Checking if TEPS is running...
INFO: Checking if OSLC Automation Provider is installed...
INFO: Installation of OSLC Automation Provider successfully finished.
Note: TADDM integration with ITM using OSLC Automation relies on the ITM KT1 facility. You must verify that KT1 has been enabled on the Hub by running a getFile command. The instructions for running getFile command are provided in https://www.ibm.com/docs/en/tivoli-monitoring/6.3.0?topic=commands-tacmd-getfile.
ITM TEPS host
Verify whether ITM dashboard data provider is installed or enabled. If not, optionally install or enable it. See the Verifying the dashboard data provider is enabled topic in the IBM Tivoli Monitoring documentation.
Important: If you use 64-bit Windows operating system, make sure that your system PATH (or path entry in the kfwenv file) points to 64-bit TMAITM6 directory. If it is not there, add it manually. For example, if you have ITM installed in the C:\IBM\ITM\ directory, you must have C:\IBM\ITM\TMAITM6_x64 specified in either system path environment variable or in the PATH directive in the C:\IBM\ITM\CNPS\kfwenv file.
Fix Pack 5
Fix Pack 52. Run the automation_provider script from ITM TEPS host
Fix Pack 5Execute the automation_provider script on your server:
  • For Linux operating system:
    automation_provider.sh install  -t /tmp/log  -i /opt/IBM/ITM -c /tmp/provider.properties
  • For Windows operating system:
    automation_provider.ps1 install  -t /tmp/log  -i /opt/IBM/ITM -c /tmp/provider.properties
An important point to note here is that even if a provider.properties file is created prior to running the automation_provider script, this is ignored and a 'default' provider.properties is created in the ITM TEPS config path($ITM_HOME/iw/profiles/ITMProfile/installedApps/ITMCell/itmautomationprovider.ear/itmautomationprovider.war/WEB-INF/provider.properties)
Fix Pack 5You will have to locate this file, manually make the changes to the parameters and then restart the TEPS for the file to be effective.

Required files

The following files must be present in the directory, from which you run the installation script:
  • The installation script:
    • For Linux and AIX® operating systems: TADDM_CD_ISO/itm-discovery-support/automation_provider.sh, and its submodules located in the TADDM_CD_ISO/itm-discovery-support/mod/sh/.
    • For Windows operating system: TADDM_CD_ISO/itm-discovery-support/automation_provider.ps1, and its submodules located in the TADDM_CD_ISO/itm-discovery-support/mod/ps/.
  • itmautomationprovider.ear - the package with ITM OSLC Execute Automation Service Provider. The exact location of the file is TADDM_CD_ISO/itm-discovery-support/ear/itmautomationprovider.ear.
  • provider.properties - the example configuration file for ITM OSLC Execute Automation Service Provider. The file can be configured manually and passed to install script as a parameter. If not passed, you must provide the required parameters during the installation. The exact location of the file is TADDM_CD_ISO/itm-discovery-support/template_provider.properties.
  • KT1 support libraries for the appropriate operating system and its architecture, 32 or 64 bit.
    • For Linux operating system:
      TADDM_CD_ISO/itm-discovery-support/linux32
TADDM_CD_ISO/itm-discovery-support/linux64
    • For AIX operating system:
      TADDM_CD_ISO/itm-discovery-support/aix32
TADDM_CD_ISO/itm-discovery-support/aix64
    • For Linux on IBM System Z (zLinux):
      TADDM_CD_ISO/itm-discovery-support/linuxz32
TADDM_CD_ISO/itm-discovery-support/linuxz64
    • For Windows operating system:
      TADDM_CD_ISO/itm-discovery-support/win32
TADDM_CD_ISO/itm-discovery-support/win64
Note:
  1. For TADDM-ITM integration prior to ITM v630 FP7 SP7, contact ITM support to obtain the latest libraries that must be installed on TEPS. The name of the libraries to ask from ITM support can be taken from file names present in above directories in TADDM_CD_ISO. The libraries should then be copied/replaced in the above directories for appropriate Operating System and architecture(32 bit vs 64 bit) before you run the installation.
  2. For TADDM-ITM integration onwards ITM v630 FP7 SP7, copy the new KT1 libraries from the TEPS lib directory of ITM, replace those in the above directories corresponding to operating system and architecture before running the installation script.

Configuring the provider.properties file

You shall optionally configure the provider.properties file by setting the following parameters:
  • com.ibm.automationprovider.registration.host=http://localhost:15210 - enables connection to ITM. The value specifies a public URL for TEPS. The default value of this parameter is http://localhost:15210.
    Note: Modify the localhost to represent the hostname or IP address of TEPS server.
  • com.ibm.automationprovider.itm.curi.url=http://localhost:15210 - specifies the URL address of ITM CURI (REST) provider. The default value is http://localhost:15210.
    Note: Modify localhost in this case to represent the hostname or IP address of your TEPS server.
  • com.ibm.automationprovider.itm.soap.url=http://localhost:1920///cms/soap - specifies the URL address of ITM SOAP. The default value is http://localhost:1920///cms/soap.
    Note: Modify localhost in this case to represent the hostname or IP address of your hub TEMS server, which may or may not be on the same host as your TEPS (most production environments should have TEMS and TEPS on separate servers).
Note: If you have nondefault configuration of ITM CURI or ITM SOAP, or if you configured SSL security on ITM TEPS, or both, make sure that you specify correct URL addresses for the com.ibm.automationprovider.itm.curi.url and com.ibm.automationprovider.itm.soap.url properties.

The values of the parameters specified in the provider.properties file have precedence over the values of the parameters defined from command line.

Fix Pack 5If you intend to run a discovery on the RTEMS then ensure that you have the parameter "KT1_TEMS_SECURE=YES" enabled in the environment file on the hub.

Registering OSLC Execute Automation Service Providers in JAZZ SM Registry Services (FRS)

You can optionally register OSLC Execute Automation Service Providers in JAZZ SM Registry Services. Choose one of the following methods:
  • Add the following parameters to the provider.properties file:
    • com.ibm.automationprovider.frs.url - specifies FRS URL address for registration of OSLC Execute Automation Service Provider. The full URL address of the collection is required, for example http://9.122.100.100:9083/oslc/pr/collection.
    • com.ibm.automationprovider.frs.user - specifies the user name that is used for connection to FRS.
    • com.ibm.automationprovider.frs.password - specifies the password that is used for connection to FRS.
    • com.ibm.automationprovider.registration.initialdelay=5000 - specifies the time between the start of OSLC Execute Automation Service Provider and the first attempt to register in FRS. The default value is 5000 and is expressed in milliseconds. To disable the registration, set the value to -1.
  • Add the -f option in the command line, for example ./automation_provider.sh -f, and during the provider installation, when prompted, provide the required parameters.