IBM Support

Installing and upgrading IBM Data Server Manager 2.1.3 and above

Question & Answer


Question

  • How to download IBM Data Server Manager?
  • How to download a license activation kit for IBM Data Server Manager Enterprise edition?
  • How to install IBM Data Server Manager?
  • How to upgrade IBM Data Server Manager?
  • How to apply a license activation kit for IBM Data Server Manager Enterprise edition?
  • How to revert to a previous IBM Data Server Manager installation after upgrading?

Answer

The following sections provide information needed to download and install IBM Data Server Manager, upgrade an existing installation to IBM Data Server Manager, and extend the functions by applying a license activation kit (LAK).

Downloading IBM Data Server Manager
Downloading license activation kit for IBM Data Server Manager Enterprise edition

Note: In general, you can automatically enable the enterprise level capabilities of Data Server Manager by connecting to the specified Db2 editions (see details in the Enabling enterprise level capabilities section of this document below). If you have a license entitlement to use the Performance Management Offering with a Db2 Express, Workgroup, or Enterprise database on Db2 10.5.0.4 and lower, you will need to:
  1. Download the latest release of Data Server Manager and license activation kit from Passport Advantage under IBM Data Server Manager or IBM Performance Management Offering bundling.
  2. Install Data Server Manager and then the license activation kit appropriate to your operating system, and enable enterprise capabilities on Data Server Manager (see details in the Enabling enterprise level capabilities and Enabling Db2 versions prior to 10.5.0.5 that use the Performance Management Offering sections of this docment below).
Installing IBM Data Server Manager

In the details that follow, replace <v.v.v> with the version you are installing or upgrading to and <platform> with your platform:
  • For AIX, use aix. The downloaded file has the extension .tgz.
  • For Linux x86-64, use linux-x86_64. The downloaded file has the extension .tgz.
  • For Linux on Power Systems (little endian), use plinuxle. The downloaded file has the extension .tgz.
  • For Linux on System z, use zlinux. The downloaded file has the extension .tgz.
  • For Windows, use win64. The downloaded file has the extension .zip.
With Data Server Manager 2.1.3 and above, you use setup scripts for both fresh installs and upgrades. Running these scripts when upgrading creates backups of the following essential directories:
  • config
  • dscomponents
  • dscomponents_with_rep (This folder is removed since Data Server Manager 2.1.5)
  • java
  • license
  • dsweb
These scripts also relocate the Data Server Manager binaries to appropriate directories, to prevent leftover contents from interfering with Data Server Manager operations and to help keep the Data Server Manager folder size under control.
Note: When upgrading, copies of the original Config, dscomponents,dscomponents_with_rep (This folder is removed since Data Server Manager 2.1.5), java, license, and dsweb directories are saved in your <installdirectory>/dsm_bak directory.

[GUI Installation] New installation of IBM Data Server Manager 2.1.3 and above

To complete your first installation of IBM Data Server Manager by GUI installation:
  1. From the Registration to Download Data Server Manager page, download the package ibm-datasrvmgr-<platform>.
    Alternatively, from Passport Advantage, download the package: ibm-dsm-ee-and-lak-<platform> for Enterprise Edition or ibm-dsm-base-<platform> for base edition.
  2. Extract the package contents.
    The extracted package expands into a /ibm-datasrvrmgr installation directory. For example, if you extract the package contents into C:\, the IBM Data Server Manager product expands into C:\ibm-datasrvrmgr. For the remainder of this Technote, the installation directory is referred to as <installdirectory>.
  3. From the installation directory, run Setup and follow the prompts in the wizard to complete the installation:
    • In Windows, right-click the setup.bat and choose 'Run as administrator'
    • In Linux, run setup.sh -gui
      Note: You can use HTTPS with SSL security exclusively to connect to your Data Server Manager installation. To do so, enter the following values in your <installdirectory>/Config/dswebserver.properties file:
    • cookie.secureOnly=true
    • port=-1
  4. Optionally, you can customize the Java Heap Size setting in Step 2 of page 3 in the wizard:
    Xms (MB): 512 (default value)
    Xmx (MB): 2048 (default value)
    Note: Data Server Manager 2.1.3 and above also allows you to customize the parameters for java heap size from right within the console. Go to Settings > Product Setup > Java Heap Size Configuration.
