Readme File for IBM® Spectrum Symphony RFE 146269


Readme file for:
IBM Spectrum Symphony

Product release: 7.2.1

Fix ID: sym-7.2.1-build600650-ms

Publication date: Aug 20, 2021

 

This enhancement allows IBM Spectrum Symphony on-premises clients to use a virtual hostname or IP address file to connect to the IBM Spectrum Symphony SD (session director) and SSM (session manager).

 

1.    Scope 

Before you install this enhancement to your cluster, note the following requirements:

Operating systems

·       IBM Spectrum Symphony: RHEL 6.4 to 7.4 64-bit

·       IBM Spectrum Symphony client:

o    RHEL 6.4 to 7.4 64-bit

o    Windows 64-bit

Product version

IBM Spectrum Symphony 7.2.1

 

2.    Installation

Follow these instructions to download and install this enhancement on hosts in your cluster.

Installing on IBM Spectrum Symphony management hosts and compute hosts

a.       Log on to a management host as the cluster administrator:

> egosh user logon -u Admin -x Admin

b.       Disable all applications, stop all services, and shut down the cluster:

> soamcontrol app disable all

> egosh service stop all

> egosh ego shutdown all

c.       On each management and compute host in your cluster, download the egocore-3.7.0.0_x86_64_build600650.tar.gz and soamcore-7.2.1.0_x86_64_build600650.tar.gz package to, for example, the /symfixes directory.

d.       Run the egoinstallfixes command to install the egocore-3.7.0.0_x86_64_build600650.tar.gz and soamcore-7.2.1.0_x86_64_build600650.tar.gz package:

> egoinstallfixes /symfixes/egocore-3.7.0.0_x86_64_build600650.tar.gz

> egoinstallfixes /symfixes/soamcore-7.2.1.0_x86_64_build600650.tar.gz

Note: Running the egoinstallfixes command automatically backs up the current binary files to a fix backup directory for recovery purposes. Do not delete this backup directory; you will need it if you want to recover the original files. For more information on using this command, see the egoinstallfixes command reference.

e.       Run the pversions command to verify the installation: 

 > pversions -b 600650

IBM Spectrum egocore 3.7.0.0

----------------------------

  binary type: linux-x86_64, Aug 20 2021, Build 600650

  installed: Aug 20 2021

  notes:

  fixes:

  files: /3.7/linux-x86_64/etc/vemkd

 

IBM Spectrum soamcore 7.2.1.0

-----------------------------

  binary type: linux-x86_64, Aug 20 2021, Build 600650

  installed: Aug 20 2021

  notes:

  fixes:

  files: /soam/7.2.1/linux-x86_64/etc/sd

         /soam/7.2.1/linux-x86_64/etc/ssm

         /soam/7.2.1/linux-x86_64/lib/libsoambase.so

         /soam/7.2.1/linux-x86_64/lib64/libsoambase.so

         /soam/7.2.1/linux-x86_64/bin/soamview

         /soam/7.2.1/linux-x86_64/bin/soamcontrol

         /soam/7.2.1/linux-x86_64/bin/soamreg

         /soam/7.2.1/linux-x86_64/bin/soamunreg

         /soam/7.2.1/linux-x86_64/bin/soamlog

         /soam/7.2.1/linux-x86_64/bin/soamlogon

 

Installing on IBM Spectrum Symphony client hosts on Linux

a.       Log on to the IBM Spectrum Symphony client host and stop the running client.

b.       Back up the following files:

$SOAM_HOME/lib/libsoambase.so 

$SOAM_HOME/lib64/libsoambase.so

c.       Download the symclnt-7.2.1.0_x86_64-build600650.tar.gz file and extract its contents to the top-level installation directory:

> tar zxfo symclnt-7.2.1.0_x86_64-build600650.tar.gz -C $SOAM_HOME

Installing on IBM Spectrum Symphony client hosts on Windows

a.       Log on to the IBM Spectrum Symphony client host and stop the running client.

b.       Back up the following files:

%SOAM_HOME%\lib\soambase.dll

%SOAM_HOME%\lib\soambase.lib

%SOAM_HOME%\lib\soambase.pdb

%SOAM_HOME%\lib64\soambase.dll

%SOAM_HOME%\lib64\soambase.lib

%SOAM_HOME%\lib64\soambase.pdb

c.       Download the symclnt-7.2.1.0_build600650.zip file and extract its contents to replace the following files:

%SOAM_HOME%\lib\soambase.dll

%SOAM_HOME%\lib\soambase.lib

%SOAM_HOME%\lib\soambase.pdb

%SOAM_HOME%\lib64\soambase.dll

%SOAM_HOME%\lib64\soambase.lib

%SOAM_HOME%\lib64\soambase.pdb

 

3.    Configuration and usage

     Prerequisites

Ensure that you have set up the proxy server, and redirected communication to virtual IP addresses and ports for the actual SD and SSM ports (for example, 7875 for SD_ADMIN, 7874 for SD_SDK, 12001 to 12100 for SD_SSM) and hosts.

 

     Configuration steps

a.     On the primary and primary candidate hosts, add configuration to the EGOSC profile for SD ($EGO_CONFDIR/../../eservice/esc/conf/services/sd.xml):

                            i.         Configure the SD_VIRTUAL_HOSTNAME_FILENAME environment variable. For example:

<ego:EnvironmentVariable name="SD_VIRTUAL_HOSTNAME_FILENAME">/opt/virtIPAddress</ego:EnvironmentVariable>


