Readme File for IBM® Spectrum Symphony RFE 147841

Readme file for: IBM Spectrum Symphony

Product release: 7.3

Fix ID: sym-7.3-build600295-cs

Publication date: March 22, 2021


With this IBM Spectrum Symphony recursive feature enhancement, a recursive service instance can bypass the SD (session director) and connect directly to the SSM
(session manager).

 

1.   Scope 

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

Operating systems

·        Windows Server 2012 to 2016 

·        Windows 8 to 10

·        RHEL 6.4 to 7.4 64-bit

Product version

IBM Spectrum Symphony 7.3

 

2. Installation

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

Prerequisites

Enable SSL for IBM Spectrum Symphony as required. To enable SSL between SSM and SDK, see step 9 in IBM Knowledge Center: https://www.ibm.com/support/knowledgecenter/SSZUMP_7.3.0/management_sym/ssl_settings_configure.html

Installing on IBM Spectrum Symphony management hosts and compute hosts on Windows

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

> egosh user logon -u Admin -x Admin

b.        Disable all applications and shut down the cluster:

> soamcontrol app disable all

> egosh service stop all

> egosh ego shutdown

c.        On each management host and compute host, download the sym-7.3.0.0-soamcore-7.3.0.0_build600295.msp package to a temporary location on the host and install the package:

o   For an interactive installation, double-click the .msp package and follow the prompts.

o   For a silent installation, enter the following command from the command prompt:

C:\>msiexec /update C:\sym-7.3.0.0-soamcore-7.3.0.0_build600295.msp /l*v install.log /norestart /quiet REINSTALLMODE=omus 

The command syntax is as follows:

C:\>msiexec /update sym_package_name_path /l*v install.log /norestart /quiet REINSTALLMODE=omus

where:

o   sym_package_name_path is the fully qualified path to the .msp package; in this case, C:\sym-7.3.0.0-soamcore-7.3.0.0_build600295.msp.

o   install.log is the log file for the upgrade.

d.        Use the pversions command to verify the installation:

> pversions

IBM Spectrum Computing family: SOAM core 7.3 for IBM Spectrum Symphony 7.3.0.0

Update for Symphony 7.3.0 (build"600295")

Installing on IBM Spectrum Symphony Developer Edition hosts on Windows

a.      Log on to the IBM Spectrum Symphony Developer Edition host, and stop all applications:

> soamcontrol app disable all

b.        Stop Spectrum Symphony Developer Edition:

> soamshutdown 

c.        On each Spectrum Symphony Developer Edition host, download the symde-7.3.0.0_build600295.msp package to a temporary location on the host and install the package:

o   For an interactive installation, double-click the .msp package and follow the prompts.

o   For a silent installation, enter the following command from the command prompt:

C:\>msiexec /update C:\symde-7.3.0.0_build600295.msp /l*v install.log /norestart /quiet REINSTALLMODE=omus 

The command syntax is as follows:

C:\>msiexec /update sym_package_name_path /l*v install.log /norestart /quiet REINSTALLMODE=omus

where:

o   sym_package_name_path is the fully qualified path to the .msp package; in this case, C:\symde-7.3.0.0_build600295.msp.

o   install.log is the log file for the upgrade.

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.      On each IBM Spectrum Symphony client host, download the symclnt-7.3.0.0_build600295.msp package to a temporary location on the host and install the package:

o   For an interactive installation, double-click the .msp package and follow the prompts.

o   For a silent installation, enter the following command from the command prompt:

C:\>msiexec /update C:\symclnt-7.3.0.0_build600295.msp /l*v install.log /norestart /quiet REINSTALLMODE=omus 

The command syntax is as follows:

C:\>msiexec /update sym_package_name_path /l*v install.log /norestart /quiet REINSTALLMODE=omus

where:

o   sym_package_name_path is the fully qualified path to the .msp package; in this case, C:\symclnt-7.3.0.0_build600295.msp.

install.log is the log file for the upgrade.

Installing on IBM Spectrum Symphony Developer Edition hosts on Linux

a.     Log on to the IBM Spectrum Symphony Developer Edition host, and stop all applications:

> soamcontrol app disable all

b.        Stop IBM Spectrum Symphony Developer Edition:

> soamshutdown 

c.        Back up the following files:

7.3/linux-x86_64/lib64/libsoambase.so

7.3/linux-x86_64/lib/libsoambase.so

7.3/linux-x86_64/etc/sd

