128
IBM Tivoli License Manager System Administrator’s Guide Version 1.1 (Revised February 2003) GC23-4834-00

IBM Tivoli License Manager: System Administrator's Guide

Embed Size (px)

Citation preview

Page 1: IBM Tivoli License Manager: System Administrator's Guide

IBM Tivoli License Manager

System Administrator’s GuideVersion 1.1 (Revised February 2003)

GC23-4834-00

���

Page 2: IBM Tivoli License Manager: System Administrator's Guide
Page 3: IBM Tivoli License Manager: System Administrator's Guide

IBM Tivoli License Manager

System Administrator’s GuideVersion 1.1 (Revised February 2003)

GC23-4834-00

���

Page 4: IBM Tivoli License Manager: System Administrator's Guide

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: [email protected]

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

Page 5: IBM Tivoli License Manager: System Administrator's Guide

Contents

Figures . . . . . . . . . . . . . . . v

Tables . . . . . . . . . . . . . . . vii

Notices . . . . . . . . . . . . . . . ixTrademarks . . . . . . . . . . . . . . ix

About This Book. . . . . . . . . . . xiWho should read this book . . . . . . . . . xiHow this book is organized . . . . . . . . . xiPublications . . . . . . . . . . . . . . xi

Tivoli License Manager library . . . . . . . xiRelated publications . . . . . . . . . . xiiAccessing publications online . . . . . . . xiiOrdering publications . . . . . . . . . . xii

Accessibility . . . . . . . . . . . . . . xiiiContacting IBM Software Support . . . . . . xiiiNotational conventions . . . . . . . . . . xiii

Chapter 1. Planning a Tivoli LicenseManager Implementation . . . . . . . 1The license management infrastructure . . . . . 1Web interfaces . . . . . . . . . . . . . . 4Implementation scenario . . . . . . . . . . 5Preparing to implement Tivoli License Manager . . 7

Chapter 2. Installing Tivoli LicenseManager . . . . . . . . . . . . . . 9Supported platforms. . . . . . . . . . . . 9Prerequisites . . . . . . . . . . . . . . 9Before you start . . . . . . . . . . . . . 11Installing and setting up Tivoli License Manager . . 12

Installing Tivoli License Manager components ona machine . . . . . . . . . . . . . . 13Creating a DB2 database for Tivoli LicenseManager . . . . . . . . . . . . . . 19Defining notification settings for a server . . . 23Starting a Tivoli License Manager servercomponent . . . . . . . . . . . . . 24SSL configuration . . . . . . . . . . . 25Setting up Tivoli License Manager . . . . . . 27

Uninstalling Tivoli License Manager . . . . . . 28Uninstalling the Tivoli License Manager Serversand Catalog Manager . . . . . . . . . . 28Dropping the Tivoli License Manager Databases 29Uninstalling the agent . . . . . . . . . . 29

Chapter 3. The Command LineInterface . . . . . . . . . . . . . . 31Accessing the command line interface . . . . . 31Commands on the Tivoli License Manager servers 31

dbpasswd . . . . . . . . . . . . . . 32expcat . . . . . . . . . . . . . . . 32

help . . . . . . . . . . . . . . . . 32impcat . . . . . . . . . . . . . . . 33info . . . . . . . . . . . . . . . . 33rtpasswd . . . . . . . . . . . . . . 33srvstart . . . . . . . . . . . . . . . 33srvstop . . . . . . . . . . . . . . . 33sslpasswd . . . . . . . . . . . . . . 33statusinfo . . . . . . . . . . . . . . 34

Chapter 4. The Agent . . . . . . . . 35Summary of agent functionality . . . . . . . 35Agent deployment and upgrade . . . . . . . 36

Deploying the agent manually . . . . . . . 36Automatic upgrade of agents . . . . . . . 37

Agent files. . . . . . . . . . . . . . . 38AIX . . . . . . . . . . . . . . . . 38Sun . . . . . . . . . . . . . . . . 39Windows . . . . . . . . . . . . . . 39

Agent commands . . . . . . . . . . . . 39All platforms . . . . . . . . . . . . . 39AIX . . . . . . . . . . . . . . . . 40Other UNIX Platforms. . . . . . . . . . 40Windows . . . . . . . . . . . . . . 40

Chapter 5. Event Notification . . . . . 41Events that generate notifications . . . . . . . 41Defining notification recipients and notificationsettings for a server. . . . . . . . . . . . 41The event.log file . . . . . . . . . . . . 43

Chapter 6. XML Interfaces . . . . . . 45XML definition for the software usage snapshot . . 45XML definition for the software usage trend analysisreport . . . . . . . . . . . . . . . . 49XML definition for the software usage level analysisreport . . . . . . . . . . . . . . . . 50XML formats for inventory reports . . . . . . 51

Chapter 7. Database Table Clean-up . . 55Performance and sizing considerations . . . . . 55Setting parameters for clean-up processes . . . . 55

Chapter 8. Problem Determination . . . 57Validating the Installation . . . . . . . . . 57Log files and tracing . . . . . . . . . . . 59

Logging and trace setting on servers . . . . . 59Using the statusinfo command to collect errorinformation . . . . . . . . . . . . . 61Logging and trace setting on the agent . . . . 61

Performance . . . . . . . . . . . . . . 62Network traffic . . . . . . . . . . . . 62Database size . . . . . . . . . . . . . 63Disk Space . . . . . . . . . . . . . 63System processes . . . . . . . . . . . 63

© Copyright IBM Corp. 2001, 2002 iii

Page 6: IBM Tivoli License Manager: System Administrator's Guide

WebSphere settings . . . . . . . . . . . 63HTTP configuration . . . . . . . . . . 64

Common Problems . . . . . . . . . . . . 64Servers . . . . . . . . . . . . . . . 64Databases . . . . . . . . . . . . . . 66Agent deployment . . . . . . . . . . . 67Agent operation . . . . . . . . . . . . 71User Interface . . . . . . . . . . . . 72

Contacting Tivoli Support . . . . . . . . . 73

Appendix A. Messages . . . . . . . . 75Message Details . . . . . . . . . . . . . 76

Appendix B. Configuration Settings . . 83Tivoli License Manager configuration files . . . . 83The system.properties file . . . . . . . . . 84

Web Interface settings . . . . . . . . . . 84Administration server settings . . . . . . . 85Runtime server settings . . . . . . . . . 86Agent settings . . . . . . . . . . . . 87E-Mail configuration settings . . . . . . . 88

The db.properties file . . . . . . . . . . . 89

Configuring proxies . . . . . . . . . . . 90

Appendix C. Options file for silentinstallations . . . . . . . . . . . . 93

Appendix D. Common Tasks . . . . . 97Initializing the DB2 command line. . . . . . . 97Starting and stopping the HTTP server . . . . . 97Starting and stopping the WebSphere applicationserver . . . . . . . . . . . . . . . . 97Starting the WebSphere administrator’s console . . 98

Appendix E. Connecting to an XDisplay Server . . . . . . . . . . . 99Connecting on the same machine . . . . . . . 99Connecting between machines . . . . . . . . 99

Glossary . . . . . . . . . . . . . 101

Index . . . . . . . . . . . . . . . 105

iv IBM Tivoli License Manager: System Administrator’s Guide

Page 7: IBM Tivoli License Manager: System Administrator's Guide

Figures

1. Three-tiered topology of Tivoli License Managercomponents . . . . . . . . . . . . . 2

2. Tivoli License Manager structure with multipleruntime servers . . . . . . . . . . . 3

3. Distribution of agents between divisions andruntime servers . . . . . . . . . . . 4

4. Monitoring needs of a large company . . . . 5

5. Tivoli License Manager structure at a largecustomer . . . . . . . . . . . . . . 6

6. SSL-enabled virtual host definition forWindows servers. . . . . . . . . . . 26

7. SSL-enabled virtual host definition for AIXservers . . . . . . . . . . . . . . 26

© Copyright IBM Corp. 2001, 2002 v

Page 8: IBM Tivoli License Manager: System Administrator's Guide

vi IBM Tivoli License Manager: System Administrator’s Guide

Page 9: IBM Tivoli License Manager: System Administrator's Guide

Tables

1. Tivoli License Manager installationprerequisites . . . . . . . . . . . . 10

2. Accessing the command line on Windows andAIX servers . . . . . . . . . . . . 31

3. Administration server commands . . . . . 314. Agent files on AIX platforms. . . . . . . 385. Agent files on Sun platforms . . . . . . . 396. Agent files on Windows platforms . . . . . 397. Agent commands on all agent platforms 408. Agent commands on AIX platforms . . . . 409. Agent commands on UNIX platforms . . . . 40

10. Agent commands on Windows platforms 4011. Subelements of the ProductEntry element in

the software usage snapshot . . . . . . . 4612. Subelements of the AgentEntry element in the

software usage snapshot . . . . . . . . 4713. Subelements of the CapacityEntry element in

the software usage snapshot . . . . . . . 4714. Subelements of the LicenseEntry element in

the software usage snapshot . . . . . . . 4715. Subelements of the SessionEntry element in

the software usage snapshot . . . . . . . 4916. Subelements of the Product element in the

level analysis report. . . . . . . . . . 50

17. Subelements of the XmlExport element in thesoftware inventory report . . . . . . . . 52

18. Subelements of the Product element in thesoftware inventory report . . . . . . . . 52

19. Subelements of the Agent element in thesoftware inventory report . . . . . . . . 53

20. Trace levels and log files . . . . . . . . 6021. WebSphere configuration scripts . . . . . 6422. Installagent return codes . . . . . . . . 7023. Tivoli License Manager message categories 7524. Tivoli License Manager messages . . . . . 7625. Configuration files for Tivoli License Manager

servers . . . . . . . . . . . . . . 8326. Web interface parameters in the

system.properties file . . . . . . . . . 8527. Administration server parameters in the

system.properties file . . . . . . . . . 8528. Runtime server parameters in the

system.properties file . . . . . . . . . 8629. Agent parameters in the system.properties file 8730. E-mail configuration parameters in the

system.properties file . . . . . . . . . 8931. Parameters in the db.properties file . . . . 8932. Argument definitions for silent installations 93

© Copyright IBM Corp. 2001, 2002 vii

Page 10: IBM Tivoli License Manager: System Administrator's Guide

viii IBM Tivoli License Manager: System Administrator’s Guide

Page 11: IBM Tivoli License Manager: System Administrator's Guide

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 ix

Page 12: IBM Tivoli License Manager: System Administrator's Guide

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.

x IBM Tivoli License Manager: System Administrator’s Guide

Page 13: IBM Tivoli License Manager: System Administrator's Guide

About This Book

This book contains information about planning, installing, and configuring IBM®

Tivoli® License Manager.

It includes information about using the command line interface and aboutpreventing, identifying, and resolving problems as well as reference material thatdescribes the Tivoli License Manager agents on different platforms.

Who should read this bookThis book is intended for the system administrators who are responsible for settingup and administering the license management environment.

How this book is organizedThis book is organized as follows:v Chapter 1, “Planning a Tivoli License Manager Implementation” provides an

overview of the monitoring infrastructure and a list of issues you should takeinto account when planning to install Tivoli License Manager.

v Chapter 2, “Installing Tivoli License Manager” provides instructions forinstalling and configuring the product.

v Chapter 3, “The Command Line Interface” summarizes the commands availableon the administration and runtime servers.

v Chapter 4, “The Agent” summarizes agent functionality and providesinstructions for manual installation of agents and use of the agent commandline.

v Chapter 5, “Event Notification” includes information about the types of eventthat trigger notifications.

v Chapter 6, “XML Interfaces” provides detailed descriptions of the XML formatsused to export reports from the Web interface.

v Chapter 7, “Database Table Clean-up” provides instructions for setting up aregular task to clear old entries from certain database tables.

v Chapter 8, “Problem Determination” provides information to help you validatethe installation of Tivoli License Manager, to identify and prevent performanceproblems, and to recognize and resolve commonly occuring problems.

v Appendixes including a list of the error messages used in Tivoli LicenseManager and information about configuration files.

PublicationsThis section lists publications in the Tivoli License Manager library and any otherrelated documents. It also describes how to access Tivoli publications online, howto order Tivoli publications, and how to submit comments on Tivoli publications.

Tivoli License Manager libraryThe Tivoli License Manager library also includes the following books:v IBM Tivoli License Manager: License Administrator’s Guide, GC23-4833-00

Provides support for using the Tivoli License Manager Web interfaces.

© Copyright IBM Corp. 2001, 2002 xi

Page 14: IBM Tivoli License Manager: System Administrator's Guide

v IBM Tivoli License Manager: Data Dictionary, GC23-4835-00Provides descriptions of the database tables and indexes maintained in the TivoliLicense Manager administration server database.

v IBM Tivoli License Manager: Release Notes, SC23-4848-00Provides a summary of changes made in a release, documents known errors andworkarounds, and includes information about any product changes that couldnot be included in the main documentation.

Related publicationsThe following documents also provide useful information:v IBM DB2 Universal Database Enterprise - Extended Edition for Windows: Quick

Beginnings, GC09-2963v IBM DB2 Universal Database Enterprise - Extended Edition for UNIX: Quick

Beginnings, GC09-2964These Quick Beginnings guides provide an introduction to installing andconfiguring DB2® products. .

The Tivoli Glossary includes definitions for many of the technical terms related toTivoli software. The Tivoli Glossary is available, in English only, at the followingWeb site:

http://publib.boulder.ibm.com/tividd/glossary/termsmst04.htm

Accessing publications onlineThe product CD is accompanied by a CD that contains the publications that are inthe product library.

IBM posts publications for this and all other Tivoli products, as they becomeavailable and whenever they are updated, to the Tivoli Software InformationCenter Web site. The Tivoli Software Information Center is located at thefollowingWeb address::

http://publib.boulder.ibm.com/tividd/td/tdprodlist.html

Click the Tivoli License Manager link to access the product library.

The Tivoli Information Center contains the most recent version of the books in theproduct library in PDF or HTML formats, or both. Translated documents are alsoavailable for some products.

Note: If you print PDF documents on other than letter-sized paper, select the Fit topage check box in the Adobe Acrobat Print dialog. This option is availablewhen you click File —> Print . Fit to page ensures that the full dimensionsof a letter-sized page print on the paper that you are using.

Ordering publicationsYou can order many Tivoli publications online at the following Web site:http://www.elink.ibmlink.ibm.com/public/applications/publications/cgibin/pbi.cgi

You can also order by telephone by calling one of these numbers:v In the United States: 800-879-2755v In Canada: 800-426-4968

xii IBM Tivoli License Manager: System Administrator’s Guide

Page 15: IBM Tivoli License Manager: System Administrator's Guide

In other countries, see the following Web site for a list of telephone numbers:

http://www.ibm.com/software/tivoli/order-lit

AccessibilityAccessibility features help users with a physical disability, such as restrictedmobility or limited vision, to use software products successfully. With this product,use the keyboard instead of the mouse to operate all features of the graphical userinterface.

For additional information, see the Accessiblity appendix in the IBM Tivoli LicenseManager: License Administrator’s Guide.

Contacting IBM Software SupportIf you have a problem with any Tivoli product, you can contact IBM SoftwareSupport . See the IBM Software Support Guide at the following Web site:

http://techsupport.services.ibm.com/guides/handbook.html

The handbook provides information about how to contact Customer Support,depending on the severity of your problem, and the following information:v Registration and eligibilityv Telephone numbers and e-mail addresses, depending on the country in which

you are locatedv What information you need to gather before contacting IBM Software Support

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.

About This Book xiii

Page 16: IBM Tivoli License Manager: System Administrator's Guide

xiv IBM Tivoli License Manager: System Administrator’s Guide

Page 17: IBM Tivoli License Manager: System Administrator's Guide

Chapter 1. Planning a Tivoli License Manager Implementation

This chapter provides you with information that will help you to plan theimplementation of Tivoli License Manager. It includes the following sections:v A short overview of the Tivoli License Manager structure. This aims to provide

you with information about the functions of the system components and howthey fit together to form a monitoring infrastructure. See “The licensemanagement infrastructure”.

v A discussion of different implementation scenarios, which provides an exampleof an implementations spread over multiple sites. See “Implementation scenario”on page 5.

v A discussion of the factors you should consider when planning to implementTivoli License Manager in your organization. See “Preparing to implement TivoliLicense Manager” on page 7.

The license management infrastructureThe basis of the license manager infrastructure are the three physical componentsof Tivoli License Manager that can be installed:

Tivoli License Manager agentA license management agent must be deployed on each customer node 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 serverAll Tivoli License Manager installations have at least one runtime server andcan have 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 monitored agents.

Tivoli License Manager administration serverAll Tivoli License Manager installations have a single administration server. Itprovides the following facilities:v A central repository of product, license agreement, license usage, inventory,

and customer information.

© Copyright IBM Corp. 2001, 2002 1

Page 18: IBM Tivoli License Manager: System Administrator's Guide

v A Web interface that can be used to perform license management andadministration tasks and to produce historical reports of license usage andinventory information over time.

Tivoli License Manager provides a flexible structure that can be adapted for largeand small installations. Figure 1 shows the three tiered relationship between thephysical components, which is maintained in all possible implementations, and thefunctions of each component.

Information is passed between the three components at regular intervals, which aredefined in the Tivoli License Manager Configuration file. See Appendix B,“Configuration Settings”, on page 83.

Information that passes between the administration server and the runtime servercan be encrypted. Information that passes between the runtime server and theagents is not encrypted.

A Tivoli License Manager implementation always has only one administrationserver where a centralized database of licensing, product, and historical softwareusage and inventory information is maintained. This could be on a customer siteor on an IBM Service Delivery Center (SDC) site.

It is at the runtime server level that an implementation can be expanded to meetthe needs of larger customers. You can install a runtime server component on eachof several machines and allocate monitored nodes to each server. Figure 2 onpage 3 shows an expanded infrastructure with multiple runtime servers.

RuntimeServer

DBMSAdministrationServer

Agents

DBMS

Figure 1. Three-tiered topology of Tivoli License Manager components

2 IBM Tivoli License Manager: System Administrator’s Guide

Page 19: IBM Tivoli License Manager: System Administrator's Guide

Figure 2 shows that each agent is assigned to a specific runtime server. Eachruntime server receives the license requests from the agents that are assigned to it.However, if a runtime server cannot satisfy a license request from its license pools,the agent can contact another runtime server. The range of runtime servers that anagent can contact is configurable. Possible settings are:v Allow the agent to contact all runtime servers.v Allow the agent to contact runtime servers that have agents in the same

division.v Restrict the agent to its own runtime server.

The default is to allow the agent to contact all servers within the customerenterprise. This structure provides the benefits of improved performance providedby multiple runtime servers without sacrificing license usage efficiency.

Agents are also grouped within divisions. Divisions are administrative units whichgive you the ability to perform operations on a group of agents. For example,inventory scans, which are performed by the agents, are scheduled at divisionlevel, reports can be produced by division, and license pools can be limited toselected divisions.

Figure 3 on page 4 shows an example of the relationship between agents, theirdivisions, and the runtime servers that they are assigned to.

DBMS

Agents

Runtime servers

Administration server

-

Figure 2. Tivoli License Manager structure with multiple runtime servers

Chapter 1. Planning a Tivoli License Manager Implementation 3

Page 20: IBM Tivoli License Manager: System Administrator's Guide

The grouping of agents into divisions should reflect the structure of theorganization. For example, there could be a division for each department of acompany. Decisions about how to distribute agents between runtime servers do notneed to reflect the organizational structure. The important factor for these decisionsis performance. Agents should be assigned to a runtime server that is local to themand care should be taken to ensure that the server is not likely to becomeoverloaded because of too many agents attempting to contact it at the same time.For this reason, you should split large divisions between more than one runtimeserver to avoid overloading of the runtime server when an inventory scan of adivision is performed.

The Tivoli License Manager infrastructure includes one other logical component,the customer. The customer is the highest element of the data stored in theadministration server database. All elements of the infrastructure, apart from thecentral administration server, belong to a customer. So, all runtime servers,divisions, and agents are recorded in the administration server database as theproperty of a customer.

Web interfacesTivoli License Manager provides Web interfaces that allow you to access theadministration and runtime servers. You do not need to install client software onthe machines from which you want to access the Web interfaces. All you need is abrowser.

The main Web interface is the password-protected interface on the administrationserver that administrators can use to define the monitoring infrastructure andlicense conditions and to produce historical reports.

The runtime server has a much smaller password-protected interface, whereadministrators can obtain real-time software usage information. The runtime server

Figure 3. Distribution of agents between divisions and runtime servers

4 IBM Tivoli License Manager: System Administrator’s Guide

Page 21: IBM Tivoli License Manager: System Administrator's Guide

also hosts a Web page from which end-users can deploy the agent software ontheir machines. This page is not password-protected.

Implementation scenarioTo understand the different ways in which Tivoli License Manager can beimplemented to provide a solution to monitoring needs, we can look at anexample of a large company, with several sites in different parts of the world.

Figure 4 shows the structure of a large international company with sites in the US,the UK, and Italy. It illustrates the organization of the workstations that need to bemonitored into a set of meaningful divisions.

Figure 5 on page 6 shows an implementation of Tivoli License Manager designed tomeet the needs of this large company.

Figure 4. Monitoring needs of a large company

Chapter 1. Planning a Tivoli License Manager Implementation 5

Page 22: IBM Tivoli License Manager: System Administrator's Guide

As the largest site and as the site where the administration functions of theorganization are located, the US site has the administration server and associatedDB2 database as well as two runtime servers to which the 8000 workstations canbe assigned. The administration server database is installed on a separate machine,which must have a high-speed connection to the administration server machine. Asingle runtime server is installed at each of the smaller sites, which have 1000workstations each. Even though it would be possible, in terms of capacity, for asingle runtime server to cover both the small sites, each site has a local runtimeserver. Runtime servers should be local to the agents they are dealing with toavoid excessive network traffic, to optimize performance, and for security reasons.

