IBM Support

ITCAM for Microsoft Applications: Microsoft Active Directory Agent 6.3.1.20 Interim Fix 1readme

Fix Readme


Abstract

This is a cumulative interim fix for the ITCAM for Microsoft Applications: Microsoft Active Directory Agent 6.3.1.20 Interim Fix 1 release.

Content

Copyright International Business Machines Corporation 2024.
All rights reserved.
============================
Component: ITCAM for Microsoft Applications: Microsoft Active Directory Agent 6.3.1.20 Interim Fix 1
Release ID: TIV-ITM_ADO-IF0001
============================
1.0 General description
2.0 Download location
3.0 Problems fixed
4.0 Architecture and prerequisites
5.0 Image directory contents
6.0 Installation instructions
7.0 Additional installation information
8.0 Known problems and workarounds
9.0 Additional product information

1.0 General description
============================

This fix resolves the APARs and the defects that are listed in the "Problems Fixed" section below.

2.0 Download location
============================

You can download the fix pack from the following location:
6.3.1.20-TIV-ITM_ADO-IF0001  

3.0 Problems fixed
============================

The following problems are addressed by this fix.

3.1 APARs 


APAR: DT381534
Abstract: MS Active Directory Agent has an issue with the DFSR Folders Staging Space in Use metric in the 3Z agent - cannot go above 1GB.
Fix: By using this fix, the situation formula for the DFSR Folders Staging Space in Use in the DFSR_Staging_Space_Low situation has been modified to accept values in megabytes (MB) rather than bytes.

Furthermore, the associated tooltip text for the DFSR Folders Staging Space in Use attribute has also been revised accordingly.
This interim fix can be applied on both Microsoft Active Directory Agent 6.3.1.19 and 6.3.1.20 versions.  

3.2 Defects 


None

3.3 Enhancements 

None

3.4 Superseded fixes 


None

3.5 APARs and defects included from superseded fixes


None

4.0 Architecture and prerequisites
============================

4.1 Prerequisites for this fix

IBM Tivoli Composite Application Manager for Microsoft Applications, Version 6.3.1 FP20 or FP19: Microsoft Active Directory Agent.
    

5.0 Image directory contents
============================

  • This fix image contains the following files.
    • 6.3.1.20-TIV-ITM_ADO-IF0001.tar
    • 6.3.1.20-TIV-ITM_ADO-IF0001.zip
      Note: Use the .zip file if you are working on a Windows environment. 
  • The fix archive file contains the following files: 
    • 6.3.1.20-TIV-ITM_ADO-IF0001.tar
    • 6.3.1.20-TIV-ITM_ADO-IF0001.zip

6.0 Installation instructions
============================

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

6.1 Before installing the fix 

  • Because there is no uninstall utility for this fix, make sure to perform a backup of your environment before installing this fix.
  • The prerequisites listed under the Prerequisites for this fix section 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 the following.
    UNIX
    /opt/IBM/ITM
    Windows
    C:\IBM\ITM
  • 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
  • Before installation, see the Known problems and workarounds section.

6.2 Local agent update

  1. Transfer the appropriate archive file (6.3.1.20-TIV-ITM_ADO-IF0001.tar or .zip) to a temporary directory on the system that contains the agent code to be updated. For 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 that agent platform. 
    On Windows systems, if the fix was expanded to <TEMP>\6.3.1.20-TIV-ITM_ADO-IF0001, the install command for 64 bit is, 
    > itmpatch -h <CANDLEHOME>
               -i <TEMP>\6.3.1.20-TIV-ITM_ADO-IF0001\k3z_wix64_tema_if0001.cab

