Tivoli Log File Agent, Version 6.3.0 Fix Pack 07 Interim fix 01 (6.3.0.7-TIV-ITM_LFA-IF0001)

Download Description

(C) Copyright International Business Machines Corporation 2022.
 All rights reserved.

Component: Tivoli® Log File Agent,
     Version 6.3.0
           
Component ID: 5724C04LF

Interim Fix: 0001, (6.3.0.7-TIV-ITM_LFA-IF0001)

Date: December 15, 2022

Contents:

1.0 General description
2.0 Problems fixed
3.0 Architecture and prerequisites
4.0 Image directory contents
5.0 Installation instructions
6.0 Additional installation information
7.0 Known problems and workarounds
8.0 Additional product information
9.0 Copyright and trademark information
10.0 Notices


1.0 General description
===============
This fix resolves the APARs and defects listed in the "Problems Fixed"
section below. This fix also includes the superseded fixes listed in
section 2.3.


2.0 Problems fixed
============
The following problems are addressed by this fix.

  2.1 APARs
  -------------
  APAR: IJ39278
  Abstract: LOG FILE AGENT STOPS FORWARDING EVENTS TO EIF RECEIVER WITH LARGE EVENT.
  Additional information: The problem occurs when the Log File Agent is 
    configured to send EIF events, the .conf file contains the BufferEvents 
    and EventMaxSize keywords and an event larger than the EventMaxSize is 
    processed. The event is written to the .cache file, but there is an issue 
    when EIF reads the event from the .cache file to forward to the EIF receiver.  
    At this point no new events are being sent to the EIF receiver and the 
    .cache file gets filled with events.
                                                                        
    Install Actions: If the .cache file was continuing to grow due to the issue
    above, after the fix has been installed the agent needs to be stopped, the 
    .cache file removed, and the agent restarted. This will result in a new .cache 
    file being created which allow messages to be forwarded again.


  2.2 Defects
  --------------
  Defect: 219237
  Abstract: Log File agent crash when CTIRA_HOSTNAME not set and LABEL used. 
  Additional information:  If the .fmt uses the keyword LABEL, for example
        hostname  LABEL
     it will try to use the value for CTIRA_HOSTNAME.  If that is not set the
     agent will crash.

  2.3 Enhancements  
  ------------------
  None.

  2.3 Superseded fixes
  -------------------------
  None.
  
  2.4 APARs and defects included from superseded fixes
  ---------------------------------------------------------------
  None.

     
3.0 Architecture and prerequisites
======================
This fix is supported on all operating systems listed in the Tivoli
Log File Agent User's Guide, version 6.3.0.

Please refer to the IBM Software Product Compatability Reports (SPCR)
for the latest operating system certification information:
http://publib.boulder.ibm.com/infocenter/prodguid/v1r0/clarity/index.html

  3.1 Prerequisites for this fix
  --------------------------------
  The prerequisite level for this fix is as follows:
  - IBM Tivoli Log File Agent 6.3.0 Fix Pack 07
    available from Fix Central.

  For details, see the Troubleshooting Wiki:
  https://www.ibm.com/developerworks/mydeveloperworks/wikis/home?lang=en#/wiki/Tivoli%20Monitoring/page/Log%20File%20Agent
 
4.0 Image directory contents
 ===================
This fix image contains the following files:

- 6.3.0.7-TIV-ITM_LFA-IF0001.README 
- 6.3.0.7-TIV-ITM_LFA-IF0001.tar 
- 6.3.0.7-TIV-ITM_LFA-IF0001.zip.

Note: The .tar and .zip files are identical in content. Use the .tar
file if you are working in a UNIX® environment; use the .zip file if
you are working in a Windows environment. 

