IBM Tivoli License Managerpublib.boulder.ibm.com/tividd/td/ITLM/GC23-4833-00/... · v Chapter 5, “Managing Software Entitlement and License Pool Details” provides instructions

IBM Tivoli License Manager

License Administrator’s GuideVersion 1.1

GC23-4833-00

��

IBM Tivoli License Manager

License Administrator’s GuideVersion 1.1

GC23-4833-00

��

First Edition (October 2002)

This edition applies to Version 1.1 of IBM Tivoli License Manager and to all subsequent releases and modificationsuntil otherwise indicated in new editions. Make sure that you are using the correct edition for the level of theproduct.

Order publications through your IBM representative or the IBM branch office serving your locality. Publications arenot stocked at the address given below.

IBM welcomes your comments.

Address your comments to:

License Managment Information DevelopmentRome Tivoli LabIBM Italia S.p.A.Via Sciangai, 5300144 RomeItaly

Fax Number: (+39) 06 5966 2077

Internet ID: ROMERCF at VNET.IBM.COM

When you send information to IBM, you grant IBM a non-exclusive right to use or distribute the information in anyway it believes appropriate without incurring any obligation to you.

© Copyright International Business Machines Corporation 2001, 2002. All rights reserved.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contractwith IBM Corp.

Note

Before using this information and the product it supports, be sure to read the general information under“Notices”.

Notices

References in this publication to IBM products, programs, or services do not implythat IBM intends to make these available in all countries in which IBM operates.Any reference to an IBM product, program, or service is not intended to state orimply that only IBM’s product, program, or service may be used. Any functionallyequivalent product, program, or service that does not infringe any of IBM’sintellectual property rights may be used instead of the IBM product, program, orservice. Evaluation and verification of operation in conjunction with otherproducts, except those that are expressly designated by IBM, are the user’sresponsibility.

IBM may have patents or pending patent applications by covering subject matterin this document. The furnishing of this document does not give you any license tothese patents. You can send license inquiries, in writing, to:

IBM Director of LicensingIBM CorporationNorth Castle DriveArmonk, NY 10504-1785U.S.A.

Licensees of this program who wish to have information about it for the purposeof enabling: (i) the exchange of information between independently createdprograms and other programs (including this one) and (ii) the mutual use of theinformation which has been exchanged, should contact:

IBM CorporationP.O. Box 121953039 CornwallisResearch Triangle Park, NC 27709-2195U.S.A.

Such information may be available, subject to appropriate terms and conditions,including in some cases, payment of a fee.

TrademarksThe following terms are trademarks of the IBM Corporation in the United States orother countries or both:

IBMThe IBM logoTivoliWebSphere

UNIX is a registered trademark in the United States and other countries licensedexclusively through X/Open Company Limited.

Microsoft, Windows, Windows NT, and the Windows logo are registeredtrademarks, of Microsoft Corporation in the U.S. and other countries.

© Copyright IBM Corp. 2001, 2002 iii

Pentium is a registered trademark of Intel Corporation in the US and othercountries.

Java and all Java-based trademarks and logos are trademarks or registeredtrademarks of Sun Microsystems, Inc. in the U.S., and other countries.

Other company, product, and service names may be trademarks or service marksof others.

iv IBM Tivoli License Manager: License Administrator’s Guide

Contents

Notices . . . . . . . . . . . . . . . iiiTrademarks . . . . . . . . . . . . . . iii

Figures . . . . . . . . . . . . . . vii

Tables . . . . . . . . . . . . . . . ix

About This Book. . . . . . . . . . . xiWho should read this book . . . . . . . . . xiRelated documents . . . . . . . . . . . . xiHow this book is organized . . . . . . . . . xiNotational conventions . . . . . . . . . . xii

Chapter 1. Overview . . . . . . . . . 1Benefits . . . . . . . . . . . . . . . . 1License Manager Components . . . . . . . . 2Managing Software Product Information . . . . . 4Administering Licenses and Metering Software Use . 4Reporting . . . . . . . . . . . . . . . 5Event Management . . . . . . . . . . . . 5Logs and Support for Problem Determination . . . 5

Chapter 2. Getting Started on the WebInterfaces . . . . . . . . . . . . . . 7Accessing the administration server . . . . . . 7Accessing a runtime server . . . . . . . . . 8About the Web interface . . . . . . . . . . 9

The portfolio . . . . . . . . . . . . . 10The work area . . . . . . . . . . . . 10The toolbar . . . . . . . . . . . . . 11

Web interface tasks . . . . . . . . . . . . 11

Chapter 3. Managing Customers andAdministrators . . . . . . . . . . . 15Adding customers to the administration serverdatabase . . . . . . . . . . . . . . . 15Updating or deleting customer details . . . . . 16Adding administrator accounts to the administrationserver database . . . . . . . . . . . . . 17Updating or deleting administration account details 19

Chapter 4. Managing Components . . . 23Defining the monitoring structure for a customer . . 23

Registering a runtime server. . . . . . . . 24Reviewing and changing runtime servers . . . 25Adding divisions . . . . . . . . . . . 27Reviewing and changing divisions. . . . . . 28Deploying an agent on a node . . . . . . . 30Reviewing and deleting agents . . . . . . . 32

Managing demographic information . . . . . . 34Adding nodes . . . . . . . . . . . . 34Reviewing and changing nodes. . . . . . . 35Adding application users . . . . . . . . . 37

Changing or deleting user details . . . . . . 38

Chapter 5. Managing SoftwareEntitlement and License Pool Details . 41Selecting a product for entitlement or license poolmaintenance . . . . . . . . . . . . . . 41Maintaining entitlement settings for a product. . . 43Creating a license pool . . . . . . . . . . 45Setting license distribution parameters . . . . . 48Updating a license pool . . . . . . . . . . 50Modifying license distribution settings . . . . . 52

Modifying target distribution settings. . . . . 53Modifying user distribution settings . . . . . 54

Chapter 6. Reporting Software UsageInformation . . . . . . . . . . . . . 57Producing a historical snapshot software usagereport . . . . . . . . . . . . . . . . 57

Requesting the report . . . . . . . . . . 57Navigating the report . . . . . . . . . . 60

Producing a software usage trend analysis report . . 64Requesting the report . . . . . . . . . . 65Using the report . . . . . . . . . . . . 67

Producing a software usage level analysis report . . 69Producing a real-time software usage report . . . 73

Requesting the report . . . . . . . . . . 73Navigating the report . . . . . . . . . . 75

Exporting reports . . . . . . . . . . . . 80

Chapter 7. Managing and ReportingInventory Information . . . . . . . . 81Scheduling inventory scans . . . . . . . . . 81Producing a software inventory report . . . . . 83

Requesting the inventory report . . . . . . 83The software inventory report . . . . . . . 85

Chapter 8. Managing ProductInformation . . . . . . . . . . . . . 89Catalogs and unknown file information . . . . . 89Using the catalog manager to update the mastercatalog . . . . . . . . . . . . . . . . 90

Adding unknown files to the master catalog . . 92Importing the IBM catalog . . . . . . . . 94Modifying entries in the master catalog . . . . 95

Appendix A. Messages . . . . . . . . 99Message Details . . . . . . . . . . . . 100

Appendix B. Accessibility . . . . . . 107Navigating the Web interface . . . . . . . . 107Shortcut keys for starting tasks . . . . . . . 107Shortcut keys for performing toolbar actions . . . 108

© Copyright IBM Corp. 2001, 2002 v

Glossary . . . . . . . . . . . . . 109 Index . . . . . . . . . . . . . . . 113

vi IBM Tivoli License Manager: License Administrator’s Guide

Figures

1. Structural relationship of IBM Tivoli LicenseManager components . . . . . . . . . 3

2. The parts of the Web interface . . . . . . 103. Product list in the historical software usage

report . . . . . . . . . . . . . . 604. Product details in the historical software usage

report . . . . . . . . . . . . . . 625. List of agents in the historical software usage

report . . . . . . . . . . . . . . 626. License pools in the historical software usage

report . . . . . . . . . . . . . . 637. Sessions in the historical software usage report 64

8. Trend Analysis report in step format . . . . 689. The Level Analysis report . . . . . . . . 73

10. Product list in the real-time software usagereport . . . . . . . . . . . . . . 76

11. Product details in the real-time software usagereport . . . . . . . . . . . . . . 77

12. License pools in the real-time software usagereport . . . . . . . . . . . . . . 78

13. Open sessions in the real-time software usagereport . . . . . . . . . . . . . . 79

14. Software inventory report . . . . . . . . 86

© Copyright IBM Corp. 2001, 2002 vii

viii IBM Tivoli License Manager: License Administrator’s Guide

Tables

1. Toolbar icons and actions . . . . . . . . 112. Web interface tasks . . . . . . . . . . 113. Tivoli License Manager message categories 994. Tivoli License Manager messages . . . . . 100

5. Key combinations for navigating the Webinterface . . . . . . . . . . . . . 107

6. Key combinations for starting tasks . . . . 1077. Key combinations for toolbar actions 108

© Copyright IBM Corp. 2001, 2002 ix

x IBM Tivoli License Manager: License Administrator’s Guide

About This Book

This book describes IBM Tivoli License Manager. It contains a general overview ofthe functionality of Tivoli License Manager and instructions on using the Webinterfaces to set up a monitoring infrastructure, define licensing conditions, andproduce reports.

Who should read this bookThis book is intended for license administrators who are responsible for definingthe licensing conditions and monitoring their application.

Related documentsThe IBM Tivoli License Manager library also includes the following books:v IBM Tivoli License Manager System Administrator’s Guide

Provides support for planning, installing, and managing the Tivoli LicenseManager product.

v IBM Tivoli License Manager Data Dictionary

Provides descriptions of the database tables and indexes maintained in the IBMTivoli License Manager DB2 database.

How this book is organizedThis book is organized as follows:v Chapter 1, “Overview” provides a summary of the benefits of Tivoli License

Manager and a brief description of the components that it includes.v Chapter 2, “Getting Started on the Web Interfaces” summarizes the online

functionality of Tivoli License Manager.v Chapter 3, “Managing Customers and Administrators” provides instructions for

the online tasks of creating and managing the customers and administrators ofthe license management implementation.

v Chapter 4, “Managing Components” provides instructions for the online tasksrequired for maintaining license manager servers, agents, monitored machines,and users of monitored applications.

v Chapter 5, “Managing Software Entitlement and License Pool Details” providesinstructions for the online tasks involved in administering licenses andmonitoring the presence and usage of software products.

v Chapter 6, “Reporting Software Usage Information” provides instructions aboutproducing and navigating the real-time and historical software usage reportsthat are available from the Web interfaces.

v Chapter 7, “Managing and Reporting Inventory Information” providesinformation about scheduling inventory scans of monitored machines andproducing inventory reports.

v Chapter 8, “Managing Product Information” provides an overview of themanagement and use of product catalogs and instructions for updating themaster catalog using the catalog manager application.

v A list of the error messages used in Tivoli License Manager.

© Copyright IBM Corp. 2001, 2002 xi

Notational conventionsThis book uses the following notation in text:

Bold Denotes something you click, select, or type, such as a menu option, field,or push button.

Italics Italics are used for variables, for new terms in the text, and for emphasis.

MonospacingMonospacing is used for path and file names and for examples.

<text> Indicates a variable in a path name. For example in the path,<INSTALL-DIR>\tlm, INSTALL-DIR depends on the location where youhave installed the component, while \tlm is constant.

xii IBM Tivoli License Manager: License Administrator’s Guide

Chapter 1. Overview

IBM Tivoli License Manager is a Web-based solution that provides softwareusage metering and license allocation services on Windows® and UNIX platforms.It can be scaled to meet the needs of all sizes of customer and can supportcustomer-managed and IBM-managed accounts.

This chapter provides a summary of the capabilities of Tivoli License Manager andof the benefits that it can provide, as follows:v A summary of the benefits of using Tivoli License Manager. See “Benefits”.v An overview of the architecture of a Tivoli License Manager installation. See

“License Manager Components” on page 2.v An overview of the processes for collecting and maintaining the information

about the software products that are managed and metered by Tivoli LicenseManager. See “Managing Software Product Information” on page 4.

v An overview of different options for license allocation that are available withinTivoli License Manager. See “Administering Licenses and Metering SoftwareUse” on page 4.

v A summary of the facilities for real-time and historical reporting that areprovided by Tivoli License Manager. See “Reporting” on page 5.

v A summary of the facilities for sending notifications about license managementevents. See “Event Management” on page 5.

v A summary of the facilities for logging events and tracing problems within thecomponents of Tivoli License Manager. See “Logs and Support for ProblemDetermination” on page 5.

BenefitsTivoli License Manager provides the following benefits:v A flexible architecture that allows you to scale the installation to fit your license

management needs.v Consolidation of information about products installed and software usage.v The capability to compare the figures for procured, installed, and used licenses.v A flexible method of defining rules for license allocation, including the facility to

assign pools of licenses to specific users, nodes, and divisions.v A method of metering software usage even for products that have no license

requirement.v Automatic generation of alerts when license usage reaches a defined level.v Real-time reporting of software and license usage information.v The capability to enforce licensing agreements.v Maintenance of historical software usage information and the provision of

reports to assist in forward planning for license needs.v Ability to export reports to a standard XML interface.v Security of confidential information ensured by the maintenance of security

profiles for access to the Web interface, and by the encryption of data duringtransmission between servers or between server and agents.

© Copyright IBM Corp. 2001, 2002 1

v The ability to work on different platforms. The servers can be installed onWindows and AIX systems, and the agents can be deployed to Windows, Linux,AIX, and Sun systems.

License Manager ComponentsAny Tivoli License Manager installation has the following components:

Tivoli License Manager agentA license management agent must be deployed on each customer nodes that isto be monitored by Tivoli License Manager. Each agent performs the followingfunctions:v Performs an inventory of the software installed on the node and forwards

this information to the runtime server.v Identifies the starting or stopping of a software product and communicates

this information to the runtime server so that a license can be assigned orreleased.

Once an agent is deployed on a node, you can set the agent to automaticallyapply any upgrades that are available on the runtime server.

Tivoli License Manager runtime serverA Tivoli License Manager installation has at least one runtime server and canhave several. Each runtime server provides the following facilities:v A repository for information about the software installed on the agents that

are managed by the server.v The capability to assign and release the licenses that are assigned to the

server according to the rules defined for each license pool.v The capability to generate and send e-mails to provide a notification about

events that have occurred on the server or its agents.v A Web interface that can be used to deploy the agents to nodes that are to

be monitored and to produce real-time reports of license usage for softwarerunning on the managed agents.

Tivoli License Manager administration serverA Tivoli License Manager installation has a single administration server. Itprovides the following facilities:v A central repository of product, license agreement, license usage, and

customer information.v A Web interface that can be used to perform license management and

administration tasks and to produce historical reports of license usage overtime.

Figure 1 on page 3 shows the basic Tivoli License Manager structure: a singlecentral administration server, a runtime server, and multiple agents.

2 IBM Tivoli License Manager: License Administrator’s Guide