6.3 Remote agent update

  1. Transfer the appropriate archive file (6.3.1.20-TIV-ITM_ADO-IF0001.tar or .zip) to a temporary directory on the IBM Tivoli Enterprise Monitoring Server system. For 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.
    1. Following is the command on the UNIX systems, if the fix was expanded to <TEMP>/6.3.1.20-TIV-ITM_ADO-IF0001.
      > $CANDLEHOME/bin/tacmd addBundles -n -i <TEMP>/6.3.1.20-TIV-ITM_ADO-IF0001
    2. Following is the command on the Windows systems, if the fix was expanded to <TEMP>\6.3.1.20-TIV-ITM_ADO-IF0001.
      > %CANDLE_HOME%\bin\tacmd addBundles -n -i <TEMP>\6.3.1.20-TIV-ITM_ADO-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. 
      -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 Appendix A. Commands reference of the IBM Tivoli Monitoring Administrator's Guide.
    1. ​​​​​​Following is the command on the UNIX systems, 
      > $CANDLEHOME/bin/tacmd login -s <server>
                                    -u <itmuser>
                                    -p <password>
      > $CANDLEHOME/bin/tacmd listSystems
      The output shows the Managed system nme 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 3Z 
                                          -n <Managed system name> 
                                          -v 063120001
        ​​​​​Following is the command on the 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 3Z
                                            -n <Managed system name> 
                                            -v 063120001
      Note:
      • The component (-t) for the "tacmd updateAgent" command is specified as two characters (3Z), not three characters (K3Z).
      • 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. 

6.4 Agent support update


Use the following steps to update the Tivoli Enterprise Monitoring Server, Tivoli Enterprise Portal Server, or Tivoli Enterprise Portal Desktop.
  1.   Transfer the appropriate archive file 6.3.1.20-TIV-ITM_ADO-IF0001.tar or .zip) to the Tivoli Enterprise Monitoring Servers, Tivoli Enterprise Portal Servers, or Tivoli Enterprise Portal Desktops.
  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. Expand the archive file (k3z_tems_teps_tepd_if0001.tar or .zip) that contains the updates for Tivoli Enterprise Monitoring Server, Tivoli Enterprise Portal Server, and Tivoli Enterprise Portal Desktop using the "tar" command on UNIX systems or an extract utility on Windows systems. This step creates a directory structure that includes a subdirectory called CD-ROM, with the necessary updates.
  4. For IBM Tivoli Monitoring Version 6.3 or above, one of the following additional steps must be performed.
    1. Acquire a platform-specific pre-packaged JRE version of the Application Support Installer (ASI). See IBM Tivoli Monitoring Application Support Installer, 6.2-tiv-itm_asi-if0001 at http://www-.ibm.com/support/docview.wss?uid=swg24024800 for download and installation instructions.
    2. Specify the '-j javahome' parameter with the path to a 32-bit java 1.5 or java 1.6 installation when running the itmasi.sh or itmasi.bat script described below.
  5. Use the Application Support Installer script to launch either GUI installation or silent installation of the application support files.  
    GUI installation option
    The GUI can be started by using one of the following commands from within the CD-ROM directory where setup.jar is located. 
    UNIX
    > ./itmasi.sh [-h <CANDLEHOME>] [-j <JAVAHOME>] 
    Windows
    > itmasi [-h <CANDLEHOME>] [-j <JAVAHOME>] 
    When prompted by the Application Support Installer for the installable media directory, select the CD-ROM directory, not the component directory. The installer can install updates for multiple components at the same time.
    Silent installation option
    To use the silent installation option, use one of the following commands from within the CD-ROM directory where setup.jar is located.      
    Note: Using the silent installation option for Linux and zLinux operating systems requires the following files contained in interim fix 6.2-TIV-ITM_ASI-IF0002:
    -  Linux: setupLinux.bin
    -  zLinux: setupLinux390.bin

    Follow the installation instructions contained in the "6.2-TIV-ITM_ASI-IF0001.README".
    UNIX
    >  ./itmasi.sh -h <CANDLEHOME>[-silent] 
                   [-r <response file>] 
                   [-j <JAVAHOME>] 

    Windows
    > itmasi -h <CANDLEHOME> [-silent] 
             [-r <response file>] 
             [-j <JAVAHOME>] 
    Where,
    -h <CANDLEHOME> - Required. The path to the IBM Tivoli Monitoring installation directory.
    r <response file> - Optional. Customized response file name. The default response file "response.txt" in the CD-ROM directory can be copied and modified for your environment. Do not update "response.txt". 
    -j <JAVAHOME> - Optional. The fully-qualified path to the "bin" directory where Java(R) is installed. The location of Java on your system might vary.
  6. The next panel presented by the Application Support Installer asks for the selection of which Tivoli Monitoring components you want to add application support to. For this fix, check or clear the check boxes as follows
    1. Tivoli Enterprise Monitoring Server(TEMS) checkbox 
    2. Tivoli Enterprise Portal Server(TEPS) checkbox
    3. Tivoli Enterprise Desktop Client(TEPD) checkbox
  7. Continue through the remaining GUI panels selecting the ADO 06.31.20.01 support to complete the installation.
  8. If the Tivoli Enterprise Portal Desktop or Tivoli Enterprise Portal Browser was running when the update was installed, it must be restarted.