The fix archive file contains the following files:
  6.3.0.7-TIV-ITM_LFA-IF0001/kloaix523.dsc
  6.3.0.7-TIV-ITM_LFA-IF0001/klo_aix523_tema_if0001.tar
  6.3.0.7-TIV-ITM_LFA-IF0001/kloaix526.dsc
  6.3.0.7-TIV-ITM_LFA-IF0001/klo_aix526_tema_if0001.tar
  6.3.0.7-TIV-ITM_LFA-IF0001/klohp11.dsc
  6.3.0.7-TIV-ITM_LFA-IF0001/klo_hp11_tema_if0001.tar
  6.3.0.7-TIV-ITM_LFA-IF0001/klohp116.dsc
  6.3.0.7-TIV-ITM_LFA-IF0001/klo_hp116_tema_if0001.tar
  6.3.0.7-TIV-ITM_LFA-IF0001/klohpi116.dsc
  6.3.0.7-TIV-ITM_LFA-IF0001/klo_hpi116_tema_if0001.tar
  6.3.0.7-TIV-ITM_LFA-IF0001/kloli6263.dsc
  6.3.0.7-TIV-ITM_LFA-IF0001/klo_li6263_tema_if0001.tar
  6.3.0.7-TIV-ITM_LFA-IF0001/klols3263.dsc
  6.3.0.7-TIV-ITM_LFA-IF0001/klo_lpl266_tema_if0001.tar
  6.3.0.7-TIV-ITM_LFA-IF0001/klolpl266.dsc
  6.3.0.7-TIV-ITM_LFA-IF0001/klo_ls3263_tema_if0001.tar
  6.3.0.7-TIV-ITM_LFA-IF0001/klols3266.dsc
  6.3.0.7-TIV-ITM_LFA-IF0001/klo_ls3266_tema_if0001.tar
  6.3.0.7-TIV-ITM_LFA-IF0001/klolx8266.dsc
  6.3.0.7-TIV-ITM_LFA-IF0001/klo_lx8266_tema_if0001.tar
  6.3.0.7-TIV-ITM_LFA-IF0001/klosol283.dsc
  6.3.0.7-TIV-ITM_LFA-IF0001/klo_sol283_tema_if0001.tar
  6.3.0.7-TIV-ITM_LFA-IF0001/klosol286.dsc
  6.3.0.7-TIV-ITM_LFA-IF0001/klo_sol286_tema_if0001.tar
  6.3.0.7-TIV-ITM_LFA-IF0001/klosol606.dsc
  6.3.0.7-TIV-ITM_LFA-IF0001/klo_sol606_tema_if0001.tar
  6.3.0.7-TIV-ITM_LFA-IF0001/KLOWINNT.dsc
  6.3.0.7-TIV-ITM_LFA-IF0001/klo_winnt_tema_if0001.cab
  6.3.0.7-TIV-ITM_LFA-IF0001/KLOWIX64.dsc
  6.3.0.7-TIV-ITM_LFA-IF0001/klo_wix64_tema_if0001.cab
  6.3.0.7-TIV-ITM_LFA-IF0001/lo_dd_063007001.xml
  6.3.0.7-TIV-ITM_LFA-IF0001/lo_dd.properties
  6.3.0.7-TIV-ITM_LFA-IF0001/itmpatch.exe