Your IBM Data Server Manager server is ready for use.
 
[Silent Installation] New installation of IBM Data Server Manager 2.1.3 and above

To complete your first installation of IBM Data Server Manager by silent installation:
  1. From the Registration to Download Data Server Manager page, download the package ibm-datasrvmgr-<platform>.
    Alternatively, from Passport Advantage, download the package: ibm-dsm-ee-and-lak-<platform> for Enterprise Edition or ibm-dsm-base-<platform> for base edition.
  2. Extract the package contents.
    The extracted package expands into a /ibm-datasrvrmgr installation directory. For example, if you extract the package contents into C:\, the IBM Data Server Manager product expands into C:\ibm-datasrvrmgr. For the remainder of this technote, the installation directory is referred to as <installdirectory>.
  3. Optionally, review and modify <installdirectory>\setup.conf. The server parameters in this file have default values. For a silent install, you must make any modifications before running setup.
    Note: To apply any license activation kits, see Applying license activation kits. When finished, continue as follows.
  4. Optionally, review and modify \bin\serverenv.sh. This shell script contains the default values for java heap size and other java starting parameters. You can customize these settings as shown below, before your first run setup.sh:
    java com.ibm.datatools.corehttpservices.util.PropertiesFileInsert "${config_file}" -Xms 512M
    java com.ibm.datatools.corehttpservices.util.PropertiesFileInsert "${config_file}" -Xmx 2048M
    java com.ibm.datatools.corehttpservices.util.PropertiesFileInsert "${config_file}" -SERVER_JAVA_OPTS "-Dhttps.protocols=SSL_TLSv2 -Duser.language=en -Duser.region=US -Dclient.encoding.override=UTF-8 -Dfile.encoding=UTF-8 -Djava.awt.headless=true"
    Notes:
    -> After running setup.sh, the settings in serverenv.sh are written to \Config\dswebserver.properties.
    -> You can also customize the parameters for java heap size and other java starting parameters in dswebserver.properties file, once step 5 is complete.
    -> Since Data Server Manager 2.1.3, you can also customize the parameters for java heap size in DSM webconsole->Settings->Product Setup->Java Heap Size Configuration.
    -> When upgrading, the dswebserver.properties file is not overwritten.
  5. From the installation directory, run the setup script and follow the prompts. To run the script from a terminal window, enter the following command:
    setup -silent
    Note: You can use HTTPS with SSL security exclusively to connect to your Data Server Manager installation. To do so, enter the following values in your <installdirectory>/Config/dswebserver.properties file:
    • cookie.secureOnly=true
    • port=-1
Your IBM Data Server Manager server is ready for use.
 
Upgrading IBM Data Server Manager to the latest release or interim fix

Before you upgrade, ensure to back up your repository database to be able to restore them to the older Data Server Manager version, if required.

