IBM Application Performance Management 8.1.3 8.1.3.0-IBM-IPM-GATEWAY-IF0008 Readme

IMPORTANT NOTE: To download this update, you must first login to IBM Fix Central. Once logged in, you may select from the individual download packages. When selecting fixes, ensure your download options are set to "Include requisites: Yes".
http://www.ibm.com/support/fixcentral/

Below is a list of components, platforms, and file names that apply to this Readme file.

General description
This is a cumulative interim fix for the Hybrid Gateway component provided with the IBM Performance Management family of products, Version 8.1.3.0.

Platforms and prerequisites
This interim fix is supported on the Hybrid Gateway platforms documented here.

Prerequisites for this interim fix
This interim fix is intended to be applied to the following level of Hybrid Gateway software:

IBM Performance Management Hybrid Gateway, Version 8.1.3.0

None

None

Prior to installation

The Performance Management Hybrid Gateway component must be installed and running before applying the interim fix.

Installing

Installing the Hybrid Gateway interim fix
1. Download 8.1.3.0-IBM-IPM-GATEWAY-IF0008.tar from IBM Fix Central to a temporary directory (e.g. /tmp/if08-patch) on the computer where you installed the Hybrid Gateway.

2. Change your current directory to the download location, e.g.
cd /tmp/if08-patch

3. Expand the archive file using the tar command
e.g. tar -xf 8.1.3.0-IBM-IPM-GATEWAY-IF0008.tar

4. Run the script hgpatch.sh:
cd 8.1.3.0-IBM-IPM-GATEWAY-IF0008
./hgpatch.sh

Notes:

• If Hybrid Gateway services need to be stopped for the patch to be applied, you will be asked to confirm that you want to install the patch.
• When hgpatch.sh is complete, a summary is displayed showing the number of fixes that were installed, the number of fixes that were not installed because they have previously been installed, and the number of fixes that failed to install. If any fixes failed to install, more information can be found in the file hgpatch.log in the logs directory,
    e.g. /opt/ibm/hybridgateway/logs/hgpatch.log .
  
• A record of each fix applied can be found in the /opt/ibm/hybridgateway/fixes directory. Do not modify this directory or its contents. It is needed if other fixes are applied in the future.
  

Performing the necessary tasks after installation

This Hybrid Gateway patch contains an enhancement that allows the Hybrid Gateway customers to control how ITM sub-node resources and managing agents are discovered by the Hybrid Gateway.

This Hybrid Gateway patch is cumulative, so it contains the fixes delivered in the previous Hybrid Gateway patches for 8.1.3.0. As of the Hybrid Gateway 8.1.3.0 IF02 patch, there was an enhancement that allows the HG customer to control how ITM sub-node resources and managing agents are discovered by the HG. Prior to the Hybrid Gateway 8.1.3.0 IF03 patch, if a managing agent is explicitly assigned to the ITM managed system group that is configured for use by the HG, and there are any sub-nodes associated with that managing agent, they will be automatically discovered by the HG and included in the inventory of agents known to the HG. This mode of discovery simplifies the administration of the ITM managed system group configured for use by the HG, since it only requires that the managing agents be assigned, and none of the individual sub-nodes

The Hybrid Gateway IF0002 and later patches introduce a second mode of agent discovery.  If this mode is enabled (which is the new default as of Hybrid Gateway IF0002 or later), the sub-nodes, whose metric data you wish to display in the APM environment, must be assigned explicitly to the ITM managed system group that is configured for use by the Hybrid Gateway.  Unlike the previous discovery mode, there is no automatic discovery of the sub-nodes.  However, with this new discovery mode, the managing agent will be discovered automatically if any of its sub-nodes are explicitly assigned to the managed system group.  For monitoring applications based on sub-nodes, it is often necessary for APM to query the managing agent for information needed to disambiguate and qualify the monitoring resources that appear in the APM navigator.  For this reason, the managing agent will always be included automatically when this new discovery mode is enabled, and there is at least one associated sub-node assigned to the managed system group configured for use by the Hybrid Gateway.  This new mode of discovery allows for very precise control over the ITM sub-node resources that are visible to APM, and is more often aligned with how APM applications are constructed, particularly for those applications that involve large sets of sub-node resource instances.

As mentioned, after applying this Hybrid Gateway patch, the default agent discovery mode will operate as described in the previous paragraph.  However, it is also possible to explicitly specify which discovery mode will be used by the Hybrid Gateway by assigning the appropriate value to a new external property named  MSN_DISCOVERY_MODE, which is  processed by the Hybrid Gateway component during initialization of the Hybrid Gateway server.  In order to control which discovery mode is used by the Hybrid Gateway, you will need to add this new MSN_DISCOVERY_MODE property (or change its current value) in the following properties file:

     <HG_install_dir>/wlp/usr/servers/hybridgateway/bootstrap.properties

Here are the recognized values:

MSN_DISCOVERY_MODE=1