5.0 Installation instructions 
==================
This fix can only be installed over an existing installation.  Use the
following steps to install this fix.

  5.1 Before installing the fix 
  -------------------------------
  - The prerequisites listed under section 3.1 entitled 'Prerequisites
    for this fix' must be installed before this fix can be installed.
    
  - For the purpose of this README, the symbol <CANDLEHOME> is the 
    IBM Tivoli Monitoring installation directory. The default value
    for CANDLEHOME is '/opt/IBM/ITM' on UNIX systems and 'C:\IBM\ITM'
    on Windows systems.

  - Before installing this fix on UNIX systems, set the environment 
    variable CANDLEHOME to the IBM Tivoli Monitoring installation
    directory.
        
    For example: 
    > CANDLEHOME=/opt/IBM/ITM
    > export CANDLEHOME  
  
  - Because there is no uninstall utility for this fix, make sure to
    perform a backup of your environment before installing this fix.

  5.2 Local agent update
  --------------------------
  1. Transfer the appropriate archive file
     (6.3.0-TIV-ITM_LFA-IF0001.tar or .zip) to a temporary directory
     on the system that contains the agent to be updated.  For the
     purpose of this README, the symbol <TEMP> represents the fully
     qualified path to this directory. Note: On Windows systems, this
     path includes the drive letter.

  2. Expand the archive file using the "tar" command on UNIX systems
     or an extract utility on Windows systems. This step creates a
     directory structure that contains fixes for all of the supported
     platforms.
     
  3. Use the "itmpatch" command to install the fix for the operating
     system of that agent. For more information on the "itmpatch"
     command, see section 6.2.  
     
     On UNIX systems, if the fix was expanded to <TEMP>/6.3.0-TIV-ITM_LFA-IF0001, 
     the install command is:
     
     > $CANDLEHOME/bin/itmpatch -h <CANDLEHOME> 
                -i <TEMP>/6.3.0-TIV-ITM_LFA-IF0001/klo_xxxxxx_tema_if0001.tar
                
       where:
         - xxxxxx corresponds to the value in the first column returned
           by the ./cinfo -i command. 
       
         In the following example, the file is "klo_lx8266_tema_if0001.tar".
         > ./cinfo -i
           lo      Tivoli Log File Agent
           lx8266  Version: 06.30.00.00

    On Windows systems, if the fix was expanded to 
    <TEMP>\6.3.0-TIV-ITM_LFA-IF0001, the install command is:

    > <TEMP>\6.3.0-TIV-ITM_LFA-IF0001\itmpatch -h <CANDLEHOME>
               -i <TEMP>\6.3.0-TIV-ITM_LFA-IF0001\klo_winnt_tema_if0001.cab


    Note: The itmpatch.exe provided ITM 6.30 FP7 SP8 through SP13 has an
    issue on 64-bit Windows systems. For 64-bit Windows systems, you
    must use the itmpatch.exe provided with this interim fix.


  5.3 Remote agent update
  ----------------------------
  1. Transfer the appropriate archive file 
     (6.3.0-TIV-ITM_LFA-IF0001.tar or .zip) to a temporary directory 
     on the IBM Tivoli Enterprise Monitoring Server system.  For the
     purpose of this README, the symbol <TEMP> represents the fully
     qualified path to this directory. Note: On Windows systems, this
     path includes the drive letter.

  2. Expand the archive file using the "tar" command on UNIX systems or
     an extract utility on Windows systems. This step creates a directory
     structure that contains fixes for all of the supported platforms.

  3. To add the agent fix bundles into the remote deploy depot, use
     the "tacmd addBundles" command found in $CANDLEHOME/bin on UNIX
     systems or in %CANDLE_HOME%\bin on Windows systems. For more
     information on the "tacmd addBundles" command, see the IBM Tivoli
     Monitoring Administrator's Guide.

     Note: 
     1. The prerequisite Log File Agent bundles must also be in the
     depot, to ensure successful completion of the remote agent update.

     On UNIX systems, 
     if the fix was expanded to <TEMP>/6.3.0-TIV-ITM_LFA-IF0001:
     > $CANDLEHOME/bin/tacmd addBundles -n 
                             -i <TEMP>/6.3.0-TIV-ITM_LFA-IF0001 
     
     On Windows systems, 
     if the fix was expanded to <TEMP>\6.3.0-TIV-ITM_LFA-IF0001:
     > %CANDLE_HOME%\bin\tacmd addBundles -n 
                              -i <TEMP>\6.3.0-TIV-ITM_LFA-IF0001 
     
       where:
         -n indicates that prerequisite bundles are not automatically
            added. The -n parameter must be used because the fix 
            directory does not contain any prerequisites that the fix
            might require.  Please see Section 3.1 for the prerequisites
            for this fix.
         -i is the directory that contains the deployment bundles to be
          added to the depot. 

  4. To log in to the Tivoli Enterprise Monitoring server, and deploy
     the fix to the appropriate nodes where the agent is running, use
     the following "tacmd" commands.  For more information on the 
     "tacmd login" and "tacmd updateAgent" commands, see the IBM Tivoli
     Monitoring Administrator's Guide.

     On UNIX systems: 
     > $CANDLEHOME/bin/tacmd login -s <server>
                                   -u <itmuser> 
                                   -p <password>
                                   
     > $CANDLEHOME/bin/tacmd listSystems
          
     The output shows the Managed System Name for the OS agent on the
     remote system to be updated. Use this value as the target of the
     "tacmd updateAgent" command.
     
     > $CANDLEHOME/bin/tacmd updateAgent -t lo 
                                         -n <Managed system name>
                                         -v 063007001

     On Windows systems:
     > %CANDLE_HOME%\bin\tacmd login -s <server>
                                     -u <itmuser> 
                                     -p <password>
                                    
     > %CANDLE_HOME%\bin\tacmd listSystems
          
     The output shows the Managed System Name for the OS agent on the
     remote system to be updated. Use this value as the target of the
     "tacmd updateAgent" command.
     
     > %CANDLE_HOME%\bin\tacmd updateAgent -t LO 
                                           -n <Managed system name>    
                                           -v 063007001
                              
     Note:
     - The component (-t) for the "tacmd updateAgent" command is
       specified as two characters (LO), not three characters (KLO).
     - The node (-n) for the "tacmd updateAgent" command is the managed
       system name of the operating system (OS) agent to be updated.
       The target node for the "tacmd updateAgent" command is always
       an OS agent.

  5.4 Agent support update
  ------------------------------
  There are no agent support updates for the Tivoli Enterprise 
  Monitoring Server, Tivoli Enterprise Portal Server,or Tivoli
  Enterprise Portal Desktop included in this fix.  No additional
  installation steps are required.
  