To upgrade IBM Data Server Manager to the latest release or interim fix:
  1. From IBM Passport Advantage Online or IBM Fix Central, download IBM Data Server Manager latest release or interim fix for your platform.
    Note: You can upgrade to IBM Data Server Manager 2.1.5 Interim fix directly from versions 2.1.4 or 2.1.5.
  2. Stop the Data Server Manager server or service.
  3. If Data Server Manager is running as a Windows service, run <installdirectory>/bin/stopservice. Otherwise, run <installdirectory>/bin/stop.sh.
  4. Run <installdirectory>/bin/status, to verify that the service has stopped.
    Note: If you have customized any of the scripts in your existing DSM /bin folder, ensure to create a backup of these files before proceeding with the upgrade, because the upgrade process will overwrite your changes. Once the upgrade is complete, you can migrate your changes to the newly created versions.
  5. Extract the contents of the IBM Data Server Manager package into the previous install directory. Allow the files to be overwritten and replaced.
    Notes:
    • If you are upgrading to the IBM Data Server Manager 2.1.5 Interim Fix, you must remove or rename the folder dsm_bak_v214, if it exists within your Data Server Manager installation folder (for example, <installdirectory>/dsm_bak_v214), because a new folder with this name will be created as part of the upgrade.
    • If you are upgrading to the IBM Data Server Manager 2.1.5.5 Fix Pack, you do not have to remove or rename the folder dsm_bak_v214. Data Server Manager 2.1.5.5 will create the backup folder for the previously installed version of Data Server Manager. For example, if you are upgrading from Data Server Manager 2.1.5.4 to 2.1.5.5, a backup folder named 'dsm_bak_v2154' will be created.
    • If you keep historical data from IBM Data Server Manager 2.1.4 in the browser, you must clear the browser cache after you upgrade successfully to Data Server Manager 2.1.5. You can find instructions on how to clear the cache for your specific browser at one of the following sites:
  6. From the install directory, run the setup script /setup.sh.
  7. Ensure that your repository database is up to date.
    • If your repository database resides on an LUW platform, navigate to the /samples/DB2LUW folder of your Data Server Manager installation folder, locate and run validate.sql to report missing tables, if any. To create those missing tables or views, you can run create.sql with the same user previously used to configure your repository database.
    • If your repository database resides on a Db2 for z/OS system, you will need to perform additional steps to make it compatible with your new Data Server Manager environment.
      For repository migration steps, refer to the IBM Knowledge Center topic, Upgrading an existing Db2 for z/OS repository database.
  8. If you have any file that is customized/configured, such as dswebserver_override.properties (and associated files, for example, customldap.properties) and truststore, and so on, replace or merge the customized/configured files after upgrade.
    To enable the configuration still work after upgrade, you must get the files from the backup folder dsm_bak_v214 (or the backup folder created during the upgrade of Data Server Manager 2.1.5.5) and merge them to the corresponding path. Restart Data Server Manager after replacing/merging the configured files.
Examples:
File name Source path Target path Action
dswebserver_override.properties
<installdirectory>/dsm_bak_v214/Config <installdirectory>/Config Merge content of backup file and the newly installed file
customldap.properties
<installdirectory>/dsm_bak_v214/Config <installdirectory>/Config Replace target with the file in backup folder
authorization.properties
<installdirectory>/dsm_bak_v214/Config <installdirectory>/Config Replace target with the file in backup folder
truststore files
<installdirectory>/dsm_bak_v214/dsweb <installdirectory>/wlp/usr/servers/dsweb Replace target with the files in backup folder
The upgrade is complete and your IBM Data Server Manager server is ready for use.
Enabling enterprise level capabilities

You can automatically enable the enterprise level capabilities of IBM Data Server Manager 2.1.3 and above by connecting to any of the following Db2 editions, from the Data Server Manager console:
  • IBM Db2 Advanced Enterprise Server Edition
  • IBM Db2 Advanced Workgroup Server Edition
  • IBM Db2 Developer Edition
  • IBM Db2 Developer-C Edition
  • IBM Db2 Direct Advanced Edition
  • IBM Db2 hosted Advanced Edition
  • IBM Db2 Express, Workgroup, or Enterprise Edition databases, version 10.5.0.5 or higher, that have the IBM Performance Management Offering license certificate installed.
Once you establish a connection to your Db2 database, IBM Data Server Manager 2.1.3 and above should enable your enterprise capabilities automatically. To check the edition of Db2 you are connected to, go to Settings > Manage Connections and view the status of your database license in the Db2 Edition column of the Database Connections table.

Note: If the value displays as Unknown, click the value to manually update the status. If you are connecting to a database that you have recently upgraded to one of the additions listed above, you may need to reconnect to your database using the database selector.