7.0 Additional installation information
============================

7.1 Installation instructions for agent baroc file

Fix (6.3.1.20-TIV-ITM_ADO-IF0001) includes changes to the agent baroc files which need to be reinstalled. If you have already installed these baroc files, there are no additional installation steps. If not, refer to IBM Tivoli Monitoring, Installation and Setup Guide under "Installing monitoring agent baroc files on the event server" in the "Installing the IBM Tivoli Enterprise Console Event Synchronization" section for more information.

7.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.
    Example
    UNIX
    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.

7.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.
    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 3Z
    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 3Z 
    Note:
    - The component (-t) for the tacmd "listSystems" command is specified as two characters (3Z), not three characters (K3Z).
    When the agent update is successful, the agent version is: 06.31.20.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.31.20.01.
  2. To verify the agent support files were updated correctly, use the "kincinfo" command on Windows systems or the "cinfo" command on Linux or UNIX systems. The sample output below shows the versions of the Tivoli Enterprise Portal Server, Tivoli Enterprise Monitoring Server, or Tivoli Enterprise Portal Desktop systems after this fix has been successfully applied.
    Note: The displayed date of the build might not be accurate. This is a known problem.
    UNIX or Linux systems
    To validate that all components have been installed, run the following command:
    ./cinfo -t
     
    *********** Wed Oct 23 16:31:08 IST 2024 ******************
    User: root Groups: root
    Host name : hjs495-sql-t-1       Installer Lvl:06.30.07.23 (Service Pack 17)
    CandleHome: /opt/IBM/ITM
    Version Format: VV.RM.FF.II (V: Version; R: Release; M: Modification; F: Fix; I: Interim Fix)
    ***********************************************************
    ...Product inventory
     
    PC   APPLICATION SUPPORT DESC          PLAT    APP VER       BUILD   INSTALL DATE
     
    3z   Active Directory Support          tms     06.31.20.01   22341   20241023 1551
    3z   Active Directory Support          tpd     06.31.20.01   22341   20241023 1557
    3z   Active Directory Support          tps     06.31.20.01   22341   20241023 1555
    3z   Active Directory Support          tpw     06.31.20.00   22341   20241023 1450
    Windows
    To validate that all components have been installed, run the following command:
    > %CANDLE_HOME%\InstallITM\kincinfo -t
    
    ************ Wednesday, October 23, 2024 01:06:05 PM ************
    User       : Administrator         Group     : NA
    Host Name  : ESX3-AD-T-64          Installer : Ver: 063007180
    CandleHome : C:\IBM\ITM
    Installitm : C:\IBM\ITM\InstallITM
    *************************************************************
    ...Product Inventory
    PC  APPLICATION SUPPORT DESC                     PLAT   APP VER      BUILD         INSTALL DATE
     
    3Z  TEMS App Support/Active Directory Support    WICMS  06.31.20.01  202408220000  20241023 1125
    3Z  TEPS App Support/Active Directory Support    WICNS  06.31.20.01  202408220000  20241023 1125
    3Z  TEPB App Support/Active Directory Support    WIXEB  06.31.20.00  22341         20241023 1125
    3Z  TEPD App Support/Active Directory Support    WIXEW  06.31.20.01  202408220000  20241023 1125

