Tivoli Module Builder - IBM Supportpublib.boulder.ibm.com/tividd/td/TMB/GC32-0632-00/en… · · 2002-11-09Tivoli Module Builder Tivoli Ready QuickStart User’s Guide vii. Connection

Tivoli ModuleBuilderTivoli Ready QuickStart User’s GuideVersion 2.4

Tivoli ModuleBuilderTivoli Ready QuickStart User’s GuideVersion 2.4

Tivoli Module Builder QuickStart User’s Guide

Copyright Notice

Copyright (C) IBM Corp. 2000. All rights reserved.

May only be used pursuant to a Tivoli Systems Software License Agreement or Addendum for Tivoli Products to IBM Customer orLicense Agreement. No part of this publication may be reproduced, transmitted, transcribed, stored in a retrieval system, or translatedinto any computer language, in any form or by any means, electronic, mechanical, magnetic, optical, chemical, manual, or otherwise,without prior written permission of Tivoli Systems. Tivoli Systems grants you limited permission to make hardcopy or otherreproductions of any machine-readable documentation for your own use, provided that each such reproduction shall carry the TivoliSystems copyright notice. No other rights under copyright are granted without prior written permission of Tivoli Systems. Thedocument is not intended for production and is furnished″as is″ without warranty of any kind.All warranties on this document arehereby disclaimed including the warranties of merchantability and fitness for a particular purpose.

Note to U.S. Government Users -- Documentation related to restricted rights -- Use, duplication, or disclosure is subject torestrictions set forth in GSA ADP Schedule Contract with IBM Corp.

Trademarks

IBM, Tivoli, Tivoli Enterprise, Tivoli Enterprise Console, TME, and Tivoli Ready are trademarks or registered trademarks ofInternational Business Machines Corporation or Tivoli Systems Inc. in the United States, other countries, or both.

Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both.

Microsoft, Windows, Windows NT and the Windows logo are trademarks of Microsoft Corporation in the United States, othercountries, or both. UNIX is a registered trademark in the United States and other countries licensed exclusively through The OpenGroup. Other company, product, and service names mentioned in this document may be the trademarks or service marks of others inthe United States, other countries, or both.

Notice

References in this publication to Tivoli Systems or IBM products, programs, or services do not imply that they will be available inall countries in which Tivoli Systems or IBM operates. Any reference to these products, programs, or services is not intended toimply that only Tivoli Systems or IBM products, programs, or services can be used. Subject to the valid intellectual property or otherlegally protectable rights of Tivoli Systems or IBM, any functionally equivalent product, program, or service can be used instead ofthe referenced product, program, or service. The evaluation and verification of operation in conjunction with other products, exceptthose expressly designated by Tivoli Systems or IBM, are the responsibility of the user.

Tivoli Systems or IBM may have patents or pending patent applications covering subject matter in this document. The furnishing ofthis document does not give you any license to these patents. You can send license inquiries, in writing, to the IBM Director ofLicensing, IBM Corporation, North Castle Drive, Armonk, New York 10504-1785, U.S.A.

© Copyright International Business Machines Corporation 2000. All rights reserved.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSAADP Schedule Contract with IBM Corp.

Contents

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ixWho Should Read This Document. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix

What This Guide Contains. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . x

Prerequisite and Related Documents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi

Accessing Online Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii

Accessing the Files on the Product CD-ROM. . . . . . . . . . . . . . . . . . . xii

Typeface Conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii

Terminology. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiii

Contacting Tivoli Customer Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiv

Chapter 1. Reviewing Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Tivoli Plus Modules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Tivoli GEM Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Tivoli IT Director Modules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Chapter 2. Planning to Use the Wizard . . . . . . . . . . . . . . . . . . . 5Modeling Application Processes and Services. . . . . . . . . . . . . . . . . . . . . . . . 5

Rules and Conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Encoding Rules and Limitations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

File System Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Naming Conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Navigation Conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Collecting Icon and Help Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Using User Exits and Flat Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Chapter 3. Using the Tivoli Ready QuickStart Wizard 15Installing the Tivoli Ready QuickStart Wizard. . . . . . . . . . . . . . . . . . . . . . . 15

iiiTivoli Module Builder Tivoli Ready QuickStart User’s Guide

Starting the Tivoli Ready QuickStart Wizard. . . . . . . . . . . . . . . . . . . . . . . . 16

Using the Start Stage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Using the Define Stage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Using the Instrument Stage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Using the Finish Stage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Additional Customization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Chapter 4. Selecting Enablers . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Chapter 5. Instance Discovery Enablers . . . . . . . . . . . . . . . . 47Selecting an Instance Discovery Enabler. . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Monitor Enabler Dependencies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

NT Performance Objects Enabler (GEM). . . . . . . . . . . . . . . . . . . . . . . . . . . 53

NT Service by Program Name Enabler (GEM). . . . . . . . . . . . . . . . . . . . . . . 54

NT Services Enabler (GEM). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Single Instance Application Enabler (GEM). . . . . . . . . . . . . . . . . . . . . . . . . 57

Specific NT Service Enabler (GEM). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Start Up Parameters Enabler (GEM). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

User Exit Enabler (GEM). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

User Exit (using File Pack) Enabler (GEM). . . . . . . . . . . . . . . . . . . . . . . . . 62

User ID and Program Enabler (GEM). . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Chapter 6. Instance Information Enablers . . . . . . . . . . . . . . 65Instance Information by User Exit Enabler (GEM). . . . . . . . . . . . . . . . . . . . 66

Instance Information by User Exit (using File Pack) Enabler (GEM). . . . . . 68

Instance Information from Flat File (using File Pack) (GEM). . . . . . . . . . . . 69

Chapter 7. Inventory Enablers . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Inventory Signature Enabler (ITD, Plus). . . . . . . . . . . . . . . . . . . . . . . . . . . 72

iv Version 2.4

Chapter 8. Task Enablers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Specifying Command Parameters for Task Enablers. . . . . . . . . . . . . . . . . . . 77

Generic Task Enabler (GEM, ITD, Plus). . . . . . . . . . . . . . . . . . . . . . . . . . . 77

Generic Task Enabler, Instance ID Passed In (GEM). . . . . . . . . . . . . . . . . . 79

IT Director Generic Task (with argument/response bean) Enabler (ITD). . . . 80

Launch Browser Enabler (GEM). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

Launch Telnet Enabler (GEM). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Plus Application Launch Enabler (Plus). . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Recover Enabler (ITD, Plus). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Recover Service Enabler (ITD, Plus). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Start Task Enabler (GEM). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

Generic Start Task Enabler (GEM, ITD, Plus). . . . . . . . . . . . . . . . . . . . . . . 90

Start Task using File Pack Enabler (GEM). . . . . . . . . . . . . . . . . . . . . . . . . . 91

Start NT Service Enabler (ITD, Plus). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

Stop NT Service Enabler (ITD, Plus). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

Stop Task Enabler (GEM). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Generic Stop Task Enabler (GEM, ITD, Plus). . . . . . . . . . . . . . . . . . . . . . . 96

Stop Task Using Filepack Enabler (GEM). . . . . . . . . . . . . . . . . . . . . . . . . . 97

Chapter 9. Monitor Enablers . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101Monitor Enablers and Instance Context. . . . . . . . . . . . . . . . . . . . . . . . . . . 101

Filtering the List of Monitor Enablers. . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

Setting Monitor Enabler Thresholds. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

Specifying Monitor Enabler Polling Intervals. . . . . . . . . . . . . . . . . . . . . . . 107

Polling Intervals for Multiple Instances. . . . . . . . . . . . . . . . . . . . . . . 108

Specifying Monitor Enabler Response Tasks. . . . . . . . . . . . . . . . . . . . . . . 109

Monitor Enabler Descriptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

vTivoli Module Builder Tivoli Ready QuickStart User’s Guide

Custom Monitor Enabler (ITD, Plus). . . . . . . . . . . . . . . . . . . . . . . . . 110

Instance NT Counter Monitor Enabler (GEM). . . . . . . . . . . . . . . . . . 112

Instance NT Service Monitor Enabler (GEM). . . . . . . . . . . . . . . . . . . 113

Instance Process Attribute Monitor Enabler (GEM). . . . . . . . . . . . . . 114

Instance Process Count Monitor Enabler (GEM). . . . . . . . . . . . . . . . . 115

Instance Process Time Monitor Enabler (GEM). . . . . . . . . . . . . . . . . 117

NT Object Counter with no NT Instance Monitor Enabler (GEM,ITD) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

NT Object Counter with NT Instance Monitor Enabler (GEM). . . . . . 120

NT Object Monitor Enabler (ITD). . . . . . . . . . . . . . . . . . . . . . . . . . . 121

NT Service Monitor Enabler (GEM, ITD, Plus). . . . . . . . . . . . . . . . . 122

Predefined DM Monitor Enabler (Plus). . . . . . . . . . . . . . . . . . . . . . . 123

Process Attribute Monitor Enabler (GEM). . . . . . . . . . . . . . . . . . . . . 124

Process Count Monitor Enabler (GEM). . . . . . . . . . . . . . . . . . . . . . . 126

Process Monitor Enabler (ITD, Plus). . . . . . . . . . . . . . . . . . . . . . . . . 127

Process Time Monitor Enabler (GEM). . . . . . . . . . . . . . . . . . . . . . . . 128

State Monitor Enabler (GEM). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

User Exit Number Monitor Enabler (GEM). . . . . . . . . . . . . . . . . . . . 130

User Exit Number using File Pack Monitor Enabler (GEM). . . . . . . . 132

User Exit String Monitor Enabler (GEM). . . . . . . . . . . . . . . . . . . . . . 133

User Exit String using File Pack Monitor Enabler (GEM). . . . . . . . . 135

Chapter 10. Connection Enablers . . . . . . . . . . . . . . . . . . . . . . 139Discover Connections by User Exit Enabler (GEM). . . . . . . . . . . . . . . . . . 140

Discover Connections by User Exit using File Pack Enabler (GEM). . . . . . 143

Discover Connections from Flat File using File Pack Enabler (GEM). . . . . 146

Support Connection Enabler (GEM). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

Chapter 11. Event Enablers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151Custom Adapter Enabler (ITD). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

vi Version 2.4

Custom Adapter Enabler (Plus). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

Logfile Adapter Enabler (Plus). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

Using Existing Logfile Adapter Instrumentation. . . . . . . . . . . . . . . . . 157

Chapter 12. Deployment Enablers . . . . . . . . . . . . . . . . . . . . . . 159Add File to Filepack Enabler (GEM). . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

InstallShield Enabler (ITD, Plus). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

Plus Module Implementation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

IT Director Module Implementation. . . . . . . . . . . . . . . . . . . . . . . . . . 162

InstallShield Deployment Enabler (ITD). . . . . . . . . . . . . . . . . . . . . . . . . . . 166

Appendix A. Programming User Exits . . . . . . . . . . . . . . . . . 169User Exit Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

Setting Up the Environment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

Instance Discovery User Exit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

Calling an Instance Discovery User Exit. . . . . . . . . . . . . . . . . . . . . . 172

Instance Discovery User Exit Response. . . . . . . . . . . . . . . . . . . . . . . 172

Processing the Instance Discovery User Exit Response. . . . . . . . . . . . 173

Monitor User Exits. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

Calling a Monitor User Exit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176

Monitor User Exit Response. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

Processing the Monitor User Exit Response. . . . . . . . . . . . . . . . . . . . 178

Instance Information User Exit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

Calling an Instance Information User Exit. . . . . . . . . . . . . . . . . . . . . 178

Instance Information User Exit Response. . . . . . . . . . . . . . . . . . . . . . 179

Processing the Instance Information User Exit Response. . . . . . . . . . 180

Task User Exit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

Calling a Task User Exit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

Task User Exit Response. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

viiTivoli Module Builder Tivoli Ready QuickStart User’s Guide

Connection User Exit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

Calling a Connection User Exit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

Connection User Exit Response. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

Processing the Connection User Exit Response. . . . . . . . . . . . . . . . . 184

Appendix B. Flat File Formats . . . . . . . . . . . . . . . . . . . . . . . . . . 187Instance Information Flat File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

File Format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

Discover Connections Flat File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

File Format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

viii Version 2.4

Preface

The Tivoli Module Builder 2.4 Tivoli Ready QuickStart User’s Guidedescribes how to use the Tivoli Ready QuickStart wizard to createmodules that manage applications in Tivoli software environments.The QuickStart wizard supports the creation of the following typesof management modules:

¶ Tivoli Global Enterprise Manager (Tivoli GEM) modules

¶ Tivoli Plus modules

¶ Tivoli IT Director modules

Who Should Read This DocumentThis document is intended for developers who integrate managementof their applications with Tivoli management software.

You should have knowledge of the following:

¶ The management requirements and features of the application forwhich you intend to build a management module. For example,you should understand those aspects of the application that areprone to failure or whose function can be facilitated by theTivoli management software tools. You should also be familiarwith the administrative tasks of the managed application, as wellas any logfiles or application programming interfaces (APIs) thatthe managed application offers for retrieving status andperformance data.

¶ The Tivoli Enterprise software environment, including TivoliManagement Framework, Tivoli Software Distribution, TivoliDistributed Monitoring, and Tivoli Enterprise Console.

¶ The Tivoli IT Director management environment, the Tivoli ITDirector Integration Toolkit, and the overall process forgenerating application management package (AMP) files.

More advanced users may also want an understanding of thefollowing:

ixTivoli Module Builder Tivoli Ready QuickStart User’s Guide

¶ Shell and script programming

¶ The Application Management Specification(AMS), anindustry-endorsed specification for creating management-readyapplications. You can find a copy of the AMS at the followingWeb site:

http://www.tivoli.com/products/index/ams/

What This Guide ContainsThe Tivoli Module Builder 2.4 Tivoli Ready QuickStart User’s Guidecontains the following chapters:

¶ Reviewing Modules

This chapter provides conceptual information on generatingmanagement modules for the Tivoli GEM, Tivoli IT Director,and Tivoli Plus environments. This chapter assumes you havehad some exposure to management modules, in the Tivoli GEM,Plus or IT Director environments.

¶ Planning to Use the Wizard

This chapter reviews things you need to consider about yourapplication or business system to model it correctly before usingthe QuickStart wizard.

¶ Using the Tivoli Ready QuickStart Wizard

This chapter gives an overview of the QuickStart wizard,showing you the general flow of building one or more moduletypes and describing the operation of the graphical user interface(GUI).

¶ Selecting Enablers

This chapter provides information on predefined implementationsthat use programming interfaces common to the operatingsystem to observe the application, discover software components,and report on their status. These implementations, calledenablers, can be selected and tailored by providing required oroptional parameter information.

x Version 2.4

¶ Chapter 5 through Chapter 12 describe each of the availableenablers, their purpose, their required and optional parameters,and other information to help you choose the right ones for yourinstrumentation needs.

¶ Programming User Exits

This appendix provides information for defining your own userexits to extend the Tivoli GEM instrumentation created with theQuickStart wizard.

¶ Flat File Formats

This appendix contains formats for Tivoli GEM enabler flat filesand examples of instance information and discovery connectionenablers.

Prerequisite and Related DocumentsManagement modules interact with various management tools in theTivoli environment. You can refer to the documentation for thesetools when creating a management module. In particular, this guidecontains references to the following documentation:

¶ For information on creating a Tivoli GEM module, see theTivoliGlobal Enterprise Manager Business System Enablement Guideand theTivoli Global Enterprise Manager Advanced BusinessSystem Enablement Guide. For other information on TivoliGEM, see theTivoli Global Enterprise Manager User’s GuideandTivoli Global Enterprise Manager Troubleshootinglocated atthe following Web site:

http://www.tivoli.com/support/Prodman/html/AB.html

You must be a registered user to access this Web site. If youhave not registered, when theUsername and PasswordRequired prompt is displayed, clickCancel and follow theregistration directions.

¶ For information on creating a Tivoli Plus module, refer to theTivoli Module Builder User’s Guide.

¶ For information on creating an IT Director module, refer to theTivoli IT Director Integration Toolkit. Included in this toolkit isa document,Managing Applications with Tivoli IT Director,

xiTivoli Module Builder Tivoli Ready QuickStart User’s Guide

which describes how to use the Tivoli Module Designer to createan application management package to run in the IT Directorenvironment. This document is also available in Microsoft Wordformat in the\module_dev\examples\IT Directorfolder on thedrive where you installed the Tivoli Module Builder. For moreinformation on obtaining the complete toolkit, send an e-mail [email protected] or call 1-800-426-9990.

Accessing Online DocumentationThe Tivoli Module Builder library is available in the followingonline formats on both the Tivoli Module Builder CD-ROM and theTivoli Web site:

¶ Portable Document Format (.pdf), which you can view or printusing the Adobe Acrobat Reader. If you do not already haveAdobe Acrobat Reader, you can obtain it for free by clicking theGet Acrobat Reader icon and following the steps that areprovided at the Adobe Web site:

http://www.adobe.com

¶ Hypertext Markup Language (.htm), which you can view usingyour default Web browser.

Accessing the Files on the Product CD-ROMSee theTivoli Module Builder Release Notesfor information onaccessing the documentation on the product CD-ROM.

Typeface ConventionsThis document uses several typeface conventions for special termsand actions. These conventions have the following meanings:

Bold Commands, keywords, file names, authorization roles, flags,universal resource locators (URLs), or other information thatyou must use literally appear inbold. The names or titles ofscreen objects also appear inbold.

Italics Variables and values that you must provide appear initalics.Words and phrases that are emphasized also appear initalics.

xii Version 2.4

Bold ItalicsNew terms appear inbold italics when they are defined inthe text.

MonospaceCode examples, output, and system messages appear in amonospace font.

TerminologyThe following table defines the Intel and UNIX terms as they areused in this document. For example, the term Intel refers to theWindows family of platforms, as well as OS/2 platforms.

Term Platform

Intel ¶ Windows 95

¶ Windows 98

¶ Windows NT

¶ Windows 2000

¶ OS/2

UNIX ¶ AIX

¶ Solaris

¶ HP/UX

For a complete glossary of Tivoli and related terms, refer to theglossary at the following Web site:

http://www.tivoli.com/products/documents/glossary/

Tivoli is in the process of changing product names. Productsreferenced in this manual may still be available under their oldnames, for example, TME 10 Enterprise Console instead of TivoliEnterprise Console.

xiiiTivoli Module Builder Tivoli Ready QuickStart User’s Guide

Contacting Tivoli Customer SupportFor support for this or any other Tivoli product, you can contactTivoli Customer Support in one of the following ways:

¶ Visit our Web site athttp://www.tivoli.com/support/

¶ Send e-mail [email protected]

Customers in the United States can also call1-800-TIVOLI8(1-800-848-6548). International customers should consult the Website for customer support telephone numbers. You can also reviewthe Customer Support Handbook which is available on our Web siteat:

http://www.tivoli.com/support/handbook/

When you contact Tivoli Customer Support, be prepared to provideidentification information for your company, so that supportpersonnel can assist you more readily. Company identificationinformation may also be needed to access various online servicesavailable on the Web site.

The Web site offers extensive information, including a guide tosupport services (the Customer Support Handbook); frequently askedquestions (FAQs); and documentation for all Tivoli products,including Release Notes, Redbooks, and Whitepapers. Thedocumentation sets for some product releases are available in bothPDF and HTML formats. Translated documents are also available forsome product releases.

You can order documentation by e-mail [email protected] provide the part number or order number of the desireddocument; alternatively, you can provide the document’s title,version number, and date of publication.

We are very interested in hearing about your experience with Tivoliproducts and documentation. We also welcome your suggestions forimprovements. If you have comments or suggestions about ourdocumentation, please contact us in one of the following ways:

xiv Version 2.4

¶ Send e-mail to:

[email protected]

¶ Fill out our customer feedback survey at:

http://www.tivoli.com/support/feedback/

xvTivoli Module Builder Tivoli Ready QuickStart User’s Guide

xvi Version 2.4

Reviewing Modules

The Tivoli Ready QuickStart wizard enables you to provideinformation to the Tivoli management software tools to describeyour applications and business systems and their relationships. Thisinformation is created in the form of amodule that can be directlyimported and interpreted by the Tivoli management software tools.

Management modules supported by the QuickStart wizard includethe following types:

¶ Plus modules, that provide specialized features for managing anapplication with the Tivoli Enterprise

¶ Tivoli GEM modules, which enable business systemsmanagement using the Tivoli Global Enterprise Manager product

¶ Tivoli IT Director modules, which are created as a series ofApplication Management Specification (AMS) componentscombined into an Application Management Package (AMP) forinstallation in the Tivoli IT Director environment

The following sections describe in more detail each of the moduletypes that can be built using the QuickStart wizard.

1

1Tivoli Module Builder Tivoli Ready QuickStart User’s Guide

1.R

eviewing

Modules

Tivoli Plus ModulesA Plus module provides a high-level integration of an applicationwith the Tivoli Enterprise. The application’s managementinformation, along with the scripts and programs for integrating theapplication with the Tivoli environment, is built into a Tivoli installimage.

A Plus module is defined as an installable image of scripts andmanagement information defined in accordance to the AMS. Thisinformation is comprised of logical units calledcomponents.

Note: AMS components are not the same as QuickStart wizardcomponents. A QuickStart wizard component contains one ormore AMS components, depending on the module type. Whenbuilding a Tivoli GEM module, a Tivoli GEM QuickStartwizard component will always map to exactly one AMScomponent. When building a Plus module, a Plus componentwill typically map to multiple AMS components.

AMS components are typically used in Plus modules to groupobjects together logically. Each AMS component defines a slice offunctionality of the module. For example, one AMS component maycontain most of the operational tasks, while another contains the filepackage definition for the configuration of the Tivoli EnterpriseConsole (TEC) logfile adapter.

In addition to customized and comprehensive applicationsmanagement, Plus modules provide a common interface and, in somecases, enable data sharing with the Tivoli management softwaretools. The specific integration points, which include tasks, monitors,file distribution, and event management, are described in AMSformat.

If you are familiar with generating Plus modules using the TivoliModule Builder (TMB), you may have used the Plus Template,available in the TMB. This template is used to populate the modulewith a number of generic objects. These objects have no actualfunctionality associated with them, but they serve as place holders to

2 Version 2.4

guide you in the process of creating an object. The QuickStartwizard can be thought of as a dynamic version of a TMB template,in that it is used to seed the TMB, but the initial objects are basedon actual characteristics that you specify.

When installed, Plus modules create a Tivoli Plus icon on the Tivolidesktop. Double-clicking on this icon brings up the TivoliPluswindow, containing the collection of Plus modules that have beeninstalled. This icon accesses the dialogs and other features for allinstalled Plus modules, avoiding the need to access the Plusmanagement functions separately from each Tivoli managementsoftware tool.

Tivoli GEM ModulesTivoli Global Enterprise Manager (Tivoli GEM) modules enable anapplication to be managed in the context of a business system withTivoli GEM. The module’s management information, along with thescripts and programs that implement the management functions, isbuilt into a Tivoli install image.

A Tivoli GEM module describes the tasks and monitors that TivoliGEM requires to build views for business systems management.These tasks and monitors are described in AMS format.

Tivoli IT Director ModulesTivoli IT Director modules are also created as a series of AMScomponents. In general, Tivoli IT Director defines a component foreach architectural component as distinguished by platform andfunction. A Tivoli IT Director component defines a single filepackage, tasks, monitors, monitor instances, thresholds, and responsetasks associated with the component.

The components and their associated files are combined into anAMP for installation in the Tivoli IT Director environment. For eachplatform and function, you will create a component in the QuickStartwizard.


1.R

eviewing

Modules

Additional information is available with the Tivoli IT DirectorIntegration Toolkit, in a document entitled,Managing Applicationswith Tivoli IT Director.

4 Version 2.4

Planning to Use the Wizard

Before using the Tivoli Ready QuickStart wizard, you need toconsider the run-time model of your application or business system.You can more effectively develop the application components andthe resulting modules by modeling the processes and services ofyour application or business system.

You should also be familiar with encoding rules, namingconventions, and requirements for icon and help files.

Modeling Application Processes and ServicesIf you model your application processes and services prior to usingthe QuickStart wizard, you reduce the time needed for a successfulinstrumentation. For each operating system that your applicationsupports, perform the following steps:

1. Identify the processes and services of your application asfollows:

¶ Capture all application processes.

For Windows NT, you can see any application processes inthe Windows NT task manager. For UNIX, you can list anyapplication processes by using theps -ecommand.

¶ Determine which named processes are persistent for the lifeof the application.

¶ Identify all Windows NT services that your Windows NTapplication creates.

2


2.P

lanningto

Use

theW

izard

You can see these services by opening theServicesicon inthe Control Panel window.

¶ Identify any prefix of displayable Windows NT servicenames that are dynamically created by your application.

For example, your application might create multiple instancesof a database manager and give them a unique name, butprefix the unique name withDB2 to form the displayableservice name.

2. Group the related processes and services of your applicationusing the following criteria:

¶ Group processes and services that require each other to be onthe same system.

Note: A client component is grouped separately from aserver component because it would connect to theserver through a network connection.

¶ Move processes or services that are optionally activated intotheir own grouping.

3. Identify the components to be instrumented.

Each group in the preceding step is considered a softwarecomponent of your application, but only those that are persistentfor the life of the application should be instrumented.

Rules and ConventionsThis section describes the QuickStart wizard encoding rules andlimitations, the file system structure used by the QuickStart wizard,and the naming conventions for product names and componentnames.

Encoding Rules and LimitationsThe following are rules for names to apply when encoding yourinstrumentation:

¶ Monitor Names

Monitor names must be alphabetic (a-z, A-Z). Spaces are notallowed. Monitor names must be unique for each component.

6 Version 2.4

¶ Task Names

Task names must be alphanumeric (a-z, A-Z, 0-9, andunderscores) and the first character must be alphabetic. Spacesare not allowed. Task names must be unique.

Names that you assign to tasks that are generated by taskenablers must have unique names. Mixed-case names areallowed, and task names that are identical except for case, suchasStart or start, are considered unique, even in the Intelenvironment. For Plus modules, task names are used as the basisfor profile manager names, which are case-sensitive.

¶ Manufacturer and Product Names

Manufacturer and product names can be alphanumeric and cancontain underscores. The first character must be alphabetic.Spaces are not allowed.

File System StructureThe QuickStart wizard uses the standard TMB file systemorganization, with the following general structure (as it would appearon a UNIX system):module_dev/Projects/<projName>/<moduleName>/...

The QuickStart wizard will create new subdirectories for eachmodule type after building the project. For example, if you have aproject with an application calledCustomAppand two componentscalledserverandclient, building modules of all three module typeswould result in the following directory structure:module_dev/Projects/CustomApp/server/...

module_dev/Projects/CustomApp/client/...

module_dev/Projects/CustomApp/ITD/...

module_dev/Projects/CustomApp/Plus/...

module_dev/Projects/CustomApp/images/...

The first two subdirectories shown above,...server/and ...client/, arespecific to Tivoli GEM. The AMP file for IT Director is generatedunder the ITD subdirectory. For Plus modules, all QuickStart wizardcomponents for a project are collated into one Plus module under thePlus subdirectory.


2.P

lanningto

Use

theW

izard

Naming ConventionsEstablish and follow a naming convention for your instrumentationto ensure meaningful unique names. Names should not contain blankspaces.

The following is an example convention for product names andcomponent names:

¶ Product names

Create an abbreviated version of the product name to carry intothe naming of its components. Ideally, the abbreviated productname should match the installable entity that will be installed inthe production environment. Your product naming conventionshould result in a common acronym for the product, along withthe operating system specification, a package qualifier, and areference to the particular version and release, if necessary.These names can be used as prefixes for the component namesto ensure uniqueness.

For example, given the applications named ABC ApplicationEnterprise Edition for Windows NT, ABC Application EnterpriseEdition for AIX, and ABC Application Workgroup Edition forWindows NT, the abbreviated names could beABC_NT_EE,ABC_AIX_EE, andABC_NT_WG, respectively.

¶ Component names

Determine a short descriptive name for each component. Prefixthis name with the abbreviated version of the product name.Using the above product name examples, this might result incomponent names such asABC_NT_EE_QMgr, ABC_AIX_EE_QMgr,andABC_NT_WG_Router. Component names need to be uniqueacross platforms if unique instrumentation is created for eachplatform.

¶ Specifying Path Names for Multiple Module Types

When you are specifying a path name in the QuickStart wizardthat is to be interpreted as a path for multiple module types (andtherefore on potentially different platforms), you should use aforward slash (/) as a path separator, instead of the backslash (\).

8 Version 2.4

For example, if, for a task enabler parameter field you specify a″command to execute″ and that command is of the formmkdir /tmp/xyz

you must specify the forward slash as the path separator to behandled correctly in the bash environment for all three moduletypes.

¶ Task names must be unique.

Navigation ConventionsWhile using the QuickStart wizard, you should be aware of thefollowing conventions for navigating the various stages:

¶ Where you are prompted to enter a file name, you will see abutton with ... next to the entry field. Clicking this button willbring up the file selection dialog, enabling you to navigate to thedesired directory where your file is located, and select the file tobe included in the entry field.

You can clear these fields later if desired by right-clicking on thefield and selectingClear value from the pop-up dialog.

¶ Throughout the QuickStart wizard, you can proceed from onescreen to the next, in either direction, by clicking theNext andPrevious buttons at the bottom of each screen. You can also exitthe QuickStart wizard at any time, preserving the current state ofyour session, by clicking theExit button. Finally, you can viewonline help information using theHelp button.

At any time you can also skip ahead or back through the wizarddialogs by clicking any of the items displayed in the left pane,or tree view, of the tab page. You can also select any of the fourtabs at the top of the left pane to skip to that stage in the overallprocess. You can change the size of the left and right panes bydragging the separating border between the two panes to theright or left.

¶ For fields that require input, an empty blue circle is displayed tothe left of the input field. When you enter valid input, the circleturns a solid blue. If the field is an optional input, the solid bluecircle is displayed by default. Even though you must enter validinformation in all required fields before you can build the


2.P

lanningto

Use

theW

izard

module, you can still traverse the QuickStart wizard dialogs andeven save your session while you have incomplete or incorrectinformation in one or more fields.

¶ If you change the size of the QuickStart wizard window, itslocation on your desktop, or the location of the vertical dividerbar on the window, you can save your settings by right-clickingin the area just above the four tabs (Start, Define, Instrumentand Finish) and floating your mouse over theWindow Settingspop-up menu that is displayed (see Figure 1). You can save someor all of these settings by selecting the appropriate check boxes.The settings are saved when you exit the QuickStart wizard.

Navigating the QuickStart Wizard Using the KeyboardWhile normally you can use the mouse to navigate through thevarious steps in the QuickStart wizard, you can also navigate fromwindow to window and across fields with the keyboard, using thefollowing Java-standard key combinations:

Figure 1. Saving your QuickStart wizard display settings

10 Version 2.4

Action KeyboardOperation

Navigate in, navigate out Tab (with Shiftkey to reverse theaction)

Navigate out of a component that accepts tabs Control-Tab (withShift key toreverse the action)

Move focus left one character or component within agroup

Left arrow

Move focus right one character or component within agroup

Right arrow

Move focus up one character or component within agroup

Up arrow

Move focus down one character or component withina group

Down arrow

Activate an input field to enter data F2

Activate the default command button Enter or Return

Dismiss a menu or dialog box without changes Escape

Activate or select the component (with keyboardfocus)

Space bar

Move to the beginning of data; in a table, move to thebeginning of a line

Home

Move to the end of data; in a table, move to the lastcell in a row

End

Figure 2 on page 12 shows the order in which the key focus isacquired using the Control-Tab keys. At the last item, Control-Tabloops back to the first item.


2.P

lanningto

Use

theW

izard

Collecting Icon and Help FilesIf you are building a Tivoli GEM module, collect the icon files andhelp files for your application and its components. Know where theyare located. If necessary, create applicable help files.

The QuickStart wizard requests these files when defining theapplication and instrumenting the software components. See “TivoliGEM Specific Build Options” on page 32 for more information.

For Plus modules, find your application icon file which can also beinput to the QuickStart wizard. You will also need another version ofthis icon superimposed with the standard Tivoli Plus symbol, andthis Plus icon can be specified in the QuickStart wizard to appear in

Figure 2. Using the Control-Tab keys, you can navigate the QuickStart wizard windowsand components in the order shown.

12 Version 2.4

the Plus module dialog on the Plus module desktop, along with otherPlus module icons. For more information, see “Plus Specific BuildOptions” on page 35.

Using User Exits and Flat FilesUsing the QuickStart wizard you can select predefinedimplementations that use programming interfaces common to theoperating system to observe the application, discover softwarecomponents, and report on their status. In many cases you willspecify parameters to customize these predefined implementations,and in the case of Tivoli GEM, you can extend yourimplementations by generating your own user exits and specialparameter files called flat files that distinguish one instance of anapplication component from another.

These user exits and flat files should be defined prior to using theQuickStart wizard. For more information on user exits, see“Programming User Exits” on page 169. For information on flat filesand their unique formats, see “Flat File Formats” on page 187.


2.P

lanningto

Use

theW

izard

14 Version 2.4

Using the Tivoli ReadyQuickStart Wizard

The Tivoli Ready QuickStart wizard is included in the Tivoli ModuleBuilder product (TMB), along with the Tivoli Module Designer(TMD).

You can use the QuickStart wizard as a front end to the TMB (in thecase of Plus and Tivoli GEM modules) and the TMD (in the case ofTivoli IT Director modules) to provide Application ManagementSpecification (AMS) information and skeletons for commonmanagement functions, including tasks, monitors, deployment, andevent handling. You can further customize this basic level ofinstrumentation by writing event adapters and customizing skeletonfiles. The QuickStart wizard helps you get started in this process andhelps cut the development time to generate your instrumentation.

The QuickStart wizard provides both a sequential stepwise tourthrough the definition of management functionality for the noviceuser, as well as the ability for advanced users to skip to any area ofthe definition.

Installing the Tivoli Ready QuickStart WizardThe QuickStart wizard is installed automatically during theinstallation of the TMB. See theTivoli Module Builder ReleaseNotesfor complete information on installing the TMB product andthe QuickStart wizard.

3


3.U

singthe

TivoliReady

QuickS

tartW

izard

Starting the Tivoli Ready QuickStart WizardTo start the QuickStart wizard, do the following:

¶ For Intel: From theStart menu, selectPrograms -> TivoliModule Builder -> QuickStart .

On NT systems, you can also start the QuickStart wizard bydouble-clicking on theQuickStart.bat file in the /module_devdirectory on the drive where you installed the TMB, or yourinstall directory, if you installed to a different directory.

¶ For UNIX: From the default install directory,/module_devoryour install directory, if you installed to a different directory,enter the command:quickstart.sh

Once the QuickStart wizard loads, theGetting Started window isdisplayed, as shown in Figure 5 on page 18.

If this is not the first time you have started the QuickStart wizard,you will also see theRestart dialog, as shown in Figure 4 onpage 17, giving you the option to do the following:

Figure 3. Starting the QuickStart wizard

16 Version 2.4

¶ Resume the previous session

The QuickStart wizard remembers the previous state of your lastsession and returns to the previous session location at which youstopped.

¶ Start over

You can erase your previous session and start fresh again with anew session by selecting this option.

Even if you exit the QuickStart wizard without saving your previousselections, the state of the QuickStart wizard at the time you exit ispreserved until the next time you use it.

Note: If you save your QuickStart wizard session and build yourmodule, you can further customize your instrumentation usingthe Tivoli Module Builder or Tivoli Module Designer.However, if you then return to the QuickStart wizard andresume your saved session, you may lose whatevercustomized instrumentation you added in the TMB or TMDthe next time you build the module.

Figure 4. Resuming the previous session or starting over


3.U

singthe

TivoliReady

QuickS

tartW

izard

Four tabs are available that represent the four main stages of theoverall QuickStart wizard process. These four main stages are asfollows:

1. Start

From theGetting Started window, you can clickNext toadvance through two more information windows that describewhat you can expect, along with a brief overview of thefour-stage process, bringing you to theSelect Instrumentationdialog. You can also skip directly to this dialog by clickingSelect Instrumentation from the tree view in the left pane.

See “Using the Start Stage” on page 19 for more details.

2. Define

In the Define stage, you identify the application to be managed,specifying application level information such as the name,manufacturer, version, and release level. You can also declarewhich module types you intend to build, selecting from TivoliGEM, Plus, or IT Director module types.

Figure 5. The Getting Started window is displayed when you start a new session.

18 Version 2.4

See “Using the Define Stage” on page 21 for more details.

3. Instrument

In the Instrument stage, you define the specific softwarecomponent parts of your application, specifying component levelinformation such as name, manufacturer, version and releaselevel. You also select the desired platform type and customize thedesired enablers for each software component.

See “Using the Instrument Stage” on page 23 for more details.

4. Finish

In the Finish stage, you can further refine the platform type forthe modules to be built. You can save your session to continue ata future time, or you can build your modules into a Tivoliinstallable image and, for Tivoli GEM and IT Director modules,an AMP file. If you need additional customization, you can usethe Tivoli Module Builder and Tivoli Module Designer products.

See “Using the Finish Stage” on page 30 for more details.

Using the Start StageThe Start stage is the initial stage of the Tivoli Ready QuickStartprocess. TheGetting Started window, along with theWhat toExpect andRequirementswindows, gives you a brief overview ofthe general process. Advancing to theSelect Instrumentationdialog, you can do the following:


3.U

singthe

TivoliReady

QuickS

tartW

izard

¶ Continue working

If you had started a previous session and exited the QuickStartwizard, the state of your session is preserved. The next time youreturn you can select this option to continue where you left off.

¶ Create a new module

Select this option to start a new module, erasing any previoussession information.

¶ Load from an existing module

Select this option to load a module previously created using theQuickStart wizard. Then you can edit the module, rebuild it, oruse it as a template to create a new module.

The list of available modules will be shown in the selection boxunder this radio button. Highlight the one you want to select.

Note: If you have previously used the QuickStart wizard tobuild a module and then further customized yourinstrumentation using the TMB or TMD, you cannotre-load the module into the QuickStart wizard.

Figure 6. Selecting your desired instrumentation

20 Version 2.4

¶ Load a QuickStart session file

Select this option to continue work on an existing session filethat you saved using theYes - Save the QuickStart session to afile option during theFinish stage (see “Using the Finish Stage”on page 30) in a previous session. Enter the path in the fieldprovided, or navigate to the desired directory and select thedesired file.

If you selectStart Over during startup, theCreate a new moduleradio button will be selected by default. If you leave this windowand return again later, theContinue working radio button will beselected by default.

If you selectResume previous sessionduring startup, theContinueworking radio button is selected by default.

If you then select an option other thanContinue working, you willbe warned about losing existing session information if you proceedfurther. Be sure to select the right option to avoid losing previoussession information.

Using the Define StageIn the Define stage, you provide information about the application tobe managed by your Tivoli GEM, IT Director or Plus module.

Figure 7. Be careful not to lose existing data you want to keep.


3.U

singthe

TivoliReady

QuickS

tartW

izard

In the Information pane, you enter application level information,such as the following:

¶ Name

This is the name you give to the module. You can specify up to20 alphanumeric characters, and the first character must bealphabetic. Blanks are not allowed, but you can use underscores.This is a required field, and is initially filled in withNewApplicationwhen you first enter this stage. You shouldreplaceNewApplicationwith your application name.

¶ Manufacturer

This is the name of the manufacturer of the application. You canspecify up to 20 alphanumeric characters, and the first charactermust be alphabetic. Blanks are not allowed, but you can useunderscores. This is a required field.

¶ Version

This is the version number for the module, and has a major,minor, and revision component. You specify a numeric value forthe major version number, the minor version number, and therevision level. The version number is a good way to track codechanges. The major and minor version numbers are requiredfields, while theRev revision field is optional. You can specifyup to 5 numeric characters in these fields.

Note: If you are building Tivoli GEM modules and plan to dofurther customization using templates in the TMB, the field

Figure 8. Identifying the application level information

22 Version 2.4

lengths for theName andManufacturer fields may be morerestricted. See theTivoli Module Designer Release Notesfordetails.

After you fill in these fields (notice the empty blue circles change tosolid blue circles when valid data has been entered into requiredfields), click Next to continue, or clickModule Type from the treeview in the left pane.

Also in this stage, in theModule Type pane, you select which of thethree module types you want to build: Tivoli GEM, Plus, or ITDirector modules. You can select one, two, or all three types.

Finally, in theSummary pane, you see the application informationand the module types you entered in the previous panes. While youare in theDefine stage, you can skip ahead to thisSummary paneat any time, if you do not want to step through the panessequentially. Use theSummary pane to confirm your definitioninformation before proceeding on. You can make changes to theinformation in theSummary pane or go back to the previous panesat any time to modify what you entered. When you are satisfied,click Next to continue.

Using the Instrument StageIn the Instrument stage, you enter information about each softwarecomponent in your application to be managed.

When you first enter theInstrument stage, you may see the firstcomponent already added for you in theComponents in this

Figure 9. Select the desired module types you want to build.


3.U

singthe

TivoliReady

QuickS

tartW

izard

module list box in the dialog window. The default component nameof NewComponent0is used. This field may be empty, however, ifyou did not previously define your application information in theDefine stage.

In the tree view in the left pane, the new component is also shown,and below this name is a list of the availableenablercategories youcan choose from. (See “Selecting Enablers” on page 45 for detailsabout enablers.)

Figure 10. The first component is added to the list for you.

24 Version 2.4

Click Add to add additional new components to the component list.For each new component you add, a new entry in the tree view ismade, along with its corresponding list of enabler types, as shown inFigure 12 on page 26. Note also that the default component name,NewComponentn, is incremented by one to create a uniquecombination of Name, Manufacturer, and Version for eachcomponent. You can change these default component names tonames that are of meaning to you, but you must maintain a uniqueName, Manufacturer and Version combination for each component.You can also remove a component from the list and the tree view byselecting the component in the list box and then clickingRemove.

Figure 11. The tree view shows the new component and available enabler types.


3.U

singthe

TivoliReady

QuickS

tartW

izard

When you have added the desired number of new components, clickNext to continue on to the component level definitions.

For each new component, you must define the following componentlevel information:

¶ Name

Here is where you can override the defaultNewComponent0name with your own desired name. You can specify up to 20alphanumeric characters, and the first character must bealphabetic. Underscores are permitted, but blank spaces are notallowed. Notice that as you modify this name in theName field,the corresponding name in the tree view in the left pane changesas well.

¶ Manufacturer

This field is already filled in with the same manufacturer nameyou entered at the application level in theDefine stage. You canoverride the component level manufacturer name here if it isdifferent. You can specify up to 20 alphanumeric characters, and

Figure 12. The Add button lets you add new components to the list.

26 Version 2.4

the first character must be alphabetic. Underscores are permitted,but blank spaces are not allowed.

Note: If you are building Tivoli GEM modules and plan to dofurther customization using templates in the TMB, the fieldlengths for theName andManufacturer fields may be morerestricted. See theTivoli Module Designer Release Notesfordetails.

¶ Version

The version field has the same major, minor, and revision levelinformation as you defined at the application level. You canoverride these numeric fields for the component level. You canspecify up to 5 numeric characters in these fields.

¶ Platform

Select the desired platform on which the software componentcan run, from thePlatform drop down list. This selection servesas an early filter for the QuickStart wizard. The enabler list youcan select from will include only those enablers which supportyour intended platforms. You can further refine this platformselection later in theFinish stage.

You can select from the following platform types:

Figure 13. Select the platform type from the drop down list.


3.U

singthe

TivoliReady

QuickS

tartW

izard

v Generic: This selection applies to all supported platforms,both Intel and UNIX.

v Generic UNIX: This selection applies only to the list ofsupported UNIX platforms.

v Microsoft Windows 32: This selection applies only to thelist of supported Windows platforms.

Note: Plus modules do not refer to the component platform. Youcan just use the default input ofGeneric.

When your component level information is complete, proceed on tothe selection of enablers for your component. At any time, you canclick on any of the enabler categories in the tree view to skip to theselection panel for that enabler category. You can also click on theInformation branch of the tree view to return to the componentlevel information panel.

In the tree view, you can select from any of the following enablercategories:

¶ Instance Discovery Enablers

¶ Instance Information Enablers

¶ Inventory Enablers

¶ Task Enablers

¶ Monitor Enablers

¶ Connection Enablers

¶ Event Enablers

¶ Deployment Enablers

When you select an enabler category, the right pane of the dialogwindow displays a scrollable list of available enablers for thatenabler category. This list is also filtered by the module type (TivoliGEM, Plus, or IT Director) you specified during theDefine stage.Only those enablers that are applicable to the types of modules youintend to build are shown in this window.

28 Version 2.4

You can select a desired enabler in the scrollable list, and see acorresponding list of parameters that the selected enabler uses tofurther customize its operation. Click theDescription field to fullydisplay the description of the selected enabler or parameter, or movethe cursor over any field to display the full field text.

To select this enabler and add it to your software component, clickAdd. Your selected enabler is then added to the list of selectedenablers at the top of the window, and also appears in the tree viewunder the appropriate enabler type.

For some enabler types, you can select more than one enabler. Justcontinue to select the desired enablers from the list and clickAdd toadd them to the selected enablers list at the top. You can alsoremove selected enablers at any time by selecting the enabler in theselected list and clickingRemove.

For each enabler you selected, you may need to fill in someparameter information to complete the customization of the enabler.You can select any of your chosen enablers in the tree view,

Figure 14. Click Add to add your selected Instance Discovery enabler to the list.


3.U

singthe

TivoliReady

QuickS

tartW

izard

resulting in the right pane displaying the corresponding parametersneeded for that enabler. See “Selecting Enablers” on page 45 fordetails on specific enablers and their parameter values.

For monitor enablers, you may also need to specify threshold valuesand polling intervals. You will navigate through additional dialogs tosupply this information to the QuickStart wizard.

When you have filled in all of your parameter information for all ofyour selected enablers in each of your software components, you canproceed to theFinish stage.

Using the Finish StageThe Finish stage is the final stage of the QuickStart wizard. You canselect this stage when you have completed the definition of yourapplication’s software components, selected the desired enablers andfilled in each enabler’s parameter values during the previous stages.In this stage you can do the following:

¶ Save your work to a QuickStart session file to continue at a latertime

¶ Quit the QuickStart wizard (the last state of the QuickStartwizard is preserved)

¶ Reconfirm or change the types of modules you wish to build

¶ Make some final module-type specific choices for applicationand component options, and then build the Tivoli install imageor AMP files. Items you can select, based on the types ofmodules you are building, include:

v Icon files, containing the icon of the application orcomponent to be displayed on the management console.

v Help files that display help information about yourapplication or component on the management console.

v Further refinement of the specific platform for which yourmodule is to be built, based on the platform group (Generic,Generic UNIX, Windows 32) you selected during theDefinestage.

30 Version 2.4

See “Tivoli GEM Specific Build Options” on page 32 for moreinformation on icon and help files.

Saving the SessionYou can save your session for subsequent work by selectingYes -Save the QuickStart session to a fileradio button on theFinishpage.

You must specify a fully qualified file name and path in the fieldprovided. ClickExit to save the session.

When you return to the QuickStart wizard to continue working onyour session, you can load this session file into the QuickStartwizard by selecting theLoad a QuickStart session fileoption onthe Start tab page.

Quitting the Current SessionYou can exit the QuickStart wizard without saving the session fileby selecting theNo - Do not save the QuickStart sessionradiobutton and selectingExit on theFinish tab page. The current sessionis not saved to a user-specified file. However, the current state of theQuickStart wizard is preserved in a default session file. The nexttime you start the QuickStart wizard you can restore this previoussession and pick up where you left off, or you can start over again.

You can also select this option if you want to build your module butdo not want to save it to a QuickStart session as well.

Figure 15. Saving your QuickStart session to a file


3.U

singthe

TivoliReady

QuickS

tartW

izard

Confirming Your Module Type SelectionThough you previously declared which module types (Tivoli GEM,Plus, or IT Director) to build during theDefine stage (see page 23),you can still change your selection of module types to build duringthe Finish stage.

For example, you may have elected to build all three module types,and defined components and configured enablers for all three moduletypes, but now only want to build one of the modules and build theothers at a later time. In this case, you can deselect one or two ofthe module types so they are not built into Tivoli install images,though their component definitions and enabler configurations canstill be saved in the QuickStart session file, to be loaded and built ata later time.

Click Next to continue with specifying optional module-specificinformation for each module type you intend to build, or select thedesired module specific dialog from theFinish stage tree view.

Tivoli GEM Specific Build OptionsDuring theFinish stage you can specify a few final options specificto building Tivoli GEM modules.

From theFinish stage tree view, selectGEM Specifics to displaythe dialog for entering options applicable to Tivoli GEM modules.

Figure 16. Confirm your module type selection one last time before building themodules.

32 Version 2.4

UnderApplication Options, you can optionally specify thefollowing:

¶ Icon File Name

This is the fully qualified (including file path) name of the filecontaining the icon, representing the application being managed,to be displayed on the management console.

If you know the exact name of the file, enter it in the fieldprovided, or click the... button to navigate to the desired folderwhere the icon file is located.

¶ Help Text File Name

This is the fully qualified (including file path) name of the filecontaining help information for the application being managed,to be displayed on the management console.

If you know the exact name of the file, enter it in the fieldprovided, or click the... button to navigate to the desired folderwhere the help file is located.

¶ Which branch of the GEM tree?

Figure 17. Specifying final build options for Tivoli GEM modules


3.U

singthe

TivoliReady

QuickS

tartW

izard

You can define whether your application should appear on themanagement console under either theApplication orMiddleware/DB branch of the Tivoli GEM tree view, byselecting the appropriate radio button.

