IBM Support

IBM Common Licensing (ICL) 9.1

Download


Downloadable File

File linkFile sizeFile description
   
   
   
   
   

Abstract

This is a maintenance release of IBM Common Licensing and its related components, IBM License Key Server Administration and Reporting Tool, and IBM License Key Server Administration Agent. It provides several useful enhancements and fixes that simplify the overall administration of the License Key Server.

Download Description

Table of Contents
SectionsDescription
The Prerequisites section provides important information to review before the installation of this release.
The Installation instructions section provides the installation instructions necessary to apply this release into your environment.
The Download package section provides the direct link to obtain the download package for installation in your environment.
The Impact assessment section provides information related to the impact of this release to allow you to assess how your environment might be affected.
The Known limitations section contains a link to the known problems (open defects) identified at the time of this release.
The Change History section provides an overview on what is new in this release with a description of any new functions or enhancements when applicable.

Supporting Documentation
DocumentDescription
Click to review the detailed system requirements information for a complete list of hardware requirements, supported operating systems, prerequisites, and optional supported software, with component-level details and operating system restrictions.
IBM Knowledge Center provides an entry point to product documentation. You can view, browse, and search online information related to the product.
Click to review a complete list of the defects (APARs) resolved in this release, including a list of resolved defects for the entire version family.

Prerequisites

Attention: IBM License Key Server Administration and Reporting Tool and IBM License Key Server Administration Agent must be configured according to the following hardware and software specifications. Otherwise, failure might occur during license administration and usage reporting.

Prerequisites include:
Hardware requirements:
IBM License Key Server Administration and Reporting Tool
  • Memory: 8 GB RAM
  • Disk space: 100 GB
IBM License Key Server Administration Agent
  • Memory: 16 GB RAM
  • Disk space: 100 GB

Software requirements: Web browser requirement for IBM License Key Server Administration and Reporting Tool

  • Mozilla Firefox: 153.0.1 or later
  • Google Chrome 150.0.78771.187 or later
  • Safari 26.5.2 or later
  • Microsoft Edge 150.0,4078.99 or later

IBM License Key Server

Operating systems: Only 64-bit architecture of Windows, Linux, and AIX operating systems are supported.

IBM License Key Server Administration and Reporting Tool

Operating systems: Only 64-bit architecture of Windows, Linux, and AIX operating systems are supported.

For more information about operating systems supported, see Operating systems for a specific product.

IBM License Key Server Administration Agent

  • Installation prerequisite: The Server Administration Agent must be collocated with the IBM License Key Server.
  • Operating Systems: Both 32-bit and 64-bit architectures of AIX, Linux, and Windows operating systems are supported.

For more information about operating systems supported, see Operating systems for a specific product.

Special characters supported by reports

  • For a list of special characters that are supported by report definitions and reports in License Key Server Administration and Reporting Tool, see the technical document.

Back to top

Installation Instructions

Installation scenarios
---------------------------------------------------------------------------------------------------
In all scenarios, updates or fresh installation must be done in the following order:
  1. License Key Server 
  2. License Key Server Administration Agent
  3. License Key Server Administration and Reporting Tool
Scenario 1: Fresh Installation
Existing Installations: None
  1. Install License Key Server 9.1
  2. Install License Key Server Administration Agent 9.1
  3. Start License Key Server Administration Agent 9.1
  4. Open a browser and go to http://<hostname>:4080/iclagent.
  5. From the Deployed Licenses panel, click the Import and overwrite licenses menu and import required license file.
  6. After the licenses are successfully imported, License Key Server starts automatically with the newly imported licenses.
  7. Repeat the steps 2-6 for each additional agent that you want to configure.
  8. Start Reporting Tool 9.1
  9. Configure the database and restart License Key Server Administration and Reporting Tool 9.1
  10. Navigate to the Server Administration page and add the License Key Server Administration Agent 9.1 instance.
 
