Connecting IBM Tivoli Monitoring agents to Cloud App Management server

To connect IBM® Tivoli® Monitoring agents to Cloud App Management server, you must first apply an agent patch either locally or remotely to update the agent framework and then configure the agent for server connection.

Before you begin

  • Download the agent patch from IBM Fix Central launch icon:
    • To connect the IBM Tivoli Monitoring agents to Cloud App Management server over HTTP, download 6.3.0.7-TIV-ITM_TEMA-IF0003 or a later patch.
    • To connect the IBM Tivoli Monitoring agents to Cloud App Management server over HTTPS, download 6.3.0.7-TIV-ITM_TEMA-IF0008 or a later patch.
  • Linux or UNIX(Local configuration only) Determine the architecture of the target operating system to select the appropriate patch file to apply.
    Tip: Use the install_dir/bin/cinfo script to get the architecture code of the operating system.
  • (Remote configuration only) Make sure the OS agent is installed on the remote system.
  • (WebSphere® Applications agent) Transaction tracking data is not yet supported by Cloud App Management. If the V6 agent has been enabled for transaction tracking data collection, reconfigure the V6 agent to disable it before you connect the V6 agent to the Cloud App Management server. For more information, see the V6 agent documentation.
  • Be aware of the following limitations before you proceed to apply the agent patch.
    Known limitation:
    • The agent patch cannot be applied on the system where the monitoring server or portal server is also installed.
    • After the agent patch is applied, the agent subscription facility (ASF) is started. Many ASF related activities might be logged. You can ignore these messages in logs and no action is required.

Procedure

Locally configuring the agent to connect to Cloud App Management server