7.4 Caching Configuration 

With this currently implemented mechanism of configuring caching, the customer can enable or disable caching and also set the cache interval. This is achieved by using an environment variable "ADO_CACHE_INTERVAL" in the environment file K3ZENV. When this fix is applied, a prescript (k3z_preinstall.cmd) is run which sets the ADO_CACHE_INTERVAL in the K3ZENV file. 
If the variable ADO_CACHE_INTERVAL already exists in the K3ZENV file, the script quits without making any changes. ADO_CACHE_INTERVAL not only acts as an ON/OFF flag, but the value which is given in seconds, forms the caching interval (time interval between consecutive data collection). Any positive integer value turns ON the caching mechanism and a negative or zero value turns it OFF. The k3z_preinstall.cmd script verifies the present installation of the Monitoring Agent for Active Directory. By default, the value of ADO_CACHE_INTERVAL is set as 240. The customer needs to turn it OFF by setting the value to 0.
Caching can be turned ON or OFF during run time through Manage Tivoli Enterprise Monitoring Services (kinconfig.exe). The steps are as follows:
  1. In Manage Tivoli Enterprise Monitoring Services (kinconfig.exe), select the " Active Directory Agent" .
  2. Right-click and go to “Advanced” options.
  3. Select "Edit ENV File" from the options. This opens the K3ZENV file for editing. 
  4. The ADO_CACHE_INTERVAL variable exists in the K3ZENV file.
    - To turn OFF caching, set ADO_CACHE_INTERVAL to 0. 
    -  To turn ON caching, set ADO_CACHE_INTERVAL to any positive integer value. This value forms the caching interval in seconds. For instance, a value of 180 would mean a 3-minute interval. 
  5. After editing the K3ZENV file, save and close the file to implement the new cache interval value.
  6. A message box will appear asking if the agent needs to be recycled to include the changes in agent functionality. 
    - "Yes" recycles the agent with the new caching interval value. 
    - "No" lets the agent continue to run without the changes to the caching interval. When the agent is restarted, the changes will be implemented.
    Note: A negative or zero value turns off caching. Non-integers (alphabetic, special characters, and alphanumerics are not supported for the cache interval and might result in unexpected behavior of the Monitoring Agent for Active Directory. The value recommended for the cache interval is 240 seconds.

8.0 Known problems and workarounds

Abstract: The agent version is not upgraded in the Add/Remove program the build level for the patch is upgraded.
Problem:  When we upgrade to the latest patch and check it on the "Add or Remove Features tab" it shows the build level is updated for the patch but the agent version is not updated.
Workaround: None

9.0 Additional product information
============================

None   

10.0 Notices
============================

This information was developed for products and services offered in the United States. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an
IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify
the operation of any non-IBM product, program, or service.
IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to:
IBM Director of Licensing
IBM Corporation
North Castle Drive
Armonk, NY 10504-1785
U.S.A.
The following paragraph does not apply to the United Kingdom or any other
country where such provisions are inconsistent with local law:
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 states do not allow disclaimer of express or implied warranties in
certain transactions, therefore, this statement may not apply to you.
Trademarks and service marks
------------------------------------
IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at "Copyright and trademark information" at www.ibm.com/legal/copytrade.shtml.
{Add or remove non-IBM trademark names as appropriate. Mark the first occurrence of IBM and special non-IBM trademark names with a '(R)'.
See http://www.ibm.com/legal/copytrade.shtml for a complete list of non-IBM trademark names.}
Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both.
Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both.
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.

[{"Type":"MASTER","Line of Business":{"code":"LOB67","label":"IT Automation \u0026 App Modernization"},"Business Unit":{"code":"BU048","label":"IBM Software"},"Product":{"code":"SSDKXQ","label":"Tivoli Composite Application Manager for Microsoft Applications"},"ARM Category":[{"code":"a8m500000008b8FAAQ","label":"ITCAM-for-Applications-\u003EMS Active Directory Agent"}],"Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"6.3.1"}]

Document Information

Modified date:
12 November 2024

UID

ibm17174242