Scenario 2: Upgrade IBM Common Licensing components 
Existing Installations: License Key Server 9.0, License Key Server Administration and Reporting Tool 9.0, and License Key Server Administration Agent 9.0
  1. Stop the License Key Server 9.0.
  2. Backup the License File LKS_License.dat into a location other than LKS_INSTALL_LOCATION
  3. Backup the reporting log files (rlks.log and other rlks_timestamp.log files) to a location other than LKS_INSTALL_LOCATION
  4. Backup the configuration file rlks.ini from the LKS_INSTALL_LOCATION/bin/ directory
  5. Uninstall License Key Server 9.0
  6. Install License Key Server 9.1
  7. Restore the backed up reporting log files (rlks.log and rlks_timestamp) to their original locations. The default location is LKS_INSTALL_LOCATION\logs\
  8. Restored the backed up rlks.ini to LKS_INSTALL_LOCATION/bin/
  9. Stop License Key Server Administration Agent 9.0.
  10. Stop License Key Server Administration and Reporting Tool 9.0.
  11. Uninstall License Key Server Administration and Reporting Tool and License Key Server Administration Agent 9.0.
  12. Open Db2 Admin command prompt and run the following commands:
    1. db2 drop database artdata
    2. db2stop
    3. db2start
    4. db2 create database artdata using codeset UTF-8 TERRITORY DEFAULT with 'LKS Administration/Usage Data'
      If using db2 12.1.4, execute below steps:
    5. Connect to artdata
    6. GRANT IMPLICIT_SCHEMA ON DATABASE TO USER rcldb2i1
    7. GRANT CREATETAB ON DATABASE TO USER rcldb2i1
  13. Install License Key Server Administration Agent 9.1
  14. Start License Key Server Administration Agent 9.1
  15. If licenses are not imported to the License Key Server 9.1, follow the steps to import the licenses.
    • Access the License Key Server Administration Agent Web UI http://<hostname>:4080/iclagent.
    • From the Deployed Licenses panel, click the Import and overwrite licenses menu and import required license file..
    • Once the licenses are successfully imported, the License Key Server will automatically start with the newly imported licenses.
  16. Repeat the Step 13 - 15 for each additional License Key Server Administration Agent you want to configure.
  17. Install the License Key Server Administration and Reporting Tool 9.1
  18. Start License Key Server Administration and Reporting Tool 9.1
  19. Configure the database and restart License Key Server Administration and Reporting Tool 9.1
  20. Navigate to the Server Administration page and add the License Key Server Administration Agent 9.1 instance.
 
IBM License Key Server installation on Windows
---------------------------------------------------------------------------------------------------
  1. Download M16QQML.zip file against required operating system from Passport Advantage.
  2. Log in to the local computer where you want to install the License Key Server using an account with administrator privileges.
  3. Extract the installation package to the local directory. 
    The extracted files contain License Key Server repository and Installation Manager. You do not need to download Installation Manager separately. 
  4. Go to the //LKS_MASTER_DISK/disk1 directory.
  5. Double-click launchpad.bat. The IBM Common Licensing splash screen opens.
  6. Refer to release information section for more details.
  7. Click Install IBM License Key Server.
    Note: If IBM Installation Manager is not installed, or if the installed version is earlier than the version that is bundled with License Key Server, install or upgrade Installation Manager before you continue with the License Key Server installation.The Install Packages window opens. Only Installation Manager is listed. License Key Server is not listed.To install Installation Manager, complete the steps in the Install wizard.
    After the installation is complete, click Restart Installation Manager.
  8. Click Install to install License Key Server.
  9. Select License Key Server and click Next.
  10. After the prerequisites are validated, click Next. To validate prerequisites again, click Recheck Status in the lower right corner.
  11. Accept the license agreement and click Next.
  12. Accept the default location or specify a different location for the Shared Resources directory and Installation Manager directory click Next. 
    Note: You cannot change the location of the Shared Resources directory after Installation Manager is installed.
    Default values:
    Shared Resources directory: C:\Program Files\IBM\IMShared
    Installation Manager directory: C:\Program Files\IBM\Installation Manager\eclipse
  13. Accept the default installation directory for the license server or enter a different installation directory.
    Default installation directory: C:\Program Files (x86)\IBM\LKS
  14. In Packages, click Install to start the installation.
  15. Click Finish to close the installation wizard.
  16. Import the required license keys and start the License Key Server. The license server will not start until license keys are installed. See the Starting the Windows license server topic.
 