You can expand this structure, adding more runtime servers on different machinesto improve performance in an environment where there are many agents. You canalso add divisions within which agents can be grouped so that multiple agents canbe selected as a single entity. For example, you can use divisions to limit theavailability of licenses to the nodes that are monitored by agents within a specifieddivision.

There is always only one administration server, which maintains the centralknowledge-base of product, license, and user information in an associated DB2database. The administration server can be used to manage the licensing needs ofmultiple customers, in an IBM-managed scenario or can be dedicated to a singlecustomer, in a customer-managed scenario.

In all IBM Tivoli License Manager installations, the runtime servers and agentsmust be assigned to a customer. In a self-managed scenario, there is normally onlyone customer to which all components belong. In an IBM-managed scenario, thereare many customers, each with its own runtime servers and agents.

The management of the Tivoli License Manager components, the definition of thelicense management rules, and the management of events that occur duringmonitoring are the responsibility of the Tivoli License Manager administratorassigned to the customer.

For information on defining the structure of your IBM Tivoli License Managerinstallation, see Chapter 4, “Managing Components” on page 23. For informationon defining customers and administrators, see Chapter 3, “Managing Customersand Administrators” on page 15.

RuntimeServer

DBMSAdministrationServer

Agents

DBMS

Figure 1. Structural relationship of IBM Tivoli License Manager components

Chapter 1. Overview 3

Managing Software Product InformationTivoli License Manager maintains a master catalog where details of all theproducts that can be monitored by Tivoli License Manager are stored. This catalogresides on the administration server and a copy of it is periodically downloaded toeach runtime server.

The Tivoli License Manager catalog manager enables you to add entries to thecatalog, using information from the following sources:

The unknown files tableThis table is compiled from information collected the agents about applicationsthat started but could not be monitored because they were not in the catalog.The catalog manager allows you to add these files to the catalog by creatingnew catalog entries or by assigning files to existing entries.

The IBM catalogThis contains information about IBM products. You can use the catalogmanager to merge this file with the master catalog when you receive a newversion from IBM.

In addition to the copy of the master catalog, each runtime server has a runtimecatalog. This catalog is a subset of the master catalog. It only includes those entriesfrom the master catalog that relates to products that have been discovered runningon nodes by agents that are assigned to the server.

For more information about catalogs, unknown files, and using the catalogmanager, see Chapter 8, “Managing Product Information” on page 89.

Administering Licenses and Metering Software UseYou can use Tivoli License Manager to enforce the conditions of procured licenses,to meter the usage of software products by recording and reporting their presenceand levels of usage on monitored notes, or it can do both of these.

Administration of licenses and metering of software depends on the license poolsthat exist for each product. If you have procured licenses and want to enforce theircondtions, you can define license pools to reflect the terms and conditions of thelicenses. If you only want to track the usage of software products, you can use thedefault license settings provided with Tivoli License Manager.

The information specified for a license pool includes the number of licensesavailable, any limitations on the availability of the license pools to specified usersand nodes, and rules that control allocation of licenses when the limit is reached.

You can define a license pool to enforce an existing license agreement or you canuse a default license pool to simply monitor the usage of software, withoutapplying any limits.

By default, license pools are available to all valid users on the monitored nodes.However, you can specify that a license pool is available only to selected users oronly on selected monitored nodes.

For more information about defining license pools, see Chapter 5, “ManagingSoftware Entitlement and License Pool Details” on page 41.


You define license pools on the administration server and they are automaticallydeployed to the appropriate runtime servers. The license pool for a product isaccessed when the agent communicates to the runtime server that a monitoredapplication has started. Availability is checked and the license is allocated orrefused accordingly. When the application closes, the agent communicates with theruntime server and the license is released.

ReportingIBM Tivoli License Manager provides both real-time and historical reporting.

You can obtain real-time reports on the status of software usage on a specificruntime server by pointing a browser at the server and selecting the report.

Historical reports of inventory and software usage information are available on theadministration server. IBM Tivoli License Manager includes a set of preconfiguredreports for the analysis of collected software usage and inventory data.

For more information about reporting. see Chapter 6, “Reporting Software UsageInformation” on page 57 and Chapter 7, “Managing and Reporting InventoryInformation” on page 81.

Event ManagementThe runtime server includes an event management component that can identifyevents that require the attention of the system administrator and forward them toan external e-mail system.

Tivoli License Manager automatically generates some events. These include eventsregarding the state of the license pools. For example, an event is generated if thenumber of licenses in use for a pool has reached the specified threshold or if thefull entitlement is used. The event management component is able to determinethat an agent is either down or has been uninstalled and can generate and forwardan e-mail to alert the person responsible. You can specify which administrators areto receive notifications.

For more information about event management, see the IBM Tivoli License ManagerSystem Administrator’s Guide.

Logs and Support for Problem DeterminationTivoli License Manager provides a trace service on the administration server andon all runtime servers. This service allows you to trace all activities generated byTivoli License Manager.

You can determine the level of detail you record by setting a trace level on eachserver. Depending on the trace level you select, the trace service records details oferrors, operations, data movement, and processes.

For more information about problems solving, see the IBM Tivoli License ManagerSystem Administrator’s Guide.

Chapter 1. Overview 5


Chapter 2. Getting Started on the Web Interfaces

The aim of this chapter is to help you to start using the Tivoli License ManagerWeb interfaces.

The main Web interface is on the administration server. Using this interface, youcan request historical reports and perform Tivoli License Manager systemdefinition and license maintenance tasks.

Web interfaces are also provided on each runtime server. You can use theseinterfaces to request real-time reports and to deploy agents.

This chapter provides the following information:v Instructions for logging on to the administration server. See “Accessing the

administration server”.v Instructions for logging on to a runtime server. See “Accessing a runtime server”

on page 8.v A description of the components of the Web interface, including general

information that is relevant to all Web interface tasks. See “About the Webinterface” on page 9.*

v A summary of functions available on the interface and where to find them. See“Web interface tasks” on page 11.

Note: When logging on to any Tivoli License Manager server for the first time,you must use the user ID tlmroot. When you are logged on as tlmroot youcan create accounts for the administrators who will work on the server.

The initial password for the tlmroot user is system. You should change thison each server as soon as you have logged on. See “Updating or deletingadministration account details” on page 19 for instructions on changing thepassword of an administrator.

Accessing the administration serverTo access the Web interface of the administration server:1. Using a browser, access the administration server logon page.

The address of the page is http://<server name>:<port>/slmadmin/login

Notes:

a. If you are using the default port (80), you do not need to specify the port inthe page address.

b. If you are using a secure (SSL) connection, you must specify https instead ofhttp.


2. Enter a valid User Name and Password pair and click OK.

A welcome panel appears on the main part of the window. From this panel.you can select a customer from the drop-down list if you are working on acentral administration site with multiple customers.

The portfolio on the left of the page provides a navigable list of the tasks youcan perform on the administration server.

Accessing a runtime serverTo access the Web interface of a runtime server:1. Using a browser, access the runtime server logon page.

The address of the page is http://<server name>:<port>/slmruntime/login

Notes:

a. If you are using the default port (80), you do not need to specify the port inthe page address.

b. If you are using a secure (SSL) connection, you must specify https instead ofhttp.


2. Enter a valid User Name and Password pair and click OK.

A welcome panel appears on the main part of the window.

The portfolio on the left of the page provides a navigable list of the tasks youcan perform on the runtime server.

About the Web interfaceThis section aims to help you become familiar with features of the Tivoli LicenseManager Web interface that are common to all tasks.

The Web interface consists of the following parts:v The portfolio, where you select the task you want to perform.v The work area, where you enter information and make selections that are

needed to complete the task you selected.v The toolbar, which contains a number of icons representing actions that are

available within all tasks, for example, getting help.

Figure 2 on page 10 shows a page on the Tivoli License Manager Web interface andindicates the different parts of the interface.

Chapter 2. Getting Started on the Web Interfaces 9

The portfolioThe portfolio shows a list of all the tasks groups that are available on the Webinterface. Most task groups include several tasks. For example, the Software Usagetask group includes the software usage snapshot, trend analysis, and level analysisreports. When you click a task group, it expands and you can see the individualtasks it includes. When you click a task name, the first dialog of the task appearsin the work area.

The work areaThe dialogs that you must complete to perform a task appear in the work area ofthe Web interface. They consist of controls where you must enter or selectinformation, as follows:v Input boxes that allow you to enter information by typing. These boxes can have

restrictions on the type of characters that can be entered. For example, theproduct name field shown in Figure 2 allows any alpha-numeric characters, butan input box that is part of a date would expect a numeric input that can beinterpreted as a valid date.

v List boxes that allow you to select from a set of possible values. Lists can bestatic or dynamic.Static lists show a set of fixed values. For example, when defining a license pool,you must choose a target type from one of four possible values.Dynamic lists are those that show values that are user-defined. For example, alist of divisions includes all the divisions that have been defined for the selectedcustomer. As dynamic lists can include a large number of items, the list issometimes truncated to a default maximum of 25 000. Where it is possible thatlists might include more items than this maximum the dialogs provide a form ofpre-selection. For example, because the agent list is likely to be long, the TivoliLicense Manager wizards that include agent selection, allow you to limitselection to selected divisions. The resulting agent list only includes agents forthe selected divisions.

Figure 2. The parts of the Web interface


Generally, static lists allow the selection of a single value. In a dynamic list youcan select multiple items.

v Radio buttons, which allow you to choose one of a small group of pre-definedoptions.

Note: Any control that is marked with an asterisk (*) is a required field.

The toolbarTable 2 lists the toolbar icons that are available and action that is taken when youclick each icon.

Table 1. Toolbar icons and actions

Icon Action

Toggles between the default view where the interface is divided betweenthe portfolio and the workarea and a view where the portfolio is hidden.

Displays the home page where you can select a different customer towork with..

Refreshes the display to show the most recent data.

Logs the user off the Web interface.

Opens the accessiblity help window where you can read about keyboardalternatives for navigating the interface and performing actions.

Opens the Tivoli License Manager information where you can see productversion and copyright information.

Opens the help window for the current dialog.

Web interface tasksTable 2 summarizes the tasks that you can perform on the Web interfaces. For eachtask, the table indicates whether you perform the task on the administration orruntime server and provides a reference to instructions for performing the task.

Note: You can perform most of the tasks by accessing the appropriate server fromany node that has a browser that meets the Tivoli License Managerprerequisites. The exception to this is deployment of the agent. This taskmust be performed from the node where the agent is to be deployed.

Table 2. Web interface tasks

Task Server See

Adding customers to theadministration serverdatabase.

Administration “Adding customers to theadministration server database” onpage 15.

Making changes to customerdetails.

Administration “Updating or deleting customer details”on page 16.

Removing customers from theadministration serverdatabase.

Administration “Updating or deleting customer details”on page 16

Adding Tivoli LicenseManager administrators.

Administrationand Runtime

“Adding administrator accounts to theadministration server database” onpage 17.


Table 2. Web interface tasks (continued)

Task Server See

Changing administratordetails and assigningcustomers to administrators.


“Updating or deleting administrationaccount details” on page 19.

Removing administratoraccounts from theadministration serverdatabase.


“Updating or deleting administrationaccount details” on page 19.

Registering runtime serversthat you have installed.

Administration “Registering a runtime server” onpage 24.

Reviewing and modifyingruntime servers that arealready registered.

Administration “Reviewing and changing runtimeservers” on page 25.

Adding divisions. Administration “Adding divisions” on page 27.

Reviewing, modifying, ordeleting existing divisions.

Administration “Reviewing and changing divisions” onpage 28.

Registering nodes in theadministration serverdatabase.

Administration “Adding nodes” on page 34.

Reviewing, modifying ordeleting node information.

Administration “Reviewing and changing nodes” onpage 35.

Deploying the agent on anode.

Runtime “Deploying an agent on a node” onpage 30.Note: For this task, you do not need tolog on to the runtime server.

Reviewing or deletingdeployed agents.

Administration “Reviewing and deleting agents” onpage 32.

Defining users of monitoredapplications.

Administration “Adding application users” on page 37.

Updating application userinformation.

Administration “Changing or deleting user details” onpage 38.

Removing application usersfrom the administrationserver database.

Administration “Changing or deleting user details” onpage 38

Maintaining general licenserules for a product.

Administration “Maintaining entitlement settings for aproduct” on page 43.

Creating a license pool for aproduct.

Administration “Creating a license pool” on page 45.

Updating a license pool for aproduct.

Administration “Updating a license pool” on page 50.

Changing the users andtargets that have access to alicense pool.

Administration “Modifying license distribution settings”on page 52.

Producing a detailed reportof software usage as it was ata specified date and time.

Administration “Producing a historical snapshotsoftware usage report” on page 57.

Producing charts for theanalysis of trends in softwareusage over a specified periodof time.

Administration “Producing a software usage trendanalysis report” on page 64


Table 2. Web interface tasks (continued)

Task Server See

Producing a summary of thelevel of usage of softwareproducts over a specifiedperiod of time.

Administration “Producing a software usage levelanalysis report” on page 69.

Producing a report of thecurrent software usage onagents registered with aspecific runtime server.

Runtime “Producing a real-time software usagereport” on page 73.

Defining a schedule forinventory scans of monitorednodes.

Administration “Scheduling inventory scans” onpage 81.

Producing a historical reportof inventory information thathas been collected frommonitored nodes.

Administration “Producing a software inventory report”on page 83.



Chapter 3. Managing Customers and Administrators

This chapter describes the functions on the administration server Web interfacethat allows you to create records for the administrators who will use the Webinterfaces and for customers and to assign customers to the administrators.

Each customer is the owner of its Tivoli License Manager components, licensepools, and reports. Whenever you log on to the administration server, you mustselect a customer. The Tivoli License Manager components, license pools, andreports that you can work with are those that belong to selected customer.

Administrators are the users who can log on to the Web interfaces. On theadministration server, you must define administrators and assign customers tothem. When the administrator logs on to the administration server, the onlycustomers available for selection are those that are assigned to him or her. Allcustomers must have at least one administrator for administration server tasks, andmight have several, because administrators can have different levels of access tothe administration server functions. You must also create at least one administratoron each runtime server.

When you have created a customer and assigned it to an administrator, you cancreate a monitoring structure for the customer. See Chapter 4, “ManagingComponents” on page 23.

The following tasks are described:v Creating details of a customer whose site is monitored from the application

server. See “Adding customers to the administration server database”v Changing or deleting the details of a customer. See “Updating or deleting

customer details” on page 16v Creating an account for a Tivoli License Manager administrator. See “Adding

administrator accounts to the administration server database” on page 17.v Changing the details of an administrator account. See “Updating or deleting

administration account details” on page 19.

You perform these tasks using a browser to access the administration or runtimeserver interface. See Chapter 2, “Getting Started on the Web Interfaces” on page 7for instructions on logging on to Web interfaces.

To perform these tasks you must be logged on to the Tivoli License Managerserver Web interface as tlmroot.

Adding customers to the administration server databaseYou use this function to record details of the customers whose licenses you aremonitoring.

To add a customer to the administration server database, complete the followingsteps:


1. In the portfolio, click Administration, then when the Administration itemexpands to show a list of sub-items, click Customers.