UnderComponent Options, for each component you have defined,you can optionally specify the following:

¶ Icon File Name

This is the fully qualified (including file path) name of the filecontaining the icon, representing the component being managed,to be displayed on the management console.

When defining an application or component, you can specify theicon file for displaying the icon of the application or componenton the management console. The icon file you specify mustreside at the path location you indicate in order to build themodule. The following requirements apply to these icon files:

v Animated icons are not supported.

v You can only add and customize icons that representresources.

v Icons must be in the graphical interchange format (GIF), and32x32 pixels in size.

¶ Help Text File Name

This is the fully qualified (including file path) name of the filecontaining help information for the component being managed,to be displayed on the management console.

Note: Help files must remain at the location specified so thatthey can be found during the module build.

The following requirements apply to help files:

v Use only lowercase letters in the help file name and filename extension.

v Use only basic HTML tags in the help file.

v Within the HTML help file, specify a charset value. Forexample:

34 Version 2.4

<META HTTP-EQUIV="Content-Type" CONTENT="text/html;charset=name">

Use the same name value as used in existing help files to ensurea consistent and valid charset value.

¶ Platform

You can refine the platform selection you made during theInstrument stage (see page 27) by clicking on the drop downlist and selecting the specific supported platform or platformgroup for each component.

Plus Specific Build OptionsDuring theFinish stage you can specify a few final options specificto building Plus modules.

From theFinish stage tree view, selectPlus Specificsto display thedialog for entering options applicable to Plus modules.

Figure 18. Refining the platform selection


3.U

singthe

TivoliReady

QuickS

tartW

izard

In the Plus Specificsdialog, as shown in Figure 19, you canoptionally specify the following:

¶ Application Icon File

This is the fully qualified (including file path) name of the filecontaining the icon, representing the application being managed,to be displayed on the management console.

¶ Application Icon (Plus) File

Figure 19. Specifying final build options for Plus modules.

36 Version 2.4

This is the same as the Application Icon File, but also hassuperimposed over it the standard Plus image. You can use anXPM or text editor to create this Plus icon from the applicationicon file.

If you know the exact name of the file, enter it in the fieldprovided, or click the... button to navigate to the desired folderwhere the desired file is located. Icons must be in the XPixMap(XPM) format, and 32x32 pixels in size. Note that the file namemust be of the formxxxxxxPlus.xpm, wherexxxxxx is theapplication icon file name.

¶ Install Options

This is a field where you can specify a list of Plus moduleinstall options. These become install options that becomeavailable at install time. Options in the list are separated bycommas. The QuickStart wizard does not validate this input. Youcan find more information about these install options in theTivoli Module Builder User’s Guide.

¶ Plus module items to include

You can select one or more of the following additional optionsfor Plus modules by checking the corresponding check box:

v Plus Configuration task

Enables you to specify a task that is run as the last step of amodule installation. The task also appears on the desktop soyou can run it again later.

v Endpoint Launch task

This is similar to the Application Launch task in thetraditional Plus template in the Tivoli Module Builder, butwhile that task is designed to run on a managed node, thistask enables you to launch an application on an endpoint. Seethe Plus Application Launch Enabler, on page 84, for moreinformation.

v Create Subscriber List task

This option adds a task to the module that enables theadministrator to create a subscriber list after the module isinstalled.


3.U

singthe

TivoliReady

QuickS

tartW

izard

v Subscriber List for Managed Nodes

This option creates a subscriber list on the TivoliManagement Region (TMR). When a module is installed on amanaged node, this list is automatically updated with thename of the managed node.

v Subscriber List for Endpoints

This option creates an empty subscriber list for endpoints.

v About task

This option creates an About task for the module on theTivoli desktop that displays the module name and version.

By default, all of the checkboxes are selected. You can select ordeselect any or all of them as desired.

Note that there is no option to refine or further specify the platformtype for Plus modules. Platform types are not applicable to Plusmodules, and if you specify platforms for other module types, theyare ignored during the Plus module build.

IT Director Specific Build OptionsDuring theFinish stage you can specify a few final options specificto building IT Director modules.

From theFinish stage tree view, selectITD Specifics to display thedialog for entering options applicable to IT Director modules.

38 Version 2.4

UnderApplication Options, you can optionally specify the bean jarfile name in theBean Jar File field. This is the fully qualified(including file path) name of a Java archive (.jar ) file that maycontain argument and response Java beans, or other resource files.

If you know the exact name of the file, enter it in the field provided,or click the ... button to navigate to the desired folder where the iconfile is located, and select it from there.

UnderComponent Options, for each component you have defined,you must override the platform selection you made during theInstrument stage (see page 27) by clicking on the drop down listand selecting the specific supported platform or platform group foreach component.

Figure 20. Specifying final build options for IT Director modules


3.U

singthe

TivoliReady

QuickS

tartW

izard

Building Your ModulesAfter you have completed specifying your the module-specificoptions, clickNext or selectSummary from theFinish tree view, todisplay the final summary dialog. Your selections for saving thesession file, desired module types to be built, and module-specificinformation is available to you for one last confirmation and chanceto change it before the actual build begins. You can also skip right tothis dialog in theFinish stage if you want to avoid going throughthe individual dialog screens.

Three tab pages, as shown in Figure 21, are available if you want todisplay and modify any of the module-type specific informationwithout going back to the previous dialog windows.

When you are satisfied with your final choices, click theFinishbutton at the bottom to begin the build.

If you have left out any required information, or if the QuickStartwizard detects a problem with your input, a dialog will be displayedwith a list of pointers to the areas that need correction, similar tothat shown in Figure 22 on page 41.

Figure 21. Module-type specific options are available on separate tab pages in theFinish Summary dialog.

40 Version 2.4

You will not be able to build a Tivoli install image if you aremissing required input. If you do have errors, the QuickStart wizardwill list for you the tab pages that you must return to in order tocomplete the required information before proceeding.

For each item in theFinal Check dialog, you can clickShow to betaken to the specific dialog window in the QuickStart wizard wherethe problem was detected. Typically the problem will be a requiredfield that is not filled in or that contains information that theQuickStart wizard considers invalid. This is denoted by the blueempty circle next to the field, indicating that required information isstill needed.

You must correct all of the problems listed in theFinal Checkdialog before you can proceed. ClickFinish at the bottom of theFinish Summary dialog to re-verify that all problems have beencorrected.

Figure 22. The Final Check dialog points you to errors that must be corrected beforethe modules can be built.


3.U

singthe

TivoliReady

QuickS

tartW

izard

The Build Image dialog is displayed, as shown in Figure 23 ,identifying the directory on your system where the build image willreside.

Click OK to start the build, or clickCancel to quit the build.

The build may take some time to complete, depending on yoursystem and the complexity of the modules being built. Status of thebuild in progress is displayed in the running JVM window. When thebuild is complete, theBuild Status dialog is displayed, as inFigure 24:

You can clickExit QuickStart to leave the QuickStart wizard, orclick Don’t leave yet to return to the QuickStart wizard if you wantto continue building modules.

Figure 23. The Build Image dialog shows where the final Tivoli install image will bebuilt.

Figure 24. The Build Status dialog tells you if the build was successful.

42 Version 2.4

Additional CustomizationIf you need to add more advanced instrumentation than theQuickStart wizard provides, you can load your saved module intothe Tivoli Module Builder or Tivoli Module Designer and continuethe instrumentation process from there.

Note: Once you modify your module in the Tivoli Module Builderor Tivoli Module Designer, you will not be allowed to reloadit into the QuickStart wizard.

Loading Tivoli GEM Modules in the Tivoli Module BuilderYou can further customize Tivoli GEM modules by launching theTivoli Module Builder and loading theGEMModule.Java.Extension.v2_3.templatefile. See theTivoliGlobal Enterprise Manager Advanced Business System EnablementGuide for information and examples of loading this extensiontemplate to further customize your Tivoli GEM module.

Loading Plus Modules into the Tivoli Module BuilderYou can further customize Plus modules by launching the TivoliModule Builder and loading the Plus module. See theTivoli ModuleBuilder User’s Guidefor details on Tivoli Plus modules.

Importing IT Director AMPs in Tivoli Module DesignerWhen you build an application management package for Tivoli ITDirector in the QuickStart wizard environment, you use theFileChooserdialog to select your desired files, and the path informationis included with the file in building the AMP for IT Director. Inaddition, the QuickStart wizard generates files for some of theenablers, and includes these in the AMP as well.

When you import this AMP into the Tivoli Module Designer,however, any non-AMS files are ignored, and only the AMSinformation is read in. Any files that are referenced in the AMSinformation must be found when TMD rebuilds the AMP.

To have access to these files when you customize your AMP inTMD, first use a jar file extraction utility, such asjar.exe (which isincluded in the Java Development Kit you installed with the Tivoli


3.U

singthe

TivoliReady

QuickS

tartW

izard

Module Builder product) and extract all of these files from the AMPand put them into a temporary directory. Specify this directory in thePrefix source location with parent directory field in the TMDbuild AMP dialog. When you build the AMP, the TMD will findthose files and the AMP file will build successfully.

Note: When you import the AMP into the TMD, you may get parserwarnings. Parser warnings can usually be ignored. They occurwhen every file in the AMP file gets parsed by TMD to see ifit is a valid AMS file. Any files that are not valid AMS filesshow up in the list of non-parseable files, including anapplication object file (.aof) that is always included in theAMP.

44 Version 2.4

Selecting Enablers

The purpose of the Tivoli Ready QuickStart wizard is to populatethe Tivoli Module Builder (in the case of Tivoli GEM and Plusmodules) and the Tivoli Module Designer (in the case of IT Directormodules) with AMS information and skeletons for commonmanagement functions, including tasks, monitors, deployment andevent definitions. The main mechanism used to gather specific userinput is theenabler.

Enablers are predefined implementations that typically use operatingsystem utilities such as batch files and shell scripts to observe theapplication, discover software components, and report on their status.Enablers can be selected for use and tailored by providing whateverparameters a given enabler requires.

Enablers are platform-specific or generic. Generic enablers run on allsupported platforms. See theTivoli Module Builder Release Notesfor the list of supported platforms.

During theInstrument stage of the QuickStart wizard, you canchoose from the following categories of enablers:

Enabler Category For Details:

Instance Discovery Enablers See page 47

Instance Information Enablers See page 65

Inventory Enablers See page 71

Task Enablers See page 75

4


4.S

electingE

nablers

Enabler Category For Details:

Monitor Enablers See page 101

Connection Enablers See page 139

Event Enablers See page 151

Deployment Enablers See page 159

During theDefine stage, you selected one or more module types tobe built. This selection also acts as a preliminary filter on the list ofenablers that are available for you to include in your build. You willbe presented with the list of enablers that are valid for the types ofmodules you selected. So, for example, if you selected to build onlyTivoli GEM modules, then only the enablers valid for Tivoli GEMmodules will be available for you to choose. If you elect to buildmore than one module type, for example, Tivoli GEM and Plusmodules, then only the enablers that are valid for either Tivoli GEMor Plus modules, as well as enablers common to both types, areincluded in the list of available enablers.

46 Version 2.4

Instance Discovery Enablers

During theInstrument stage of the QuickStart wizard, you definesoftware components that make up your application. For Tivoli GEMmodules, each software component requires a mechanism to notifyTivoli GEM of the instances configured on the system. The processof detecting a software component and notifying the managementtool is calleddiscovery.

The following table shows the Instance Discovery Enablers that areavailable for your Tivoli GEM module.

Note: If you did not select Tivoli GEM as one of your module typesin the Define stage (see page 23), you will not see anyinstance discovery enablers available for selection.

Instance Discovery Enablers For Details:

NT Performance Objects Enabler See page 53

NT Service by Program Name Enabler See page 54

NT Services Enabler See page 56

Single Instance Application Enabler See page 57

Specific NT Service Enabler See page 58

Start Up Parameters Enabler See page 59

User Exit Enabler See page 60

User Exit (using File Pack) Enabler See page 62

User ID and Program Enabler See page 63

5


5.Instance

Discovery

Enablers

Note: You may only selectone instance discovery enabler from thislist.

Selecting an Instance Discovery EnablerUse the following guidelines to choose an instance discoveryenabler. Since this is only a guideline, review all instance discoveryenablers, and the monitors that they enable, before finalizing thechoice for each software component.

1. Does the software component implement one or more NTServices?

¶ If YES, proceed to step 2.

¶ If NO, skip to step 5.

Figure 25. Selecting an instance discovery enabler in the Instrument stage

48 Version 2.4

2. Does the software component implement one and only one NTService per system?

¶ If YES, use the Specific NT Service Enabler (see page 58).

¶ If NO, proceed to step 3.

3. Are multiple services implemented by a single program whosepurpose is to implement the application?

Note: Look in the NT Registry underHKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\Services\to find the registry keys for thesoftware service. The keyImagePath lists the name ofthe program (*.exe) that Windows NT uses to control theservice.

¶ If YES, use the NT Service by Program Name Enabler (seepage 54).


4. Is there a consistent naming convention that uses a commonprefix string as the name of the NT service?

¶ If YES, use the NT Services Enabler (see page 56).


5. Is the software component represented by a Windows NTPerformance Object?



6. Does the NT Performance Object have multiple instances?

¶ If YES, use the NT Performance Objects Enabler (see page53).


7. Can the software component start and execute multiple timesconcurrently on a single system?



5.Instance

Discovery

Enablers

¶ If NO, use the Single Instance Application Enabler (seepage 57) or, if enhanced process-related monitors aredesired, consider the Start Up Parameters Enabler (see page59).

8. Is each instance of the software component started with aunique set of parameters?

Notes:

a. If the software component was started twice with the sameparameters, one of the instances must terminate for you toanswerYES.

b. If the software component is started by a command file orscript, consider the long running program that implementsthe software program.

¶ If YES, use the Start Up Parameters Enabler (see page 59).


9. Is each instance of the software component started under adifferent system user ID?

Note: If the software component was started twice with thesame parameters under the same system user ID, one ofthe instances must terminate for you to answerYES.

¶ If YES, use the User ID and Program Enabler (see page63).


10. Can you create a program (script or binary executable) that caninteract with the software component, with the goal ofidentifying the software component instances?

¶ If YES, use the User Exit Enabler (see page 60) or, theUser Exit (using File Pack) Enabler (see page 62).

¶ If NO, then there is no instance discovery enabler availablethat provides a solution for this software component.

50 Version 2.4

Monitor Enabler DependenciesSeveral monitor enablers (see page 101) are only available when acertain instance discovery enabler is selected. The following tableshows which monitor enablers are available when a particularinstance discovery enabler is selected.

Instance discovery enablers are represented across the top of thetable, as follows:

D1: NT Performance Objects

D2: NT Service by Program Name

D3: NT Services

D4: Single Instance Application

D5: Specific NT Service

D6: Start-up Parameters

D7: User Exit

D8: User Exit (using File Pack)

D9: User ID and Program

MonitorEnabler

D1 D2 D3 D4 D5 D6 D7 D8 D9

State X X X X X X X X X

Process Attribute X X X X X X X X X

Instance ProcessAttribute

X X X X X X X

Process Count X X X X X X X X X

Instance ProcessCount

X X X X X X X

Process Time X X X X X X X X X

Instance ProcessTime

X X X X X X X

NT ObjectCounter with NTInstance

X X X X X X X X X


5.Instance

Discovery

Enablers

MonitorEnabler

D1 D2 D3 D4 D5 D6 D7 D8 D9

NT ObjectCounter w/o NTInstance

X X X X X X X X X

Instance NTCounter

X X X

NT Service X X X X X X X X X

Instance NTService

X X X X X

User ExitNumber

X X X X X X X X X

User ExitNumber (usingFile Pack)

X X X X X X X X X

User Exit String X X X X X X X X X

User Exit String(using File Pack)

X X X X X X X X X

So, for example, the Instance Process Attribute monitor enabler willonly be available for selection if one of the following instancediscovery enablers has been selected:

¶ D2 = NT Service by Program Name

¶ D3 = NT Services

¶ D5 = Specific NT Service

¶ D6 = Start-up Parameters

¶ D7 = User Exit

¶ D8 = User Exit (using File Pack)

¶ D9 = User ID and Program

Other monitor enablers not shown in this table have no dependencyon the selected instance discovery enabler.

52 Version 2.4

Each instance discovery enabler is described in the followingsections.

NT Performance Objects Enabler (GEM)Enabler Category: Instance Discovery

Applicable to module type: Tivoli GEM

Description: This enabler creates an instance of the softwarecomponent for each instance of an NT Performance Object. Theenabler also deletes the instance if it is no longer registered as aninstance of an NT Performance Object. The name of the instance isthe name of the NT Performance Object. An NT object is notnecessarily an NT service.

Select this enablerif the software component is represented by aWindows NT Performance Object and the NT Performance Objecthas multiple instances. If your application does not detail its use ofNT Performance Objects, you can do the following:

1. From theStart menu on a system where the application isrunning, selectPrograms -> Administrative Tools ->Performance Monitor.

2. From theEdit menu on thePerformance Monitor toolbar,selectAdd to Chart .


5.Instance

Discovery

Enablers

3. Select theObject drop-down list to display the objects on yoursystem.

4. Select one of the objects from the drop down list (for example,Process). If there are multiple instances of this object, they willappear in theInstance scrollable list.

Related enablers:None

Prerequisites: None

Required Parameters:

¶ NT Performance Object Name:The name of the NT object (forexample,Process)

Optional parameters: None

Tasks created:None

NT Service by Program Name Enabler (GEM)Enabler Category: Instance Discovery


Figure 26. View your NT Performance Objects using the Performance Monitor.

54 Version 2.4

Description: This enabler detects instances of a software componentfor each Windows NT service that is started by a particular programor image name. The name of the instance is the Windows NT servicename.

The enabler creates new instances of the software component afterthe NT service is registered in theServicesdialog box in theWindows NTControl Panel. The enabler deletes the instance if it isno longer registered as an NT service.

Select this enablerif the software component implements multipleNT services started by a single program whose purpose is toimplement the application.

Related enablers:If the software component implements only oneNT service per system, use the Specific NT Service Enabler (seepage 58). If multiple NT services are implemented by multipleprograms having a common prefix in their NT service names, selectthe NT Services Enabler (see page 56).

Prerequisites: None

Required parameters:

¶ Program or Image Name:The exact program or image name,excluding path information, of the software component’sexecutable file, including the file name and type. The nameshould match the process names displayed by the Windows NTTask Manager.

Note: When this enabler detects a process started by Java, itconsiders the Java class name, excluding the packagename, as the program name to determine if a Javaexecutable needs to be monitored.


Tasks created:When this enabler is built, the following tasks arecreated:


5.Instance

Discovery

Enablers

¶ Start

¶ Stop

NT Services Enabler (GEM)Enabler Category: Instance Discovery


Description: This enabler detects instances of a software componentfor each Windows NT Service that matches the provided servicename prefix. The name of each instance is the Windows NT servicedisplayable name.

The enabler compares the names of the registered NT servicesagainst the provided service name prefix. It creates new instances ofthe registered NT services that match the prefix. For example, if theservice prefix name isDBM and two NT services are registered asDBM AccountingandDBM Inventory, the enabler creates instancesfor each service. The enabler deletes the instance if it is no longerregistered as an NT service.

Select this enablerif the software component implements multipleNT services using more than one program, and if there is aconsistent naming convention that uses a common prefix string asthe name of the NT service.

Related enablers:If the software component implements only oneNT service per system, use the Specific NT Service Enabler instead.If the software component implements more than one NT service bya single program whose purpose is to implement the application,then select the NT Service by Program Name Enabler (see page 54).

Prerequisites: None


56 Version 2.4

¶ Service Name Prefix:The prefix string that is common to themultiple NT service names (for example,DBM matchesDBMAccountingandDBM Inventory)

Optional Parameters: None


¶ Start

¶ Stop

Single Instance Application Enabler (GEM)Enabler Category: Instance Discovery


Description: This enabler enables you to define a single instance ofthe software component on the system where the instrumentation isdeployed. The name of the instance is a parameter that you provide.Since this enabler statically defines the instance, a task is providedthat enables you to remove all awareness of the instance.

Select this enablerwhen the software component cannot start andexecute multiple times concurrently on a single system.

Related enablers:If the software component can start and executemultiple times concurrently, and each instance is started with aunique combination of parameters, you should select the Start UpParameters Enabler (see page 59).

Prerequisites: None

Parameters:

¶ Instance Label:The name of the label that is displayed on themanagement console


5.Instance

Discovery

Enablers


¶ Delete_Instance:Use this task to remove all awareness of theinstance. This task removes the current instance, but does notstop the enabler from rediscovering the instance at a later time.To prevent it from being re-discovered, remove theinstrumentation from the system.

Specific NT Service Enabler (GEM)Enabler category: Instance Discovery


Description: This enabler detects instances of a software componentbased on matching the Windows NT service name. The name of theinstance is the Windows NT service name.

This enabler creates instances only after the NT service is registeredin the Servicesdialog box in the Windows NTControl Panel. Theenabler deletes the instance if it is no longer registered as an NTservice.

Select this enablerif the software component implements one andonly one NT Service per system.

Related enablers:If the software component implements more thanone NT service, then:

¶ If the multiple services are implemented by a single programwhose purpose is to implement the application, you should selectthe NT Service by Program Name Enabler (see page 54).

¶ If the multiple services are implemented by multiple programsthat have a common prefix string as part of their NT servicenames, you should select the NT Services Enabler (see page 56).

Prerequisites: None


58 Version 2.4

¶ Service Name:Name of the NT Service (for example,Messenger), as it appears in theServicesdialog box from theWindows NTControl Panel.

Optional parameters:

¶ None

Tasks created by selecting this enabler:

¶ Start task for the specific NT service

¶ Stop task for the specific NT service

Start Up Parameters Enabler (GEM)Enabler category: Instance Discovery


Description: This enabler enables you to detect instances of asoftware component based on the unique combination of parametersthat start the program. The name of each instance is a combinationof the program name and the parameters that start the program.

The enabler creates new instances of the software component onlywhen a unique combination of program name and parameters isdetected. Once detected, an instance remains discovered until theTivoli GEM database clears or the Tivoli GEM InstrumentationService data stores are deleted. A task is provided that enables youto remove all awareness of the instance.

Select this enablerwhen the software component can be startedmultiple times on a single system, and each instance uses a uniquecombination of parameters that start the program.

Related enablers:If the software component cannot be startedmultiple times concurrently, consider using the Single InstanceApplication Enabler (see page 57). If the software component can bestarted multiple times on a single system, but the parameters thatstart the program may or may not be unique, and each instance of


5.Instance

Discovery

Enablers

the program has a unique user ID, then consider using the User IDand Program Enabler (see page 63).

Prerequisites: None


¶ Process or Image Name:The process or image name parameters,excluding path information, of the software component’sexecutable file, including both the file name and type. The nameshould match the process names displayed by the Windows NTtask manager or theps command on a UNIX system.




¶ Delete_Instance:Use this task to remove all awareness of theinstance. This task removes the current instance, but does notstop the enabler from rediscovering the instance at a later time.To prevent it from being re-discovered, remove theinstrumentation from the system.

User Exit Enabler (GEM)Enabler Category: Instance Discovery


Description: This enabler enables you to detect instances of asoftware component as directed by an external program, or user exit.

60 Version 2.4

Each time the user exit is called it must return all instances for asoftware component. This enabler uses previous instance informationto determine which new instances to create and which no longerexist.

The user exit may also return instance information, includingprocess, service, and NT Performance Object information, whichcertain monitors use to provide enhanced monitoring capabilities.

Select this enablerwhen you want to provide your own user exit todetect instances of your software component.


Prerequisites: This enabler does not package the user exit with theTivoli GEM module. You should ensure that the user exit program isdeployed to the monitored system so it will be found in the systempath when the Tivoli GEM Instrumentation Service attempts to callit.

For additional information on programming a user exit, see“Programming User Exits” on page 169.


¶ User Exit Name:The exact name of the user exit for the enablerto call.

¶ Program Parameters:The program arguments for the user exit.


¶ Setup Environment 1:This enables you to issue a commandprior to invoking the user exit. These environmental changescould include changing the current directory, setting anenvironment variable, or issuing a file command.

¶ Setup Environment 2: This enables you to issue a secondpreparatory command, if desired.

Tasks created:None


5.Instance

Discovery

Enablers

User Exit (using File Pack) Enabler (GEM)Enabler category: Instance Discovery


Description: This enabler enables you to detect instances of asoftware component as directed by an external program, or user exit.This enabler is packaged into a file pack which Tivoli SoftwareDistribution deploys to the systems being monitored.

Each time the user exit is called it must return all instances for asoftware component. This enabler uses previous instance informationto determine which new instances to create and which no longerexist.

The user exit may also return instance information, includingprocess, service, and NT Performance Object information, whichcertain monitors use to provide enhanced monitoring capabilities.