In this scenario, the three sites are being monitored as a single entity. License poolscan be defined that are applicable to all monitored workstations and all softwareusage and inventory information can be included in the same reports.

If the management decide that they would like to separate the licenseadministration and reporting of the sites, each site could be defined as a separatecustomer. This implementation would look exactly the same as the large singlecustomer implementation shown in Figure 5. There is no need to use additionalresources by installing the administration server component on each site. Thecentral administration server would remain on the US site. The difference betweenthe two implementations is in the structure of the data stored in the administrationserver database. Each customer registered on the administration server has its own

Figure 5. Tivoli License Manager structure at a large customer

6 IBM Tivoli License Manager: System Administrator’s Guide

Page 23: IBM Tivoli License Manager: System Administrator's Guide

data structure. In the original example, there was one customer structure coveringthe three sites, in the second example, each site is a customer with its own datastructure.

Preparing to implement Tivoli License ManagerBefore you start the installation of Tivoli License Manager components, you shouldmake a implementation plan that includes the following tasks:v Identify the workstations that are to be monitored by Tivoli License Manager.v Devise a number of divisions that reflect a meaningful breakdown of the

organization and assign the workstations to the appropriate divisions.

Note: Divisions should not be too large. For performance reasons , it is notadvisable to have a very large number of agents in the same divisionassigned to a single runtime server. A division can be split over more thanone server, but it is not advisable to split it over many.

v Assign a machine for the administration server. Unless there is a runtime serverwith less than 1000 agents assigned the administration server component shouldbe installed on a separate machine.

v Decide whether to install the administration server DB2 database on the samemachine as the administration server component or on a different machine. Ifyou decide to install the database on a different machine, ensure that there is ahigh-speed connection between the two machines.

v Decide how many runtime servers are required. Consider the following:– The maximum number of agents that can be supported by a runtime server is

5000.– The number of agents within a single division assigned to a single runtime

server can be critical to the performance of the server. This is because thelargest load on runtime server occurs during the inventory scan, which isscheduled by division. You must determine an acceptable amount of time foran inventory scan of a division to be completed, for example a working day,and then estimate how many agents in the same division can be assigned to asingle runtime server.The agent properties section of the system.properties file for each runtimeserver includes settings that define the amount of time required to scan anode. These properties are:

pcInventoryDurationThe amount of time taken to scan a Windows® node. The default settingis 120 seconds.

serverInventoryDurationThe amount of time taken to scan a UNIX® node. The default setting is600 seconds.

You can use these properties to estimate the time required to scan the nodesfrom a single division that are assigned to the node.

– It is advisable for the runtime server and the agents assigned to it to be at thesame location. This is partly to keep response time when requesting licensesto a minimum and partly for security reasons, as communications betweenagents and runtime server are not encrypted. For this reason, if yourimplementation covers more than one location, it is advisable to have at leastone runtime server at each location.

Chapter 1. Planning a Tivoli License Manager Implementation 7

Page 24: IBM Tivoli License Manager: System Administrator's Guide

v Create a schedule for deploying the agents. For example, create a deploymentcalendar in which each division has a deployment date.When the runtime servers have been installed and the divisions have beencreated, send the schedule to the users, instructing them to deploy the agent atthe stated time, selecting a specified runtime server and division on thedeployment screen.

Note: You can check the progress of the scheduled deployments using the Agentoption that is available from the Topology section of the administrationserver Web interface.

v Compile a schedule for performing inventory scans. Scans are performed by theagent and are scheduled by division, so you must plan a date and time for eachdivision.Consider the following when you decide on your schedule:– As far as possible, scans should be scheduled for times when other agent

activity is low.– Scans for divisions that have agents assigned to the same runtime server

should not be scheduled so that they coincide or overlap.– Before the information is available for reporting it must be transferred to the

runtime server and then to the administration server.

Note: You create the schedules for inventory scanning on the administrationserver Web interface, this means that a certain amount of time will elapsebetween the time when you record a schedule and the time when theagents can use it. For this reason it is advisable to define the schedulewell before the time at which you want it to start.

Time delays for the transmission of data between Tivoli License Managercomponents are defined in the system.properties configuration file. SeeAppendix B, “Configuration Settings”, on page 83.

8 IBM Tivoli License Manager: System Administrator’s Guide

Page 25: IBM Tivoli License Manager: System Administrator's Guide

Chapter 2. Installing Tivoli License Manager

This chapter provides the information and instructions required to install andconfigure Tivoli License Manager. This information includes:v The platforms on which the components of Tivoli License Manager can be

installed. See “Supported platforms”.v The software and hardware requirements that the machines on which you plan

to install the Tivoli License Manager components should meet. See“Prerequisites”.

v Things that you should do or check before starting the installation. See “Beforeyou start” on page 11.

v Instructions for installing and configuring Tivoli License Manager, including asummary of the steps involved and detailed instructions for performing eachstep. See “Installing and setting up Tivoli License Manager” on page 12.

v Instructions for uninstalling Tivoli License Manager. See “Uninstalling TivoliLicense Manager” on page 28.

Supported platformsTivoli License Manager servers can run on Windows and AIX platforms. Agentscan be deployed on a range of Windows and UNIX platforms.

For full details of the supported platforms and of the version and fix pack levelthat is required for a Tivoli License management component, see the IBM TivoliLicense Manager: Release Notes.

PrerequisitesTable 1 on page 10 shows the software, hardware, and space requirements for theinstallation of the Tivoli License Manager components.

© Copyright IBM Corp. 2001, 2002 9

Page 26: IBM Tivoli License Manager: System Administrator's Guide

Table 1. Tivoli License Manager installation prerequisites

Component Prerequisite Type Prerequisites

Tivoli LicenseManageradministrationand runtimeservers

Database client v IBM DB2 Runtime Client 7.2.7

This is required on the server machine if the DB2 server is installed on adifferent machine. If the server and database are installed on the samemachine, the machine must have the prerequisites listed for the DB2databases.

Web server One of the following:

v IBM HTTP Server version 1.3.12.6 (packaged with IBM WebSphere®

3.5.6)

v IBM HTTP Server version 1.3.19.3 (packaged with IBM WebSphere4.0.4)

v Microsoft® IIS version 5.0 (packaged with Windows 2000 Server)

Web application server One of the following:

v IBM WebSphere Application Server Advanced Edition version 3.5.6

v IBM WebSphere Application Server Advanced Edition version 4.0.4

Internet browser One of the following:

v Microsoft Internet Explorer 5.5 or higher

v Netscape Navigator 6.2 or higher

CPU One of the following:

v Intel Pentium® IV 1.5 Ghz or equivalent

v IBM RS/6000® (7044 recommended)

Memory v 1 GB minimum

Space v 10 GB

In addition, on AIX® platforms there must be at least 100 MB of freespace in the /tmp directory.

DB2 databasesfor theadministrationand runtimeservers

Database server v DB2 Enterprise Edition 7.2.7

CPU One of the following:

v Intel Pentium IV 1.5 Ghz or equivalent

v IBM RS/6000 (7044 recommended)

Memory v 1 GB minimum

Space Dependent on the number of agents supported.

In addition, on AIX platforms there must be at least 100 MB of free spacein the /tmp directory.

Tivoli LicenseManagercatalogmanager

Space v 50 MB

In addition, on AIX platforms there must be at least 100 MB of free spacein the /tmp directory.

10 IBM Tivoli License Manager: System Administrator’s Guide

Page 27: IBM Tivoli License Manager: System Administrator's Guide

Table 1. Tivoli License Manager installation prerequisites (continued)

Component Prerequisite Type Prerequisites

Tivoli LicenseManager Agent

Browser One of the following:

v Internet Explorer 5.0 or higher

v Netscape Navigator 4.7.x or later

Notes:

1. On agents running on Sun platforms, you can only use NetscapeNavigator.

2. On AIX, Netscape Navigator 4.79 is recommended.

Space v 10 MB

Notes:

1. If you plan to install the Web administration server on an AIX platform, theserver machine must have access to an X Display server. See Appendix E,“Connecting to an X Display Server”, on page 99 for information aboutchecking for the connection to the X Display server and instructions on makingthe connection if it does not exist.

2. If possible, you should use the JDBC driver 2.0 as it provides advanceddatabase capabilities (query optimized execution, data sources) that are notavailable with the version 1.2 driver. This version is a prerequisite ofWebSphere 4.0, but not of WebSphere 3.5.6. If you are using WebSphere 3.5.6,you should switch to the JDBC driver 2.0. Instructions for this task areprovided in the DB2 documentation.If you cannot switch to the JDBC 2.0, you can run Tivoli License Manager withthe JDBC driver 1.2, though performance and scalability could be affected. Ifyou want to do this, you must change the setting of thedbPoolerImplementation property in the db.properties file for each installeddatabase to Internal. See “The db.properties file” on page 89.

Before you startBefore you start the installation, do the following:v Decide on how you intend to configure your system topology, for example, how

many runtime servers you are installing and on which machines. For moreinformation and examples, see Chapter 1, “Planning a Tivoli License ManagerImplementation”, on page 1.

v Check that the machines on which you plan to install the Tivoli License Managercomponents meet the installation prerequisites. See “Prerequisites” on page 9.

Notes:

1. You should install DB2 before installing WebSphere.2. If you install the DB2 server on the AIX platform, make sure that the /home

file system is at least 10 GB wide, as the DB2 databases will be hosted in thispartition. You can extend the file system size using an AIX configuration tool,for example, smitty.

3. You can install and configure the IBM HTTP server using the WebSphereQuick Installation option. If you want to use this method, ensure that noother Web server is running before you start WebSphere. If you wantWebSphere to use a different Web server, choose the WebSphere CustomInstallation option and follow the instructions.

Chapter 2. Installing Tivoli License Manager 11

Page 28: IBM Tivoli License Manager: System Administrator's Guide

4. If you are planning to use SSL for communications between theadministration and runtime servers and between Web browsers and the SSLservers, the IBM HTTP server must be installed with the SSL option turnedon.

v Adjust the time and time zone settings on each machine where you plan toinstall a server component. It is not advisable to change these settings whenTivoli License Manager is in use.

v Start DB2 services on the DB2 servers.v Start WebSphere on the machines where you plan to install the Tivoli License

Manager servers. For instructions on starting WebSphere, see “Starting andstopping the WebSphere application server” on page 97.

v Ensure that you have the following information:– The password that is to be assigned to the tlmsrv user for communications

between the Tivoli License Manager server and its DB2 database.– The exact names with which you intend to register the runtime servers you

are installing.– The password that is to be used for communications between each runtime

server and the administration server.– The exact name of the customer for whom runtime servers are being installed.

If you are adding a runtime server for an existing customer, ensure that thisname is exactly the same as the name under which the customer has beenregistered on the administration server Web interface.

– The host name of the machine where the Tivoli License Manageradministration server is installed or will be installed.

Installing and setting up Tivoli License ManagerTo install Tivoli License Manager and make it ready for use, you must completethe following tasks:1. Install the administration server. runtime server and catalog manager

components on the machines you have selected. See “Installing Tivoli LicenseManager components on a machine” on page 13.

2. Create and populate the DB2 databases for the administration server andruntime servers you have installed. See “Creating a DB2 database for TivoliLicense Manager” on page 19.

3. Set parameters for event notification in the system.properties file of each TivoliLicense Manager server. See “Defining notification settings for a server” onpage 23.

4. Start the server components that you have installed. See “Starting a TivoliLicense Manager server component” on page 24.

5. Enable SSL on the administration server and configure the runtime server as anSSL client. See “SSL configuration” on page 25.

Note: This step is optional. When you install a runtime server, you can chooseto use SSL for secure communication. If you choose not to, you can omitthis step.

6. Use the Tivoli License Manager Web interfaces to create the structure requiredfor each customer. See “Setting up Tivoli License Manager” on page 27.

Note: “Validating the Installation” on page 57 describes a series of steps you cantake to check that the installation of the server and database components hasbeen successful and that Tivoli License Manager is ready for use.

12 IBM Tivoli License Manager: System Administrator’s Guide

Page 29: IBM Tivoli License Manager: System Administrator's Guide

Installing Tivoli License Manager components on a machineTivoli License Manager provides a single installation wizard that can be used onall supported platforms. The setup file is:

Windows setupwin32.exe

AIX setupaix.bin

Using the installation wizard you can do the following:v Install the Tivoli License Manager administration and runtime server

components and configure WebSphere for these servers.v Install the Tivoli License Manager catalog manager.v Copy the scripts for creating and populating the DB2 databases for the

administration and runtime servers to the machines where the databases are tobe located.

Using the installation wizard in silent modeWhen the installation wizard runs in silent mode, it takes the parameters itrequires from an InstallShield options file. The options file, recordFile.txt isprovided with Tivoli License Manager. You must edit this file to provide the valuesfor parameters that the wizard must set.

To launch the installation wizard in silent mode, launch the set up command withthe following arguments:

-options ″.\recordFile.txt″ -silent

You may find this option useful if you are installing a large number runtimeservers and databases on different machines, as you can use the same options fileon all machines, only changing a small number of parameters, for example theruntime server name.

See Appendix C, “Options file for silent installations”, on page 93 for a fulldescription of the recordFile.txt file.

Using the installation wizard in interactive modeTo install a Tivoli License Manager server and configure WebSphere for the server,complete the following steps:1. Log on to the machine where you want to install Tivoli License Manager

components as a user with administrative rights (Administrator on Windowsplatforms or root on AIX platforms).

2. Launch the setup file for Tivoli License Manager: On Windows, you shouldstart the wizard using the Add/Remove Program function that is availablefrom the Control Panel.The initial panels include a welcome panel and the license agreement. Youmust select the radio button to accept the license agreement before you canproceed by clicking Next.

Chapter 2. Installing Tivoli License Manager 13

Page 30: IBM Tivoli License Manager: System Administrator's Guide

The next panel enables you to select the installation location.

3. Accept the default location displayed or click Browse to select a differentlocation. Click Next.

4. Select the type of installation you want for this machine. There are threeoptions:

AdministrationInstalls the administration server, its database, and the catalog manager onthe machine.

RuntimeInstalls the runtime server and its database on the machine.

CustomEnables you to choose the components that are to be installed.

5. Click Next.

14 IBM Tivoli License Manager: System Administrator’s Guide

Page 31: IBM Tivoli License Manager: System Administrator's Guide

If you chose a custom installation, the following panel appears.

6. Clear the check boxes of components that you do not want to install and clickNext.

Note: Unless the runtime server is to support a small number of agents(fewer than 1000), you should not install a runtime server and theadministration server on the same machine.

If you are installing a database on an AIX platform, the following panelappears.

7. Accept the default location for the DB2 instance owner or click Browse toselect a different location.

8. Click Next to move to the next panel.

Chapter 2. Installing Tivoli License Manager 15

Page 32: IBM Tivoli License Manager: System Administrator's Guide

If you chose to install the administration server, runtime server, or a database ,the following panel appears.

9. Enter and confirm the password to be used to access the DB2 database that isassociated with the server component you are installing. During installationthe user tlmsrv is created with a password is set to this value.

Note: If you install the administration and runtime server components on thesame machine, this password is valid for both databases.

This is true when you install the components in a single installationand when you install one first and then run the wizard again to installanother. If a component has already been installed on the machine, andthe tlmsrv user has already been created, the panel that appears has asingle text box asking you to confirm the password that was specifiedduring the first installation.

16 IBM Tivoli License Manager: System Administrator’s Guide

Page 33: IBM Tivoli License Manager: System Administrator's Guide

If you chose to install the runtime server component the following panelappears.

10. Specify information to identify the runtime server, as follows:a. Identify the customer for which the runtime server is being installed.

If the administration server has already been installed and customerrecords have been created using the administration server Web interface,you must be sure that the name you specify exactly matches the customername registered on the interface. Otherwise, you must create a customerwith this name when the administration server Web interface is available.

b. Specify a name for the runtime server that has not already been assignedto a runtime server.

c. Specify and confirm the password to be used to authenticate this runtimeserver in communications with the administration server.

Notes:

a. These settings are used to authenticate communication between theruntime server and the administration server. You must be careful to enterthem correctly, both here and when you later register the runtime serveron the administration server Web interface. If there is any discrepancybetween the values entered when installing and registering the server, theruntime server cannot be plugged in to the administration server.

b. The values you enter for Customer name and Runtime server name mustcontain only US ASCII characters.

Chapter 2. Installing Tivoli License Manager 17

Page 34: IBM Tivoli License Manager: System Administrator's Guide

11. Click Next.

12. Specify information to enable the runtime server to communicate with theadministration server. To do this:a. Identify the host machine of the administration server by entering the host

name or the IP address in the Administration server address field. OnlyUS ASCII characters can be used.

b. Specify the number of the port to be used in the Port field. The default forunencrypted communications is 80. For secure (SSL) communications,enter 443.

c. Choose the appropriate radio button to specify whether communicationswith the administration server, initiated by this runtime server, should beencrypted.

d. If you choose Yes, enter the SSL Password and confirm it.Following installation, you must follow the instructions given in “SSLconfiguration” on page 25 to enable the administration server for SSL andcomplete the configuration of the runtime server as an SSL client.

13. A panel appears confirming the selections you have made and the sizing ofthe installation.

14. Click Next to start the installation.15. When the installation process is complete, a confirmation panel appears. Click

Next to continue.

18 IBM Tivoli License Manager: System Administrator’s Guide

Page 35: IBM Tivoli License Manager: System Administrator's Guide

If you are installing one or more server components, the following panelappears.

16. Make sure that WebSphere is running.If WebSphere is not running when you click Next, the WebSphereconfiguration will fail and you will need to manually run the WebSphereconfiguration script. See Table 21 on page 64 for a list of the WebSphereconfiguration scripts for each platform, WebSphere version, and server type.

17. Click Next.The install wizard configures WebSphere to recognize the Tivoli LicenseManager server.

18. When the WebSphere configuration is complete, click Finish to exit thewizard.

Creating a DB2 database for Tivoli License ManagerFor each Tivoli License Manager server you install, you must create an associateddatabase. You can create the Tivoli License Manager DB2 database on Windowsand AIX platforms. A database can be created on the same machine as theassociated Tivoli License Manager server or the database and server can be onseparate machines.

Communication is automatically established between the database and the serverwhen both are installed on the same Windows machine. When the database andserver are installed on different machines or when they are installed on the sameAIX machines, additional steps are required to establish communication.

Instructions for creating the databases and for establishing communications in allsupported configurations are provided under the following headings:v “Creating and populating a database on Windows” on page 20v “Creating and populating a database on AIX” on page 21v “Connecting a database to a Tivoli License Manager server on an AIX machine”

on page 22.

Chapter 2. Installing Tivoli License Manager 19

Page 36: IBM Tivoli License Manager: System Administrator's Guide

v “Connecting a database to a Tivoli License Manager server on a Windowsmachine” on page 22.

You should also consult the DB2 Quick Beginnings guides for more informationabout methods of connecting to databases.

Creating and populating a database on WindowsWhen you choose the option to install a database to be associated with a TivoliLicense Manager server, the installation wizard creates the folder:

Administration server<TLM_INSTALL_DIR>\admin\db\db2

Runtime servers<TLM_INSTALL_DIR>\runtime\db\db2

These folders each contain a script for creating and populating a DB2 database.You must launch this script on the machine where the DB2 server is installed tocreate and populate the DB2 database.

To create and populate the database complete the following steps:1. Log on to the DB2 server machine as administrator or as a DB2 administrator

(for example db2admin).2. From the Start menu, open the DB2 Command Window.3. Change to DB2 directory:

Administration server<TLM_INSTALL_DIR>\admin\db\db2

Runtime servers<TLM_INSTALL_DIR>\runtime\db\db2

and enter the command:

dbsetup.bat

4. When requested, enter the password for the user you have logged on as.

Note: If you enter a wrong password, drop the database using the command:

db2 drop database <database name> Where <database name> is tlma if youare creating the administration server database and tlmr if you arecreating a runtime server database.

Then run dbsetup.bat again.

If the server and the DB2 database are installed on the same machine, thedatabase creation is now complete.

If the server is on a different Windows machine, complete the steps describedin “Connecting a database to a Tivoli License Manager server on a Windowsmachine” on page 22.

If the server is on an AIX machine, complete the steps described in“Connecting a database to a Tivoli License Manager server on an AIX machine”on page 22.

20 IBM Tivoli License Manager: System Administrator’s Guide

Page 37: IBM Tivoli License Manager: System Administrator's Guide

Creating and populating a database on AIXWhen you choose the option to install a database to be associated with a TivoliLicense Manager server, the installation wizard creates the folder:

Administration server<TLM_INSTALL_DIR>/admin/db/db2

Runtime servers<TLM_INSTALL_DIR>/runtime/db/db2

These directories each contain a script for creating and populating a DB2 database.You must launch this script on the machine where the DB2 server is installed tocreate and populate the DB2 database.

To create and populate the database complete the following steps:1. Log on to the DB2 server machine as root.2. Switch to DB2 instance owner, typically db2inst1. To do this, enter the

command:su - db2inst1

3. Check that the DB2 command line is initialized. To do this, enter the command:db2 You should see the DB2 Command Line Processor. Type quit to exit andreturn to the Unix shell.

4. If the DB2 command line is not initialized, you must load the DB2environment. To do this, change to directory /home/db2inst1/sqllib and enter thecommand:. ./db2profile

5. Change to DB2 directory:

Administration server<TLM_INSTALL_DIR>/admin/db/db2

Runtime servers<TLM_INSTALL_DIR>/runtime/db/db2

and enter the command:

. ./dbsetup.sh

6. Enter the password for the DB2 instance owner when requested.

Note: If you enter a wrong password, drop the database using the command:

db2 drop database <database name> Where <database name> is tlma if you arecreating the administration server database and tlmr if you are creating aruntime server database.

Then run dbsetup.sh again.

You must now establish the connection between the database and the TivoliLicense Manager server. The way you do this depends on where the server isinstalled, as follows:v If the server is installed on the same machine or on another AIX machine, follow