2. Click Create.

3. Enter the details of a customer whose licenses you are managing.

Note: The value you enter for Name must include only US ASCII characters.4. Click Finish.

The customer details are recorded in the administration server database. Youcan now select this customer, using the Change Customer function and set upthe topology of runtime servers, agents, and application users for the customer.See Chapter 4, “Managing Components” on page 23.

Updating or deleting customer detailsTo change or delete information for a customer whose details are recorded on theadministration server database, complete the following steps:


1. In the portfolio, click Administration, then when the Administration itemexpands to show a list of sub-items, click Customers.

2. Select the customer you want to update or delete from the list of customers.3. Click Next.

4. If you want to delete the customer, check the details, and if this is the correctcustomer, click Delete.

Note: When you delete a customer, you also delete all components and datathat are associated with the customer.

If you want to change the customer details, make the required changes andthen click Finish.

Adding administrator accounts to the administration server databaseYou use this function to create accounts for administrators who are entitled to usethe Tivoli License Manager Web interface.

Note: This function is available on both the administration and runtime serverinterface. On the administration server, define administrators who are to usethe administration server interface and receive notifications generated by the

Chapter 3. Managing Customers and Administrators 17

administration server. On each runtime server, define administrators whoare to use the runtime server interface and receive notifications generated bythat runtime server.

To add an administration account to the administration server database, completethe following steps:1. In the portfolio, click Administration. If you are working on the administration

server, the Administration item expands to show a list of sub-items; clickAccounts.

2. Click Create.

3. Enter the details of the user who is to be allowed access to the Web interface.If the administrator is to receive notifications, you must specify the e-mailaddress to which the notifications are to be sent.If you are defining an account on the administration server Web interface, theadministrator will receive notifications generated by the administration serverby events relating to a customer that is assigned to him or her. If you aredefining an account on a runtime server, the administrator will receive allnotifications generated by events on the runtime server.


For Information about the different types of event notifications generated bythe administration and runtime servers, see the IBM Tivoli License ManagerSystem Administrator’s Guide.

4. Click Finish.The account details are recorded in the administration server database. Theuser can now log on the Web interface using the logon name and passwordthat you have specified.

Note: The administrator currently has no customers assigned and no profile toassign an access level. To select a profile and assign customers to theadministrator, you must update the administration account details. See“Updating or deleting administration account details”.

Updating or deleting administration account detailsYou can select an existing administration account and perform any of the followingtasks:v Change the account details, for example, the user’s logon name or e-mail

address.v Define the user’s level of access to Web interface functions (administration

server only).v Select the customers that are assigned to the user (administration server only).v Change the user’s password.v Delete the administration account.

To change or delete information for an administration account, complete thefollowing steps:1. In the portfolio, click Administration. If you are working on the administration

server, the Administration item expands to show a list of sub-items; clickAccounts.


2. Select an account from the list and click Change.

3. If you want to delete the account, check the details, and if this is the correctaccount, click Delete.

4. You can change the account details and notification status you defined.If this is a new account you must do the following:a. Select a profile. The profile defines the user’s level of access to the

administration server functions, as follows:

AdministratorThe user can perform all tasks on the administration server Webinterface.

Licensing managerThe user can perform the licensing tasks that are accessed using theSoftware Entitlement menu option.

OtherThe user can request any report.


5. If you want to change the administrator’s password, click Password

6. Enter the password and then confirm it by re-entering it.7. Click Finish.8. When you have made the necessary changes to the account, click Finish.



Chapter 4. Managing Components

This chapter provides instructions for the tasks related to creating and managingthe components of a Tivoli License Manager installation for a selected customer.The topology has two types of component:v Components that form the structure of the Tivoli License Manager

implementation for a customer. See “Defining the monitoring structure for acustomer”

v Components that record demographic information. See “Managing demographicinformation” on page 34.

You perform these tasks using a browser to access the Web interfaces. SeeChapter 2, “Getting Started on the Web Interfaces” on page 7 for information aboutthe tasks available on each server and for instructions on logging on to theadministration and runtime servers.

All of the components must belong to a customer, whose details have beenrecorded in the administration server database. You are prompted to select thecustomer you want to work with when you log on to the administration server. Tochange the customer during a session, click the Home icon on the tool bar andselect a different customer from the list that appears. For instructions for creating acustomer, see “Adding customers to the administration server database” onpage 15.

Defining the monitoring structure for a customerIn a Tivoli License Manager implementation, you must define a monitoringstructure for each customer. The structure comprises the following:v The runtime servers that have been installed. These must be registered with the

administration server before they can be used.v Agents that you must deploy to nodes that are to be monitored. You must

decide on the distribution of agents among the runtime servers in order to makethe most efficient use of resources.

v Divisions that divide agents into logical groupings. Grouping of agents intoseparate divisions is not obligatory. You can create a single division and assignall agents to it. However, having agents grouped makes it possible to definedifferent frequencies of inventory scans for different groups, select groups ofagents for reporting, and limit access to license pools to a specific group orgroups of agents.

The tasks related to the monitoring structure that you can perform on the Webinterfaces are:v Registering a new runtime server with the administration server. See

“Registering a runtime server” on page 24.v Reviewing and updating the runtime servers included in the Tivoli License

Manager implementation. See “Reviewing and changing runtime servers” onpage 25.

v Adding new divisions to the topology. See “Adding divisions” on page 27.v Reviewing and updating divisions. See “Reviewing and changing divisions” on

page 28.


Divisions are used to group agents. Each customer implementation must includeat least one division and in large implementations there can be many.

v Deploying an agent to a node. See “Deploying an agent on a node” on page 30.v Reviewing the details of deployed agents and deleting agents that are no longer

required. See “Reviewing and deleting agents” on page 32.

Registering a runtime serverWhen you install the runtime server component on a machine, you must registerthe new runtime server on the administration server before it can be used byagents.

To register a runtime server with the administration server complete the followingsteps:1. In the portfolio, click Topology. When the Topology item expands to show a

list of sub-items, click Servers.

2. Click Create.

3. Complete the form with the requested details.

Notes:

a. The server name must be exactly the same as the name you specified whenyou installed the runtime server component on the machine.


b. The password is used to authenticate communications between the runtimeserver and the administration server. If the initial password that isregistered on the administration server is not exactly the same as thepassword specified when the runtime server was installed, communicationsfail.

c. The server name and address must include only US ASCII characters.4. Click Finish.

When you submit the server information, the runtime server is plugged in tothe administration server and is then ready for use.The server fails to plug in if the one or more of the following occurs:v The server name entered does not match the name of any installed server.v The server name entered identifies a server that does not belong to the

customer you are working with.v The password you entered does not match the runtime password that was

specified when the server was installed.

If any of these problems occur, an entry is made in the event.log file, which islocated on the administration server machine, in the folder: You can open thislog file using any text editor.

<TLM_INSTALL_DIR>\admin\log

Reviewing and changing runtime serversUsing this function, you select a runtime server and can then do the following:v View the current information for the server, including a list of the agents that are

assigned to it.v Change the name, IP address, and port number of the server.v Change the server password.

To review and update a runtime server, complete the following steps:1. In the portfolio, click Topology. When the Topology item expands to show a

list of sub-items, click Servers.

2. Select a server from the list and click Next.

Chapter 4. Managing Components 25

The details of the selected server are displayed.

3. You can change the Name, Address, and Port number fields. However, makeany changes with care and be aware of the following:v The name must be exactly the same as the server name specified when the

runtime server was installed on the machine. Therefore, the only change youshould make is to correct an error made when the server was originallyregistered.

v The address may be a host name or an IP address depending on the networkenvironment. You should only change the IP address if it was originallyentered wrongly, or if the machine on which the server is installed haschanged its IP address.

v If you change the port number to anything other than the default (80), youmust include the port number in the Web page address when accessing theruntime server. For example, http/alpha:8080/slmruntime/login.

v The address and port fields are used by agents to contact the runtime server.If you change either of these values when agents are already deployed, youwill have to redeploy all agents to enable them to contact the runtime serverusing the new values.

4. To save your changes, click Finish.

From this page, you can select the following additional options:v Change the password that is used to authenticate communications from this

server. To do this:


1. Click Password.

2. Enter the password and then confirm it by re-entering it.3. Click Finish.

v View a list of the agents that use this server. To do this:1. Click Details.

2. If the list of agents extends to more than one page, click the back andforward arrows or enter a page number and click Go.

Adding divisionsDivisions are organizational units within a customer implementation of TivoliLicense Manager. They are used to group agents. You must create at least onedivision for a customer before you can deploy any agents for that customer. Largecustomers can include several divisions.

To create a division, complete the following steps:


1. In the portfolio, click Topology. When the Topology item expands to show alist of sub-items, click Divisions.

2. Click Create.

3. Assign a name to the division and enter a description.4. Click Finish.

Reviewing and changing divisionsYou can review and change an existing division, as follows:v View the current information for the division, including a list of the agents that

are assigned to it.v Change the name and description of the division.v Delete a division you no longer want to use.

If you delete a division that has agents assigned to it, the agents will also beremoved.

To review and update a division, complete the following steps:


1. In the portfolio, click Topology. When the Topology item expands to show a listof sub-items, click Divisions.

2. Select a division from the list and click Next.The details of the selected division are displayed.

3. You can do the following:v Make changes to the name and description and then click Finish to save the

changes.v Delete the division by clicking the Delete button.

If any agents are currently assigned to the division they will be removedwhen thedivision is deleted.


v View a list of the agents that are assigned to the division. To do this, clickDetails.

If the list of agents extends to more than one page, click the back andforward arrows or enter a page number and click Go.

Deploying an agent on a nodeEach runtime server hosts a Web page from which you can download TivoliLicense Manager agent and install it on a node. This page is not passwordprotected, so you do not need to have the user name and password of a TivoliLicense Manager administrator to use it, though you must be logged on as a userwith administrator rights to the node. Typically, the Tivoli License Manageradministrator would contact users and tell them to deploy the agent on theirmachines.

Note: If you are installing the agent on a Windows node, ensure that the WindowsService Manager Tool is stopped.

To deploy an agent on a node, complete the following steps:1. Log on to the node as a user with administrator rights.2. Access a runtime server.

The address of the page is http//<server name>/slmruntime/register

3. Complete the requested information, as follows:


DivisionSelect the division to which the agent is to belong from the drop-down list.

ServerSelect the runtime server that the agent will use from the drop-down list.This does not need to be the runtime server from which you are deployingthe agent.

Note: The drop-down list includes all runtime servers that have beenregistered with the administration server for the selected customer. Ifthe server you want is not in the list, this may be because you haveinstalled the component but have not registered the new server.

Computer LabelEnter the number on the identifying label of the machine on which theagent is to be deployed.

4. Click Finish.Standard security warnings for downloading from a Web site appear.

5. Accept the security warnings.

Note: The number and format of warning panels differs for different browsers.For Netscape Navigator, there are multiple panels, and you must clickGrant to accept each warning. For Internet Explorer, there is a singlepanel, and you must click Yes to accept it.

The agent is deployed on the node and started. For information about the filescreated when the agent is deployed, see the IBM Tivoli License Manager SystemAdministrator’s Guide.

Note: There is a delay between the agent starting to monitor the node andinformation from the agent being available on the servers. You must takeinto account the time delays required for scanning the node and fortransferring data to the runtime server and then to the administrationserver. You can set time delay parameters on the administration serverinterface. These parameters are held in the system.properties file for theadministration server.

Redeploying or upgrading an agentThere are some circumstances in which you need to redeploy the agent on a node:v You change the server name or port of the runtime server after the agent has

been deployed or you decide to monitor the node using a different server or toassign the agent to a different division.In this case, you should simply follow the deploy procedure again. You do notneed to uninstall the agent.

v A newer version of the agent is available on the runtime server with which theagent is registered.In this case, you can use the agent self-update facility. To do this, change theupdateAgentEnabled property to Yes in the runtime server’s system.propertiesfile. The agent starts regular checks for an new agent version, and if it finds oneit initiates a redeploy, using the current division and server settings.

v A change has been applied to the current version of the agent for a platform, tosolve an existing problem.In this case, you cannot use the agent self-update function because it relies onthe change being in a new version of the agent. To automatically apply thechange to all agents deployed on the affected platform, do the following:


1. Go to the <TLM_INSTALL_DIR>\runtime\conf folder and open theagent_install.properties file for editing.

2. Scroll through the file until you find the section that starts: #List of platformswhere the agent will be deployed.

3. Find the entry in the list for the affected platform and change the parameternoForce to force.

4. Save the file.

Reviewing and deleting agentsYou can use this function to review details of the agents that are deployed and todelete agents when they are no longer needed.

Note: You do not need to delete the agent before redeploying. The delete agentfunction is intended for the situation where a node is no longer beingmonitored.

You can request details of all agents or you can limit the information displayed, asfollows:v Include all agents that are assigned to a specified division.v Include only a specific agent.

The resulting report provides you with the following information for each agentthat is included:v The name, machine label, serial number, and hardware platform of the node

where the agent is installed.v The name and version of the operating system running on the machine.v The IP address of the machine.v The number of hard disk drives, configured processors, and online processors on

the machine.v The division to which the agent is assigned.v The runtime server that the agent uses.v The date and time of the last inventory scan by this agent.

To review or delete agents, complete the following steps:1. In the portfolio, click Topology. When the Topology item expands to show a

list of sub-items, click Agents.


2. Accept the default to include agents from all divisions or select a division fromthe list.

3. Click Next.

The list of agents includes all agents or, if you selected a division, all agents forthe selected division.

4. Accept the default to include all the agents included in the list or select a singleagent from the list.

5. Click Next.A page appears showing details of a single agent.

6. To display details of another agent that is included in the report, click the backand forward arrows or enter a page number and click Go.

7. To delete the agent for which details are displayed, click Delete.


You are asked to confirm your decision to delete. If you do so, the entry for theagent is removed from the administration server database.

Note: Deleting the agent only removes the database entry. The agent files arenot removed from the node. If you want to remove these files, run theuninstall agent script for the appropriate platform. For information aboutthe agent files and uninstall scripts for the different platforms, see theIBM Tivoli License Manager System Administrator’s Guide.

Managing demographic informationYou can store information in the administration server database about the customernodes that are to be monitored and about the users who can start applications onthe nodes. Using this information, Tivoli License Manager can restrict access tolicense pools to specified users or nodes.

The tasks related to demographic information that you can perform on the Webinterface are:v Adding new nodes to the administration server database. See “Adding nodes”.v Reviewing and updating nodes. See “Reviewing and changing nodes” on

page 35.v Recording details of the users of monitored applications. See “Adding

application users” on page 37.v Changing or deleting the details of an application user. See “Changing or

deleting user details” on page 38.

Adding nodesYou can use this function to record details of nodes within the customer’s network.

Note: When an agent is deployed on a node for which there is no entry in theadministration server database, Tivoli License Manager automatically createsa new node record.

To add a node to the administration server database, complete the following steps:1. In the portfolio, click Topology. When the Topology item expands to show a

list of sub-items, click Nodes.


2. Click Create.