Select this enablerwhen you want to detect instances of thesoftware component using an external program or user exit, and youwant to use Tivoli Software Distribution to deploy the file pack tosystems being monitored.

Related enablers:If you do not want to deploy using TivoliSoftware Distribution, use the User Exit Enabler (see “User ExitEnabler (GEM)” on page 60.

Prerequisites: This enabler does not package the user exit with theTivoli GEM module. You should ensure that the user exit program isdeployed to the monitored system so it will be found in the systempath when the Tivoli GEM Instrumentation Service attempts to callit.


¶ User Exit Name:The name of the user exit for the enabler tocall. Use the browser file option on the input field to select thefile.

62 Version 2.4

¶ Program Parameters:Program arguments for the user exit.


¶ Setup Environment 1:This enables you to issue a commandprior to invoking the user exit. These environmental changescould include changing the current directory, setting anenvironment variable, or issuing a file command.

¶ Setup Environment 2: This enables you to issue a secondpreparatory command, if desired.

Tasks created:None


User ID and Program Enabler (GEM)Enabler Category: Instance Discovery


Description: This enabler enables you to detect instances of asoftware component based on a unique user ID. As an option, youcan create a new instance for each unique user ID and parametercombination. The name of each instance is a combination of the userID, program name, and the parameters.

The enabler creates new instances of the software component onlywhen a unique combination of user ID, program name, andparameters is detected. Once detected, an instance remainsdiscovered until the Tivoli GEM database clears or the Tivoli GEMInstrumentation Service data stores are deleted. A task is providedthat enables you to remove all awareness of the instance.

Select this enablerwhen the software component can be startedmultiple times on a single system, and each instance can bedifferentiated by a unique combination of user ID, program name,and parameters that start the program.


5.Instance

Discovery

Enablers


Prerequisites: None


¶ Program or Image Name:The exact program or image name,excluding path information, of the software component’sexecutable file, including both the file name and type. The nameshould match the process names displayed by the Windows NTtask manager or theps command on a UNIX system.

¶ Consider Parameters:Indicates whether start-up parametersshould also be considered in discovering unique instances of thesoftware component.




¶ Delete_Instance:Use this task to remove all awareness of theinstance. This task removes the current instance, but does notstop the enabler from rediscovering the instance at a later time.To prevent it from being re-discovered, remove theinstrumentation from your system.

64 Version 2.4

Instance Information Enablers

Instance information enablers are available to provide additionalinstance identification during instance discovery, to support TivoliGEM connections and enable instance filtering. Refer to theTivoliGlobal Enterprise Manager Advanced Business System EnablementGuide for more information on instance information enablers.

Examples of instance information, including primary and secondaryattributes, are TCP addresses and port numbers used forcommunicating, or application domain or cluster names.

6


6.Instance

Information

Enablers

The following instance information enablers are available:

Instance Information Enablers For Details:

Instance Information by User Exit Enabler See page 66

Instance Information by User Exit (using File Pack)Enabler

See page 68

Instance Information from Flat File (using File Pack) See page 69

Instance Information by User Exit Enabler (GEM)Enabler category: Instance Information


Description: This enabler calls the user exit that provides instanceinformation. You are responsible for deploying the user exit to thesystem where monitoring will take place. The user exit is called with

Figure 27. Selecting an Instance Information Enabler in the Instrument stage

66 Version 2.4

the instance identifier and must return a complete list of all pairs ofprimary and secondary attributes for the instance.

Select this enablerwhen you want to use a predefined user exit toprovide the instance information and the user exit is alreadyavailable on the target system or it is deployed independently of thisapplication management module.

Related enablers:This enabler does not use Tivoli SoftwareDistribution to package the user exit for deployment. If you want todeploy using Tivoli Software Distribution, use the InstanceInformation by User Exit (using File Pack) Enabler (see page 68).

Prerequisites: The user exit must be created and available so that itcan be added to the instrumentation during the module build. Formore information on building user exits, see “Programming UserExits” on page 169.


¶ User Exit Name:The file name of the desired user exit to call.You can specify just the file name if the file is available in thepath of the target system, or you can specify the fully-qualifiedfile path, or you may choose to use the optionalSetupEnvironmentparameters to set up the desired path.



Note: The instance identifier is the first argument following theprogram parameters.

¶ Setup Environment1:This enables you to issue optionalpreparatory commands to make any necessary environmentalchanges prior to issuing a user exit, for example, changing thecurrent directory, setting an environment variable, or issuing afile command.


6.Instance

Information

Enablers

¶ Setup Environment2:This enables you to issue a second optionalpreparatory command, similar toSetup Environment1. Use asneeded.

Tasks created by selecting this enabler:None

Monitors associated with this enabler:None

Instance Information by User Exit (using File Pack)Enabler (GEM)

Enabler category: Instance Information


Description: This enabler calls the user exit that provides instanceinformation. The user exit is called with the instance identifier andmust return a complete list of all pairs of primary and secondaryattributes for the instance.

Select this enablerwhen you want to use a predefined user exit toprovide the instance information.

Related enablers:This enabler uses Tivoli Software Distribution topackage the user exit for deployment. If you do not want to deployusing Tivoli Software Distribution, use the Instance Information byUser Exit Enabler (see page 66).

Prerequisites: The user exit must be created and available. For moreinformation on building user exits, see “Programming User Exits” onpage 169.


¶ User Exit Name:The file name of the desired user exit to call.Double click this input field to bring up theChoose a Filedialog and navigate to the desired file.


68 Version 2.4



¶ Setup Environment1:This enables you to issue optionalpreparatory commands to make any necessary environmentalchanges prior to issuing a user exit, for example, changing thecurrent directory, setting an environment variable, or issuing afile command.

¶ Setup Environment2:This enables you to issue a second optionalpreparatory command, similar toSetup Environment1. Use asneeded.



Instance Information from Flat File (using File Pack)(GEM)

Enabler category: Instance Information


Description: This enabler uses a flat file to discover instanceinformation associated with a software component instance. The flatfile is packaged for deployment for Tivoli Software Distribution. Youmust provide the name of the flat file when defining this enabler.

The flat file is organized into a list of elements that allow instanceinformation to be provided for one or more instances of the softwarecomponent. Each line in the flat file consists of a key and theinstance information. The enabler uses the key information whensearching the flat file to identify which line applies to the specificinstance. You can also define primary and secondary instanceinformation.


6.Instance

Information

Enablers

For more information on building flat files, see “Flat File Formats”on page 187.

Select this enablerwhen you want to provide a flat file containingadditional instance information for your software component.


Prerequisites: None


¶ File Name:The name of the flat file where additional instanceinformation is defined. Double click this input field to bring upthe Choose a Filedialog and navigate to the desired file.




For more information on building a flat file, see “Flat File Formats”on page 187.

70 Version 2.4

Inventory Enablers

This category of enablers is logically a type of discovery enabler.There is one enabler in this category, the Inventory SignatureEnabler. The Inventory Signature Enabler is optional, but if it isused, there can be only one defined. Inventory enablers discoverinstalled software, while instance discovery enablers discoverrunning instances of software. For these reasons, this enablercategory is separated from the Instance Discovery Enablers category.

Figure 28. Selecting an Inventory Enabler in the Instrument stage

7


7.Inventory

Enablers

The following inventory enablers are available:

Inventory Enablers For Details:

Inventory Signature Enabler See page 72

Inventory Signature Enabler (ITD, Plus)Enabler category: Inventory

Applicable to module types: IT Director, Plus

Description: This enabler detects instances of a software componentbased on a file or list of files, along with file details such as size,date, and time, which together make up theinventory signatureforthe component.

Select this enablerwhen you want to detect specific file names,dates and sizes associated with a specific release level of thesoftware component. If you have the multiple versions of the samesoftware component on your system, you can detect each uniqueinstance of the software component for each unique version orrelease level.


Prerequisites:Any files that you need for inventory must alreadyexist on the system where you are running the QuickStart wizard.During the module build, the QuickStart wizard will access thesefiles and extract certain information it needs to generate theinventory instrumentation. Even if you are building a module for aUNIX platform, for example, and you are running your QuickStartwizard on an Intel system, you must first copy the desired UNIXfiles needed for inventory to an accessible location on the Intelsystem.


¶ Signature File List:This is a list of files with associated details(name, size, date, and time) that you want to associate with your

72 Version 2.4

software component as its inventory signature. You can add filesto the signature file list using the following steps:

1. Double-click on theCurrent Value field in the Parameterswindow for this enabler. TheSignature File List Chooserdialog is displayed.

2. Navigate to the desired subdirectory containing the files youwish to add to the inventory signature file list.

3. Select each desired file and clickAdd to List to add the file,or click Remove from List to remove a file.

4. When you are satisfied with the list of files that make up thesignature, clickAccept to close the dialog and return to theParameterswindow.

Figure 29. Create your inventory signature file list using the Signature File List Chooserdialog.


7.Inventory

Enablers




For further customization of the inventory signature informationusing the Tivoli Module Builder product, note that, for both Plus andIT Director modules, signature information is generated in thecorresponding AMS component. Each signature file will have oneentry in the AMS Software Signature group. If each signature filehas not already been included in the AMS Distribution File Listgroup, an entry will be added to this group with a source locationindex that references a source location of an empty string (″″),providing the same result as selectingnonefor source location usingthe Tivoli Module Designer.

74 Version 2.4

Task Enablers

Task enablers provide operational control of the applicationenvironment. You can define your own tasks using the QuickStartwizard.

Note: Unless otherwise noted, for all tasks which apply to Plusmodules, you will find a Plus-specific parameter calledHidden Task, that indicates whether or not this task shouldbe accessible in the TivoliPlus window. This parameter is setto falseby default, meaning the task is not hidden. If you setthis parameter totrue, the task will be hidden from theTivoliPlus window, but you can still choose the task as aresponse task for the monitor or the Tivoli EnterpriseConsole.

See theTivoli Module Builder User’s Guidefor moreinformation on theHidden Task parameter.

8


8.Task

Enablers

The following task enablers are available:

Task Enablers For Details:

Generic Task Enabler See page 77

Generic Task Enabler, Instance ID Passed In See page 79

IT Director Generic Task (with argument/response bean)Enabler

See page 80

Launch Browser Enabler See page 82

Launch Telnet Enabler See page 83

Plus Application Launch Enabler See page 84

Recover Enabler See page 86

Recover Service Enabler See page 87

Start Task Enabler (GEM Specific) See page 88

Generic Start Task Enabler See page 90

Start Task using File Pack Enabler See page 91

Start NT Service Enabler See page 93

Figure 30. Selecting a Task Enabler in the Instrument stage

76 Version 2.4

Task Enablers For Details:

Stop NT Service Enabler See page 94

Stop Task Enabler (GEM Specific) See page 95

Generic Stop Task Enabler See page 96

Stop Task Using Filepack Enabler See page 97

Specifying Command Parameters for Task EnablersIn the task enabler descriptions that follow, you will find some taskenablers that include parameters enabling you to specify commandsor preparatory commands that will be executed in the Tivoli GEM,Plus, or IT Director environments. These commands are expected tobe in the form of bash shell script command syntax. Plus and TivoliGEM modules run in Tivoli Enterprise environments where a shellscript environment is available.

IT Director modules built by the QuickStart wizard willautomatically include the required shell utilities to deploy to ITDirector endpoints for running these scripts. See theTivoli ModuleBuilder Release Notesunder″IT Director Module Considerations″for more information on the IT Director Application Tools extension.

Generic Task Enabler (GEM, ITD, Plus)Enabler Category: Task Enabler

Applicable to module type: Tivoli GEM, IT Director, Plus

Description: This enabler is used to run arbitrary tasks from themanagement desktop, issuing tasks and capturing results. These tasksare included in the application’s task library, and are part of thesoftware component’s task list that is displayed by the Tivolimanagement console.

This task assumes that the command to be executed is in the path onthe target machine (you can use the preparatory commands to set thepath properly).


8.Task

Enablers

Select this enablerto issue various tasks (command file, script, Javaprogram, or binary executable file) on the target machine, in theTivoli GEM, Plus, or IT Director environments. This enabler isnotinstance specific.

Related enablers:If you want to direct your task to a particularinstance of the software component (for Tivoli GEM only), youshould use the Generic Task Enabler, Instance ID Passed In (seepage 79). If, in the case of Tivoli GEM, the command does not existon the target and you want to distribute the command to the target,you can use the Add File to Filepack Enabler. If, in the case of ITDirector, you want to issue a task using Java argument and responsebeans, or if you want the command distributed, you should use theIT Director Generic Task (with argument/response bean) Enabler (seepage 80).

Prerequisites: None


¶ Task Name:This is the label for the task. Task names must beunique, and are case-sensitive.

¶ Command to execute:This is the name of the command toexecute. See “Specifying Command Parameters for TaskEnablers” on page 77 for more information.

¶ Hidden Task:Only valid for Plus modules, this determineswhether or not the task is hidden in the Plus desktop. It is set tofalseby default. Use the drop down list to select eithertrue orfalse.


¶ Preparatory Command 1:This is valid for all three moduletypes, and can be used to issue a command prior to issuing thecommand to execute. Use this, for example, to set the desiredpath for the command to execute, set an environment variable,or issue a file command.

78 Version 2.4

¶ Preparatory Command 2:This is valid for all three moduletypes, and enables you to issue a second preparatory command ifdesired.

¶ Program Parameters:Any arguments that need to be passed into the command to execute are specified here.

Tasks created:When this enabler is built, the task you specified iscreated.


Generic Task Enabler, Instance ID Passed In (GEM)Enabler Category: Task Enabler


Description: This enabler is identical to the Generic Task Enabler(see page 77), except that it calls the target command to be executedwith the Tivoli GEM instance ID as a parameter. This enables thetask to be directed to a particular instance of the softwarecomponent.

When the instance-based task is issued from the Tivoli GEMconsole, Tivoli GEM provides the instance information to the task. Ifthe instance-based task is issued from the application’s task libraryon the Tivoli desktop, a dialog is displayed that asks you for theinstance ID.

Select this enablerwhen you want to issue a command to a specificinstance of the software component.

Related enablers:If you do not need to direct your task to aparticular instance of the software component (for Tivoli GEM only),you should use the Generic Task Enabler (see page 77). If thecommand does not exist on the target and you want to distribute thecommand to the target system, you can use the Add File to FilepackEnabler. If, in the case of IT Director, you want to issue a task using


8.Task

Enablers

Java argument and response beans, you should use the IT DirectorGeneric Task (with argument/response bean) Enabler (see page 80).

Prerequisites: None



¶ Command to execute:This is the name of the command toexecute.

Optional Parameters:

¶ Preparatory Command 1:This enables you to issue a commandprior to issuing the command to execute. Use this, for example,to set the desired path for the command to execute, set anenvironment variable, or issue a command.

¶ Preparatory Command 2:This enables you to issue a secondpreparatory command if desired.

¶ Program Parameters:Any arguments that need to be passed into the command to execute are specified here. The parametersspecified here precede the instance ID.

Tasks created:When this enabler is built, the generic task youspecified is created.


IT Director Generic Task (with argument/responsebean) Enabler (ITD)

Enabler Category: Task Enabler

Applicable to module type: IT Director

Description: This enabler is valid only for IT Director, and enablesyou to issue tasks using Java argument and response beans. Theargument and response bean names refer to Java beans that exist in a

80 Version 2.4

.jar file that you specify at the project level (see “IT DirectorSpecific Build Options” on page 38).

The Command to executeparameter on this enabler is specified asa file name rather than a text string. The command is automaticallydistributed at execution time to the target, without the need toinclude it in a file pack and distribute it separately. IT Directorcomponents are typically platform specific (as opposed to Pluscomponents, which are platform independent).

Select this enablerwhen you want to use Java beans in the ITDirector environment to issue commands.

Related enablers:See the Generic Task Enabler (page 77), and theGeneric Task Enabler, Instance ID Passed In (page 79) forinformation on related generic task enablers.

Prerequisites:You must create any argument and response beansyou wish to refer to with this enabler.



¶ Command to execute:This is the name of the command toexecute.


¶ Argument Bean:This is the name of the IT Director argumentbean.

¶ Response Bean:This is the name of the IT Director responsebean.

See the document,Managing Applications with Tivoli IT Director, inyour \module_dev\examples\IT Directorsubdirectory, for moreinformation on argument and response beans.


8.Task

Enablers

Tasks created:When this enabler is built, the task you specified iscreated.


Launch Browser Enabler (GEM)Enabler Category: Task Enabler


Description: This enabler defines a Tivoli GEM task to launch alocal web browser on the system where the Tivoli GEM console isrunning, and display a particular Universal Resource Locator (URL)address in the browser window. The URL can contain Tivoli GEMsymbolic variables that are specific to an instance of the softwarecomponent. These symbolic variables will be resolved at the time thetask is executed.

For example, %HB_HOSTNAME% would resolve to the host nameof the machine on which the software component instance isexecuting. The symbolic substitution is especially valuable when thesoftware component has a browser interface for its configuration andmanagement functions.

Select this enablerwhen you want to create a Tivoli GEM task tolaunch a local Web browser and display a particular URL.


Prerequisites: None


¶ Task Name:The name of the task, that will appear on the TivoliGEM console, to launch the local Web browser. Task namesmust be unique, and are case-sensitive.

¶ URL: The address of the web page that displays when thebrowser is launched, for example,http://www.tivoli.com. The

82 Version 2.4

URL can include instance specific symbolic variables that areresolved at task execution time prior to invoking the browser.


Tasks created:When this enabler is built, the Tivoli GEM LaunchLocal Browser task is created.


Launch Telnet Enabler (GEM)Enabler Category: Task Enabler


Description: This enabler defines a Tivoli GEM task to launch alocal telnet session on the system where the Tivoli GEM console isrunning. When invoked from the Tivoli GEM console, the telnetsession attempts to connect to the provided hostname. The hostnamecan contain a Tivoli GEM symbolic variable, such as%HB_HOSTNAME%, that is specific to an instance of the softwarecomponent. This symbolic variable will be resolved at the time thetask is executed.

Select this enablerwhen you want to create a Tivoli GEM task tolaunch a local telnet session and connect to a desired host.


Prerequisites: None


¶ Task Name:This is the name of the task, that will appear on theTivoli GEM console, to launch the local telnet session. Tasknames must be unique, and are case-sensitive.

¶ Hostname:This is the name of the desired host to connect towhen the telnet session is invoked. To target the telnet session tothe host where the specific software component instance is


8.Task

Enablers

executing, input the hostname as%HB_HOSTNAME%. Thehostname is resolved at task execution time prior to invoking thetelnet session.


Tasks created:When this enabler is built, the Tivoli GEM Launchtelnet session task is created.


Plus Application Launch Enabler (Plus)Enabler Category: Task Enabler

Applicable to module type: Plus

Description: This enabler enables an application to be started on amanaged node or endpoint. Similar to the application launch task inthe traditional Plus template, this enabler generates a script thatcreates the application launch icon and invokes the specifiedprogram with the specified parameters on a node, provided that theapplication server check is passed at the time that the module isinstalled. You can include more than one Plus Application LaunchEnabler per QuickStart wizard component.

If you define one or more Plus Application Launch Enablers for agiven QuickStart wizard component, the installed Plus module willinclude one application launch icon for that component. The menuselections on that icon correspond to the Plus Application LaunchEnablers that were specified for that component in the QuickStartwizard. To launch the command specified in a QuickStart wizardPlus Application Launch Enabler, select the application launch iconfor that component on the TivoliPlus window, and from the menu,select the name of the desired enabler task that you wish to launch.

Select this enablerwhen you want to create a Plus task that startsan application on a managed node or endpoint.

84 Version 2.4

Note: To start an application on an endpoint, be sure to check theEndpoint Launch task check box in thePlus Specificsdialog of theFinish stage. See “Plus Specific Build Options”on page 35 for more information.


Prerequisites:You must have the Plus Module Support (LinkBinaries) installed in your TMR before loading your Plus module.See theTivoli Module Builder Release Notesfor more information.


¶ Task Name:The label for the application launch task. Tasknames must be unique, and are case-sensitive.

¶ Launch Program Name:The name of the program to belaunched when this task is invoked.

Note: There is noHidden Task parameter for this enabler. If youwant to create a hidden task on the TivoliPlus window thatstarts or restarts the application, you should use the GenericTask Enabler (see page 77).


¶ Setup Environment 1:This enables you to issue a commandprior to issuing the command to execute. Use this, for example,to set the desired path for the command to execute, set anenvironment variable, or issue a file command.

¶ Setup Environment 2:This enables you to issue a secondpreparatory command if desired.

¶ Launch Program Parameters:Specifies any parameters that needto be passed to the program being launched.

¶ Application Server Check Command:This is the command thatwill be executed to check the node for the application. Thecommand should return a0 if the application does not exist onthe node, or a1 if it does exist.


8.Task

Enablers

Tasks created:When this enabler is built, the application launchtask is created for Plus modules only.


Recover Enabler (ITD, Plus)Enabler Category: Task Enabler

Applicable to module type: IT Director, Plus

Description: This enabler creates a recover task on the desktop.Valid only for Plus and IT Director modules, this enabler generates askeleton file which will call a specified stop program, then call aspecified start program. You can provide additional functionality, forexample, backing up files, by using the Tivoli Module Builder forPlus modules.

Select this enablerwhen you want to create a recover task on yourPlus or IT Director desktop.

Related enablers:If you want to create a task to stop and restart aspecific NT service, then use the Recover Service Enabler (see page87).

Prerequisites: If you want additional functionality beyond startingand stopping the target software component, you must modify theskeleton file to provide this function.


¶ Task Name:This is the label of the recover task. Task namesmust be unique, and are case-sensitive.

¶ Stop Program Name:This is the name of the Stop programname to be executed. This is a string value, which you canspecify as an executable program name, or as a command. See“Specifying Command Parameters for Task Enablers” on page 77for more information.

86 Version 2.4

¶ Start Program Name:This is the name of the Start program tobe executed. This is a string value, which you can specify as anexecutable program name, or as a command. See “SpecifyingCommand Parameters for Task Enablers” on page 77 for moreinformation.

¶ Hidden Task:Only valid for Plus modules, this determineswhether or not the task is hidden on the TivoliPlus window. It isset tofalseby default. Use the drop down list to select eithertrue or false.




¶ Start program parameters:Specify any parameters that need tobe passed to the start program.

¶ Stop program parameters:Specify any parameters that need tobe passed to the stop program.

Tasks created:When this enabler is built, the recover task is createdfor Plus or IT Director environments.


Recover Service Enabler (ITD, Plus)Enabler Category: Task Enabler


Description: This enabler creates a task to recover a specific NTservice. The default implementation stops and then restarts the NTservice. You can provide any additional functionality by using theTivoli Module Builder for Plus modules.


8.Task

Enablers

Select this enablerwhen you want to create a task for Plus or ITDirector modules to restart a NT service.

Related enablers:If you want to generate a task to recover aspecific software component, use the Recover Enabler (see page 86).

Prerequisites: None


¶ Task Name:This is the label of the recover task. Task namesmust be unique, and are case-sensitive.

¶ Service Name:This is the name of the NT service to berestarted.



Tasks created:When this enabler is built, the recover NT servicetask is created.


Start Task Enabler (GEM)Enabler Category: Task Enabler


Description: This enabler generates a start task on the Tivoli GEMconsole to start an instance of a software component, a service, or adaemon.

Select this enablerif you want to create a start task for TivoliGEM, which includes the ability to optionally specify one or twopreparatory commands to set up the environment, as well as

88 Version 2.4

optionally pass the instance ID as one of the arguments, to target aspecific instance of the software component. Use this enabler if youare not requiring Tivoli Software Distribution to deploy yourinstrumentation.

Related enablers:If you want to use Tivoli Software Distribution todeploy your instrumentation, use the Start Task using File PackEnabler (see page 91). If you do not need to target a specificinstance of the software component, you can use the Generic StartTask Enabler (see page 90).

Prerequisites: None


¶ Task Name:This is the name of the start task. Task names mustbe unique, and are case-sensitive.

¶ Program Name:This is the name of the program to be executedby the task.





¶ Pass InstanceID as argument:SelectYes from the drop-downlist to pass in the instance ID as the first argument in theprogram parameters field. This field is set toNo by default.

Tasks created:When this enabler is built, the start task is created tostart a service or daemon.


8.Task

Enablers


Generic Start Task Enabler (GEM, ITD, Plus)Enabler Category: Task Enabler


Description: This enabler is similar to the Start Task Enabler (seepage 88), but is more general in nature and is applicable to all threemodule types. This enabler allows the instance ID to be specified inthe parameter list. This enabler creates a start task to start aparticular service or daemon.

Select this enablerif you want to create a general start task for anyof the module types, and do not need to target a specific instance ofthe software component.

Related enablers:If you want to use Tivoli Software Distribution todeploy your instrumentation for Tivoli GEM modules, use the StartTask using File Pack Enabler (see page 91). If you only need aTivoli GEM task, or if you want to target a particular instance of thesoftware component, you can use the Start Task Enabler (see page88).

Prerequisites: None



¶ Program Name:This is the name of the program to be executedby the task. See “Specifying Command Parameters for TaskEnablers” on page 77 for more information.


¶ Setup Environment 1:This can be used to issue a commandprior to issuing the command to execute. Use this, for example,

90 Version 2.4

to set the desired path for the command to execute, set anenvironment variable, or issue a file command.




Tasks created:When this enabler is built, a start task is created tostart the desired service or daemon.


Start Task using File Pack Enabler (GEM)Enabler Category: Task Enabler


Description: This enabler generates a start task on the Tivoli GEMconsole to start an instance of a software component, for example, aservice or daemon.

Select this enablerif you want to create a start task for TivoliGEM, which includes the ability to optionally specify one or twopreparatory commands to set up the environment, as well asoptionally pass the instance ID as one of the arguments, to target aspecific instance of the software component. Use this enabler if youwant to use Tivoli Software Distribution to deploy yourinstrumentation.


8.Task

Enablers

Note: If you already selected an Instance Discovery NT ServicesEnabler for Tivoli GEM, you do not need to use this enablerto create an NT Service Start task, since one is alreadycreated for you.

Related enablers:If you do not need to use Tivoli SoftwareDistribution to deploy your instrumentation, use the Start TaskEnabler (see page 88). If you do not need to target a specificinstance of the software component, you can use the Generic StartTask Enabler (see page 90).

Prerequisites: None





¶ Preparatory Command 1:This enables you to issue a commandprior to issuing the command to execute. Use this, for example,to set the desired path for the command to execute, set anenvironment variable, or issue a file command.



¶ Pass InstanceID as argument:SelectYes from the drop-downlist to pass in the instance ID as the first argument in theProgram Parametersfield. This field is set toNo by default.

Tasks created:When this enabler is built, the start task is created.


92 Version 2.4

Start NT Service Enabler (ITD, Plus)Enabler Category: Task Enabler


Description: This enabler is specific to Plus and IT Directormodules, and is used to create a task to start a particular NT service.

For Plus modules, a skeleton file is created that calls the appropriateWindows NTnet command, as follows:net start <servicename>

For IT Director modules, an entry is generated in the appropriate.CDF file. The enabler causes theService Start Supportedattributeto be set to 1 (true). IT Director uses this to create a predefinedimplementation of a start service task.

Select this enablerto create a task in the Plus or IT Directorenvironments to start a particular NT service.

Related enablers:There is also an accompanying Stop NT Servicetask. See the Stop NT Service Enabler description on page 93.

Prerequisites: None


¶ Task Name:This is the label of the NT service start task.Software component names must be unique. Task names must beunique, and are case-sensitive.

¶ Service Name:This is the name of the NT service to be started.


Tasks created:When this enabler is built, the desired Start NTService task is created.


8.Task

Enablers


Stop NT Service Enabler (ITD, Plus)Enabler Category: Task Enabler


Description: This enabler is specific to Plus and IT Directormodules, and is used to create a task to stop a particular NT service.

For Plus modules, a skeleton file is created that calls the appropriateWindows NTnet command, as follows:net stop <servicename>

For IT Director modules, an entry is generated in the appropriate.cdf file. The enabler causes theService Stop Supportedattribute tobe set to 1 (true). IT Director uses this to create a predefinedimplementation of a stop service task.

Select this enablerto create a task in the Plus or IT Directorenvironments to stop a particular NT service.

Related enablers:There is also an accompanying Start NT Servicetask. See the Start NT Service Enabler description on page 93.

Prerequisites: None


¶ Task Name:This is the label of the Stop NT Service task. Tasknames must be unique, and are case-sensitive.

¶ Service Name:This is the name of the NT service to be stopped.


94 Version 2.4

Tasks created:When this enabler is built, the desired Stop NTService task is created.


Stop Task Enabler (GEM)Enabler Category: Task Enabler


Description: This enabler generates a stop task on the Tivoli GEMconsole to stop an instance of a software component, for example, aservice or daemon.

Select this enablerif you want to create a stop task for TivoliGEM, which includes the ability to optionally specify one or twopreparatory commands to set up the environment, as well asoptionally pass the instance ID as one of the arguments, to target aspecific instance of the software component. Use this enabler if youare not requiring Tivoli Software Distribution to deploy yourinstrumentation.

Related enablers:If you want to use Tivoli Software Distribution todeploy your instrumentation, use the Stop Task Using FilepackEnabler (see page 97). If you do not need to target a specificinstance of the software component, you can use the Generic StopTask Enabler (see page 96).

Prerequisites: None


¶ Task Name:This is the name of the stop task. Task names mustbe unique, and are case-sensitive.




8.Task

Enablers




¶ Pass instanceID as argument:SelectYes from the drop-downlist to pass in the instance ID as the first argument in theProgram Parametersfield. This field is set toNo by default.

Tasks created:When this enabler is built, the stop task is created tostop a service or daemon.


Generic Stop Task Enabler (GEM, ITD, Plus)Enabler Category: Task Enabler


Description: This enabler is similar to the Stop Task Enabler (seepage 95), but is more general in nature and is applicable to all threemodule types. This enabler has the optional setup environmentcommands, but does not allow the instance ID to be specified in theparameter list. This enabler creates a stop task to stop a particularservice or daemon.

Select this enablerif you want to create a general stop task for anyof the module types, and do not need to target a specific instance ofthe software component.

Related enablers:If you want to use Tivoli Software Distribution todeploy your instrumentation, use the Stop Task Using FilepackEnabler (see page 97). If you only need a Tivoli GEM task, or if you

96 Version 2.4

want to target a particular instance of the software component, youcan use the Stop Task Enabler (see page 95).

Prerequisites: None



¶ Program Name:This is the name of the program to be executedby the task. See “Specifying Command Parameters for TaskEnablers” on page 77 for more information.






Tasks created:When this enabler is built, a Stop task is created tostop the desired service or daemon.


Stop Task Using Filepack Enabler (GEM)Enabler Category: Task Enabler



8.Task

Enablers

Description: This enabler generates a stop task on the Tivoli GEMconsole to stop an instance of a software component, that is, aservice or daemon.

Select this enablerif you want to create a stop task for TivoliGEM, which includes the ability to optionally specify one or twopreparatory commands to set up the environment, as well asoptionally pass the instance ID as one of the arguments, to target aspecific instance of the software component. Use this enabler if youwant to use Tivoli Software Distribution to deploy yourinstrumentation.

Related enablers:If you do not need to use to use Tivoli SoftwareDistribution to deploy your instrumentation, use the Stop TaskEnabler (see page 95). If you do not need to specify anyenvironment setup commands, and do not need to target a specificinstance of the software component, you can use the Generic StopTask Enabler (see page 96).

Prerequisites: None





¶ Preparatory Command 1:This can be used to issue a commandprior to issuing the command to execute. Use this, for example,to set the desired path for the command to execute, set anenvironment variable, or issue a file command.



98 Version 2.4

¶ Pass InstanceID as argument:SelectYes from the drop-downlist to pass in the instance ID as the first argument in theProgram Parametersfield. This field is set toNo by default.

Tasks created:When this enabler is built, the start task is created.



8.Task

Enablers

100 Version 2.4

Monitor Enablers

Monitors enable the operator to view the overall status of themonitored resources. Monitors ensure that key system or networkresources needed by a component are available.

Monitor enablers provide monitoring capabilities for particularapplication characteristics related to the health of the application. ForTivoli GEM modules, the particular monitor enablers that areavailable to you may depend on the instance discovery enabler youhave chosen.

Monitor Enablers and Instance ContextSome monitor enablers for Tivoli GEM provide enhanced monitoringcapabilities according to theinstance-contextof the softwarecomponent being monitored. There are three basic types ofinstance-context information that can be associated with an instance,depending on the instance discovery enabler selected:

¶ Process Leader Context:This consists of the discoveryprogram name, the active process program identification (PID),and the parent PID. The context contains an awareness ofprocess hierarchy in the discovered processes program group.Instance discovery enablers associated with this type ofinstance-context include:

v Start Up Parameters Enabler

v User ID and Program Enabler

9


9.M

onitorE

nablers

v Specific NT Service Enabler

v NT Services Enabler

v NT Service by Program Name Enabler

v User Exit Enabler

¶ Windows NT Service Context:This consists of the discoveredNT Service and the program process ID that implements theservice (if the service is active). The instance discovery enablersthat create this instance-context include:

v NT Service by Program Name Enabler

v NT Services Enabler

v Specific NT Service Enabler

v User Exit Enabler

¶ Windows NT Object Context: This consists of the name of theNT Performance Object responsible for discovering the instance.When an instance of the NT Object is discovered, the contextalso contains the identification of the instance. Instancediscovery enablers associated with this instance-context include:

v NT Performance Objects Enabler

v User Exit Enabler

The discovery services provided by the associated discovery enablerscapture this instance-context information. See “Instance DiscoveryEnablers” on page 47 for details on selecting instance discoveryenablers.

Filtering the List of Monitor EnablersWhen you display the list of available monitor enablers using theQuickStart wizard, remember that this list is filtered according tothree criteria:

¶ The module types you have selected to build (Tivoli GEM, Plus,or IT Director).

102 Version 2.4

The list of enablers will only display those enablers that arevalid for the type of module you are building. For example, ifyou selected Tivoli GEM and Plus module types, only enablersthat are valid for Tivoli GEM, or Plus, or common to those twowill be selectable from the list.

¶ The platform type (selected during theInstrument stage)

¶ The instance discovery enabler you have selected.

Some monitor enablers are only selectable if a certain instancediscovery enabler has been selected. See the table under“Monitor Enabler Dependencies” on page 51) for the list ofmonitor enablers that are available for each instance discoveryenabler selected.