6.0 Additional installation information
========================
For additional troubleshooting installation information, see the
itmpatch.log in the patchlogs directory in <CANDLEHOME>.

  6.1 Installation instructions for agent baroc file
  -----------------------------------------------------
  There are no updates to the baroc files included in this fix or
  any of the superseded fixes.  No additional installation steps are
  required.
 
  6.2 Additional information on using "itmpatch" command
  --------------------------------------------------------------
  The "itmpatch" command has the following syntax:

  Usage: itmpatch -h <installation home> [OPTIONS]

  itmpatch -h <installation home> 
           -t { <patch_file_directory> | <patch_file> }
           
  itmpatch -h <installation home> 
           -i { <patch_file_directory> | <patch_file> }

  where:
  -h  Specifies the IBM Tivoli Monitoring installation directory
  -i  Specifies the path to the directory or patch file to be installed
  -t  Generates a report of the actions to be taken by the patch
  

  For example, on UNIX systems:
  - To preview the fix installation, use the "-t" option:
    > <CANDLEHOME>/bin/itmpatch -h <CANDLEHOME> -t <TEMP>
    
  - To install the fix, use the "-i" option:
    > <CANDLEHOME>/bin/itmpatch -h <CANDLEHOME> -i <TEMP>
    
  where:   
  <CANDLEHOME> is the fully qualified IBM Tivoli Monitoring 
  installation directory. On Windows systems, this path must include
  the drive letter.
  <TEMP> represents the fully qualified directory specification, where
  the fix is located. On Windows systems, this must include the drive
  letter.

  6.3 Verifying the update
  ----------------------------
  1. To verify the agent was updated correctly, use the "tacmd" command
     to view the agent's current version after the agent is restarted.
     You are required to log in to a Tivoli Enterprise Monitoring
     Server prior to viewing the agent version.  
                 
     For example:
     On UNIX systems, where $CANDLEHOME is the IBM Tivoli Monitoring
     installation directory, the default location is '/opt/IBM/ITM'.   
    
     > $CANDLEHOME/bin/tacmd login -s <server>
                                   -u <itmuser> 
                                   -p <password>
     > $CANDLEHOME/bin/tacmd listSystems -t LO

     On Windows systems, where %CANDLE_HOME% is the IBM Tivoli
     Monitoring installation directory, the default location
     is 'C:\IBM\ITM'.   

     > %CANDLE_HOME%\bin\tacmd login -s <server>
                                     -u <itmuser> 
                                     -p <password>
                                     
     > %CANDLE_HOME%\bin\tacmd listSystems -t LO 

     Note: The component (-t) for the "tacmd listSystems" command is
     specified as two characters (LO), not three characters (KLO).

     When the agent update is successful, the agent version is: 
     06.30.07.01.
    
    After the agent is restarted, you can also use the GUI to verify
    the agent was successfully updated.
    
    For the agent on Windows systems, the version number is 
    06.30.07.01.                                         

  2. To verify the agent you are running contains the updates from the
     fix, see the following lines in the agent log                    
     <hostname>_lo_<instance>_kloagent_<timestamp>.log located in
     $CANDLEHOME/logs on UNIX/Linux systems and
     %CANDLE_HOME%\tmaitm6\logs on Windows systems:

    UNIX/Linux:
    <timestamp>    Component: ira
    <timestamp>    Driver: agent-fac:202208111101/5260679.3
    <timestamp>    Timestamp: Aug 11 2022 11:09:32

    Windows:
    <timestamp>    Component: ira
    <timestamp>    Driver: DEV:202208111101/526068
    <timestamp>    Timestamp: Aug 11 2022 11:17:20