3. Enter the details of a node that is in the network of the currently selectedcustomer.

Note: The Tag, which is also referred to as the computer label, is the uniqueidentifier of the node. It is this value that the agent deployment processattempts to match when it looks for a node entry in the administrationserver database for the target node of the deployment. If it does not finda match, it creates a new entry.

4. Click Finish.The node details are recorded in the administration server database. The nodecan now be specified when you set target distribution details for a license poolto limit access to a license pool to specified nodes.

Reviewing and changing nodesYou can use this function to do the following:v Change the details of nodes that are recorded on the administration server

database.v View information about nodes and the agents that are deployed on them.v Delete records for nodes that do not have an agent deployed.

To review and update an existing node, complete the following steps:


1. In the portfolio, click Topology. When the Topology item expands to show alist of sub-items, click Nodes.

2. Select one of the radio buttons to determine which nodes will be available forselection on the next form.

3. Click Next.


4. Select a node from the list and click Next.

5. You can do the following:v Make any necessary changes and click Finish.v Delete the node.

You can do this only if there are no agents deployed on the node. If this isthe case, the Delete button is displayed.

Adding application usersYou can use this function to record details of users who are entitled to runapplications on monitored nodes. The purpose of registering users in theadministration server database is allow license pools to be restricted to specifiedusers.

To add a user to the administration server database, complete the following steps:1. In the portfolio, click Topology. When the Topology item expands to show a

list of sub-items, click Users.


2. Click Create.

3. Enter the details of a user who has access to one or more of the monitorednodes in the network of the currently selected customer.

4. Click Finish.The user details are recorded in the administration server database. The usercan now be specified when you define user distribution settings for a licensepool if you want to limit access to the license pool to selected users.

Changing or deleting user detailsTo change or delete information for an application user whose details are recordedon the administration server database, complete the following steps:1. In the portfolio, click Topology. When the Topology item expands to show a

list of sub-items, click Users.


2. Under the User Selection banner you can enter information to limit thenumber of users available for selection on the next form.To do this, from the drop-down list, select Last Name, Logon Name, orEmployee No, then in the text box make an entry that is to be used inmatching. For example, select Last Name and enter Smith to select all userswith the last name Smith.Leave the User Selection fields unchanged to select all users.

3. Click Next.

4. Select a user from the list and click Next.

5. If you want to delete the user, check the details, and if this is the correct user,click Delete.If you want to change the user details, make the required changes and thenclick Finish.



Chapter 5. Managing Software Entitlement and License PoolDetails

This chapter provides instructions for the tasks involved in creating andmaintaining license entitlement information and license pools for products. Thesetasks are:v Maintaining the license entitlement settings for a product. See “Maintaining

entitlement settings for a product” on page 43.v Creating new license pools for a product. See “Creating a license pool” on

page 45.v Updating existing license pools. See “Updating a license pool” on page 50.v Limiting access to a license pool to specific divisions, agents, nodes, and users.

See “Setting license distribution parameters” on page 48 and “Modifying licensedistribution settings” on page 52.

You perform these tasks using a browser to access the administration serverinterface. See Chapter 2, “Getting Started on the Web Interfaces” on page 7 forinstructions on logging on.

License entitlement and license pool information relates to a specific customer,whose details must recorded in the administration server database. You areprompted to select the customer you want to work with when you log on to theadministration server. To change the customer during a session, click the Homeicon on the tool bar and select a different customer from the list that appears.

Changes in license information that you make on the administration server areautomatically downloaded to the customer’s runtime servers at regular intervals.

Selecting a product for entitlement or license pool maintenanceThe first two forms of the Software Entitlement wizard allow you to select theproduct for which you want to update license information.

To select a product, complete the following steps:1. In the navigation list on the left side of the administration server Web page,

click Software Entitlement.


The first form of the Software Entitlement wizard appears.

2. Complete this form as follows:

SW VendorSelect All to allow selection of products from all vendors or select one ormore vendors and limit selection of products to products supplied by thosevendors.

PlatformSelect All to allow selection of products installed on all platforms or selectone or more platforms and limit selection to products installed on thoseplatform.

Product NameTo limit the selection criteria by product name matching, enter part of aproduct name, preceded, followed, or surrounded by wildcard characters(%). All products that have names that match the characters you enter areavailable for selection on the next form. Leave the field blank if you do notwant to use product name matching.

IncludeIndicate whether your selection should include products that already havesettings or products that do not have settings by selecting the appropriateradio button.


3. Click Next to move to the next form.


ProductSelect the product for which you want to create or update softwareentitlement settings.

The list includes only those products that match the criteria you entered onthe previous form.

IncludeIndicate which licenses are to be selected for update by selecting theappropriate radio button.

5. Click Next to show the license information about the product you selected.

You can now update the license information for the selected product. Forinstructions see:v “Maintaining entitlement settings for a product”.v “Creating a license pool” on page 45.v “Updating a license pool” on page 50.v “Modifying license distribution settings” on page 52.

Maintaining entitlement settings for a productThe entitlement settings for a product determine whether a product is subject tomonitoring and if so, how the license agreements are to be defined and enforced.

To change the entitlement settings for a product, complete the following steps:1. Select the product for which you want to maintain license entitlement details.

See “Selecting a product for entitlement or license pool maintenance” onpage 41

Chapter 5. Managing Software Entitlement and License Pool Details 43

page 41.

2. Complete the Product Settings section of this form by selecting radio buttonsas follows:

Software monitoringSelect Enabled if you want to track the presence and use of this productusing Tivoli License Manager. Otherwise, select Disabled.

Licenses controlSelect User-defined if you want to define license pools for this product.Select Default to use default license pool settings.

If you select Default, you do not need to create any license pools as a set ofdefault license rules is applied. Any license pools that exist are ignored.

Run offlineSelect Yes if the product can be used when there is no connection betweenthe agent and the runtime server. Otherwise select No.

If you select Yes, the product can be used in off-line mode and no licensechecks will be made. License rules can be applied only when the agent isconnected to the runtime server.

Server ResponseSelect Required if the agent must wait for a server response beforeallowing the application to start. Select Not required if the application canstart before a response from the runtime server has been received.

3. Click Finish to record these settings.A confirmation page appears and you can click Back to return to the previousform, where you can continue working with software entitlement settings bycreating or updating license pools for the selected product.For instructions on maintaining license pools, see:v “Creating a license pool” on page 45.v “Updating a license pool” on page 50.


Creating a license poolEach product that specifies user-defined license settings must have at least onelicense pool and might have more than one.

When you create a license pool, you define a set of rules that is to be appliedwhen administering the licenses assigned to the pool.

To create a license pool, complete the following steps:1. Select the product for which you want to create a license pool. See “Selecting a

product for entitlement or license pool maintenance” on page 41.2. You can define the product level license entitlement settings. See “Maintaining

entitlement settings for a product” on page 43.

Notes:

a. If you do not define product settings before creating license pools, defaultsettings are used. .

b. For the Licenses control setting, you must select User Defined. If you selectDefault, any license pools you define are ignored.

3. When you return to the form where you defined product settings, scroll downuntil you reach the License Pools heading.


4. Click Create.

5. Complete the form as follows:

Capacity TypeSelect a capacity type from the drop-down list. The capacity type controlshow the number of licenses required when a product starts is determined.The following options are available:

UsersA license is assigned for each user who starts the application.

MemoryThe volume of licenses assigned is equal to the size of the memory ofthe requesting node.

Processors On-lineThe number of licenses assigned is equal to the number of onlineprocessors on the requesting node.

Processors configuredThe number of licenses assigned is equal to the number of configuredprocessors on the requesting node.

DisksThe number of licenses assigned is equal to the number of hard diskson the requesting node.

Hard StopSelect Yes or No. If you select Yes, the number of licenses available is anabsolute maximum. Once all licenses are in use, the next license request isrefused and the application cannot start.

If you select No, the number of licenses available is not an absolutemaximum. Once all licenses are in use, the next license request causes awarning event to be generated, but the application is allowed to start.


Multi-InstanceThis setting controls the situation where a single license can be used formultiple instances of the product. Select the default, Disabled, ifmulti-instance licenses are not allowed. Otherwise, select one of thefollowing options from the drop-down list:

Same UserIf the application is started by a user who has already been assigned alicense for this product, no further license is required.

Same GroupIf a license is already assigned to the group of the user who starts theapplication, no further license is required.

Same NodeIf a further instance of the product is started on a node to which alicense has already been assigned, no further license is required.

QuantitySpecify the volume of licenses available in this license pool.

ThresholdSpecify the percentage of the total licenses in the pool at which to set athreshold for warnings. When the volume of licenses that are in use reachesthis percentage, a warning event is generated.

Target TypeSelect a target type from the drop-down list. The target type indicates theavailability of the license pool within the customer monitoring structure.

Select Enterprise to make the license pool available to all nodes in thecustomer structure, or select Division, Node, or Agent to limit availabilityto selected components. If you choose anything other than Enterprise, youmust specify which divisions, nodes, or agents can use this license pool.You do this when you set distribution parameters for the license pool. See,“Setting license distribution parameters” on page 48.

Start DateSpecify the date from which the license pool is available.

Expiration DateSpecify the date when the license pool will stop being available.

DescriptionEnter a short description of the license pools that will help you to recognizethe license pool when it appears in the software usage reports.

Creation ModeSelect Set distribution now if you want to go immediately to the formwhere distribution details are defined. See “Setting license distributionparameters” on page 48.

Select Set distribution later if you want to defer setting the distributiondetails. See “Modifying license distribution settings” on page 52.

Note: If you do not set distribution parameters when you create a licensepool, the default is to allow all users to access the license pool.Therefore, if you do not want to limit access to specific users, youmight not need to create distribution details.


However, if you chose a target type other than Enterprise, you mustuse set distribution parameters for targets either immediately orlater. By default, no nodes, agents, or divisions are selected.

6. Click Finish to create the license pool.

Setting license distribution parametersThe Create License Distribution Parameters wizard starts if you chose immediatecreation of distribution parameters when you created a license pool. The first formof the wizard is the confirmation that the license pool has been created.

The details requested by the wizard differ depending on the target type youselected for the license pool. If you selected any target type other than Enterprise,the wizard requests details of the targets on which you want the license pool to beavailable.

The wizard always asks you if you want to limit the distribution to specified users.The default is to allow all users to access the license pool.

To create license distribution details, complete the following steps:1. Define the license pool, following the instructions in “Creating a license pool”

on page 45 and selecting the Set distribution now creation mode.When you click Finish to create the license pool, the following form appears.

In this example, the target type selected on the license creation form wasDivision. If you had selected Enterprise for target type, you would not need toselect any targets and instead would be immediately prompted for userlimitations.

2. To use target name matching to limit target selection, enter part of a targetname, preceded, followed, or surrounded by wildcard characters (%). All targetnames that match the characters that you enter are available for selection on thenext form. Leave the field blank if you do not want to use target namematching.


3. Click Next.

4. Select the targets you want to include in the distribution of the license pool.5. Click Next.

6. Choose whether the license pool is to be restricted to selected users or availableto all users:v To allow all users, click Allow all.

The creation of distribution details is now complete.v To restrict the license pool to selected users click Next.

If you want to use name matching to restrict the entries in the list of usersfrom which you will choose on the next page, enter a part of the User logonname, preceded, followed, or surrounded by wildcard characters (%). Alluser names that match the characters you enter are available for selection.


7. Select the users who are to have access to the license pool.8. Click Finish.

A confirmation page appears summarizing the distribution parameters youspecified.

Updating a license poolYou can use the Change action to make changes to a license pool that you havealready defined.

To update a license pool, complete the following steps:1. Select the product for which you want to make changes to a license pool. See

“Selecting a product for entitlement or license pool maintenance” on page 41.2. Scroll down the form that starts with license entitlement product settings until

you reach the License Pools banner and the list of licenses that exist for theselected product.


3. Select the license pool you want to update and click Change.

4. Complete the form as follows:

Hard StopSelect Yes or No. If you select Yes, the number of licenses available is anabsolute maximum. Once all licenses are in use, the next license request isrefused and the application cannot start.

If you select No, the number of licenses available is not an absolutemaximum. Once all licenses are in use, the next license request causes awarning event to be generated, but the application is allowed to start.

Multi-InstanceThis setting controls the situation where a single license can be used formultiple instances of the product. Select the default, Disabled, ifmulti-instance licenses are not allowed. Otherwise, select one of thefollowing options from the drop-down list:

Same UserIf the application is started by a user who has already been assigned alicense for this product, no further license is required.

Same GroupIf a license is already assigned to the group of the user who starts theapplication, no further license is required.

Same NodeIf a further instance of the product is started on a node to which alicense has already been assigned, no further license is required.

QuantityYou can change the volume of licenses available in this license pool.


ThresholdYou can change the percentage of the total licenses in the pool at which toset a threshold for warnings. When the volume of licenses that are in usereaches this percentage, a warning event is generated.

Target TypeYou cannot change the target type on this form. To change the target type,you must select the option to modify target distribution details.

Start DateYou can change the date from which the license pool is available.

Expiration DateYou can change the date when the license pool will stop being available.

5. If you want to change the distribution details for the license pool, scroll downto the Distribution banner and select from the options to change or deletetarget and user distribution information. See “Modifying license distributionsettings”.

Note: When you have made changes to distribution details, you return to thisform. You must click Finish on this form to save the changes you madeto the distribution details.

6. Click Finish to save the changes you have made.

Modifying license distribution settingsAll license pools include distribution settings. These can be the default values toallow use of the pool by all users throughout the customer enterprise or they caninclude limitations to specific users and targets within the enterprise.

When you update a license pool, the current distribution details are displayed onthe Manage License Settings page, under the Distribution heading.

If the current settings include target or user limitations, the allowed targets andusers are listed. You can change the settings by deleting items from either list. Todelete an item from the target or user list, select it and click the related Deletebutton.

Note: If you delete all users from the list, the user distribution settings default toallow the pool to be accessed by all users. If you delete all current targetsyou must modify the target distribution settings to select new targets.

To add users or targets or to change the target type, use the Change options forusers and targets.


Modifying target distribution settingsTo change the distribution target settings, complete the following steps:1. In the Distribution section of the License Settings page, click the Change button

for the target settings.

2. To change to a different type of target, select a Target Type from thedrop-down list. For example, you can change from Division to Node.

3. Click Next.If you chose Enterprise as the target type, the target update is complete andyou return to the Manage License Settings page. Otherwise, you are promptedto select targets of the type you specified.

4. To use target name matching to limit target selection, enter part of a targetname, , preceded, followed, or surrounded by wildcard characters (%). Alltarget names that match the characters you enter are available for selection onthe next form. Leave the field blank if you do not want to use target namematching.


5. Click Next.

6. Select the targets you want to include in the distribution of the license pool.If you have not changed to a different target type, the list includes only thosetargets that are not selected in the current settings. You can add more targetshere, but can only delete targets using the Delete button on the LicenseSettings page.

7. Click Next.You now return to the License Settings page.

8. Click Finish.

Modifying user distribution settingsTo change the user distribution settings, complete the following steps:1. In the Distribution section of the License Settings page, click the Change button