IBM License Key Server installation on AIX/LINUX
----------------------------------------------------------------------------------------------------------
  1. Download M16QSML.zip (for Linux) or M16QTML.zip (for AIX) file against required operating system from Passport Advantage.
  2. Extract the IBM_License_Key_Server_<Platform>.zip into an appropriate directory.
  3. Go to the LKSSERVER_Platform/disk1 directory.
  4. Extract the installation files for License Key Server. The extracted files are the repository for License Key Server. Add this repository to the Installation Manager.
  5. Accept the default installation directory for the license server or enter a different installation directory.
    Default installation directory: /opt/IBM/LKS.
  6. Review the features selected for installation and click Next.
  7. Click Install.
  8. Click Finish.
 
IBM License Key Server Administration Agent Installation
----------------------------------------------------------------------------------------------------------
  1. Download M16QWML.zip file against required operating system from Passport Advantage.
  2. Create a temporary directory (for example, ../agent-installer/910/) and extract the downloaded .zip file into this directory.
  3. Install the IBM Installation Manager V1.9.3.4 for installing License Key Server Administration Agent 9.1
    • Update the Installation Manager if the installed version is V1.8.5 or earlier.
    • The Installation Manager restarts after you complete the installation process.
  4. Open the Installation Manager.
  5. Click File > Preferences > Repositories.
  6. Click Add Repository and specify location where the installation package is extracted, and click OK.
  7. From the main Installation Manager window, click Install.
  8. In the Install Packages window, select the IBM License Key Server Administration Agent > Version 9.1 package and click Next.
  9. Review and accept the license agreement and click Next.

  10. Click Create a new package group to install the agent into a new package group and click Next.

    The agent is supported on 32-bit and 64-bit computers. By default, the package is installed in this directory location:

    • Windows: C:\Program Files\IBM\ICL\LKSAdminAgent
    • UNIX: /opt/IBM/ICL/LKSAdminAgent

    Note: Multiple Agent instances can be installed on the same system. Installation Manager assigns a unique profile name to each instance based on the installation order. For example, First installation: IBM LKS Administration Agent
    Second installation: IBM LKS Administration Agent_1.

  11. Select IBM License Key Server Administration Agent feature to proceed with agent installation and click Next.
  12. Use the applicable table in Agent configuration to determine the server type, server location, license server log file, and license files.
    • Install a separate Agent for each license server on the system.If Installation Manager reports that the selected port is already in use, select a different port number and continue.
    • Select the license server type:
      • IBM License Key Server
      • ELM server - Floating licenses
      • ELM server - Authorized user licenses
    • Perform one of the following actions:
      • Windows platform with License server type selected as LKS: Select a Windows service name from the list of License Key Server services that are installed on the system.When you select a service, the following fields are populated and displayed as read-only:Location of LKSLocation of the lmgrd.log fileLocation of license filesTo enter values manually, select --Configure manually--.
      • Platforms other than Windows with the License server type set to LKS: Select a License Key Server installation location from the list of servers that are installed on the system.When you select an installation location, the following fields are populated: Location of LKS, Location of the lmgrd.log file, and Location of license files.
    • If you are not using the pre-populated values, you must enter the location of the IBM License Key Server (lmgrd application) that you want to administer with the IBM License Key Server Administration and Reporting Tool. You can either browse for the license server location or enter the location. By default, License Key Server is installed in one of these directories:
      • Windows: C:\Program Files\IBM\LKS\bin
      • Linux:/opt/IBM/LKS/bin
    • If you are not using the prepopulated values, you must enter the location of the license server Hook log file. The agent uses the log file to gather license usage data. You can either browse for the license server log file or enter the location.
    • Specify the license key file that is configured with the selected License Key Server. You can select multiple files. For Windows operating systems, separate multiple license files with semicolons (;). For Linux operating systems, separate the names with colons (:).
  13. Click Next.
  14. Review the installation summary and then click Install. A summary list of installed packages displays.
  15. Select IBM License Key Server Administration Agent to start the application. The agent is installed by default as a Windows service and can be configured as a service on UNIX platforms. If you select None in this step, you can start the application manually as a Windows or UNIX service. See Starting License Key Server Administration and Reporting Tool on system startup.
  16. After the installation process completes, click Finish to close the Installation Manager.