Enabling Db2 versions prior to 10.5.0.5 that use the Performance Management Offering

If you have a license entitlement to use the Performance Management Offering with a Db2 Express, Workgroup, or Enterprise database on Db2 10.5.0.4 and lower, you will need to install a license activation kit appropriate to your operating system, on Data Server Manager.

Go to Downloading IBM Data Server Manager for a complete list of Enterprise edition LAKs for each supported operating system.

To install a license activation kit for IBM Data Server Manager 2.1.3 and above:

Note: Make sure IBM Data Server Manager has been already installed.

The Performance Management Offering LAK has been applied.
  1. Go to the Passport Advantage site and download the license activation kit package.
    For Data Server Manager Enterprise installations supporting a repository database on either IBM Db2 or IBM Db2 for z/OS, use the ibm-lakm-ds-only-<platform> LAK.
  2. If Data Server Manager was already up and running:
    1. Stop the Data Server Manager server or service.
      If Data Server Manager is running as a Windows service, run <installdirectory>/bin/stopservice. Otherwise, run <installdirectory>/bin/stop.sh.
    2. Verify that the server is stopped, by running <installdirectory>/bin/status.
    3. Extract each entitled license activation kit into your install directory. Allow files to be overwritten and replaced.
    4. Start the Data Server Manager server or service.
      If Data Server Manager is running as a Windows service, run <installdirectory>/bin/startservice. Otherwise, run <installdirectory>/bin/start.sh.
Notes: In case of installation failure, you may:
  • Verify that copies of the original Config, dscomponents, dscomponents_with_rep (This folder is removed since Data Server Manager 2.1.5 ), java and license folders are saved in <installdirectory>/dsm_bak directory.
  • Remove the Config, dscomponents, dscomponents_with_rep (This folder is removed since Data Server Manager 2.1.5 ), java and license folders from <installdirectory>.
  • Move the Config, dscomponents, dscomponents_with_rep (This folder is removed since Data Server Manager 2.1.5 ), java and license folders from <installdirectory>/dsm_bak to <installdirectory>.
  • Remove<installdirectory>/dsm_bak.
  • Repeat steps from New Installation of IBM Data Server Manager.
Reverting to a previous IBM Data Server Manager installation after upgrading

When you upgrade your current Data Server Manager environment, the running of the setup script creates a sub-folder within your Data Server Manager installation, titled dsm_bak_v21x (where x is your version prior to upgrading), that is populated with a backup of your current Data Server Manager installation. In the event that you want to revert to your original Data Server Manager installation, after upgrading, you can use the contents of this folder to re-create your previous Data Server Manager environment.

Note: Be advised that, if you have already upgraded your repository database for use with your upgraded Data Server Manager version, there are several changes to tables that cannot be reverted. This process will only work using a clean backup of your previous Data Server Manager repository database.

To revert to a previous Data Server Manager installation:
  1. Install a new instance of the Data Server Manager version to which you want to revert.
  2. From the installation folder of your upgraded DSM instance, locate and open your \dsm_bak_v21x sub-folder.
  3. Copy the contents of the \dsm_bak_v21x sub-folder to the corresponding locations within your newly created Data Server Manager 2.1.x installation.
  4. If you have not already done so, start your newly regressed version of the Data Server Manager application.
  5. Log in through the web console and examine your product setup.
    You will find that your settings, such as the Java Heap Size and System port number, have been reverted to their previous 2.1.x values.
  6. Go to Settings > Product Setup and restore the connection to your previous Data Server Manager 2.1.x repository database, or to a restored backup of that database.
You will find all the information in the repository database is still here.

[{"Line of Business":{"code":"LOB10","label":"Data and AI"},"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Product":{"code":"SS5Q8A","label":"IBM Data Server Manager"},"ARM Category":[{"code":"a8m0z0000001jGMAAY","label":"rbrw"}],"ARM Case Number":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"2.1.3;2.1.4;2.1.5"}]

Document Information

Modified date:
28 August 2020

UID

swg21999208