for the Allowed Users settings.

2. Choose whether the license pool is to be restricted to selected users or availableto all users:v To allow all users, click Allow all.

The creation of distribution details is now complete.v To restrict the license pool to selected users click Next.

If you want to use name matching to restrict the entries in the list of usersfrom which you will choose on the next page, enter part of the User logonname, preceded, followed, or surrounded by wildcard characters (%). Alluser names that match the characters you enter are available for selection.


If you selected the option to allow all users, the update of user distributionsettings is now complete. Otherwise, the following form appears.

3. Select the users you want to include in the distribution of the license pool.The list includes only those users that are not selected in the current settings.You can add more users here, but can only delete users using the Delete iconon the License Settings page.

4. Click Next.You now return to the License Settings page.

5. Click Finish.



Chapter 6. Reporting Software Usage Information

This chapter provides instructions for producing software usage reports.

Tivoli License Manager provides real-time and historical information on softwareusage. You request the real-time information from the appropriate runtime serverand the historical information from the administration server. The followingreports are available:v A snapshot report of software usage at a specified time. See “Producing a

historical snapshot software usage report”.v A report in graphical format showing trends in usage of a product over a period

of time. See “Producing a software usage trend analysis report” on page 64.v A report that summarizes the highest or average usage of products during a

specified period. See “Producing a software usage level analysis report” onpage 69.

v A real-time software usage report which you can request on a runtime server.See “Producing a real-time software usage report” on page 73.

You perform these tasks using a browser to access the Web interfaces. SeeChapter 2, “Getting Started on the Web Interfaces” on page 7 for information aboutthe tasks available on each server and for instructions on logging on to theadministration and runtime servers.

You are prompted to select the customer you want to work with when you log onto the administration server. To change the customer during a session, click theHome icon on the tool bar and select a different customer from the list thatappears.

Producing a historical snapshot software usage reportThe software usage report, which is available from the Web interface onadministration server, provides information about the software usage on monitorednodes as at a date and time that you specify.

The report includes detailed information about the products and their level ofusage at the specified time, the agents on which they were installed, the licensepools that were available, and the sessions that were active.

Requesting the reportThe software usage snapshot report wizard consists of two forms where you candefine parameters for the report. You can limit the report as follows:v Only specified productsv Only products supplied by a selected vendorv Only products installed on a specified operating systemv Only products installed on nodes that are monitored by specified agents or

agents in specified divisions.

To produce a software usage snapshot report complete the following steps:1. In the portfolio, click Software Usage then when the Software Usage item

expands to show a list of sub-items, click Snapshot. The first form of the


software usage snapshot wizard appears. This form allows you to limit theproducts and agents that can be selected for inclusion in the report on thesecond form.




Product NameTo limit the products available for selection using product name matching,enter a part of a product name preceded, followed, or enclosed by wildcardcharacters (%). All products that have names that match the characters youenter are included in the selection list on the next form. Leave the fieldblank if you do not want to use product name matching.

DivisionSelect All to allow selection of agents from all divisions or select one ormore divisions to limit selection to agents assigned to those divisions.

Agent NameTo limit the agents available for selection using agent name matching, entera part of a agent name preceded, followed, or enclosed by wildcardcharacters (%). Agents with names that match the characters you enter areavailable for selection on the next form. Leave the field blank if you do notwant to use agent name matching.




Product nameAccept the default, All, to include all products that match the criteria youspecified in the first form or select a product to limit the report to instancesof a single product.

AgentAccept the default, All, to include products installed on all agents thatmatch the criteria you specified in the first form or select agent to limit thereport to products installed on that agent.

DateEnter the effective date of the report. Software usage information as at thedate and time entered will be included in the report.

TimeEnter the effective time of the report.

Time ZoneSelect a time zone from the drop-down list. Ensure that the time zone youselect does not put the specified date and time in the future.

HWM Time RangeFrom the drop-down list, select the time period over which the high watermark is to be reported. The time range is considered as a period up to thedate and time specified. For example, if you specify a time range of 1 day,the high water mark values for products in the report will be the maximumconcurrent usage in the 24 hours before the date and time you specified.

5. Click Next to produce the report

Chapter 6. Reporting Software Usage Information 59

Navigating the reportThe report has the following sections:v A list of products installed on the selected nodes, showing the level of usage of

each product.The list of products includes all products that fit the selection criteria, whichwere in use at the specified time or which have procured licenses. Products thatuse the default license settings are only included if they were in use at thespecified time.

v Product details for each product.v Details of the monitored nodes on which each product is installed.v Details of license pools available for each product.v A list of current sessions for each product that is in use.

Figure 3 shows the product list section of the software usage report.

This is the first section that appears when the report is produced. It shows a list ofthe products that fit the selection criteria you entered.

You can choose to export the report in an XML format. To do this, select Page orDocument from the Export drop-down list and click OK.

If the list extends to more than one page, click the back and forward arrows orenter a page number and click Go

The list of product shows software usage information for products that areinstalled on the selected agents.

Figure 3. Product list in the historical software usage report


Note: Products that have procured licenses are included in the report even if theywere not in use at the specified time. Product that use the default licensesettings are only included if they were in use.

At the top of the list, you can change the Capacity Type for which information isdisplayed, by selecting from a drop-down list. If entries in the list do not have fulldetails, this is because they have a different capacity type to the one currentlyselected. In addition to the product name and version, each entry includes thefollowing information about the status of products at the specified reporting time:

Total InstalledThe number of instances of the product, which were installed on agents at thespecified date and time, that are included in the report.

ProcuredThe volume of licenses that were procured at the specified time. How this isexpressed depends on the capacity type. For example, if the capacity type isUsers, this will be the number of licenses available. If the product uses defaultlicense settings, this is set to N.A.

In UseThe volume of licenses in use on the agents included in the report at the dateand time specified.

Total in UseThe volume of licenses in use on all agents at the date and time specified.

Total HWMThe maximum volume of licenses that were concurrently in use on all agentsduring the specified HWM period.

Each row of the product list includes links that allow you to jump to anothersection of the report, as follows:v Click a Product to jump to details of that product. See Figure 4 on page 62.v Click a Total Installed value to jump to information about the monitored nodes

where the product is installed.v Click a Procured value to jump to details of the license pool for the product. See

Figure 12 on page 78.v Click an In Use value to jump to details of the sessions that were open for the

product. See Figure 13 on page 79.

Figure 4 on page 62 shows the details of a selected product. The details comprisethe name of the operating system under which the product runs, the name of thesoftware vendor, whether or not the product must wait for a response from theruntime server before opening, and whether or not the product can run if there isno connection to the server.


Click the arrow icon to return to the top of the report.

Figure 5 shows the list of monitored nodes on which a selected product is installed.

For nodes where the product was installed at the specified reporting time, thereport shows the following:v Machine information comprising the host name, IP address, node name,

operating system name, and operating system version.v Tivoli License Manager information comprising the division and the runtime

server to which the agent is assigned.

You can navigate to other parts of the report as follows:v Click the arrow icon to return to the top of the report.v Click List of products to jump to the current page of the list of products. See

Figure 3 on page 60.v Click Product Name to jump to the product details section of the report. See

Figure 4

.

Figure 6 on page 63 shows the list of license pools for a selected product.

Figure 4. Product details in the historical software usage report

Figure 5. List of agents in the historical software usage report


For each license pool that the selected product can use, the following informationis displayed:

LicenseIdentifies the license whose terms are summarized here.

Products that are not subject to a license can be monitored by assigning them adefault set of conditions.

QuantityThe size of the license pool. For license agreements based on the User capacitytype, this is the number of licenses available.

ThresholdThe level of license usage, expressed as a percentage of total quantity, at whichan administrator is to be alerted about possible shortage of licenses.

Hard StopPossible values are Yes and No. Yes indicates that when all the licenses in thepool have been allocated, the next request to open a session is refused. Noindicates that the number of available licenses can be exceeded, though awarning will be issued.

Multi-instancePossible values are Disabled, Same User, Same Group, or Same Node. Ifmulti-instance is enabled, a single license can be used for multiple sessions ofthe product for the same user, for the same user group, or for the same node.Otherwise, each session must be allocated a license.

HWMThe maximum volume of licenses from this license pool concurrently in use onall agents that was reached during the specified HWM period.

In UseThe volume of licenses from this license pool in use on all agents at the dateand time specified.

Capacity TypeThis indicates how to calculate the volume of licenses required when a productis started. The most usual capacity type, Users, allocates one license each timea product starts.

Start DateThe date from which the license pool can be used.

Expiration DateIf set, the license pool cannot be used after this date.

You can navigate to other parts of the report as follows:

Figure 6. License pools in the historical software usage report


v Click the arrow icon to return to the top of the report.v Click List of products to jump to the current page of the list of products. See


Figure 4 on page 62.

Figure 7 shows the details of the sessions open for a selected product.

For each session that was open at the specified reporting time, the followinginformation is displayed:

Host nameIdentifies the node on which the session is open.

User NameThe ID of the user who opened the session.

Group NameThe name of the user group to which the user is assigned.

In UseThe number of licenses in use.

Grant DateThe date and time at which the license was allocated.

You can navigate to other parts of the report as follows:v Click the arrow icon to return to the top of the report.v Click List of products to jump to the current page of the list of products. See


Figure 4 on page 62.v Click Licenses to jump to the license pool section of the report. See Figure 6 on

page 63.

Producing a software usage trend analysis reportThe Trend Analysis report provides a graphical representation of trends in theusage of a selected product during a specified period.

You can only select one product for reporting. You can report its usage on allagents, on agents within selected divisions, or on selected agents.

Figure 7. Sessions in the historical software usage report


The report can include several charts. If the selected product has license pools withdifferent capacity types, usage under the different capacity types must bepresented on separate charts. Optionally, you can break down the report further, sothat usage for each available license pool is reported on a separate chart.

Requesting the reportThe trend analysis report wizard consists of two forms where you can defineparameters for the report.

To produce a trend analysis report, complete the following steps:1. In the portfolio on the left side of the administration server Web page, click

Software Usage then when the Software Usage item expands to show a list ofsub-items, click Trend Analysis. The first form of the trend analysis wizardappears. This form allows you to limit the products and agents that appear inthe selection lists on the next form.


SW VendorSelect All to include products from all vendors in the list on the next formor select one or more vendors and limit selection of products to productssupplied by those vendors.




ShowSelect one of the radio buttons to determine whether the report includesonly products with entitlement settings, all products, or only productswithout entitlement settings.





ProductSelect a product from the list.


Query bySelect one of the radio buttons.

This selection determines the level at which software usage information isto be broken down into separate charts, as follows:

CapacityA chart is produced for each different capacity type that is used for the


product. The usage figures for all license pools of the same capacitytype are reported together. For example, if the product has some licensepools with capacity type Users and some with capacity type Memory,the report includes two charts, each of which might include usage fromseveral license pools.

LicenseA chart is produced for each license pool defined for the product.

Note: Usage levels from license pools that have been deleted are notincluded.

Start Date SelectionEnter the date and time at which the reporting period is to start.

Stop Date SelectionEnter the date and time for the end of the reporting period. Informationabout trends of software usage up to and including the date and timeentered will be included in the report.

Time ZoneSelect a time zone from the drop-down list. Ensure that the time zone youselect does not any part of the reporting period in the future.

5. Click Next to produce the report.

Using the reportFigure 8 on page 68 shows a chart from the Trend Analysis report in line format.The chart plots licenses used against time, over the period you specified. In theline format, the periods of time during which licenses were in use are joined,showing the rise and fall in usage.

Note: Usage levels from license pools that have been deleted are not included.


You can perform the following actions to navigate the report, change the content,or change the presentation of the report:v If the report includes more than one chart, click the back and forward arrows or

enter a page number and click Go.v Export the current chart in an XML format. Click OK next to the Export list.v Change the format of the chart, by selecting from the Chart Type list.

Available formats are Step, Line, and Event. The Step format is shown inFigure 8. The Line format shows the different levels connected by a line showingthe trend of the change in usage. The Event format shows single events,unconnected by a trend line.

v Change the period covered by the report by changing the Start Date Selectionand Stop Date Selection fields and clicking Submit.

v Change the breakdown of the information by changing the from Capacity toLicense or from License to Capacity and clicking Submit.In Figure 8, Capacity is selected and the information shown includes usage of alllicense pools that have the capacity type Users. If you change to License, thereport shows a separate chart for each license pool.

v Show a verbal description of the chart by click the D link below the chart.

Figure 8. Trend Analysis report in step format


Producing a software usage level analysis reportThe Level Analysis report provides an overview of the level of usage of softwareproducts during a specified period. The reporting options allow you to considerusage as either the high water mark or as the average usage of products.

The level analysis report wizard consists of three forms where you can defineparameters for the report. You can limit the report as follows:v Only specified productsv Only products with entitlement settingsv Only products without entitlement settingsv Only products supplied by a selected vendorv Only products installed on a specified operating systemv Only products installed on nodes that are monitored by specified agentsv Only products that have more than or less than a specified level of usage

You can sort the report in product order or in descending order of usage level.

To produce a level analysis report, complete the following steps:1. In the portfolio on the left side of the administration server Web page, click

Software Usage then when the Software Usage item expands to show a list ofsub-items, click Level Analysis. The first form of the level analysis wizardappears. This form allows you to limit the products and agents that can beselected for inclusion in the report on the second form.






ShowSelect one of the radio buttons to determine whether the report includesonly products with entitlement settings, all products, or only productswithout entitlement settings.






ProductAccept the default, All, to include all products that match the criteria youspecified in the first form or select a product to limit the report to instancesof a single product.


End DateEnter the date for the end of the reporting period. Information about levelsof software usage up to and including the date and time entered will beincluded in the report.

TimeEnter the time for the end of the reporting period.


Time RangeFrom the drop-down list, select the time period over which the softwareusage levels are to be reported. The time range is considered as a period upto the date and time specified.



6. Define a usage threshold for inclusion in the report, as follows:a. From the first drop-down list, select the type of usage level: high water

mark or average usage.b. Set the threshold for reporting by selecting greater than or lower than from

the second drop-down list and entering a value in the text box. Forexample, you can set a threshold to include all products with a usage levelgreater than 10.

Note: The usage levels reported are only those for the selected agents.Products are only selected for the report if they had usage levels onthe selected agents that meet the threshold criteria.

c. Select the Capacity type of licenses to be included in the usage figures. Thecapacity type determines the units that are used to determine the thresholdusage level.

Note: Products with no license pools are considered as using the defaultcapacity type Users.

7. Under the Order banner, select one of the radio buttons to determine whetherthe report is produced in product order or in descending order of usage level.


Figure 9 on page 73 shows a level analysis report showing the high water marklevels for the selected products, sorted by product name.


You can choose to export the report in an XML format. To do this, select Page orDocument from the Export drop-down list and click OK. See “Exporting reports”on page 80 for more details.

If the report extends to more than one page, you can use the paging controls at thebottom of the current page to display further pages of the report as follows.v Click a number to display a specific page of the report.v Click Previous to move to the page before the page that is currently displayed.v Click Next to move to the page after the page that is currently displayed.