IBM License Key Server Administration and Reporting Tool Installation or Upgrade
-------------------------------------------------------------------------------------------------------------------

  1. Download M16QVML.zip file against required operating system from Passport Advantage.
  2. Create a temporary directory (for example, ../ART-installer/9002/) and extract the downloaded .zip file into this directory.
  3. Install the Installation Manager V1.9.3.4 for installing License Key Server Administration and Reporting Tool 9.1
    • Update the Installation Manager if the installed version is V1.8.5 or earlier.
  4. Open the Installation Manager.
  5. Add the extracted location of downloaded media file
  6. Click File > Preferences > Repositories,
    Add the repository location that contains the extracted installation files.
  7. Click Ok.
  8. In the Installation Manager window, click Install.
  9. In Install Packages window, select the IBM License Key Server Administration and Reporting Tool > Version 9.1 and click Next.
  10. Review and accept the license agreement and click Next.

  11. Click Create a new package group to install the reporting tool into a new package group and click Next.

    Note: License Key Server Administration and Reporting Tool and IBM License Key Server Administration Agent cannot be installed in the same directory. By default, the package is installed in the following location:

    • Windows: C:\Program Files\IBM\ICL\LKSAdmin
    • UNIX: /opt/IBM/ICL/LKSAdmin
  12. Select IBM License Key Server Administration and Reporting Tool feature, and click Next.
  13. Review the installation summary and then click Install. 
    A summary list of installed packages displays.
  14. After the installation process completes, click Finish to close the Installation Manager.
  15. Select IBM License Key Server Administration and Reporting Tool to start the application. 
    The reporting tool is installed by default as a Windows service and can be configured as a service on UNIX platforms. If you select None in this step, you can start the application manually as a Windows or UNIX service. See Starting License Key Server Administration and Reporting Tool on system startup.

Back to top

Download Package

The following sections provide detailed information that is related to this release.

Click here to obtain the release from Passport Advantage.

 

How critical is this fix?

Impact Assessment
ImpactDescription

Corrective

This release is a service release of IBM License Key Server. It contains new features and fixes for client-reported and internally found defects.

Back to top

Problems Solved

Defects resolved
Click the Fix List link in the table of contents above to review a list of the problems solved in this release.

Known Side Effects

  • On the Live Reports page, if a user name contains multiple words, only the first word is displayed.
  • On the Live Reports page, the ELM products usage records do not consider the Role information. The highest Token count among the Token counts for each Role of the respective products is displayed under the "Tokens per license" column.
  • If the license server has more than a thousand check-outs and the IBM License Key Administration Agent is processing them as part of the conversion cycle, the Live Reports page might not show any information. You can refresh the page after few minutes.
  • If the same license definitions are present in more than one license files that are used by the license server, the quantity of license, as shown in the License Details report, might be more than the actual available quantity of license.
  • When you start or stop the server from a redundant server triad and if the network connectivity is poor, the license server status and therefore the reporting operation might be incorrect.
  • When you save and run a report on the create report definition page, the report definition name does not appear in the exported parameters file.
  • For the scenarios with a chargeback group where duplicate users have different cases. If you generate a group-based chargeback report with this group and the user name case sensitivity is Off, the information in the report for such duplicate users generates incorrectly.
  • For "IBM Engineering Systems Design Rhapsody Architect for Software" and "IBM Engineering Systems Design Rhapsody Tool & Utilities Add On" products, you might see a difference in token counts between the token value and the user-based reports. Because of this difference, the license hours in the user-based report cannot be matched with the product usage hours in the token value report.
  • The data displayed in the "License Hours" column for user-based report and the "Product Usage Hours" column for token value report for the same set of parameters might be inaccurate. This inaccuracy arises when the products are part of the IBM Engineering portfolio and a user re-attempts the login after a web session timeout.