Note: If you are building a Tivoli GEM module, you shouldselect an instance discovery enabler (see “InstanceDiscovery Enablers” on page 47) before you selectmonitor enablers. If you select an instance discoveryenabler and then select monitor enablers, then later onattempt to change the discovery enabler, you may berequired to remove the monitor enablers first.


9.M

onitorE

nablers

Setting Monitor Enabler ThresholdsFor each monitor enabler that you select, you can define thresholdsettings for the various severity levels that the monitor value mayrepresent. For Tivoli GEM and Plus modules, the range of severitylevels includes the following:

¶ Normal

¶ Informational

¶ Warning

¶ Severe

¶ Critical

¶ Fatal

For each of these severity levels, you can select one of the followingoperators from a pull-down menu (the value type for each field isshown in parentheses):

Figure 31. Selecting a Monitor Enabler in the Instrument stage

104 Version 2.4

¶ Greater than (numeric)

¶ Less than (numeric)

¶ Equal (numeric or string)

¶ Not equal (numeric or string)

¶ Changes to (string)

¶ Changes from (string)

¶ Crosses above (numeric)

¶ Crosses below (numeric)

¶ Matches (string)

¶ Does not match (string)

Note: The QuickStart wizard does not perform error checking onyour input. Be sure that the operator you select is applicableto the type of monitor you are using, and that the value youspecify matches the type (numeric or string) for that operator.If not, your module may fail to install properly.

Once you select an operator, you can define an optional value for thethreshold, and the monitor will set the specified severity level basedon the thresholds that are met or exceeded.


9.M

onitorE

nablers

The operator determines how the monitor uses the threshold todetermine the status of a resource. For example, the monitor assessesthe severity level by verifying whether the value is greater than,equal to, or less than, the value specified in theValue field.

For IT Director modules, a different set of severity levels isavailable:

¶ High error (numeric)

¶ Low error (numeric)

¶ High warning (numeric)

¶ Low warning (numeric)

¶ Error (string)

¶ Warning (string)

¶ Return to normal (string)

IT Director internally maps these relative threshold operators toregular AMS operators as follows:

IT Director Threshold AMS Severity AMS Threshold

High error Critical Greater than or equal

High warning Warning Greater than or equal

Figure 32. Specifying monitor enabler thresholds

106 Version 2.4

IT Director Threshold AMS Severity AMS Threshold

Low warning Warning Less than or equal

Low error Critical Less than or equal

Error Critical Matches

Warning Warning Matches

Return to normal Normal Matches

Specifying Monitor Enabler Polling IntervalsThe polling interval indicates how often the monitor should checkthe status of a monitored resource.

When specifying the polling interval, you may take the followinginto consideration:

¶ How often the application or system updates the value of themonitored resource

¶ How quickly an administrator needs to know about the situationbeing monitored

¶ The overhead associated with running the monitor program


9.M

onitorE

nablers

For example, you may wish to specify that the monitor run everyminute in the case of a resource whose failure immediately causesthe application to be unavailable. You may wish to specify a longerinterval for those resources that require more time to reach a criticalstatus.

Enter a numeric value in thePolling Interval field. Select the typeof interval from the drop down menu. The following list indicatesvalid values for each selection on the drop down menu.

¶ 0 to 2,147,483,647 Seconds

¶ 0 to 35,791,394 Minutes

¶ 0 to 596,523 Hours

¶ 0 to 24,855 Days

¶ 0 to 3550 Weeks

Polling Intervals for Multiple InstancesIf you define multiple instances of the same monitor enabler underone component, they will all have the same polling interval. TheApplication Management Specification includes polling interval

Figure 33. Specifying monitor enabler polling intervals

108 Version 2.4

information in the overall monitor definition, not on a per-instancebasis. So if the polling interval for one instance is changed, thechanges will be reflected in the polling intervals of the otherinstances.

For example, an application status monitor definition might looksimilar to the following:AMSSynchronousMonitorDefinition

AMSSynchronousMonitorInstance_1

AMSSynchronousMonitorThreshold_1

AMSSynchronousMonitorThreshold _2

AMSSynchronousMonitorInstance_2



Both AMSSynchronousMonitorInstance_1and ...Instance_2haveunique sets of threshold levels, but the polling interval is part of theoverall ...Definition, and will be applied to both ...Instance_1and...Instance_2.

You can further customize these polling intervals for each instanceusing the Tivoli Module Designer to create a new definition, aftercompleting the module using the QuickStart wizard.

Specifying Monitor Enabler Response TasksFor Plus and IT Director modules, you can optionally define aresponse task that will be executed once the associated thresholdseverity has been reached.

You can only select those tasks that you have previously definedunderTask Enablers in the Instrument section of the QuickStartwizard (see “Task Enablers” on page 75). For each severity level,you can click the drop down menu in theResponse Taskcolumnand select one of the tasks from the list.


9.M

onitorE

nablers

Monitor Enabler DescriptionsThe following monitor enablers are available:

Monitor Enablers For Details:

Custom Monitor Enabler See page 110

Instance NT Counter Monitor Enabler See page 112

Instance NT Service Monitor Enabler See page 113

Instance Process Attribute Monitor Enabler See page 114

Instance Process Count Monitor Enabler See page 115

Instance Process Time Monitor Enabler See page 117

NT Object Counter with no NT Instance MonitorEnabler

See page 118

NT Object Counter with NT Instance MonitorEnabler

See page 120

NT Object Monitor Enabler See page 121

NT Service Monitor Enabler See page 122

Predefined DM Monitor Enabler See page 123

Process Attribute Monitor Enabler See page 124

Process Count Monitor Enabler See page 126

Process Monitor See page 127

Process Time Monitor Enabler See page 128

State Monitor Enabler See page 129

User Exit Number Monitor Enabler See page 130

User Exit Number using File Pack MonitorEnabler

See page 132

User Exit String Monitor Enabler See page 133

User Exit String using File Pack MonitorEnabler

See page 135

Custom Monitor Enabler (ITD, Plus)Enabler Category: Monitor Enabler


110 Version 2.4

Description: You can use this enabler to create a customizedmonitor with no input arguments for Plus or IT Director modules.For Plus modules, a custom Distributed Monitoring (DM) monitorwill be created. Default DM application-specific collection files,class files, and rules files will be automatically generated. For ITDirector modules, a custom monitor will be created. Informationreturned from your monitor can be in numeric or string format.

Select this enablerwhen you have a user-defined custom monitorfor Plus or IT Director modules. You can include this enabler morethan once in your modules, and use the parameter fields to configureit for multiple custom monitors you have defined.

Related enablers:This monitor enabler is not dependent on theselection of any instance discovery enablers.

Prerequisites: None


¶ Monitor Name:The name of the monitor

¶ Monitor Program:The file name of your pre-defined custommonitor.

Note: If you specify a batch file script, the script should exitwith a return value of0 to signify that the monitorexecution was successful.

¶ Return Type:The format of the value returned from the monitor.Select eithernumeric or string from the drop down menu.


¶ Collection Name:This is the label for the monitor’s collection.This is valid only for Plus modules.

¶ Value Description:This is a string value specifying the units ofmeasurement for the returned value, for example,kilobytes, orseconds.

Tasks created:None


9.M

onitorE

nablers

Instance NT Counter Monitor Enabler (GEM)Enabler Category: Monitor Enabler


Description: This monitor enabler returns the value of the NT objectcounter for the discovered instance.

Select this enablerto monitor the value of the NT object counterfor the discovered instance.

Related enablers:This enabler is only available if one of thefollowing instance discovery enablers has been selected:

¶ NT Performance Objects Enabler (see page 53)

¶ User Exit Number Monitor Enabler (see page 60)

¶ User Exit Number using File Pack Monitor Enabler (see page62)

Prerequisites: None


¶ Counter Name:This is the name of the NT Object Counter to bemonitored.

¶ Contribute to State (y or n): Specify whether the state of thismonitor should be included in the overall state of the instance. Ifyou select yes, the State monitor will check the state of thismonitor before returning the overall state of the instance. See theState Monitor Enabler (page 129) for more information.


¶ Query Value

¶ Query Threshold

¶ Set Thresholds

¶ Set Polling Interval

112 Version 2.4

Instance NT Service Monitor Enabler (GEM)Enabler Category: Monitor Enabler


Description: This monitor enabler returns the status of a specific NTservice identified in the Windows NT Service context (see “MonitorEnablers and Instance Context” on page 101 for more information)associated with the software component instance.

This enabler returns the status of an NT Service as eitherRunningor Stopped. These exact keywords must be used for thresholdcomparisons.

Select this enablerwhen you want to monitor the status of adiscovered NT service.

Related enablers:This monitor enabler is only available forselection if one of the following instance discovery enablers hasbeen selected:

¶ NT Service by Program Name Enabler (see page 54)

¶ NT Services Enabler (see page 56)

¶ Specific NT Service Enabler (see page 58)

¶ User Exit Enabler (see page 60)

¶ User Exit (using File Pack) Enabler (see page 62)

Prerequisites: None




9.M

onitorE

nablers


¶ Query Value

¶ Query Threshold

¶ Set Thresholds


Instance Process Attribute Monitor Enabler (GEM)Enabler Category: Monitor Enabler


Description: This monitor enabler returns the value of the processattribute of the program identified in the Process Leader Context (see“Monitor Enablers and Instance Context” on page 101 for moreinformation) associated with the instance. Attributes monitoredinclude:

¶ Percentage of CPU (whole numbers from 0 to 100)

¶ Total rate of page faults (per second)

¶ Total amount of resident memory committed (in kilobytes)

Select this enablerif you want to monitor a specific processattribute (cpu, paging, or memory) of the discovered instance.





¶ Start Up Parameters Enabler (see page 59)



114 Version 2.4

¶ User ID and Program Enabler (see page 63)

Prerequisites: None


¶ Process Attribute:Select the process attribute (cpu, memory, orpaging) to monitor from the drop-down list.



¶ Query Value

¶ Query Threshold

¶ Set Thresholds


Note: When this enabler detects a process started by Java, itconsiders the Java class name, excluding the package name,as the program name to determine if a Java executable needsto be monitored.

Instance Process Count Monitor Enabler (GEM)Enabler Category: Monitor Enabler


Description: This monitor enabler counts the total number of activeprocesses implemented by the process name in the Process LeaderContext (see “Monitor Enablers and Instance Context” on page 101for more information) associated with the software componentinstance.


9.M

onitorE

nablers

This enabler only considers those processes within the instance’sprocess group. It returns a value of zero or greater for thresholdprocessing.

Select this enablerto monitor the number of active processes thatare implemented by the discovered process name instance.









Prerequisites: None




¶ Query Value

¶ Query Threshold

¶ Set Thresholds


116 Version 2.4


Instance Process Time Monitor Enabler (GEM)Enabler Category: Monitor Enabler


Description: This monitor enabler returns the total number ofelapsed minutes that a process has been active. The process name isidentified in the Process Leader Context (see “Monitor Enablers andInstance Context” on page 101 for more information) associated withthe software component instance.

This enabler only considers those processes within the instance’sprocess group. It returns a value of zero or greater for thresholdprocessing.

If the provided process name implements more than one process, thisenabler returns the elapsed time for the process with the leastamount of active time.

Select this enablerwhen you want to monitor the total number ofminutes that a process for a discovered instance has been active.









9.M

onitorE

nablers


Prerequisites: None




¶ Query Value

¶ Query Threshold

¶ Set Thresholds



NT Object Counter with no NT Instance MonitorEnabler (GEM, ITD)

Enabler Category: Monitor Enabler

Applicable to module type: Tivoli GEM, IT Director

Description: This monitor enabler creates a monitor for an NTobject counter with no associated NT instances. This enabler is validfor Tivoli GEM or IT Director modules. This monitor enabler isavailable for selection with Tivoli GEM only if one of the InstanceDiscovery Enablers has been selected.

Select this enablerto monitor an NT performance object counterwith no associated Windows NT instances.

118 Version 2.4

Related enablers:Any of the instance discovery enablers can beselected to enable selection of this monitor enabler. If you want tomonitor an NT performance object counter with associated instances,use the NT Object Counter with NT Instance Monitor Enabler (seepage 120).

Prerequisites: None


¶ Object Name:This is the name of the NT performance object,for example,Process.

¶ Counter Name:This is the name of the NT performance counter,for example,%Processor Time.


¶ Value Type:Specifies the type of data to be returned by thecounter. Available choices include:

v unknown

v 32-bit string

v 64-bit string

v floating point

Tasks created:When this enabler is built for Tivoli GEM, thefollowing tasks are created:

¶ Query Value

¶ Query Threshold

¶ Set Thresholds



9.M

onitorE

nablers

NT Object Counter with NT Instance Monitor Enabler(GEM)



Description: This monitor enabler creates a monitor for an NTperformance object counter with NT instances. Windows NTPerformance Objects and associated counters provide a detailed viewinto the health of an application.

Select this enablerto monitor an NT performance object counterwith instances.

Related enablers:Any of the instance discovery enablers can beselected to enable selection of this monitor enabler. If you want tomonitor an NT performance object counter with no associatedinstances, use the NT Object Counter with no NT Instance MonitorEnabler (see page 118).

Prerequisites: None


¶ Object Name:This is the name of the NT performance object,for example,Process.

¶ Counter Name:This is the name of the NT performance counter,for example,%Processor Time.

¶ Instance Name:This is the name of the NT Object Instance, forexample,Command for NT Object Process. Many NT objects donot support multiple instances. If the NT object you aremonitoring does support multiple instances, include this valueonly if you want to exclude other instances from your discovery.


120 Version 2.4


¶ Query Value

¶ Query Threshold

¶ Set Thresholds


NT Object Monitor Enabler (ITD)Enabler Category: Monitor Enabler


Description: This enabler generates an AMS predefined NTPerformance Object monitor.

Select this enablerto generate a predefined NT Performance Objectmonitor for IT Director modules.


Prerequisites: None


¶ Object Name:This is the name of the performance object.

¶ Multiple Instances:This field indicates whether the objectsupports single or multiple instances. Selectyesor no from thedrop down menu provided.


¶ Event Category:This field contains source specificcategorization information. See the document,ManagingApplications with Tivoli IT Director, in the\module_dev\examples\IT Directorsubdirectory where youinstalled the Tivoli Module Builder.

Tasks created:None


9.M

onitorE

nablers

NT Service Monitor Enabler (GEM, ITD, Plus)Enabler Category: Monitor Enabler


Description: This monitor enabler returns the status of an NTService as either running or stopped.

Select this enablerto monitor an NT Service and determine if it isoperational or not.

Related enablers:If you are building a Tivoli GEM module, youmust select one of the instance discovery enablers to enable selectionof this monitor enabler. If you want to monitor status of a specificNT service identified in the Windows NT Service context (see“Monitor Enablers and Instance Context” on page 101 for moreinformation) associated with the software component instance, usethe Instance NT Service Monitor Enabler (see page 113).

Prerequisites: None


¶ NT Service Name:This is the name of the NT service to bemonitored. This field is used for IT Director modules only. Ifyou are only building Tivoli GEM or Plus modules, enter anynon-blank alphanumeric characters here; it will be ignored.

¶ NT Service Display Name:This is the more″user friendly″ namefor the NT service. This field is used for Tivoli GEM and Plusmodules only. If you are only building an IT Director module,enter any non-blank alphanumeric characters here; it will beignored.

Note: You can use the Microsoft command line utility,sc.exeto findboth the service name and service display name for NTservice. See the following Web site for additional informationon thesc.exeutility:

http://msdn.microsoft.com/library/techart/msdn_scmslite.htm

122 Version 2.4

¶ Contribute to State (y or n): Specify whether the state of thismonitor should be included in the overall state of the instance. Ifyou select yes, the State monitor will check the state of thismonitor before returning the overall state of the instance. Thisparameter is required only for Tivoli GEM modules. See theState Monitor Enabler (page 129) for more information.

Tasks created:When this enabler is built for Tivoli GEM, thefollowing tasks are created:

¶ Query Value

¶ Query Threshold

¶ Set Thresholds


Predefined DM Monitor Enabler (Plus)Enabler Category: Monitor Enabler


Description: This enabler allows reuse of existing DistributedMonitoring (DM) monitors in a Plus module. The monitors may beselected from the following collections:

¶ DM Universal

¶ UNIX

¶ NT_Event_Log

¶ NT_Memory

¶ NT_Process

¶ NT_System

¶ NT_NetworkMonitor

¶ NT_NetworkInterface

¶ NT_ClientServicesforNetWare


9.M

onitorE

nablers

Note: Only the synchronous monitors in these collections aresupported.

Select this enablerif you want to define a synchronous monitorfrom an existing DM collection.


Prerequisites: Collections that you select here should be installed inyour TMR before installing this Plus module.


¶ Collection Name:This is the name of the DM collection.

¶ Monitor Name:This is the name of the monitor from thecollection.


¶ Monitor Arguments:This is a list of argument values for themonitor.

Tasks created:None

Process Attribute Monitor Enabler (GEM)Enabler Category: Monitor Enabler


Description: This monitor enabler returns the specific processattributes for a program or image name.

Attributes monitored include:

¶ Percentage of CPU (whole numbers from 0 to 100)

¶ Total rate of page faults (per second)

¶ Total amount of resident memory committed (in kilobytes)

If this monitor executes on an instance that has a Process LeaderContext, the enabler considers only the processes within the

124 Version 2.4

instance’s process group. If a Process Leader Context is notassociated with the instance, all processes on the system areconsidered by this monitor.

Select this enablerwhen you want to monitor the specific processattribute (cpu, memory, paging) of a program or image name.

Related enablers:For Tivoli GEM, you must select one of theinstance discovery enablers for this enabler to appear in the monitorenabler selection list. If you want to monitor the process attribute ofthe program identified in the Process Leader Context associated witha discovered instance, use the Instance Process Attribute MonitorEnabler (see page 114).

Prerequisites: None


¶ Process or Image Name:Provide the exact program or imagename, excluding path information, of the software component’sexecutable file, including both the file name and type. The nameshould match the process name displayed by the Windows NTtask manager or the output of theps command on a UNIXsystem.

¶ Process Attribute:Select the process attribute (cpu, memory, orpaging) to monitor from the drop-down list.



¶ Query Value

¶ Query Threshold

¶ Set Thresholds


9.M

onitorE

nablers



Process Count Monitor Enabler (GEM)Enabler Category: Monitor Enabler


Description: This monitor enabler counts the total number of activeprocesses implemented by the provided program or image name. Itreturns a value of zero or greater for threshold processing.

Select this enablerto monitor the total number of active processimplemented by a program or image name.

Related enablers:If you want to count the total number of activeprocesses implemented by the process name in the Process LeaderContext associated with the software component instance, use theInstance Process Count Monitor Enabler (see page 115). For TivoliGEM, you must select one of the instance discovery enablers for thisenabler to appear in the monitor enabler selection list.

Prerequisites: None


¶ Process or Image Name:Provide the exact process or imagename, excluding path information, of the software component’sexecutable file. Include both the file name and type. The nameshould match the process name displayed by the Windows NTtask manager or the output of theps command on a UNIXsystem.

¶ Contribute to State (y or n): Specify whether the state of thismonitor should be included in the overall state of the instance. Ifyou select yes, the State monitor will check the state of this

126 Version 2.4

monitor before returning the overall state of the instance. See theState Monitor Enabler (page 129) for more information.


¶ Query Value

¶ Query Threshold

¶ Set Thresholds



Process Monitor Enabler (ITD, Plus)Enabler Category: Monitor Enabler


Description: This enabler creates a process monitor in Plus and ITDirector modules.

For Plus modules, this enabler will create an instance of theApplication Status monitor from the DM Universal monitorcollection.

For IT Director modules, an instance of the AMS predefined monitortype ApplicationProcessIdentificationwill be generated. See theApplication Management Specification(AMS) version 2.0, section7.6.5.4 for more information.

Select this enablerto create a process monitor in Plus or ITDirector modules.


Prerequisites: None


9.M

onitorE

nablers


¶ Process Name:This is the name of the process or service to bemonitored. It is a string value.

Tasks created:None

Process Time Monitor Enabler (GEM)Enabler Category: Monitor Enabler


Description: This monitor enabler returns the total number ofelapsed minutes that the process has been active. The process isidentified by the program or image name. If the provided processname implements more than one process, this enabler returns theelapsed time for the process with the least amount of active time.

Select this enablerto monitor the total elapsed time that a processhas been active.

Related enablers:For Tivoli GEM, you must select one of theinstance discovery enablers for this enabler to appear in the monitorenabler selection list. If you want to monitor the total elapsed timefor a process identified in the Process Leader Context associatedwith a discovered software component instance, use the InstanceProcess Time Monitor Enabler (see page 117).

Prerequisites: None


¶ Process or Image Name: The exact program or image name,excluding path information, of the software component’sexecutable file. Include both the file name and type. The nameshould match the process names displayed by the Windows NTtask manager or the output of theps command on a UNIXsystem.

¶ Contribute to State (y or n): Specify whether the state of thismonitor should be included in the overall state of the instance. If

128 Version 2.4

you select yes, the State monitor will check the state of thismonitor before returning the overall state of the instance. See theState Monitor Enabler (page 129) for more information.


¶ Query Value

¶ Query Threshold

¶ Set Thresholds



State Monitor Enabler (GEM)Enabler Category: Monitor Enabler


Description: This monitor enabler returns the overall state of aspecific instance.

During the definition of all other monitor enablers, you determinewhether a monitor will contribute to the overall state. The Statemonitor considers every other monitor that contributes to state beforereturning the overall state of the instance. This monitor returnsuponly if all monitors that contribute to state are considered normal orinformational. If one or more of the monitors are in any other state,this monitor returnsdown.

Select this enablerwhen you want to monitor the state of othermonitors created by other monitor enablers that can contribute to theoverall state of the instance.

Related enablers:For Tivoli GEM, you must select one of theinstance discovery enablers for this enabler to appear in the monitor


9.M

onitorE

nablers

enabler selection list. Other monitor enablers that have an option tocontribute to the overall state can be set to combine their state withthe overall instance state.

Prerequisites: None

Parameters: None


¶ Query State

¶ Query Value

¶ Query Threshold

¶ Set Thresholds


User Exit Number Monitor Enabler (GEM)Enabler Category: Monitor Enabler


Description: This monitor enabler works with an external program,or user exit, to monitor a numerical attribute of a softwarecomponent instance.

Select this enablerif you must put the logic to monitor the softwarecomponent into an external program which returns its monitor valueas a number.

Related enablers:For Tivoli GEM, you must select one of theinstance discovery enablers for this enabler to appear in the monitorenabler selection list. If you want to return the status of the user exitas a character string for thresholding purposes, use the User ExitString Monitor Enabler (see page 133).

Prerequisites: The user exit needs to be created and available forselection.

130 Version 2.4


¶ Monitor Name: The descriptive label for the user exit monitorprogram you have created.

¶ User Exit Name: The name of the user exit to be run. Make surethat the user exit program and any supporting programs are inthe path on the target machine. Provide the exact program orimage name, excluding path information, of the softwarecomponent’s executable file. Include both the file name andtype.



¶ Setup Environment1: This enables you to issue an optionalpreparatory command to make any environmental changes priorto invoking the user exit. These environmental changes couldinclude changing the current directory, setting an environmentalvariable, or issuing a file command.

¶ Setup Environment2: Same asSetup Environment1.

¶ Program Parameters: Provide the program arguments for theuser exit.


¶ Query Value

¶ Query Threshold

¶ Set Thresholds




9.M

onitorE

nablers

User Exit Number using File Pack Monitor Enabler(GEM)



Description: This monitor enabler works with an external program,or user exit, to monitor a numerical attribute of a softwarecomponent instance. This enabler uses Tivoli Software Distributionto deploy the instrumentation.

Select this enablerif you must put the logic to monitor the softwarecomponent into an external program which returns its monitor valueas a number, using Tivoli Software Distribution to deploy theinstrumentation.

Related enablers:For Tivoli GEM, you must select one of theinstance discovery enablers for this enabler to appear in the monitorenabler selection list. If you want to return the status of the user exitas a character string for thresholding purposes, use the User ExitString Monitor Enabler (see page 133). If you do not want to deployusing Tivoli Software Distribution, use the User Exit NumberMonitor Enabler.



¶ Monitor Name: This is the descriptive label for the user exitmonitor program you have created.

¶ User Exit Name: Provide the name of the user exit to be run.Make sure that the user exit program and any supportingprograms are in the path on the target machine. Provide theexact program or image name, excluding path information, ofthe software component’s executable file. Include both the filename and type.

132 Version 2.4







¶ Query Value

¶ Query Threshold

¶ Set Thresholds



User Exit String Monitor Enabler (GEM)Enabler Category: Monitor Enabler


Description: This monitor enabler works with an external program,or user exit, to monitor a string attribute of a software componentinstance.


9.M

onitorE

nablers

Select this enablerif you must put the logic to monitor the softwarecomponent into an external program which returns its monitor valueas a character string.

Related enablers:For Tivoli GEM, you must select one of theinstance discovery enablers for this enabler to appear in the monitorenabler selection list. If you want to return the status of the user exitas a number for thresholding purposes, use the User Exit NumberMonitor Enabler (see page 130).









134 Version 2.4



¶ Query Value

¶ Query Threshold

¶ Set Thresholds



User Exit String using File Pack Monitor Enabler(GEM)



Description: This monitor enabler works with an external program,or user exit, to monitor a character string attribute of a softwarecomponent. This enabler uses Tivoli Software Distribution to deploythe instrumentation.

Select this enablerif you must put the logic to monitor the softwarecomponent into an external program which returns its monitor valueas a character string, and use Tivoli Software Distribution to deploythe instrumentation.

Related enablers:For Tivoli GEM, you must select one of theinstance discovery enablers for this enabler to appear in the monitorenabler selection list. If you want to return the status of the user exitas a number for thresholding purposes, use the User Exit NumberMonitor Enabler (see page 130). If you do not want to deploy usingTivoli Software Distribution, use the User Exit String MonitorEnabler.


9.M

onitorE

nablers











¶ Query Value

¶ Query Threshold

¶ Set Thresholds


136 Version 2.4



9.M

onitorE

nablers

138 Version 2.4

Connection Enablers

Connection enablers are provided to support Tivoli GEMconnections. Displayed as directional lines on the Tivoli GEMconsole, connections represent a relationship between two instances.Connection enablers can discover and display unmonitoredconnection lines.

Connections are identified by two main pieces of information: aconnection type and a direction. When you define a component tosupport a certain connection type and direction, you can thenconnect it to other components that also support the same connectiontype and direction.

You can also enable a component to report a connection, that is, aparticular connection type and direction pair, as well as a destination.A line will display on the Tivoli GEM console, between the twocomponents, which support the same connection type and directionpair.

Additional information, calledprimary andsecondaryattributes,identify the endpoints of the connection. An example of theseattributes areIP addressandPort #, respectively.

10


10.C

onnectionE

nablers

The following connection enablers are available:

Connection Enablers For Details:

Discover Connections by User Exit Enabler See page 140

Discover Connections by User Exit using File PackEnabler

See page 143

Discover Connections from Flat File using File PackEnabler

See page 146

Support Connection Enabler See page 148

Discover Connections by User Exit Enabler (GEM)Enabler Category: Connection Enabler


Figure 34. Selecting a Connection Enabler in the Instrument stage

140 Version 2.4

Description: This connection enabler reports connections betweeninstances as directed by a user exit. The user exit is called with theinstance identifier. This enabler reports only connections that matchthe specified connection type/direction characteristics. Multiplereport connections can be defined for an instance. Connectionsdisplay on the Tivoli GEM console.

This enabler does not use Tivoli Software Distribution to deploy theinstrumentation.

Select this enablerto report connections between instances using auser exit.

Related enablers:If you want to report connections using a userexit and you want to deploy the instrumentation using TivoliSoftware Distribution, use the Discover Connections by User Exitusing File Pack Enabler (see page 143).

Prerequisites:You must have a user exit defined, which prints allthe information needed to report a connection to stdout. The userexit should return information relating to one connection for eachline. For each connection, there are four main attributes:

¶ Connection type

¶ Connection direction

¶ Primary attribute

¶ Secondary attribute

The latter two identify the destination and are followed by theirvalues. The Primary Attribute can beTCPIPAddressorTCPIPHostNameor GenericAttribute, while the Secondary attributecan haveTCPIPServiceor TCPIPPortor GenericAttribute. Theitems are separated by a tilde (x). For example:Databasex3xTCPIPAddressx9.1.2.5x*xTCPIPPortx55

Mailx2xGenericAttributexp1xp2xGenericAttributexp3xp4

From the above examples,

¶ DatabaseandMail are two connection types


10.C

onnectionE

nablers

¶ 3 and2 represent connection directions:

v 1 = Origin

v 2 = Destination

v 3 = Conversational (bi-directional)

¶ The values forTCPIPAddressandTCPIPPort follow thesekeywords; the same holds true forGenericAttribute.

Note: Since stdout is used for communication, nothing should bewritten to stdout except the information associated with thisexit call.


¶ Type:Provide the name of the connection type. In order for aconnection between two instances to be established, theconnection type and connection direction must also be definedon the software component instance that supports the connection,which you can do using the Support Connection Enabler (seepage 148).

¶ Direction: The direction of the connection. Valid values are:

v Origin

v Destination

v Conversational (bi-directional)

¶ User Exit Name:The name of the user exit. Type in the nameexactly as you want it to be executed.


¶ Setup Environment1:This enables you to issue optionalpreparatory commands to make any environmental changes priorto issuing a user exit. These environmental changes couldinclude changing the current directory, setting an environmentalvariable, or issuing a file command.

¶ Setup Environment2:Same asSetup Environment1.

142 Version 2.4

¶ Program Parameters:Provide the program arguments for theuser exit.


Monitors associated with this enabler:Monitors can be associatedwith connections to make them active using advancedinstrumentation with Tivoli Module Builder.


Discover Connections by User Exit using File PackEnabler (GEM)

Enabler Category: Connection Enabler


Description: This connection enabler reports connections betweeninstances as directed by a user exit. The user exit is called with theinstance identifier. This enabler reports only connections that matchthe specified connection type/direction characteristics. Multiplereport connections can be defined for an instance. Connectionsdisplay on the Tivoli GEM console.

This enabler uses Tivoli Software Distribution to deploy theinstrumentation.

Select this enablerto report connections between instances using auser exit.

Related enablers:If you want to report connections using a userexit and you do not want to deploy the instrumentation using TivoliSoftware Distribution, use the Discover Connections by User ExitEnabler (see page 140).


10.C

onnectionE

nablers

Prerequisites:You must have a user exit defined, which prints allthe information needed to report a connection to stdout. The userexit should return information relating to one connection for eachline. For each connection, there are four main attributes:

¶ Connection type

¶ Connection direction

¶ Primary attribute

¶ Secondary attribute

The latter two identify the destination and are followed by theirvalues. The Primary Attribute can beTCPIPAddressorTCPIPHostNameor GenericAttribute, while the Secondary attributecan haveTCPIPServiceor TCPIPPortor GenericAttribute. Theitems are separated by a tilde (x). For example:Databasex3xTCPIPAddressx9.1.2.5x*xTCPIPPortx55

Mailx2xGenericAttributexp1xp2xGenericAttributexp3xp4

From the above examples,

¶ DatabaseandMail are two component types

¶ 3 and2 represent connection directions:

v 1 = Origin

v 2 = Destination

v 3 = Conversational (bi-directional)

¶ The values forTCPIPAddressandTCPIPPort follow thesekeywords; the same holds true forGenericAttribute.

Note: Since stdout is used for communication, nothing should bewritten to stdout except the information associated with thisexit call.


¶ Type:Provide the name of the connection type. In order for aconnection between two instances to be established, theconnection type and connection direction must also be defined

144 Version 2.4

on the software component instance that supports the connection,which you can do using the Support Connection Enabler (seepage 148).


v Origin

v Destination


¶ User Exit Name:Provide the name of the user exit by typing inthe name exactly as you want it to be executed.


¶ Setup Environment1:This enables you to issue optionalpreparatory commands to make any environmental changes priorto issuing a user exit. These environmental changes couldinclude changing the current directory, setting an environmentalvariable, or issuing a file command.

¶ Setup Environment2:Same asSetup Environment1.

¶ Program Parameters:Provide the program arguments for theuser exit.


Monitors associated with this enabler:Monitors can be associatedwith connections to make them active using advancedinstrumentation with Tivoli Module Builder.



10.C

onnectionE

nablers

Discover Connections from Flat File using File PackEnabler (GEM)

Enabler Category: Connection Enabler


Description: This enabler uses a flat file to report connections for ancomponent instance. The flat file lists elements that reportconnections for instances of a software component. This enablerreports only connections that match the specified connectiontype/direction characteristics. Multiple report connections can bedefined for an instance. The flat file is packaged for deployment byTivoli Software Distribution.

Select this enablerif you want to use a flat file to reportconnections for a component instance.

Related enablers:You can use a user exit instead of a flat file toreport connections. Use either the Discover Connections by UserExit Enabler (see page 140) or the Discover Connections by UserExit using File Pack Enabler (see page 143).

Prerequisites:You must have a flat file defined, which includes allthe information needed to report a connection.

The flat file contains information that defines the type, direction anddestination of the connections inkey=valueformat.

Flat file lines consist of a key, which determines which definitionsapply to an instance, and the report connection information,including connection type, connection direction, and primary andsecondary attributes.

To specify a connection for all the instances, theglobals.relationskey is used. Another key,instance.relations.<instanceID>is used forspecific instances (whereinstanceIDis the instance identifier. Anyblanks in the instanceID should be replaced with underscores).

146 Version 2.4

For each valid value, there are four main attributes:

¶ Connection Type

¶ Connection Direction

Valid values include:

1. Origin

2. Destination

3. Conversational (bi-directional)

¶ Primary Attribute


v TCPIPAddress

v TCPIPHostName

v GenericAttribute

¶ Secondary Attribute


v TCPIPService

v TCPIPPort

v GenericAttribute

The latter two identify the destination and are followed by theirvalues. The items are separated by a tilde (x).

For example:globals.relations.1=Databasex3xTCPIPAddressx9.1.2.5x*xTCPIPPortx55x*

globals.relations.2=Mailx2xGenericAttributexp1xp2xGenericAttributexp3xp4

Each attribute is followed by its value (in the first example above,the attributeTCPIPAddressis followed by its value,9.1.2.5). Withthe exception ofGenericAttribute, all are single-valued and so adummy (* in the above example) is used to mark the other value.The Connection Type attribute, with a value ofDatabase, is a labelthat identifies the type of connection, followed by the ConnectionDirection attribute, with a value of3. All of the keys in the file


10.C

onnectionE

nablers

should be unique, which is why the numbers1 or 2 are appended atthe end of theglobals.relationskey in the above examples.


¶ Type: Provide the name of the connection type. In order for aconnection between two instances to be established, theconnection type and connection direction must also be definedon the software component instance that supports the connection,which you can do using the Support Connection enabler.


v Origin

v Destination

v Conversational

¶ File Name: The name of the flat file containing the definedconnection.

For additional information on specifying flat files, see “Flat FileFormats” on page 187.

Support Connection Enabler (GEM)Enabler Category: Connection Enabler


Description: This connection enabler configures the component tosupport a given type/direction combination. This enabler gives thecomponent the ability to let other components connect to it using thegiven connection type/direction.

Select this enablerto configure components to support a specifictype/direction pair for a connection.

Related enablers:See the other connection enablers in this sectionfor information on reporting connections between components usinguser exits and flat files.

148 Version 2.4

Prerequisites: None


¶ Type:Provide the name of the particular connection.


v Origin

v Destination



10.C

onnectionE

nablers

150 Version 2.4

Event Enablers

Event enablers provide a mechanism for gathering the informationrequired to configure any of the supported Tivoli Enterprise Console(TEC) event adapters.

You can select one or more event enablers for your modules duringthe Instrument stage, however you are limited to selecting only onecustom adapter per application. The list of available event enablersyou can select from is shown in the scrollable list. This list displaysonly those event enablers that are valid for the module type(s) youhave chosen to build.

11


11.E

ventE

nablers

The following event enablers are available:

Event Enablers For Details:

Custom Adapter Enabler (ITD) See page 153

Custom Adapter Enabler (Plus) See page 154

Logfile Adapter Enabler See page 155

You can filter this list further by checking or unchecking the selectboxes for the desired module type, reducing or expanding the list ofvalid enablers to choose from.

To select an event enabler, highlight the enabler name and clickAddto add the monitor to theSelected Event Enablerslist at the top ofthe dialog. The selected event enabler’s parameters are shown in thescrollable list at the bottom of the dialog.

Figure 35. Selecting an Event Enabler in the Instrument stage

152 Version 2.4

Custom Adapter Enabler (ITD)Enabler Category: Event Enabler


Description: The Custom Adapter Event Enabler creates a customadapter configuration task in your IT Director module.

Your custom adapter is a program that you develop outside of theQuickStart wizard environment. The Custom Adapter Enablerhandles definition and packaging of this adapter and its associatedsetup program in your IT Director module. Only one custom adaptercan be configured per application.

Select this enablerif you want to create a custom adapterconfiguration task for your IT Director module.


Prerequisites:You must create the customized IT Director adapteroutside of the QuickStart wizard environment.


¶ Configuration Program File: This is the name of theconfiguration program that performs the adapter setup. Specifythe full path name for the file. You can double-click on thisinput field to bring up a selection dialog, enabling you tonavigate to the desired directory and select the desired file name.

¶ Adapter Path: This is the path to the directory of the adapterexecutables.

¶ Adapter File: This is the name of the adapter executable file.Specify the full path name for the file. You can double-click onthis input field to bring up a selection dialog, enabling you tonavigate to the desired directory and select the desired file name.

Tasks created:When this enabler is built, a custom adapterconfiguration task is created for your customized event adapter.


11.E

ventE

nablers

Custom Adapter Enabler (Plus)Enabler Category: Event Enabler


Description: The Custom Adapter Enabler creates a custom adapterconfiguration task in your Plus module. This results in the creationof a task on the desktop, and as a result, creates a new TivoliModule Builder component to support the custom adapters. You canselect only one event adapter per application.

Any BAROC or rules files that are specified are accumulated in aTivoli Enterprise Console (TEC) Server Configuration Taskcomponent. This task must be executed on the TEC event servermanaged node in order to be introduced into the TEC system.

Note: The custom adapter must have already been installed on theend point.

Select this enablerwhen you want to create a custom event adapterconfiguration task for your Plus module.


Prerequisites:You must have a custom event adapter created foryour Plus environment, and the adapter must already be installed onthe endpoint.


¶ Task Name: This is the name of the configuration task. It is astring value.

¶ Configuration Program: This is the program that is run by theconfiguration task. Specify the full path name for the file. Youcan double-click on this input field to bring up a selectiondialog, enabling you to navigate to the desired directory andselect the desired file name.


154 Version 2.4

¶ Rule File: This is the name of the file (including file path)containing the specific rules for this instance of the logfileadapter. You can double-click on this input field to bring up aselection dialog, enabling you to navigate to the desireddirectory and select the desired file name.

¶ BAROC File: This is the name of the file (including file path)used to configure the TEC event server to accept messages fromthis adapter. You can double-click on this input field to bring upa selection dialog, enabling you to navigate to the desireddirectory and select the desired file name.

Tasks created:When this enabler is built, a custom event adapterconfiguration task is created to appear on the TivoliPlus window.

Logfile Adapter Enabler (Plus)Enabler Category: Event Enabler


Description: The Logfile Adapter Enabler creates a logfile adapterconfiguration task in your Plus module.

The task is generated using a skeleton that creates and configures anadapter configuration profile (ACP) that is specific to a platform oradapter type, ready for distribution to endpoint subscribers. The task,when run on the TivoliPlus window, prompts you for the platform oradapter type, and the event log path name. It then uses thisinformation to create a dataless profile manager and ACP on theTivoliPlus window for that platform and adapter type.

A TEC configuration task is also created on the TivoliPlus window.Executing this task uses the BAROC and rules files you specify inthe enabler parameters to set up the TEC event server. See theTivoliModule Builder User’s Guide, Chapter 25, for more information onthe TEC configuration component, from which theSetup TECEvent Server task is generated.