Procedure

  1. Extract the agent patch to the local system where the V6 agent is installed.
    • For HTTP connection, extract 6.3.0.7-TIV-ITM_TEMA-IF0003.tar or 6.3.0.7-TIV-ITM_TEMA-IF0003.
    • For HTTPS connection, extract 6.3.0.7-TIV-ITM_TEMA-IF0008.tar or 6.3.0.7-TIV-ITM_TEMA-IF0008.

    In the extracted directory, different fix files are included for all supported operating systems. Use the appropriate file for the target operating system in the following steps.

  2. Run the following script to apply the patch.
    • Linux or UNIX
      cd temp_dir/agent_patch
      ./install.sh -h install_dir -q -p `pwd`/unix/tfarch.txt
    • Windows
      cd temp_dir\agent_patch\WINDOWS
      setup.exe /w /z"/sf%cd%\deploy\TF_Silent_Install.txt" /s /f2"install_dir\INSTALLITM\Silent_KTF.log"
    where:
    • temp_dir is the temporary directory that contains the extracted agent patch folder.
    • agent_patch is the agent patch file name, for example, it is 6.3.0.7-TIV-ITM_TEMA-IF0003 for connection over HTTP, and 6.3.0.7-TIV-ITM_TEMA-IF0008 for connection over HTTPs.
    • install_dir is the V6 agent installation directory. For example, /opt/ibm/itm.
    • arch is the architecture code of the operating system. Use the appropriate tfarch.txt file for the target system, for example, tflx8266.txt.
    Troubleshooting on Windows: If some product files are locked by other processes on a Windows system, the deployment might fail and the locked files are reported in the Abort IBM Tivoli Monitoring.log file.

    To solve this problem, manually stop all processes that are locking the files and try again. For example, if you have WebSphere Applications agent installed, you also need to stop the application server that has the agent data collector installed.

    Alternatively, you can add Locked Files=continue to the installation section in the TF_Silent_Install.txt and TFX64_Silent_Install.txt files within in the agent_patch/WINDOWS/Deploy directory and try again.

    For more information about this limitation, see the Locked files encountered during Windows agent silent installation launch icon technote.

  3. Download the agent configuration pack from the Cloud App Management console. The downloaded package contains agent configuration files for server connection.
    1. Log in to the Cloud App Management console and click Get Started.
    2. Click Administration > Integrations > Configure an integration (Incoming).
    3. In the Standard monitoring agents section, go to the ITM/ITCAM Agents tile and click Configure.
    4. Click Download file to download the ibm-cloud-apm-v6-configpack.tar file.
  4. Extract the .tar file on the systems where the V6 agents are installed.

    In the extracted directory, the .tar file is for the Linux and UNIX systems and the .zip file is used for the Windows systems. Use the appropriate file in the following steps according to the type of the target operating system.

  5. If you created private situations, back up your private situation file (ITM_install_dir/localconfig/pc/pc_situations.xml).
    Otherwise, the private situation file will be lost during reconfiguration of the Tivoli monitoring agent to connect to the Cloud App Management server.
  6. To configure the V6 agent for Cloud App Management server connection, extract the .tar or .zip file, and then run the agent2server_itm script:
    • Linux or UNIX
      ./agent2server_itm.sh -i agent_install_dir -e env.properties -c connection_mode
    • Windows
      agent2server_itm.bat -i agent_install_dir -e env.properties -c connection_mode
    where:
    • agent_install_dir is the V6 agent installation directory, for example, /opt/ibm/itm.
    • env.properties is the path to the file that contains all required server properties. By default, it is the env.properties file that is in the same directory of the script file.
      Attention: This -e parameter is optional. You can remove -e env.properties from the command if the properties file is in the default directory.
    • connection_mode is the connection type that you want for the V6 agent. The value can be icam, dual, or itm. If you do not specify any connection type, the default is icam.
      • Use icam to connect the V6 agent to Cloud App Management server and disconnect from Tivoli Enterprise Monitoring Server.
      • Use dual to connect the V6 agent to both Cloud App Management server and Tivoli Enterprise Monitoring Server.
      • Use itm to connect the V6 agent to Tivoli Enterprise Monitoring Server and disconnect from Cloud App Management server.
      Known limitation:
      • In dual mode, if private situations are defined in IBM Tivoli Monitoring, the private situations run and send events to IBM Tivoli Monitoring EIF destinations. The private situations in IBM Cloud App Management (thresholds run on the agent) will not run.
      • In icam mode:
        • If private situations are defined in IBM Tivoli Monitoring, they will not run.
        • The OS agent will still connect to Tivoli Enterprise Monitoring Server to enable remote deploy functions. It will send agent data to Tivoli Enterprise Monitoring Server, and continues to run enterprise situations.
      • In either mode, central configuration files are received from IBM Tivoli Monitoring (if defined) and IBM Cloud App Management in separate folders specific to the server. The files are received no matter whether private situations from that server are run.
  7. Optional: If you want to check the current connection mode of the V6 agents, run the following command:
    • Linux or UNIX
      ./agent2server_itm.sh -i agent_install_dir -m
    • Windows
      agent2server_itm.bat -i agent_install_dir -m
    Important: You can connect the IBM® Tivoli® Monitoring V6 agents to the Cloud App Management server with icam mode or dual mode.
    • If you installed 6.3.0.7-TIV-ITM_TEMA-IF0008 or earlier, any existing configuration files for Private situations and Central Configuration server that are configured for IBM Tivoli Monitoring are backed up and replaced by those files downloaded from the Cloud App Management server. Therefore, Private situations, Private Historical data, and Central Configuration server files that are configured in IBM Tivoli Monitoring are not available in dual mode.
    • If you installed 6.3.0.7-TIV-ITM_TEMA-IF0009 or later, private situations or private historical data that are configured for IBM Tivoli Monitoring are available in dual mode, but thresholds from the Cloud App Management server are not available. Other files from the Tivoli Enterprise Monitoring Server are processed as usual.

What to do next

  • Log in to the Cloud App Management console to view monitoring data.
  • If you are sure that you no longer need to reconnect the agents to Tivoli Enterprise Monitoring Server, remove the offline agents from Tivoli Enterprise Portal.
  • If you enable the icam connection mode, then, to reconnect the agents to Tivoli Enterprise Monitoring Server, see Reconnecting IBM Tivoli Monitoring agents to Tivoli Enterprise Monitoring Server.
  • (IBM MQ(formerly WebSphere MQ) agent only) If you create new agent instances when the agents are connecting to the Cloud App Management server, run the agent2server_itm script again for the new IBM MQ(formerly WebSphere MQ) agent instances to connect to the Cloud App Management server.