7.0 Known problems and workarounds
=========================
When installing the interim fix on a Windows 64-bit system with ITM 6.30 FP7
SP8-SP13 common components installed, if you get an error installing check
the itmpatch.log file. If the following error is in the file, then re-run the
itmpatch command using the itmpatch in the directory with the patch files and not
the version in %CANDLE_HOME%\bin.

ERROR 11/07/22 09:22:34 (patchprocessor.cpp,1088): Unable to extract CAB file C:\Downloads\6.3.0.7-TIV-ITM_LFA-IF0001\KLO_wix64_tema_if0001.cab: 13
  

8.0 Additional product information
======================
None.


9.0 Copyright and trademark information
==================================  
A current list of IBM trademarks is available on the Web at "Copyright
and trademark information" at www.ibm.com/legal/copytrade.shtml.


10.0 Notices
=======
INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION
"AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
Some jurisdictions do not allow disclaimer of express or implied
warranties in certain transactions, therefore, this statement may not
apply to you.

This information could include technical inaccuracies or typographical
errors. Changes are periodically made to the information herein; these
changes will be incorporated in new editions of the publication. IBM
may make improvements and/or changes in the product(s) and/or the
program(s) described in this publication at any time without notice.

Microsoft, Windows, and Windows Server are trademarks of Microsoft
Corporation in the United States, other countries, or both. 

Java and all Java-based trademarks and logos are trademarks or
registered trademarks of Oracle and/or its affiliates. 

UNIX is a registered trademark of The Open Group in the United States 
and other countries.

Linux is a registered trademark of Linus Torvalds in the United States,
other countries, or both.

Other company, product, or service names may be trademarks or service
marks of others.

Third-Party License Terms and Conditions, Notices and Information
-----------------------------------------------------------------
The license agreement for this product refers you to this file for
details concerning terms and conditions applicable to third party
software code included in this product, and for certain notices and
other information IBM must provide to you under its license to
certain software code. The relevant terms and conditions, notices and
other information are provided or referenced below. Please note that
any non-English version of the licenses below is unofficial and is
provided to you for your convenience only. The English version of the
licenses below, provided as part of the English version of this file,
is the official version.

Notwithstanding the terms and conditions of any other agreement you
may have with IBM or any of its related or affiliated entities
(collectively "IBM"), the third party software code identified below
are "Excluded Components" and are subject to the following terms and
conditions:

- the Excluded Components are provided on an "AS IS" basis
- IBM DISCLAIMS ANY AND ALL EXPRESS AND IMPLIED WARRANTIES AND
  CONDITIONS WITH RESPECT TO THE EXCLUDED COMPONENTS, INCLUDING, BUT
  NOT LIMITED TO, THE WARRANTY OF NON-INFRINGEMENT OR INTERFERENCE
  AND THE IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND
  FITNESS FOR A PARTICULAR PURPOSE
- IBM will not be liable to you or indemnify you for any claims
  related to the Excluded Components
- IBM will not be liable for any direct, indirect, incidental,
  special, exemplary, punitive or consequential damages with respect
  to the Excluded Components.