Back to top

Change History

What's New
 

IBM Common Licensing (ICL) 9.1 introduces updates to the user interface, platform components, and security features. These updates improve usability, maintain compatibility with current software platforms, and address security vulnerabilities.

Improved user experience

The License Key Server Administration and Reporting Tool (ART) has been migrated from Angular to React and rebuilt by using the IBM Carbon Design System.

These changes provide a more responsive and consistent user experience and establish a foundation for future enhancements to the ICL platform.

Updated the software prerequisites

IBM Common Licensing 9.1 includes updates to core platform components to maintain compatibility, improve performance, and provide continued vendor support.

 
  • Java 21 Upgrade: IBM Common Licensing now runs on IBM Semeru Certified Runtime Java 21. This update provides performance improvements, enhanced runtime security, access to modern Java features, and long-term support.
  • Liberty 26.0.0.6: It uses IBM WebSphere Liberty 26.0.0.6, which provides runtime stability improvements, security enhancements, and continued compliance with IBM Liberty standards.

  • IBM Db2 12.1.4: It supports IBM Db2 12.1.4, which provides compatibility with the latest Db2 features and includes database performance and reliability improvements.

    These updates help maintain platform compatibility and support while improving overall system performance.

Security vulnerabilities resolved
Includes remediation for security vulnerabilities, helping customers maintain a compliant licensing environment.

 

 

Off

Technical Support

Tab navigation

IBM Software Support Communities

  • Visit the IBM Support Portal to configure your support portal experience and review FAQs, lists of known problems, fixes, and a wealth of important support information.
     
  • Visit the IBM RFE Community to submit an enhancement request.
     
  • Visit the Jazz Community if you use a IBM product that is created by using the Jazz platform to interact directly with the Jazz development team and other community members, download product trials and betas and track development progress.

Helpful Hints For Obtaining Technical Assistance:

Before you contact IBM Software Support, gather the background information that you need to describe the problem. When you describe a problem to an IBM software support specialist, be as specific as possible and include all relevant background information so that the specialist can help you solve the problem efficiently. To save time, know the answers to these questions:

  • What software versions were you running when the problem occurred?
  • Do you have logs, traces, or messages that are related to the problem?
  • Can you reproduce the problem? If so, what steps do you take to reproduce it?
  • Is there a workaround for the problem? If so, be prepared to describe the workaround.

If you have helpful information to diagnose or identify the problem on your system, you can provide this data by following the instructions to exchange information with IBM Technical Support.

 

Follow IBM Client Support on Twitter | Facebook | YouTube | devWorks Blog

Back to top

Document Location

Worldwide

[{"Type":"MASTER","Line of Business":{"code":"LOB77","label":"Automation Platform"},"Business Unit":{"code":"BU048","label":"IBM Software"},"Product":{"code":"SSFT2B","label":"IBM Common Licensing"},"ARM Category":[{"code":"a8m0z0000001hfKAAQ","label":"RLegacy Categories-\u003ERational License Key Center"}],"ARM Case Number":"","Platform":[{"code":"PF002","label":"AIX"},{"code":"PF016","label":"Linux"},{"code":"PF033","label":"Windows"}],"Version":"9.1.0"}]

Document Information

Modified date:
01 September 2026

UID

ibm17284914

Page Feedback