Remotely configuring the agent to connect to Cloud App Management server

Procedure

Complete the following steps on a system where the tacmd library is available:

  1. Extract the agent patch to a temporary directory.
    • For HTTP connection, extract 6.3.0.7-TIV-ITM_TEMA-IF0003.tar or 6.3.0.7-TIV-ITM_TEMA-IF0003.
    • For HTTPS connection, extract 6.3.0.7-TIV-ITM_TEMA-IF0008.tar or 6.3.0.7-TIV-ITM_TEMA-IF0008.

    There are different .tar files for different operating systems in the extracted agent patch directory. Use the appropriate file for the target operating system in the following steps.

  2. On the hub monitoring server system, log in to Tivoli Enterprise Monitoring Server by running the following command from the tacmd library:
    tacmd login -s tems_address -u user_name -p password
    where:
    • tems_address is the host name or IP address of the Tivoli Enterprise Monitoring Server.
    • user_name is the user ID that is used to log in to the monitoring server.
    • password is the user password.
  3. Go to the extracted directory that contains the agent patch for the current operating system.
    • Linux or UNIX
      cd temp/agent_patch/unix
    • Windows
      cd temp\agent_patch/WINDOWS/Deploy
    where:
    • temp is the temporary directory that contains the extracted agent patch folder.
    • agent_patch is the agent patch file name, for example, it is 6.3.0.7-TIV-ITM_TEMA-IF0003 for connection over HTTP, and 6.3.0.7-TIV-ITM_TEMA-IF0008 for connection over HTTPS.
  4. Run the following command to populate the agent depot:
    tacmd addbundles -i . -t tf
    After the command is run, more information about the tf component, including its version, is returned.
  5. Run the following command from the tems_install_dir/bin directory to update the agent framework to the version that is returned in Step 4.
    • For connection over HTTP:
      tacmd updateFramework -n node_name -v 063007003
    • For connection over HTTPS:
      tacmd updateFramework -n node_name -v 063007008

    where, node_name is the node name of the operating system where the V6 agent is installed.

    The following example updates the agent framework on the kvm-011235:LZ system.
    • For connection over HTTP:
      tacmd updateFramework -n kvm-011235:LZ -v 063007003
    • For connection over HTTPS:
      tacmd updateFramework -n kvm-011235:LZ -v 063007008
    Troubleshooting on Windows: If some product files are locked by other processes on a Windows system, the deployment might fail and the locked files are reported in the Abort IBM Tivoli Monitoring.log file.

    To solve this problem, manually stop all processes that are locking the files and try again. For example, if you have WebSphere Applications agent installed, you also need to stop the application server that has the agent data collector installed.

    Alternatively, you can add Locked Files=continue to the installation section in the TF_Silent_Install.txt and TFX64_Silent_Install.txt files within in the agent_patch/WINDOWS/Deploy directory and try again.

    For more information about this limitation, see the Locked files encountered during Windows agent silent installation launch icon technote.

  6. Download the agent configuration pack from the Cloud App Management console. The downloaded package contains agent configuration files for server connection.
    1. Log in to the Cloud App Management console and click Get Started.
    2. Click Administration > Integrations > Configure an integration (Incoming).
    3. In the Standard monitoring agents section, go to the ITM/ITCAM Agents tile and click Configure.
    4. Click Download file to download the ibm-cloud-apm-v6-configpack.tar file.
  7. Extract the .zip file to the current system.

    In the extracted directory, the .tar file is for the Linux and UNIX systems and the .zip file is used for the Windows system. Use the appropriate file in the following steps according to the type of the target operating system.

    Windows: If it is difficult to remotely extract the .zip file for Windows systems, you can first extract the configuration pack on the current system and then transfer the extracted file to the remote Windows system one by one.
  8. On the remote system where the V6 agent is installed, create a temporary directory to save the extracted agent configuration pack. You have multiple ways to do it.

    Example:

    The following example uses the tacmd executecommand command to create the /tmp/configpack directory on a Linux system as the remote working directory:
    tacmd executecommand -m kvm-011235:LZ -c "nohup /bin/sh -c 'mkdir /tmp/configpack > /tmp/output'" 
    The following example uses the tacmd executecommand command to create the C:\IBM\ITM\configpack directory on a Windows system as the remote working directory:
    tacmd executecommand -m Primary:IMG-WINDOWS2008:NT -c "md C:\IBM\ITM\configpack"
  9. Transfer the agent configuration pack to the remote system where the V6 agents are installed.

    Example:

    The following example uses the tacmd executecommand command to transfer the linux_unix_configpack.tar file from local /mnt/configpacks directory to the /tmp/configpack directory on the remote kvm-011235:LZ system:
    tacmd putfile -m kvm-011235:LZ -s /mnt/configpacks/linux_unix_configpack.tar -d /tmp/configpack/linux_unix_configpack.tar -t bin
    The following example uses the tacmd executecommand command to transfer the two files extracted from windows_configpack.zip file from local C:\temp\windows_configpack directory to the C:\IBM\ITM\configpack directory on the remote Primary:IMG-WINDOWS2008:NT system:
    tacmd putfile -m Primary:IMG-WINDOWS2008:NT -s C:\temp\windows_configpack\agent2server_itm.bat -d C:\IBM\ITM\configpack\agent2server_itm.bat -t text
    tacmd putfile -m Primary:IMG-WINDOWS2008:NT -s C:\temp\windows_configpack\env.properties -d C:\IBM\ITM\configpack\env.properties -t text
  10. If you created private situations, back up your private situation file (ITM_install_dir/localconfig/pc/pc_situations.xml).
    Otherwise, the private situation file will be lost during reconfiguration of the Tivoli monitoring agent to connect to the Cloud App Management server.
  11. Extract the .tar or .zip file on the remote system if you didn't do it in the previous step, and then run the agent2server_itm script with the -i, -e, and -coptions. Use the -i option to specify the agent installation directory, use the -e option to specify the path to the env.properties file in the extracted directory, and use the -c option to specify the connection mode.
    Remember: On the AIX® or Linux system, the sh, bash, or ksh shell is required to run the agent2server_itm script on the remote system.

    Example:

    The following example extracts the /tmp/configpacks/linux_unix_configpack.tar file and runs the agent2server_itm.sh script on a Linux system. The V6 agent is installed in the /opt/ibm/itm directory and the sh shell is in the /bin/sh directory. Enable the V6 agent dual mode to connect to both Cloud App Management server and Tivoli Enterprise Monitoring Server.
    tacmd executecommand -m kvm-011235:LZ -c "nohup /bin/sh -c 'sleep 10; tar -xvf /tmp/configpacks/linux_unix_configpack.tar; /tmp/configpacks/agent2server_itm.sh -i /opt/ibm/itm -c dual -e /tmp/configpacks/env.properties > /tmp/output' &" -w /tmp/configpacks
    The following example directly runs the agent2server_itm.bat script on a Windows system. The V6 agent is installed in the C:\IBM\ITM directory and the sh shell is in the /bin/sh directory. Enable the V6 agent dual mode to connect to both Cloud App Management server and Tivoli Enterprise Monitoring Server.
    tacmd executecommand -m Primary:IMG-WINDOWS2008:NT -c "START /B C:\IBM\ITM\configpack\agent2server_itm.bat -i C:\IBM\ITM -e C:\IBM\ITM\configpack\env.properties -c dual" -w C:\IBM\ITM\configpack

What to do next

  • Log in to the Cloud App Management console to view monitoring data.
  • If you are sure that you no longer need to reconnect the agents to Tivoli Enterprise Monitoring Server, remove the offline agents from Tivoli Enterprise Portal.
  • If you enable the icam connection mode, then, to reconnect the agents to Tivoli Enterprise Monitoring Server, see Reconnecting IBM Tivoli Monitoring agents to Tivoli Enterprise Monitoring Server.
  • (IBM MQ(formerly WebSphere MQ) agent only) If you create new agent instances when the agents are connecting to the Cloud App Management server, run the agent2server_itm script again for the new IBM MQ(formerly WebSphere MQ) agent instances to connect to the Cloud App Management server.