IBM Licensing Tools
IBM Licensing Tools
Licensing
Tools
ILMT and IBM
License Service
User Guide
Version History
Version Updates
April 2022 – Added detail regarding the various possible configurations of ILMT, and the
components of ILMT which are necessary for a functioning system.
– Added content to the IBM License Service section reflecting the recently added
capability to account for Hyperthreading and Simultaneous Multithreading
(SMT), and provide links that explain how to enable this functionality.
– Updated the ILMT Lite Scenario to explain that ILMT Lite is now pre-approved
for environments up to 500 virtual environments.
August 2022 – Added detail regarding ILMT capability to collect metrics other than capacity
based.
3 Contents IBM Licensing Tools
Contents
Overview 4
Key Terms 4
Introduction 5
Detail 7
Scenarios 19
FAQs 21
Further Reading 25
4 Overview IBM Licensing Tools
Overview
The use of an approved license metering tool is necessary to comply with the eligibility requirements of
IBM Virtualization Capacity licensing policies for Sub-Capacity and Container Licensing. Clients often have
difficulty ensuring that their deployment of these tools is complete and accurate. An improperly configured or
incompletely deployed metering tool may report inaccurate license requirements. It may also mean that the
client does not meet the Sub-Capacity or Container Licensing terms and is therefore required to license its
IBM programs on a Full-Capacity basis. This can lead to significant findings in an audit context.
This guide is intended to provide information and best practice on setting up and managing the two IBM
license metering tools: IBM License Metric Tool (ILMT) and IBM License Service. ILMT is one of the two eligible
tools which clients must deploy to take advantage of Sub-Capacity licensing; IBM License Service is the only
tool which allows clients to take advantage of Container Licensing.
This guide describes relevant scenarios and best practices but it is not intended to provide advice for specific
client circumstances. Always consult your IBM representative should you have any questions or concerns
about ILMT and IBM License Service tools in your IBM estate.
Key Terms
The following terms are used throughout this document and are fundamental to understanding its contents.
This is not an exhaustive list, and some concepts may be discussed in other licensing guides or rely on
assumed knowledge.
A setting which constrains the processing An agreement which sets out licensing terms for
capacity consumed by containers in a Kubernetes all IBM programs licensed under the Passport
Namespace. Advantage Express program. It is available here.
Full-Capacity Kubernetes
The licensing of all the activated processor cores A program which manages (or “orchestrates”) the
installed on the physical machine. In other words, running of containerized applications. Kubernetes
the licensing of the full processing capacity of the is a management platform and can manage
physical machine. multiple types of container technology.
An IBM tool used to measure consumption of One or more worker nodes working together to run
certain IBM software metrics. Use of ILMT or containerized applications.
HCL BigFix Inventory is one of the eligibility
requirements for Sub-Capacity licensing.
5 Overview
Introduction IBM Licensing Tools
Introduction
Assumed Knowledge
This guide assumes knowledge of the following These reports must be completed at least
topics which are the subject of other guides. They quarterly, retained for a period of two years, and
are all available on this page. provided to IBM and/or its auditors on request.
Failure to do so, or failure to correctly configure the
– Virtualization Capacity: Sub-Capacity
tools, requires the IBM programs to be licensed on
– Virtualization Capacity: Container Licensing a Full-Capacity basis.
– Cloud Paks
ILMT
ILMT is a tool developed by IBM and provided free of charge. It is required for metering and reporting license
usage of IBM products deployed in “traditional” virtualization environments to take advantage of Sub-Capacity
licensing. IBM approves the use of certain alternate tools in lieu of ILMT. These are listed on the official IBM
Sub-Capacity Licensing page.
In addition to IBM License Service, IBM License Service Reporter allows you to consolidate IBM License
Service reports across multiple Kubernetes Clusters to present the aggregated peak license use of each IBM
program across all relevant clusters. IBM License Service Reporter also accepts ILMT as a data source, so that
you can report your Virtualization Capacity license use across both traditional virtualization technologies and
containerized deployments in one report.
The key points of similarity and difference between ILMT and IBM License Service are summarized in the table:
Purpose To allow clients to take advantage of IBM Virtualization Capacity licensing. Identifies IBM
programs, counts their license requirement and records this periodically to enable the
reporting of peak license use across a specified period.
Where is it deployed? An agent is installed on each virtual (or Installed as a self-contained Pod on
physical) machine with IBM program(s) each Kubernetes Cluster upon which
installed. IBM programs are running.
How does it discover IBM Components are discovered using software Uses Kubernetes Annotations to identify
programs? ID tags. A software catalog is used to IBM programs, relationships between
match these to IBM programs and identify programs (Bundled or Supporting, Cloud
bundled and supporting programs. Paks, and so on) and license metrics.
Creating Reports Each ILMT Managing Server will report all Will only report those installations in
deployments reported by agents connected the same cluster. IBM License Service
to it. Reporter can be used to aggregate
these reports from multiple IBM License
Service installations, otherwise this
must be performed manually.
This guide discusses ILMT and IBM License Service in greater depth than in the relevant Virtualization
Capacity license guides.
7 Detail IBM Licensing Tools
Detail
ILMT Key Configuration Steps
ILMT is a free of charge IBM program which There are five steps that must be performed upon
operates on a client-server basis. Agents are initial installation and configuration of ILMT:
installed on each virtual (or physical) machine
on which IBM programs are deployed and are
configured to ‘talk’ to the ILMT Managing Server to
1 Install and update ILMT
report measurement data on a periodic basis.
2 Configure the hardware and software scans
ILMT’s main purpose is to:
– Discover and report the IBM products 3 Classify the identified components
deployed on your distributed (Linux/Unix/
Windows) systems.
4 Review the license usage report
– Identify the hardware configurations (both
physical infrastructure and virtual environment
configuration settings) for “traditional” and 5 Generate the Audit Snapshot and archive it
eligible virtualization technologies such as
VMware, Microsoft Hyper-V and IBM PowerVM.
– Measure and record the license use of Subsequent changes to the IT environment or
identified IBM programs which have a deployment of IBM programs will require these
capacity-based license metric such as PVU or steps to be reperformed: for example, adding a
VPC. new virtual machine will require a new installation
and configuration. Steps 4 and 5 will need to
The requirement under IBM Virtualization Capacity be performed each time you generate a license
licensing is to generate complete and accurate use report, which should be carried out at least
reports of your license use at least every quarter quarterly.
and to retain these reports for two years. They
must be made available to IBM and its auditors If you encounter difficulties properly installing
upon request. and configuring ILMT in accordance with these
steps, best practice is to ensure that you open
an IBM Support call to record that you have
ILMT, like any other program, must be installed, encountered issues. This can be an important
configured and managed carefully. Merely reference point in any subsequent audit. However,
installing ILMT will not give you the reporting opening an IBM Support call does not remove
capability necessary to comply with the or relax the Virtualization Capacity eligibility
Virtualization Capacity licensing rules. It is not requirements for the associated IBM program
‘set and forget’. deployments. IBM Support calls are intended to
be used cooperatively to address any impediment
to compliance with the requirement to use ILMT.
If a client provides a support ticket as evidence
While this document provides guidance and for difficulties in installing ILMT, or creating and
best practices, always reference the official and retaining the required license use reports, we
comprehensive ILMT product documentation. reserve the right to review this to determine
whether prompt and reasonable steps have been
taken to comply and whether a real technical
impediment has prevented compliance.
8 Detail IBM Licensing Tools
The five steps are discussed in more detail below: once installed, are automatically gathering
capacity data and IBM Software inventory that
Step 1: Install and update ILMT: are stored into output packages on the local
VM/LPAR. Clients can use their own solutions
ILMT is an IBM program licensed through Passport
to support deployment of ILMT disconnected
Advantage with dedicated part numbers for the
scanners and data gathering of outputs
Base License and for annual S&S. Even though
packages generated by the ILMT Disconnected
there is no license charge for ILMT, you need to
Scanners to transfer them into a central
have the base license and active S&S on your
location for ILMT to import and use.
entitlement records. The part numbers required
and instructions on how to order ILMT are
documented here. This support page provides
reference links to the ILMT software download of If you wish to use the ILMT Lite configuration
ILMT packages accordingly to the provided ILMT (or you already use this configuration) and
deployment options with references to the ILMT you have more than 500 VMs and LPARs in
product documentation. scope for Virtualization Capacity, you must get
approval from IBM. Please contact your IBM
ILMT provides three deployment options to representative or send email to talk2sam@
accommodate clients’ environments and license [Link].
usage metering needs:
The following points are also important to ensuring a complete and accurate scan of hardware, software and
related license counts:
Cessation of eligibility IBM maintains a list of all eligible virtualization technologies here. However, as Link
for legacy virtualization platforms age and their vendors cease mainstream support, technologies cease to
technologies be eligible for Virtualization Capacity. IBM typically waits 180 days after the vendor
has ceased mainstream support before removing eligibility, so that most clients will
have already moved off the affected platforms. A regularly updated list of impending
changes to eligibility is kept at the link to the right.
If you do not move your IBM programs to an eligible platform, once eligibility
has ceased these installations must be licensed on a Full-Capacity basis.
x86 Virtualization: VM For certain x86 virtualization technologies such as VMware and Hyper-V, ILMT Link
Manager Configuration must collect hardware capacity data from the infrastructure used to deploy any
virtual machines. This is required to calculate any caps on the number of activated
processor cores or other capacity measures, as well as to assign the correct “PVU
per core” value for each activated processor core made available to an IBM program
licensed with the Processor Value Unit (PVU) metric.
To achieve this, ILMT needs to use an additional component called “VM Manager”.
The VM Manager connects to the Hypervisor and gathers information relating to the
hardware configuration of host machines and clusters.
When Virtualization data are missing the Server Name on which the VM/LPAR is
hosted on is reported by ILMT with the TLM_VM prefix followed by the UID (unique
identifier) of the VM/LPAR too and the Computer status within the Hardware
inventory report of ILMT is set to No VM Manager Data.
11 Detail IBM Licensing Tools
Public Cloud You do not need to configure ILMT’s VM Manager component unless you are fully BigFix: Link
managing the Hypervisor of the server too. However, you must configure the ILMT
agent or apply a “Tag” to the servers so that ILMT will apply the flat rate of 70 PVUs Disconnected
per vCPU, as per the BYOSL policy for Eligible Public Clouds. Scanners:
Link
If you do not do this, ILMT will apply a rate of 120 PVUs per vCPU.
LMT Disconnected ILMT Disconnected Scanners are used by ILMT Lite and ILMT with Ansible ILMT
Scanners deployments by default. ILMT Disconnected Scanners can also be used with ILMT Disconnected
with HCL’s BigFix platform configuration deployment when a machine with IBM Scanner
programs installed does not have connectivity to an ILMT Managing Server, or it is
not feasible to create this connection. The ILMT Disconnected Scanner can then be
used to collect the hardware and software information to be loaded into the ILMT
Managing Server.
12 Detail IBM Licensing Tools
Step 3: Classify the identified Newer releases of IBM programs make use of
software identification tags (as defined by ISO
components
19770-2). These tags reside in the file system.
Software classification is a key step in ensuring an ILMT finds and uses these to identify the
accurate inventory of IBM programs so that the components of IBM programs.
related license usage reports can be created for
Virtualization Capacity. The Overview and Key Concepts sections of the
ILMT documentation provide more information
ILMT discovers software components, and about how the ILMT Software Catalog is
maps these components to products based on conceptually organized: from software signatures
data contained in a software catalog which is to components to related products.
loaded into ILMT and must be kept up to date
as IBM releases updates so that the software While the ILMT product documentation discusses
identification is as complete and accurate as the related tasks needed to classify IBM products
possible. The software catalog is a collection of in some detail, ILMT also has some built-in logic
definitions of software products, their relationships and processes to assign discovered components to
and signatures that are used to detect software as IBM programs. The following guidance will help to
installed or used in an IT environment. ensure this is performed accurately:
Consideration Description
Currency of the The ILMT software catalog is updated every quarter along with ILMT Managing Server updates
Software Catalog and will often be updated automatically if you update your ILMT Server promptly. Failure to
keep the software catalog updated may cause inaccurate software classifications which would
need manual intervention to rectify until the software catalog is updated to the latest version.
Bundled and ILMT discovers software components and assigns them to IBM programs. Some components
Supporting Programs may be included as a Bundled or Supporting Program of a Principal Program and are therefore
not licensable themselves if they are used in accordance with the terms of the License
Information document.
ILMT’s software catalog contains the definitions of IBM programs, including non-chargeable
components. Keeping the catalog up to date is therefore important. The catalog enables
ILMT to make decisions automatically as to the status of Bundled or Supporting Programs
when these are installed on the same machine. Where these programs are installed across
multiple machines ILMT will be unable to determine the relationship between these programs.
This therefore requires manual intervention during software classification to mark relevant
installations as Bundled or Supporting.
Where the License Information document specifies that a license is required for the use for the
program as a whole and Bundled or Supporting Programs are installed on multiple machines,
these bundled or supporting programs must be assigned to the Principal Program name so
that the license calculation can be performed across the entire installation footprint. See the
‘Bundled and Supporting Programs’ license guide on the Guides page for more information.
Part Numbers Always import the list of part numbers that you have entitlement to and which you are Link
deploying.
While ILMT will use the software catalog to identify IBM programs from the installed
components, ILMT will perform a ‘best guess’ as to which IBM program the components
belong to. Importing your entitled part numbers increases ILMT’s accuracy as it narrows down
the number of possible IBM programs which a discovered component can be assigned to.
13 Detail IBM Licensing Tools
Consideration Description
Use comments It is possible to exclude discovered components from the license counts, or to suppress them
from the reports entirely. When doing so you are required to provide a comment to explain your
reasons.
Be as accurate and descriptive as possible when providing comments. Add IBM Support Ticket
numbers (TSxxxxxx) or any Problem Management (PMR) numbers to clarify the situation and
provide a trail for IBM to follow in our own internal documentation.
Cloud Paks IBM Cloud Paks can also be deployed on traditional virtualization technologies, either solely or Link
as part of a hybrid approach including containerized deployments.
If you are deploying programs that are licensed within one of the IBM Cloud Paks, you must
classify them in ILMT as belonging to the IBM Cloud Pak program so that ILMT can perform
the correct license use report.
Step 4: Review the license usage reports Regularly review the licensing usage
The primary source of information about license data to avoid pitfalls
usage is the “All Metrics” report. The report can To ensure completeness and accuracy of license
be filtered to show the relevant IBM products and usage data within your reports, ensure:
PVU and VPC license metrics for which you need
to generate and archive the related quarterly audit – All devices where you have deployed IBM
snapshots. You can also drill down further: products are included in the report and
software scan data is collected from the entire
– Clicking the product name shows a list of environment. To verify whether there are any
components classified as belonging to the problems, check the Software Scan Health
program (as performed during software widget on the Overview panel.
classification)
– Capacity data is collected from the entire
– Clicking the metric quantity shows a list environment and the proper PVU per core
of machines where the program has been values are being used. To verify whether there
installed and deployed, along with related are any problems, check the Capacity Scan
license use data Health widget on the Overview panel.
For every product, you can specify a metric – Software instances have been correctly
threshold to verify whether metric utilization is classified. Verify that IBM products licensed
above or below your expectations. For example, under IBM Cloud Paks have been properly
you could set your threshold to be the number assigned to the related Cloud Pak they a
of licenses that you hold to each IBM program, component of.
enabling you to easily see whether you require
additional licenses. – Verify that data imports have been successful.
To check the import history, go to ILMT Web
You can also create a snapshot of the report, UI: Management > Data Imports.
and store it for audit purposes (see the following
paragraph for more info: Generate the Audit
Snapshot and Archive it)
The Container Licensing policy covers the use of 2 Discovery of IBM programs
IBM programs in containerized environments. For
IBM licensing purposes, these containers must be
managed by a program called Kubernetes. This 3 Generation of audit snapshots
management is referred to as “orchestration”,
and so you will often see the term “Kubernetes-
orchestrated” in IBM documentation. If any of these steps is not properly performed, you
may need to be licensed on a Full-Capacity basis.
Unlike ILMT, IBM License Service does not require Always open an IBM Support call in case of issues
you to perform any software classification because with any of the required steps.
it makes use of Kubernetes Annotations to identify
which Pods belong to IBM programs. These
Annotations (which are conceptually similar to the
software tags used by ILMT) identify a program
as being standalone, or part of a bundled solution
such as a Cloud Pak. They also allow IBM License
Service to apply the licensing rules under the IBM
Container Licensing policy and to identify the
metric and applicable Cloud Pak ratios.
An instance of IBM License Service is required for each Kubernetes Cluster. A single instance of IBM License
Service will monitor all Cloud Paks or IBM containerized programs running on the same cluster as itself.
It uses Kubernetes capabilities to discover IBM programs and gather license usage-related data from the
running Pods.
To do this correctly, the IBM License Service Operator requires certain cluster permissions which are detailed
in the table below (although see the official documentation for the most up to date guidance):
ibmlicenseservicereporters/ List
status
Patch
ibmlicensings/finalizers
Update
ibmlicenseservicereporters/
finalizers Watch
IBM License Service has minimal impact on the performance of the cluster: it works transparently in the
background and does not require any configuration or user engagement once enabled.
IBM Container Licensing requires physical cores to be counted. Processors which support Hyperthreading (or
Simultaneous Multithreading – SMT) present multiple “virtual” cores which IBM License Service must account
for when determining the number of physical cores in each Kubernetes cluster which need to be licensed. You
need to enable hyperthreading in IBM License Service for each cluster to ensure it properly accounts for this
and counts license usage accurately.
Please refer to the IBM License Service documentation for more information about how to verify
Hyperthreading enabled values for your Kubernetes cluster and how to configure your installation(s) of IBM
License Service accordingly:
18 Detail IBM Licensing Tools
productChargedContainers: “All”
19 Detail IBM Licensing Tools
[Link] The unique checksums that are a proof that the audit snapshot was not
tempered with.
data_condition.txt Audit snapshot metadata that includes information about the cluster, the time
and date when the report was generated, and the reported period.
products_<reported_ The highest license usage for each product that is deployed on the cluster within
period>_<cluster hostname>.csv the reported period.
products_daily_<reported_ The highest license usage for each product that is deployed on the cluster within
period>_<cluster hostname>.csv the reported period daily.
bundled_products_<reported_ The highest license usage for each bundled product that is included in the IBM
period>_<cluster hostname>.csv Cloud Pak solutions that are deployed on the cluster within the reported period.
bundled_products_ The highest license usage for each bundled product that is included in the IBM
daily_<reported_ Cloud Pak solutions that are deployed on the cluster within the reported period
period>_<cluster hostname>.csv daily.
pub_key.pem The public key file that can be used to verify the [Link] file against the
[Link] file.
[Link] A digital signature that can be used to verify whether the [Link] file was
tampered with.
unrecognized-apps- <reported_ A list of pods from which the license usage data was not collected on a specified
period>.csv date. The pods have incomplete or missing product annotations that provide the
product metadata that is needed for measurements. The information is provided
for every date within the reported period. The list contains the namespace
followed by a pod name.
20 Detail IBM Licensing Tools
Scenarios
ILMT Lite The key steps for effective deployment and use of
ILMT Lite are:
If your environment consists of up to 500
computers (VMs/LPARs), you can opt to use the
ILMT Lite deployment configuration. ILMT Lite does Step 1: Install In the case of ILMT Lite, you need
not require the BigFix platform to be installed as and configure to install ILMT Server and its
it uses disconnected (stand-alone) scanners to (Lite scenario) database. Then, you need to install the
collect software and hardware information. disconnected (standalone) scanner on
every machine where you want to collect
ILMT Lite is pre-approved for up to a total of 500 hardware and software inventory data.
targets (that is, VMs and LPARs). Environments
larger than this require approval from IBM. Step 2: The application discovers software that
Classify is installed on your machines where
While standard ILMT configurations which use the
discovered the disconnected scanners have been
BigFix platform automate the scheduling of scan
software (Lite used. The components are automatically
result uploads, it is your responsibility to do this at
scenario) assigned to licensable IBM programs.
least once per week if you use ILMT Lite. These assignments must be reviewed
and either confirmed as accurate or
You can use one of the following approaches to
modified based on your knowledge of
upload scan results:
your license entitlement.
FAQs
IBM License Metric Tool Is ILMT “set and forget”?
No. ILMT requires detailed configuration to
How can I be kept up to date with ILMT supported ensure it is reporting a complete and accurate
and eligible virtualization environments? measurement of the IBM software licenses
For updates on the development of ILMT, use required. In addition, key data sets used by ILMT
the ‘IBM Notifications’ portal to search for and to identify and measure the IBM software are
subscribe to notifications about ILMT. For example, updated periodically and included in the ILMT
search for ‘IBM License Metric Tool’ and then Server component, which needs to be updated on
select the document types you wish to be notified a regular basis.
about as changes occur.
IBM License Service and License Service If I have multiple clusters where containerized
Reporter software is running, does License Service need
to be installed on each cluster or does a single
Can I use IBM License Service on third party cloud installation suffice?
environments? In the case of multiple clusters, License Service
Yes, you can take advantage of our Bring Your Own is installed in each cluster where containerized
Software License (“BYOSL”) policy for deploying software is deployed (the client should verify
IBM software on Eligible Public Clouds. The installation and keep License Service healthy).
Eligible Public Clouds are listed on the BYOSL
page.
How can I consolidate license usage data among
multiple clusters?
What if I do not use IBM License Service? IBM License Service will output data that can
Clients who do not use IBM License Service will be used for this consolidation but this must be
be charged for all cores in the entire Kubernetes done manually. Alternatively, clients can use
cluster. This is because when using Kubernetes IBM License Service Reporter to automate this
containers can run on any node throughout the task with the option to incorporate outputs from
cluster. It is possible therefore that a single ILMT installations which monitor Sub-Capacity
program might have containers which take deployments as well.
advantage of the entire capacity of the cluster at
once.
How does IBM License Service Reporter work with
IBM License Service?
How quickly do I have to install IBM License IBM License Service Reporter collects and
Service? aggregates data from IBM License Service from
New Container Licensing clients are required to multiple clusters and from IBM License Metric
implement IBM License Service within 90 days Tool. For more details consult the IBM License
of their first Eligible Product deployment within a Service documentation.
container. For subsequent deployments the IBM
License Service must be deployed and enabled
immediately. Is it necessary to have IBM License Service on
disaster recovery or backup Clusters?
Yes. You need to install IBM License Service on any
What are the exceptions to the requirement to use disaster recovery or backup Kubernetes Cluster.
IBM License Service for Container Licensing? Any IBM Program running Pod within the disaster
There are no exceptions. recovery or backup Kubernetes Cluster will then be
counted for IBM Container Licensing.
IBM License Service runs in a Pod within a IBM License Service may come preinstalled when
worker node within the Cluster as determined by deploying containerized software via each IBM
Kubernetes scheduler. Cloud Pak’s services and within IBM Certified
Containers. Please verify the installation upon your
first container deployment. If IBM License Service
is not installed, contact product support.
25 FAQs IBM Licensing Tools
What is the part number used to order IBM Does IBM License Service report license usage for
License Service? “Monthly API Call” or other metrics aside from
There is no part number associated with IBM Processor Value Unit (PVU) and VPC?
License Service. IBM License Service collects information about
PVU and VPC metrics automatically for the
IBM programs which are enabled for reporting.
Does IBM License Service come with Red Additionally, IBM License Service can report
Hat OpenShift Container Platform (RHOCP) license usage for any other metric, including
entitlement? “Monthly API Call”. Enabling a program to be
measured by IBM License Service requires the
No. IBM License Service does not come with a free IBM product teams to incorporate the mechanism
RHOCP entitlement. License Service is included for delivering measurement data to IBM License
in the IBM Cloud Pak services and therefore Service into the program itself. If your program
leverages available RHOCP entitlements of the does not currently have this capability, and you
Cloud Pak or direct entitlements that the client would like it to have it in the future, please contact
obtains from Red Hat. When IBM License Service IBM Support. Understanding client needs in this
is being utilized outside Cloud Paks, you are area will allow IBM to prioritize the integration of
responsible for any overhead that License Service this feature appropriately.
may require.
Further Reading
IBM License Service Operator IBM Notifications
A GitHub repository providing information on IBM The IBM Portal where you can subscribe to
License Server and detailed instructions on how to notifications about various documents and keep up
deploy IBM License Service for Container Licensing. to date with the latest news that affects your IBM
[Link] licensing.
[Link]