the instructions detailed in “Connecting a database to a Tivoli License Managerserver on an AIX machine” on page 22.

Chapter 2. Installing Tivoli License Manager 21

Page 38: IBM Tivoli License Manager: System Administrator's Guide

v If the server is installed on a Windows machine, follow the instructions detailedin “Connecting a database to a Tivoli License Manager server on a Windowsmachine”.

Connecting a database to a Tivoli License Manager server on aWindows machineIf the server is installed on a Windows platform and the database is installed on adifferent Windows or AIX machine, complete the following steps.1. Log on to the system where the Tivoli License Manager server is installed.2. Run the DB2 Client Configuration Assistant.3. Click Add and select Search the network.4. Find the DB2 server machine and select the Tivoli License Manager server

database from the list of local databases.5. In the ODBC folder, clear the check box Register this Database for ODBC.6. Click Finish.

Connecting a database to a Tivoli License Manager server on anAIX machineFollow these instructions for a database on any platform that is associated with aTivoli License Manager server that is installed on an AIX platform.

Note: This includes the situation were the server and database are installed on thesame AIX machine.

1. Log on to the machine where the DB2 server is installed as a user withadministrative rights (Administrator or a DB2 administrator on Windowsplatforms or root on AIX platforms).

2. Using a text editor, open one of the following files:

AIX/etc/services

Windowsc:\winnt\system32\drivers\etc\services

and search for a row with the following information:<service> <port>/tcp # Connection port for DB2

If there is more than one entry like this, find the latest entry.3. On AIX, note the <service> value.

On Windows, note the <port> value.4. Log on as the DB2 instance owner to the system where the Tivoli License

Manager server is installed.5. Load the DB2 environment. To do this, change to the DB2 home directory, for

example, /home/db2inst1/sqllib and enter the command:. ./db2profile

6. Enter commands as follows:

If the database is on the same machine as the server

db2 catalog tcpip node tlmnode remote 127.0.0.1 server <noted value>

db2 catalog database <database name> as <cataloged name> at node tlmnode

If the database and server are on different machines

db2 catalog tcpip node tlmnode remote <host> server <noted value>

22 IBM Tivoli License Manager: System Administrator’s Guide

Page 39: IBM Tivoli License Manager: System Administrator's Guide

db2 catalog database <database name> as <cataloged name> at node tlmnode

where the values of variables are as follows:

hostThe host name or IP address of the machine where the DB2 server isinstalled.

noted valueThe value you found in the services file. This is a port number if the DB2server is on a Windows machine, and a server name if the DB2 server is onan AIX machine.

database nameThe name of the database: tlma for the administration server database ortlmr for a runtime server database.

catalogued nameThe name used to catalog the database: tlmadb for the administrationserver database or tlmrdb for a runtime server database.

Defining notification settings for a serverTo use event notification you must specify who is to receive notifications anddefine settings that allow the notifications to be automatically sent.

Each Tivoli License Manager server has its own settings that control the sending ofnotifications. You define the parameters to be used to send notifications in thesystem.properties file for each server.

Note: If you start the Tivoli License Manager server before you define notificationsettings or if you change notification settings, you must stop the server andrestart it before the settings take effect.

The following is an example of the Mail Settings section of the system.propertiesfile.#Mail SettingssmtpServer=mailserv120.ibm.commailEngine=InternalmailRecipient=jsmith@[email protected]

To define notification settings for a server, complete the following steps:1. Log on to the machine where the administration or runtime server is installed.2. Open the system.properties file in a text editor.

The location of the system.properties file is as follows:

administration server<TLM_INSTALL_DIR>\admin\conf

runtime server<TLM_INSTALL_DIR>\runtime\conf

Note: If the administration server is installed on the same machine as aruntime server, system.properties files exist in both locations. You mustdefine settings in both files to enable both types of notification.

3. In the #Mail Settings section of the file, define the properties as follows:

Chapter 2. Installing Tivoli License Manager 23

Page 40: IBM Tivoli License Manager: System Administrator's Guide

smtpServerEnter the host name or IP address of a valid Simple Mail TransferProtocol(SMTP) server. This server will be used to forward the e-mailcommunications generated by the notification component of the server.

mailRecipientYou can enter the e-mail address to which notifications are to be sent. Thissetting is optional because you can set up Tivoli License Manageradministrators to receive notifications using the Web interfaces.

mailSenderEnter the e-mail address that is to be used by the server as the senderaddress when notifications are generated. This must be a valid e-mailaddress.

4. Save the file and close it.

Note: E-mails are not generated if the settings for the SMTP server and the mailsender are not present or not valid.

Starting a Tivoli License Manager server componentWhen you have installed the administration server or runtime server componenton a machine, you must activate the server using WebSphere.

To activate a server, complete the following steps:1. Start the WebSphere administration console on the machine where the Tivoli

License Manager server is installed.

Note: On AIX, you can open the WebSphere console by opening a shellwindow, then changing to directory:

/usr/WebSphere/AppServer/bin and entering the command:

./adminclient.sh

2. In the navigation pane, navigate to the machine where you installed the server.3. Select the IBM Tivoli License Manager Administration Server or IBM Tivoli

License Manager Runtime Server item from the list of application servers, andclick the Play icon on the task bar.

Notes:

a. If the server is not included in the list of application servers, the installationor the WebSphere configuration has failed. Consult the install.log file fordetails of the failure.If the server has installed successfully but the WebSphere configurationfailed, you must manually run the configuration script. See Table 21 onpage 64 for a list of the WebSphere configuration scripts for each platform,WebSphere version, and server type.

b. The Tivoli License Manager WebSphere configuration script configures port9085 for the administration server and 9086 for a runtime server. If thechosen port is already used by WebSphere, an exception message appearsand you cannot start the server. The procedure for resolving this isdescribed in the Common Problems section of the Problem Determinationchapter. See the items listed under “Servers” on page 64.

24 IBM Tivoli License Manager: System Administrator’s Guide

Page 41: IBM Tivoli License Manager: System Administrator's Guide

c. If you are using WebSphere 3.5.6 on AIX, you need to clear the workingdirectory on the administration console for both the Tivoli License Managerservers; otherwise you cannot start them, because of a known problem withWebSphere.

4. Check that the name of the machine is included in the list of WebSphere hostaliases.To add aliases, open the WebSphere console, select Virtual hosts/default_host,click General, and add any necessary aliases.

Notes:

a. You must include the name as a simple host name, for example, alpha, andas a fully qualified host name, for example, alpha.rome.ibm.com.

b. If you are using IP addresses, rather than host names, to identify the serverhosts, make sure that the IP address is included in the list of aliases, asdescribed above.

c. If the server is not using the default port (80), you must append the portnumber to the server name in all aliases you create. For example,alpha.rome.ibm.com:443.

SSL configurationDuring the installation of runtime servers, you are asked whether you wish to useSSL. If you chose this option to enable secure communications between TivoliLicense Manager administration and runtime servers and for communicationbetween the Tivoli License Manager servers and Web browsers, you must do thefollowing:v Ensure that the Web server installed on the Tivoli License Manager server

machine you are configuring is enabled for SSL On IBM HTTP servers, youensure that an SSL-enabled virtual host definition is present in the configurationfile, http.conf. See“Virtual host definition in the HTTP configuration file”.If you use the Microsoft IIS Web server, refer to the IIS documentation forinstructions on configuring a server for SSL communications.

v Update the list of WebSphere host aliases to include aliases for SSL ports. See“SSL port aliases” on page 26.

v Update key.jks to register your trusted certificate. “Adding a server certificate tothe trusted store” on page 26

Note: The Tivoli License Manager installation includes a self-signed certificatefor use with an HTTP server. This certificate is installed in the followinglocation on the administration and runtime servers:

<TLM_INSTALL_DIR>/keystore

If you have the HTTP server installed, you can use the self-signedcertificate and omit this task.

Virtual host definition in the HTTP configuration fileFigure 6 on page 26 shows a sample SSL-virtual host definition for a Windowsserver and Figure 7 on page 26 shows an SSL-enabled virtual host definition for anAIX server.

Open the HTTP configuration file, httpd.conf and check for an entry like this. Ifyou do not find one you must add a new definition.

Chapter 2. Installing Tivoli License Manager 25

Page 42: IBM Tivoli License Manager: System Administrator's Guide

Note: If you have to add or change an entry in the configuration file, you mustrestart the Web server before the changes take effect.

You can check that the configuration is correct by sending the server an SSLrequest from a Web browser.

SSL port aliasesTo update the WebSphere list of host aliases, complete the following steps:1. Open the WebSphere administration console on the Tivoli License Manager

administration server machine.2. Select default_host and click Advanced.3. Duplicate all the virtual host entries, specifying the SSL port. For example, if

there are entries for localhost, alpha, alpha.rome.ibm.com, and 127.0.0.1, youshould add localhost:443, alpha:443, alpha.rome.ibm.com:443, and 127.0.0.1:443.

Adding a server certificate to the trusted storeIf you are using your own certificate instead of the self-signed certificate deliveredwith Tivoli License Manager, you must update the key.jks trusted store that hasbeen installed on each SSL-enabled runtime server so that it includes the CertificateAuthority (CA) used to sign you certificate. The key.jks trusted store is installed inthe following location:

<TLM_INSTALL_DIR>/keystore

Note: After you have updated the key.jks, you must restart the runtime server.

loadModule ibm_ssl_module modules/IBMModulesSSL128.dll...Listen 443<VirtualHost yourIPaddress:443>SSLEnableSSLClientAuth noneServerName yourServerNameErrorLog logs\ssl.error_logCustomLog logs\ssl.access_log common</VirtualHost>SSLDisableKeyfile yourPath\key.kdb

Figure 6. SSL-enabled virtual host definition for Windows servers

loadModule ibm_ssl_module libexec/mod_ibm_ssl_128.so...addModule mod_ibm_sslListen 443<VirtualHost yourIPaddress:443>SSLEnableSSLClientAuth noneServerName yourServerNameErrorLog logs/ssl.error_logCustomLog logs/ssl.access_log common</VirtualHost>SSLDisableKeyfile "c:\IBM HTTP Server\key\key.kdb"

Figure 7. SSL-enabled virtual host definition for AIX servers

26 IBM Tivoli License Manager: System Administrator’s Guide

Page 43: IBM Tivoli License Manager: System Administrator's Guide

Use the IBM Key Management tool (IKEYMAN), which is included in IBM Java™

Secure Sockets Extension (IBM JSSE), to import the trusted CA used to sign yourcertificate.

If you are using Microsoft IIS as your Web Server, you need first to extract thecertificate before you can import it, using IKEYMAN.

To do this, complete the following steps:1. On the runtime server machine, open the Internet Services Manager console

and select the Web Site Properties and Directory Security tab.2. View the server certificate details, select the Issuer, and click Copy to File.3. When you are asked whether to export the private key, select No.4. Export the certificate information in DER format.5. Use IKEYMAN to add the server certificate to list of certificates in the key.jks

trusted store.

Setting up Tivoli License ManagerAt this point, you can log on to the Tivoli License Manager Web interfaces and usethe functions available to set up a monitoring structure for the site or sites that youare responsible for.

Notes:

1. “Validating the Installation” on page 57 describes a series of steps you can taketo check that the installation of the server and database components has beensuccessful and that Tivoli License Manager is ready for use.

2. You can access the Web interfaces from any machine that can connect to theWeb administration and Web runtime servers using one of the followingbrowsers:v Internet Explorer 5.5 or later.v Netscape Navigator 6.2 or later.

The browsers must be enabled for JavaScript and any programs that preventadditional windows from opening automatically must be disabled.

See IBM Tivoli License Manager: License Administrator’s Guide for instructions onusing the Web interfaces.

Before you can start metering software usage, you must perform the followingtasks on the Tivoli License Manager Web interfaces:v Log on to the administration server as user tlmroot and create customer records

and administrators to manage their Tivoli License Manager environment, licenseentitlement, and reporting and to receive license management notifications.

Note: The initial password for user tlmroot is system. You should change this assoon as possible after the initial use, using the Administration Accountsfunction on the administration server Web interface.

v Make any necessary changes to the runtime server configurations. If you areusing proxies for communications between runtime servers and theadministration server or between runtime servers and agents, you must definethe proxies in the runtime server configuration files. See Appendix B,“Configuration Settings”, on page 83.

Chapter 2. Installing Tivoli License Manager 27

Page 44: IBM Tivoli License Manager: System Administrator's Guide

v For each customer, log on to the administration server, using the administratorlog on and password for the customer. Register the runtime servers with theadministration server and create divisions.