Producing a real-time software usage reportThe software usage report, which is available from the Web interface on runtimeservers, provides current information about the software usage on monitorednodes.

The report includes detailed information about the products and their current levelof usage, the license pools that are available, and the sessions that are active.

Requesting the reportThe software usage report wizard consists of two forms where you can defineparameters for the report. You can limit the report as follows:v Only specified productsv Only products supplied by a selected vendorv Only products installed on a specified operating systemv Only products installed on nodes that are monitored by specified agents

Figure 9. The Level Analysis report


To produce a real-time software usage report complete the following steps:1. In the portfolio on the left side of the runtime server Web page, click Software

Usage. The first form of the software usage wizard appears.










ProductAccept the default, All, to include all products that match the criteria youspecified in the first form or select on or more products to be included inthe report.

AgentAccept the default, All, to include products installed on all agents thatmatch the criteria you specified in the first form or select one or moreagents to limit the report to products installed on those agents.

Note: If the list of agents is empty, this means that the runtime server has noagents that are currently running any monitored software products.


Navigating the reportThe report has the following sections:v A list of products installed on the selected nodes, showing the level of usage of

each product.The list of products includes all products that fit the selection criteria, which arein use when the report is requested or which have procured licenses. Productsthat use the default license settings are only included if they are in use when thereport is requested.

v Product details for each product.v Details of license pools available for each product.v A list of current sessions for each product that is in use.

Figure 10 on page 76 shows the product list section of the software usage report.


This is the first section that appears when the report is produced. It shows a list ofthe products that fit the selection criteria you entered.

If the list extends to more than one page, click the back and forward arrows orenter a page number and click Go

The list of product shows software usage information for products that areinstalled on the selected agents. At the top of the list, you can change the CapacityType for which information is displayed, by selecting from a drop-down list. Ifentries in the list do not have full details, this is because they have a differentcapacity type to the one currently selected. In addition to the product name andversion, each entry includes the following information about the current status ofproducts:

ProcuredThe volume of licenses procured. How this is expressed depends on thecapacity type. For example, if the capacity type is Users, this will be thenumber of licenses available.

In UseThe volume of licenses in use on the agents included in the report.

Total in UseThe volume of licenses in use on all agents for this runtime server.

Figure 10. Product list in the real-time software usage report


HWMThe maximum volume of licenses that have been concurrently in use since thehigh water mark was last reset.

You can reset this value using the buttons below the list. To reset the value fora single product, select the check box in the Select column and click Resetselected HWM. To reset the values for all products in the list, click Reset AllHWM.

HWM Reset DateThe date and time at which the high water mark was last reset.

Each row of the product list includes links that allow you to jump to anothersection of the report, as follows:v Click a Product to jump to details of that product. See Figure 11.v Click a Procured value to jump to details of license pools for the product. See

Figure 12 on page 78.v Click an In Use value to jump to details of the sessions that are currently open

for the product. See Figure 13 on page 79.

Figure 11 shows the details of a selected product. The details comprise the name ofthe operating system under which the product runs, the name of the softwarevendor, whether or not the product must wait for a response from the runtimeserver before opening, and whether or not the product can run if there is noconnection to the server.

You can navigate to other parts of the report as follows:v Click the arrow icon to return to the top of the report.v Click List of Licenses to jump to details of the license pools in use for this

product. See Figure 12 on page 78.

Figure 12 on page 78 shows the details of the license pools for a selected product.

Figure 11. Product details in the real-time software usage report


For each license pool that the selected product can use, the following informationis displayed:

LicenseIdentifies the license whose terms are summarized here.

Products that are not subject to a license can be monitored by assigning them adefault set of conditions.

QuantityThe size of the license pool. For license agreements based on the User capacitytype, this is the number of licenses available.

ThresholdThe level of license usage at which an administrator is to be alerted aboutpossible shortage of licenses.

Hard StopPossible values are Yes and No. Yes indicates that when all the licenses in thepool have been allocated, the next request to open a session is refused. Noindicates that the number of available licenses can be exceeded, though awarning will be issued.

Multi-instancePossible values are Disabled, Same User, Same Group, or Same Node. Ifmulti-instance is enabled, a single license can be used for multiple sessions ofthe product for the same user, for the same user group, or for the same node.Otherwise, each session must be allocated a license.

HWMThe maximum volume of licenses that have been concurrently in use since thehigh water mark was last reset.

Total in UseThe volume of licenses, from this pool, in use on all agents for this runtimeserver.

Capacity TypeThis indicates how to calculate the volume of licenses required when a productis started. The most usual capacity type, Users, allocates one license each timea product starts.

Start DateThe date from which the license pool can be used.

Expiration DateIf set, the license pool cannot be used after this date.

You can navigate to other parts of the report as follows:

Figure 12. License pools in the real-time software usage report


v Click the arrow icon to return to the top of the report.v Click List of products to jump to the current page of the list of products. See


Figure 13.

Figure 13 shows the details of the sessions open for a selected product.

All open sessions are listed. If the session are using license pools with differentcapacity types, the In Use figure is only shown for sessions using the capacity typethat is currently selected. You can select another capacity type from the drop-downlist.

For each session, the following information is displayed:

Host nameIdentifies the node on which the session is open.

Node tagThe machine tag of the node on which the session is open.

User NameThe ID of the user who opened the session.

Group NameThe name of the user group to which the user is assigned.

In UseThe number of licenses in use.

Grant DateThe date and time at which the license was allocated.

You can navigate to other parts of the report as follows:v Click top to return to the top of the report.

Figure 13. Open sessions in the real-time software usage report


v Click List of products to jump to the current page of the list of products. SeeFigure 10 on page 76.

v Click Product Name to jump to the product details section of the report. SeeFigure 11 on page 77.

v Click Licenses to jump to the license pool section of the report. See Figure 12 onpage 78.

Exporting reportsThe option to export information to an XML format is available for the followingreports:v Software Usage Snapshotv Software Usage Trend Analysisv Software Usage Level Analysis

If you want to store a report, you can save it in XML format using the Exportbutton at the top of the report. There are two options for exporting:

DocumentSelect this option to export the entire report.

PageSelect this option to export the page that is currently displayed.

When you click Export, the XML Export page appears.

Right-click the link to the file to open the context menu and save the file.


Chapter 7. Managing and Reporting Inventory Information

One of the functions of the agent is to make regular inventories of the productsinstalled on the node it is monitoring. The information collected in the inventoryscan is passed to the runtime server, where the runtime server identifies thoseproducts which have entries in the master catalog. Only products with entries inthe master catalog are passed to the administration server and stored in theadministration server database.

This chapter provides instructions related to the inventory of monitored nodes asfollows:v Specifying the time interval between inventory scans of monitored nodes.

“Scheduling inventory scans”.v A software inventory report, which details the products that have been

discovered on monitored nodes by agent inventory scans. You can produce thereport in product or agent order. See “Producing a software inventory report” onpage 83.

You perform these tasks using a browser to access the administration serverinterface. See Chapter 2, “Getting Started on the Web Interfaces” on page 7 forinstructions on logging on.

You are prompted to select the customer you want to work with when you log onto the administration server. To change the customer during a session, click theChange Customer option in the navigation list and select a different customer fromthe list that appears.

Scheduling inventory scansYou use this function to schedule the frequency with which inventory data iscollected from monitored nodes within a specified division.

Consider the following when you decide on the timing of an inventory scan:v It is advisable to create the schedule for scanning well in advance of the time

specified for scanning. This will reduce the possibility that the schedule detailswill not reach all agents within the division.

v It is advisable to schedule the scans of different divisions at different times, asthis will spread the network instead of concentrating it around one scan time.

v Before the information is available for reporting it must be transferred to theruntime server and then to the administration server. Time delays operate foruploads between the components. These are defined in the system.propertiesfiles for each server. See the IBM Tivoli License Manager System Administrator’sGuide for details of the configuration file.

To schedule inventory updates, complete the following steps:


1. In the navigation list, click Software Inventory, then when the Configurationitem expands to show a list of sub-items, click Scheduling.

2. Select a division from the drop-down list and click Next.

3. Complete the requested information, as follows:

DateSpecify the date on which the first inventory scan is to be made using theseparameters.

TimeSpecify the time at which the first inventory scan is to be made using theseparameters.

Note: The time refers to the time in the time zone where the agent islocated.

Scan frequencyDefine the regularity of the inventory schedule.

If these parameters are to be used for a single inventory scan, select Once.If the parameters are to be used for a regular schedule of inventory scans,select Repeat Each, enter a number in the text box, and then select a timeperiod from the drop-down list. For example, to perform an inventory scanevery two weeks, enter 2 in the text box and select Weeks from the list.

4. Click Finish.


Producing a software inventory reportThe software inventory report provides you with information about products thatare installed on nodes monitored by Tivoli License Manager. The details includedin the report are compiled by making regular scans of the monitored nodes. Youcan define the frequency of inventory scans, see “Scheduling inventory scans” onpage 81.

Requesting the inventory reportThe software inventory report wizard consists of two forms where you can defineparameters for the report. You can limit the report as follows:v Only specified productsv Only products supplied by selected vendorsv Only products installed on specified operating systemsv Only products installed on nodes that are monitored by specified agents

You can produce the report in either product or agent order and must specify thedate and time for which inventory information is to be reported.

To produce a software inventory report complete the following steps:1. In the navigation list on the left side of the page, click Software Inventory then

when the Software Inventory item expands to show a list of sub-items, clickReport. The first form of the software inventory wizard appears.



Chapter 7. Managing and Reporting Inventory Information 83







ProductAccept the default, All, to include all products that match the criteria youspecified in the first form or select one or more products.

AgentAccept the default, All, to include products installed on all agents that


match the criteria you specified in the first form or select agent to limit thereport to products installed on that agent.

Order byClick the Product radio button to produce the report in product order. Clickthe Agent radio button to produce the report in agent order.

DateEnter the effective date of the report. Inventory information as at the dateand time entered will be included in the report.

TimeEnter the effective time of the report.



The software inventory reportFigure 14 on page 86 shows a software inventory report, produced in productorder. The details of each agent is followed by a list of the products that have beenidentified on the node which is monitored by the agent.


You can choose to export the report in an XML format. To do this, select Page orDocument from the Export drop-down list and click Export. See “Exportingreports” on page 87 for more details.

If the report extends to more than one page, you can use the paging controls at thebottom of the current page to display further pages of the report as follows.v Click a number to display a specific page of the report.v Click Previous to move to the page before the page that is currently displayed.v Click Next to move to the page after the page that is currently displayed.

Note: If the report does not include products that you know are installed onmonitored nodes, take account of the following:v There is a time delay between the inventory scan and the availability of

the new inventory information on the administration server. For details ofparameters that affect the time delay, see the description of theconfiguration file in the IBM Tivoli License Manager System Administrator’sGuide.

v The inventory report only includes products that have entries in themaster catalog.

Figure 14. Software inventory report


Exporting reportsIf you want to store a report, you can save it in XML format using the Exportbutton at the top of the report. There are two options for exporting:

DocumentSelect this option to export the entire report.

PageSelect this option to export the page that is currently displayed.

When you click Export, the XML Export page appears.

Right-click the link to the file to open the context menu and save the file.



Chapter 8. Managing Product Information

This chapter provides you with information about the use and management ofsoftware product information in Tivoli License Manager, as follows:v How the catalog of product information is used to enable monitoring of software

products. See “Catalogs and unknown file information”v How to add new products and change information in the master catalog. See

“Using the catalog manager to update the master catalog” on page 90

Catalogs and unknown file informationThe Tivoli License Manager master catalog contains details of all products that canbe monitored by Tivoli License Manager.

Master catalogThe master catalog is a central repository of product information. It is createdand maintained on the administration server, a copy is downloaded to eachruntime server, and is periodically refreshed to include new information.

The master catalog contains information about all the software componentsand related files for the products that are to be monitored. An initial mastercatalog is provided when Tivoli License Manager is installed.

The Tivoli License Manager catalog manager component allows you to addnew information to the master catalog. There are two sources of newinformation: the unknown file table, which contains entries for all applicationsthat were detected by agents, but that were not already in the master catalog,and new releases of the IBM Tivoli Inventory catalog, which you can mergewith the master catalog so that it contains all the entries from the IBM Tivoliinventory catalog.

Runtime catalogA runtime catalog is created automatically on each runtime server. It is asubset of the master catalog which contains information about only thoseproducts that are installed on the nodes that are managed by the runtimeserver.

A copy of the runtime catalog is downloaded to each node where the agent isinstalled. These copies are periodically refreshed to include new informationadded to the runtime catalog on the runtime server.

New entries are added to the runtime catalog when the runtime server receiveslicense entitlement details from the administration server and when theunknown file table identifies an application, which has been discovered on amonitored node, that is not in the catalog.

Unknown file table and unknown file listsThe unknown file table and unknown file lists provide a way of identifyingsoftware that is not included in the runtime catalog and which may not be inthe master catalog.

The agent, running on a node, identifies any applications that are not includedin the runtime catalog and adds them to the unknown file list. The listscompiled by all the agents are communicated to the runtime server where theyare merged to form the unknown file table. The information in the table isused to identify entries in the master catalog which should be added to the


runtime catalog. Unknown file tables from the runtime servers are periodicallyuploaded to the administration server, where they are merged to form a singleunknown file table. You can add the unknown files to the master catalog usingthe catalog manager.

Using the catalog manager to update the master catalogThe catalog manager is a standalone tool that you can use to expand and makechanges to the master catalog. To use it, you must extract the catalog and unknownfile table from the administration server database. You can then perform a numberof tasks, the most frequent of which is adding the unknown files, discovered bythe agents, to the master catalog. When you have finished making changes, youmust reimport the catalog to the administration server database.

To use the catalog manager, perform the following steps:1. Open the Tivoli License Manager command line interface (CLI).

On WindowsClick Start ->IBM Software License Manager ->Admin CLI.

On AIX

a. Open a shell window and change to the directory:<TLM_INSTALL_DIR>/admin/cli

b. Enter the command:. ./tlmcli

2. At the command line, type:expcat

A script runs to extract the master catalog and unknown file table to the filecatalog.dat in the <TLM_INSTALL_DIR>/admin/cli folder.

3. Launch the catalog manager.

On WindowsClick Start->Programs->Tivoli License Manager->Catalog Manager.

On AIX

a. Open a shell window and change to the directory:<TLM_INSTALL_DIR>/catmgr

b. Enter the command:. ./catman


4. Navigate to the folder where the expcat script stored the catalog files, selectcatalog.dat and click Open.Catalog manager loads the file and displays the following screen.

5. Choose the program functions to make the changes you require and follow theinstructions in the following sections:v “Adding unknown files to the master catalog” on page 92..v “Modifying entries in the master catalog” on page 95.v “Importing the IBM catalog” on page 94.

6. When you have completed your changes, click Save to File, and save thecatalog so that it overwrites the extracted catalog.bat file in the<TLM_INSTALL_DIR>/admin/cli folder.

Note: Do not save the file under a different name. The impcat command forreimporting the catalog to the Tivoli License Manager administrationserver database requires a file named catalog.dat.