7.3/linux-x86_64/etc/ssm

7.3/linux-x86_64/etc/sim

d.        On each IBM Spectrum Symphony Developer Edition host, download the symde-7.3.0.0_x86_64_build600295.tar.gz package and extract its content to the $SOAM_HOME installation directory:

> tar zxfo symde-7.3.0.0_x86_64_build600295.tar.gz -C $SOAM_HOME

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:

lib64/libsoambase.so

lib/libsoambase.so

c.      On each IBM Spectrum Symphony client host, copy the symclnt-7.3.0.0_x86_64-build600295.tar.gz package and extract its content to the $SOAM_HOME installation directory:

> tar zxfo symclnt-7.3.0.0_x86_64-build600295.tar.gz -C $SOAM_HOME

3.   Configuration and usage

To let the recursive SI (service instance) connect directly to the SSM, the application developer should first get the value of the SSM_FRONTEND_URL environment variable, then pass it to the C++, C#, or Java SoamFactory::connect() API as the first parameter in the service code:

 

C++ sample code:

char *url = getenv("SSM_FRONTEND_URL");

ConnectionPtr conPtr = SoamFactory::connect(url, appName, &securityCB);

 

C# sample code:

string url = Environment.GetEnvironmentVariable("SSM_FRONTEND_URL");

Connection connection = SoamFactory.Connect(url, appName, securityCb);

 

Java sample code:

String url = System.getenv("SSM_FRONTEND_URL");

Connection connection = SoamFactory.Connect(url, appName, securityCb);

 

After re-compiling and re-deploying the recursive application, the recursive service instance will be able to connect directly to the SSM.

 

By default, when a recursive SI is connecting directly to the SSM, the SSM will check if the username and password are valid. However, if SD_BYPASS_AUTHENTICATION_BY_APPLICATION is configured in sd.xml and the current application matches the pattern defined in SD_BYPASS_AUTHENTICATION_BY_APPLICATION, both the SD and the SSM will not check the username and password.

 

4.    Uninstallation

Uninstalling from IBM Spectrum Symphony management hosts and compute hosts on Windows

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

> egosh user logon -u Admin -x Admin

b.        Stop all applications and shut down the cluster:

> soamcontrol app disable all

> egosh service stop all

> egosh ego shutdown

c.        On each management host and compute host, uninstall the enhancement:

o   To roll back from the Windows Control Panel, go to Control Panel > Programs and Features > View installed updates, click Update for Symphony 7.3.0 (build “600295”) and click Uninstall.

o   To roll back from the IBM Spectrum Symphony command prompt, enter the following command:

C:\> msiexec /uninstall {24F1ADF3-ACF1-462C-A104-2CA3AA93C263} /package {5B7B0C11-4DDB-4C5F-96A2-D1DCF66DBB64} /norestart /quiet /l*v rollback.log

The command syntax is as follows:

C:\> msiexec /uninstall interim_fix_code /package product_code /norestart /quiet /l*v rollback.log

where:

o   interim_fix_code is the identifier of the .msp package for this interim fix, in this case, {24F1ADF3-ACF1-462C-A104-2CA3AA93C263}.

o    product_code is the identifier of the .msi file for the original product installation package, in this case, {5B7B0C11-4DDB-4C5F-96A2-D1DCF66DBB64}.

o    rollback.log is the name of the log file to capture details of the rollback.

Uninstalling from IBM Spectrum Symphony Developer Edition hosts on Windows

a.      Log on to the IBM Spectrum Symphony Developer Edition host, and stop all applications:

> soamcontrol app disable all

b.        Stop IBM Spectrum Symphony Developer Edition:

> soamshutdown 

c.        On each IBM Spectrum Symphony Developer Edition host, uninstall the enhancement:

o   To roll back from the Windows Control Panel, go to Control Panel > Programs and Features > View installed updates, click Update for Symphony 7.3.0 (build “600295”) and click Uninstall.

o   To roll back from the IBM Spectrum Symphony command prompt, enter the following command:

C:\> msiexec /uninstall {5BBDF03E-870C-4A62-8AFA-51069EF6B9C1} /package {22654A06-21CF-422C-B5E1-387C1EDC788E} /norestart /quiet /l*v rollback.log

The command syntax is as follows:

C:\> msiexec /uninstall interim_fix_code /package product_code /norestart /quiet /l*v rollback.log

where:

o   interim_fix_code is the identifier of the .msp package for this interim fix, in this case, {5BBDF03E-870C-4A62-8AFA-51069EF6B9C1}.

o    product_code is the identifier of the .msi file for the original product installation package, in this case, {22654A06-21CF-422C-B5E1-387C1EDC788E}.

o    rollback.log is the name of the log file to capture details of the rollback. 

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.      On each IBM Spectrum Symphony client host, uninstall the enhancement:

o   To roll back from the Windows Control Panel, go to Control Panel > Programs and Features > View installed updates, click Update for Symphony 7.3.0 (build “600295”) and click Uninstall.

o   To roll back from the IBM Spectrum Symphony command prompt, enter the following command:

C:\> msiexec /uninstall {EB3D0B49-03E1-4D76-874D-B9E1661A2DBD} /package {D0374E2E-2D3C-4240-9642-D99621AD5463} /norestart /quiet /l*v rollback.log

The command syntax is as follows:

C:\> msiexec /uninstall interim_fix_code /package product_code /norestart /quiet /l*v rollback.log

where:

o   interim_fix_code is the identifier of the .msp package for this interim fix, in this case, {EB3D0B49-03E1-4D76-874D-B9E1661A2DBD}.

o    product_code is the identifier of the .msi file for the original product installation package, in this case, {D0374E2E-2D3C-4240-9642-D99621AD5463}.

o    rollback.log is the name of the log file to capture details of the rollback.

Uninstalling from IBM Spectrum Symphony Developer Edition hosts on Linux

a.     Log on to the IBM Spectrum Symphony Developer Edition host, stop all applications:

> soamcontrol app disable all

b.        Stop IBM Spectrum Symphony Developer Edition:

> soamshutdown 

c.        Restore the backed up files:

7.3/linux-x86_64/lib64/libsoambase.so

7.3/linux-x86_64/lib/libsoambase.so

7.3/linux-x86_64/etc/sd

7.3/linux-x86_64/etc/ssm

7.3/linux-x86_64/etc/sim

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 the backed up files:

lib64/libsoambase.so

lib/libsoambase.so

5.   List of files

sym-7.3.0.0-soamcore-7.3.0.0_build600295.msp

soam/7.3/w2k3_x64-vc7-psdk/lib64/soambase.dll

soam/7.3/w2k3_x64-vc7-psdk/lib64/soambase.pdb

soam/7.3/w2k3_x64-vc7-psdk/lib/soambase.dll

soam/7.3/w2k3_x64-vc7-psdk/lib/soambase.pdb

soam/7.3/w2k3_x64-vc7-psdk/etc/sd.exe

soam/7.3/w2k3_x64-vc7-psdk/etc/sd.pdb

soam/7.3/w2k3_x64-vc7-psdk/etc/ssm.exe

soam/7.3/w2k3_x64-vc7-psdk/etc/ssm.pdb

soam/7.3/w2k3_x64-vc7-psdk/etc/sim.exe

soam/7.3/w2k3_x64-vc7-psdk/etc/sim.pdb

 

symde-7.3.0.0_build600295.msp

7.3/w2k3_x64-vc7-psdk/lib64/soambase.dll

7.3/w2k3_x64-vc7-psdk/lib64/soambase.pdb

7.3/w2k3_x64-vc7-psdk/lib/soambase.dll

7.3/w2k3_x64-vc7-psdk/lib/soambase.pdb

7.3/w2k3_x64-vc7-psdk/etc/sd.pdb

7.3/w2k3_x64-vc7-psdk/etc/sd.exe

7.3/w2k3_x64-vc7-psdk/etc/ssm.exe

7.3/w2k3_x64-vc7-psdk/etc/ssm.pdb

7.3/w2k3_x64-vc7-psdk/etc/sim.exe

7.3/w2k3_x64-vc7-psdk/etc/sim.pdb

 

symclnt-7.3.0.0_build600295.msp

lib64/soambase.dll

lib64/soambase.pdb

lib/soambase.dll

lib/soambase.pdb

 

symde-7.3.0.0_x86_64_build600295.tar.gz

7.3/linux-x86_64/lib64/libsoambase.so

7.3/linux-x86_64/lib/libsoambase.so

7.3/linux-x86_64/etc/sd

7.3/linux-x86_64/etc/ssm

7.3/linux-x86_64/etc/sim

 

symclnt-7.3.0.0_x86_64-build600295.tar.gz

lib64/libsoambase.so

lib/libsoambase.so

5.   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. 

6.   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.