The SD_VIRTUAL_HOSTNAME_FILENAME value (
/opt/virtIPAddress in this example) can be any readable file containing your virtual hostname or IP address.

                           ii.         Configure the SD_ADMIN_PORT, SD_SDK_PORT, and SSM_SDK_ADDR environment variables. For example:

<ego:EnvironmentVariable name="SD_ADMIN_PORT">7875</ego:EnvironmentVariable>

<ego:EnvironmentVariable name="SD_SDK_PORT">7874</ego:EnvironmentVariable>

<ego:EnvironmentVariable name="SSM_SDK_ADDR">12001-12100</ego:EnvironmentVariable>

<ego:EnvironmentVariable name="SDK_TRANSPORT_OPT">TCP_KEEP_ALIVE_TIME=100</ego:EnvironmentVariable>

 

Configure the SD_ADMIN_PORT, SD_SDK_PORT, and SSM_SDK_ADDR ports (7875, 7874, 12001-12100 in this example) with the ports redirected by your proxy server.

 

b.     On each management host, prepare the virtual hostname or IP address file you specified for the SD_VIRTUAL_HOSTNAME_FILENAME value in the sd.xml file.

 

The file specified for the SD_VIRTUAL_HOSTNAME_FILENAME value (/opt/virtIPAddress, in the example), should contain the virtual hostname or IP address as the first line. Each management host should have this file, using a unique host name or IP address.

For example:

> cat /opt/virtIPAddress

10.123.11.11

 

c.     Log on to the primary host, start the cluster, and enable your application:

 

> egosh ego start all

> soamcontrol app enable application_name

 

d.     Check that the EGO clients SD_ADMIN_VIRTUAL and SD_SDK_VIRTUAL are created:

 

> egosh client view SD_ADMIN_VIRTUAL

> egosh client view SD_SDK_VIRTUAL

 

e.     On the compute (Linux only) or client nodes, execute the clients:

·       Linux:

> export SOAM_USE_VIRTUAL_HOSTNAME=Y

> symping

·       Windows:

   > set SOAM_USE_VIRTUAL_HOSTNAME=Y

   > symping

 

f.      On the Linux compute nodes, run:

 

> export SOAM_USE_VIRTUAL_HOSTNAME=Y

> soamview/soamcontrol/soamreg/soamunreg/soamlog/soamlogon

 

4.    Uninstallation

Uninstalling from IBM Spectrum Symphony management hosts and compute hosts

a.       Log on to the IBM Spectrum Symphony management as the cluster administrator:

> egosh user logon -u Admin -x Admin

b.       Stop all applications, stop all services, and shut down the cluster:

> soamcontrol app disable all

> egosh service stop all

> egosh ego shutdown

c.       On each management or compute host, roll back this interim fix:

> egoinstallfixes -r 600650

d.    On primary and primary candidates hosts, remove the new configurations added to the sd.xml file.

e.    On each management host, remove the virtual hostname or IP address file.

f.        Log on to the primary host, start the cluster, and enable your application:

> egosh ego start all

> egosh user logon -u Admin -x Admin

> soamcontrol app enable application_name

 

Uninstalling from IBM Spectrum Symphony client hosts on Linux

a.       Log on to the IBM Spectrum Symphony client host and stop the running client.

b.       Restore your backup of the following files:

$SOAM_HOME/lib/libsoambase.so 

$SOAM_HOME/lib64/libsoambase.so

 

Uninstalling from IBM Spectrum Symphony client hosts on Windows

a.       Log on to the IBM Spectrum Symphony client host and stop the running client.

b.       Restore your backup of the following files:

%SOAM_HOME%\lib\soambase.dll

%SOAM_HOME%\lib\soambase.lib

%SOAM_HOME%\lib\soambase.pdb

%SOAM_HOME%\lib64\soambase.dll

%SOAM_HOME%\lib64\soambase.lib

%SOAM_HOME%\lib64\soambase.pdb

 

5.    List of files

egocore-3.7.0.0_x86_64_build600650.tar.gz

3.7/linux-x86_64/etc/vemkd

 

soamcore-7.2.1.0_x86_64_build600650.tar.gz

soam/7.2.1/linux-x86_64/etc/sd

soam/7.2.1/linux-x86_64/etc/ssm

soam/7.2.1/linux-x86_64/lib/libsoambase.so

soam/7.2.1/linux-x86_64/lib64/libsoambase.so

soam/7.2.1/linux-x86_64/bin/soamview

soam/7.2.1/linux-x86_64/bin/soamcontrol

soam/7.2.1/linux-x86_64/bin/soamreg

soam/7.2.1/linux-x86_64/bin/soamunreg

soam/7.2.1/linux-x86_64/bin/soamlog

soam/7.2.1/linux-x86_64/bin/soamlogon

 

symclnt-7.2.1.0_x86_64-build600650.tar.gz

lib64/libsoambase.so

lib/libsoambase.so

 

symclnt-7.2.1.0_build600650.zip

lib\soambase.dll

lib\soambase.lib

lib\soambase.pdb

lib64\soambase.dll

lib64\soambase.lib

lib64\soambase.pdb

 

6.    Product notifications

To receive information about product solution and patch updates automatically, subscribe to product notifications on the My Notifications page http://www.ibm.com/support/mynotifications/ on the IBM Support website (http://support.ibm.com). You can edit your subscription settings to choose the types of information you want to get notification about, for example, security bulletins, fixes, troubleshooting, and product enhancements or documentation changes. 

7.    Copyright and trademark information

© Copyright IBM Corporation 2021

U.S. Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

IBM®, the IBM logo and ibm.com® are 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.