Chapter 8. Managing Product Information 91

7. Go to the Tivoli License Manager Administration command line interface andtype, impcat to import the updated catalog to the administration serverdatabase.

Adding unknown files to the master catalogUsing this function, you can view the entries in the unknown files table that youextracted and determine whether to associate each with an existing catalog entry orto create a new entry.

To process the entries in the unknown files table, complete the following steps:1. In the initial window of the catalog manager, click Unknown Files Manager.

2. Search for the entry in the unknown files list that you want to process, asfollows:a. Select a radio button to search by file name or description.b. From the drop-down list, select the platform for which you want to find

files-c. You can limit the search to entries where the name or description includes

a specific string by entering the string in the text box.d. You can limit the search to entries that include a description.

Note: This is only relevant for Windows platform entries. Do not checkthe Description checkbox when searching for UNIX files.

e. Click Search.The results of the search are listed in the upper part of the window.

3. Select an entry from the list of results. The details of the file you selected aredisplayed in the lower part of the window.

4. Click Associate.


Note: You must attempt to associate the file with an existing entry in themaster catalog before you create a new entry. When the entry is firstselected, the New button is not available.

The catalog manager compiles a list of products, currently in the mastercatalog, that are possible matches for the unknown file you are trying toassociate. It compiles the list by identifying all products for which thedescription contains any of the same words as the description of the unknownfile.

5. Check the list to see if the product that the unknown file belongs to is there. Ifit is, select it and click OK.If the product is not in the list, you can change the search criteria and searchagain. To do this, edit the Euristic search field and click Search.If you do not find the product that the unknown file belongs to, click Cancel.When you click OK or Cancel, you return to the previous window.

6. If you selected a product, click OK to associate the file with the product entryin the master catalog. The entry is removed from the unknown file table. Youcan now select another entry.


If you did not find the product that the unknown file belongs to, click New todefine a new entry for the master catalog.

7. Supply the information that is missing and edit any fields that need to bechanged.Name and Version are required fields.

8. Click Create to return to the previous window.9. Click OK to add the new entry to the master catalog and remove the entry

from the unknown file table.10. Select another entry or click Close to exit the Unknown Files Manager.

Importing the IBM catalogYou use this function to incorporate the changes in a new version of the IBMcatalog into the master catalog.

To merge the IBM catalog with the master catalog, complete the following steps:1. In the initial window of the catalog manager, click Import IBM Catalog.

2. Navigate to the folder where you stored the new version of the IBM catalog.


3. Select the IBM catalog file and click Open.4. A message appear to tell you that the import takes several minutes. Click OK

to continue.The import is completed silently, with no user interaction. When the process iscomplete the following message appears to summarize the changes that havebeen made to the master catalog export file.

5. Click OK.

Modifying entries in the master catalogYou can use the catalog manager function to make changes to existing entries inthe master catalog. The most likely uses for this function are to change incorrectinformation or add details that were not available when the entry was created, forexample, the product vendor.

You can make changes to the list of files associated with the product. However, asthe catalog has already been used to monitor software products and to collectusage information, adding or removing files can result in inconsistencies inmonitoring. Therefore, use the function with caution.

To make changes to entries in the master catalog, complete the following steps:


1. In the initial window of the catalog manager, click Catalog Manager.

2. From the scrollable list, select a product for which you want to change thecatalog entry and click Edit.You can use the Fast search to move directly to products that match thecharacters you enter.

3. Change or complete information in the editable fields.The Name and Version fields are required.

4. If you need to make changes to the linked files, click Add/Remove.


The Linked Modules Manager window appears, showing a list of files currentlylinked to the product in the Linked Executables list and a list of files that arenot linked to any product in the Linkable Executables list.

Note: Be aware that changing the files that are linked to an application maycause discrepancies in monitoring the software usage.

5. Change the list of linked executables, as follows:v To dissociate a file from this product, select it in the Linked Executables list

and click Remove.

Note: If you remove all the linked files from a product that has not beenadded to the master catalog from the IBM catalog, its level ofmonitoring will be changed to Disabled and it will not appear on anyTivoli License Manager reports.

v To associate another file with the product, select a file in the LinkableExecutables list and click Add.

6. Click OK to save the changes to the catalog and return to the list of entries.7. Click Close to exit from the catalog manager.



Appendix A. Messages

Messages appear in the work area of the window. Each message has the followingcomponents:v An external message text which indicates the nature of the problem.v A message code that can be used as a reference to the error condition.v An internal message text which provides a more detailed description of the error

and the circumstances that caused it.v A message category, which is one of the following values:

Table 3. Tivoli License Manager message categories

Category Type Description and Response

1 Input error Caused by incomplete or inconsistent input data in asubmitted form. For example, an input error would begenerated if you failed to enter a value in a mandatoryfield or if you specified a future date and time whenrequesting a historical report.

If you get this type of error, check and correct the data youentered.

2 Technicalerror

Caused by an internal problem within the Tivoli LicenseManager® software.

You should contact customer support if this type of erroroccurs.

3 Business error Associated with database problems, for example, datainsubstantiality, locking errors, or loss of networkconnection.

This type of error is normally caused by a temporarydatabase problem. It may correct itself. Wait and try againlater, or reboot your system.

4 Unexpectederror

The cause of these errors is not predictable.

You should contact customer support if this type of erroroccurs.

5 Access error Caused by an attempt by a user to perform anunauthorized operation.

The hideInternalErrorMessage property in the Web interface section of thesystem.properties file controls which of the four message components aredisplayed when an error condition is generated. If hideInternalErrorMessage is setto false, all four components are displayed. If hideInternalErrorMessage is set totrue (the default), the situation is as follows:v For category 1 messages, in response to input errors, only the external message

text is shown.v For all other categories, the error code and the external message text are shown.


Message DetailsTable 4 shows details the messages that appear on the Web interfaces. It includesthe standard and long message texts and any parameters used in the texts, themessage number, and the message category of each message. The action youshould take when a message is displayed depends on the message category. SeeTable 3 on page 99.

Table 4. Tivoli License Manager messages

Errorcode

External message text andparameters

Internal message text andparameters

Category

666 Internal technical error. Message: {0}

Parameters0 = Native Java™ error message

1 = user ID

2 = date and time of log in

2

1099 User {0} does not have aprofile.

Parameters0 = User ID

Profile file {0} for user {1}, logged onat {2} cannot be found.

Parameters0 = file name

1 = user ID

2 = date and time of log-on

5

1100 Wrong user ID or password. Failed log-on for user {0}.

Parameters0 = user ID

5

1101 Unauthorized access. Unauthorized access: missing,expired, or wrong user reference {0}.

Parameters0 = user reference previouslyassigned to the user

5

1102 Technical error: there is nouser session for user {0}.


Access Manager could not create auser session for user {0}.


2

1103 The user ID that you chosealready exists. Please make adifferent choice.

The user ID already exists on theXML password file.

1

1105 Technical error: illegal statefor user {0}.


The user session is in an illegal statefor the requested action. Message {0}.

Parameters0 = Native Java error message

2

1500 Technical error: file {0} wasnot found.


Technical error: required file {0}cannot be found. Please check thelog file.


2

1501 Technical error: IO error. Technical error: an IO error occurred.Please check the log file.

2


Table 4. Tivoli License Manager messages (continued)

Errorcode



Category

1502 Technical error: null pointererror.

Technical error: a required variable isNULL. Please check the log file.

2

1503 Technical error: missing class. Technical error: a required classcannot be found. Please check thelog file and application classpath.

2

1504 Technical error: unable torender or create an image.

An error occurred while creating orrendering an image. Message {0}.

Parameters0 = Native Java error message

2

1505 Technical error: unable tocreate a chart.

An error occurred while creatingchart {0}. Message {1}.

Parameters0 = Chart ID

1 =Native Java error message

2

1600 Technical error: no divisions.are available

Technical error: no divisions areavailable from the runtime serverdatabase.

2

1601 Technical error: no servers areavailable.

Technical error: no servers areavailable from the runtime serverdatabase.

2

2001 Database technical error. Database technical error: DB2® coremessage {0} (SQL error code = {1}).

Parameters0 = Message generated by DB2

1 = SQL error code

2

2002 Database error: cannot findthe requested object.

The object was not found. 2

2003 Database error: the objectcannot be saved because itwill break unique constraints.

Unique error. 3

2004 Database error: locking error.The object was modified bysomeone else.

Optimistic locking error. 3

2005 An error occurred whileexecuting a databasetransaction.

An error occurred while executing acommit, rollback, or other transactionoperation.

2

2101 Business error: wrongoperation for a non-persistentobject.

Wrong operation for a non-persistentobject.

3

2102 Business error: the changesyou are trying to make willcause databaseinsubstantiality.

Business error: you are trying todelete the root administrator, changeits properties, make an illegal profileassignment, or change an existinglicense entitlement.

3

2801 Database technical error. The JDBC driver was not found. 2

2802 Database technical error. The connection pooler failed to get adatabase connection.

2

Appendix A. Messages 101


Errorcode



Category

2803 Database technical error. It is not possible to create aconnection to the database.

2

2804 Database error: It is notpossible to get a databaseconnection. Please try again.

A closed database connection wasfound.

2

2805 Database error: It is notpossible to get a databaseconnection. Please try again.

The administration databaseconnection pooler did not initializecorrectly.

2

2806 Invalid version of the TivoliLicense Manager database

The Tivoli License Manager databaseversion does not match the versionof the code.

2

4000 Logger initialization error. An error occurred while initializingclass {0}.

Parameters0 = name of the class

2

4001 Event logger error. An error occurred while processingan event or while performinganother logger task.

2

5070 It is not possible to sende-mail.

It is not possible to send e-mail.Message {0}

Parameters0 = Java native message

4

9890 Technical error: failed toinstantiate a class.

An exception occurred whileinstantiating class (0).

Parameters0 = full name of the Java class

2

9891 Technical error: failed toinvoke a method.

It was not possible to get or invokemethod (0) on class (1).

Parameters0 = name of the Java method 1 =full name of the Java class

2

9900 Technical error: wronginstance of a model object.

Wrong instance of model object. {0}in place of {1}.

Parameters0 = actual class of object

1 = expected class of object

2

9902 A field is missing or out ofrange. Please make a differentchoice.

Parameter {0} is out of range,missing, required but null, or ofunexpected type.

Parameters0 = parameter name

1

9903 The specified time is in thefuture for the selected timezone. Please make a differentchoice.

Historical check failed for date. 1



Errorcode



Category

9905 One or more illegal dateshave been entered.

User {0} entered one or more illegaldates.


1

9906 You tried to update data thatcould be out of date. Pleasetry again making your choicefrom the portfolio.

Missing object model in the report. 1

9910 Internal technical error. It wasnot possible to get theresource from bundle file (0).

Parameters0 = the file name

Bundle file (0) was not found or doesnot contain a required key.

Parameters0 = the file name

2

9911 Technical error: unsupportedoutput format.

Unsupported output format {0}.

Parameters0 = HTML format

2

9912 Technical error: a class field isnot set.

Field {0} was not set by the servlet.

Parameters0 = field name

2

9913 Technical error: missingargument.

Missing argument (0} in report.

Parameters0 = argument name

2

9914 Technical error: missingattribute in the user session.

Missing attribute {0} in the usersession.

Parameters0 = attribute name

2

9915 Technical error: missingmodel object.

Model object {0} is missing.

Parameters0 = class name of missing object

2

9916 The service is not yetavailable.

The flow controller could not findthe requested reply.

2

9917 The requested data is out ofdate. Please make your choicefrom the portfolio.

Report {0} is no longer in the usersession.

Parameters0 = report name

1

9918 No {0} is available. Youcannot proceed with selectionunless at least one exists.

Parameters0 = Type of item

No (0) has been returned by thedatabase query.

Parameters0 =the type of object beingqueried.

1

9919 Technical error: there is nostored action in the usersession.

There is no action in the user sessionto be retrieved and stored again.

2



Errorcode



Category

9920 Technical error: unexpectedformat of the http requestheader.

Unexpected {0} header format inHttpServletRequest.

Parameters0 = header field name

2

9930 Technical error: It was notpossible to create the DOMdocument.

An exception occurred whileinitializing the DOM document or itsfactory.

2

9931 It was not possible to buildthe DOM document.

It is not possible to append node (0)in document (1).

Parameters0 = node name 1 = documentname.

2

9932 Technical error: it was notpossible to parse the XML file.

The parser failed to parse file (0).


2

9940 Technical error: failed toinitialize XSL transformer.

The XSL transformer initializationfailed. The XSL file (0) contains oneor more serious errors.

Parameters0 = XSL file name

2

9941 Technical error: it was notpossible to transform XML toHTML.

The XSL file (0) does not match theDOM document or contains one ormore errors.


2

9942 Technical error: it was notpossible to initialize theHTML serializer.

HTML serializer initialization failed.Please check the log file.

2

9943 It was not possible to serializethe HTML document.

It was not possible to serialize theHTML document got by a viewbased on XSL file (0).


9945 Technical error: It was notpossible to instantiate a viewobject.

It was not possible to instantiateview class {0}. Caught exception {1}.

Parameters0 = View class name

1 = Java exception type

2

9950 Technical error: userentitlement could not bedetermined.

Argument {0}, needed by entitlementsupport for user {1} is null.

Parameters0 = argument name

1 = user ID

2



Errorcode



Category

9951 Technical error: The operationcontext is not defined.

Technical error: user {0} has anundefined (NULL) operation context.


2

9952 Technical error: The operationwas not found

Technical error: operation {0} cannotbe found. Please check the operationhierarchy.

Parameters0 = operation name

2

9953 You are not entitled to executeoperation {1}.


1 = name of operation

User {0} is not entitled to executeoperation {1} in context {2}.


1 = name of operation 2 = nameof context

1

9954 User {0} is not entitled to usethis application.


User {0} is not entitled to use thisapplication. Log-off required.


1

9955 User {0} is not entitled operatein context {1}.


1 = name of context

User {0} is not entitled to operate incontext {1}, type {2}, value {3}.


1 = name of context

2 = context type

3 = context value

1

9960 No existing values of {0}match previous selections.Please make a differentchoice.

Parameters0 = requested information

No {0} has been returned by thedatabase query.

Parameters0 = type of object

1

9961 The requested page is out ofrange.

Page {0} is out of range.

Parameters0 = number of the requestedpage

1



Appendix B. Accessibility

The tables in this appendix detail the keyboard alternatives to mouse navigation,selection, and activation on the Tivoli License Manager Web interfaces.

In addition to these key combination assignments, you can also use any standardfeatures for text resizing and keyboard access that are available for your browser.

Navigating the Web interfaceTable 5 shows the key combinations that allow you to navigate between thedifferent areas of the Web Interace.

Table 5. Key combinations for navigating the Web interface

Key combination Action

ALT + p Gives focus to the first link in the portfolio section of thewindow.

ALT + t Gives focus to the first control in the toolbar section of thewindow.

ALT + w Gives control to the first control in the work area section ofthe window.

ALT + u Expands the Software Usage task group in the portfolio.