Forces the Hybrid Gateway to use the original mode of agent discovery (used by APM v8.1.3 IF01 and previous releases) where all sub-nodes are discovered automatically for any
managing agent assigned to the ITM managed system group.

MSN_DISCOVERY_MODE=2

Forces the Hybrid Gateway to use the new default mode of agent discovery (supported by APM v8.1.3 IF02 and later releases) where only those sub-nodes explicitly assigned to
the ITM managed system group will be queried by the Hybrid Gateway, and the associated managing agent(s) will be discovered automatically.

Note: If the bootstrap.properties file is updated, the Hybrid Gateway needs to be restarted before the changes will take effect.

Troubleshooting installation problems from the Support site

For more detailed information, refer to the Troubleshooting and support Guide:
http://www.ibm.com/support/knowledgecenter/SSHLNR_8.1.3/com.ibm.pm.doc/install/trouble_intro.htm

Uninstalling if necessary

Files modified by the patch are backed up during the patch installation. If you encounter an issue with the patch and need to back it out then contact IBM support for assistance.

For detailed instructions to uninstall the hybrid gateway, please refer to the IBM Performance Management guide, here:
http://www.ibm.com/support/knowledgecenter/en/SSHLNR_8.1.3/com.ibm.pm.doc/install/integ_hybridgateway_uninstall.htm

The Secure Hash Algorithm 1 (SHA1) checksum of each image image is as follows:
SHA1(8.1.3.0-IBM-IPM-GATEWAY-IF0008.tar) = 3be2ae7fbdc7a802c6a98826c247a9dbf0b7fcc9

Image Contents
The following files implement this fix:
- 8.1.3.0-IBM-IPM-GATEWAY-IF0008.readme.html - This README file
- 8.1.3.0-IBM-IPM-GATEWAY-IF0008.tar - For extracting patch files use the tar utility

Extracting the above bundle (.tar) creates the following directory and patch files:

8.1.3.0-IBM-IPM-GATEWAY-IF0008/
|-- apmpatch_functions
|-- hgpatch.sh
|-- msg
|-- nls_replace
|-- patches
|-- patch.properties

New Features

The following changes are included in IBM Performance Management Hybrid Gateway 8.1.3.0 Interim Fix 8:

• Defect fixes and other stability improvements

The following problems are addressed by this interim fix.

APARs

• None

• 130401: Apply Liberty APAR PI94351 for Missing Secure Attribute in Encrypted Session (SSL) Cookie oidcclient/redirect/rpoed
• 131154: Apply Liberty APAR PI88642 for a security vulnerability
• 131592: Apply Liberty APAR PI94763 fix for security vulnerability in Apache Commons
• 131595: Uplift Java to version 8.0.5.10 for security vulnerablity fixes

• None

• 8.1.3.0-IBM-IPM-GATEWAY-IF0001
• 8.1.3.0-IBM-IPM-GATEWAY-IF0002
• 8.1.3.0-IBM-IPM-GATEWAY-IF0003
• 8.1.3.0-IBM-IPM-GATEWAY-IF0004
• 8.1.3.0-IBM-IPM-GATEWAY-IF0005
• 8.1.3.0-IBM-IPM-GATEWAY-IF0006
• 8.1.3.0-IBM-IPM-GATEWAY-IF0007

• IV90313: While the Hybrid Gateway is reinitialising, EIF events are discarded. If an agent is removed from the MSL, while an event is open in APM, the event will not be closed.
• 99781: APM may indicate that ITMv6 agents are offline and not allow the agents to be added to applications when the agents are online to the ITMv6 infrastructure. This problem occurs if timezone offsets could not be acquired for the ITMv6 agents when the hybrid gateway attempts to retrieve the list of configured managed systems from the ITMv6 TEPS.
  
• 101833: OMEGAMON subnode agents cannot be supported unless the agent node is in the hybrid gateway MSL. However, this has performance implications since all subnodes of a managing agent are automatically included in the list of agents monitored by the hybrid gateway. This enhancement allows specific subnodes to be added to the MSL and monitored by the hybrid gateway.
  
• 103851: A change to collectLogs.sh to archive the hybridgateway/fixes directory that tracks which patches have been installed.
  
• 104108: Detects that the provider ID has changed after reconnecting with TEPS and uses the new ID thereby avoiding the need to restart the HG.
  
• 105089: Detects when the connection to TEPS is lost and stops all heartbeating so that the agents go off-line in the UI.
  
• 108979: Pick up Liberty security patches
• 109586: ITMV6 agent events are processed out of order so open events may not appear in the APMUI Events tab
• 111261: collectLogs.sh script fails
• 111750: Uplift to IBM Runtime Environment, Java Technology Edition Version 8 SR3 FP21
• 118966: Uplift to IBM Runtime Environment, Java Technology Edition Version 8 SR4 FP5
• 129463: Uplift Java to 8.0.5.5 for security fixes
• 128536: Uplift Liberty to 17.0.0.2 for security fixes