11.E

ventE

nablers

You can then distribute the configuration of the logfile adapter on anendpoint, including stopping and starting the adapter, by distributingthe profile manager or profile to endpoints of the appropriateplatform type using standard ACP (user/command line) interfaces.

You also have access to the profile record on the TivoliPlus window,enabling you to customize the configuration after the task creates theprofile but before you distribute it.

Any BAROC or rules files that you specify are accumulated in aTEC Server Configuration Task component. This task must beexecuted on the TEC event server managed node in order to beintroduced into the TEC system.

Select this enablerto create a logfile adapter configuration task foryour Plus environment.


Prerequisites: None


¶ Task Name: This is the name of the configuration task. It is astring value.

¶ Format File: This is the name of the file (including file path)containing the formatting information for the logfile. You candouble-click on this input field to bring up a selection dialog,enabling you to navigate to the desired directory and select thedesired file name.


¶ Configuration Variables: This is a list of variable names andtheir values, which are inserted into the adapter’s configurationfile at configuration time. It is a string value. The format is a listof variables and their values, delimited by a semicolon (forexample: Var1=value1;Var2=value2;...).

156 Version 2.4

¶ Rules File: This is the name of the file (including file path)containing the specific rules for this instance of the logfileadapter. You can double-click on this input field to bring up aselection dialog, enabling you to navigate to the desireddirectory and select the desired file name.

¶ BAROC File: This is the name of the file (including file path)used to configure the TEC event server to accept messages fromthis adapter. You can double-click on this input field to bring upa selection dialog, enabling you to navigate to the desireddirectory and select the desired file name.

Tasks created:When this enabler is built, a logfile adapterconfiguration task is created for your Plus environment.

Using Existing Logfile Adapter InstrumentationYou may choose to use the version 2.3 logfile adapterinstrumentation by changing the reference to the configuration taskskeleton, using the Tivoli Module Builder, to reference the version2.3 skeleton file,PLUSconfig_logadapter.sh.skel. Configurationvariables you specified in the above enabler are then ignored, sincethey are not used by the old skeleton.

If you have an existing (version 2.3) logfile adapter task that shouldbe upgraded to use the TEC 3.6 Adapter Configuration Facility(ACF), you can use the new skeleton,PLUSQSconfig_logadapter.sh.skel.

In either case, in using skeletons across different versions of theTivoli Module Builder, you should modify the AMS definition forthe task arguments to match what is expected by the task skeleton.You can find both of these skeletons in the following directory:

\module_dev\ToolKit/templates/Module/Plus*.template


11.E

ventE

nablers

158 Version 2.4

Deployment Enablers

Deployment enablers provide mechanisms for distributing andinstalling your module components on one or more machines so thatthe module’s management features are accessible to Tivoli’smanagement software, in the Tivoli GEM, Plus, and IT Directorenvironments.

The deployment enablers available for selection have uniquecharacteristics and features for Tivoli GEM, Plus and IT Directormodules. Details are included in the enabler descriptions.

The list of available deployment enablers you can select from isshown in the scrollable list. This list displays only those deploymentenablers that are valid for the module type(s) you have chosen tobuild.

12


12.D

eployment

Enablers

The following deployment enablers are available:

Deployment Enablers For Details:

Add File to Filepack Enabler See page 161

InstallShield Enabler See page 161

InstallShield Deployment Enabler See page 166

You can filter this list further by checking or unchecking the selectboxes for the desired module type, reducing or expanding the list ofvalid enablers to choose from.

To select a deployment enabler, highlight the enabler name and clickAdd to add the monitor to the Selected Deployment Enablerslistat the top of the dialog. The selected enabler’s parameters are shownin the scrollable list at the bottom of the dialog.

Figure 36. Selecting a Deployment Enabler in the Instrument stage

160 Version 2.4

Add File to Filepack Enabler (GEM)Enabler Category: Deployment Enabler


Description: This deployment enabler, valid for Tivoli GEMmodules only, gives the ability to bundle additional files needed bythe user exits into the same file pack (as the user exits) and bedistributed onto the target system using Tivoli Software Distribution.It can be used in conjunction with the user exitDiscovery/Monitor/Task enablers that use the Tivoli SoftwareDistribution file pack. To add multiple files this enabler should beselected and added multiple times.

Select this enablerwhen you want to bundle additional files to bedistributed with the user exits onto the target systems using TivoliSoftware Distribution.

Related enablers:See the Discovery, Monitor and Task enablersections for information on user exits that use Tivoli SoftwareDistribution.

Prerequisites: The file you want to bundle must be created andavailable for inclusion in the file pack.


¶ File Name: This is the file name of the file to be included in theTivoli Software Distribution file pack. You can double-click onthis input field to bring up a selection dialog, enabling you tonavigate to the desired directory and select the desired file name.

Tasks created:None

InstallShield Enabler (ITD, Plus)Enabler Category: Deployment Enabler



12.D

eployment

Enablers

Description: This enabler allows you to specify an installationimage name and an InstallShield.iss file. It also allows you tospecify basic install prerequisites for Plus modules that are generatedinto a script, that can be run before the installation. This script isattached to the Plus module file package. This enabler is valid forPlus or IT Director modules.

Plus Module ImplementationA task and a file package profile will be created on the desktop. TheInstallShield.iss file that contains the automated commands for theinstallation is included as part of the file package definition.

IT Director Module ImplementationIf your instrumentation includes auxiliary files that are distributed toan endpoint, AMS includes a CONFGLOC extension to identifywhere these files are located for the install. Deployment uses thesame CONFGLOC mechanism as UNIX utilities in ApplicationTools to execute InstallShield. Details on this extension can be foundin the document,Managing Applications With Tivoli IT Director,which is included in the Tivoli IT Director Integration Toolkit, andalso available in the\module_dev\examples\IT Directordirectory.

CONFGLOC is written in the C language, and you will need accessto a Windows 32-bit C compiler. A sample CONFGLOC file isprovided with the TMB product for your reference (see the followingtar file: apache_1_3_6_ITD_example.tar, located in the followingdirectory: \module_dev\examples\IT Director\. It contains the Csource code for CONFGLOC, example argument and responsebeans, and other samples for your use), to test your work and toprovide a working example, but itcannot be used as-is, because theresulting file generated by running this sample program would be thesame for all modules generated by the QuickStart wizard. If youinstall more than one module generated by the QuickStart wizard,the .bat file for the first installed module will be overwritten.

In addition to the CONFGLOC parameter, you must specify thename of the setup program (invoked from the install script).

162 Version 2.4

The InstallShield File Package enabler file list will be merged withthe file list of the component to which the enabler belongs. Locationtable entries will be added to the component as needed.

An additional parameter allows you to choose whether or not toinclude the setup program for the enabler in the generated AMP file.

You may only select one InstallShield File Package enabler percomponent.

Select this enablerto add an InstallShield image name and an.issfile to your Plus or IT Director module.

Related enablers:This enabler does not provide for predefineddependencies. If you are building an IT Director module and youneed to specify predefined dependencies, use the InstallShieldDeployment Enabler (see page 166).

Prerequisites:You need to provide any before-install or after-installprograms you want to specify for Plus modules, and theCONFGLOC program for IT Director. Thesetup.issandsetup.exefiles must already exist on the same system you are running theQuickStart wizard, since these files are examined by the wizard atmodule build time for information needed to build the module.


¶ Task Name(required for Plus modules only): This is the name ofthe file package configuration task. It is a string value.

¶ InstallShield setup.exe image file: This is the name of theInstallShieldsetup.exeprogram. You can double-click on thisinput field to bring up a selection dialog, enabling you tonavigate to the desired directory and select the desired file name.

¶ Include setup.exe in module image: Selectyesor no from thedrop-down menu, choosing whether to include thesetup.exeprogram for the enabler in the generated Plus module image orIT Director AMP file.


12.D

eployment

Enablers

Note: If the setup.exeprogram is excluded from the image,nested file packs are used to install the image. In thiscase, you may need to upgrade your TMR and associatedmanaged nodes to Tivoli Management Framework 3.6.3or later.

¶ InstallShield .iss file: This is the path to the InstallShieldsetup.issfile. You can double-click on this input field to bringup a selection dialog, enabling you to navigate to the desireddirectory and select the desired file name.

¶ Default Application Directory on Targets: This is the defaultdirectory where the application will be installed on the targetmachines. It must be the same value as the directory specified inthe setup.issfile. This is a string value. Be sure to include thedrive letter, and use back slashes in all cases, for example:C:\install_my_app_here

¶ CONFGLOC File(required for ITD modules only): This is thepath to the IT Director CONFGLOC program. You candouble-click on this input field to bring up a selection dialog,enabling you to navigate to the desired directory and select thedesired file name.


¶ Before Install Program: This is the name of the program to runbefore installation. You can double-click on this input field tobring up a selection dialog, enabling you to navigate to thedesired directory and select the desired file name.

¶ After Install Program: This is the name of the program to runafter installation. You can double-click on this input field tobring up a selection dialog, enabling you to navigate to thedesired directory and select the desired file name.

Note: The above two fields apply only to Plus modules.

¶ Application File List: This is the path to a directory containingadditional files that may be required for the application.

164 Version 2.4

Double-click on this field to bring up theDistribution File ListChooserdialog.

Navigate to the desired folder, highlight it, and selectGenerateList . A file list entry is created for each file in that folder. Youcan erase the list by clickingClear List , and choose a differentfolder if you like. When you are satisfied, clickAccept to closethe dialog and return to the enabler parameter list.

Tasks created:When this enabler is built for Plus modules, a taskand a file package profile will be created on the desktop.

Figure 37. Specifying the Application File List


12.D

eployment

Enablers

InstallShield Deployment Enabler (ITD)Enabler Category: Deployment Enabler


Description: This enabler allows you to specify an installationimage name and an InstallShield.iss file. This script is attached tothe file package.

Refer to the discussion, “IT Director Module Implementation” onpage 162, which describes the usage of the CONFGLOC program.

An additional parameter allows you to choose whether or not toinclude the setup program for the enabler in the generated AMP file.

You may only select one InstallShield File Package enabler percomponent.

Select this enablerto add an InstallShield image name and a.issfile to your IT Director module.

Related enablers:IT Director allows you to specify predefineddependencies in the enabler. This enabler provides for predefineddependencies. If you are building a Plus or IT Director module andyou do not need to specify predefined dependencies, use theInstallShield Enabler (see page 161).

Prerequisites:You need to provide the CONFGLOC program for ITDirector. Thesetup.issandsetup.exefiles must already exist on thesame system you are running the QuickStart wizard, since these filesare examined by the wizard at module build time for informationneeded to build the module.


¶ InstallShield setup.exe image file: This is the name of theInstallShieldsetup.exeprogram. You can double-click on thisinput field to bring up a selection dialog, enabling you tonavigate to the desired directory and select the desired file name.

166 Version 2.4

¶ Include setup.exe in module image: Selectyesor no from thedrop-down menu, choosing whether to include thesetup.exeprogram for the enabler in the generated AMP file.

¶ InstallShield .iss file: This is the path to the InstallShieldsetup.issfile. You can double-click on this input field to bringup a selection dialog, enabling you to navigate to the desireddirectory and select the desired file name.

¶ Default Application Directory on Targets: This is the defaultdirectory where the application will be installed on the targetmachines. It must be the same value as the directory specified inthe setup.issfile. This is a string value. Be sure to include thedrive letter, and use back slashes (to match exactly the directoryin setup.iss) in all cases, for example:C:\install_my_app_here

¶ CONFGLOC File: This is the path to the IT DirectorCONFGLOC program. You can double-click on this input fieldto bring up a selection dialog, enabling you to navigate to thedesired directory and select the desired file name.


¶ Application File List: This is the path to the directory containingadditional files that may be required for the application.Double-click on this field to bring up theDistribution File ListChooserdialog (see Figure 37 on page 165).

Navigate to the desired folder, highlight it and selectGenerateList . A file list entry is created for each file in that folder. Youcan erase the list by clickingClear List , and choose a differentfolder if you like. When you are satisfied, clickAccept to closethe dialog and return to the enabler parameter list.

¶ Installation Dependencies: This is a list of predefineddependencies that you can select from a special dialog.Double-click on this input field to bring up theSelectedDependenciesdialog.


12.D

eployment

Enablers

Click on theDependency Typedrop-down menu to select oneof several predefined dependency types, such as RequiredMemory, OS Version, Registry Entry, and so on. For eachdependency, you can specify a certain value, or fill in severalvalue fields with the desired information, then click theleft-arrow button to add the dependency to theSelectedDependencieslist. When you are done, clickOK to return tothe enabler parameter dialog.

Tasks created:None

Figure 38. Define dependencies with the Selected Dependencies dialog.

168 Version 2.4

Programming User Exits

The Tivoli Ready QuickStart wizard enables augmentation of itsinstrumentation through user exits. There are Tivoli GEMInstrumentation Service enablers that call user exits using thesystemroutine for Windows NT and thepopen routine for UNIX systems.In both cases, the same programming interface of stdout and stderr isused. The information captured in stdout is used as thecommunication link.

This user exit programming interface is intended to be used toaugment QuickStart wizard features for applications that cannot beproperly supported with the built-in functions of the QuickStartwizard. This ability to augment instrumentation functionality throughthe use of user exits is not intended to generally replace buildinginstrumentation with what is described in theTivoli GlobalEnterprise Manager Advanced Business System Enablement Guide.

User Exit RequirementsThe following are the requirements for QuickStart wizard user exits:

¶ QuickStart wizard user exits are associated with a particularsoftware component.

¶ The types of user exits that can be defined are:v Instance discoveryv Monitorv Instance informationv Task

A


A.

Program

ming

User

Exits

v Connection

¶ Ensure nothing is written to stdout and stderr except theinformation that is associated with the user exit call. Thissuppression is important for any routine called inside the userexit.

¶ Properties considerations

The Tivoli GEM Instrumentation Service enables user exits toassociate data with a software component instance or a specificmonitor by maintaining this data, which is calledproperties, andmaking it available to subsequent user exit calls. Consider thefollowing about these properties:

v Instance properties are available to monitor user exits.

v Monitor properties are available only to the specific monitoruser exit.

v The user exit that creates a property is responsible forremoving it when the information it contains is no longerrelevant.

v Properties are not maintained across shutdown and startup ofthe Tivoli GEM Instrumentation Service.

¶ With Windows NT, the Tivoli GEM Instrumentation Service usesthe Tivoli bash shell interpreter to run your user exit when theuser exit has a file type of.sh.

Setting Up the EnvironmentWhen defining a user exit enabler using the QuickStart wizard, youcan optionally definepreparatorycommands to make anyenvironmental changes prior to issuing the user exit. Theseenvironmental changes can include such things as changing thecurrent directory, setting an environment variable, or issuing acommand file.

When using a.sh command file as a preparatory command, be sureto inline its call if you want its environment changes to be in effectafter the shell command file completes. For example:

170 Version 2.4

. command_name.sh

On Windows NT, preparatory commands and enabler user exits areexecuted in the Tivoli scripting environment. As a result, you mustconsider the following:

¶ Directory paths should use forward slashes (/), rather thanWindows NT backward slashes (\).

¶ Although a Windows NT command file (.bat or .cmd) can beused as a preparatory command, it cannot be used to change theTivoli shell command environment, such as current directory orsetting an environment variable that runs the user exit afterreturning from the preparatory command.

¶ When defining the use of a Windows NT command files (.bat or.cmd) in a task or user exit, input the command as follows toinvoke it in the native command environment:cmd /c whatever.cmd

Note: This is not required if you define the.cmd or .bat file tothe QuickStart wizard by selecting it though the browsecontrol.

Instance Discovery User ExitAn instance discovery user exit controls the creation and deletion ofTivoli GEM software component instances. The user exit is called bya Tivoli GEM Instrumentation Service instance discovery user exitenabler.

An instance discovery user exit can tag properties to softwarecomponent instances in the form ofname=valuepairs. By usingTivoli GEM Instrumentation Service defined property names,instance discovery user exits can provide properties that enable theuse of Tivoli GEM Instrumentation Service built-in instance contextmonitor enablers. For example,PID=valueprovides instance contextinformation for the Instance Process Time enabler.

The instance discovery user exit returns a complete list of instancesfor a particular software component instance each time it is called.


A.

Program

ming

User

Exits

The Tivoli GEM Instrumentation Service takes appropriate action onthe information in the returned list.

Calling an Instance Discovery User ExitBased on the information provided to the QuickStart wizard, theTivoli GEM Instrumentation Service instance discovery user exitenabler uses the instance name specified as an identifying label, andsets up the environment by issuing any of the preparatory commandsspecified. Then, it calls the instance discovery user exit in thefollowing manner:

User-Exit_name [parm1...parmN] "comp" "ver"

The value of the calling parameters are described in the followingtable:

Parameter Description

User-Exit_name The name of the user exit.

parm1...parmN(optional)

Specifies the parameters for the named user exit,which the user exit might not require to control itslogic, but allowing parameters to be specifiedenables one user exit to be written to handlemultiple functions.

comp The name of the software component.

ver The version or release of the software component.

Note: The compandver parameters are passed as single argumentsregardless of any delimiters contained within them.

Instance Discovery User Exit ResponseThe instance discovery user exit responds by listing instances tostdout for the software component. This complete list of instancesmust be returned each time the user exit is called. When a stringrepresenting a particular software component instance is not returnedin the list of instances, the Tivoli GEM Instrumentation Serviceassumes that the instance no longer exists.

172 Version 2.4

The instance discovery user exit puts the following to stdout for eachinstance:

InstanceIDx[InstanceLabel]x[name1=value1x...xnameN=valueN]

The response parameter descriptions are listed in the following table:


InstanceID Specifies a unique string that represents a softwarecomponent instance. If this string is not returned inthe list of instances on subsequent calls to the userexit, the Tivoli GEM Instrumentation Serviceassumes that the instance no longer exists.

InstanceLabel(optional)

Specifies the name of the instance that is displayedto the operators. When anInstanceLabelis notprovided, theInstanceIDis used in its place.

nameN=valueN(optional)

A name=valuepair mechanism for the user exit toassociate properties to an instance. It enables the userto associate any useful information to the instancewhich can later be retrieved and processed.

Notes:

1. Each line should at least have anInstanceID.

2. All items are separated by a tilde (x).

Processing the Instance Discovery User ExitResponse

Tivoli GEM Instrumentation Service uses the returned information tocorrelate the instance with system components. This enables TivoliGEM built-in monitors to be used with these instances.

The Tivoli GEM Instrumentation Service detects new instances thatare being reported for the first time and previously discoveredinstances that are no longer in the returned list. In each case, theappropriate action is taken.

Certain key names are reserved and recognizable by the Tivoli GEMInstrumentation Service. When the user exit returns one of these key


A.

Program

ming

User

Exits

names, the value that is returned is processed and can be used toassociate built-in monitors to the instance. The following arerecognized key names:

¶ PID=process_leader_PID

WhenPID is specified, ensure that its value is the process leaderPID of an active process on the system. When an invalid valueis detected, a dummy instance property by the name ofprocessLeader is created.

¶ NTObject=object_name

This is the Windows NT object name that represents theinstance. For example, whenNTObject=Processor is specified,an instance property is created. If the Windows NT ObjectProcessor does not exist on the system, the option is ignored.

For Windows NT objects that have no instances, just the objectname suffices for creating an instance property.

¶ NTService=name_of_service

This is the Windows NT service name that represents theinstance. For example, whenNTService=Messenger is specified,an instance property is created. If theMessenger Windows NTService does not exist on the system, the option is ignored.

Note: NTObject andNTService key names apply only to theWindows NT platform.

As an example, an instance discovery user exit puts the followinginformation to stdout:

LotusNotesAppxLotus NotesxPID=234xInfo=Mail ServerMessengerxMessenger ServicexNTService=MessengerMicrosoftOfficexMS Office Performance ObjectxNTObject=Process\MSOFFICE

The preceding example of the stdout information shows differentvariants of how the user exit can be specified. For line 1 of theresponse, the values and their descriptions are listed in the followingtable:

174 Version 2.4

Value Description

LotusNotesApp This value tells the Tivoli GEM InstrumentationService that the following information on this lineapplies to InstanceIDLotusNotesApp (an internalrepresentation).

Lotus Notes This value tells the Tivoli GEM InstrumentationService that the instance LotusNotesApp is to bedisplayed on the Tivoli GEM console with a displayname ofLotus Notes.

PID=234 This keyword=valuepair tells the Tivoli GEMInstrumentation Service that the instanceLotusNotesApp is to be associated with the processleader of that instance, whose process identifier is234.

Info=Mail Server This propertiesname=valuepair tells the TivoliGEM Instrumentation Service the additionalproperty information to be added to the instance.

With process information for the instance already in place, all thebuilt-in instance process monitors that are provided with theQuickStart wizard (like Instance Process Count, Instance ProcessTime, and Instance Process Attribute) can be added to monitor thisinstance.

The last two lines in the preceding example of the stdout(InstanceIDs:Messenger andMicrosoftOffice) enable theinstances to add built-in instance monitors for Windows NT Serviceand Windows NT Object, respectively.

Monitor User ExitsA monitor user exit can be associated with one or more Tivoli GEMsoftware component monitors and is classified by the type of datathat it can return. It is called by a Tivoli GEM InstrumentationService monitor user exit enabler.

A monitor user exit can create properties information that is only incontext to the conditions that it is running under in the form ofname=valuepairs.


A.

Program

ming

User

Exits

A monitor user exit is responsible for communicating the currentvalue of the attribute it is monitoring. The current value must bereturned each time the monitor user exit is called.

Calling a Monitor User ExitBased on the information provided to the QuickStart wizard, theTivoli GEM Instrumentation Service monitor user exit enabler usesthe monitor name specified as an identifying label, and sets up theenvironment by issuing any of the preparatory commands specified.Then it calls the monitor user exit, optionally passing parameters,including any instance property and monitor property value pairs inthe following manner:

User-Exit_name [parm1...parmN] "InstanceID" "comp" "ver" "properties"

The monitor user exit calling parameters and their descriptions arelisted in the following table:


User-Exit_name The name of the user exit.



comp The name of the software component.

ver The version or release of the software component.

properties Thesename=valuepairs are properties that werereturned from previous calls to the user exit. Eachname=valuepair is enclosed in quotes.

Note: The compparameter and thever parameter are passed assingle arguments regardless of any delimiters contained withinthem.

The Tivoli GEM Instrumentation Service monitor user exit enablercan pass both instance and monitor properties as parameters whencalling a monitor user exit. The user exit program can access these

176 Version 2.4

properties from the input stream, but update operations can only beperformed on the monitor properties. User exits only have read-onlyaccess to instance properties.

Monitor User Exit ResponseThe monitor user exit program processes any parameters passed. Itcan update or delete monitor properties, but cannot update or deleteinstance properties because it only has read-only access to instanceproperties. To delete a property, the user exit must use the keywordfor the property without the value.

The monitor user exit provides the current value of the attribute it ismonitoring and any propertyname=valuepairs in its response tostdout. The current value must be returned each time the monitoruser exit is called.

The monitor user exit response to stdout is in the following format:

MonitorValuextypex[name1=value1x...xnameN=valueN]



MonitorValue The value that is set for the monitor that is currentlyunder execution for a specific instance.

type Indicates the type ofMonitorValue. The valid valuesare eitherString or Number.

nameN=valueN(optional)

A name=valuepair mechanism for the user exit toassociate properties to a monitor which can later beretrieved and processed. Specifyname= (without avalue) to delete the property.

Notes:

1. At leastMonitorValueand a type ofString or Number is neededto update the monitor. When onlyMonitorValueis returned, thedefault type isNumber.



A.

Program

ming

User

Exits

Processing the Monitor User Exit ResponseA monitor user exit puts information to stdout similar to thefollowing as its response to being called:

upxStringxname1=value1xname2=value2

The values and descriptions of the typical monitor user exit responseare listed in the following table:

Value Description

up The monitor value expressed as a string

String The type of the preceding monitor value

nameN=valueN Propertyname=valuepairs

To delete the monitor propertyname1, you need to change themonitor user exit program file to put the following to stdout:

upxStringxname1=xname2=value2

The current value of the attribute the user exit is monitoring is usedby threshold processing to determine the state of the monitor.Properties information is in the form ofname=valuepairs and isavailable to subsequent calls to the monitor user exit in the samecontext, acting against the same instance.

Instance Information User ExitAn instance information user exit is associated with one Tivoli GEMconnection or software component. It is used to define additionalinstance information that supports Tivoli GEM connections andmakes instance filtering work. The user exit is called by a TivoliGEM Instrumentation Service instance information user exit enabler.

Calling an Instance Information User ExitBased on the information provided to the QuickStart wizard, theTivoli GEM Instrumentation Service instance information user exitenabler uses the instance name specified as an identifying label, and

178 Version 2.4

sets up the environment by issuing any of the preparatory commandsspecified. Then, it calls the instance information user exit in thefollowing manner:

User-Exit_name "InstanceID"

The instance information user exit calling parameters and theirdescriptions are listed in the following table:


User-Exit_name The name of the user exit

InstanceID Unique string representing a software componentinstance

Instance Information User Exit ResponseThe instance information user exit response returns a list of instanceinformation values for the specified instance to stdout, one for eachline of user exit instance information. Each valid value has two mainattributes followed by their values.

The following are sample formats of an instance information userexit response:

PrimaryAttributexpvalx*xSecondaryAttributexsvalx*GenericAttributexgtypexgvalxGenericAttributexgtypexgval



PrimaryAttribute The primary attribute of the communications object.Valid keywords areTCPIPAddress,TCPIPHostName, SNAName, IPXHostName,IPXAddress, NetbiosName, or GenericAttribute .

pval The value of thePrimaryAttribute.

SecondaryAttribute The secondary attribute of the communicationsobject. Valid keywords areTCPIPService,TCPIPPort , SNATPN, IPXSocket, TaskID,SNASvcPoint, PPITaskID, or GenericAttribute .


A.

Program

ming

User

Exits


sval The value of theSecondaryAttribute.

gtype The type ofGenericAttribute .

gval The value of theGenericAttribute .

Notes:

1. A GenericAttribute has two variables:Generic Attribute TypeandGeneric Attribute Value. The other attributes aresingle-valued and an asterisk (*) is used as a format placeholder,as shown in the preceding example.


3. Attribute names, such asTCPIPAddress, are case sensitive andmust be entered exactly as shown in the table.

Processing the Instance Information User ExitResponse

The user exit contains the information that uniquely identifies theinstance connection point and puts these values to stdout, as shownin the following example:

TCPIPAddressx9.1.2.5x*xTCPIPPortx55x*GenericAttributextDomainxtHostxGenericAttributextAddressxtSocket

The values and descriptions of the typical instance information userexit response are listed in the following table:

Value Description

TCPIPAddress The primary attribute of the communications object

9.1.2.5 The value of the specified primary attribute

TCPIPPort The secondary attribute of the communications object

55 The value of the specified secondary attribute

tDomainThe GenericAttribute types

tAddress

tHostThe GenericAttribute values

tSocket

180 Version 2.4

The Tivoli GEM Instrumentation Service parses each line in stdoutand sets the attributes for the software component instance.

Task User ExitA task user exit is associated with one or more Tivoli GEM softwarecomponent instances. It is called by a Tivoli GEM InstrumentationService task user exit enabler. The task executes completely in theTivoli Framework task environment on the target system, but thetask execution and completion are under the control of the TivoliGEM Instrumentation Service.

With task user exits, the following information is requested by theQuickStart wizard:¶ Task name¶ Preparatory commands¶ Program name¶ Program parameters

Calling a Task User ExitThe Tivoli GEM Instrumentation Service user exit task enabler usesthe task name specified as an identifying label. It sets up theenvironment by issuing the preparatory commands specified. Then itcalls the task user exit, passing the specified program parameters andthe instance ID of the target software component instance. Theformat of the call to the task user exit is as follows:

User-Exit_name [parm1...parmN] "InstanceID"

The task user exit calling parameters and their descriptions are listedin the following table:


User-Exit_name Specifies the program name of the user exit.


A.

Program

ming

User

Exits




InstanceID Specifies a unique string representing a softwarecomponent instance.

Task User Exit ResponseThe task user exit response to stdout is whatever the user exit isprogrammed to provide. There is not an expected format.

The Tivoli GEM Instrumentation Service associates the responsewith the task name and displays the response on the Tivoli GEMconsole.

Connection User ExitA connection user exit is associated with one or more Tivoli GEMsoftware component connections. It contains all the informationneeded to report a connection in a format that is similar to a flat fileformat as described in “Discover Connections Flat File” on page 190.It is called by a Tivoli GEM Instrumentation Service connection userexit enabler using the stdout programming interface.

Calling a Connection User ExitTivoli GEM Instrumentation Service calls a connection user exit inthe following format:

User-Exit_name [parm1...parmN] "InstanceID"

The connection user exit calling parameters and their descriptions arelisted in the following table:


User-Exit_name Specifies the name of the user exit.

182 Version 2.4




InstanceID Specifies a unique string representing a softwarecomponent instance

Connection User Exit ResponseThe connection user exit returns a list of connections to stdout forthe specified software component instance. The following are sampleformats of a discover connection user exit response:

con_typexcon_dirxPrimaryAttributexpvalx*x SecondaryAttributexsvalx*

con_typexcon_dirxGenericAttributexgtypexgvalx GenericAttributexgtypexgval



con_type The connection type.

con_dir The connection direction, whose value can be 1(Origin), 2 (Destination), or 3 (Conversational).

PrimaryAttribute The primary attribute of the communicationsobject. Valid keywords areTCPIPAddress,TCPIPHostName, SNAName, IPXHostName,IPXAddress, NetbiosName, or GenericAttribute .

pval The single value forPrimaryAttribute.

SecondaryAttribute The secondary attribute of the communicationsobject. Valid keywords areTCPIPService,TCPIPPort , SNATPN, IPXSocket, TaskID,SNASvcPoint, PPITaskID, or GenericAttribute .

sval The single value for theSecondaryAttribute.

gtype The type ofGenericAttribute .

gval The value of theGenericAttribute .


A.

Program

ming

User

Exits

Notes:

1. A GenericAttribute has two variables:Generic Attribute TypeandGeneric Attribute Value. The other attributes aresingle-valued and an asterisk (*) is used as a format placeholder,as shown in the preceding example.


3. Attribute keywords, such asTCPIPAddress, are case sensitive andmust be entered exactly as shown in the table.

Processing the Connection User Exit ResponseA sample of the information returned by the user exit for each lineto stdout for a software component instance is shown in thefollowing example:

Databasex3xTCPIPAddressx9.1.2.5x*xGenericAttributex tAddressx

tSocketMailx2xGenericAttributextDomainxtHostx TCPIPPortx55x*

The values and descriptions of the typical connection user exitresponse are listed in the following table:

Value Description

Database The connection type

3 The connection direction (Conversational)

TCPIPAddress The primary attribute of the communications object

9.1.2.5 The value of the specified primary attribute

TCPIPPort The secondary attribute of the communications object

55 The value of the secondary attribute (port number)

Mail The connection type

2 The connection direction (Destination)

tAddressThe GenericAttribute types

tDomain

tSocketThe GenericAttribute values

tHost

184 Version 2.4

Tivoli GEM Instrumentation Service uses the returned information todisplay the reported connections on the Tivoli GEM console.


A.

Program

ming

User

Exits

186 Version 2.4

Flat File Formats

This appendix contains the flat file formats and examples forinstance information and discover connections enablers.

Instance Information Flat FileThe instance information flat file is organized into a list of elementsthat enables instance information to be provided for one or moreinstances of the software component. Each line in the flat fileconsists of a key and the instance information.

You provide the name of the flat file when defining the enabler anduse the Tivoli Ready QuickStart browser file option on the inputfield to select the file.

The Tivoli GEM Instrumentation Service Instance Informationenabler uses the key information when searching the flat file todetermine which lines of the flat file to use as instance information.

File FormatAn instance information flat file is predefined and has entries in thefollowing format:

key=PrimaryAttributexSecondaryAttribute

The following table lists and describes the instance information flatfile entry parameters:

B


B.

Flat

File

Form

ats

Entry Parameter Description

key Assign one of the following keys:

globals.comms.nKey used for all instances, wheren is anumber that can be added to ensure uniquenames.

instance.comms.instanceID.nKey used for a specific instance, whereinstanceIDis the instance identifier, andnis a number that can be added to ensureunique names.

hostname.comms.hostname.nKey used for all host instances, wherehostnameis the name of the host withoutthe domain qualification andn is a numberthat can be added to ensure unique names.

hostinstance.comms.hostname.instanceID.nKey used for a specific host instance,wherehostnameis the name of the hostwithout the domain qualification,instanceIDis the instance identifier, andnis a number that can be added to ensureunique names.

PrimaryAttribute Assign a primary attribute for each key. Validvalues are one of the following:

TCPIPAddressxvalueTCPIPHostNamexvalueSNANamexvalueIPXHostNamexvalueIPXAddressxvalueNetbiosNamexvalueGenericAttribute xvalue

188 Version 2.4


SecondaryAttribute Assign a secondary attribute for each key: Validvalues are one of the following:

TCPIPServicexvalueTCPIPPortxvalueSNATPNxvalueIPXSocketxvalueTaskIDxvalueSNASvcPointxvaluePPITaskIDxvalueGenericAttribute xvalue

Notes:

1. Attribute names, such asTCPIPAddress, are case sensitive andmust be entered exactly as written here.

2. Separate each item with a tilde (x).

3. Replace any blanks in theinstanceIDwith an underscore.

4. All key names in a flat file must be unique.

ExampleThe following is an example of an instance information flat file:globals.comms.1=TCPIPAddressx9.1.2.5x*xGenericAttributextAddressxtSocket

globals.comms.2=GenericAttributextDomainxtHostxTCPIPPortx55x*

instance.comms.LotusNotesServer.1=TCPIPAddressx1.2.3.4x*xTCPIPPortx10x*

instance.comms.BackupNotesServer.1=TCPIPAddressx2.3.4.5x*xTCPIPPortx20x*

instance.comms.SQLServer.1=IPXHostnamexdbaseServerx*xIPXSocketx2020x*

In the preceding example, the following should be noted:

¶ A number (.n) is appended at the end ofglobals.commsandinstance.comms.instanceIDto ensure uniqueness of key names.

¶ LotusNotesServer, BackupNotesServer, andSQLServerare theinstanceIDs.

¶ TCPIPAddress, GenericAttribute, andIPXHostname areprimary attributes.


B.

Flat

File

Form

ats

¶ GenericAttribute, TCPIPPort, andIPXSocket are secondaryattributes.

¶ A GenericAttribute has two variables:Generic Attribute TypeandGeneric Attribute Value. The other attributes aresingle-valued and an asterisk (*) is used as a format placeholder,as shown in the preceding example.

¶ tAddress andtDomain areGeneric Attribute Types.

¶ tSocket andtHost areGeneric Attribute Values.

Discover Connections Flat FileA discover connections flat file is organized into a list of elementsthat enables instance information to be provided for one or moreinstances of the software component. Each line in the flat fileconsists of a key and the connection identity information.

When defining a discover connections enabler that requires a flatfile, you must provide the name of a predefined flat file. Then, usingthe Tivoli Ready QuickStart browser file option on the input field,you select the file.

The Tivoli GEM Instrumentation Service Discover Connectionsenabler uses the key information when searching the flat file todetermine which lines of the flat file to use as connectioninformation. Using the connection information, the connections arediscovered and then displayed on the Tivoli GEM console.

File FormatA discover connections flat file is predefined and has entries in thefollowing format:

key=conn_typexconn_dirxPrimaryAttributexSecondaryAttribute

The following table lists and describes the discover connections flatfile entry parameters:

190 Version 2.4


key Assign one of the following keys:

globals.relations.nKey used for all instances, wheren is anumber that can be added to ensure uniquenames.

instance.relations.instanceID.nKey used for a specific instance, whereinstanceIDis the instance identifier, andnis a number that can be added to ensureunique names.

hostname.relations.hostname.nKey used for all host instances, wherehostnameis the name of the host withoutthe domain qualification andn is a numberthat can be added to ensure unique names.

hostinstance.relations.hostname.instanceID.nKey used for a specific host instance,wherehostnameis the name of the hostwithout the domain qualification,instanceIDis the instance identifier, andnis a number that can be added to ensureunique names.

conn_type Provide the name of the connection type.

conn_dir Provide the direction of the connection. Validvalues are:

1 = Origin2 = Destination3 = Conversational (bidirectional)


B.

Flat

File

Form

ats


PrimaryAttribute Identify the primary element of the connection. Oneof the following is valid:

TCPIPAddressxvalueTCPIPHostNamexvalueSNANamexvalue

IPXHostNamexvalueIPXAddressxvalueNetbiosNamexvalueGenericAttribute xvalue

SecondaryAttribute Identify the secondary element of the connection.One of the following is valid:

TCPIPServicexvalueTCPIPPortxvalueSNATPNxvalueIPXSocketxvalueTaskIDxvalueSNASvcPointxvaluePPITaskIDxvalueGenericAttribute xvalue

Notes:

1. Attribute names, such asTCPIPAddress, are case sensitive andmust be entered exactly as written here.

2. Separate each item with a tilde (x).

3. Replace any blanks in theinstanceIDwith an underscore.

4. All key names in a flat file must be unique.

ExampleThe following is an example of a discover connections flat file:globals.relations.1=Databasex3xTCPIPAddressx9.1.2.5x *xTCPIPPortx55x*

globals.relations.2=Mailx2xGenericAttributextDomainx tHostx

IPXSocketx2020x*

globals.relations.3=SQLx3xIPXHostnamexdbaseServerx *x

GenericAttributextAddressxtSocket

instance.relations.LotusNotesClient.1=Notesx1xTCPIPAddressx1.2.3.4x *

xTCPIPPortx10x*

192 Version 2.4

instance.relations.LotusNotesClient.2=Backupx2xTCPIPAddressx2.3.4.5x *

xTCPIPPortx20x*

In the preceding example, the following should be noted:

¶ A number (.n) is appended at the end ofglobals.relationsandinstance.relations.InstanceIDto ensure uniqueness of keynames.

¶ LotusNotesClientis the InstanceID.

¶ Database, Mail, SQL, Notes, and Backup are connectiontypes.

¶ TCPIPAddress, GenericAttribute, andIPXHostname areprimary attributes.

¶ TCPIPPort, GenericAttribute, andIPXSocket are secondaryattributes.

¶ A GenericAttribute has two variables:Generic Attribute TypeandGeneric Attribute Value. The other attributes aresingle-valued and an asterisk (*) is used as a format placeholder,as shown in the preceding example.

¶ tDomain andtAddress areGeneric Attribute Types.

¶ tHost andtSocket areGeneric Attribute Values.


B.

Flat

File

Form

ats

194 Version 2.4

Index

Special Characters.pdf xii.xpm 37

Aabout task 38Add File to File Pack Enabler 161adding components 25additional customization 19, 43Adobe Acrobat Reader xiiAMS x, 1, 3, 15, 108App Tools extension 77application branch, Tivoli GEM 34application information, specifying 22application level information, specifying 18application management package 1, 3application management package (AMP) xiiApplication Management Specification x, 108

Bbean jar file 39blue circle 9build, canceling 42build image 42build options

IT Director 38Plus specific 35Tivoli GEM 32

build status, displaying 42building modules 40

without saving your session 31

CCD-ROM

accessing files xiiclear value function 9component

adding to application 25AMS vs TR-QS Wizard 2information, specifying 19manufacturer 26multiple AMS 2name 26name, NewComponentn 24options, Tivoli GEM 34version 27

component name 8connection enablers 28, 139Connection Enablers

Discover Connections by User Exit 140Discover Connections by User Exit Using File

Pack 143Discover Connections From Flat File Using

File Pack 146primary attribute 139secondary attribute 139Support 148

continue working 20, 21create a new module 20create subscriber list task 37Custom Adapter Event Enabler 153Custom Adapter Event Enabler (Plus) 154Custom Monitor Enabler 110customer support

contacting xiv


Index

DDefine stage 18, 21deleting files from an input field 9deployment enablers 28, 159Deployment Enablers

Add File to File Pack 161InstallShield 161InstallShield (ITD) 166

Discover Connections by User Exit Enabler 140Discover Connections by User Exit Using File

Pack Enabler 143Discover Connections From Flat File Using File

Pack Enabler 146discovery, defined 47documentation

accessing online xiiIT Director 4related xi

Eenabler 24, 27

categories 28category 45Connection 139

Discover Connection by User Exit 140Discover Connections by User Exit Using

File Pack 143Discover Connections From Flat File

Using File Pack 146Support 148

defined 45dependency on module type 46Deployment 159

Add File to File Pack 161InstallShield 161InstallShield (ITD) 166

Event 151Custom Adapter 153Custom Adapter (Plus) 154Logfile Adapter 155

filtering 28filtering the list of available 102

enabler 24, 27 (continued)Instance Discovery 47

NT Performance Objects 53NT Service by Program Name 54NT Services 56Single Instance Application 57Specific NT Services 58Start Up Parameters 59User Exit 60User Exit Using File Pack 62User ID and Program 63

Instance Information 65Instance Information by User Exit 66Instance Information by User Exit (Using

File Pack) 68Instance Information from Flat File (Using

File Pack) 69Inventory 71

Inventory Signature 72Monitor 101

Custom Monitor 110Instance NT Counter 112Instance NT Service 113Instance Process Attribute 114Instance Process Count 115Instance Process Time 117NT Object Counter with No Instance 118NT Object Counter with NT

Instance 120NT Object Monitor 121NT Service 122Predefined DM 123Process 127Process Attribute 124Process Count 126Process Time 128State 129User Exit Number 130User Exit Number Using File Pack 132User Exit String 133User Exit String Using File Pack 135

parameters 29removing 29selecting 29, 45selecting more than one 29specifying 19

196 Version 2.4

enabler 24, 27 (continued)Task 75

Generic Start 90Generic Stop 96Generic Task 77Generic Task, Instance ID Passed In 79IT Director Generic (with

argument/response bean) 80Launch Browser 82Launch Telnet 83Plus Application Launch 84Recover 86Recover Service 87Start 88Start, Using File Pack 91Start NT Service 93Stop 95Stop (Using File Pack) 97Stop NT Service 94

encoding rules and limitations 6endpoint launch task 37errors in input, correcting 41event enablers 28, 151Event Enablers

Custom Adapter 153Custom Adapter (Plus) 154Logfile Adapter 155

exiting the wizard 17

Ffile system structure 7final check dialog 41Finish stage 19, 30flat files 13

Ggeneric platform type 28Generic Start Enabler 90Generic Stop Task Enabler 96

Generic Task Enabler 77Generic Task Enabler, Instance ID Passed In 79generic UNIX platform type 28getting started 16, 19glossary

website xiii

Hhelp files, collecting 12help files, module-type specific 30help text file name 33

component level 34hidden task, Plus modules 75

Iicon

file name 33file name, component level 34files, module-type specific 30TivoliPlus 3

icon files, collecting 12ImagePath key 49input, optional 9input, required 9InstallShield Deployment Enabler (ITD) 166InstallShield Enabler 161instance context, monitor enablers 101instance discovery enablers 28, 47Instance Discovery Enablers

monitor dependencies 103monitor enabler dependencies 51NT Performance Objects 53NT Service by Program Name 54NT Services 56selecting 48Single Instance Application 57Specific NT Service 58Start Up Parameters 59User Exit 60


Index

Instance Discovery Enablers(continued)User Exit Using File Pack 62User ID and Program 63

Instance Information by User Exit (Using FilePack) Enabler 68

Instance Information by User Exit Enabler 66instance information enablers 28, 65Instance Information Enablers

Instance Information by User Exit 66Instance Information by User Exit (Using File

Pack) 68Instance Information from Flat File (Using

File Pack) 69Instance Information from Flat File (Using File

Pack) Enabler 69Instance NT Counter Monitor Enabler 112Instance NT Service Monitor Enabler 113Instance Process Attribute Monitor Enabler 114Instance Process Count Monitor Enabler 115Instance Process Time Monitor Enabler 117Instrument stage 19, 23inventory enablers 28, 71Inventory Enablers

Inventory Signature 72Inventory Signature Enabler 72IT Director

application tools extension 77IT Director Generic Task (with

argument/response bean) 80

LLaunch Browser Enabler 82Launch Telnet Enabler 83load from existing module 20loading a session file 21Logfile Adapter Event Enabler 155

Mmanufacturer 22

component 26specifying 18

Microsoft Windows 32 platform type 28middleware/DB branch, Tivoli GEM 34modeling processes and services 5module

building 19, 40create a new 20IT Director 1, 3load from existing 20Plus 1, 2reviewing 1Tivoli GEM 1, 3types of 1

module typechanging 30confirming 32declaring 18filtering enablers 46specific options, specifying 30specifying 23

monitornames 6

monitor enablers 28, 101Monitor Enablers

Custom 110dependencies on instance discovery

enablers 51dependencies on Instance Discovery

Enablers 103filtering the list 102instance context 101Instance NT Counter 112Instance NT Service 113Instance Process Attribute 114Instance Process Count 115Instance Process Time 117NT Object 121NT Object Counter with No Instance 118NT Object Counter with NT Instance 120NT Service 122polling intervals, setting 107Predefined DM 123

198 Version 2.4

Monitor Enablers(continued)Process 127Process Attribute 124Process Count 126Process Time 128response tasks 109setting thresholds 104State 129User Exit Number 130User Exit Number Using File Pack 132User Exit String 133User Exit String Using File Pack 135

monitorsTivoli GEM 3

moving between stages 9

Nname

application 22component 8, 19, 26manufacturer 7, 22monitor 6product 7, 8task 7

naming conventions 8navigation 9

skipping ahead 23using keyboard 10

NT Object Counter with No Instance MonitorEnabler 118

NT Object Counter with NT Instance MonitorEnabler 120

NT Object Monitor Enabler 121NT Performance Objects Enabler 53NT Service by Program Name Enabler 54NT Service Monitor Enabler 122NT Services Enabler 56

Oonline documentation xiiother documentation xi

Ppane, changing size 9parameters, specifying shell-based for win32

platforms 77planning 5platform

refining 30, 35selecting 27type, specifying 27

platform typerefining 19specifying 19

Plusicon files 12

Plus Application Launch Enabler 84Plus configuration task 37Plus module

documentation xiPlus specific options

application icon (Plus) file name 37application icon file name 36install options 37Plus module items to include 37

Plus template 2polling intervals

multiple monitor instances under the samecomponent 108

specifying 107portable document format (.PDF) xiiPredefined DM Monitor Enabler 123primary attribute 139Process Attribute Monitor Enabler 124Process Count Monitor Enabler 126process leader context 101Process Monitor Enabler 127Process Time Monitor Enabler 128processes and services

modeling 5


Index

product name 7, 8ps -e command 5

Qquickstart.bat 16quickstart.sh 16quitting the wizard 30

RRecover Enabler 86Recover Service Enabler 87related documentation xirelease level, specifying 18release notes xii, 15removing components 25requirements 19response tasks, specifying 109resume previous session 21resuming a previous session 16rules and conventions 6

Ssaving your session 10, 21secondary attribute 139Select Instrumentation 19Select Instrumentation dialog 18selecting enablers 29session

loading 31loading file 21quitting 31resuming 16resuming previous 21saving 30, 31saving your 19starting a new 17

session, continue working on 20Single Instance Application Enabler 57skeleton 15Specific NT Service Enabler 58stage 9Start NT Service Enabler 93Start stage 18Start stage, using 19Start Task Enabler 88Start Task Using File Pack Enabler 91Start Up Parameters Enabler 59starting a new session 17starting the wizard 16State Monitor Enabler 129Stop NT Service Enabler 94Stop Task Enabler 95Stop Task Using File Pack Enabler 97subscriber list for endpoints 38subscriber list for managed nodes 38summary 23, 40Support Connection Enabler 148

Ttask

names 7Tivoli GEM 3

task enablers 28, 75specifying command parameters 77

Task EnablersGeneric 77Generic Start 90Generic Stop 96Generic Task, Instance ID Passed In 79IT Director Generic (with argument/response

bean) 80Launch Browser 82Launch Telnet 83Plus Application Launch 84Recover 86Recover Service 87Start 88Start, Using File Pack 91Start NT Service 93

200 Version 2.4

Task Enablers(continued)Stop 95Stop (Using File Pack) 97Stop NT Service 94

templatePlus module 2

terminology xiiithresholds, IT Director 106thresholds, setting 104Tivloi Module Designer (TMD) 15Tivoli customer support

contacting xivTivoli GEM

documentation xiicon and help files 12module 3tree branch, specifying 33user exits and flat files 13

Tivoli Global Enterprise Manager 3Tivoli install image 2Tivoli IT Director

module 3Tivoli IT Director Integration Toolkit xiTivoli Module Builder 15, 19, 43

library xiiTivoli Ready QuickStart wizard

installing 15stages 18starting 16using 15

TivoliPlusicon 3

TMB 2TME 10 xiiiTR-QS Wizard component 2tree view 18typeface conventions xii

UUser Exit Enabler 60User Exit Number Monitor Enabler 130User Exit Number Using File Pack Enabler 132User Exit String Monitor Enabler 133

User Exit String Using File Pack Enabler 135User Exit Using File Pack Enabler 62user exits 13User ID and Program Enabler 63

Vversion

application 22component 27specifying 18

Wwhat to expect 19Windows NT Object context 102Windows NT Service context 102

XXPixMap (XPM) format 37


Index

202 Version 2.4

Printed in the United States of Americaon recycled paper containing 10%recovered post-consumer fiber.

GC32-0632-00