ALT + i Expands the Software Inventory task group in the portfolio

ALT + y Expands the Topology task group in the portfolio.

ALT + d Expands the Administration task group in the portfolio.

CTRL + RIGHT ARROW Moves focus to the next section of the window.

CTRL + LEFT ARROW Moves focus to the previous section of the window

TAB Moves focus to the next link or control.

SHIFT + TAB Moves focus to the previous item or control.

ENTER Activates the link, tool bar control, or work area button thathas focus. If focus is not on a link, control, or button,pressing ENTER executes the default action.

Shortcut keys for starting tasksTable 6 shows the key combinations for starting the tasks that are listed in theportfolio. These key combinations allow you to start a task directly withoutnavigating the task groups listed in the portfolio.

Table 6. Key combinations for starting tasks

Key combination Task

ALT + SHIFT + s Software Usage Snapshot

ALT + SHIFT + t Software Usage Trend Analysis

ALT + SHIFT + l Software Usage Level Analysis

ALT + SHIFT + r Software Inventory Report

ALT + SHIFT + h Software Inventory Scheduling


Table 6. Key combinations for starting tasks (continued)

Key combination Task

ALT + e Software Entitlement

ALT + SHIFT + d Topology - Divisions

ALT + SHIFT + v Topology - Servers

ALT + SHIFT +n Topology - Nodes

ALT + SHIFT + a Topology - Agents

ALT + SHIFT + u Topology - Users

ALT + SHIFT + c Administration - Accounts

ALT + SHIFT + x Administration - Customers

Shortcut keys for performing toolbar actionsTable 6 on page 107 shows the key combinations for performing the actions that areavailable on the toolbar.

Table 7. Key combinations for toolbar actions

Key combination Action

ALT + m Toggles the view between displaying and hiding theportfolio section of the window.

ALT + f Displays the home page where you can select a differentcustomer.

ALT + r Refreshes the current window.

ALT + a Opens the accessiblity help window.

ALT + h Opens the help window for the current dialog.

ALT + n Opens the Tivoli License Manager information window.

ALT + o Signs off from the Web interface.


Glossary

Aaccount. See administration account.

administrator. A person who performs the followingtasks for the customers for which he or she isresponsible:

v Manages the license management environmentincluding registration of runtime servers, divisions,and agents.

v Manages license entitlement and license pooldefinitions.

v Produces reports.

v Receives and reacts to notifications of events.

administration server. A component that performs thefollowing tasks

v Maintains a database of product, license, customer,application user, and infrastructure information.

v Provides a Web interface where administrators candefine and update the infrastructure and license rulesfor their customers and produce historical reports.

administration server database. A DB2 databaseassociated with the administration server. This databasestores the information about customers, monitoringinfrastructure, and license entitlement that are definedon the administration server as well as the historicinventory and software usage information that is usedin the historical reports available on the administrationserver Web interface.

administration account. The record of anadministrator that is stored in the database.Administration account details include the log-oninformation, e-mail address, level of access, and thecustomers that are assigned to the administrator.

agent. A component that is deployed from a runtimeserver to a customer node that is to be monitored. Anagent performs the following functions on themonitored node:

v Performs regular inventory scans and forwards theresults to the runtime server.

v Identifies the starting or stopping of monitoredapplications and communicates to the runtime serverso that a license can be assigned or released.

application user. A user who can start applications onmonitored nodes. Details of application users aremaintained to allow license pools to be restricted tospecified users.

Ccapacity type. The property of a license pool thatspecifies how to determine the number of requiredlicenses for an application. Depending on the capacitytype selected for the pool, the number of licensesrequired can be based on the number of usersrequesting a license or can depend on the size of thememory, number of processors, or number of harddisks on the node where the application is started.

customer. An organization whose license managementis controlled by Tivoli License Manager. Each customeris the owner of a set of the Tivoli License Managercomponents, including runtime servers, divisions,agents, and application users.

Ddivision. An administrative unit of Tivoli LicenseManager. Divisions are used to group agents so thatthey can be selected as a group, for example whenscheduling inventory scans or specifying targetdistribution rules.

Eevent. An occurrence that causes a notification to begenerated. Events can relate to license management, forexample a usage threshold is reached, or to thefunctioning of Tivoli License Manager, for example, anagent is not responding.

Hhard stop. A property of a license pool that specifieswhether the number of licenses available in the pool isan absolute maximum. If the property is set to Yes, it isan absolute maximum, which means that when alllicenses are in use, no further instances of theapplication can be opened. If the property is set to No,it means that the number of licenses available can beexceeded.″

high-water mark. The maximum concurrent licenseusage for a product since the high-water mark was lastreset. Depending on the context, this can refer to usagewithin a specific license pool or to usage for all licensepools of the same capacity type.


Iinventory scan. An operation performed by agents todiscover all the software applications installed onmonitored nodes. Inventory scans can be scheduled torepeat at regular, defined intervals.

Llicense pool. A set of licenses for a specific productthat are administered as a group with a set of rulesgoverning thresholds, hard stops, license allocation tomultiple sessions of the same product, and theavailability of the product to users and nodes.

Mmaster catalog. The central repository of productinformation about all software components and relatedfiles for products that can be monitored.

multi-instance. A property of a license pool thatdetermines whether multiple sessions of an applicationcan be opened using a single license. Multi-instancelicenses can apply to multiple sessions for the sameuser, for users in the same user group, or for sessionson the same node.

Nnode. A workstation in the network that can bemonitored by Tivoli License Manager when an agent isdeployed on it.

notification. An e-mail sent to a designatedadministrator in response to a license management orinternal event.

Pproduct entitlement settings. A definition thatdetermines whether or not the usage of a productshould be monitored and the level of licenseenforcement that should be applied.

Rruntime catalog. A subset of the master catalogcreated on each runtime server. Entries are added tothe runtime catalog either when user-definedentitlement settings for applications are downloadedfrom the administration server or when applications aredetected on the nodes monitored by agents that belongto the runtime server.

runtime server. A component that performs thefollowing functions:

v Assigns and releases licenses according to the rulesdefined in the license pools when it receives arequest from the agent.

v Compiles inventory information about monitorednodes that it receives from its agents and forwardsthe information to the administration server.

v Generates and sends notifications in response toevents that occur on the server itself or any of itsagents.

v Provides Web interfaces for the deployment of agentsand the production of real-time reports.

Ssoftware entitlement. Rules that define how asoftware product is monitored, the conditions underwhich licenses are allocated, and any restrictions placedon the availability of license pools to application usersand monitored nodes.

Ttarget. General term used to describe any part of anlicense management infrastructure that can haveexclusive use of a license pool. A target can be adivision, a node, or an agent, depending on how thetarget distribution rules for the license pool are defined.

target distribution parameters. Rules associated witha license pool that limit the availability of the licensepool to selected targets. The targets can be divisions,nodes, or agents depending on the target type propertyof the license pool.

target type. The property of a license pool thatspecifies where the license pool is available in thecustomer’s environment. The target type for a licensepool is set to one of the following values:

v Enterprise

v Division

v Node

v Agent

An enterprise license pool is available throughout thecustomer organization. For division, node, and agentlicense pools, the administrator defines the targetdistribution parameters to determine the availability ofthe license pool in those locations.

threshold. A percentage of the licenses available in alicense pool; if more than this percentage of licenses fora product is in use, notifications about the level of useare generated.

topology. The structure in which a customer’s runtimeservers, divisions, and agents are organized.


Uunknown file list. A list, compiled by the agent, thatidentifies any applications detected on the monitorednode that are not included in the copy of the runtimecatalog that has been downloaded to the agent.

unknown file table. A file that is maintained on eachruntime server. It is a compilation of the applications inthe unknown file lists of all agents for that runtimeserver and identifies applications that are not in thecurrent runtime catalog. If the applications in theunknown file table correspond to entries in the mastercatalog, the entries are added to the runtime catalog.

user. See application user.

user distribution parameters. Rules associated with alicense pool that limit the availability of the licensepool to selected application users. The default setting isto allow all users of applications to access the licensepool.

Glossary 111


Index

Aaccessibility 107account

adding 17deleting 19updating 19

actionson the toolbar 11

addingadministrator account 17customer 15divisions 27nodes 34users 37

administrationtasks for defining components 23

AdministrationAccounts 17, 19Customers 15, 16

administration serverGUI tasks 11logging on 7summary of functionality 2

administratorchange password 21

administrator accountadding 17deleting 19updating 19

agentdeleting 32force update 31installing 30reviewing 32select for license pool distribution 48self-update 31summary of functionality 2target type for license pool 47, 53

agent_install.properties file 31agents

in software usage snapshot 62application users

adding to SLM database 37deleting 38updating 38

associate functionunknown files manager 93

Bbenefits of Tivoli License Manager 1

Ccapacity type

defining in license pool 46in level analysis report 72selecting in real-time software usage report 76selecting in software usage snapshot 60

catalogexporting master 90importing master 92master 4, 89merging Tivoli catalog with master 94modifying entries in master 95runtime 4, 89Tivoli 94updating master 90updating master with unknown files 92

catalog manager 4, 89, 95starting 90

catalog.dat file 90, 91categories of messages 99changing

customer 16divisions 28license pools 50nodes 35runtime servers 25user details 38

changing master catalog 95command

expcat 90impcat 92

components of Tivoli License Manager 2create function

unknown files manager 93creating

administrator account 17customer 15divisions 27nodes 34users 37

creating a license pool 45creating license pools

selecting products 41customer

adding to the administration server database 15deleting 16new 15

customersupdating 16

Ddefault license pool

using 44deleting

agents 32customers 16divisions 28nodes 35user details 38

disabling software monitoring 44displaying

agents 32customers 16divisions 28nodes 35runtime servers 25


displaying (continued)user details 38

distribution detailschanging 52creating for license pool 48target selection 48

divisionadding new 27deleting 28reviewing 28select for license pool distribution 48target type for license pool 47, 53updating 28

Eenabling software monitoring 44enterprise

target type for license pool 47, 53entitlement

tasks 41entitlement settings

maintaining 43selecting products for defining 41

event notificationsdefining recipients 18

eventssummary 5

expcat command 90export

level analysis report 69, 73master catalog 90

exportingreports 80

Ffile

agent_install.properties 31catalog.dat 90, 91system.properties 31, 99Tivoli Catalog.INI 95

force update of agent 31frequency

of inventory scans 81

Hhard stop licenses 46, 51

Iicons

on the toolbar 11impcat command 92import

master catalog 92installing agents 30inventory

reporting 83scheduling scans 81

inventory reportsexporting 80

Kkeyboard access 107

Llevel analysis report

selecting products for 69level analysis software usage report 69license administration

summary 4license pool

changing distribution details for 52creating 45creating distribution details for 48modifying 50restricting to selected targets 47, 48, 53restricting to selected users 47, 48, 54selecting products for creating or modifying 41

license poolsin real-time software usage report 77in software usage snapshot 63

logging onadministration server 7runtimeserver 8

Mmaintaining entitlement settings 43maintaining product settings 43master catalog 4, 89

exporting 90importing 92merging Tivoli catalog with 94modifying entries 95updating 90updating with unknown files 92

menuAdministration->Accounts 17, 19Administration->Customers 15, 16Software Entitlement 41Software Inventory->Report 83Software Inventory->Scheduling 81Software Usage->Level Analysis 69Software Usage->Snapshot 57Software Usage->Trend Analysis 65Topology->Agents 32Topology->Divisions 27, 28Topology->Nodes 34, 35Topology->Servers 24, 25Topology->Users 37, 38

MenuSoftware Entitlement 41

messagescategories 99descriptions 100on the Web interfaces 99

modifyinglicense pools 50

modifying license poolsselecting products 41

modifying master catalog 95multi-instance licenses 47, 51


Nnew

administrator account 17customer 15division 27node 34user 37

nodeadding new 34deleting 35reviewing 35select for license pool distribution 48target type for license pool 47, 53updating 35

nodesin software usage snapshot 62

notificationsummary 5

notificationsdefining recipients 18

Ppassword

change for administrator 21changing for runtime servers 25

portfoliohow to use 10

productselecting for defining entitlement settings 41selecting for defining license pools 41

product detailsin real-time software usage report 77in software usage snapshot 61

product listin realtime software usage report 75in software usage snapshot 60

product settingsmaintaining 43selecting products for defining 41

propertyupdateAgentEnabled 31

Qquantity of licenses

changing 51setting 47

Rreal-time software usage report 73

license pools 77list of products 75product details 77sessions 79

realtime software usage reportselecting products for 73

recipientsof event notifications 18

reportsoftware inventory 83software usage level analysis 69software usage real-time 73software usage snapshot 57

report (continued)software usage trend analysis 64

reportingsoftware usage 57

reportssummary 5

reviewingagents 32customer 16divisions 28nodes 35runtime servers 25user details 38

runtime catalog 4, 89runtime server

changing password 25GUI tasks 11logging on 8registering 24reviewing 25software usage 73summary of functionality 2updating 25

Sscan

inventory 81sessions

in real-time software usage report 79in software usage snapshot 64

snapshot software usage report 57software entitlement

tasks 41Software Entitlement 41software inventory

reporting 83scheduling scans 81

Software InventoryReport 83Scheduling 81

software inventory reportsexporting 80

software meteringsummary 4

software monitoringdisabling 44enabling 44

software usagelevel analysis report 69on runtime server 73real-time report 73reporting 57snapshot report 57trend analysis report 64

Software UsageLevel Analysis 69Snapshot 57Trend Analysis 65

software usage reportsexporting 80

software usage snapshotagents 62license pools 63list of products 60nodes 62product details 61

Index 115

software usage snapshot (continued)selecting products for 57sessions 64

starting the builder tool 90system.properties file 31

setting message display property 99

Ttarget type

setting for license pool 47, 53tasks

administration 23topology 23

Taskson the Web interfaces 11

threshold in license poolchanging 51setting 47

Tivoli catalog 94Tivoli Catalog.INI file 95Tivoli License Manager components 2toolbar

actions 11topology

tasks for defining components 23Topology

Agents 32Divisions 27, 28Nodes 34, 35Servers 24, 25Users 37, 38

trend analysis reportselecting products for 65

trend analysis software usage report 64

Uunknown file list 4, 89unknown file table 4, 89unknown files

associating with existing catalog entry 93creating new catalog entry 93updating master catalog 92

unknown files manager 92associate function 93create function 93

updateAgentEnabled property 31updating

customer 16divisions 28license pool 50nodes 35runtime servers 25user details 38

updating license poolsselecting products 41

user defined license pools 45users

adding to the database 37deleting 38updating 38

WWeb administration server

GUI tasks 11logging on 7summary of functionality 2

Web interface 9Web interfaces

tasks 11Web runtime server

changing password 25GUI tasks 11logging on 8registering 24reviewing 25summary of functionality 2updating 25

work areatypes of control 10


��

Program Number: 5724-D33

Printed in U.S.A.

GC23-4833-00

Documents

IBM Tivoli License Managerpublib.boulder.ibm.com/tividd/td/ITLM/GC23-4833-00/... · v Chapter 5, “Managing Software Entitlement and License Pool Details” provides instructions