v Check that the servers have correctly plugged in. If a server has not plugged in,refer to the event log file (event#n.log) on the administration where the reasonfor failure is reported. The event.log file is located in the<TLM_INSTALL_DIR>\admin\log folder.

v Schedule inventory scans for each division you have created.v Log on to each node that you want to monitor as a user with administration

rights and deploy the Tivoli License Manager agent from the agent registrationpage of a runtime server that is registered for the customer and that hassuccessfully plugged in.

v Log on to each runtime server as user tlmroot and create accounts foradministrators who will be able to request reports and receive notificationsabout events that occur on the runtime servers.

Uninstalling Tivoli License ManagerThis section includes instructions for uninstalling the following components ofTivoli License Manager:v The Tivoli License Manager servers and catalog manager.v The DB2 databases that are associated with the servers.v The Tivoli License Manager agent.

Uninstalling the Tivoli License Manager Servers and CatalogManager

You run the Tivoli License Manager multi-platform uninstall wizard on a machinefrom which you want to remove a Tivoli License Manager server or the catalogmanager.

The wizard allows you to select the components you want to remove. If youchoose to remove a server component, the wizard can also remove the WebSphereconfigurations for the server, provided that WebSphere is running when you runthe wizard.

It does not remove the following:v The tables and data in the DB2 databases that are associated with the server

components.v Tivoli License Manager data files.v Configuration files that have been changed.

To uninstall Tivoli License Manager server components from a machine, completethe following steps:1. Start the uninstall wizard.

Windows uninstaller.exe

AIX uninstaller.bin

The wizard is located in the folder <TLM_INSTALL_DIR>/_uninst.

Note: On AIX platforms, there is a folder called deinst. This folder is not theuninstall folder. It contains files used in the deinstallation.

28 IBM Tivoli License Manager: System Administrator’s Guide

Page 45: IBM Tivoli License Manager: System Administrator's Guide

On Windows, you should start the wizard using the Add/Remove Programfunction that is available from the Control Panel.

2. The wizard detects the components that are present on the machine. Deselectany that you do not wish to uninstall.

3. When the uninstall is complete, delete the folder where Tivoli License Managerwas installed, to ensure that all deleted logs and data are removed from the filesystem.

Dropping the Tivoli License Manager DatabasesTo drop a Tivoli License Manager database on a Windows platform, complete thefollowing steps:1. Log on to the DB2 server machine as administrator or as aDB2 administrator

(for example db2admin).2. Open a DB2 command window.3. Enter the command:

db2 drop database <database name>

Where <database name> is tlma for the administration server database or tlmrfor the runtime server database.

To drop a Tivoli License Manager database on an AIX platform, complete thefollowing steps:1. Log on to the machine where the Tivoli License Manager server was installed

as the DB2 administration user, for example db2inst1.2. Open a shell window.3. If the DB2 command line is not initialized, you must load the DB2

environment. To do this, change to directory /home/db2inst1/sqllib and enterthe command:. ./db2profile

4. Uncatalog the database by entering the command:db2 uncatalog database <catalogued name>

where the value of <catalogued name> is as follows:

tlmadbIf the database is for the administration server and is installed on the samemachine.

tlmrdbIf the database is for a runtime server and is installed on the same machine.

5. Uncatalog the node where the server was installed by entering the command:db2 uncatalog node tlmnode

6. On the DB2 server machine, drop the database by the entering the command:db2 drop database <database name>

Where <database name> is tlma for the administration server database or tlmrfor the runtime server database.

Uninstalling the agentTo uninstall the Tivoli License Manager agent from a Windows node, complete thefollowing steps:1. On the node where the agent is installed, open a command prompt window.2. Change to the directory:

Chapter 2. Installing Tivoli License Manager 29

Page 46: IBM Tivoli License Manager: System Administrator's Guide

winnt\itlm3. Enter the command:

tlmunins.bat

To uninstall the Tivoli License Manager agent from a UNIX node, complete thefollowing steps:1. On the node where the agent is installed, open a shell window.2. Change to the directory:

/var/itlm3. Enter the command:

./tlmunins.sh

30 IBM Tivoli License Manager: System Administrator’s Guide

Page 47: IBM Tivoli License Manager: System Administrator's Guide

Chapter 3. The Command Line Interface

This chapter describes how to use the command line interfaces on theadministration and runtime servers. It includes the following information:v Instructions for accessing the Tivoli License Manager command windows on the

administration and runtime servers. See “Accessing the command line interface”.v A summary of the commands available on the administration and runtime

servers and instructions for their use. See “Commands on the Tivoli LicenseManager servers”.

Accessing the command line interfaceTable 2 shows the methods of accessing the command line interface foradministration and runtime servers on Windows and AIX platforms.

Note: On AIX platforms, only user root can access the Tivoli License Managercommand line.

Table 2. Accessing the command line on Windows and AIX servers

Server Platform Action

Administration Windows Open the Start menu and click TivoliLicense Manager ->Admin CLI.

Runtime Windows Open the Start menu and click TivoliLicense Manager ->Runtime CLI.

Administration AIX Do the following:

1. Open a shell window and change tothe directory:

<TLM_INSTALL_DIR>/admin/cli

2. Enter the command:

. ./tlmcli

Runtime AIX Do the following:

1. Open a shell window and change tothe directory:

<TLM_INSTALL_DIR>/runtime/cli

2. Enter the command:

. ./tlmcli

Commands on the Tivoli License Manager serversTable 3 shows the commands that are available on the Tivoli License Managerservers. Some are available on both server components and some are onlyapplicable to either the administration or runtime server component.

Table 3. Administration server commands

Command Server Purpose See Page

dbpasswd Both To change the password for the DB2database that is associated with theadministration or runtime server.

32

© Copyright IBM Corp. 2001, 2002 31

Page 48: IBM Tivoli License Manager: System Administrator's Guide

Table 3. Administration server commands (continued)

Command Server Purpose See Page

expcat Administration To export the master catalog and relatedfiles for update by the catalog manager.

32

help Both To get help on command line usage. 32

impcat Administration To import the updated master catalog andrelated files.

33

info Both To print information about theadministration or runtime serverconfiguration.

33

rtpasswd Runtime To change the password for the runtimeserver.

33

srvstart Both To start the administration or runtimeserver.

33

srvstop Both To stop the administration or runtimeserver.

33

sslpasswd Runtime To change the secure sockets (SSL)password.

33

statusinfo Both To assemble information about a problemto send to the support team.

34

dbpasswdYou use this command to change the password used to connect to the DB2database.

Note: This command changes the encrypted value of the password held in thepasswd.properties file. This value must match the password defined on theoperating system for the tlmsrv user.

Syntaxdbpassword new_password

For example, to change the password to ″newdb″, type:

dbpassword newdb

expcatYou use this command as part of the process of updating the master catalog withnew entries. This command exports the catalog and related files so that they can beloaded by the catalog manager, which can modify entries and add entries to thecatalog.

The file, catalog.dat, is written to the following location:<TLM_INSTALL_DIR>/admin/cli/catalog

Syntaxexpcat

helpYou use this command to find out which commands are available on theadministration or runtime server.

32 IBM Tivoli License Manager: System Administrator’s Guide

Page 49: IBM Tivoli License Manager: System Administrator's Guide

Syntaxhelp

The command returns a list of the commands that are available, including a shortdescription of each command.

impcatYou use this command as part of the process of updating the master catalog withnew entries. This command imports the updated catalog files to the administrationserver database.

Syntaximpcat

infoUsing this command, you can obtain information about the Tivoli License Managerinstallation on the administration or runtime server.

Syntaxinfo

The command returns the following information:v The version of the Tivoli License Manager installedv The installation pathv The name of the DB2 database for the server

rtpasswdYou use this command to change the password for the runtime server. This isrequired to authenticate communications from the server.

Syntaxrtpasswd new_password

For example, to change the runtime password to ″myruntime″, type:

rtpasswd myruntime

srvstartYou use this command to start the application server.

Syntaxsrvstart

srvstopYou use this command to stop the application server.

Syntaxsrvstop

sslpasswdYou use this command to change the secure sockets password for the runtimeserver. This is required to authenticate secure communications from the server.

Chapter 3. The Command Line Interface 33

Page 50: IBM Tivoli License Manager: System Administrator's Guide

Syntaxsslpasswd new_password

For example, to change the SSL password to ″1234secure″, type:

sslpasswd 1234secure

statusinfoYou use this command to gather trace files, configuration files, and database debugtables on the administration or runtime server machine. You can then forward thisinformation to the support team.

Syntaxstatusinfo

The command creates the directory <TLM_INSTALL_DIR>/admin/cli/adminStatusor <TLM_INSTALL_DIR>/runtime/cli/runtimeStatus with the following contents:v information.txt: a file that contains general information and the date and time at

which the information was gathered.v configuration: a folder that contains the configuration files for the server. This is

a copy of the server conf folderv traceLogs: a folder that contains the trace files for the server. This is a copy of

the server log folder.v dbData: a folder that contains the .dat files exported from the DB2 database.v wasLogs: a folder that contains any WebSphere logs found in the

<TLM_INSTALL_DIR>/admin/was or <TLM_INSTALL_DIR>/runtime/wasfolder

34 IBM Tivoli License Manager: System Administrator’s Guide

Page 51: IBM Tivoli License Manager: System Administrator's Guide

Chapter 4. The Agent

This chapter provides the following information about the agent:v An overview of functionality of the agent. See “Summary of agent

functionality”.v Information about deploying and upgrading agents. See “Agent deployment and

upgrade” on page 36.v The directory structures and files that are installed for each of the different

platforms where the agent can be deployed. See “Agent files” on page 38.v The commands that are available to control the agent on different platforms. See

“Agent commands” on page 39.

Summary of agent functionalityThe agent component of Tivoli License Manager runs silently on the nodes whereit is deployed, performing the following tasks:v Inventorying in the node, collecting details of its hardware and operating

system, and of the software installed on the node and forwarding thisinformation to the runtime server.

v Identifying the starting or stopping of a software product and communicatingthis information to the runtime server so that a license can be assigned orreleased and so that software usage information can be compiled.

Each agent is associated with a single runtime server when it is deployed. Theagent makes the following exchanges of information with the runtime server atregular intervals:v It downloads the parameters defined in the agents settings section of the

system.properties configuration file held on the runtime server.Among other things, these settings define how often uploads and downloads ofthe different types of information are performed. See “Agent settings” onpage 87.

v It downloads the runtime server catalog, which identifies the products that theagent can monitor.

v It uploads information to the server about applications it has detected that arenot included in the runtime catalog.

v It downloads the definitions of monitoring system topology that have beendefined most recently.

v It uploads the information that it has collected in inventory scans.v It communicates the starting and stopping of monitored applications and

requests the issue and release of licenses.

While the agent is running, it holds the information that it is working with inmemory. This includes the information that it has downloaded from the server, forexample, the monitoring system topology and runtime server catalog andinformation that it has compiled, for example, unknown file information andinventory scans. If the agent is stopped, the information held in memory is savedto a cache so that it can be retrieved when the agent restarts. The agent also caches

© Copyright IBM Corp. 2001, 2002 35

Page 52: IBM Tivoli License Manager: System Administrator's Guide

inventory scan information if it fails to send it to the server. It will then try toresend at a later time unless the scan has still not been sent when the next scan isperformed.

Although each agent is assigned to a specific runtime server, it does not need to belimited to this server when requesting licenses. The agent has information aboutother runtime servers in the topology information that it downloads. Dependingon the value of the requestScope property defined in agent settings section of thesystem.properties file, the agent can contact:v All runtime servers.v Runtime servers that have agents in the same division.v Only the assigned runtime server.

Agent deployment and upgradeThe agent is typically deployed using the agent registration Web page that isavailable on all runtime servers. This procedure is described in the IBM TivoliLicense Manager: License Administrator’s Guide. However, you can deploy the agentby running a script from a command line. See “Deploying the agent manually”.

Once the agent is installed, you can apply any upgrades automatically. See“Automatic upgrade of agents” on page 37.

You only need to uninstall an agent if you no longer wish to monitor the nodewhere it is installed. If you want to upgrade the agent, you can use the automaticmethod described in “Automatic upgrade of agents” on page 37. If you want toassign the agent to a different runtime server or division, you can simply redeploythe agent with the new parameters.

The deployment of the agent installs a number of files on the monitored node,including an uninstall script, tlmunins.bat on Windows platforms or tlmunins.shon UNIX platforms. See “Uninstalling the agent” on page 29.

Deploying the agent manuallyTo deploy an agent manually, perform the following steps:1. On a runtime server, change to the folder where the agent installation scripts

are stored for all platforms. The folder is:<TLM_INSTALL_DIR>/runtime/installedApp.ear/slm_runtime.war/webdoc/agent

It contains a folder for each platform where agents can be deployed.2. Copy the folder for the platform you require to any directory on the target

node.3. From the folder, run the installagent command with the appropriate

parameters:

Notes:

a. For AIX platforms, there are subdirectories for different versions. Beforerunning the command, you must copy the contents of the correctsubdirectory to the folder where the installagent file is located.

b. If you are deploying the agent on a Windows node, ensure that theWindows Service Manager Tool window is closed.

36 IBM Tivoli License Manager: System Administrator’s Guide

Page 53: IBM Tivoli License Manager: System Administrator's Guide

Parameters

sourcepathThe location to which you copied the agent files from the runtime server.

divisionIDUnique identifier of the division to which the new agent is assigned.

nodeTagThe computer label of the node.

serverThe host name or IP address of the runtime server that this agent is to use.

portThe runtime server port. This is normally 80.

urlThis must be set to ″/slmruntime/service″.

customerThe name of the customer.

useProxyValid values are: Yes (use proxy) and No (do not use proxy).

ProxyNameEnter the proxy host name or IP address of the server.

ProxyPortEnter the proxy port number of the server. This must be a number that isgreater than zero.

traceValid values are: y (enabling the trace file for this command) and n (do nottrace). The name of the trace file is tlmia.trc.

You can extract a list of division IDs from the administration server database,using this query:

SELECT div.id division_id, div.name division_name, cus.name customer_nameFROM tlm.division div, slm.customer cus WHERE div.customer_id = cus.id ANDcus.name = "xxx"

If the agent does not install successfully, see “Agent deployment” on page 67 for alist of possible causes and solutions.

Automatic upgrade of agentsYou can apply upgrades to agents automatically.

When a new version of the agent files is available for one or more platforms, youshould do the following:1. Put the new agent files in the appropriate folder on each runtime server.

The folder:<TLM_INSTALL_DIR>/runtime/installedApp.ear/slm_runtime.war/webdoc/agent

installagent sourcepath divisionID nodeTag server port uri customer useProxy proxyName proxyPort trace

Chapter 4. The Agent 37

Page 54: IBM Tivoli License Manager: System Administrator's Guide

has a subfolder for each platform. Some platforms have subfolders for differentversions. Ensure the agent files are copied to the correct folders.

2. Edit the agent settings section of the system.property file on each runtimeserver, and change the updateAgentEnabled property to Yes.

3. Stop and restart the runtime servers so that the changed configurations takeeffect.

Following the next download of agent parameters to agents, the agents will start tocheck the runtime server for a changed version of the appropriate agent files. Themaximum interval between checks is defined by the updateAgentPeriod. When anew version of the agent files is found, the agent downloads the files and appliesthe new version.

When all agents have been upgraded, you should reset the updateAgentEnabledproperty to No.

Agent filesThe agent deployment command installs a number of directories and files. Thelocation of the agent files depends on the platform on which the agent is deployed.

Note: The license status and unknown files log files are not created if the agenttrace level is set to 0. See “Logging and trace setting on the agent” onpage 61.

AIXOn AIX platforms, only 32 bit kernels are supported. The agent files are created asfollows:

Table 4. Agent files on AIX platforms

File Description

/usr/sbin/tlmagent The main agent file

/etc/tlmagent.ini The agent configuration file

/var/itlm/tlmunins.sh Uninstall agent script

/var/itlm/tlmkagent.def Device configuration database definitions forthe agent kernel.

/usr/lib/drivers/tlmkagent/usr/lib/drivers/tlmkreg/usr/lib/drivers/tlmkstub

The agent kernel extensions

/usr/lib/methods/deftlmkagent/usr/lib/methods/cfgtlmkagent/usr/lib/methods/chgtlmkagent/usr/lib/methods/ucfgtlmkagent/usr/lib/methods/undtlmkagent

Device configuration methods for the agentkernel extensions.

/var/itlm/cache/ Folder for agent caches files.

/var/itlm/log/traceagt.log The agent log file

/var/itlm/log/tracelics.log The license status log file

/var/itlm/log/traceuat.log The unknown files log file

38 IBM Tivoli License Manager: System Administrator’s Guide

Page 55: IBM Tivoli License Manager: System Administrator's Guide

SunOn Sun platforms only 64 bit kernels are supported. The agent files are created asfollows:

Table 5. Agent files on Sun platforms

File Description

/usr/sbin/tlmagent The main agent file

/etc/tlmagent.ini The agent configuration file

/usr/kernel/drv/sparcv9/tlmkagent The agent kernel extension

/usr/kernel/drv/tlmkagent.conf. The agent kernel extension configuration

/var/itlm/tlmunins.sh Uninstall agent script

/var/itlm/cache/ Folder for agent caches files.

/var/itlm/log/traceagt.log The agent log file

/var/itlm/log/tracelics.log The license status log file

/var/itlm/log/traceuat.log The unknown files log file

/etc/init.d/tlm Auto-startup script

/etc/rc2.d/S01slm Link to auto-startup script for runlevel 2.

/etc/rc1.d/K01slm Link to auto-startup script for runlevel 1.

WindowsOn Windows platforms, the agent files are created in the location: The followingfiles are installed in this location:

%windir%\itlm

Table 6. Agent files on Windows platforms

File Description

tlmagent.exe The main agent file

tlmagent.ini The agent configuration file

tlmkagent.sys The agent kernel extension on WindowsNT® and Windows 2000

tlmkagent.dll The agent kernel extension on Windows95/98 and Windows ME

tlmunins.bat Uninstall agent script

cache\ Folder for agent caches files

log\traceagt.log The agent log file

log\tracelics.log The license status log file

log\traceuat.log The unknown files log file

Agent commandsYou can perform some agent tasks from the command line. This section details thecommands that can be used on the different platforms.

All platformsTable 7 on page 40 lists the commands available on all platforms.

Chapter 4. The Agent 39

Page 56: IBM Tivoli License Manager: System Administrator's Guide

On Windows platforms, commands must be run from the %windir%\itlm folder

Table 7. Agent commands on all agent platforms

Task Command

Return the version of the agent. tlmagent -v

Plug in. tlmagent -p

Perform an inventory scan tlmagent -s

Plug in and perform a scan. tlmagent -sp or tlmagent -ps

AIXTable 8 lists the commands available on AIX platforms. On AIX, commands forcontrolling the agent differ from those used on other UNIX platforms because theyuse the AIX System Resource Controller (SRC).

Table 8. Agent commands on AIX platforms

Task Command

Start the agent. startsrc -s tlmagent

Stop the agent. stopsrc -s tlmagent

Show the status of the agent. lssrc -s tlmagent

Other UNIX PlatformsTable 9 lists the commands available on UNIX platforms other than AIX.

Table 9. Agent commands on UNIX platforms

Task Command

Start the agent. /etc/init.d/tlm start

Stop the agent. /etc/init.d/tlm stop

WindowsTable 10 lists the commands available on Windows platforms.

Commands must be run from the %windir%\itlm folder

Table 10. Agent commands on Windows platforms

Task Command

Start the agent service. tlmagent -g

Stop the agent service. tlmagent -e

Register the agent as a service. tlmagent -i

Remove the agent from the list ofservices.

tlmagent -r

40 IBM Tivoli License Manager: System Administrator’s Guide

Page 57: IBM Tivoli License Manager: System Administrator's Guide

Chapter 5. Event Notification

Tivoli License Manager includes a system of notifying administrators of events thathave occurred by automatically generating e-mails and sending them to designatedrecipients. Events are also written to a log.

This chapter provides the following information:v A summary of events that generate notifications on the administration server

and on runtime servers. See “Events that generate notifications”.v Instructions for setting the parameters for sending notifications and for

specifying who is to receive them. See “Defining notification recipients andnotification settings for a server”.

v Information about the event log. See “The event.log file” on page 43.

Events that generate notificationsEvent notifications are generated on the administration server and on each runtimeserver.

The following events generate a notification on the administration server:v The number of licenses in use within a license pool reaches the total number of

license available in the pool.v The percentage of licenses in use within a license pool reaches the threshold

value defined for the pool.v The administration server is stoppedv The administration server is started.

The check that identifies the license usage events is performed at regular intervals,defined by the property hwmScanPeriod in the system.properties file for theadministration server. See “Administration server settings” on page 85.

The following events generate a notification on runtime servers:v The runtime server is stoppedv The runtime server is started.v An inventory scan is sent to the runtime server by an agent.v An agent, associated with the server, is inactive.

An agent is considered inactive if the runtime server has had not communicationfrom it for a period of time defined in the maxAgentInactivity property of thesystem.properties file on the runtime server.

Defining notification recipients and notification settings for a serverTo use event notification you must specify who is to receive notifications anddefine settings that allow the notifications to be automatically sent.

Recipients of notifications are Tivoli License Manager administrators. When youdefine the account details for an administrator, you can specify an e-mail addressand select the option for the administrator to receive e-mails.

© Copyright IBM Corp. 2001, 2002 41

Page 58: IBM Tivoli License Manager: System Administrator's Guide

You define administrators on the administration server to receive thelicense-related notifications. You define administrators on each runtime server toreceive the notifications relating to runtime server and agent status. See the IBMTivoli License Manager: License Administrator’s Guide for information on creating andupdating administrator accounts.

The administration server and each runtime server has its own settings that controlthe sending of notifications. You define the parameters to be used to sendnotifications in the system.properties file for each server. These parameters includethe name of the mail server, the mail engine to be used, the e-mail address towhich notifications are to be sent. You can also set one mail recipient to receivenotifications in addition to the administrators you have defined. This additionalrecipient does not need to be an administrator.

The following is an example of the Mail Settings section of the system.propertiesfile.#Mail SettingssmtpServer=mailserv120.ibm.commailEngine=InternalmailRecipient=jsmith@[email protected]

To define notification settings for a server, complete the following steps:1. Log on to the machine where the administration or runtime server is installed.2. Open the system.properties file in a text editor.

The location of the system.properties file is as follows:

administration server<TLM_INSTALL_DIR>\admin\conf

runtime server<TLM_INSTALL_DIR>\runtime\conf

Note: If the administration server is installed on the same machine as aruntime server, system.properties files exist in both locations. You mustdefine settings in both files to enable both types of notification.

3. In the #Mail Settings section of the file, define the properties as follows:

smtpServerEnter the host name or IP address of a valid SMTP server. This server willbe used to forward the e-mail communications generated by the server’snotification component.

mailRecipientYou can enter the e-mail address to which notifications are to be sent. Thissetting is optional.

mailSenderEnter the e-mail address that is to be used by the server as the senderaddress when notifications are generated.

Note: E-mails are not generated if the settings for the smtp server and the mailsender are not present or not valid.

4. Save the file and close it.

42 IBM Tivoli License Manager: System Administrator’s Guide

Page 59: IBM Tivoli License Manager: System Administrator's Guide

The event.log fileAll servers maintain an event.log file that includes entries for all the events thatoccur on the server. The location of the file on each server is:

Administration server<TLM_INSTALL_DIR>\admin\log

Runtime servers<TLM_INSTALL_DIR>\runtime\log

In addition to the events that generate notifications, the administration server logsentries in the event.log file when a runtime server fails to plug in to theadministration server. These entries give the reason for failure. This is normally amismatch between information entered at installation of the server and thatentered when registering the runtime server on the administration server.

The following is an example of entries in the event.log file:

February 25, 2002 3:58:46 PM, System, Server Start, The administration server has been startedFebruary 25, 2002 4:29:09 PM, Usage, Threshold Exceeding, The maximum threshold allowed has beenreached or exceeded for the following licensesCustomer: Customer1, License: License1, Product: Component1 version 1, Quantity: 10, Threshold:8, High Water Mark: 9, HWM date: February 25, 2002 4:20:13 PM GMTFebruary 25, 2002 4:29:09 PM, Usage, Enrollment Exceeding, The maximum threshold allowed has beenreached or exceeded for the following licenses:Customer: Customer1, License: LicenseUser, Product: Component1 version 1, Quantity: 10, HighWater Mark: 11, HWM date: February 25, 2002 4:20:13 PM GMTFebruary 25, 2002 5:34:10 PM, System, Server Plugin Failure, The runtime server plugin has beenrefused by the administration server, the attempting server was not found because the runtimeserver name is unknown.Runtime server name: paoneffFebruary 25, 2002 5:36:41 PM, System, Server Plugin Failure, The runtime server plugin has beenrefused by the administration server, the attempting server was not found because the runtimeserver is not owned by the passed customer.Customer name: FabioCustomer3, Runtime server name: paonefFebruary 25, 2002 5:38:59 PM, System, Server Plugin Failure, The runtime server plugin has beenrefused by the administration server, the attempting server was not found because the runtimeserver password is wrong.Runtime server name: paonef

February 25, 2002 5:48:19 PM, System, Server Plugin Failure, The runtime server plugin has beenrefused by the administration server, because of a mismatch between the actual server ID andthe expected value.Runtime server name: omega

February 25, 2002 5:59:02 PM, System, Server Stop, The administration server has been stopped

Chapter 5. Event Notification 43

Page 60: IBM Tivoli License Manager: System Administrator's Guide

44 IBM Tivoli License Manager: System Administrator’s Guide

Page 61: IBM Tivoli License Manager: System Administrator's Guide

Chapter 6. XML Interfaces

Tivoli License Manager provides DTDs for the export of the following reports:v The software usage snapshot. See “XML definition for the software usage

snapshot”.v The software usage trend analysis. See “XML definition for the software usage

trend analysis report” on page 49.v The software usage level analysis. See “XML definition for the software usage

level analysis report” on page 50.v The software inventory report. See “XML formats for inventory reports” on

page 51.

The DTDs are stored on the administration server machine in the folder:

<TLM_INSTALL_DIR>/runtime/installedApp.ear/slm_admin.war/webdoc/xml/export

XML definition for the software usage snapshotThe XML format for the software usage snapshot is defined in the SWUsage.dtd. asfollows.<?xml version="1.0" encoding="UTF-8"?><!ELEMENT XMLExport (ProductEntry+)><!ATTLIST XMLExportCustomer CDATA #REQUIRED><!ELEMENT ProductEntry (Category, Description, Name, OSName, Version, Id,VendorId, VendorName, TotalInstall, AgentEntry*, CapacityEntry*)><!ATTLIST ProductEntry Available (true | false) #REQUIRED>

<!ELEMENT CapacityEntry (HWM, InUse, Name, Id, LicenseEntry+, FilteredInUse,LicenseQuantity)>

<!ELEMENT LicenseEntry (Description, ExpirationDate, StartDate, HardStop,Id, MultiInstance, Quantity, TargetType, Threshold, HWM, HWMDate,SessionEntry*, InUse)>

<!ELEMENT SessionEntry (GroupName, HostName, LogonName, Id, EndTime,Capacity, StartTime, ComponentName, QuantityGranted)>

<!ELEMENT AgentEntry (Division, HostName, IpAddress, NodeName, OSName,OsVersion, ServerName)><!ATTLIST AgentEntryAvailable (true | false) #REQUIRED><!ELEMENT Capacity (#PCDATA)><!ELEMENT Category (#PCDATA)><!ELEMENT ComponentName (#PCDATA)><!ELEMENT Description (#PCDATA)><!ELEMENT Division (#PCDATA)><!ELEMENT EndTime (#PCDATA)><!ELEMENT ExpirationDate (#PCDATA)><!ELEMENT FilteredInUse (#PCDATA)><!ELEMENT GroupName (#PCDATA)><!ELEMENT HWM (#PCDATA)><!ELEMENT HWMDate (#PCDATA)><!ELEMENT HardStop (#PCDATA)>

© Copyright IBM Corp. 2001, 2002 45

Page 62: IBM Tivoli License Manager: System Administrator's Guide

<!ELEMENT HostName (#PCDATA)><!ELEMENT Id (#PCDATA)><!ELEMENT InUse (#PCDATA)><!ELEMENT IpAddress (#PCDATA)><!ELEMENT LicenseQuantity (#PCDATA)><!ELEMENT LogonName (#PCDATA)><!ELEMENT MultiInstance (#PCDATA)><!ELEMENT Name (#PCDATA)><!ELEMENT NodeName (#PCDATA)><!ELEMENT OSName (#PCDATA)><!ELEMENT OsVersion (#PCDATA)><!ELEMENT Quantity (#PCDATA)><!ELEMENT QuantityGranted (#PCDATA)><!ELEMENT ServerName (#PCDATA)><!ELEMENT StartDate (#PCDATA)><!ELEMENT StartTime (#PCDATA)><!ELEMENT TargetType (#PCDATA)><!ELEMENT Threshold (#PCDATA)><!ELEMENT TotalInstall (#PCDATA)><!ELEMENT VendorId (#PCDATA)><!ELEMENT VendorName (#PCDATA)><!ELEMENT Version (#PCDATA)>

The tables included in this section detail the elements that form the XML definitionof the software usage snapshot report.

The format of the report comprises a XmlExport element. This element has therequired attribute Customer, which identifies the customer whose software usageinformation is reported. The XmlExport contains a ProductEntry element for eachproduct included in the report.

Each ProductEntry element has the required attribute Available, which can be setto true or false.

Table 11. lists the subelements contained in a ProductEntry element.

Table 11. Subelements of the ProductEntry element in the software usage snapshot

Element Content

Category The software category of the product, for example, Utilities -Antivirus, or Business - Finance.

Description A description of the software product.

Name The name of the software product.

OSName The operating system on which this product runs.

Version The version of the software product.

Id A unique string that identifies the product.

VendorId A unique string that identifies the product vendor.

VendorName The name of the company that supplies the software product.

TotalInstall The total number of installations of this product on monitorednodes.

AgentEntry Details of an agent that monitors a node on which the productis installed. See Table 12 on page 47.

CapacityEntry Details of the license usage for the product within a specificcapacity type. See Table 13 on page 47.

46 IBM Tivoli License Manager: System Administrator’s Guide

Page 63: IBM Tivoli License Manager: System Administrator's Guide

Table 12 shows the elements that are contained within each AgentEntry element.An AgentEntry element is embedded in the ProductEntry element for each agentthat monitors a node on which the product is installed and has the requiredattribute Available, which can be set to true or false.

Table 12. Subelements of the AgentEntry element in the software usage snapshot

Element Content

Division The name of the division to which the agent is assigned.

HostName The host name of the node on which the agent is deployed.

IpAddress The IP address of the node on which the agent is deployed.

NodeName Name of the node on which the agent is deployed.

OSName The operating system that is running on this node.

OSVersion The operating system version.

ServerName The name of the runtime server with which the agent isregistered.

Table 13 shows the elements that are contained within each CapacityEntry element.A CapacityEntry element is embedded in the ProductEntry element for eachdifferent capacity type for which the product uses licenses.

Table 13. Subelements of the CapacityEntry element in the software usage snapshot

Element Content

HWM The maximum concurrent license usage at any time during thespecified HWM period, for all license pools defined with thiscapacity type. This includes licenses in use on all agents notonly those selected for reporting.

InUse The total number of licenses, defined with this capacity type,that were in use at the specified time. This includes licenses inuse on all agents not only those selected for reporting.

Name The name of the capacity type, for example Users, Memory.

Id A unique identifier for the capacity type.

LicenseEntry Details of the licenses of this capacity type that existed for theproduct at the specified reporting time. See Table 14.

FilteredInUse The number of licenses, defined with this capacity type, thatwere in use on the selected agents at the specified time.

LicenseQuantity The volume of licenses for the product available in licensepools with this capacity type.

Table 14 shows the elements that are contained within each LicenseEntry element.A LicenseEntry element is embedded in the CapacityEntry element for each licensepool of the specified capacity that existed for the product at the specified reportingtime.

Table 14. Subelements of the LicenseEntry element in the software usage snapshot

Element Content

Description A description of the license pool.

ExpirationDate The date when the availability of this license pool ends.

StartDate The date when this license pool became available.

Chapter 6. XML Interfaces 47

Page 64: IBM Tivoli License Manager: System Administrator's Guide

Table 14. Subelements of the LicenseEntry element in the software usagesnapshot (continued)

Element Content

HardStop Possible values are:

Yes The quantity of licenses is an absolute maximum.When it is reached, licenses are refused.

No Licenses can still be granted when the maximum hasbeen reached.

Id A unique identifier for the license pool.

MultiInstance Possible values are:

DisabledMultiple sessions for licenses is not allowed.

Same userMultiple sessions are allowed for the same user on thesame agent.

Same groupMultiple sessions are allowed for users in the same groupon the same agent.

Same nodeMultiple sessions are allowed on the same node andagent.

Quantity The volume of licenses available in this pool.

TargetType Indicates the availability of the license pools. Possible valuesare:

EnterpriseAvailable to all nodes.

DivisionRestricted to specified divisions.

NodeRestricted to specified nodes.

AgentRestricted to specified agents.

Threshold The percentage of available licenses at which a notificationshould be generated.

HWM The maximum concurrent use of licenses from this poolduring the HWM period.

HWMDate The date on which the high-water mark was reached.

SessionEntry Details of a session that was using a license from this pool atthe specified reporting time. See Table 15 on page 49.

InUse The number of licenses in use from this pool at the specifiedreporting time.

Table 15 on page 49 shows the elements that are contained within eachSessionEntry element. A SessionEntry element is embedded in the LicenseEntryelement for each session that was using a license from the pool at the specifiedreporting time.

48 IBM Tivoli License Manager: System Administrator’s Guide

Page 65: IBM Tivoli License Manager: System Administrator's Guide

Table 15. Subelements of the SessionEntry element in the software usage snapshot

Element Content

GroupName The name of the user group to which the license was assigned.

HostName The host name of the node on which the session was running.

LogonName The user ID of the user who started the session.

Id A unique identifier for the session.

EndTime The time at which the session ended.

Capacity The capacity type of the license that was granted.

StartTime The time at which the session started.

ComponentName The name of the product component that was in use.

QuantityGranted The volume of licenses granted for the session.

XML definition for the software usage trend analysis reportThe XML format for the software usage trend analysis report is defined in theEventData.dtd. as follows.<?xml version="1.0" encoding="UTF-8"?>XMLExport (EventDataModel)><!ATTLIST XMLExportCustomer CDATA #REQUIRED><!ELEMENT EventDataModel (Event+)><!ELEMENT Event EMPTY><!ATTLIST Event

Start CDATA #REQUIREDStop CDATA #REQUIREDValue CDATA #REQUIRED

>

The following is an example XML format for the software usage trend analysisreport.<?xml version="1.0" encoding="UTF-8"?>

<XMLExport><EventDataModel>

<Event Start="12/1/01 2:00 PM" Stop="12/1/01 2:59 PM" Value="0"/><Event Start="12/1/01 2:59 PM" Stop="12/1/01 3:11 PM" Value="1"/><Event Start="12/1/01 3:11 PM" Stop="12/1/01 3:12 PM" Value="2"/><Event Start="12/1/01 3:12 PM" Stop="12/1/01 3:55 PM" Value="1"/><Event Start="12/1/01 3:55 PM" Stop="12/1/01 4:17 PM" Value="0"/>

</EventDataModel></XMLExport>

The trend analysis report includes one or more charts on which the usage of aproduct over a specified period is shown graphically.

The example export is for a report with a single chart. The chart is represented bythe EventDataModel element. Inside this element, the different levels of usageagainst time that are plotted on the chart are defined within Event elements. EachEvent element has the following parameters:

StartThe date and time at which the level of usage reached the value associatedwith the element.

Chapter 6. XML Interfaces 49

Page 66: IBM Tivoli License Manager: System Administrator's Guide

StopThe date and time at which the level of usage changed from the valueassociated with the element.

ValueThe level of usage between the Start and Stop times.

XML definition for the software usage level analysis reportThe XML format for the software usage level analysis is defined in theSWUsageLevelAnalysisReport.dtd. as follows.<?xml version="1.0" encoding="UTF-8"?><!ELEMENT XmlExport (Product+)>

<!ATTLIST XmlExportCustomer (#CDATA) #IMPLIED><!ELEMENT Product (

Name,Version,Vendor,Platform,ThresholdType,UsageData,HWMDate? )>

<!ELEMENT Name (#PCDATA)><!ELEMENT Version (#PCDATA)><!ELEMENT Vendor (#PCDATA)><!ELEMENT Platform (#PCDATA)><!ELEMENT ThresholdType (High Water Mark|Average Usage)><!ELEMENT UsageData (#PCDATA)><!ELEMENT HWMDate (#PCDATA)>

The format of the report comprises a XmlExport element, which contains a Productelement for each product included in the report. The XmlExport element has therequired attribute Customer, which identifies the customer whose software usageinformation is reported.

Table 16 shows the elements that are contained within each Product element.

Table 16. Subelements of the Product element in the level analysis report

Element Content

Name The name of the software product.

Version The version of the software product.

Vendor The company that supplies the software product.

Platform The operating system on which this product runs.

ThresholdType Indicates the value to be used in measuring level of usage.Possible values are High Water Mark and Average Usage.

UsageData The level of usage. Which units that the usage is expressed independs on the capacity type selected when the report wasrequested.

HWMDate The date on which the high-water mark was reached. This isonly present if ThresholdType is High Water Mark.

50 IBM Tivoli License Manager: System Administrator’s Guide

Page 67: IBM Tivoli License Manager: System Administrator's Guide

XML formats for inventory reportsTivoli License Manager provides an inventory report that can be produced in thefollowing formats:v Sorted by agent

In this format, the details of each agent are shown followed by a list of allproducts that are installed on the node it is monitoring.

v Sorted by productIn this format, the details of each product are shown followed by a list of all theagents that are monitoring nodes where it is installed.

The XML format for the software inventory report in product order is defined inthe InventoryProductReport.dtd. as follows.<?xml version="1.0" encoding="UTF-8"?><!ELEMENT XmlExport (Product+)>

<!ATTLIST XmlExport Customer (#CDATA) #IMPLIED><!ELEMENT Product (

Name,Version,Vendor,Platform,Category,Description,AgentsNumber,IsClone,Agent+ )>

<!ELEMENT Name (#PCDATA)><!ELEMENT Version (#PCDATA)><!ELEMENT Vendor (#PCDATA)><!ELEMENT Platform (#PCDATA)><!ELEMENT Category (#PCDATA)><!ELEMENT Description (#PCDATA)><!ELEMENT AgentsNumber (#PCDATA)><!ELEMENT IsClone (true|false)><!ELEMENT Agent (

IsRemoved,Name,Division,Node,LastScanDate )>

<!ELEMENT IsRemoved (true|false)><!ELEMENT Name (#PCDATA)><!ELEMENT Division (#PCDATA)><!ELEMENT Node (#PCDATA)><!ELEMENT LastScanDate (#PCDATA)>

The XML format for the software inventory report in agent order is defined in theInventoryAgentReport.dtd. as follows.<?xml version="1.0" encoding="UTF-8"?><!ELEMENT XmlExport (Agent+)>

<!ATTLIST XmlExport Customer (#CDATA) #IMPLIED><!ELEMENT Agent (

Name,Division,Node,LastScanDate,ProductsNumber,IsClone,Product+ )>

<!ELEMENT Name (#PCDATA)><!ELEMENT Division (#PCDATA)>

Chapter 6. XML Interfaces 51

Page 68: IBM Tivoli License Manager: System Administrator's Guide

<!ELEMENT Node (#PCDATA)><!ELEMENT LastScanDate (#PCDATA)><!ELEMENT ProductsNumber (#PCDATA)><!ELEMENT IsClone (true|false)><!ELEMENT Product (

IsRemoved,Name,Version,Vendor,Platform,Category,Description )>

<!ELEMENT IsRemoved (true|false)><!ELEMENT Name (#PCDATA)><!ELEMENT Version (#PCDATA)><!ELEMENT Vendor (#PCDATA)><!ELEMENT Platform (#PCDATA)><!ELEMENT Category (#PCDATA)><!ELEMENT Description (#PCDATA)>

The tables included in this section detail the elements that form the XML definitionof the inventory reports. The format of both reports comprises an XmlExportelement, within which are enclosed the elements that make up the report.

Table 17 shows the second level elements that are enclosed in the XmlExportelement. Some of these elements include another level of elements, which aredetailed in separate tables.

Table 17. Subelements of the XmlExport element in the software inventory report

Element Content

Agent The details of an agent. This includes information about thenode on which it is deployed. If the report is produced inproduct order, this element is a subelement of the Productelement.

This element occurs for each agent that is included in thereport. See Table 19 on page 53 for information about thesubelements that occur within this element.

Product The details of a software product that is installed on a nodethat is monitored by Tivoli License Manager. If the report isproduced in agent order, this element is a subelement of theAgent element.

This element occurs for each product that is included in thereport. See Table 18 for information about the subelements thatoccur within this element.

Table 18 shows the elements that are contained within the Product element. If thereport is produced in Product order, multiple occurrences of this element areembedded within the XmlExport element, identifying all the inventoried productsthat are included in the report. If the report is produced in Agent order, multipleoccurrences of this element are contained within each Agent element, identifyingall the inventoried products on nodes that are monitored by that agent.

Table 18. Subelements of the Product element in the software inventory report

Element Content

Name The name of the software product.

Version The version of the software product.

52 IBM Tivoli License Manager: System Administrator’s Guide

Page 69: IBM Tivoli License Manager: System Administrator's Guide

Table 18. Subelements of the Product element in the software inventory report (continued)

Element Content

Vendor The company that supplies the software product.

Platform The operating system on which this product runs.

Category The software category of the product, for example, Utilities -Antivirus, or Business - Finance.

Description A description of the software product.

AgentsNumber The number of agents that are monitoring nodes on which theproduct is installed.

This element is only included if the report is produced inProduct order.

IsClone This element only occurs when the report is in product order.It indicates whether the reporting entry represented by thisProduct element is a continuation of the list of agents for theproduct from the previous page of the report. Possible valuesare true and false.

IsRemoved Indicates whether the reported product has been removed.Possible values are true and false.

Agent The details of an agent that monitors a node on which thisproduct is installed. See Table 19.

This element is only embedded in the Product element if thereport is produced in product order.

Table 19 shows the elements that are enclosed within the Agent element. If thereport is produced in Agent order, multiple occurrences of this element arecontained within the XmlExport element, identifying all the agents that areincluded in the report. If the report is produced in Product order, multipleoccurrences of this element are contained within each Product element, identifyingall the agents on nodes where that product is installed.

Table 19. Subelements of the Agent element in the software inventory report

Element Content

Name Specifies the name of the agent.

Division The division of the organization to which the agent isassigned.

Divisions are optional organizational units within an TivoliLicense Manager implementation.

Node The node which the agent is monitoring.

LastScanDate The date and time of the last inventory scan on this agent.

IsClone This element only occurs when the report is in agent order. Itindicates whether the reporting entry represented by thisAgent element is a continuation of the list of products for theagent from the previous page of the report. Possible values aretrue and false.

IsRemoved Indicates whether the reported product has been removed.Possible values are true and false.

Chapter 6. XML Interfaces 53

Page 70: IBM Tivoli License Manager: System Administrator's Guide

Table 19. Subelements of the Agent element in the software inventory report (continued)

Element Content

ProductsNumber The number of products that are reported as being installed onthe node.

This element is only included if the report is produced inagent order.

Product Details of a software product that is installed on the monitorednode. See Table 18 on page 52.

This element is only embedded in the Agent element if thereport is produced in agent order.

54 IBM Tivoli License Manager: System Administrator’s Guide

Page 71: IBM Tivoli License Manager: System Administrator's Guide

Chapter 7. Database Table Clean-up

The following tables in the administration server database are continually added toby internal processes:

USAGE This table stores the information sent from runtime servers to theadministration server in usage snapshot and usage updatetransactions.

The usage snapshot contains information about the licenses in useat a point in time and is sent at regular intervals.

SERVICE This table maintains a history of requests for services. An entry isadded to the table each time there is an inventory scan by anagent, a update of agent information, or a download of topologyinformation from the administration server to runtime servers.

Tivoli License Manager includes clean-up processes, which you can run on aregular basis to prevent these tables from reaching unmanageable sizes.

Performance and sizing considerationsBecause the internal processes are continually adding new entries to these tables,intervention is needed to stop the tables from growing to proportions that couldaffect performance.

For example, in an environment with a 100 000 agents, it would only require tentransactions per hour over a ten hour working day to add 10 million entries to theUSAGE table in a single day. The USAGE table is the source of data used in thesoftware usage reports, and performance of these reports would be affected if thetable became too large.

Setting parameters for clean-up processesTivoli License Manager provides a clean-up process for USAGE table and anotherfor the SERVICE table.

The administration server section of the system.properties file includes propertiesthat control how often the processes are to run and the length of time for whichentries are to be retained. These properties are set to default values, but you candefine them to suit your needs.

Each server has its own system.properties file. The file in which you need to setthese parameters is located on the administration server in the directory:<TLM_INSTALL_DIR>\admin\conf

For information about the system.properties file, see Appendix B, “ConfigurationSettings”, on page 83.

The USAGE table process runs regularly at intervals determined by thecleanUsagePeriod property. The default for this property is one day. You candisable the process by changing the setting of the cleanUsageEnabled property tofalse.

© Copyright IBM Corp. 2001, 2002 55

Page 72: IBM Tivoli License Manager: System Administrator's Guide

The clean-up process identifies usage transactions that are older the number ofdays specified in the maxUsageAge property. These transactions are cleared fromthe table and the detailed software usage information that they provided is nolonger available to the software usage reports. However, a less detailed record ismaintained by adding entries to the USAGE_H table. This table includes an entryfor each unique combination of license pool, date, and time. The quantity oflicenses assigned values for all transactions that match on all three parameters areconsidered and the highest value is recorded in the USAGE_H entry. In this way, arecord of high-water mark is maintained at license pool, date, and time level. Thisinformation is accessible using DB2 queries.

The SERVICE table process runs regularly at intervals determined by thecleanServicePeriod property. The default for this property is six hours. You candisable the process by changing the setting of the cleanServiceEnabled property tofalse.

The clean-up process identifies entries that are older the number of days specifiedin the maxServiceAge property and deletes them.

56 IBM Tivoli License Manager: System Administrator’s Guide

Page 73: IBM Tivoli License Manager: System Administrator's Guide

Chapter 8. Problem Determination

This chapter includes the following information:v A procedure for verifying the correct installation of Tivoli License Manager

server and database components. See “Validating the Installation”.v An overview of error reporting, logging, and tracing on servers and agents. See

“Log files and tracing” on page 59.v A summary of issues related to performance. See “Performance” on page 62.v A list of common problems and their solutions. See “Common Problems” on

page 64.v Information about contacting Tivoli support. See “Contacting Tivoli Support” on

page 73.

Validating the InstallationMany initial problems are caused by mistakes or missed steps during theinstallation process. Following installation, perform the following checks to ensurethat the components have been correctly installed:v Check the connection to the Tivoli License Manager administration and runtime

databases, as follows:1. Initialize the DB2 command line on the machine where the Tivoli License

Manager administration or runtime server is installed.2. Enter the following command:

db2 connect to <database name> user tlmsrv

Where <database name> is tlma for the administration server database andtlmr for the runtime server database.

3. Enter the database password when it is requested.

The following information is returned if the connection succeeds:Database Connection Information

Database server = DB2/6000 7.1.0SQL authorization ID = TLMSRVLocal database alias = <database name>

Where <catalogued name> is tlma for the administration server database and tlmrfor the runtime server database.

If you do not get this result there is a problem with the database or with theconnection between the Tivoli License Manager server and the database. See“Databases” on page 66 for details of the possible reasons for this.

v Check the HTTP server on machines where you have installed a Tivoli LicenseManager server, as follows:1. Open a browser.2. In the Address box, type the host name of the machine where the Tivoli

License Manager server is installed. The HTTP welcome screen should

© Copyright IBM Corp. 2001, 2002 57

Page 74: IBM Tivoli License Manager: System Administrator's Guide

appear.

If this panel does not appear, first check that the host name you typed iscorrect, and if so, check that the HTTP server is running.

v Check the Tivoli License Manager data source on WebSphere, as follows:1. Start the WebSphere administrative console.2. Open Administrative Domain Tree ->Resources->JDBC Providers.3. Find the Tivoli License Manager administration DB2 driver or the Tivoli

License Manager runtime DB2 driver.v Check that the Tivoli License Manager administration or runtime server is

included in the WebSphere list of application servers for the host where it isinstalled and that the application server has been started. To do this, completethe following steps:1. On the WebSphere administration console, open Administrative Domain

Tree ->Nodes-><host name> ->Application servers.

2. Find the entry for IBM Tivoli License Manager Administration Server or IBMTivoli License Manager Runtime Server.

3. If the server has not been started, start it by selecting it and clicking the Playicon on the task bar.

If the server is not included in the list of application servers, the installation orthe WebSphere configuration has failed. Consult the install.log file for details ofthe failure.

If the server has installed successfully but the WebSphere configuration failed,you must manually run the configuration script. See Table 21 on page 64 for alist of the WebSphere configuration scripts for each platform, WebSphereversion, and server type.

If the server fails to start and an exception message informs you that the HTTPtransport port is in use, you need to reconfigure WebSphere to use a differentport. The procedure for resolving this is described in the Common Problemssection of this chapter. See “Servers” on page 64.

58 IBM Tivoli License Manager: System Administrator’s Guide

Page 75: IBM Tivoli License Manager: System Administrator's Guide

v Check that the following have been included in the list of the WebSphere hostaliases:– The host name of the machine where the Tivoli License Manager server is

installed as both a simple host name, for example alpha, and as a fullyqualified name, for example alpha.ibm.com.

– The IP address of the machine where the Tivoli License Manager server isinstalled if this is being used instead of the host name.

Note: If you are not using the default port (80), the port number must beappended to all the aliases, for example, alpha:443.

To check the aliases on WebSphere, complete the following steps:1. On the WebSphere administration console, select Virtual hosts/default_host.2. Click General.

v Check the Tivoli License Manager command line:1. On the administration server machine, open the Tivoli License Manager

command line.2. Type:

expcat

This command should export the master catalog from the administration serverdatabase to the directory: <TLM_INSTALL_DIR>/admin/cli/catalog

If the command fails to extract the catalog, this indicates a failure to access thedatabase, probably caused by a mismatch between the DB2 password enteredduring the server installation and the password defined for the tlmsrv user.

Log files and tracingTivoli License Manager provides information in the form of messages, trace logfiles, event log files, and event notifications. This section includes informationabout the trace files that are available on the administration server, runtimeservers, and agents.

Event notifications are generated in response to licensing events and to TivoliLicense Manager system events, for example, that a server or agent has stopped.Notifications are sent to designated recipients and the events are logged. For moreinformation about the event logging and notification, see Chapter 5, “EventNotification”, on page 41.

For information about messages, see Appendix A, “Messages”, on page 75.

Logging and trace setting on serversOn the administration and runtime servers, Tivoli License Manager logsinformation in the following files:v error-x.log (where x is a number between 0 and 9).

An entry is logged in this file for all exceptions generated by Tivoli LicenseManager.

v time-x.log (where x is a number between 0 and 9).Time stamped entries in this file are logged for all communication services(start/stop).

Chapter 8. Problem Determination 59

Page 76: IBM Tivoli License Manager: System Administrator's Guide

v trace-x.log (where x is a number between 0 and 9). This file includes entries fortrace, debugging and data operation information.

Each file has a maximum size of 1 MB. When the maximum size is reached,logging moves to the next file in sequence. For example, when error-1.log reaches 1MB, error log entries are written to error-2.log and so on.

Log files are created in the following directories on the administration server andall runtime servers:

Administration server<TLM_INSTALL_DIR>\admin\log

Runtime servers<TLM_INSTALL_DIR>\runtime\log

The level of information that is included in log files depends on the trace levelsetting for the server as shown in Table 20.

Table 20. Trace levels and log files

Trace level Description Files

0 error error.log

1 debug trace.x.log

2 trace trace.x.log

3 data trace.x.log

4 time time.log

-1 disabled none

You set the trace level in the traceFilter.properties file. There is a copy of this fileon the administration server and on each runtime server that you install.Therefore, you can set the trace level independently on each server. The location ofthe traceFilter.properties file on the servers is:

Administration server<TLM_INSTALL_DIR>\admin\conf

Runtime servers<TLM_INSTALL_DIR>\runtime\conf

There are two methods that you can use to set the trace level in thetraceFilter.properties file:1. By including the statement:

traceLevel = <number>

where number is the number of the highest trace level to be written. Forexample, the setting:traceLevel = 2

results in the logging of error (trace level 0), debug (trace level 1), and trace(trace level 2) information.

2. By including statements that set an on/off switch for each trace level. Forexample:

60 IBM Tivoli License Manager: System Administrator’s Guide

Page 77: IBM Tivoli License Manager: System Administrator's Guide

error = 0debug = 1trace = 1data = 0time = 0

These statements result in the logging of debug and trace information.

Using this method, you can select higher trace levels without logginginformation at lower levels. This is not possible using the first method.

Note: Disabling tracing using the traceLevel=-1 statement can be overridden byturning the individual trace levels on, for example, the following definitionsresult in disabling of all tracing except error level tracing.traceLevel = -1error = 1

In addition to the statements described here, the traceFilter.properties file includesthe statement:Java.lang.Object = 1

This statement enables tracing within the Java classes. If this line is not present inthe file, no tracing will occur whatever level of trace you set. Ensure that this lineis not removed, and if it is accidentally deleted, edit the file and replace it.

Using the statusinfo command to collect error informationThe statusinfo command provides a way of collecting the trace files, configurationfiles, and database debug tables that can help customer support to resolveproblems on the Tivoli License Manager servers. You can forward this informationto the support team.

The command creates the directory <TLM_INSTALL_DIR>/admin/cli/adminStatusor <TLM_INSTALL_DIR>/runtime/cli/runtimeStatus with the following contents:v information.txt: a file that contains general information and the date and time at

which the information was gathered.v configuration: a folder that contains the configuration files for the server. This is

is a copy of the server conf folderv traceLogs: a folder that contains the trace files for the server. This is a copy of

the server log folder.v dbData: a folder that contains the .dat files exported from the DB2 database.v wasLogs: a folder that contains any WebSphere logs found in the

<TLM_INSTALL_DIR>/admin/was or <TLM_INSTALL_DIR>/runtime/wasfolder

Logging and trace setting on the agentTrace settings for the agent include settings that enable tracing during deploymentand during operation.

Deployment and installation tracingAgent deployment comprises two phases: the downloading of agent files to thetarget machine and the execution of the installagent program on the targetmachine.

In the download phase, Tivoli License Manager can send debug information to theJava console. To identify problems in this phase, do the following:

Chapter 8. Problem Determination 61

Page 78: IBM Tivoli License Manager: System Administrator's Guide

1. On the runtime server from which you intend to deploy the agent, open theagent_install.properties file and set the property parm.debug to true.The agent_install.properties file is located in the directory:<TLM_INSTALL_DIR>/runtime/conf

2. Open your internet browser and enable the Java Console.

Note: You may need to restart the browser.3. Deploy the agent on the target machine.4. Check the Java Console for any exceptions that have been generated.

The log file for agent installation process that follows the download is tlmia.trc. Bydefault, tracing of the agent deployment is turned off and the file is not produced.If you are encountering problems, you can turn on the trace. The trace setting isdefined at runtime level in the agent_install.properties file.

The property that turns tracing on or off is called parm.trace. The default value ofthe is n. To enable tracing of the deployment you must edit this file and changethe value of parm.trace to y.

Agent operation tracingThe log file that is maintained during the operation of the agent is traceagt.log.

By default, only error conditions are logged to this file. If you are experiencingproblems and you need a more detailed trace to send to support, you must set thetrace_level property in the tlmagent.ini file to 2.

The locations of the traceagt.log file and the tlmagent.ini file depend on the agentplatform. See “Agent files” on page 38.

PerformanceThe performance of Tivoli License Manager depends on the following factors:v Network trafficv Database sizev Disk spacev System processesv WebSphere settingsv The HTTP configuration

Network trafficThe control of network traffic and the prevention of periodic surges of activitymust be your objectives when you set up your monitoring infrastructure anddefine configuration settings for your Tivoli License Manager servers

Chapter 1, “Planning a Tivoli License Manager Implementation”, on page 1provides some guidelines for designing your monitoring infrastructure. Defaultconfiguration settings are provided and you do not need to change these. If youwish to make changes, do so with care and ensure that your changes do notunnecessarily increase the load on the network. For example, do not reduceperiods between uploads or downloads of data too much. For information aboutconfiguration settings, see Appendix B, “Configuration Settings”, on page 83.

62 IBM Tivoli License Manager: System Administrator’s Guide

Page 79: IBM Tivoli License Manager: System Administrator's Guide

If you have installed a database on a separate machine from its associated TivoliLicense Manager server, database accesses can become a bottleneck. To minimizethis, ensure that there is a high-speed connection between the database and servermachines.

Database sizeThe performance of the administration server Web interface will be reduced if tablesizes in the administration database become too large. Most of the database tablesare reasonably static as they include information that the administrator defines.However, the USAGE and SERVICE tables are continually updated by internalprocesses. A reduction in performance of the software usage reports is a symptomof a too large USAGE table.

Clean-up processes are provided for these tables and should be scheduled to run atintervals that are suitable to the size of your Tivoli License Managerimplementation. For more information, see Chapter 7, “Database Table Clean-up”,on page 55.

Disk SpaceThe administration and runtime servers each require a minimum of 50MB space onAIX and 100 MB space on Windows for storing logs, trace files, and configurationinformation. The associated DB2 databases require considerably more space. Therequirements depend mainly on the number of agents supported. You shouldperform regular checks on the amount of free space on the machines where theTivoli License Manager and DB2 servers are installed.

System processesThe administration and runtime servers run on top of the WebSphere applicationserver. They all run into different Java Virtual Machines. You should keep track ofsystem resource usage in particular memory and I/O , especially on heavily loadedmachines. To check the use of resources by the Tivoli License Manager servers, youwill need their process IDs. You can obtain the process ID for a server by clickingit on the WebSphere administrative console.

WebSphere settingsThere are two related values that can be set the WebSphere console for each server:initial and maximum Java heap sizes. The initial Java heap size sets the amount ofmemory that is initially reserved for the application, while the maximum Java heapsize determines the largest amount of memory the application will be allowed toconsume.

If a runtime server has more than 5 000 agents deployed, you need to increase thedefault value for the initial Java heap size setting to maintain performance.

To change the Java heap size settings for a runtime server, complete the followingsteps:1. On the WebSphere administrative console, select the runtime server for which

you want to change settings.2. Click the JVM settings tab.3. Change Initial Java heap size to 256.

Chapter 8. Problem Determination 63

Page 80: IBM Tivoli License Manager: System Administrator's Guide

HTTP configurationPerformance of runtime servers responding to multiple concurrent requests will beunsatisfactory if the HTTP configuration setting for the default size of thread poolis too low.

In the httpd.conf file, ensure that the parameter that controls this is set to at least150. The name of the parameter is:

WindowsThreadsperchild

AIXMaxClients

The location of the file is IBM HTTP Server/conf

Common ProblemsThis section provides a listing of some common problems, their symptoms andsolutions.

Servers1.

Symptom: A Tivoli License Manager server is missing from the WebSpherelist of application servers.

When you try to start a Tivoli License Manager server from the WebSphereadministration console, it is not present in the list of application servers.

Possible causes and solutionsThe WebSphere configuration process that is a part of the Tivoli LicenseManager installation wizard has failed. This is probably because WebSpherewas not running when the wizard tried to perform the configuration.

You must manually run the WebSphere configuration script that is usuallycalled by the installation wizard. Table 21 shows the configuration scriptsfor each combination of platform, WebSphere version, and server type.

Table 21. WebSphere configuration scripts

PlatformWebSphereversion Server Script

AIX 3.5.6 administration <TLM_INSTALL_DIR>/admin/setup/WASConfig.sh

AIX 3.5.6 runtime <TLM_INSTALL_DIR>/runtime/setup/WASConfig.sh

AIX 4.0.4 administration <TLM_INSTALL_DIR>/admin/setup/SetupAdmin.sh

AIX 4.0.4 runtime <TLM_INSTALL_DIR>/runtime/setup/SetupRuntime.sh

Windows 3.5.6 administration <TLM_INSTALL_DIR>\admin\setup\WASConfig.bat

Windows 3.5.6 runtime <TLM_INSTALL_DIR>\runtime\setup\WASConfig.bat

Windows 4.0.4 administration <TLM_INSTALL_DIR>\admin\setup\SetupAdmin.bat

Windows 4.0.4 runtime <TLM_INSTALL_DIR>\runtime\setup\SetupRuntime.bat

2.

Symptom: The HTTP port is already in use.An exception occurs on the WebSphere administrative console when you

64 IBM Tivoli License Manager: System Administrator’s Guide

Page 81: IBM Tivoli License Manager: System Administrator's Guide

try to start a Tivoli License Manager server that you have installed. Theexception reports that the HTTP transport port is already in use.

Cause and solutionThis occurs because the Tivoli License Manager script for configuringWebSphere specifies a port that is already in use by a WebSphereapplication server. To resolve this problem you must complete thefollowing steps:a. Find out which port numbers are in use, by using the following

command:

Windowsnetstat -an

AIXnetstat -an |grep LISTEN

Check the list of ports to see if port 9087 or 9088 is available.b. Open the script file.

See Table 21 on page 64 for information about the correct WebSphereconfiguration script to use.

c. Change the port parameter to a port number that is not in use.d. From the setup directory, run the deleteAdmin or deleteRuntime script.e. From the setup directory, run the appropriate WebSphere configuration

script.3.

Symptom: A runtime server does not plug in.Following registration of a runtime server, it does not plug in to theadministration server.

Possible causes and solutionsThe reason or reasons for failure are recorded in the event.log file for theadministration server, which is stored at the following location:<TLM_INSTALL_DIR>\admin\log

This problem is typically caused by a misconfiguration, either duringinstallation or during registration of the server on the administration server.As follows:v The administration server address was specified during installation was

incorrect.v There is a mismatch between the values entered at installation and at

registration for customer name, runtime server name, or runtime serverpassword.

If the administration server address has been incorrectly specified, youmust change it in the scp.properties file for the runtime server which isstored in the following location: <TLM_INSTALL_DIR>\runtime\conf.

If the problem is the customer or runtime server name, check theregistration details of the server, if the values are incorrect, they can bechanged there. If not, you must change the installation values by editingthe scp.properties file for the runtime server.

If the passwords do not match, you must align the passwords by changingthe password in the registration details to align it with the value specifiedat installation.

Chapter 8. Problem Determination 65

Page 82: IBM Tivoli License Manager: System Administrator's Guide

4.

Symptom: A runtime server is no longer plugged in.A runtime server that has previously plugged in to the administrationserver fails to plug in when the server has been stopped and restarted.

Possible causes and solutionsThis failure is caused by a mismatch between the server ID passed by theruntime server to the administration server and the ID that theadministration server has stored in its database. This can happen in thefollowing circumstances:v The runtime server administrator has manually transferred the server to

a different customer without dropping the runtime server database.v The runtime server has been deleted from the administration server

database and then reregistered.

In both cases, the runtime server has changed its identity making all thedata stored in its database invalid. You must stop the runtime server, dropthe runtime server database, create a new database and restart the server.See “Creating a DB2 database for Tivoli License Manager” on page 19.

5.

Symptom: The srvstart command does not start a server .You run the srvstart command from the command line on an AIX machinewhere a Tivoli License Manager server is installed, but the server does notstart.

Possible causes and solutionsThis failure is probably the result of a known problem with WebSphere3.5.x on AIX. You need to clear the working directory on the administrationconsole for the Tivoli License Manager server.

Databases1.

Symptom: Server Web interface cannot connect to the database.After logging on to the Web interface, an error message indicating adatabase technical error appears.

Possible causes and solutions

v DB2 services were not running during the installation process or werestarted after WebSphere started. Restarting DB2 and WebSphere shouldsolve this problem.

v The script has not been run to create and populate the database. Run thescript. See “Creating a DB2 database for Tivoli License Manager” onpage 19

v The connection between the Tivoli License Manager server and thedatabase was not established. “Connecting a database to a Tivoli LicenseManager server on a Windows machine” on page 22 or “Connecting adatabase to a Tivoli License Manager server on an AIX machine” onpage 22.

Note: If the server is on an AIX machine, you must make the connectionbetween the database and server even if they are on the samemachine.

v The wrong value has been used for the database name in thedb.properties file. See “The db.properties file” on page 89.

66 IBM Tivoli License Manager: System Administrator’s Guide

Page 83: IBM Tivoli License Manager: System Administrator's Guide

v The password held in the passwd.properties file does not match thepassword for the tlmsrv user. You can change the tlmsrv password usingthe utility for changing user passwords on your operating system or youcan change the password held in the passwd.properties file, using thecommand dbpasswd. See“dbpasswd” on page 32.

2.

Symptom: Data is missing from historical reports.Updated information is missing from the software usage and inventoryreports on the administration server.

Possible causes and solutionsThis problem could be caused by a runtime server stopping or by a failureof communication between runtime server databases and theadministration server database.v If the runtime server has stopped, the administrator will have received

an event notification and the event will be logged in the event log. Youcan restart the server either using the WebSphere administrator’s consoleor by issuing the srvstart command from the Tivoli License Managercommand line. See Chapter 3, “The Command Line Interface”, onpage 31.

v If the runtime server has only recently been installed, the problem maybe caused by mistakes made during the installation and configuration ofthe runtime server database. This requires the same checks and actions asdescribed for the previous problem where the administration serverdatabase could not be accessed by the administration server Webinterface. See item 1 in this section.

v If there has previously been successful communication between thedatabases and if the problem affects data from all runtime servers, theproblem is probably caused by a data mismatch following the re-creationor restoration of the administration server database.To resolve this problem, you must drop all runtime server databases andrecreate them. See “Creating a DB2 database for Tivoli License Manager”on page 19.

To avoid this situation, make back-ups of the administration and runtimeserver databases at the same time and restore all databases if theadministration server database needs to be restored.

Note: You must stop servers before performing the back-up or restoreand then restart them when the operation is complete.

Agent deployment1.

Symptom: The install agent applet is not foundWhen you open the deployment Web page, a message appears in thestatus bar indicating that the slmInstallagent applet cannot be found orcannot start.

Possible causes and solutionsThe applet is corrupt. This can occur if you install the runtime server on amachine that has WebSphere 4.0.x without fixpack 4. You must apply thefixpack and reinstall the server.

2.

Chapter 8. Problem Determination 67

Page 84: IBM Tivoli License Manager: System Administrator's Guide

Symptom: agent deployment process hangs.The Registration in progress message appears and after a reasonablelength of time there is no message indicating success or failure. When youcheck the Java Console, an exception is reported:

Java.io.exception. No space left on device.

Possible causes and solutionsThis problem occurs when there is insufficient space for the temporarystorage of agent files. At least 10 MB of free space is required in thedirectory used by the browser for temporary storage of downloaded files.On UNIX platforms, this directory is /tmp. On Windows platforms, thedirectory depends on the Internet browser being used.

You may need to increase the size of the file systems where the browser isinstalled.

3.

Symptom: agent files cannot be downloaded.Agent deployment fails with the message:

An error occurred downloading file:path/filename. The destinationdirectory directory might be full.

Possible causes and solutionsThis problem occurs when there is insufficient space for the agent files.

There must be at least 10 MB of free space in the agent installationdirectory where the files are permanently located. You may need toincrease the size of the file systems where the agent files will be installed.

For information about the locations in which agent files are installed ondifferent platforms, see “Agent files” on page 38.

4.

Symptom: agent files cannot be downloaded.Agent deployment fails with the message:

Connection was reset by peer.

Possible causes and solutionsThis is a network connectivity problem that can be caused by anunusually high amount of traffic or by a server error. Wait for a short timeand then retry the operation. If the problem persists, report the problem tothe system administrator. You could try deploying the agent from adifferent server.

5.

Symptom: deployment is denied.Agent deployment fails with the message:

You are not logged on with administrative/root rights. You are notallowed to register the Tivoli License Manager agent.

Possible causes and solutionsOnly users with administrator (Windows) or root (UNIX) rights areallowed to deploy the agent on a machine.

Log on as Administrator or root and try again.6.

Symptom: deployment fails with a file error.Agent deployment fails with the message:

68 IBM Tivoli License Manager: System Administrator’s Guide

Page 85: IBM Tivoli License Manager: System Administrator's Guide

An error verifying the file: filename. It might be corrupted.

Possible causes and solutionsThis is probably caused by server or network problems that interruptedthe transmission of the file from the server to the node.

Retry the deployment. If the problem persists, the copy of the agent fileheld on the runtime server might be corrupt.

Try deploying the agent from a different runtime server. If this works, it islikely that the problem is a corrupt file or files on the original runtimeserver. To resolve this problem, copy all of the agent directories andsubdirectories from the runtime server that deployed the agentsuccessfully to the runtime server where the files are probably corrupt.

7.

Symptom: deployment fails with internal errorAgent deployment fails with the message:

Some problems occurred. You are not registered. Internal error.

Possible causes and solutionsThis is probably caused by problems with the browser JVM. Check thatyou are using a level of browser that is compatible with deploying theTivoli License Manager agent. See “Prerequisites” on page 9.

Netscape on AIX made need to be updated or patched because of knownproblems. Refer to http://aix.software.ibm.com/aix/efixes/net.

8.

Symptom: deployment fails because of unsupported operating system.Agent deployment fails with the message:

Your operating system is not yet supported.

Possible causes and solutionsThere is no agent for the platform you are trying to deploy to. For moreinformation, see “Supported platforms” on page 9.

9.

Symptom: deployment fails because the applet certificate was not accepted.Agent deployment fails with the message:

The registration failed because you may not have accepted the Appletcertificate.

Possible causes and solutionsIf you did not accept the certificate, retry the deployment accepting thecertificate when the dialog appears.

If you did accept the certificate, this could mean that the applet file iscorrupt. This can occur if you install the runtime server on a machine thathas WebSphere 4.0.x without fixpack 4. You must apply the fixpack andreinstall the server.

10.

Symptom: No status is returned to the runtime server.No acknowledgement of success or failure is displayed. The followingmessage appears:

Some problems occurred while sending the Agent Installation status backto the runtime server.

Chapter 8. Problem Determination 69

Page 86: IBM Tivoli License Manager: System Administrator's Guide

Possible causes and solutionsCheck that the agent has been installed on the node.

On Windows, you can open the Services panel from the Control panel andcheck for IBM Tivoli License Manager Agent.

On UNIX, enter the following command: If the agent is running aresponse is returned. If it is not, there is no response.

ps -ef | grep tlmagent

11.

Symptom: The installagent program returns a failure return code.The following message is returned by the installagent program:

An error occurred registering Tivoli License Manager Agent. Return code:number.

Possible causes and solutionsTable 22 lists the possible causes and solutions for each return code thatcan be included in the message. If the problem persists, you can get moreinformation by enabling agent deployment tracing. See “Deployment andinstallation tracing” on page 61.

Table 22. Installagent return codes

Return code Possible cause Solution

-1 v Invalid character in the computer labelparameter.

v Invalid character in the customer or servername.

v The agent_install.properties file on the serveris corrupt or wrongly modified.

v Check your input for computer label.

v Check the customer and server names in thescp.properties file for the server.

v Check the agent_install.properties file.

-2 The Windows environment variable%WINDIR% does not exist.

Check:

My Computer ->Properties ->Advanced->Environment.

-3 v The agent ID cannot be created because of amisconfiguration of the host name/DNS onthe system.

v The agent configuration file could not bewritten.

v Check the host name, domain name, and DNSconfiguration.

v Check the disk and file systems where theagent configuration files should be installed.See “Agent files” on page 38.

-4 The main agent file could not be installed. Check the disk and file systems where the agentfile should be installed. See “Agent files” onpage 38.

-5 The agent kernel extension files could not beinstalled.

Check the disk and file systems where the agentkernel files should be installed. See “Agent files”on page 38.

-6 The agent kernel extension could not beinstalled. (AIX and Sun only).

Check the disk and file systems where the agentconfiguration files should be installed. See“Agent files” on page 38

-8 The agent failed to start. Check the system and try to start the agent.

-11 The agent kernel extension configuration filecould not be installed. (AIX and Sun only).

Check the disk and file systems where the agentconfiguration files should be installed. See“Agent files” on page 38

70 IBM Tivoli License Manager: System Administrator’s Guide

Page 87: IBM Tivoli License Manager: System Administrator's Guide

Table 22. Installagent return codes (continued)

Return code Possible cause Solution

-12 The agent configuration file could not beinstalled.

Check the disk and file systems where the agentconfiguration files should be installed. See“Agent files” on page 38

-13 The agent uninstall script could not beinstalled.

Check the disk and file systems where the agentuninstall script should be installed. See “Agentfiles” on page 38

-15 Linux distribution is not supported. Check the supported platforms. See the IBMTivoli License Manager: Release Notes.

Agent operation1.

Symptom: The agent does not start automatically.After deployment on a Windows platform, the agent does not start.

Possible causes and solutionsThis problem occurs when the Windows Services panel is open when thedeployment is performed. If the service IBM TLM agent is present butrunning, you can start it manually by selecting it in the Windows servicepanel and clicking Start or from the command line as follows:

%windir%\itlm\tlmagent -g If the service is not present, you must use thefollowing commands to register it and then start it:

%windir%\itlm\tlmagent -i

%windir%\itlm\tlmagent -g

2.

Symptom: The agent cannot be stopped.The agent running on a UNIX platform cannot be stopped.

Possible causes and solutionsThis occurs if you try to stop the agent when the traceagt.log file is open.

Close the file and try again.3.

Symptom: After deployment, the agent does not appear in the agent reportThe agent has been deployed successfully. The agent files are on the targetmachine and the agent is running but the agent is not included in the agentreport or in the lists of agents for the server and division to which it isassigned.

Possible causes and solutionsThis problem occurs in the unusual situation that a monitored machinechanges from one customer to another. For example, if the decision hasbeen made to divide a large enterprise into two or more customers.

When the agent is deployed from a runtime server assigned to the firstcustomer, an agent record for this customer is created in the administrationserver database. When the agent is redeployed from a runtime serverassigned to the second customer, a new record for the agent under thesecond customer cannot be created while the original record exists. Thismeans that though the agent is in contact with its runtime server and is

Chapter 8. Problem Determination 71

Page 88: IBM Tivoli License Manager: System Administrator's Guide

sending information to the server, the runtime server cannot transmit thisinformation to the administration serer because of the database mismatch.

To resolve this problem do the following:a. Log on to the administration server Web interface and select the original

customer.b. From the Topology task group, select Agent.c. Select the agent record for the node that has been moved to a new

customer.d. Delete the agent record.

User Interface1.

Symptom: A technical error is produced by the first action after log on.After logging on, when you attempt to perform your first action, forexample, selecting the customer, a technical error is generated..

Possible causes and solutionsThis problem occurs when the browser is not enabled for JavaScript.Change the browser setting to enable JavaScript and try again..

2.

Symptom: Additional windows do not open automatically.Every time an additional window is required, for example, when you logon or when you click the help icon, you are prompted to confirm that itshould open.

Possible causes and solutionsThis occurs if you have software activated to prevent pop-ups openingautomatically. If you want to avoid the confirmation step each time TivoliLicense Manager needs to open a supplementary window, you must disablethis software.

3.

Symptom: Problems displaying a chart.The Web interface cannot display the Software Usage Trend Analysis chart.

Possible causes and solutionsThis problem can occur when the administration server is installed on anAIX platform and there is no access to an X Display server. You mustensure that the administration server has access to an X Display server. SeeAppendix E, “Connecting to an X Display Server”, on page 99.

4.

Symptom: problems displaying report pages.Software usage and inventory reports do not display correctly the first timethe report page is displayed. The report is often positioned wrongly on thereport or only a part of the expected information is shown.

Possible causes and solutionsThis is caused by a known problem with Internet Explorer 5.5. which isresolved with Internet Explorer 6.0. Refreshing the page using the Refreshicon on the Web interface toolbar corrects this display problem.

72 IBM Tivoli License Manager: System Administrator’s Guide

Page 89: IBM Tivoli License Manager: System Administrator's Guide

Contacting Tivoli SupportIf you need to contact Tivoli support to resolve a problem, you can make theprocess more efficient by doing the following before contacting support:v Producing a clear description of the problem, including the symptoms and any

error output that was associated with the problem. You can use the statusinfocommand to assemble log and configuration information. See “Using thestatusinfo command to collect error information” on page 61.

v Collect information about the operating environment: the hardware platform, theoperating system version, the versions of any prerequisite software products.

v Determine how the problem affects you ability to meet your business needs.v Ensure that you have your IBM Passport Advantage or Tivoli Customer ID.v Provide contact information.

Chapter 8. Problem Determination 73

Page 90: IBM Tivoli License Manager: System Administrator's Guide

74 IBM Tivoli License Manager: System Administrator’s Guide

Page 91: IBM Tivoli License Manager: System Administrator's Guide

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

© Copyright IBM Corp. 2001, 2002 75

Page 92: IBM Tivoli License Manager: System Administrator's Guide

Message DetailsTable 24 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 23 on page 75.

Table 24. 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 orsession timeout. Please log onagain.

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

Parameters0 = User ID

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

Parameters0 = user ID

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

Parameters0 = User ID

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.

Parameters0 = file name

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

Parameters0 = file name

2

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

2

76 IBM Tivoli License Manager: System Administrator’s Guide

Page 93: IBM Tivoli License Manager: System Administrator's Guide

Table 24. Tivoli License Manager messages (continued)

Errorcode

External message text andparameters

Internal message text andparameters 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 77

Page 94: IBM Tivoli License Manager: System Administrator's Guide

Table 24. Tivoli License Manager messages (continued)

Errorcode

External message text andparameters

Internal message text andparameters 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

78 IBM Tivoli License Manager: System Administrator’s Guide

Page 95: IBM Tivoli License Manager: System Administrator's Guide

Table 24. Tivoli License Manager messages (continued)

Errorcode

External message text andparameters

Internal message text andparameters Category

9905 One or more illegal dateshave been entered.

User {0} entered one or more illegaldates.

Parameters0 = User ID

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

Appendix A. Messages 79

Page 96: IBM Tivoli License Manager: System Administrator's Guide

Table 24. Tivoli License Manager messages (continued)

Errorcode

External message text andparameters

Internal message text andparameters 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).

Parameters0 = file name

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.

Parameters0 = XSL file name

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

Parameters0 = XSL file name

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

80 IBM Tivoli License Manager: System Administrator’s Guide

Page 97: IBM Tivoli License Manager: System Administrator's Guide

Table 24. Tivoli License Manager messages (continued)

Errorcode

External message text andparameters

Internal message text andparameters Category

9951 Technical error: The operationcontext is not defined.

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

Parameters0 = user ID

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

Parameters0 = user ID

1 = name of operation

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

Parameters0 = user ID

1 = name of operation 2 = nameof context

1

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

Parameters0 = user ID

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

Parameters0 = user ID

1

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

Parameters0 = user ID

1 = name of context

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

Parameters0 = user ID

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 A. Messages 81

Page 98: IBM Tivoli License Manager: System Administrator's Guide

82 IBM Tivoli License Manager: System Administrator’s Guide

Page 99: IBM Tivoli License Manager: System Administrator's Guide

Appendix B. Configuration Settings

This appendix provides information about the configuration files maintained foreach Tivoli License Manager server and how you can use some of them to tuneTivoli License Manager to suit your needs. It includes the following information:v A summary of the configuration files that are installed for each Tivoli License

Manager server. See “Tivoli License Manager configuration files”.v A detailed description of the main server configuration file, the

system.properties file. See “The system.properties file” on page 84.v A detailed description of the configuration file for the DB2 database that is

associated with a Tivoli License Manager server. See “The db.properties file” onpage 89.

v Instructions about configuring proxy settings for communications between aruntime server and the administration server and between a runtime server andits agents. See “Configuring proxies” on page 90.

Tivoli License Manager configuration filesConfiguration files are installed in the following location:

administration server<TLM_INSTALL_DIR>\admin\conf

runtime server<TLM_INSTALL_DIR>\runtime\conf

Table 25 provides a summary of the Tivoli License Manager configuration files thatare installed for each server.

Table 25. Configuration files for Tivoli License Manager servers

File Usage

agent_install.properties Contains the information required to download and install agents from theruntime server. Settings for debugging and tracing deployment are described in“Deployment and installation tracing” on page 61. Settings for proxycommunications between the runtime server and agents are described in“Configuring proxies” on page 90.

You should not change any other properties in this file.

csvPlugins.properties For future use.

db.properties Defines settings that control the communications between a server and itsassociated DB2 database. See “The db.properties file” on page 89.

help.properties Maps each help topic to the associated Web interface dialog. You should notedit this file.

locales.properties Defines localization information. You should not edit this file.

password.properties Contains the encrypted values for passwords. You must not edit this file. If youneed to change a password, you should use the appropriate command. SeeChapter 3, “The Command Line Interface”, on page 31.

© Copyright IBM Corp. 2001, 2002 83

Page 100: IBM Tivoli License Manager: System Administrator's Guide

Table 25. Configuration files for Tivoli License Manager servers (continued)

File Usage

scp.properties Contains the server and customer names specified when the runtime server wasinstalled, and the address at which the runtime server contacts theadministration server. If any of these values are entered wrongly at installation,you can edit the values in this file.

You can define a proxy address for the administration server. See “Configuringproxies” on page 90.

scp.services.properties Defines service handling for client and server tasks. You should not edit thisfile.

slmInitFile.properties Contains the base installation path for the server, the installation path forconfiguration files, and the installation path for log files. You should not editthis file.

stylesheets.properties Maps each Web interface dialog to a stylesheet. You should not edit this file.

system.properties See “The system.properties file”.

traceFilters.properties Defines the level of trace for the server. See “Logging and trace setting onservers” on page 59.

The system.properties fileA system.properties file is installed on the administration server and on eachruntime server. The system.properties file has the following sections:v Web interface settings.

These settings affect the behavior of the Web interfaces on the administrationand runtime servers. Most settings in this section should not be changed. See“Web Interface settings” for those that can be changed.

v Administration server settings.The settings in this section are relevant only to the system.properties file thatresides on the administration server. See “Administration server settings” onpage 85.

v Runtime server settings. These settings affect the behavior of the runtime server,for example, the time delays used between repeats of a task. Each runtime serverhas its own system.properties file, so settings can be different for each server.See “Runtime server settings” on page 86.

v Agent settings.The agent settings that are defined in the system.properties file located on aruntime server are effective for all the agents that are registered with that server.Agent settings are downloaded from the runtime server to the agent at definedintervals. See “Agent settings” on page 87.

v E-mail configuration settings.These settings enable the sending of event notifications that are generated on theserver. See “E-Mail configuration settings” on page 88.

Note: The Web interface settings must not be changed. Make changes to the othersections with caution.

Web Interface settingsTable 26 on page 85 shows properties defined in the Web interface section of thesystem.properties file that you may need to change. You should not change anyother setting in this section of the configuration file.

84 IBM Tivoli License Manager: System Administrator’s Guide

Page 101: IBM Tivoli License Manager: System Administrator's Guide

Table 26. Web interface parameters in the system.properties file

Parameter Default Description

requestOldPassword false Controls whether the Change Password dialog includes afield requesting the current password.

hideInternalErrorMessage true Controls which components of error information messageswill be displayed. See Appendix A, “Messages”, onpage 75.

maxSelectionListLength 5 000 Defines the maximum number of agents, nodes, or usersthat can be displayed in a list box on the Web Interface.Increasing this value can cause decreased performance ofthe Web interface.

Administration server settingsTable 27 shows the properties defined in the administration server settings sectionof the system.properties file.

Table 27. Administration server parameters in the system.properties file

Parameter Default Description

hwmScanPeriod 240 minutes Length of time between checks on the level of licenseusage. Notifications are generated if usage levels reach themaximum or a defined threshold.

cleanUsagePeriod true The number of days between clean-ups of the Usagedatabase table.

cleanUsageEnabled 1 day Possible values are:

true The Usage table clean-up runs at the intervaldefined by cleanUsagePeriod.

false The Usage table clean-up does not run.

maxUsageAge 30 days The number of days that software usage data should beretained in the Usage database table. Once data is olderthan the specified number of days, it is cleared by theregular clean-up process.

adminWakeUpEnabled true Possible values are:

true Checks for changes on the administration serverare made at as defined by adminWakeUpPeriod.

false Checks for changes on the administration serverare not made.

adminWakeUpPeriod 15 minutes Length of time between checks for changes in license pooland entitlement information. If there have been changes,the administration server calls the runtime servers totrigger an update.

cleanServiceEnabled true Possible values are:

true The Service table clean-up runs at the intervaldefined by cleanServicePeriod.

false The Service table clean-up does not run.

cleanServicePeriod 6 hours The number of hours between clean-ups of the Servicedatabase table.

Appendix B. Configuration Settings 85

Page 102: IBM Tivoli License Manager: System Administrator's Guide

Table 27. Administration server parameters in the system.properties file (continued)

Parameter Default Description

maxServiceAge 7 days The number of days that data should be retained in theService database table. Once data is older than thespecified number of days, it is cleared by the regularclean-up process.

Runtime server settingsTable 28 shows the properties defined in the runtime server settings section of thesystem.properties file.

Table 28. Runtime server parameters in the system.properties file

Parameter Default Description

defaultCapacityType 0 The capacity type that is used to meter software usage forproducts that do not have user-defined license pools.Possible values are:0 = Users1 = Memory2 = Online processors3 = Configured processors4 = Disks

defaultMultiInstance 0 The setting to be used for the multi-instance rule indefault license pools. Possible values are:0 = No multi-instance licenses1 = Allowed for the same user and agent2 = Allowed for the same user group and agent3 = Allowed for the same node and agent

runtimePluginPeriod 60 minutes Length of time between attempts to plug the runtimeserver to the administration server.

inventoryUpdatePeriod 350 minutes Length of time that the server waits between checks forinventory scans to update. When the scans arrive from theagents, they are stored until the next update time.

cacheUpdatePeriod 355 minutes Length of time between updates of the runtime catalog. Atan interval defined by this property, the runtime serverprocesses the unknown file information that has arrivedfrom the agents since the last update and determineswhich can be added to the runtime catalog.

adminDownloadPeriod 360 minutes Length of time that the server waits between downloadsof updated license, catalog, and topology information fromthe administration server.

adminUploadPeriod 365 minutes Length of time that the server waits between uploads ofsoftware inventory and agent information to theadministration server.

licenseCleanUpPeriod 370 minutes Length of time that the server waits between checks onlicense confirmations sent by agents. If the server does notfind a confirmation that a license is still in use, it releasesit even if no specific release request has been received.

usageSnapshotPeriod 375 minutes Length of time between uploads of software usagesnapshots to the administration server.

Snapshots are sent periodically to enable repair of theusage history if any software usage information is lost.

This property should not be set to less than 120 minutes.

86 IBM Tivoli License Manager: System Administrator’s Guide

Page 103: IBM Tivoli License Manager: System Administrator's Guide

Table 28. Runtime server parameters in the system.properties file (continued)

Parameter Default Description

maxAgentInactivity 10 080 minutes The maximum time that an agent can be not respondingbefore it is considered inactive. This period must not belower than the downloadParametersPeriod defined in theagents settings section of this file.

uploadUsageEvents true Possible values are:

true The runtime server continually sends licenseassignment and release information to theadministration server. In addition, snapshots ofcurrent usage are made at intervals defined bythe usageSnapshotPeriod property and sent to theadministration server.

false The usage snapshots are the only usageinformation sent to the administration server.

Setting this property to false will improveperformance by reducing network activity at thecost of a significant reduction in the accuracy anddetail of software usage information.

Agent settingsTable 29 shows the properties defined in the agent settings section of thesystem.properties file.

Table 29. Agent parameters in the system.properties file

Parameter Default Description

pcInventoryDuration 120 seconds The time that it is likely to take for an inventory scan ofa single Windows node to be sent to the runtime server.

serverInventoryDuration 600 seconds The time that it is likely to take for an inventory scan ofa single UNIX node to be sent to the runtime server.

inventoryFilesPerPacket 25 The maximum number of entries per packet in aninventory scan.

The entries in an inventory scan are divided into packetsfor transmission to the runtime server. Once the definedmaximum is reached, the packet is sent and a new packetis started.

packetDelayThreshold 5 The maximum number of seconds normally required tosend an inventory packet to the server. If no responsefrom the server has been received within this time, theserver is probably busy and a delay in sending furtherpackets is applied to reduce traffic.

The length of the delay is calculated by taking thenumber of seconds by which this threshold is exceededand multiplying it by the packetDelayEscalation value.For example, if the default values are in use, and theresponse is received after 50 seconds, the agent willcalculate (50-30)*1 and so wait 20 seconds before sendingthe next packet.

packetDelayEscalation 30 seconds A factor used in calculating a delay to be applied whensending inventory packets. See the description of thepacketDelayThreshold property.

Appendix B. Configuration Settings 87

Page 104: IBM Tivoli License Manager: System Administrator's Guide

Table 29. Agent parameters in the system.properties file (continued)

Parameter Default Description

inventoryResendTimes 1 The maximum number of times that the agent should tryto send an inventory packet. If this number of sends isreached without success, the packet is not sent, and theinventory scan fails.

requestScope 2 Controls the runtime servers that an agent can contact.Possible values are:

0 Only the server with which the agent isregistered

1 Any server that serves agents in the agent’sdivision.

2 All runtime servers registered for the customer.

checkPeriod 10 800 seconds Length of time between checks by the agent on licensesthat have been granted. If a license is no longer in use,the agent releases it. If the license is in use, the agentsends a confirmation to the runtime server.

pingPeriod 3 600 seconds Length of time that the agent waits between checks of theconnection to its runtime server.

downloadParametersPeriod 86 400 seconds Length of time between downloads of the agentparameters from the system.properties file on the runtimeserver.

downloadCatalogPeriod 86 400 seconds Length of time between downloads of the runtimecatalog from the runtime server.

downloadTopologyPeriod 86 400 seconds Length of time between downloads from the runtimeserver of information about Tivoli License Managerinfrastructure.

uploadMinTime 10 800 seconds Length of time between uploads of unknown fileinformation from the agent to the runtime server.

updateAgentEnabled No Indicates whether self-updating by agents is enabled.

If this parameter is set to Yes, the agent regularly checksthe runtime server for a new version of the agent and ifit finds one, it automatically triggers deployment usingthe server and division of the current deployment.

updateAgentPeriod 604 800 seconds Length of time between checks for the presence of a newversion of the agent on the runtime server.

E-Mail configuration settingsTable 30 on page 89 shows the properties defined in the e-mail configurationsettings section of the system.properties file. The settings relate to notificationsgenerated on the server where the system.properties file is located. On theadministration server, notifications relate to license events. On the runtime servers,notifications are generated in response to changes in server or agent status and tothe completion of inventory scans. For more information about notifications, seeChapter 5, “Event Notification”, on page 41.

88 IBM Tivoli License Manager: System Administrator’s Guide

Page 105: IBM Tivoli License Manager: System Administrator's Guide

Table 30. E-mail configuration parameters in the system.properties file

Parameter Default Description

smtpServer The host name or IP address of a valid SMTP server.

The text must include only US ASCII characters.

mailEngine internal The mail engine to be used for sending notifications.

mailSender The e-mail address that is to be used by the server as thesender address when notifications are generated.

The text must include only US ASCII characters.

mailRecipient An e-mail address to which notifications should be sent.

This is optional. Tivoli License Manager administrators arethe normal recipients of notifications, and you can specifythis when you create an administrator record using theWeb interfaces.

mailReload 1440 minutes Length of time that the server waits between reloads ofe-mail address information.

The db.properties fileThe properties defined in the db.properties file control the communicationsbetween a server and its associated DB2 database. Several of the properties mustnot be changed if the connection to the database is to function correctly.

Table 31 shows the properties defined in the db.properties file.

Table 31. Parameters in the db.properties file

Parameter Default Description

dbUser The name of the DB2 user.

dbPoolerImplementation ExternalNote: Only change this default ifyou cannot install the JDBCdriver 2.0.

Indicates the pooler connection to be used byDB2 for the administration and runtimedatabases. Valid values are:

InternalUse the Tivoli License Manager poolerconnection capabilities.

ExternalUse the WebSphere pooler connectioncapabilities. This can only be used if theDB2 JDBC driver 2.0 is installed. Thisdriver is standard with WebSphere 4.0. ForWebSphere 3.5.6, you must install thedriver on the administration or runtimeserver machine, and switch to it asdescribed in the DB2 documentation.

Appendix B. Configuration Settings 89

Page 106: IBM Tivoli License Manager: System Administrator's Guide

Table 31. Parameters in the db.properties file (continued)

Parameter Default Description

dbName For the administration serverdatabase: tlma For the runtimeserver database: tlmr

The name of the database used for the DB2pooler settings if the dbPoolerImplementationproperty is set to Internal.

The default value should be used if the TivoliLicense Manager server with which thedatabase is associated is installed on aWindows platform. If the associated server ison an AIX platform, the value must be set totlmadb (administration server database) ortlmrdb (runtime server database.

maxDbConnections 15 The maximum number of connections to thedatabase if the dbPoolerImplementationproperty is set to Internal.

jdbcDriver ibm.db2.jdbc.app.DB2Driver The path to the DB2 Driver if thedbPoolerImplementation property is set toInternal. Do not change this value.

jdbcDb2UrlPrefix jdbc:db2 The URL for the database if thedbPoolerImplementation property is set toInternal. Do not change this value.

dbJNDIName For the administratoin serverdatabase: jdbc/tlma For theruntime server database:jdbc/tlmr

The path to the data source if thedbPoolerImplementation property is set toExternal.

The default value should be used if the TivoliLicense Manager server with which thedatabase is associated is installed on aWindows platform. If the associated server ison an AIX platform, the value must be set tojdbc/tlmadb (administration server database)or jdbc/tlmrdb (runtime server database.

Configuring proxiesYou can define proxy settings for communications between runtime servers andthe administration server and between runtime servers and their agents.

To define a proxy for communications between a runtime server and theadministration server, complete the following steps:1. On the runtime server machine, navigate to the

<TLM_INSTALL_DIR>/runtime/conf folder.2. Open the scp.properties file in a text editor.3. Under the row that defines the adminpath property, add the following:

proxy = http://<proxy_address>:<proxy_port>/

where <proxy_address> is the full URL of the proxy server and <proxy_port> isthe port number.

4. Save the file and exit.5. Stop and restart the runtime server.

To define a proxy for communications between a runtime server and the agentsthat are assigned to it, complete the following steps before deploying agents:

90 IBM Tivoli License Manager: System Administrator’s Guide

Page 107: IBM Tivoli License Manager: System Administrator's Guide

1. On the runtime server machine, navigate to the<TLM_INSTALL_DIR>/runtime/conf folder.

2. Open the agent_install.properties file in a text editor.3. Scroll down to find the proxy parameters, and define them as follows:

# Proxy nameparm.proxyname=<proxy_address>

where <proxy_address> is the full path of the proxy.

# Proxy portparm.proxyport=<proxy_port>

where <proxy_port> is the port number

# Proxy is enabledparm.useproxy=yes

4. Save the file and exit.

Appendix B. Configuration Settings 91

Page 108: IBM Tivoli License Manager: System Administrator's Guide

92 IBM Tivoli License Manager: System Administrator’s Guide

Page 109: IBM Tivoli License Manager: System Administrator's Guide

Appendix C. Options file for silent installations

The recordFile.txt file, which is provided with Tivoli License Manager, is anInstallShield options file. It defines arguments to set each parameter that must beprovided to the Tivoli License Manager installation wizard. Some parameters havedefault value that you can accept or change, for example, the installation location.Other parameters do not have default values, and you must provide a value, forexample, the name of the customer.

To launch the installation wizard in silent mode, launch the set up command withthe following arguments:

-options ″.\recordFile.txt″ -silent

The command runs using all the arguments that are defined in the options filerecordFile.txt. See Table 32 for descriptions of the arguments and the possiblevalues that you can set.

Table 32. Argument definitions for silent installations

Parameter

Argument Default

Description

State - W license.selection= 1

Determines whether the license agreement is to be accepted. The default value (1) accepts thelicense agreement. If you change this setting to anything else, the installation will be refused.

Install location -P installLocation= ″C:\Program Files\IBM \Tivoli License Manager″

Specifies the installation directory. You can accept the default or specify a different location. Ifthe path name you specify includes spaces, you must enclose it in double-quotes, as shown forthe default location.

Setup type - W setupType.selectedSetupTypeId= custom

Determines the type of installation to be performed. Possible values are:

adminInstalls the administration server, its database, and the catalog manager on the machine.

runtimeInstalls the runtime server and its database on the machine.

customEnables you to choose the components that are to be installed.

If you select custom, you must define a ″feature active″ argument for each component you wantto install. If you select admin or runtime, any ″feature active″ arguments contained in the fileare ignored. The components to be installed are defined by the admin or runtime setup type.

Administrationserver featureactive

-P admin.active= true

Specifies whether or not the administration server component should be installed. Possiblevalues are:

true The server will be installed

false The server will not be installed.

© Copyright IBM Corp. 2001, 2002 93

Page 110: IBM Tivoli License Manager: System Administrator's Guide

Table 32. Argument definitions for silent installations (continued)

Parameter

Argument Default

Description

Administrationdatabase featureactive

-P adminDB.active= true

Specifies whether or not the administration server database should be installed. Possible valuesare:

true The database will be installed

false The database will not be installed.

Runtime serverfeature active

-P runtime.active= true

Specifies whether or not the runtime server component should be installed. Possible values are:

true The server will be installed

false The server will not be installed.

Runtime databasefeature active

-P runtimeDB.active= true

Specifies whether or not the runtime server database component should be installed. Possiblevalues are:

true The database will be installed

false The database will not be installed.

Catalog managerfeature active

-P catalog_manager.active= true

Specifies whether or not the catalog manager component should be installed. Possible valuesare:

true The catalog manager will be installed

false The catalog manager will not be installed.

DB2 instanceowner

-W db2Instance.dir= ″/home/db2inst1″

Specifies the location of the DB2 instance owner on AIX platforms. You can accept the default orspecify a different location. If the path name you specify includes spaces, you must enclose it indouble-quotes.

tlmsrv userpassword

-W adminConfig.passwordFinal= None

Specifies the password to be used to access the DB2 database that is associated with the servercomponent your are installing. During installation the user tlmsrv is created and its password isset to this value.

Customer name -W runtimeConfig.customerName= None

Specifies the name of the customer with which runtime server and database components are tobe associated. This value must contain only US ASCII characters.

Runtime name -W runtimeConfig.runtimeName= None

Specifies the name of the runtime server you are installing. This value must contain only USASCII characters.

Runtimepassword

-W runtimeConfig.runtimePassword= None

Specifies the password to be used to authenticate this runtime server in communications withthe administration server. The password has a maximum length of 8 characters and can containonly the following characters:

A-Z, a-z, 0-9, +, -, =.

Administrationhost name

-W r2aComm.adminHost= None

Specifies the host name of the administration server machine for this runtime server. This valuemust contain only US ASCII characters.

94 IBM Tivoli License Manager: System Administrator’s Guide

Page 111: IBM Tivoli License Manager: System Administrator's Guide

Table 32. Argument definitions for silent installations (continued)

Parameter

Argument Default

Description

Port -W r2aComm.port= ″80″

Specifies the port to be used for communications between the runtime server and theadministration server.

Use SSL -W r2aComm.useSSL= ″-1″

Indicates whether or not secure sockets layer (SSL) communications is to used between theadministration server and runtime server. Possible values are:

0 Use SSL.

-1 Do not use SSL.

Protocol -W r2aComm.protocol= ″http″

Specifies the protocol to be used for communications between the runtime server and theadministration server. Possible values are:

http For non-secure communications.

https For secure communications.

SSL password -W r2aComm.sslPassword= None

Specifies the password to be used to authenticate secure communications between this runtimeserver and the administration server. The password has a maximum length of 8 characters andcan contain only the following characters:

A-Z, a-z, 0-9, +, -, =.

Appendix C. Options file for silent installations 95

Page 112: IBM Tivoli License Manager: System Administrator's Guide

96 IBM Tivoli License Manager: System Administrator’s Guide

Page 113: IBM Tivoli License Manager: System Administrator's Guide

Appendix D. Common Tasks

This appendix provides instructions in performing some common tasks that youwill need to perform when installing and using Tivoli License Manager, but whichare not a part of Tivoli License Manager. These include tasks related to WebSphere,the HTTP server, and DB2, and tasks involved in checking performance metrics.

Instructions are provided for the following tasks:v Initializing the DB2 command line.v Starting and stopping the HTTP server.v Starting and stopping the WebSphere application server.v Starting the WebSphere administration console.

Initializing the DB2 command lineTo initialize the DB2 command line, do the following:

On WindowsClick Start -> Programs -> IBM DB2 -> Command Window

This opens the DB2 command window.

On AIXType:

. /home/db2inst1/sqllib/db2profile

Starting and stopping the HTTP serverTo start the HTTP server, do the following:

On WindowsClick Start -> Programs -> IBM HTTP Server -> Start HTTP Server

On AIX

1. Change to the directory: /usr/HTTPServer/bin2. Type:

./apachectl start

To stop the HTTP server, do the following:

On WindowsClick Start -> Programs -> IBM HTTP Server -> Stop HTTP Server

On AIX

1. Change to the directory: /usr/HTTPServer/bin2. Type:

./apachectl stop

Starting and stopping the WebSphere application serverTo start the WebSphere application server, do the following:

© Copyright IBM Corp. 2001, 2002 97

Page 114: IBM Tivoli License Manager: System Administrator's Guide

On WindowsClick Start -> Programs -> Programs -> IBM WebSphere -> ApplicationServer -> Start Admin Server

On AIX

1. Change to the directory: /usr/WebSphere/AppServer2. Type:

./startupServer.sh &

Note: You can check that the server has started by viewing the trace log, using thecommand:

tail ../logs/tracefile and looking for the entry:Administration server open for e-business.

To stop the WebSphere application server on either Windows or AIX, do thefollowing:1. Start the WebSphere administrator’s console.2. In the administrative domain tree, select the node with the name of the

machine.3. Right-click on force stop, and then confirm the requested action.

Starting the WebSphere administrator’s consoleTo start the WebSphere administrator’s console, do the following:

On WindowsClick Start -> Programs -> IBM WebSphere -> Application Server ->Administrator’s Console

On AIX

1. Change to the directory: /usr/WebSphere/AppServer/bin2. Enter the command:

./adminclient.sh

98 IBM Tivoli License Manager: System Administrator’s Guide

Page 115: IBM Tivoli License Manager: System Administrator's Guide

Appendix E. Connecting to an X Display Server

When the administration server component is installed on an AIX platform,display of graphical components, for example charts, depends on access to an XDisplay server.

To check whether there is an X Display server running on the machine, type:

ps -ef |grep X

If an X Display server is running, an output similar to the following appears:root 3394 2172 = Mar 20 - 5:09 /usr/lpp/X11/bin/X -x abx-x dbe -x GLX -D /usr/lib/X11/rgb -T -force :0 - auth/var/dt/A:= -lfchMa

Check that the following conditions are true:v The DISPLAY environment variable, in the environment where you are running

Java, identifies the path to the X Display server.v There are no security settings that will prevent the opening of a connection

between the Web administration server machine and the X Display servermachine.

The method of connecting to the X Display server depends on where the server isinstalled. The X Display server may be installed on the same machine as theadministration server and WebSphere or it may be on a different machine, wherethe WebSphere Graphic Admin Console is running.

Connecting on the same machineIf the X Display server is on the same machine as the administration server andWebSphere and you start the administration server locally, no further action isrequired.

If you started the administration server from a remote session, complete thefollowing steps:1. If WebSphere is running, stop it.2. Set the DISPLAY variable for your remote session, as follows:

export DISPLAY=<AdminServerHostName>:0.0

3. Add the host name of the workstation where you launched the remote sessionto the list of machines from which the X Server accepts connections, as follows:xhost +<RemoteSessionHostName>

4. Start WebSphere.

Connecting between machinesTo establish access to the X Display server when it is installed on a different hostfrom the administration server, complete the following steps:1. If WebSphere is running, stop it.2. Add the hostname of the workstation where the administration server and

WebSphere are installed to the list of machines from which the X Server acceptsconnections, as follows:

© Copyright IBM Corp. 2001, 2002 99

Page 116: IBM Tivoli License Manager: System Administrator's Guide

xhost +<AdminServerHostName>

3. Set the DISPLAY variable on the machine where the X Display server isinstalled, as follows:export DISPLAY=<XDisplayServerHostName>:0.0

4. Start WebSphere.

100 IBM Tivoli License Manager: System Administrator’s Guide

Page 117: IBM Tivoli License Manager: System Administrator's Guide

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.

© Copyright IBM Corp. 2001, 2002 101

Page 118: IBM Tivoli License Manager: System Administrator's Guide

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.

102 IBM Tivoli License Manager: System Administrator’s Guide

Page 119: IBM Tivoli License Manager: System Administrator's Guide

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 103

Page 120: IBM Tivoli License Manager: System Administrator's Guide

104 IBM Tivoli License Manager: System Administrator’s Guide

Page 121: IBM Tivoli License Manager: System Administrator's Guide

Index

Special characters/etc/services file 22

AadminDownloadPeriod property 86administration server

commands 31event notifications 41in Tivoli License Manager structure 2installing 13prerequisites 10starting 24, 33, 58stopping 33summary of functionality 1system.properties file settings 84, 85uninstalling 28

administration server databasecreating on AIX 21creating on Windows 20dropping on AIX 29dropping on Windows 29prerequisites 10

administratorsas notification recipients 23, 41

adminUploadPeriod property 86adminWakeUpEnabled property 85adminWakeUpPeriod property 85agent 35

access to runtime servers 3, 88commands 39in Tivoli License Manager structure 2inactive 86, 87on AIX 38on Sun 39on Windows 39prerequisites 11self-update 37, 88summary of functionality 1, 35system.properties file settings 35, 87trace operation 62tracing deployment 61troubleshooting 67uninstalling on UNIX 30uninstalling on Windows 29

agent_install.properties file 61, 83, 90AIX

agent commands 40agent files 38creating DB2 database 21

Bbooks

feedback xionline xiordering xi

CcacheUpdatePeriod property 86capacity type

in default license pools 86catalog

exporting master 32importing master 33

catalog managerinstalling 13prerequisites 10uninstalling 28

catalog.dat file 32categories of messages 75checkPeriod property 88clean-up SERVICE table 55, 85, 86clean-up USAGE table 55, 85cleanServiceEnabled property 85cleanServicePeriod property 56, 85cleanUsageEnabled property 85cleanUsagePeriod property 55, 85CLI 31

on agents 39starting on AIX 31starting on Windows 31

commanddbpasswd 32expcat 32help 32impcat 33info 33installagent 36rtpasswd 33srvstart 33srvstop 33statusinfo 34, 61

command linefor DB2 97

command line interface 31checking 59starting on AIX 31starting on Windows 31

commandson agents 39on AIX agents 40on all agent platforms 39on runtime servers 31on Sun agents 40on the administration server 31on Windows agents 40

configuration 9db.properties file 89system.properties file 84

configuration scriptsWebSphere 64

connection pooling 11, 89CPU prerequisites 10csvPlugins.properties file 83Customer Support xiii

© Copyright IBM Corp. 2001, 2002 105

Page 122: IBM Tivoli License Manager: System Administrator's Guide

Ddatabase

checking the connection 57creating on AIX 21creating on Windows 20

database name 90database server 10database size

performance impact 63databases

troubleshooting 66db.properties file 11, 89DB2

Client Configuration Assistant 22connection pooling 11, 89connections 90driver 90initializing command line 97user 89

DB2 databasechecking the connection 57connecting to a server on AIX 22connecting to a server on Windows 22creating on AIX 21creating on Windows 20dropping on AIX 29dropping on Windows 29name 33, 90password 16, 32, 94prerequisites 10

DB2 driverschecking on WebSphere 58

db2setup.bat script 20db2setup.sh script 21dbJNDIName property 90dbName property 90dbpasswd command 32dbPoolerImplementation property 89dbUser property 89default license pool 86defaultCapacityType property 86defaultMultiInstance property 86deployment

tracing 61disk space

performance impact 63division

in Tivoli License Manager structure 3downloadCatalogPeriod property 88downloadParametersPeriod property 88driver

DB2 90DTDs

for exporting data 45

Eentitlement

defining check period for updates 85error.log file 59event notifications 41

recipients 23, 41server settings 23, 41system.properties file settings 88

event.log file 43EventData.dtd 49

eventsinactive agent 41inventory scan 41license usage 41on the administration server 41on the runtime server 41

expcat command 32export

master catalog 32exporting

reports 45

Ffile

/etc/services 22agent_install.properties 61, 83, 90catalog.bat 32csvPlugins.properties 83db.properties 89error.log 59event.log 43help.properties 83httpd 25locale.properties 83password.properties 83recordFile.txt 93scp.properties 84, 90scp.services.properties 84setup.exe 13slmInit.properties 84stylesheets.properties 84system.properties 23, 42, 75, 84time.log 59tlmia.trc 62trace.log 60traceagt.log 62traceFilters.properties 60, 84

Hhelp

for the command line interface 32help command 32help.properties file 83host name aliases

checking on WebSphere 59HTTP configuration

performance impact 63, 64HTTP port

changing 64HTTP server

checking availability 57starting 97stopping 97

HTTP Web serverconfiguring for SSL 25

httpd file 25hwmScanPeriod property 85

IIBM Websphere

configuring for Tivoli License Manager 19IBM WebSphere

configuring for Tivoli License Manager 13

106 IBM Tivoli License Manager: System Administrator’s Guide

Page 123: IBM Tivoli License Manager: System Administrator's Guide

IBM WebSphere (continued)removing configurations for Tivoli License Manager 28starting a server on 24, 58

IKEYMAN 26impcat command 33import

master catalog 33inactive agent 86, 87info command 33installagent command 36

return codes 70installation 9

of catalog manager 13of Tivoli License Manager servers 13silent 13, 93validating 57

installation pathobtaining 33

inventory reportsexporting 45XML format 51

inventory scanduration 7, 87event 41resending 88

InventoryAgentReport.dtd 51inventoryFilesPerPacket property 87InventoryProductReport.dtd 51inventoryResendTimes property 88inventoryUpdatePeriod property 86

JJava console 61jdbcDb2UrlPrefix property 90jdbcDriver property 90

Kkey.jks 26

Llevel analysis

XML format 50license

release 86, 88license pools

default 86defining check period for updates 85maximum reached 41threshold reached 41

license usagedefining check period 85

licenseCleanUpPeriod property 86locale.properties file 83log files 59

Mmail settings

in system.properties file 23, 42mailEngine property 89mailRecipient property 89mailReload property 89

mailSender property 89manuals

feedback xionline xiordering xi

master catalogexporting 32importing 33

maxAgentInactivity property 87maxDbConnections property 90maxServiceAge property 56, 86maxUsageAge property 55, 85memory

prerequisites 10memory prerequisites 10messages

categories 75descriptions 76on the Web interfaces 75

multi-instancedefault 86in default license pools 86

Nnetwork traffic

performance impact 62notification

events 41recipients 23, 41server settings 23, 41system.properties file settings 88

Oonline publications xiiordering publications xii

PpacketDelayEscalation property 87packetDelayThreshold property 87parm.trace property 62password

for DB2 database 16, 32, 94for DB2 user 32runtime server 17, 33secure sockets (SSL) 33SSL keystore 18tlmsrv 15, 16, 94

password.properties file 83pcInventoryDuration property 7, 87performance

factors 62pingPeriod property 88plug in

runtime server 86plug in failure

runtime server 65prerequisites

CPU 10database server 10for administration server 10for agent 11for catalog manager 10for DB2 databases 10

Index 107

Page 124: IBM Tivoli License Manager: System Administrator's Guide

prerequisites (continued)memory 10space 10, 11

problemsagents 67databases 66servers 64user interface 72

propertyadminDownloadPeriod 86adminUploadPeriod 86adminWakeUpEnabled 85adminWakeUpPeriod 85cacheUpdatePeriod 86checkPeriod 88cleanServiceEnabled 85cleanServicePeriod 56, 85cleanUsageEnabled 85cleanUsagePeriod 55, 85dbJNDIName 90dbName 90dbPoolerImplementation 89dbUser 89defaultCapacityType 86defaultMultiInstance 86downloadCatalogPeriod 88downloadParametersPeriod 88hwmScanPeriod 85inventoryFilesPerPacket 87inventoryResendTimes 88inventoryUpdatePeriod 86jdbcDb2UrlPrefix 90jdbcDriver 90licenseCleanUpPeriod 86mailEngine 89mailRecipient 89mailReload 89maxAgentInactivity 87maxDbConnections 90maxServiceAge 56, 86maxUsageAge 55, 85packetDelayEscalation 87packetDelayThreshold 87parm.trace 62pcInventoryDuration 7, 87pingPeriod 88requestScope 3, 88runtimePluginPeriod 86serverInventoryDuration 7, 87smtpServer 89trace_level 62updateAgentEnabled 37, 88updateAgentPeriod 88uploadMinTime 88uploadUsageEvents 87usageSnapshotPeriod 86

proxiesconfiguring 90

publicationsfeedback xionline xiordering xi

Rrecipients

of event notifications 23, 41

recordFile.txt file 93release license 86, 88requestScope property 3, 88return codes

installagent command 70rtpasswd command 33runtime catalog

adding unknown files to 86download to agent 88

runtime serverchanging password 33changing SSL password 33commands 31event notifications 41in Tivoli License Manager structure 2installing 13plug in 86plug in failure 65prerequisites 10setting password 17starting 24, 33, 58stopping 33summary of functionality 1system.properties file settings 86uninstalling 28

runtime server databasecreating on AIX 21creating on Windows 20dropping on AIX 29dropping on Windows 29prerequisites 10

runtimePluginPeriod property 86

Sscp.properties file 84, 90scp.services.properties file 84script

db2setup.bat 20db2setup.sh 21SetupAdmin.bat 64SetupAdmin.sh 64SetupRuntime.bat 64SetupRuntime.sh 64WASConfig.bat 64WASConfig.sh 64

Secure Sockets Layer 25self-updating agent 37, 88serverInventoryDuration property 7, 87servers

troubleshooting 64SERVICE table

clean-up 55, 85, 86set up 9setup.exe file 13SetupAdmin.bat script 64SetupAdmin.sh script 64SetupRuntime.bat script 64SetupRuntime.sh script 64silent installation 13, 93SLM Web runtime server

setting password 17slmInit.properties file 84smtpServer property 89software inventory reports

DTD 51exporting 45

108 IBM Tivoli License Manager: System Administrator’s Guide

Page 125: IBM Tivoli License Manager: System Administrator's Guide

software usage 87software usage level analysis

DTD 50software usage reports

exporting 45software usage snapshot

DTD 45software usage trend analysis

DTD 49space prerequisites 10, 11srvstart command 33

failure 66srvstop command 33SSL 25SSL keystore password 18SSL password

changing 33statusinfo command 34, 61structure of Tivoli License Manager 2stylesheets.properties file 84Sun

agent files 39Sun agent

commands 40SWUsage.dtd 45SWUsageLevelAnalysisReport.dtd 50system processes

performance impact 63system.properties file 84

administration server settings 84, 85agent settings 35, 87e-mail settings 88mail settings 23, 42runtime server settings 86setting message display property 75

Ttime.log file 59Tivoli Customer Support xiiiTivoli License Manager agent

access to runtime servers 3Tivoli License Manager structure 2tlmia.trc file 62tlmroot user 27tlmsrv password 16, 94tlmsrv user password

setting on the administration server 15trace

agent deployment 61agent operation 62on servers 59

trace level 60setting for servers 60

trace services 59trace_level property 62trace.log file 60traceagt.log file 62traceFilters.properties file 60, 84trend analysis

XML format 49troubleshooting

agents 67common problems 64databases 66servers 64user interface 72

trusted store 26

Uuninstalling

agent on UNIX node 30agent on Windows node 29catalog manager 28Tivoli License Manager servers 28

unknown filesadding to runtime catalog 86sending to runtime server 88

updateAgentEnabled property 37, 88updateAgentPeriod property 88updateUsageEvents property 87uploadMinTime property 88usage information 87USAGE table

clean-up 55, 85usageSnapshotPeriod property 86user

DB2 89tlmroot 27

user interfacetroubleshooting 72

Vversion of Tivoli License Manager

obtaining 33

WWASConfig.bat script 64WASConfig.sh script 64Web administration server

event notifications 41in Tivoli License Manager structure 2installing 13prerequisites 10starting 24, 58summary of functionality 1uninstalling 28

Web interfacetroubleshooting 72

Web runtime serverevent notifications 41in Tivoli License Manager structure 2installing 13plug in failure 65starting 24, 58summary of functionality 1uninstalling 28

WebSpherechecking aliases 59checking for DB2 drivers 58configuration scripts 64configuring for Tivoli License Manager 13, 19connection pooling 89removing configations for Tivoli License Manager 28starting a server on 24, 58starting the administrator’s console 98starting the application server 97stopping the administrator’s console 98stopping the application server 97

Index 109

Page 126: IBM Tivoli License Manager: System Administrator's Guide

WebSphere aliasesfor SSL 26

Windowsagent commands 40agent files 39creating DB2 database 20

XX Display server

connecting to 99XML elements

in inventory report 52in software usage snapshot report 46

XML formatsoftware inventory report 51software usage level analysis 50software usage snapshot 45software usage trend analysis 49

110 IBM Tivoli License Manager: System Administrator’s Guide

Page 127: IBM Tivoli License Manager: System Administrator's Guide
Page 128: IBM Tivoli License Manager: System Administrator's Guide

���

Program Number: 5724-D33

GC23-4834-00