management framework reference manual version...

Tivoli ® Management FrameworkReference ManualVersion 3.7.1

Tivoli Management Framework Reference Manual

Copyright Notice© Copyright IBM Corporation 1998, 2001. All rights reserved. May only be used pursuant to aTivoli Systems Software License Agreement, an IBM Software License Agreement, orAddendum for Tivoli Products to IBM Customer or License Agreement. No part of thispublication may be reproduced, transmitted, transcribed, stored in a retrieval system, ortranslated into any computer language, in any form or by any means, electronic, mechanical,magnetic, optical, chemical, manual, or otherwise, without prior written permission of IBMCorporation. IBM Corporation grants you limited permission to make hardcopy or otherreproductions of any machine-readable documentation for your own use, provided that each suchreproduction shall carry the IBM Corporation copyright notice. No other rights under copyrightare granted without prior written permission of IBM Corporation. The document is not intendedfor production and is furnished “as is” without warranty of any kind.All warranties on thisdocument are hereby disclaimed, including the warranties of merchantability and fitnessfor a particular purpose.U.S. Government Users Restricted Rights—Use, duplication or disclosure restricted by GSAADP Schedule Contract with IBM Corporation.

TrademarksIBM, Tivoli, the Tivoli logo, AIX, AS/400, DB2, OS/2, Tivoli Enterprise, and TME aretrademarks or registered trademarks of International Business Machines Corporation or TivoliSystems Inc. in the United States, other countries, or both.

Lotus Notes is a registered trademark of Lotus Development Corporation.

Microsoft, Windows, Windows NT, and the Windows logo are trademarks of MicrosoftCorporation in the United States, other countries, or both.

UNIX is a registered trademark of The Open Group in the United States and other countries.

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

NoticesReferences in this publication to Tivoli Systems or IBM products, programs, or services do notimply that they will be available in all countries in which Tivoli Systems or IBM operates. Anyreference to these products, programs, or services is not intended to imply that only TivoliSystems or IBM products, programs, or services can be used. Subject to valid intellectualproperty or other legally protectable right of Tivoli Systems or IBM, any functionally equivalentproduct, program, or service can be used instead of the referenced product, program, or service.The evaluation and verification of operation in conjunction with other products, except thoseexpressly designated by Tivoli Systems or IBM, are the responsibility of the user. Tivoli Systemsor IBM may have patents or pending patent applications covering subject matter in thisdocument. The furnishing of this document does not give you any license to these patents. Youcan send license inquiries, in writing, to the IBM Director of Licensing, IBM Corporation, NorthCastle Drive, Armonk, New York 10504-1785, U.S.A.

Tivoli Management Framework Reference Manual iii

ContentsPreface................................................................................................................. xiii

Chapter 1—CommandsEstablishing the Tivoli Environment ..................................................................1-1

Command Syntax................................................................................................1-3

Object References ...............................................................................................1-4

Registered Names ......................................................................................1-4

Object Paths................................................................................................1-5

Tivoli Transactions .............................................................................................1-6

Platform Commands ...........................................................................................1-7

Administrator Commands ..........................................................................1-7

Configuration Management Commands ....................................................1-8

Endpoint and Gateway Commands ............................................................1-9

httpd Commands.......................................................................................1-11

Installation Commands.............................................................................1-11

Interregion Commands.............................................................................1-12

Kerberos Commands ................................................................................1-13

Low-Level Maintenance Commands .......................................................1-14

Managed Node Commands ......................................................................1-15

Multiplexed Distribution Commands.......................................................1-16

Notification Commands ...........................................................................1-17

Policy Commands.....................................................................................1-17

Query Commands.....................................................................................1-18

RDBMS Interface Module (RIM) Commands.........................................1-19

Revision Control System (RCS) Commands ...........................................1-19

Scheduler Commands...............................................................................1-20

Task Library Commands..........................................................................1-20

Miscellaneous Commands........................................................................1-22

idlarg .................................................................................................................1-25

idlattr .................................................................................................................1-27

iv Version 3.7.1

idlcall ................................................................................................................ 1-29

idlexception....................................................................................................... 1-32

idlinput .............................................................................................................. 1-34

idlresult ............................................................................................................. 1-35

kadmin .............................................................................................................. 1-37

kadmind ............................................................................................................ 1-40

kdb_destroy....................................................................................................... 1-42

kdb_edit ............................................................................................................ 1-44

kdb_init ............................................................................................................. 1-46

kdb_util ............................................................................................................. 1-48

kdestroy............................................................................................................. 1-50

kerberos............................................................................................................. 1-52

kinit ................................................................................................................... 1-56

klist ................................................................................................................... 1-58

kpasswd............................................................................................................. 1-60

ksrvtgt ............................................................................................................... 1-62

kstash ................................................................................................................ 1-64

lcfd .................................................................................................................... 1-66

lcfd.sh................................................................................................................ 1-76

logls................................................................................................................... 1-77

objcall................................................................................................................ 1-79

odadmin ............................................................................................................ 1-83

odbls................................................................................................................ 1-103

odstat............................................................................................................... 1-105

oinstall............................................................................................................. 1-112

oserv................................................................................................................ 1-115

tivoli ................................................................................................................ 1-122

tmcmd ............................................................................................................. 1-124

tmstat............................................................................................................... 1-126

w4inslcf.pl....................................................................................................... 1-129

waddicon......................................................................................................... 1-132

Tivoli Management Framework Reference Manual v

waddpath .........................................................................................................1-134

waddrealm.......................................................................................................1-135

wadminep........................................................................................................1-136

wauthadmin.....................................................................................................1-138

wbkupdb..........................................................................................................1-140

wbindmsg........................................................................................................1-145

wbroadcast ......................................................................................................1-147

wcatcher ..........................................................................................................1-148

wcd..................................................................................................................1-150

wchkdb............................................................................................................1-152

wchknode ........................................................................................................1-155

wchkpol...........................................................................................................1-158

wci...................................................................................................................1-160

wclient.............................................................................................................1-169

wclrblk ............................................................................................................1-175

wclrline ...........................................................................................................1-177

wco..................................................................................................................1-179

wconnect .........................................................................................................1-187

wcpcdrom........................................................................................................1-192

wcpyfile...........................................................................................................1-195

wcrtadmin .......................................................................................................1-196

wcrtgate...........................................................................................................1-199

wcrtjob ............................................................................................................1-201

wcrtpol ............................................................................................................1-204

wcrtpr ..............................................................................................................1-206

wcrtprf.............................................................................................................1-208

wcrtprfmgr ......................................................................................................1-210

wcrtqlib ...........................................................................................................1-212

wcrtquery ........................................................................................................1-213

wcrtrim............................................................................................................1-216

wcrttask ...........................................................................................................1-219

vi Version 3.7.1

wcrttlib ............................................................................................................ 1-222

wdate............................................................................................................... 1-223

wdel................................................................................................................. 1-224

wdelep............................................................................................................. 1-226

wdelgate.......................................................................................................... 1-227

wdeljob............................................................................................................ 1-228

wdelpol............................................................................................................ 1-229

wdelpr ............................................................................................................. 1-230

wdelrealm........................................................................................................ 1-231

wdelsched........................................................................................................ 1-232

wdeltask .......................................................................................................... 1-234

wdepot............................................................................................................. 1-235

wdisconn ......................................................................................................... 1-240

wdiskspace...................................................................................................... 1-242

wdistrib ........................................................................................................... 1-243

wdisttask ......................................................................................................... 1-246

wdskspc........................................................................................................... 1-248

weditini ........................................................................................................... 1-250

wedsched......................................................................................................... 1-252

wenblsched...................................................................................................... 1-258

wep.................................................................................................................. 1-260

wepmgr ........................................................................................................... 1-271

wexpnotif ........................................................................................................ 1-276

wgateway ........................................................................................................ 1-277

wgetadmin....................................................................................................... 1-281

wgetallinst....................................................................................................... 1-283

wgetdfpol ........................................................................................................ 1-284

wgeteppol........................................................................................................ 1-286

wgetjob............................................................................................................ 1-288

wgetkey........................................................................................................... 1-290

wgetpolm ........................................................................................................ 1-292

Tivoli Management Framework Reference Manual vii

wgetpr .............................................................................................................1-297

wgetprf ............................................................................................................1-298

wgetquery........................................................................................................1-300

wgetrim ...........................................................................................................1-302

wgetsched........................................................................................................1-303

wgetsub ...........................................................................................................1-306

wgettask ..........................................................................................................1-308

wgetval ............................................................................................................1-310

whostid............................................................................................................1-312

wiconv.............................................................................................................1-313

wident..............................................................................................................1-315

widmap............................................................................................................1-316

wifconfig .........................................................................................................1-319

winsblk............................................................................................................1-321

winsline ...........................................................................................................1-323

winstall ............................................................................................................1-325

winstdir ...........................................................................................................1-328

winstendpt .......................................................................................................1-329

winstlcf............................................................................................................1-330

winstruct..........................................................................................................1-337

winstruct_plus .................................................................................................1-340

winstruct_task .................................................................................................1-343

winterp ............................................................................................................1-345

wlcftap.............................................................................................................1-346

wln...................................................................................................................1-349

wlocalhost .......................................................................................................1-351

wlocktmr .........................................................................................................1-352

wlocpath..........................................................................................................1-354

wlookup...........................................................................................................1-356

wls ...................................................................................................................1-358

wlsconn ...........................................................................................................1-360

viii Version 3.7.1

wlsendpts ........................................................................................................ 1-363

wlsinst ............................................................................................................. 1-365

wlsnotif ........................................................................................................... 1-368

wlspol.............................................................................................................. 1-371

wlspolm........................................................................................................... 1-373

wlsrealms ........................................................................................................ 1-375

wlssub ............................................................................................................. 1-376

wlstlib ............................................................................................................. 1-378

wmailhost........................................................................................................ 1-379

wmannode....................................................................................................... 1-380

wmdist............................................................................................................. 1-381

wmdistgui ....................................................................................................... 1-393

wmemsize ....................................................................................................... 1-394

wmerge............................................................................................................ 1-395

wmrgaef .......................................................................................................... 1-397

wmrgini........................................................................................................... 1-399

wmv ................................................................................................................ 1-400

wpatch............................................................................................................. 1-402

wping .............................................................................................................. 1-404

wpopulate........................................................................................................ 1-405

wputeppol........................................................................................................ 1-407

wputpolm ........................................................................................................ 1-408

wpwd............................................................................................................... 1-412

wrcs................................................................................................................. 1-413

wrcsdiff ........................................................................................................... 1-419

wrcsmerge....................................................................................................... 1-421

wrefresh .......................................................................................................... 1-424

wregister.......................................................................................................... 1-425

wrestart............................................................................................................ 1-427

wrimtest .......................................................................................................... 1-428

wrimtrace ........................................................................................................ 1-430

Tivoli Management Framework Reference Manual ix

wrlog ...............................................................................................................1-432

wrm .................................................................................................................1-436

wrmnode .........................................................................................................1-438

wrplblk ............................................................................................................1-440

wrplline ...........................................................................................................1-442

wrpt .................................................................................................................1-444

wrunas .............................................................................................................1-454

wruninvquery ..................................................................................................1-455

wrunjob ...........................................................................................................1-458

wrunquery .......................................................................................................1-461

wruntask..........................................................................................................1-463

wschedjob .......................................................................................................1-468

wserver ............................................................................................................1-473

wsetadmin .......................................................................................................1-481

wsetdfpol.........................................................................................................1-483

wseterr.............................................................................................................1-485

wsetjob ............................................................................................................1-486

wsetlang ..........................................................................................................1-489

wsetpkey .........................................................................................................1-491

wsetpm ............................................................................................................1-492

wsetpr ..............................................................................................................1-494

wsetquery ........................................................................................................1-496

wsetrim............................................................................................................1-498

wsetrimpw.......................................................................................................1-500

wsettap ............................................................................................................1-501

wsettask...........................................................................................................1-504

wsetval ............................................................................................................1-506

wsndnotif.........................................................................................................1-508

wstarthttpd.......................................................................................................1-511

wstartsched......................................................................................................1-512

wstophttpd.......................................................................................................1-513

x Version 3.7.1

wsub................................................................................................................ 1-514

wsupport.......................................................................................................... 1-516

wtailnotif......................................................................................................... 1-519

wtaskabort....................................................................................................... 1-521

wtimezone....................................................................................................... 1-523

wtemp.............................................................................................................. 1-524

wtll .................................................................................................................. 1-526

wtmrname ....................................................................................................... 1-530

wtrace.............................................................................................................. 1-532

wuname........................................................................................................... 1-537

wuninst............................................................................................................ 1-538

wunstmn.......................................................................................................... 1-541

wunsub............................................................................................................ 1-544

wupdate........................................................................................................... 1-546

wvalidate......................................................................................................... 1-548

wxterm ............................................................................................................ 1-549

Chapter 2—Tivoli-defined PolicyEndpoint Policy .................................................................................................. 2-1

Profile Manager Policy ....................................................................................... 2-2

Default Policy Methods.............................................................................. 2-3

Validation Policy Methods......................................................................... 2-3

Task Library Policy ............................................................................................ 2-4

Default Policy Methods.............................................................................. 2-4

Validation Policy Methods......................................................................... 2-4

Editing Endpoint Policy...................................................................................... 2-5

Editing Profile Manager and Task Library Policy.............................................. 2-6

EndPoint Policy Methods ................................................................................... 2-8

allow_install_policy ........................................................................................... 2-9

after_install_policy ........................................................................................... 2-14

login_policy ...................................................................................................... 2-17

select_gateway_policy ...................................................................................... 2-20

Tivoli Management Framework Reference Manual xi

Profile Manager Policy Methods ......................................................................2-23

pm_def_profile_managers ................................................................................2-24

pm_def_profile_types .......................................................................................2-26

pm_def_subscribers .........................................................................................2-27

pm_val_remove_subscribers.............................................................................2-29

pm_val_remove_subscription ...........................................................................2-31

pm_val_subscribers...........................................................................................2-33

pm_val_subscription .........................................................................................2-34

Task Library Policy Methods............................................................................2-35

tl_def_dist_mode...............................................................................................2-36

tl_def_man_nodes .............................................................................................2-37

tl_def_prof_mgrs...............................................................................................2-38

tl_val_man_nodes .............................................................................................2-39

tl_val_prof_mgrs...............................................................................................2-40

tl_val_set_gid....................................................................................................2-41

tl_val_set_uid....................................................................................................2-42

Index

xii Version 3.7.1

Preface

Tivoli Management Framework Reference Manual xiii

PrefaceTivoli® Management Framework is the base component for the Tivoliproduct line. Using Tivoli Management Framework and a combinationof Tivoli applications, you can manage large distributed networks withmultiple operating systems, various network services, diverse systemtasks, and constantly changing nodes and users.

Tivoli Management Framework provides a set of common services orfeatures that are used by the Tivoli applications installed on TivoliManagement Framework. The services provided by Tivoli ManagementFramework include, but are not limited to, the following:

■ A Dynamic Host Configuration Protocol (DHCP) service thatenables dynamic IP addressing for installations that use DHCP

■ A task library through which you can create tasks and execute thetasks on multiple Tivoli resources

■ A scheduler that enables you to schedule all Tivoli operations,including the execution of tasks created in the Tivoli task library

■ A RDBMS Interface Module (RIM) that enables some Tivoliapplications to write application-specific information to relationaldatabases

■ A query facility that enables you to search and retrieve informationfrom a relational database

Tivoli applications installed on Tivoli Management Framework areenabled to use the services provided by Tivoli Management Framework.

This manual provides in-depth information about Tivoli ManagementFramework commands. This manual is helpful when writing scripts thatare later run as Tivoli tasks. This manual also documentsTivoli-provided policy scripts.

References to the interpreter type for a particular client are locatedthroughout this guide. Interpreter types for each machine type arelocated in theTivoli Management Framework Release Notes.

Preface

xiv Version 3.7.1

Who Should Read This ManualThis manual is intended for use by system administrators who use thecommand line to perform Tivoli operations. It is also helpful in writingscripts that are later run as Tivoli tasks. Users of this manual should havesome knowledge of the following:

■ The UNIX® or Microsoft® Windows NT® operating systems

■ Shell programming

■ The Motif or Windows® environment

Prerequisite and Related DocumentsTivoli provides the following related documentation:

■ Tivoli Management Framework Planning for Deployment Guide

Explains how to plan for deploying your Tivoli environment. Italso describes Tivoli Management Framework and its services.

■ Tivoli Enterprise Installation Guide

Explains how to install and upgrade Tivoli Enterprise™ softwarewithin your Tivoli management region using the availableinstallation mechanisms provided by Tivoli Software InstallationService and Tivoli Management Framework. Tivoli Enterprisesoftware includes the Tivoli management region server, managednodes, gateways, endpoints, and RDBMS Interface Module (RIM)objects. This guide also provides information abouttroubleshooting installation problems.

■ Tivoli Management Framework User’s Guide

Describes the concepts and procedures for using TivoliManagement Framework services. It provides instructions forperforming tasks from the Tivoli desktop and from the commandline.

■ Tivoli Management Framework Maintenance and TroubleshootingGuide

Explains how to maintain the Tivoli environment and troubleshootproblems that can arise during normal operations.

Preface

Tivoli Management Framework Reference Manual xv

What This Manual ContainsTheTivoli Management Framework Reference Manual contains thefollowing sections:

■ Chapter 1, “Commands”

Provides in-depth information about Tivoli ManagementFramework commands.

■ Chapter 2, “Tivoli-Defined Policy”

Discusses the default and validation policies for TivoliManagement Framework components.

Conventions Used in This ManualThe manual uses several typeface conventions for special terms andactions. These conventions have the following meaning:

Bold Commands, keywords, file names, authorization roles,URLs, or other information that you must use literallyappear inbold. Names of buttons and other controlsalso appear inbold.

Italics Variables and values that you must provide appear initalics. New terms appear initalics when they aredefined in the text. Words and phrases that areemphasized also appear initalics.

Monospace Code examples, output, and system messages appearlike this , in amonospace font.

Preface

xvi Version 3.7.1

Accessing Publications OnlineThe Tivoli Customer Support Web site(http://www.tivoli.com/support/ ) offers a guide to support services (theCustomer Support Handbook); frequently asked questions (FAQs); andtechnical information, including release notes, user’s guides, redbooks,and white papers. You can access Tivoli publications online athttp://www.tivoli.com/support/documents/. The documentation forsome products is available in PDF and HTML formats. Translateddocuments are also available for some products.

To access most of the documentation, you need an ID and a password.To obtain an ID for use on the support Web site, go tohttp://www.tivoli.com/support/getting/ .

Resellers should refer tohttp://www.tivoli.com/support/smb/index.html for more informationabout obtaining Tivoli technical documentation and support.

Business Partners should refer to “Ordering Publications” for moreinformation about obtaining Tivoli technical documentation.

Ordering PublicationsOrder Tivoli publications online athttp://www.tivoli.com/support/Prodman/html/pub_order.html orby calling one of the following telephone numbers:

■ U.S. customers:(800) 879-2755

■ Canadian customers:(800) 426-4968

Providing Feedback about PublicationsWe are very interested in hearing about your experience with Tivoliproducts and documentation, and we welcome your suggestions forimprovements. If you have comments or suggestions about our productsand documentation, contact us in one of the following ways:

■ Send e-mail [email protected].

■ Fill out our customer feedback survey athttp://www.tivoli.com/support/survey/.

Preface

Tivoli Management Framework Reference Manual xvii

Contacting Customer SupportTheTivoli Customer Support Handbook athttp://www.tivoli.com/support/handbook/ provides informationabout all aspects of Tivoli Customer Support, including the following:

■ Registration and eligibility

■ How to contact support, depending on the severity of your problem

■ Telephone numbers and e-mail addresses, depending on thecountry you are in

■ What information you should gather before contacting support

Preface

xviii Version 3.7.1

Tivoli Management Framework Reference Manual 1–1

1C

omm

ands

1Commands

Tivoli commands enable you to perform system operations from aUNIX command line instead of using the Tivoli desktop. This is oftenuseful when you do not have access to a graphical display such as whenlogging in over a modem line.

All Tivoli end-user commands begin with aw to identify them as Tivolicommands. Commands are also developed with a w+verb+objectsyntax, which matches the way you would think of the action. Forexample, if you want to create a task, use thewcrttask command. Todelete a job, use thewdeljob command.

It is often convenient or more appropriate to invoke a Tivolimanagement application operation from the command line than from thegraphical user interface. For example:

■ You may not have access to a graphical user interface, perhapsbecause you dialed in over a modem

■ A number of operations are going to be grouped together inside ashell script

■ You would rather invoke a command from a shell

Establishing the Tivoli EnvironmentTivoli Management Framework includes thesetup_env.sh andsetup_env.csh files, which enable you to establish the correct searchpaths and environment variables. These setup files are available on anyserver or client in the Tivoli management region.

1–2 Version 3.7.1

To set up the Tivoli environment, follow these steps:

1. Log in to a Tivoli client or the Tivoli management region server.

2. Do one of the following:

On UNIX systems only, do one of the following:

■ If you are using the Bourne shell, enter the following script:

. /etc/Tivoli/setup_env.sh

■ If you are using the C shell, enter the following script:

source /etc/Tivoli/setup_env.csh

On Windows NT or Windows 2000 systems only, do one of thefollowing:

■ From a bash shell, enter the following command:

%SystemRoot%/system32/drivers/etc/Tivoli/setup_env.sh

■ From a command prompt, enter the following command:

%SystemRoot%\system32\drivers\etc\Tivoli\setup_env.sh

■ To configure the Windows command line to automaticallysource the Tivoli environment, follow these steps:

a. Right-click theCommand Prompt (MS-DOS)shortcutto the Tivoli desktop.

b. Click Properties.

c. Click theShortcut tab.

d. In theTarget text box, enter the following commands:

%SystemRoot%\system32\cmd.exe /kc:\%SystemRoot%\system32\drivers\etc\Tivoli\setup_env.cmd

You now have an environment ready to perform Tivoli maintenanceoperations.


Com

mands

Command SyntaxThe commands in this book use the following special characters todefine the command syntax:

[ ] . Identifies optional options. Options not enclosed inbrackets are required.

…. Indicates that you can specify multiple values for theprevious option.

|. Indicates mutually exclusive information. You can usethe option to the left of the separator or the option to theright of the separator. You cannot use both options in asingle use of the command.

{ } . Delimits a set of mutually exclusive options when oneof the options is required. If the options are optional,they are enclosed in brackets ([ ]).

\. Indicates that the command line wraps to the next line.It is a continuation character.

For example:

logls [–Dofls] [–k dir] [–m maxdlen] log_name…

log_nameis the only required option for theloglscommand. The ellipsismarks (…) following thelog_nameoption indicate that you can specifymultiple log file names. The brackets around the other options indicatethat these options are optional.

Another example is thewchkdb command:

wchkdb [–ooutfile] [–u] [–x] { –f infile | –i | object…}

In this example, the–f infile, –i, andobject options are mutuallyexclusive. The braces ({}) indicate that one of these options is required.If you choose to specify theobject option, you can optionally specifymore than one object name or ID.

The options for each command are listed alphabetically in theOptionssection, unless the options must be used in a specific order to implementthe command.

1–4 Version 3.7.1

Object ReferencesWhen an object is referenced in a command issued from the commandline, the reference is not an absoluteobject referencelike those used inprogramming. Instead, a user-friendly name is used. This user-friendlyname derives from a name given to the object by the user of theapplication, such as when a policy region is created.

Two different forms of names can be used with commands:

■ Registered names

■ Object paths

Tivoli programs that use a command line interface support both namingschemes. Sometimes you will find it more convenient to use one formover the other. If you receive an error message indicating that a resourcecannot be found, try a different naming convention.

Registered NamesThe key concept behind the name registry is aregistered name. Aregistered name is the name by which a resource instance is registeredwith the name registry when it is created. Every resource has a name andis of some particular type. For example, a printer namedlp01has a namelp01 and is of type printer. Some examples of registered names used asoptions for thewls andwmv commands are as follows:wls @PolicyRegion:Serverswmv @ManagedNode:ayers-rock @PolicyRegion:Servers

The syntax for specifying a resource using the registered name facilityis @type:name, wheretype is the resource type andname is theparticular instance of that resource on which you want to perform someoperation.

The name registry does not allow two resources of the same type to havethe same name within a single Tivoli management region. However, itis possible for resource names to be duplicated within two or moreconnected regions. If you attempt to perform an action on a resourcewith a duplicated name, an error message is returned, and the action isnot performed.


Com

mands

To avoid this situation, you should either rename one of the resources ordifferentiate between the resources by appending a region name to theresource name, as follows:wls @ManagedNode:moria#moria-Region

Object PathsObject paths are similar to path names in file systems and may berelative or absolute. An absolute path is one that starts with a slash (/)character. A relative path can start with any character including thespecial path components period (.) and double period (..). Someexamples of object path names used as options for thewls andwmvcommands are as follows:wls /Regions/Serverswmv ../Servers/ayers-rock /Regions/Servers

The syntax for specifying a resource using the object path name style is/distinguished/parent/[type:]name, wheredistinguished is a resourcetype,parent is the start of the object path name,type is used to furtheridentify a resource, andname is the particular instance on which youwant to perform some operation. You often use the optionaltypequalifier when you need to name a particular resource that has the samename as some other resource of a different type.

For example, suppose policy regionEngineeringhad a profile managernamedServers and a policy subregion namedServers. To specify theprofile manager using an object path name, you could use the following:wls /Regions/Engineering/ProfileManager:Servers

If you specify a resource using an absolute path, its location is notambiguous between connected regions. However, if you use a relativepath, both your home and current administrator collection must belocated before the resource can be found. Each administrator’s homecollection is/Administrators/ Name, whereNameis the administrator’sTivoli Management Framework name.

If you have recently issued awcd command, Tivoli ManagementFramework contains a record that specifies the location of the currentadministrator collection. Otherwise, no such record exists, and in thiscase, the current administrator collection can be ambiguous if multipleTivoli management regions are connected. For example, suppose youare an administrator namedJohn (with a login namejohnc) in region A,

1–6 Version 3.7.1

and there is another administrator namedJohn (with a login name ofjsmith ) in region B. When you specify an action to be performed on aresource, Tivoli Management Framework searches for the/Administrators/John collection. The search finds collectionsbelonging to you and jsmith. Because Tivoli Management Frameworkcannot determine which home collection you meant to specify, an errormessage is returned, and the action is not performed. You can executethewcd command to prevent this problem from occurring.

Tivoli TransactionsBecause Tivoli products run in a distributed environment, program errorconditions can cause consistency errors between the Tivoli objectdatabase and the actual work environment. For example, consider TivoliUser Administration, which creates a new user on a managed node.Tivoli User Administration must create a new user object and add anentry to the node’s password file. If an error occurs while writing thefile, Tivoli User Administration must have a way to remove the userobject. Otherwise, the Tivoli database is left in an inconsistent state.

To solve this problem, Tivoli provides atransaction system. Atransaction is a set of operations that must all complete successfully. Ifany operations in a transaction fail, all changes made by the otheroperations are aborted.

The Tivoli transaction allows you to create nested transactions, whichform transaction hierarchies. A method can be invoked in one of fourways:

■ The method is not part of a transaction.

■ The method is the top of a transaction hierarchy.

■ The method is a subtransaction of a top-level transaction.

■ The method is a revocable subtransaction.

A top-level transaction only succeeds if its subtransactions succeed. Ifthe top-level transaction fails, Tivoli undoes all changes made by thetransaction and its subtransactions. Subtransactions can themselves havesubtransactions on which they depend.

When a subtransaction is revocable, it can abort without forcing theparent transaction to abort. The parent can decide whether the failure is


Com

mands

severe enough to warrant aborting the entire transaction. For example,consider a transaction that calls a revocable subtransaction to write a setof database records. If the subtransaction fails after writing 99 percent ofthe records, the parent may choose to succeed anyway. However, if themethod fails after writing only 5 percent, the parent may choose to failand undo the records that have been written.

The Tivoli task library runs jobs using this transaction model. Tasks runfrom the Tivoli desktop are executed as top-level transactions. You can,however, create a task that runs a shell script, which in turn runs otherTivoli tasks as either subtransactions or as revocable subtransactions.

Platform CommandsThe following sections list Tivoli Management Framework commandsby component. Each section contains a table of command names andpurpose statements.

Administrator Commands

Command Purpose

wauthadmin Adds, removes, or displays the root authority ofTivoli administrators in a Tivoli management region

wcrtadmin Creates a new Tivoli administrator

wgetadmin Lists information about a Tivoli administrator

widmap Lists and modifies user login mapping

wsetadmin Changes information about a Tivoli administrator

wsetlang Determines the operating system locale to use for aTivoli management region server or managed node

1–8 Version 3.7.1

Configuration Management Commands

Command Purpose

wcrtprf Creates a new profile or clones an existing profile

wcrtprfmgr Creates a profile manager

wdistrib Distributes one or more profile copies

wgetprf Retrieves subscription copies of one or more profiles

wgetsub Lists the subscribes of a profile manager

wlssub Lists the profile managers to which a host, NISdomain, or profile manager subscribes

wpopulate Populates a profile from system files

wsetpm Enables or disables a profile manager to operate indataless mode

wsub Subscribes Tivoli resources to a profile manager

wuninst Uninstalls Tivoli applications from a specified nodeor from the entire Tivoli management region

wunsub Removes Tivoli resources from a profile manager’ssubscription list

wvalidate Validates a profile against its validation policy


Com

mands

Endpoint and Gateway Commands

Command Purpose

lcfd Starts the endpoint daemon (lcfd) on an endpoint andinstalls or removes the daemon as a service onWindows NT or Windows 2000 systems

lcfd.sh Starts or stops the endpoint daemon (lcfd) on UNIXendpoints

w4inslcf.pl Installs an endpoint on an AS/400® system

waddpath Adds an entry to the path statement in the registry hiveof the current control set (Windows NT andWindows 2000 only)

wadminep Performs automatic upgrade of an endpoint client

wclrblk Removes a block of statements from a file

wclrline Removes a single line from a file

wcpyfile Enables an.NCF configuration program to copy a file(NetWare only)

wcrtgate Creates an endpoint gateway

wdelep Deletes an endpoint

wdelgate Deletes an endpoint gateway

wdskspc Verifies the amount of disk space available (DOS,Windows, and NetWare only)

weditini Modifies the groups, variables, and values in an.INI file

wep Performs actions on endpoint information contained inthe endpoint list

1–10 Version 3.7.1

wepmgr Provides control and configuration for the endpointmanager

wgateway Starts, stops, or lists the properties of an endpointgateway

wgetkey Retrieves the subkey listing in a registry hive(Windows only)

wgetval Retrieves a registry subkey (Windows only)

winsblk Inserts a block of statements into a file

winsline Inserts a single line into a file

winstlcf Installs an endpoint on UNIX, Windows NT, andWindows 2000 workstations

wlsendpts Lists all the endpoints subscribed to a profile manager

wmrgini Merges groups and variables from one.INI file intoanother

wrestart Initiates a system restart and optional restart (Windowsonly)

wrplblk Replaces a block of statements in a file

wrplline Replaces a single line in a file

wseterr Sets the return code from a batch file for a configurationprogram

wsetval Sets a registry key value (Windows only)

Command Purpose


Com

mands

httpd Commands

Installation Commands

Command Purpose

waddrealm Registers an HTTP 1.0 authentication realm with theHTTP daemon.

wdelrealm Deletes a registered HTTP 1.0 authentication realm. TheHTTP daemon must be restarted before the realm isactually deleted.

wlsrealms Lists the currently registered HTTP 1.0 authenticationrealms.

wstarthttpd Starts the Tivoli HTTP daemon.

wstophttpd Stops the Tivoli HTTP daemon.

Command Purpose

oinstall Installs, updates, or removes the Tivoli objectdispatcher service in the Windows Service Manager(Windows NT and Windows 2000 only)

wclient Installs Tivoli clients

wcpcdrom Copies installation images from a CD to a systemdirectory

winstall Installs a Tivoli product

winstlcf Installs an endpoint on a UNIX, Windows NT, orWindows 2000 workstation

1–12 Version 3.7.1

Interregion Commands

wmailhost Specifies the mail server used by Tivoli ManagementFramework on Windows NT or Windows 2000systems

wpatch Installs a Tivoli patch

wserver Installs the Tivoli management region server

wsettap Sets the properties of the Tivoli AuthenticationPackage (Windows NT and Windows 2000 only)

Command Purpose

Command Purpose

wconnect Connects two Tivoli management regions

wdisconn Disconnects two Tivoli management regions

wlookup Searches for a resource’s object reference

wlsconn Lists the current Tivoli management regionconnections or information about a singleconnection

wregister Registers a resource with the name registry

wtmrname Displays or changes the name of the local Tivolimanagement region

wupdate Updates resources in the local name registry


Com

mands

Kerberos Commands

Command Purpose

kadmin Network utility for Kerberos database administration

kadmind Network daemon for Kerberos database administration

kdb_destroy Destroys a Kerberos key distribution center database

kdb_edit Kerberos key distribution center database editing utility

kdb_init Initializes a Kerberos key distribution center database

kdb_util Kerberos key distribution center database utility

kdestroy Destroys Kerberos tickets

kerberos Introduces the Kerberos authentication service

kinit Kerberos login utility

klist Lists currently held Kerberos tickets

kpasswd Changes a user’s Kerberos password

ksrvtgt Fetches and stores Kerberos ticket-granting-ticket usinga service key

kstash Stashes the Kerberos key distribution center databasemaster key

1–14 Version 3.7.1

Low-Level Maintenance Commands

Command Purpose

idlarg Extracts individual options from an option listreturned by theidlinput command

idlattr Gets or sets implementation attributes

idlcall Provides a method of invoking Interface DefinitionLanguage (IDL) operations from the shell commandline

idlexception Raises exceptions for a shell method

idlinput Gets the input or inout options list to a shell method

idlresult Formats inout or output options or the result (if any)of a shell method

logls Creates a readable version of a transaction log file

objcall Performs an object call from the shell

odadmin Manages object dispatchers

odbls Lists the contents of an object database

odstat Lists the status of current and recent object calls

oserv Provides operations to control and configure objectdispatchers

tmcmd Forces a change of state of a running transaction

tmstat Displays the status of current transactions and locks

wlocalhost Sets the name of the local host in the Windowsregistry (Windows NT and Windows 2000 only)


Com

mands

Managed Node Commands

wlocktmr Places the current Tivoli management region inmaintenance mode

wmailhost Specifies the mail server used by Tivoli ManagementFramework on Windows NT and Windows 2000systems

Command Purpose

Command Purpose

wclient Creates a managed node

wdate Prints out the current date and time of the managednode

wdiskspace Prints the number of free kilobytes available in thespecified directory (file system) of the specifiedmanaged node

whostid Prints the host ID of the specified managed node

wifconfig Queries or changes the IP interfaces on a managednode

winstdir Prints out the path of the installation directory of thespecified managed node

winterp Prints the interpreter type of the specified managednode

wmannode Returns the properties of a managed node

wmemsize Reports the amount of physical memory of amanaged node

wtimezone Prints the value of the specified system’s time zone

1–16 Version 3.7.1

Multiplexed Distribution Commands

wuname Lists operating system information

wunstmn Removes Tivoli Management Framework files froma managed node

wxterm Starts an Xterminal session on a UNIX managednode

Command Purpose

Command Purpose

lcfd Provides configuration information to the endpointdaemon (lcfd), such as enabling wake-on-LANfunctionality on the endpoint

wadminep Performs administrative operations on an endpoint,such as upgrading the endpoint daemon orgenerating the endpoint wake-up packet forwake-on-LAN operations

wdepot Manages MDist 2 repeater depots

wep Performs actions on endpoint information containedin the endpoint list, such as setting a Windowsendpoint to receive and control MDist 2 distributionsthrough the use of the Tivoli Mobile Computingconsole

wmdist Configures MDist 2 repeaters and managesdistributions

wmdistgui Starts the MDist 2 service’s Distribution Statusconsole from the managed node on which thiscommand is run


Com

mands

Notification Commands

Policy Commands

wrpt Creates a repeater on a managed node (for bothMDist and MDist 2), configures MDist repeaters,and manages MDist distributions

Command Purpose

Command Purpose

wbroadcast Broadcasts a message to all Tivoli desktops

wexpnotif Expires notices from a notice group

wlsnotif Lists notices on an administrator’s bulletin board

wsndnotif Translates standard input into a message structureand sends it to the notification server

wtailnotif Connects to the notification server and displays newnotices as they are posted

Command Purpose

wchkpol Checks policy region members against policy

wcrtpol Creates a new policy object for a class

wcrtpr Creates a policy region

wdelpol Deletes a default policy object

wdelpr Deletes a policy region

1–18 Version 3.7.1

Query Commands

wgetdfpol Lists a default policy object

wgeteppol Lists the body and constant values of an endpointpolicy script

wgetpolm Lists the body or constant value of a default orvalidation policy method

wgetpr Lists the properties of a policy region

wlspol Lists available policy default and validation objectsfor a Tivoli resource

wlspolm Lists policy methods for a Tivoli resource

wputeppol Replaces an endpoint policy script that has beenmodified

wputpolm Replaces a policy method’s body

wsetdfpol Sets the default policy for a class

wsetpr Assigns the policy used in a policy region, enables ordisables policy validation, and adds or removes amanaged resource in a policy region

Command Purpose

Command Purpose

wcrtqlib Creates a query library

wcrtquery Creates a query

wgetquery Lists information about a query


Com

mands

RDBMS Interface Module (RIM) Commands

Revision Control System (RCS) Commands

wruninvquery Queries the database for inventory information andreturns a list of object IDs and object labels thatmatch the query criteria

wrunquery Runs a query and returns the results to eitherstandard output or a file

wsetquery Edits the properties of a query

Command Purpose

Command Purpose

wcrtrim Creates a RIM object

wgetrim Lists information about a RIM object

wrimtest Verifies a RIM object’s connectivity andfunctionality

wrimtrace Enables or disables tracing for RIM objects

wsetrim Changes the database information for a RIM object

wsetrimpw Sets the RIM password for a RIM object database

Command Purpose

wci Checks in RCS revisions

wco Checks out RCS revisions

1–20 Version 3.7.1

Scheduler Commands

Task Library Commands

wident Identifies files

wrcs Changes RCS file attributes

wrcsdiff Compares RCS revisions

wrcsmerge Merges RCS revisions

wrlog Prints log messages and other information aboutRCS files

Command Purpose

Command Purpose

wdelsched Removes jobs from the scheduler

wedsched Edits a job that currently exists in the scheduler

wenblsched Disables or enables scheduled jobs

wgetsched Retrieves information about jobs currently scheduled

wschedjob Schedules a job that exists in a task library

wstartsched Starts the Tivoli scheduler

Command Purpose

wcrtjob Creates a job in a task library

wcrttask Creates a task in a task library


Com

mands

wcrttlib Creates a task library

wdeljob Deletes a job from a task library

wdeltask Deletes a task from a task library

wdisttask Controls the distribution of task binaries for a tasklibrary

wgetjob Lists the properties of a job

wgettask Lists the properties of a task

wlstlib Lists the properties of a task library

wrunjob Runs a job in a task library

wruntask Runs a task in a task library

wsetjob Sets the properties of a job

wsettask Sets the properties of a task

wtaskabort Aborts a task transaction and rolls back anyuncommitted changes

wtll Imports and exports task library definitions

Command Purpose

1–22 Version 3.7.1

Miscellaneous Commands

Command Purpose

tivoli Starts the Tivoli graphical user interface

waddicon Adds an icon to a Windows Program Manager group(Windows 95, Windows NT, and Windows 2000only)

wbindmsg Retrieves a translated string from a local messagecatalog and binds any variables

wbkupdb Backs up and restores Tivoli databases

wcatcher Saves custom dialogs in Tivoli ManagementFramework or a Tivoli application before an upgradeto a new version of Tivoli Management Frameworkor the application

wcd Changes the current working collection

wchkdb Verifies and repairs the Tivoli database

wchknode Verifies and updates references to a specificdispatcher number from parts of the Tivoli database

wdel Deletes objects from the Tivoli database

wgetallinst Displays all instances of a resource type

wiconv Converts the characters or sequences of characters ina file from one code set to another code set

winstendpt Installs behavior for an endpoint resource type

winstruct Provides the Tivoli environment with informationnecessary to install and manage an application


Com

mands

winstruct_plus Creates Tivoli Application Management modulesfrom Application Management Specification (AMS)files produced by the Tivoli Module Builder

winstruct_task Provides Tivoli Management Framework withinformation necessary to create tasks anddependencies for installing and managing anapplication

wlcftap Sets the properties of the Tivoli AuthenticationPackage on a Windows NT or Windows 2000 client

wln Links an object into a collection

wlocpath Returns the path for the localized file or directory

wls Lists a collection’s member objects

wlsinst Lists the products and patches installed in a Tivolimanagement region

wmerge Performs a three-way file merge

wmrgaef Merge custom dialogs into Tivoli ManagementFramework or a Tivoli application after upgrading

wmv Moves objects between collections

wping Attempts to contact the object dispatcher on a host

wpwd Prints the current working collection

wrefresh Refreshes a Tivoli collection window

wrm Removes objects from a collection

wrmnode Removes a managed node from a Tivoli installation

wrunas Retrieves passwords and launches commands

Command Purpose

1–24 Version 3.7.1

wsetpkey Encrypts and stores passwords

wsupport Collects problem information from users to send to acustomer support representative

wtemp Displays the name of the directory in which Tivoliproducts create temporary files

wtrace Provides information to debug methods

Command Purpose

idlarg


Com

mands

idlargExtracts individual options from an option list returned by theidlinputcommand.

Syntaxidlarg element_offset [option_list]

DescriptionThe idlarg command extracts individual options from an option listreturned by theidlinput command. This command can also be used toget the members of a constructed type. This command returns an exitcode of 0 if successful. If an error occurs, this command exits with anonzero code.

Optionselement_offsetSpecifies the offset to the element in the option list that

should be extracted. The first element is at offset 1, thesecond element is at offset 2, and so on.element_offsetmust be a positive integer.

option_list Specifies a list of options in cleartext format. Ifoption_listis not specified in the command line,idlargreads from standard input until an EOF is encountered.

ExamplesThe following example extracts the in and inout options:interface test {

exception ex { long code; string reason; };struc t s { long l; char c; };s op(in s a, inout s b, out s c) raises (ex);attribute long attr;

};

idlarg

1–26 Version 3.7.1

#! /bin/sh# shell implementation of test::op# Get the input/inout optionsinargs=ìdlinput`# $inargs may look like: "{1 'z'} {2 'w'}".# Now separate the in and inout options.arg_a=ìdlarg 1 $inargsàrg_b=ìdlarg 2 $inargs`# We can get to the fields of arg_a as followsarg_a_l=ìdlarg 1 $arg_aàrg_a_c=ìdlarg 2 $arg_a`# This will set arg_a_l to 1 and arg_a_c to# 'z' respectively.

See Alsoidlattr , idlcall , idlexception, idlinput , idlresult

idlattr


Com

mands

idlattrGets or sets implementation attributes.

Syntaxidlattr –t [–a | –g | –s | –v] target_object attr_name type_name[value]

DescriptionThe idlattr command gets or sets implementation (object) attributes.The–t option indicates that the option list contains the attribute typename; this option is required. The–sand–goptions indicate a set or getoperation, respectively. If neither the–s nor–g option is specified, thedefault is a set operation. Theattr_name option specifies the unscopedattribute name; this is the same unscoped attribute name as in thecorresponding implementation construct. Thetype_name optionspecifies the fully scoped attribute type. If a set operation is beingperformed, thevalueoption is the cleartext value to which the attributeshould be set. If this option is omitted, the cleartext value is read fromstandard input.

Options–t Indicates that the option list contains the type name of

the attribute. This option is required.

–a Adds an attribute to the target object.

–g Specifies a get operation.

–s Specifies a set operation. This is the default.

–v Specifies verbose mode. In verbose mode, exceptionsare bound to messages and printed to standard output.The default is to write exceptions to standard output incleartext format.

target_object Specifies the target object for the operation. The targetobject should be specified in string format.

idlattr

1–28 Version 3.7.1

attr_name Specifies the unscoped attribute name. This is theunscoped attribute name that is in the correspondingimplementation construct.

type_name Specifies the fully scoped type of the attribute.

value Specifies the cleartext value the attribute is to be set to.This option is valid only for a set operation (–s).

ExamplesThe following example shows the accessing of implementationattributes:interface test {exception ex { long code; string reason; };struc t s { long l; char c; };s op(in s a, inout s b, out s c) raises (ex);attribute long attr;};

Assume the following implementation of an interface test:implementation class imp_test honors test {struc t t { long l; };

attribute s attr1; // refers to test::sattribute t attr2;attribute unsigned long attr3; // define methods here

};

Assume 2001.1.15 is the object reference string to an instance ofimp_test. Its physical attributes can be accessed or modified as follows:idlattr -t -g 2001.1.15 attr1 test::s// may print {1 'z'}idlattr -t -s 2001.1.15 attr2 imp_test::t '{20}'idlattr -t 2001.1.15 attr3 ulong 10

See Alsoidlcall

idlcall


Com

mands

idlcallProvides a method of invoking Interface Definition Language (IDL)operations from the shell command line.

Syntaxidlcall [–T trans_type] [–v] target_object operationId [options]

DescriptionThe idlcall command invokes IDL operations from the shell commandline. Thetrans_type option can be used to specify a top-leveltransaction, a subtransaction, a revocable transaction, or no transaction.Thetarget_objectoption specifies the cleartext string representation ofthe target object reference. TheoperationId option specifies theoperation name. The operation name can be specified as the fully scopedname separated by a double colon (Common Object Request BrokerArchitecture [CORBA]RepositoryId) or the operation name (as in theIDL description).options specifies any input or inout options. Theseoptions are listed in the same order as in the IDL description. Thiscommand writes the inout or output options and the result, if any, tostandard output in cleartext format. If theidlcall invocation results in anexception, the exception is written to standard output. If an operationrequires input or inout options but none are specified on the commandline, this command reads input from standard input until an EOF isencountered.

Options–T trans_type Specifies a transaction type. This option can be one of

the following:

none No transaction

revoke Revocable transaction

sub Subtransaction

top Top-level transaction

–v Specifies verbose mode. In verbose mode, exceptionsare bound to messages and printed to standard output.

idlcall

1–30 Version 3.7.1

The default is to write exceptions to standard output incleartext format.

target_object Specifies the cleartext string format of the targetobject’s object reference.

operationId Specifies the operation name. This can be thedouble-colon separated fully scoped name (CORBARepositoryId) or the operation name (as in the IDLdescription). The first form is more efficient because itmakes fewer remote calls, but the second form issimpler to use. For IDL attributes, the operation name isthe attribute name prefix with_get_ or _set_ for a getor set operation, respectively.

options Specifies the input or inout options. If input or inoutoptions are required but not specified on the commandline, theidlcall command reads input from standardinput until an EOF is encountered.

DiagnosticsTheidlcall command exits with a nonzero status if the invocation resultsin an exception (either in dispatching the call or raised by the methodimplementation). Otherwise, this command exits with 0. The exit statuscan be used to interpret the cleartext output.

Examplesinterface test {


};

Assume 2001.1.15 is the cleartext string representation of the objectreference to an object that supports interface test.

idlcall


Com

mands

Its operations can be invoked as follows:idlcall –T top 2001.1.15 test::op "{1'z'}" "{2 'w'}"idlcall –T top 2001.1.15 op <<!EOF{1 'z'} {2 'w'}!EOFidlcall 2001.1.15 _get_attridlcall –T top 2001.1.15 _set_attr 20

See Alsoidlattr

idlexception

1–32 Version 3.7.1

idlexceptionRaises exceptions for a shell method.

Syntaxidlexception [{ exception_type scoped_exception_name{ exception_data}}]

DescriptionTheidlexceptioncommand is used to raise exceptions. The script mustexit with a nonzero exit code if the script raises an exception. An exitcode of 0 indicates a normal return.

Note: Do not useidlexception to raise an exception from a TivoliExtended Interface Definition Language (EIDL) commandmethod. The Tivoli run time will implicitly raise an exceptionfrom a command method if the command was terminated by asignal. A command method never raises an exception explicitly.Thus, a shell method refers to the EIDL shell binding only.

Optionsexception_typeSpecifies the exception type. This can be

USER_EXCEPTION or SYSTEM_EXCEPTION .

scoped_exception_nameSpecifies the fully qualified IDL exception name.

exception_dataIndicates the cleartext representation of the exceptionstructure fields. If the exception is empty, nothing iscontained inside the inner parentheses. Ifidlexceptionis invoked without any command line options, thecleartext exception is read from standard input.

idlexception


Com

mands

Examplesinterface test {


};

#! /bin/sh# shell implementation of test::op# In doing some work, say we failed, and now# want to raise the test::ex exception.excep=ìdlexception '{USER_EXCEPTION test::ex {"failed" 99}}'`# the exception must be written to stdout.echo $excep# must exit with a nonzero statusexit 1

To raise a SYSTEM exception, enter the following:# Raise a standard exception (also let idlexception read

# from stdin)excp=ìdlexception <<!EOF{SYSTEM_EXCEPTION StExcep::BAD_PARAM {999 NO }}!EOFècho $excpexit 1

See Alsoidlattr , idlcall , idlinput , idlresult

idlinput

1–34 Version 3.7.1

idlinputGets the input or inout options list to a shell method.

Syntaxidlinput

DescriptionThe idlinput command gets the input or inout options list (in cleartextformat) to a shell method. The options are in the same order as in theInterface Definition Language (IDL) signature.

Note: Do not useidlinput with Tivoli Extended Interface DefinitionLanguage (EIDL) command-style methods. A commandmethod gets its input from the options list or standard input.Thus, a shell method refers to the EIDL shell binding only.

ExamplesThe following example accesses the inout options of the EIDL shell:interface test {


};

#! /bin/sh# shell implementation of test::op# Get the input/inout optionsinargs=`idlinput`# $inargs may look like: "{1 'z'} {2 'w'}",# the first and the second pair of curly braces# contain the in option (a) and the inout option# (b) respectively. The method can now access each# individual option or their fields using idlarg.# rest of the method goes here.

See Alsoidlattr , idlcall , idlexception, idlresult

idlresult


Com

mands

idlresultFormats inout or output options or the result (if any) of a shell method.

Syntaxidlresult [options]

DescriptionTheidlresult command formats inout or output options or any result thatis returned. The inout and output options must be in cleartext format andmust be passed to this command in the same order that they appear in theInterface Definition Language (IDL) signature. The result, if any,follows. The options to be formatted can be specified as command lineoptions toidlresult . Otherwise,idlresult reads the options fromstandard input until an EOF is encountered.

Note: Do not useidlresult with Tivoli Extended Interface DefinitionLanguage (EIDL) command-style methods. A commandmethod writes its output to standard output or standard error andno formatting is necessary. Thus, a shell method refers to theEIDL shell binding only.

ExamplesThe following example formats the inout options of the EIDL shell:interface test {


};

#! /bin/sh# shell implementation of test::op# do some work# return some hard coded values.b="{1 'a'}"c="{2 'b'}"retval="{3 'c'}"# the order of options is inout(b), out(c) and# the return result. We could have also said:#

idlresult

1–36 Version 3.7.1

# all=`idlresult <<!EOF# $b# $c# $retval# !EOF# `#all=`idlresult $b $c $retval`# The results must be written to stdout.echo $all# A 0 exit code means a successful return from# a EIDL shell method.exit 0

See Alsoidlattr , idlcall , idlexception, idlinput

kadmin


Com

mands

kadminNetwork utility for Kerberos database administration.

Syntaxkadmin

DescriptionThis utility provides a unified administration interface to the Kerberosmaster database. Kerberos administrators usekadmin to register newusers and services to the master database, and to change informationabout existing database entries. For example, an administrator can usekadmin to change a user’s Kerberos password. A Kerberosadministrator is a user with an “admin” instance whose name appears onone of the Kerberos administration access control lists.

Thekadmin utility communicates over the network with thekadmindprogram, which runs on the machine housing the Kerberos masterdatabase. Thekadmind creates new entries and makes modifications tothe database.

When you enter thekadmin command, the program displays a messagethat welcomes you and explains how to ask for help. Thenkadmin waitsfor you to enter commands (which are described below). It then asks youfor youradmin password before accessing the database.

Use theadd_new_key (or ank for short) command to register a newprincipal with the master database. The command requires one option,the principal’s name. You are asked to enter youradmin password, andthen you are prompted twice to enter the principal’s new password.

Use theadd_new_instance(ani) command to add a new principal witha non-null instance to the master database. The command requires twooptions, the principal’s name and the principal’s instance. You are askedto enter youradmin password, and then you are prompted twice to enterthe principal’s new password.

Use thechange_password (cpw) command to change a principal’sKerberos password. The command requires one option, the principal’sname. You are asked to enter youradmin password, and then you areprompted twice to enter the principal’s new password.

kadmin

1–38 Version 3.7.1

Use thechange_instance_key (cik) command to change the Kerberospassword for a principal with a non-null instance. The commandrequires two options, the principal’s name and the principal’s instance.You are asked to enter youradmin password, and then you are promptedtwice to enter the principal’s new password.

Use thechange_admin_password (cap) command to change youradmin instance password. This command requires no options. Itprompts you for your oldadmin password, and then prompts you twiceto enter the newadmin password.

Use thelist_requests(lr ) command to get a list of possible commands.

Use thehelp command to display the various help messages forkadmin. If entered without an option,help displays a general helpmessage. You can get detailed information about specifickadmincommands by enteringhelp command_name.

To quit the program, typequit .

Defectskadmin currently does not allow addition, retrieval, or modification ofprincipals with non-null instances.

AuthorJeffrey I. Schiller, MIT (Massachusetts Institute of Technology) ProjectAthena

RestrictionsCopyright © 1989 by the Massachusetts Institute of Technology.

Export of this software from the United States of America is assumed torequire a specific license from the United States Government. It is theresponsibility of any person or organization contemplating export toobtain such a license before exporting.

WITHIN THAT CONSTRAINT, permission to use, copy, modify, anddistribute this software and its documentation for any purpose andwithout fee is hereby granted, provided that the above copyright noticeappears in all copies and that both that copyright notice and thispermission notice appear in supporting documentation, and that the

kadmin


Com

mands

name of M.I.T. not be used in advertising or publicity pertaining todistribution of the software without specific, written prior permission.M.I.T. makes no representations about the suitability of this software forany purpose. It is provided “as is” without express or implied warranty.

See Alsokerberos, A Subsystem Utilities Package for UNIX by Ken Raeburn

kadmind

1–40 Version 3.7.1

kadmindNetwork daemon for Kerberos database administration.

Syntaxkadmind [–n] [–h] [–f file_name] [–d db_name] [–aacl_dir]

Descriptionkadmind is the network database server for the Kerberospassword-changing and administration tools.

Upon execution, it prompts the user to enter the master key string for thedatabase. If the–n option is specified, the master key is instead fetchedfrom the master key cache file. If the–f file_name option is specified,that file is used to hold the log information instead of the default.

If the –d db_name option is specified, that file is used as the databasename instead of the default.

If the –aacl_dir option is specified,acl_dir is used as the directory inwhich to search for access control lists (ACLs) instead of the default.

If the –h option is specified,kadmind prints a short summary of thepermissible control options, and then exits.

When performing requests on behalf of clients,kadmind checks ACLsto determine the authorization of the client to perform the requestedaction. Currently three distinct access types are supported:

Addition (.add ACL file). If a principal is on this list, it may addnew principals to the database.

Retrieval (.get ACL file). If a principal is on this list, it mayretrieve database entries.

Note: A principal’s private key is never returned bythe get functions.

Modification (.mod ACL file). If a principal is on this list, it maymodify entries in the database.

A principal is always granted authorization to change its own password.

kadmind


Com

mands

Files/kerberos/admin_server.syslog

Default log file.

/kerberos Default access control list directory.

admin_acl.{ add,get,mod}Access control list files (within the directory).

/kerberos/principal.pag, /kerberos/principal.dirDefault DBM files containing a database.

/.k Master key cache file.

AuthorDouglas A. Church, MIT Project AthenaJohn T. Kohl, Project Athena/Digital Equipment Corporation



WITHIN THAT CONSTRAINT, permission to use, copy, modify, anddistribute this software and its documentation for any purpose andwithout fee is hereby granted, provided that the above copyright noticeappears in all copies and that both that copyright notice and thispermission notice appear in supporting documentation, and that thename of M.I.T. not be used in advertising or publicity pertaining todistribution of the software without specific, written prior permission.M.I.T. makes no representations about the suitability of this software forany purpose. It is provided “as is” without express or implied warranty.

See Alsokerberos, kpasswd, kadmin, acl_check

kdb_destroy

1–42 Version 3.7.1

kdb_destroyDestroys a Kerberos key distribution center database.

Syntaxkdb_destroy

Descriptionkdb_destroy deletes a Kerberos key distribution center database.

The user is prompted to verify that the database should be destroyed. Aresponse beginning with ‘y’ or ‘Y’ confirms deletion. Any otherresponse aborts deletion.

Diagnostics“Database cannot be deleted at /kerberos/principal”

The attempt to delete the database failed (probably dueto a system or access permission error).

“Database not deleted.”The user aborted the deletion.

Files/kerberos/principal.pag, /kerberos/principal.dir

DBM files containing a database.



WITHIN THAT CONSTRAINT, permission to use, copy, modify, anddistribute this software and its documentation for any purpose andwithout fee is hereby granted, provided that the above copyright noticeappears in all copies and that both that copyright notice and this

kdb_destroy


Com

mands

permission notice appear in supporting documentation, and that thename of M.I.T. not be used in advertising or publicity pertaining todistribution of the software without specific, written prior permission.M.I.T. makes no representations about the suitability of this software forany purpose. It is provided “as is” without express or implied warranty.

See Alsokdb_init

kdb_edit

1–44 Version 3.7.1

kdb_editKerberos key distribution center database editing utility.

Syntaxkdb_edit [–n]

Descriptionkdb_edit is used to create or change principals stored in the Kerberoskey distribution center (KDC) database.

When executed,kdb_edit prompts for the master key string and verifiesthat it matches the master key stored in the database. If the–n option isspecified, the master key is instead fetched from the master key cachefile.

After the master key has been verified,kdb_edit begins a prompt loop.The user is prompted for the principal and instance to be modified. If theentry is not found, the user may create it. After an entry is found orcreated, the user may set the password, expiration date, maximum ticketlifetime, and attributes. Default expiration dates, maximum ticketlifetimes, and attributes are presented in brackets; if the user pressesEnter, the default is selected. There is no default password. ThepasswordRANDOM is interpreted specially, and if entered, the usermay have the program select a random DES key for the principal.

Upon successfully creating or changing the entry,Edit O.K. isprinted.

Diagnostics“verify_master_key: Invalid master key, does not match database.”

The master key string entered was incorrect.




kdb_edit


Com

mands




kdb_init

1–46 Version 3.7.1

kdb_initInitializes a Kerberos key distribution center database.

Syntaxkdb_init [realm]

Descriptionkdb_init initializes a Kerberos key distribution center database, creatingthe necessary principals.

If the optionalrealmoption is not present,kdb_init prompts for a realmname (defaulting to the definition in/usr/include/krb.h). Afterdetermining the realm to be created, it prompts for a master keypassword. The master key password is used to encrypt every encryptionkey stored in the database.

Diagnostics“/kerberos/principal: File exists”

An attempt was made to create a database on a machinethat already had an existing database.



/usr/include/krb.hInclude file defining default realm.



kdb_init


Com

mands


See Alsokdb_destroy

kdb_util

1–48 Version 3.7.1

kdb_utilKerberos key distribution center database utility.

Syntaxkdb_util operation file_name

Descriptionkdb_util allows the Kerberos key distribution center (KDC) databaseadministrator to perform utility functions on the database.

operation must be one of the following:

load Initializes the KDC database with the records describedby the text contained in the filefile_name. Any existingdatabase is overwritten.

dump Dumps the KDC database into a text representation inthe file file_name.

slave_dump Performs a database dump like thedumpoperation, andadditionally creates a semaphore file, which signals thepropagation software that an update is available fordistribution to slave KDC databases.

new_master_keyPrompts for the old and new master key strings, andthen dumps the KDC database into a text representationin the filefile_name. The keys in the text representationare encrypted in the new master key.

convert_old_dbPrompts for the master key string, and then dumps theKDC database into a text representation in the filefile_name. The existing database is assumed to beencrypted using the old format (encrypted by the keyschedule of the master key); the dumped database isencrypted using the new format (encrypted directlywith master key).

kdb_util


Com

mands





file_name.ok Semaphore file created by slave_dump.




kdestroy

1–50 Version 3.7.1

kdestroyDestroy Kerberos tickets.

Syntaxkdestroy [–f] [–q]

DescriptionThekdestroy utility destroys the user’s active Kerberos authorizationtickets by writing zeros to the file that contains them. If the ticket filedoes not exist,kdestroy displays a message to that effect.

After overwriting the file,kdestroy removes the file from the system.The utility displays a message indicating the success or failure of theoperation. Ifkdestroy is unable to destroy the ticket file, the utilitywarns you by making your terminal beep.

Options–f Status message does not display.

–q kdestroy terminal does not beep if tickets are notdestroyed.

FilesKRBTKFILE environment variable if set; otherwise,/tmp/tkt [uid].

DefectsOnly the tickets in the user’s current ticket file are destroyed. Separateticket files are used to hold root instance and password changing tickets.These files should probably be destroyed too, or all the user’s ticketskept in a single ticket file.

AuthorSteve Miller, MIT Project Athena/Digital Equipment Corporation.Clifford Neuman, MIT Project Athena, Bill Sommerfeld, MIT ProjectAthena

kdestroy


Com

mands




See Alsokerberos, kinit , klist

kerberos

1–52 Version 3.7.1

kerberosIntroduction to the Kerberos authentication service.

DescriptionKerberos authenticates individual users in a network environment. Afterauthenticating yourself to Kerberos, you can use network utilities suchasrlogin , rcp, andrsh without having to present passwords to remotehosts and without having to use.rhosts files. These utilities workwithout passwords only if the remote machines you deal with supportthe Kerberos system.

Tivoli Management Framework can use Kerberos to authenticate Tivoliobjects in a distributed management environment.

Before you can use Kerberos, you must make sure that you have beenadded to the Kerberos database. Use thekinit command. This commandtries to log you in to the Kerberos system.kinit prompts you for a username and password. Enter your user name and password. If you can login without a message, you are registered in the Kerberos database.

If you enter your user name andkinit responds with this message, seeyour system administrator:Principal unknown (kerberos) you haven’t been registered as aKerberos user. See your system administrator.

A Kerberos name contains three parts:

■ principal name—Usually a user’s or service’s name.

■ instance—In the case of a user, usually null. Some users may haveprivileged instances, however, such asroot or admin. In the caseof a service, the instance is the name of the machine on which itruns; for example, anrlogin service can run on machine ABC,which is different from therlogin service running on the machineXYZ.

■ realm—Corresponds to the Kerberos service providingauthentication for the principal. For example, at MIT there is aKerberos running at the Laboratory for Computer Science and onerunning at Project Athena.

When writing a Kerberos name, the principal name is separated from theinstance (if not null) by a period, and the realm (if not the local realm)

kerberos


Com

mands

follows, preceded by an “@” sign. The following are examples of validKerberos names:billb , jis.admin, [email protected], [email protected].

When you authenticate yourself with Kerberos through thekinitcommand, Kerberos gives you an initial Kerberos ticket. (A Kerberosticket is an encrypted protocol message that provides authentication.)Kerberos uses this ticket for network utilities such asrlogin andrcp.The ticket transactions are done transparently, so you do not have tomanage them.

Tickets, however, expire. Privileged tickets, such as root instancetickets, expire in a few minutes. Tickets that carry more ordinaryprivileges can be good for several hours or a day, depending on theinstallation’s policy. If your login session extends beyond the time limit,you will have to reauthenticate yourself to Kerberos to get new tickets.Use thekinit command to reauthenticate yourself.

If you use thekinit command to get your tickets, be sure to use thekdestroy command to destroy your tickets before you end your loginsession. If you put thekdestroy command in your.logout file, yourtickets will be destroyed automatically when you log out. See thekinitandkdestroy commands for more information. Kerberos supports thefollowing network services:rlogin , rsh, andrcp.

DefectsKerberos will not do authentication forwarding. In other words, if youuserlogin to log in to a remote host, you cannot use Kerberos servicesfrom that host until you authenticate yourself explicitly on that host.Although you may need to authenticate yourself on the remote host, beaware that when you do so,rlogin sends your password across thenetwork in cleartext.

AuthorSteve Miller, MIT Project Athena/Digital Equipment Corporation,Clifford Neuman, MIT Project Athena

kerberos

1–54 Version 3.7.1

The following people helped out on various aspects of the system:

■ Jeff Schiller designed and wrote the administration server and itsuser interface,kadmin. He also wrote thedbm version of thedatabase management system.

■ Mark Colan developed the Kerberos versions ofrlogin , rsh, andrcp as well as contributing work on the servers. These versions ofrlogin , rsh, andrcp were further modified by Tivoli Systems Inc.

■ John Ostlund developed the Kerberos versions ofpasswd anduserreg.

■ Stan Zanarotti pioneered Kerberos in a foreign realm (LCS), andmade many contributions based on that experience.

Many people contributed code and useful ideas, including Jim Aspnes,Bob Baldwin, John Barba, Richard Basch, Jim Bloom, Bill Bryant, RobFrench, Dan Geer, David Jedlinsky, John Kohl, John Kubiatowicz, BobMcKie, Brian Murphy, Ken Raeburn, Chris Reed, Jon Rochlis, MikeShanzer, Bill Sommerfeld, Jennifer Steiner, Ted Ts’o, and Win Treese.Additional revision of this version was performed by Tivoli Systems tosupport the Tivoli software. The following functions were modified:kerberos, kdb_edit, kdb_init , andkdb_destroy.

RestrictionsCopyright © 1985, 1986, 1989 Massachusetts Institute of Technology.



kerberos


Com

mands

See Alsokdestroy, kinit , klist , kpasswd

kinit

1–56 Version 3.7.1

kinitKerberos login utility.

Syntaxkinit [–irvl ]

DescriptionThekinit command is used to log in to the Kerberos authentication andauthorization system. Only registered Kerberos users can use theKerberos system. For information about registering as a Kerberos user,see thekerberos command.

When you usekinit without options, you are prompted for your username and Kerberos password, andkinit tries to authenticate your loginwith the local Kerberos server.

If Kerberos authenticates the login attempt,kinit retrieves your initialticket and puts it in the ticket file specified by yourKRBTKFILEenvironment variable. If this variable is undefined, your ticket is storedin thetmp directory, in the filetktuid , where UID specifies your useridentification number.

Always use thekdestroy command to destroy active tickets before youend your login session. If you put thekdestroy command in your.logout file, your tickets are destroyed automatically when you log out.

Options–i Specifies that you are to be prompted for a Kerberos

instance.

–v Specifies verbose mode.kinit prints the name of theticket file used, and a status message indicating thesuccess or failure of your login attempt.

–l kinit prompts you for a ticket lifetime in minutes. Thevalue must be between 5 and 1275 minutes.

kinit


Com

mands

AuthorSteve Miller, MIT Project Athena/Digital Equipment Corporation,Clifford Neuman, MIT Project Athena




See Alsokerberos, klist

klist

1–58 Version 3.7.1

klistLists currently held Kerberos tickets.

Syntaxklist [–s –t] [–file file_name] [–srvtab]

Descriptionklist prints the name of the tickets file and the identity of the principalthe tickets are for (as listed in the tickets file), and lists the principalnames of all Kerberos tickets currently held by the user, along with theissue and expiration time for each authenticator. Principal names arelisted in the formname.instance@realm, with the ‘.’ omitted if theinstance is null, and the ‘@’ omitted if the realm is null.

Options–s Specifies that issue and expiration times, the name of

the tickets file, or the identity of the principal are not tobe printed.

–t klist checks for the existence of a nonexpiredticket-granting ticket in the ticket file. If one is present,it exits with status 0; if not, it exits with status 1. Nooutput is generated when–t is specified.

–file file_nameSpecifiesfile_name as the ticket file. Otherwise, if theKRBTKFILE environment variable is set, it is used. Ifthis environment variable is not set, the file/tmp/tkt [uid] is used, whereuid is the current user IDof the user.

–srvtab Specifies that the file is to be treated as a service keyfile. The names of the keys contained in the file display.

klist


Com

mands

Files/etc/krb.conf File containing the name of the local realm.

/tmp/tkt [uid] Default ticket file ([uid] is the decimal UID of the user).

/etc/srvtab Default service key file.

DefectsWhen reading a file as a service key file, little error checking isperformed.

RestrictionsCopyright ©1989 by the Massachusetts Institute of Technology.



See Alsokerberos, kinit , kdestroy

kpasswd

1–60 Version 3.7.1

kpasswdChanges a user’s Kerberos password.

Syntaxkpasswd [–h] [–n name] [–i instance] [–r realm][–u user_name[.instance@realm]]

DescriptionThekpasswd command is used to change a Kerberos principal’spassword.

The utility prompts for the current Kerberos password (printing thename of the principal for which it intends to change the password),which is verified by the Kerberos server. If the old password is correct,the user is prompted twice for the new password. A message is printedindicating the success or failure of the password changing operation.

Options–h Prints a brief summary of the options.

–n name Specifies thatnameis to be used as the principal namerather than the user name of the user runningkpasswd.(This is determined from the ticket file if it exists;otherwise, it is determined from the UNIX user ID.)

–i instance Specifies thatinstance is to be used as the instancerather than a null instance.

–r realm Specifies thatrealm is to be used as the realm ratherthan the local realm.

–u user_name[.instance@realm]Specifies a fully qualified Kerberos principal.

Defectskpasswd does not handle names, instances, or realms with specialcharacters in them when the–n, –i, or–r options are used. If the–uoption is used, however, any valid full name is accepted.

kpasswd


Com

mands

If the principal whose password you are trying to change does not exist,you will not receive a message until after you have entered the oldpassword.




See Alsokerberos, kinit , passwd

ksrvtgt

1–62 Version 3.7.1

ksrvtgtFetches and stores the Kerberos ticket-granting ticket using a servicekey.

Syntaxksrvtgt name instance [[realm] srvtab]

Descriptionksrvtgt retrieves a ticket-granting ticket with a lifetime of 5 minutes forthe principalname.instance@realm (or name.instance@localrealm ifrealmis not supplied on the command line), decrypts the response usingthe service key found insrvtab (or in /etc/srvtab if srvtab is notspecified on the command line), and stores the ticket in the standardticket cache.

This command is intended primarily for use in shell scripts and otherbatch-type facilities.

Diagnostics“Generic kerberos failure (kfailure)” can indicate a range ofproblems, the most common of which is the inability to read the servicekey file.

Files/etc/krb.conf File containing the name of the local realm.

/tmp/tkt [uid] The default ticket file.

/etc/srvtab The default service key file.



ksrvtgt


Com

mands


See Alsokdestroy, kerberos, kinit

kstash

1–64 Version 3.7.1

kstashStashes the Kerberos key distribution center database master key.

Syntaxkstash

Descriptionkstash saves the Kerberos key distribution center (KDC) databasemaster key in the master key cache file.

The user is prompted to enter the key, to verify the authenticity of thekey and the authorization to store the key in the file.



“kstash: Unable to open master key file”The attempt to open the cache file for writing failed(probably due to a system or access permission error).

“kstash: Write I/O error on master key file”Thewrite (2) system call returned an error whilekstashwas attempting to write the key to the file.





Export of this software from the United States of America is assumed torequire a specific license from the United States Government. It is the

kstash


Com

mands

responsibility of any person or organization contemplating export toobtain such a license before exporting.


lcfd

1–66 Version 3.7.1

lcfdProvides configuration information to the endpoint daemon (lcfd),including login options, port numbers, and debugging information.

Syntaxlcfd [–b lib_dir] [–C dir_name] [–d level] [–D option=value][–gaddress[+port][:address[+port]…]] [ –H] [–i] [–l file_name][–n ep_label] [–p ep_gw_port] [–Pep_port] [–r svc_name] [–s][–w 0 | 1] [–x protocol]

DescriptionThe lcfd command provides configuration information to the endpointdaemon (lcfd), including login options, port numbers, and debugginginformation. It can also start the endpoint daemon (lcfd) installed on anendpoint. UNIX endpoints can use thelcfd.shscript to start and stop theendpoint (seelcfd.sh). You can use the–i option to install the daemonas a service on Windows NT and Windows 2000 systems. The–r optionremoves an existing service from the Windows NT Service Manager. Toview the usage statement for this command, enterlcfd –s –D?. Whenusing Internetwork Packet Exchange (IPX) to connect to endpoints, onlyNetWare and Windows systems are supported.

Options–b lib_dir Specifies the path to the configuration library, which

contains the shared libraries required by an endpoint.This option does not apply to NetWare.

–C dir_name Specifies the name of the endpoint’s current workingdirectory. This directory contains configuration filesneeded for startup and the method cache.

–d level Defines the level of debug messages written to thelcfd.log file. The default value is 1. The following arevalid entries:

0 No message logging

1 Minimal logging (default)

lcfd


Com

mands

2 Tracing and moderate output

3 Detailed information and tight loops

4 Data

Note: Level 1 is the default value. Level 4message logging generates a large numberof messages. Level 2 or 3 is recommendedfor troubleshooting.

–D option=valueReconfigures the endpoint during startup using one ormore of the following options. Configurationinformation is stored in thelast.cfgfile on the endpoint.Some of these options can also be set with commandline options.

? Displays the usage statement for this command.

address_notif_interval=secondsFor Dynamic Host Configuration Protocol (DHCP)environments, specifies an endpoint timeoutinterval to wake up from its idle state and attempt tonotify the gateway of its current IP address. Thisoption is only for endpoints that might change IPaddresses without the endpoint daemon restarting.The recommended value for this option is 300seconds. The default value for this option is 0,meaning that the endpoint daemon does not notifythe gateway.

bcast_disable=1 | 0Disables the User Datagram Protocol (UDP) or IPXbroadcast when set to1. If you set this option to1,you must use thelcs.login_interfaces option. IPXextended broadcast uses the Routing InformationProtocol (RIP) protocol, and is able to send loginpackets within a 5-hops radius.

cache_limit=max_sizeSpecifies the maximum size of the method cache.After this maximum size is reached, the least

lcfd

1–68 Version 3.7.1

recently used methods are deleted to make room forcurrent methods.

cache_loc=cacheIdentifies or changes the name of the method cachecreated and maintained on the endpoint. Thisoption can also be used to change the location of themethod cache when submitted with a full pathname.

config_path=last.cfgIdentifies the absolute path to thelast.cfgconfiguration file. Editing this option is notrecommended.

debug_flags=debug_levelEnables the user to attach a debug tool to a runningmethod. Editing this option is not recommended.

gateway_port=port_numberIdentifies the port on which the gateway monitorsendpoint communications. The default value is9494. This option can also be set using thelcfd –pcommand.

http_disable=valueSpecifies the level of functionality for the Webbrowser accessible on the endpoint. By default, theWeb browser is fully enabled and can be usedremotely for configuration of the endpoint(value=0). If you setvalue=1, the Web browserallows viewing of endpoint configuration data, butchanging endpoint configuration from the browseris disallowed. If you setvalue=2, the endpointdaemon does not respond to Web browser (http)requests.

interp= interp_typeIdentifies the interpreter type of the endpoint.Editing this option is not recommended.

lcfd


Com

mands

lcfd_alternate_port=port_numberIdentifies an alternate port on which the endpointdaemon (lcfd) monitors gateway communicationsif lcfd cannot contact its default port (specified bylcfd –P) during startup. The default value is 9496.

lcfd_port=port_numberIdentifies the port on which the endpoint daemon(lcfd) monitors gateway communications. Thedefault value is 9495. This option can also be setusinglcfd –P.

lcs.gateway_address=IP_address | IPX_addressChanges the login gateway after the endpoint hassuccessfully logged in. If the gateway has notpreviously logged in, use thelcs.login_interfacesoption to provide one or more gateways throughwhich the endpoint can log in. For NetWare andWindows endpoints using IPX, to log in to agateway located outside a 5-hops radius, you mustspecify the IPX address (not host name).

lcs.login_interfaces=address[+port][:address [+port]]…

Specifies the IP address or host name (or IPXaddress or server name) and port number of one ormore gateways to which an endpoint sends its loginpacket. This option is required for the endpoint tolog in to a gateway on a different subnet or to log into a specific gateway when two or more exist on asubnet. If your gateways and endpoints areseparated by a network address translation (NAT)device, specify host names instead of IP addresses.Multiple addresses must be separated by colons.You can also use the–g option to list one or moregateways.

Note: This option does not specify the gateway towhich an endpoint is ultimately assigned.The endpoint manager determines gatewayselection and assignment. If the endpoint

lcfd

1–70 Version 3.7.1

has successfully logged in to a gateway,use thelcs.gateway_address option tochange the gateway.

lcs.machine_name=ep_labelIdentifies the endpoint label as shown inwlookupor wep. You can also use the–n option to identifyan endpoint label.

lcs.machine_unique_id=ID_numberIdentifies the unique identification of the endpoint.ID_number must be a unique number within theTivoli environment that is the same length as thenumber it is to replace in the file$LCF_DATDIR/lcf.id .

local_ip_address=IP_addressFor endpoints with multiple IP addresses, allowsconnections on the specifiedIP_address. If thelocal_ip_addressoption is specified, the endpointbinds to the provided address instead of 0.0.0.0, andconnections are only accepted on that interface.

local_ip_interface=IP_addressFor machines with multiple network interfaces,forces the lcfd daemon to bind an endpoint to aspecificIP_address. This option also can bespecified in thelast.cfg file using thelocal_ip_interface statement.

logfile=full_pathIdentifies the absolute path to the file in whichstatus messages are logged. The default log file islcfd.log. Editing this option is not recommended.

Note: Tivoli recommends using the–l option tochange the name of the log file.

login_interval=secondsSpecifies the waiting period before an endpointexecutes another login attempt. The default is 1800seconds (30 minutes).

lcfd


Com

mands

login_mode=mobile | non_mobileFor Windows endpoints only, enables a user at thespecified endpoint to receive and control MDist 2distributions through the Tivoli Mobile Computingconsole. Specify thenon_mobileoption to disableconsole functions on the endpoint.

Note: For this to work, a Tivoli administratormust first use thewepep_label setlogin_mode –s variablecommand.

You also can enable mobile support by using thewepep_label set login_mode –m mobilecommand.

log_queue_size=max_sizeSpecifies the maximum amount of memory(measured in bytes) used for the log queue. OnlyLogQ messages are sent to the log queue. If anexception occurs, the entire queue is printed to thescreen. The valid range is 1024 through 102400.

log_size=max_sizeSpecifies the maximum size (in bytes) of the logfile. The valid range is 10240 through 10240000.

log_threshold=debug_levelIdentifies the level of debug logging. This optioncan also be set using the–d option.

protocol=TCPIP | IPXSpecifies the protocol on which the endpointdaemon (lcfd) monitors gateway communications.Supported protocols are as follows:

TCPIP Specifies Transmission ControlProtocol/Internet Protocol(TCP/IP). This is the default.

IPX Specifies Internetwork PacketExchange (IPX).

To specify both TCP/IP and IPX protocols, specifythe option asprotocol=TCPIP,IPX . You also can

lcfd

1–72 Version 3.7.1

set this option using the–x option. Note that youcannot turn off the TCP/IP protocol for a gateway.

run_dir= dir_nameIdentifies the directory from which the endpointdaemon runs. Editing this option is notrecommended.

run_timeout=secondsThis value is no longer used. Theudp_interval isnow used to specify the wait time (in seconds)before a communication timeout occurs following asuccessful login.

start_delayDelays lcfd startup in cases where an endpoint anda gateway coexist on the same machine. Ifstart_delay is not used in the above circumstances,endpoint login either takes a long time, or it maynot occur at all.

start_timeout=secondsSpecifies the wait time (in seconds) before acommunication timeout occurs during login. Thedefault value is 120.

udp_attempts=numberSpecifies the number of times an endpoint transmitsan initial login request. The default value is 6.

udp_interval=secondsSpecifies the number of seconds between endpointinitial login request attempts. The default value is300.

–gaddress[+port] [:address[+port]]…If the endpoint uses TCP/IP, this option specifies theIP address or host name and, optionally, the portnumber of one or more gateways to which an endpointsends its login packet. If the endpoint uses InternetworkPacket Exchange/Sequenced Packet Exchange(IPX/SPX), this option specifies the IPX address orserver name and port number of one or more gateways

lcfd


Com

mands

to which an endpoint sends its login packet. The defaultport number is 9495. This option is required for theendpoint to log in to a gateway on a different subnet orto log in to a specific gateway when two or more existon a subnet.

Notes:

• If your gateways and endpoints are separatedby a network address translation (NAT) device,specify host names instead of IP addresses.Multiple addresses must be separated bycolons.

• For NetWare and Windows endpoints to log into a gateway located outside a 5-hops radius,you must specify the IPX address (not servername).

–H In OS/2® only, enables you to start the endpoint onOS/2 systems in detached mode. This option removeslcfd.exe from the task list to prevent users frominadvertently killing the lcfd daemon. This option doesnot hide the process from other means of detection suchas PSPM2, pstat, or KILLFEATUREENABLE=YES intheconfig.sys file.

–i Installs the endpoint software as a Windows service onthe specified endpoint. This option is valid onWindows NT and Windows 2000 systems only.

–l file_name Specifies the name of the log file to which status anderror messages are written. The default file name islcfd.log.

–n ep_label Identifies the endpoint label as shown inwlookup orwep. NetWare, Windows, and OS/2 endpointscommunicating over TCP/IP use the machine’s hostname as the default. NetWare endpoints using IPX usethe server name as the default. Windows endpointsusing IPX use the computer name as the default.

lcfd

1–74 Version 3.7.1

–p ep_gw_portSpecifies the port number on which the gatewaymonitors endpoint communications.

–Pep_port Sets the port number on which the endpoint monitorsgateway communications.

–r svc_name Removes an existing Windows service from the ServiceManager. If used on Windows 95, removes all instancesof lcfd. This option is valid for Windows systems only.

–s Starts an endpoint as a console application, printing allmessages to the screen and to the endpoint log file. Ifused on Windows 95 and Windows 98, this optionprints all messages in the debug window and the logfile. OS/2 and NetWare ignore this option.

–w 0 | 1 Enables wake-on-LAN functionality on the endpointwhen set to1. When an endpoint enabled forwake-on-LAN performs a normal login, the endpointsends the gateway the information necessary togenerate the wake-up packet. By default,wake-on-LAN is disabled (0). For more informationabout wake-on-LAN, see theTivoli ManagementFramework User’s Guide.

–x TCPIP | IPXSpecifies the protocol used by the endpoint. Supportedprotocols are the following:

TCPIP Specifies Transmission ControlProtocol/Internet Protocol (TCP/IP).This is the default. If you do notspecify the–x option, the endpointuses TCP/IP.


To specify both TCP/IP and IPX protocols, specify theoption as–x=TCPIP,IPX. You also can set this optionusing the–protocol option. Note that you cannot turnoff the TCP/IP protocol for a gateway.

lcfd


Com

mands

AuthorizationNo Tivoli authorization role is required.

Examples1. The following example starts the local endpoint using

configuration information contained in thelast.cfg file:

lcfd

2. The following example starts the endpoint as a service on the localmachine and sets the debug level to 3, which causes the endpointto log all messages to thelcfd.log file:

lcfd -i -d 3

3. The following example restarts the local Windows endpoint. Theendpoint logs in to a gateway outside its subnet (with host namezeus) on port27246. The–poption indicates both the endpoint andgateway use port 27246.

lcfd -p 27246 -g zeus+9494

4. The following example starts the local endpoint as a service andspecifies that it uses SPX/IPX as a protocol. It also specifies thatthe endpoint logs in to a gateway with the specified IPX address,listening to a specified port.

lcfd -x IPX -g 4132AF12.000000000001+41204 -i

5. The following example starts the local endpoint as a service on aWindows NT system and specifies that it update thelog_threshold option to debug level 3. Note that in this situationthe option is not preceded with a dash, but is preceded with a slash.

net start lcfd /d3

See Alsolcfd.sh

lcfd.sh

1–76 Version 3.7.1

lcfd.shStarts or stops the endpoint daemon (lcfd) on UNIX endpoints.

Syntaxlcfd.sh { start | stop} [ lcfd_ options]

DescriptionThe lcfd.sh command is a wrapper for thelcfd command.lcfd.shcontains the links to platform-specific shared libraries required on UNIXendpoints.lcfd.sh takes the same options as thelcfd command andresides inLCF_DATDIR . These options are then passed to lcfd whenit is invoked. See thelcfd command for a detailed explanation of thelcfdoptions.

The lcfd.sh command is run locally on UNIX machines inLCF_DATDIR .

Optionsstart Starts the endpoint daemon (lcfd).

stop Stops the endpoint daemon (lcfd).

lcfd_options See thelcfd command for a detailed explanation of thelcfd options.

AuthorizationNo Tivoli authorization is required.

ExamplesThe following example is run locally on a UNIX endpoint and stops theendpoint daemon on that machine:lcfd.sh stop

See Alsolcfd

logls


Com

mands

loglsCreates a readable version of a transaction log file.

Syntaxlogls [–Dofls] [–k dir] [–m maxdlen] log_name…

DescriptionThe logls command creates a readable version of the specifiedtransaction log files. It is primarily a diagnostic tool for debugging thetransaction manager. Customer Support may ask you to run thiscommand if a severe problem is encountered.

The oserv daemon’s transaction log file isodb.log. This file is locatedin the database directory.

If the oserv daemon is running, you may want to shut it down orsynchronize the database. The log snapshot may be incomplete withrespect to any currently running transactions.

You can runodadmin db_sync to flush the log file.

Options–D Prints the data in the log records.

–o Lists only the “old pages” log records.

–f Lists only the “forward” log records.

–l Prints the log headers.

–s Lists only the log headers. No “forward” or “old pages”log records are listed.

–k dir Specifies the directory to prepend to each log file name.

–m maxdlen Specifies the maximum amount of data to dump. Thisoption should be used with the–D option. If themaxdlen option is not specified, the default amount is64 bytes.

log_name… Specifies the name of the log file to be processed. Youcan specify multiple log files.

logls

1–78 Version 3.7.1

AuthorizationYou must have read permission for the log files you want to list.

ExamplesThe following example creates a readable version of a specifiedtransaction log file:logls -k /var/spool/Tivoli/myhost.db odb.log

Output similar to the following is displayed:Database update records:old page 0 8248insert "0.0.0"insert <0.0.0\x00.attr._bootcount\x00>{0:0,0:0,1:0} replace <0.0.0\x00.attr._ids\x00>Database transaction state transitions:prepare transaction {0:0,0:0,1:0}complete transaction {0:0,0:0,1:0}abort transaction {202020:1,202020:1,1:75}Database event and undo callbacks registered:{2020201,202020:1,1:61} undo [1:0:286748945] 2000.1.3 \undo_callback{2020201,202020:1,1:61} Event-prepare 2000.1.3 prepare_callback{2020201,202020:1,1:61} Event-complete 2000.1.3 commit_callback{2020201,202020:1,1:61} Event-abort 2000.1.3 abort_callback

See Alsotmcmd, tmstat

objcall


Com

mands

objcallPerforms an object call from the shell.

Syntaxobjcall [–a] [–b] [–cgroup:role:…] [–e] [–F file_descriptor] [–k len][–n] [–p port] [–s] [–T trans_type] oid method [arg…]

DescriptionTheobjcall command requests the specified object to run the specifiedmethod with zero or more options. The method’s standard output andstandard error are sent to theobjcall command’s standard output andstandard error. This command exits with the method’s exit code. Thiscommand is only used for non-IDL (Interface Definition Language)methods.

Options–a Performs the object call asynchronously.

–b Passes theobjcall command’s standard input to themethod’s standard input. If this option is not specified,the method gets an empty standard input.

–cgroup:role:…Performs the object call with the specified group andspecified roles. The caller can only specify roles that thecaller has. If this option is not specified, the methodruns with all the caller’s roles.

–e Passes theobjcall command’s environment as themethod’s environment. If this option is not specified,the method is given a default miniature environment.

–F file_descriptorSpecifies the file descriptor number to which to writestatus information.

–k len Reads the number of bytes specified by thelen optionfrom standard input for the key value. If the–k optionis not specified, no key is used.

objcall

1–80 Version 3.7.1

–n Starts the method and exits theobjcall commandasynchronously without waiting for the method toreturn results.

–p port Specifies the local object dispatcher port number.

–s Creates Inter-Object Messaging (IOM) keys forsending input and output to and from a method. Thisoption should be specified only if the method beingcalled expects these keys as input.

–T trans_type Specifies a transaction type. This option can be one ofthe following:

none No transaction

revoke Revocable transaction

sub Subtransaction

top Top-level transaction

oid Specifies the object ID of the object that is to run themethod.

method Specifies the method to be run.

arg… Specifies one or more arguments for the method. If thisoption is not specified, the method does not get anyarguments.

Note: If both the–b and–k options are specified, the key (–k len) isread first.

AuthorizationNo role is required to run theobjcall command itself, but you must havethe roles required by the method that is specified as an option to theobjcall command.

objcall


Com

mands

Examples1. The following example invokes theget_oservmethod against the

base object0.0.0. The result is that the unique object identifier(OID) number of the oserv process on the Tivoli managementregion server is returned.

objcall 0.0.0 get_oserv

2248904349.1.2

2. All Tivoli management regions have a unique 10-digit number thatis the first part of every object's three-part OID. The particularTivoli management region queried in example 1 had a uniqueidentifying number of2248904349. Instead of typing those 10digits in any given command, you can substitute the variable$TMR (after you have sourced your Tivoli environment).

In the following example, the middle part of the OID, in this case,the1, designates which managed node contains the objectreferenced by the third part of the OID (the2). The first managednode created is the Tivoli management region server, whichalways receives a middle number of1. The third part of the OIDdesignates some type of object belonging to the managed node. Inthis case, the2 is the numerical designation for the oserv processitself.

The following example invokes theboot_method method, withthe argumentlist, against the object referred to as$TMR.1.2. Thisobjcall asks the oserv object to list all the methods that are startedautomatically when the Tivoli management region server(dispatcher 1) is booted.

objcall $TMR.1.2 boot_method list

This results in output similar to the following:

Scheduler

EndpointManager

HTTPd

ActiveDesktopList

objcall

1–82 Version 3.7.1

3. The following command (objcall) invokes thequery methodagainst the oserv process (the2 part of the OID) on the Tivolimanagement region server (the1 part of the OID), in the regionwhich has the unique identifying number of2248904349. Theargument supplied to thequery method isinstall_dir , whichresults in the database call returning the path name to theinstallation directory. In this case, the Tivoli management regionserver is running a UNIX operating system.

objcall 2248904349.1.2 query install_dir/usr/local/Tivoli/bin

To invoke this command using the$TMR variable to substitute forthis region’s unique 10-digit number, and to run the query againstthe fifth managed node created (the5 in the OID), enter thefollowing command. In this case, the managed node queried is amachine running a Windows NT operating system.

objcall $TMR.5.2 query install_dirC:\tivoli\bin

See Alsoidlcall

odadmin


Com

mands

odadminManages object dispatchers.

Syntaxodadmin [option [suboption]]

DescriptionTheodadmin command provides a command line interface to manyoserv run-time configuration settings and management operations. Thelist of supported functions includes options for the following:

■ Allowing or disallowing client installations

■ Synchronizing object databases

■ Getting or setting object dispatcher environments

■ Listing information about object dispatchers

■ Reexecuting object dispatchers

■ Performing remote region operations

■ Setting encryption levels and passwords

■ Setting network security

■ Setting downed-host checking options

■ Starting and shutting down object dispatchers

■ Enabling or disabling Kerberos authentication

■ Adding or changing platform and application license keys

It is recommended that you back up all object databases before you usetheodadmincommand to change the low-level configuration of a Tivolimanagement region. There may be better methods (using the Tivolidesktop or Tivoli commands other than theodadmin command) toperform some of the operations that theodadmin command allows youto perform. If you are not explicitly familiar with the implications of theodadmin command, call your Customer Support provider beforeattempting to perform anyodadmin operations.

odadmin

1–84 Version 3.7.1

Optionsallow_client_install TRUE | FALSE

Sets an installation flag to permit or disallow addingadditional object dispatchers to the local region. Youmust have thesuper or senior role to run this option.

allow_dynamic_ipaddr TRUE | FALSEEnables or disables dynamic Internet Protocol (IP)address assignment support (Dynamic HostConfiguration Protocol [DHCP]) within the local Tivolimanagement region. The default value isFALSE.

db_sync [od… | clients | all]Flushes the object database state to disk. You can flushthe specified object databases (od), all client objectdatabases (clients), or all object databases (all) to disk.You must have thesuper or senior role to run thisoption.

environ Gets or sets the method environment for specific objectdispatchers. The method environment is theenvironment variables that are set inside the process ofthe method when the method executes. Defaultenvironment variables are set in addition to theuser-specified variables displayed when using thisoption. You must have thesuper or senior role to runthis option.

The following suboptions are available with theenviron option:

get [od… | clients | all]Gets the method environment for oneor more specific object dispatchers(od…), all client object dispatchers(clients), or all object dispatchers (all).

set [od… | clients | all]Sets the method environment for oneor more specific object dispatchers(od…), all client object dispatchers(clients), or all object dispatchers (all).

odadmin


Com

mands

The method environment is read fromstandard input.

get_allow_NATDisplays the value of theset_allow_NAT option,which enables or disables network address translation(NAT) support.

get_platform_licenseGets the current platform license key. You must havethesuper or senior role to run this option.

get_port_rangeGets the port range setting for Inter-Object Messaging(IOM) channel communication ports and Tivolicommunication between managed nodes. To set theport range, use theset_port_range option.

get_rpc_max_threadsRetrieves the maximum number of concurrent remoteprocedure call threads handled by the dispatcher. Youcan reset this number with theset_rpc_max_threadsoption.

help [suboption]When invoked with no option, gives top-level helpabout the available options for theodadmin command.If an option is specified, gives help for the specifiedoption. If no help is available for the specified option,the top-level help menu is displayed. You can run thisoption with any role.

odinfo [od… | clients | all]Provides information about specific object dispatchers(od…), all client object dispatchers (clients), or allobject dispatchers (all) in an installation.odinfo is thedefault option if you invoke theodadmin commandwithout specifying any options. If you do not specifyany object dispatcher numbers or theclients or alloption, theodinfo option returns information about thelocal object dispatcher. You must have thesuper,senior, admin, oruser role to run this option.

odadmin

1–86 Version 3.7.1

Theodinfo option provides the following objectdispatcher information:

Copyright informationIndicates the IBM copyright information.

RegionIndicates the Tivoli management region number,which is a unique number encoded within thelicense key.

DispatcherIndicates the server or dispatcher number within theTivoli management region. Dispatcher number 1indicates a Tivoli management region server. TheTivoli dispatcher number is based on the client’sinstallation order.

Interpreter TypeIndicates the machine interpreter type.

Database directoryIndicates the path for the local Tivoli objectdatabase.

Install directoryIndicates the path for the object dispatcher’sinstallation directory and the location of thebinaries.

Inter-dispatcher encryption levelIndicates the encryption type used when clientspass messages between themselves.

Kerberos in useIndicates whether Kerberos authentication is beingused within the Tivoli management region.

Remote client login allowedEnables you to make a remote desktop connectionusing Tivoli Desktop for Windows.

Force socket bind to a single addressIndicates whether to force socket bind to a singleaddress. For example, if this statement is FALSE

odadmin


Com

mands

and you have multiple network interface cards(NICs), the oserv opens port 94 and binds to all IPaddresses, one for each NIC. (TCP/IP lets the oservlisten on port 94 on all IP addresses.) If thisstatement isTRUE, it indicates that the oserv bindsto only port 94 on one IP address.

Perform local hostname lookup for IOMconnections

Indicates that Inter-Orb Messaging (IOM) will usethe IP address passed to make a connection back tothe initiator of the IOM request. It will not use thehost name passed to look up the IP address.

Use Single Port BDTIndicates whether single-port Bulk Data Transfer(BDT) is enabled (TRUE) or disabled (FALSE)for this node.

oserv version stringIndicates the object dispatcher’s versioninformation.

Port rangeIdentifies the range of ports that the Tivolienvironment is allowed to use.

Single Port BDT service port numberIndicates the port that the BDT service uses on thisnode.

Network SecurityIndicates the network security level of a managednode.none specifies that Secure Sockets Layer(SSL) is not used by the managed node, exceptwhen it is SSL-capable and is communicating withaFORCE_SSLmanaged node.SSLspecifies thatthe managed node uses SSL when communicatingwith other SSL managed nodes.FORCE_SSLspecifies that the managed node onlycommunicates using SSL.

odadmin

1–88 Version 3.7.1

SSL CiphersIndicates the cipher list (in order of preference)used with SSL network security. The keyworddefault indicates the default Tivoli cipher list of05040A030609.

ALLOW_NATIndicates whether network address translation(NAT) support is enabled (TRUE) or disabled(FALSE).

Note: On UNIX systems, theodadmin commandalso displays the library path in effect for Tivolioperations. On Windows NT systems, thedynamically linked libraries (DLLs) are storedin thebinary directory instead of a separatelibrary directory.

For a Tivoli management region server, the followinginformation is also provided:

State flags in useIndicates whether the oserv ping cache is consulted.For more information about communicatingbetween managed nodes, see theTivoliManagement Framework Maintenance andTroubleshooting Guide.

State checking in useIndicates whether the host state information is keptup-to-date with polling (TRUE) or collectedimplicitly (FALSE).

State checking everyx secondsIndicates the interval at which state checking isperformed.

Dynamic IP addressing allowedIndicates whether Dynamic Host ConfigurationProtocol (DHCP) support on managed nodes isenabled.

odadmin


Com

mands

Transaction manager will retry messagesx timesIndicates the number of inter-ORB retries forcommunicating with another oserv.

odlist [suboption]Lists or edits information about the dispatchers in aninstallation. You must have thesuperor senior role torun this option. Note that theodlist information iscached and theflags column output might notaccurately reflect the most recent connection orcommunication state of the managed node. To force anew polling of the state, invoke a command thatactually contacts the managed node in question (such asthewping command), and then reinvoke theodadminodlist command. If you specify theodlist optionwithout any suboptions, the following information isprovided in a columnar format about each currentlyattached object dispatcher:

Disp The object dispatcher number.

Flagsxyz There are three flags. If the first flag (x)is c, it indicates that the objectdispatcher is connected to the remotedispatcher listed in the display.

If the first flag is?, it indicates that thecached state is out-of-date, and thestate of the connection to the remotedispatcher is unknown. The state isupdated only in certain circumstances.(See theTivoli ManagementFramework Maintenance andTroubleshooting Guide for details.)

If the first flag is–, it indicates that theremote dispatcher is down.

The second flag (y) is alwayst. Thetflag indicates that the object dispatcheris trusted.

odadmin

1–90 Version 3.7.1

The third flag (z) is always–. The–flag indicates that the dispatcher is nota special dispatcher.

Hostname(s) The host name and aliases of the clienton which the object dispatcher islocated.

IPaddr The IP addresses of the client on whichthe object dispatcher is located.

Port The listening port for the objectdispatcher.

Region The number identifying the installationin which the object dispatcher islocated.

The following suboptions are available with theodlistoption:

list_od Lists members of the region.

add_ip_aliasod IP_address | host_nameAdds an IP address alias for an objectdispatcher. The request fails if the newIP address and object dispatcher portnumber match another objectdispatcher IP address and port number.This suboption must be invoked fromthe Tivoli management region server.

delete_ip_aliasod IP_addressDeletes an IP address alias for anobject dispatcher. This suboption mustbe invoked from the Tivolimanagement region server.

add_hostname_aliasod IP_address host_nameAdds a host name alias to an IP addressassociated with an object dispatcher.This suboption must be invoked fromthe Tivoli management region server.

odadmin


Com

mands

delete_hostname_aliasod IP_address host_nameDeletes a host name alias for an IPaddress associated with an objectdispatcher. This suboption must beinvoked from the Tivoli managementregion server.

change_ipod IP_address [TRUE | FALSE]Changes the primary IP addressassociated with an object dispatcher.The request fails if the new IP addressand object dispatcher port numbermatch another object dispatcher IPaddress and port number. Thissuboption must be invoked from theTivoli management region server.

rm_od od Removes an object dispatcher from theinstallation. The specified objectdispatcher must be shut down before itis removed. A list of object IDs forobjects that the dispatcher owned isdisplayed. The objects are removed,but references to the objects remain.This suboption must be invoked fromthe Tivoli management region server.

Therm_od option should only be runat the direction of Customer Supportwhen a client installation has failed andit is impossible to recover. The usualmethod of deleting a client is with thewrmnode command.

set_kerberos_instance 1kerberos_nameChanges the instance name of theKerberos service used by the Tivolimanagement region server. The objectdispatcher number is always 1.

objectsod Displays a list of the object IDs ofobjects owned by the object dispatcher.

odadmin

1–92 Version 3.7.1

reexec [od… | clients | all]Reexecutes the local object dispatcher. You canreexecute specified object dispatchers (od), all clientobject dispatchers (clients), or all object dispatchers(all). The Tivoli management region server’s objectdispatcher cannot be reexecuted from another system.You must have thesuper or senior role to run thisoption.

region [suboption]Provides remote region operations. You must have thesuper or senior role to run this option. The followingsuboptions are available forodadmin region. Thesesuboptions should only be run at the direction ofCustomer Support to resolve low-level problems thatcannot be handled from the Tivoli desktop or by theinterregion commands.

add_aliasregion IP_address [host_name…]Adds a host name or IP alias for aremote Tivoli management regionserver.

add_group_mapregion remote_group local_groupAdds an object group map betweenregions.

add_group_id_mapregion remote_name local_nameAdds mapping from user group namesin the remote region to group names inthe local region.

add_regionregion host port [crypt]Integrates an additional region. Thepassword is read from standard input.You are prompted for the password ifyou run this command from a terminaldevice (tty).

add_role_mapregion remote_group remote_rolelocalrole Adds a role map within a group map.

odadmin


Com

mands

add_user_id_mapregion remote_name local_nameAdds mapping from user login namesin the remote region to login names inthe local region.

change_regionregion host port [crypt]Changes configuration information fora remote region. The password is readfrom standard input. You are promptedfor the password if you run thiscommand from a terminal device (tty).An empty password indicates that thepassword should not be changed.

delete_aliasregion IP_address [name…]Deletes a host name or IP alias for aremote Tivoli management regionserver.

delete_group_mapregion remote_groupDeletes an object group map betweenregions.

delete_group_id_mapregion remote_nameDeletes user-group name mapping.

delete_regionregionDisconnects a remote region.

delete_role_mapregion remote_group remote_roleDeletes a role map within a group map.

delete_user_id_mapregion remote_nameDeletes login name mapping.

list_group_id_map regionDisplays mapping from user groupnames in the remote region to groupnames in the local region.

list_map regionLists object group and role mapsbetween regions.

odadmin

1–94 Version 3.7.1

list_region [region]Lists connected regions. If theregionoption is not specified, lists regionsthat are connected to the local region.

list_user_id_mapregionDisplays mapping from user loginnames in the remote region to loginnames in the local region.

set_region_crypt_levelcryptSets encryption level used by otherTivoli management region servers toconnect to this region. Thecryptoptioncan be one ofnone, simple, orDES.

set_region_pwSets encryption password for otherTivoli management region servers toconnect to this region. The oldpassword and the new password areread from standard input. You areprompted for the old and newpasswords if you run this commandfrom a terminal device (tty).

set_allow_rconnect {TRUE | FALSE}Enables Tivoli Desktop for Windows to connect to aTivoli management region server or client.

set_allow_NAT {TRUE | FALSE}Enables network address translation (NAT) support.You must restart the endpoint manager and gatewaysfor changes to take effect. The default value isFALSE.For more information about NAT support, see theTivoliManagement Framework Planning for DeploymentGuide.

set_bdt_port {port_value} [ od… | clients | all]Sets the port that the Bulk Data Transfer (BDT) serviceuses. The port value must be greater than 1023. You canset the port that the service uses for object dispatchers

odadmin


Com

mands

(od), all client object dispatchers (clients), or all objectdispatchers (all). You must have thesuper or seniorrole to run this option.

Note: You can use this option only if the odadminsingle_port_bdt option is set toTRUE. Ifsingle_port_bdt is set toFALSE (the default),this BDT port is not used and does not apply toany other node operations.

set_crypt_level {crypt}Sets encryption level for communication betweenobject dispatchers within the local region. Typically,you need to use the following procedure to set theencryption level:

1. Enter odadmin shutdown clients.

2. Enterodadmin set_crypt_levelcryptwherecryptspecifies the encryption level and can benone,simple, orDES.

3. Enterodadmin start clients.

You must have thesuper or senior role to run theset_crypt_level option.

set_force_bind TRUE | FALSE {od… | clients | all}Forces Tivoli communication connections to bind to asingle IP address. This option is used in certain highavailability or failover configurations where multipleobject dispatchers reside at different IP addresses on asingle physical system.

set_install_pw Sets the installation password for future clientinstallations. The old password and the new passwordare read from standard input. You are prompted for theold and new passwords if you run this command from aterminal device (tty). You must have thesuper orsenior role to run this option.

set_iom_by_name TRUE | FALSE {od… | clients | all}Enables or disables communications to rely on the hostname rather than the IP address of a Tivoli management

odadmin

1–96 Version 3.7.1

region server when interpreting an IOM key andmaking a connection. Use this option for multihomedservers that are known by different IP addresses ondifferent subnets.

set_keep_alive {on | off | poll | nopoll | time…}Sets options for checking for hosts that are down. Thedefault is off, that is, check every 180 seconds to see ifa host is still down. See the value referenced in theodadmin command output in the line that reads “Statechecking every 180 seconds”. You must have thesuperor senior role to run this option. The suboptions are asfollows:

on | off Specifies whether to trust cacheddowned-host information (on) or to trythe host each time (off).

poll | nopoll Specifies whether to poll dispatchers(poll) or collect information implicitly(nopoll). The polling algorithmminimizes network traffic.

time Specifies the minimum poll intervaltime in seconds. Most dispatchers arenot polled every interval.

The currentkeep_aliveoptions can be read by runningodadmin odinfo 1.

set_network_security {none | SSL | FORCE_SSL}[od… | clients | all]Sets the network security level of a managed node. Youcan set the network security level on specified objectdispatchers (od), all client object dispatchers (clients),or all object dispatchers (all). Options are as follows:

none Specifies that Secure Sockets Layer(SSL) is not used by the managednode, except when it is SSL-capableand is communicating with aFORCE_SSL managed node. This isthe default setting.

odadmin


Com

mands

SSL Specifies that the managed node usesSSL when communicating with otherSSL managed nodes. SSL is not usedwhen communicating to a node with asetting ofnone.

FORCE_SSL Specifies that the managed node onlycommunicates using SSL. Non-SSLconnections are not accepted by themanaged node.

Note: Restart the managed node for changes to takeeffect. For more information about SSL, see theTivoli Management Framework Planning forDeployment Guide.

set_ORB_pwodSets the password for communication between a Tivolimanagement region server’s object dispatcher and thespecified client’s object dispatcher. The password isread from standard input. You are prompted for thepassword if you run this command from a terminaldevice (tty). You must have thesuper or senior role;you must also have root privileges on the Tivoli serverand the specified object dispatcher.

Typically, when a client is added to the Tivolimanagement region server, the password used by theTivoli client to communicate with the Tivoli server isset by the Tivoli server. This password is never storedin a file or transmitted over the network in plain text.However, there is a slight possibility that an intrudercould get a copy of this password in its obscured formand decode it if your network is compromised duringthe installation process or if your database iscompromised at a later date.

To change a client’s Tivoli password, do the following:

1. Shut down the affected client.

2. Runodadmin set_ORB_pwod on the Tivolimanagement region server.

odadmin

1–98 Version 3.7.1

3. Copy the filehost_name-od-odb.adj from theTivoli database directory to a file namedodb.adjin the client database directory. Use a securecopying mechanism to copy this file. Set the filepermissions onodb.adj to user-read/write,group-none, and other-none, and set the fileownership to root.

4. Restart the client’s object dispatcher.

set_platform_licenselicense_keyAdds or changes a platform license key. You must havethesuper or senior role to run this option.

set_port_range [range]Restricts the IOM channel communication ports andTivoli Management Framework communicationbetween managed nodes to the specified port range.This option is especially helpful for firewalladministrators who need to regulate the availability ofports. Theoserv and gateway default ports are notaffected by this option. Port ranges must be greater than1023. To set the port range to null, use the followingsyntax:

odadmin set_port_range ""

set_rpc_max_threadsnum_threadsSets the concurrent remote procedure call thread limitfor the dispatcher or the number of concurrent objectcall threads. The default is 250.

set_ssl_cipherscipher… [od… | clients | all ]Sets ciphers for managed nodes to protect the channel.You can set ciphers on specified object dispatchers(od), all client object dispatchers (clients), or all objectdispatchers (all). cipher options are as follows:

default Specifies the default Tivoli list of05040A030609. A node can be set tothe default regardless of its SSLcapabilities.

odadmin


Com

mands

cipher Specifies the cipher list, in order ofpreference (for example, 0A09). Thenode must be SSL-capable before youcan change a user-defined cipher list.For cipher values and informationabout how to enable SSL on a managednode, see theTivoli ManagementFramework Planning for DeploymentGuide.

Note: Restart the managed node for changes to takeeffect.

set_tmgr_retriesAdjusts the transaction manager’s default timeoutvalue. The transaction manager retries messages onceper minute, so that the number of retries is equal to thenumber of minutes that it should wait before aborting atransaction.

Note: This value is adjusted on a per Tivolimanagement region basis; every dispatcher inthe region gets the same value. The new valuetakes effect the next time a dispatcher isrestarted.

shutdown [od… | clients | all]Shuts down the local object dispatcher. You can shutdown specified object dispatchers (od), all client objectdispatchers (clients), or all object dispatchers (all). Youmust have thesuper or senior role to run this option.You cannot shut down the Tivoli management regionserver from a remote system. This option is notavailable to NetWare clients. NetWare clients must bestopped with theoservend command.

single_port_bdt {TRUE | FALSE} { od… | clients | all}Enables or disables single-port Bulk Data Transfer(BDT)—the underlying support for Inter-ObjectMessaging (IOM) and other large-scale data transfers.If TRUE is specified, the port usage is consolidated tothe selected port. The default isFALSE. You can

odadmin

1–100 Version 3.7.1

enable or disable the service for object dispatchers (od),all client object dispatchers (clients), or all objectdispatchers (all). You must have thesuper or seniorrole to run this option.

Notes:

• After you enable BDT service, use theodadmin reexec command to reexecute thedispatchers.

• If you enablesingle_port_bdt, you can changethe default port (9401) to another port by usingtheodadmin set_bdt_port command.

start [od… | clients | all]Starts the local object dispatcher. You can startspecified object dispatchers (od), all client objectdispatchers (clients), or all object dispatchers (all). Youmust have thesuper or senior role to run this option.This option is not available to NetWare clients.NetWare clients must be started with theoservruncommand.

trace {objcalls | services | errors | off [od… | clients | all]}Starts or stops debug tracing. You can specify thatobject calls, services, or errors be traced, or you can turnoff debug tracing. If you want to trace object calls,services, and errors, you must turn first on the tracing oferrors by using theodadmin trace errors command.Note that turning error tracing on also turns off thetracing of object calls and services. Therefore, ensurethat you turn object call and services traces on after theerror trace invocation.

You can start or stop tracing for specified objectdispatchers (od), all client object dispatchers (clients),or all object dispatchers (all). If you do not specifyspecific clients or theclients or all option, debugtracing is started or stopped on the local objectdispatcher. The trace information is collected in theodtrace.logfile in the database directory. You can use

odadmin


Com

mands

thewtrace command to view this trace information.You must have thesuperorseniorrole to runodadmintrace.

Tivoli recommends that you do not enable error tracingby default. Tracing all object calls and services impactsthe performance of your dispatcher. Use tracing of allobject calls and services only when diagnosing specificproblems.

use_kerberos {TRUE | FALSE [od… | clients | all]}Enables or disables Kerberos authentication. You canenable or disable Kerberos authentication for specifiedobject dispatchers (od), all client object dispatchers(clients), or all object dispatchers (all). If you do notspecify specific clients or theclients or all option,Kerberos authentication is enabled or disabled for thelocal object dispatcher. You must have thesuper orsenior role to run this option.

Examples1. The following example gets the status of the Tivoli management

region server:

odadmin odinfo 1

Output similar to the following is displayed:

Tivoli Management Framework (mb) #1 Fri Feb 16 17:19:20 2001(c) Copyright IBM Corp. 1990, 2001. All Rights Reserved.

Region = 1000142803Dispatcher = 1Interpreter type = w32-ix86Database directory = C:\Tivoli\mbarber2.dbInstall directory = C:\Tivoli\binInter-dispatcher encryption level = simpleKerberos in use = FALSERemote client login allowed = TRUEForce socket bind to a single address = FALSEPerform local hostname lookup for IOM connections = FALSEUse Single Port BDT = TRUEPort range = (not restricted)Single Port BDT service port number = default (9401)Network Security = SSL

odadmin

1–102 Version 3.7.1

SSL Ciphers = defaultALLOW_NAT = FALSEState flags in use = TRUEState checking in use = TRUEState checking every 180 secondsDynamic IP addressing allowed = FALSETransaction manager will retry messages 4 times.

2. The following example gets help on theshutdown option:

odadmin help shutdown


shutdown [od… |clients|all]Stop object dispatcher(s)

3. The following example flushes the database files for alldispatchers:

odadmin db_sync all

4. The following example specifies that all managed nodes use portrange 60000 through 60100.

odadmin set_port_range 60000-60100

5. The following example lists information about the dispatchers(managed nodes) in a Tivoli environment:

odadmin odlist


Region Disp Flags Port IPaddr Hostname(s)

1248901349 1 ct- 94 10.69.9.42 la.tivoli.com,la 2 ct- 94 10.69.9.73 ten.tivoli.com

See Alsoodbls, odstat, oserv, wconnect, wdisconn, wlsconn, wrmnode,wtrace, wupdate

odbls


Com

mands

odblsLists the contents of an object database.

Syntaxodbls [–aIilmOs] [–k directory] [–M meth_name] [oid]

DescriptionTheodbls command lists the contents of an object database.

Options–a Displays the attributes in the object database.

–I Displays the object database inheritance list.

–i Displays the inheritance trees in the object database. Touse this option, you must use the Tivoli managementregion server’s database.

–k directory Specifies the directory that contains the object databaseto be listed. If this option is not specified, the databasein the current directory is listed.

–l Displays a verbose listing of the requested information.

–m Displays the method headers and dumps all entries. Touse this option, you must use the Tivoli managementregion server’s database.

–M Searches through method headers and dumps entries formeth_name. To use this option, you must use the Tivolimanagement region server’s database.

–O Walks through the object database. This is the default.

–s Forces the appropriate object dispatcher to update thedatabase that is to be listed. This synchronizationensures that theodbls command reports the same datathat the object dispatcher is using. If this option is notspecified, no synchronization is performed beforelisting the object database contents.

odbls

1–104 Version 3.7.1

oid Restricts the listing to the specified object.

AuthorizationYou must have read permission on the database to use theodblscommand. In addition, you must have thesuperrole to use the–soption.

ExamplesThe following example lists all objects in the object database. Theoutput is also shown.odbls –k /var/spool/tivoli/myhost.db

<bootstrap>200003.0.0200003.1.0200003.1.1200003.1.10200003.1.100200003.1.101200003.1.102200003.1.103200003.1.104

…

See Alsoodadmin

odstat


Com

mands

odstatLists the status of current and recent object calls.

Syntaxodstat [?] [–acdhlsv] [–obaseoid] [–p port_no]

(UNIX only) odstat [?] [–acdhlsv] –k dbdir [pid]

DescriptionTheodstatcommand lists the status of current and recent object calls forthe specified object dispatcher. This command can list object calls froma running dispatcher.

The first form of theodstat command collects the object dispatcherhistory by invoking a method. You can specify a remote objectdispatcher if desired.

The second form of theodstat command collects information bysending a signal to the object dispatcher. The–k option specifies thedatabase directory; the object dispatcher dumps its information to atemporary file in this directory. Thepid option specifies the objectdispatcher to send a signal to. The second form of theodstatcommandis useful when communication is disrupted for some reason, but is morespecific than the first form. The second form can only send signals tolocal processes, and because the object dispatcher is owned byAdministrator or root, you can only run this form if you are logged in asAdministrator or root.

Theodstat command returns its output in the following columns:

tid Lists the thread ID. When you start an object call, twothreads are generated: one for the object call itself andone for the method being invoked.

type Lists the thread type. The thread type flags are asfollows:

O Specifies the object call thread (attached to anobject request). This indicates that the method wasinvoked here but is running elsewhere.

odstat

1–106 Version 3.7.1

M Lists the method thread (attached to a method). Theobject call occurred on a different system, but theobject is located on the local system.

O+ Indicates that the object call and method threads arethe same. This indicates that the caller and methodare both local.

The method type flags are as follows:

a Asynchronous object call

b One-way object call

d Daemon method

h Helperless method

o Per-object method

q Queueing method

ptid Lists the parent thread ID or the thread ID of the objectcall whose method made the current object call. If thisfield is blank, the object call is external. The numberbefore the dash (-) is the dispatcher number where theparent thread resides. The number after the dash is thethread ID in the parent’s object dispatcher.

State Lists the following states of the object call thread:

ali The thread is performing a lookup onthe Tivoli management region server’sdatabase.

coord The method is serving as a transactioncoordinator.

done The object call is complete.

err An internal error terminated the thread.

init The thread has been initialized.

mwait The thread is waiting for the associatedmethod thread to complete.

odstat


Com

mands

rwait The thread is waiting for the caller tocollect the results of an asynchronousobject call.

The states of method threads are as follows:

done The method is complete.

gmeth The thread is obtaining the methodcode from another dispatcher.

hdwt The thread is waiting for thedaemon-method process (nonqueueingdaemon) to be ready to accept anotherrequest.

init The thread has been initialized.

run The method is running.

serv The thread is performing an objectservices call.

twait The method is waiting on transactionstatus to commit or abort.

StdO Lists the number of bytes written to standard output bythe method.

StdE Lists the number of bytes written to standard error bythe method. Most threads do not write to standard error.

Start Lists the time that the thread started. Entries include dayand time or just time if the method started on the sameday that you issued theodstat command. If the threadstarted more than one week ago, you cannot determinethat from this output (refer to thewtrace output).

Err Lists the thread’s error status. If this field is blank, noerror occurred.

Error types are as follows:

e=n The method returnedn as its exit code.Error codes 0 through 21 are reservedfor system-defined errors. Applicationerror codes start at 22.

odstat

1–108 Version 3.7.1

s=n The method failed due to signaln.

S=n The method failed due to signaln andproduced a core file. Contact yourTivoli customer support provider ifyou want to debug using this core file.

XXX An uppercase word indicates an errorin the object dispatcher.

Exit codes (e=) can come from the system on which theTivoli desktop is running, Tivoli ManagementFramework, or an application. It might be necessary tolook at different sets of error documentation to find outwhich is the most likely source. You might be able touse system documentation to obtain help regardingsystem-produced errors. Most UNIX systems includean error file that lists the system error codes and often ashort description. On OS/2 systems, enterhelpn, wheren is the number of the error message (for example,help 5 ). On Windows NT and Windows 2000systems, enter thenet helpmsgn command (forexample,net helpmsg 5 ).

Method Lists the text of the method invocation. The first valueis the object ID of the object in whose context themethod was invoked. This can take the form of threenumbers separated by periods or three numbersseparated by periods followed immediately by a poundsign (#), the class name, and another pound sign. Thenext entry is the name of the method followed by themethod’s options.

The following is an example of a method listed in theodstat output:

1242184237.1.516#TMF_SysAdmin::InstanceManager#_get_interfaces

For more information aboutodstatcommand output and other problemdetermination commands, see theTivoli Management FrameworkMaintenance and Troubleshooting Guide.

odstat


Com

mands

Options? Displays help on theodstat command.

–a Lists all threads. By default, system threads are omitted.

–c Lists currently running threads.

–d Lists the active method-daemon processes.

–h Lists thread history (terminated threads) only.

–k dbdir Returns information from the dispatcher that is usingthe database in the specified directory. You shouldspecify the object dispatcher’s process ID (pid) if youspecify the–k dbdir option. If you do not, theodstatcommand randomly picks the object for thedispatcher’s process ID.

Note: This option is for UNIX only.

–l Returns a long listing.

–obaseoid Returns object dispatcher status from another system.

–p port_no Sets the port number.

–s Returns a short listing.

–v Specifies verbose mode. Lists the last object-servicesrequest that the method or thread made, that request’sreturn code, the process ID associated with the method,and the last method invoked in a daemon thread.

pid Specifies the process ID of the dispatcher. If youspecify this option, you must also specify the–k option.

If no options are specified, theodstat command’s default isodstat –c–h –l –o 0.0.0.

AuthorizationYou must have thesuper, senior, admin, oruser role to run thiscommand. You must be Administrator or root to run the–k option.

odstat

1–110 Version 3.7.1

Examples1. The following example shows the output ofodstat with no

options. Explanations of the output are included throughout theexample.

odstat

The output shows the methods currently running:

n_activ e = 5 n_free = 195tid type ptid State StdO StdE Start Err Method83 O+bhdoq run 0 0 Sat16:00 \

200003.1.163#TMF_Scheduler::scheduler# start

In the previous section of theodstat output method thread, ID 83is a “one way” invocation that invoked a helperless, queueing,daemon, per-object method implementation. It is currently in a runstate, and started at 16:00 on Saturday. The object ID is200003.1.163#TMF_Scheduler::scheduler#(the local schedulerobject), and the method name isstart.

(… output deleted for brevity …)---- history ----

855 O+ 1-854 done 11 0 Sun16:16 0.0.0\get_name_registry\

856 O+hdoq 1-854 done 106 0 Sun16:16 200003.1.26 \lookup

857 O+hd 1-854 done 6 0 Sun16:16200003.1.128#TMF_UI::ActiveDesktopList# add_entry

The history line indicates the beginning of methods that havealready completed. Methods 855, 856, and 857 are cascadedmethods; they were invoked by method 854 on this oserv. (Thisexample uses dispatcher 1.) Method 855 produced 11 bytes ofstandard output, 856 produced 106 bytes, and 857 produced 6bytes.

(… more output deleted ...)\* 918 O+hdoq 1-917 done 488 0 Sun16:27 e=12 200003.1.26 \lookup

Method 918 produced an error. The asterisk in the first columnindicates a possible abnormal condition. The e=12 indicates anexception occurred. Thewtrace command can be used todetermine more information about the exception.

odstat


Com

mands

950 O 1-949 done 0 0 Sun16:28 <batch-mgr>\add_backref_optimized

951 O+hdq 1-949 done 117 0 Sun16:28 \200003.1.378#TMF_Install::ProductInfo# add_backref_optimi\

zed

Method thread 950 is a batch-object-call manager. It indicates thatthere were multiple invocations of the same method on multipleobjects at the same time. Line 951 is one of the batched methodinvocations managed by 950.

* 1029 O+ 1-1026 done 0 0 Sun17:06 UNAUTHORIZED\200003.0.0 \get_principal_roles Root_PI-sluggo

Method 1029 shows a method that ran and failed at the coreservices level, below the exception facility. In this case,odstattranslates the error code to an error name, where possible. Becausean exception did not occur,wtrace is not likely to produceadditional information about the error code.

2. The following example queries the method history on a remotemachine. First, use the name registrywlookup command totranslate the machine name to an object reference, and then callodstat with that object reference.

wlookup -r ManagedNode -a

pokey 200003.2.7#TMF_ManagedNode::Managed_Node#sluggo 200003.1.285#TMF_ManagedNode::Managed_Node#

odstat -o 200003.2.7#TMF_ManagedNode::Managed_Node#

See Alsoodadmin, tmstat, wtrace

oinstall

1–112 Version 3.7.1

oinstallInstalls, updates, or removes the Tivoli object dispatcher service, ordaemon, in a Windows NT or Windows 2000 Service Manager.

Syntaxoinstall –install path

oinstall –query

oinstall –remove

oinstall –update {[ +auto | –auto] [+depend | –dependservice][+interactive | –interactive] [path]}

DescriptionTheoinstall command is used to install the Tivoli object dispatcher, oroserv, in the Service Manager. This command also is used to update theoserv service or to remove it from the Windows NT or Windows 2000Service Manager. When you install Tivoli Management Framework ona Windows NT or Windows 2000 system,oinstall runs automaticallyduring the installation process.

Options–install Installs the oserv service in the Windows NT or

Windows 2000 Service Manager. The service isinstalled in noninteractive mode and manual restartmode.

–query Enables you to see the dependencies associated with thecurrent oserv service. This option also returns status ofthe oserv installation.

–remove Removes an oserv service from the Windows NT orWindows 2000 Service Manager.

–update Updates the oserv with one or more of the followingoptions:

+auto | –autoEnables or disables automatic restart when you

oinstall


Com

mands

restart your system. By default, automatic restart isdisabled.

+depend| –depend serviceDelays the start of the oserv on a Windows NT orWindows 2000 system until the specified service isstarted. Services includeTCPIP, TRIP , and so on.If the specified service is down and you attempt tostart the oserv, the system tries to start the servicebefore starting the oserv. If you try to stop thespecified service, you are prompted with a dialogstating that the oserv is dependent on this service. Ifyou proceed to stop the service, the oserv also isstopped. You can also remove an oserv servicedependency by using this option. If the service isrunning when you issue the update, the service isstopped and must be restarted for the change to takeaffect. The dependent service then returns a promptabout stopping the oserv service.

+interactive | –interactiveEnables or disables the interactive mode betweenthe oserv service and the Tivoli desktop. Unlessyou are doing Tivoli ADE (ApplicationDevelopment Environment) development, do notenable the interactive mode.

pathSpecifies the path to theoserv.exe file on a localNew Technology File System (NTFS). It isassumed that thelibuthreads.dll file is located inthe same library.

Note: If the service is running when you issue theoinstall –updatecommand, you must stop the service and restart it for changes totake effect.

AuthorizationLog on as service privilege

oinstall

1–114 Version 3.7.1

Examples1. The following example installs the oserv service in the Service

Manager. Theoserv.exe file and thelibuthreads.dll file arelocated inc:\Tivoli .

oinstall –install c:\Tivoli\oserv.exe

2. The following example updates the oserv service in the ServiceManager. The location of theoserv.exe file andlibuthreads.dllfile is changed toc:\Tivoli\bin and the automatic restart mode isenabled.

oinstall –update +auto c:\Tivoli\bin\oserv.exe

3. The following example delays the start of the oserv on aWindows NT or Windows 2000 system until TCP/IP is started:

oinstall -update +depend TCPIP

4. The following example removes the oserv service dependency:

oinstall -update -depend

5. The following example enables you to see what dependencies areassociated with the current service:

oinstall –query

oserv


Com

mands

oservProvides operations to control and configure object dispatchers.

Syntaxoserv –kdbdir [–a TRUE | FALSE] [–b install_dir] [–B libpath][–ccrypt] [–C crypt] [–d] [–E {default | cipher…}][–K kerb_serv_inst] [–l log_file] [–m swapsize] [–n { none | SSL |FORCE_SSL}] [ –N ali [–r region]] [–N {by_addr | by_name}][–p local_port] [–R irkey] [–S] [–sinstall_key] [–t max_trace_size] [–v][–z TRUE | FALSE]

oserv –kdbdir [–b install_dir] [–B libpath] [–d][–E {default | cipher…}][–h TMEhost] [–l log_file] [–m swapsize] [–n {none | SSL |FORCE_SSL}] [ –p local_port] [–S][–t max_trace_size] [–v][–z TRUE | FALSE]

oserv –binstall_dir –k dbdir [–f TRUE | FALSE] –i –r region[–a TRUE | FALSE] [–B libpath] [–ccrypt] [–C crypt] [–d][–E {default | cipher…}] [ –K kerb_serv_inst] [–l log_file][–m swapsize][–n {none | SSL | FORCE_SSL}] [ –N {by_addr | by_name | ali}][–p local_port] [–R irkey] [–S] [–sinstall_key] [–t max_trace_size] [–v][–z TRUE | FALSE]

oserv –kdbdir [–f TRUE | FALSE] –i –h TMEhost–b install_dir[–B libpath] [–d] [–E { default | cipher…}] [ –l log_file] [–m swapsize][–n { none | SSL| FORCE_SSL}] [ –p local_port] [–S][–sinstall_key][–t max_trace_size] [–v] [–z TRUE | FALSE]

Windows NT or Windows 2000 Systems Only

net start oserv /–option…

Theoserv command can only be invoked from the Service Manager.From the command line, theoserv command must be preceded bynetstart.

All options must be preceded by a slash and a dash (/–) instead of thesingle dash (–) used in UNIX. Any letter options that require a valuecannot have a space between the letter and the value (for example,netstart oserv /–Nbyaddr).

oserv

1–116 Version 3.7.1

The–k option is not required. If not specified, the location of thedatabase directory is taken from the registry.

DescriptionTheoserv command starts the Tivoli object dispatcher. The Tivoliobject dispatcher has multiple functions. It maintains the Tivoli objectdatabase on each system that has Tivoli installed, it routes object calls tothe proper systems and objects, and it arranges for the execution ofmethods that are invoked in the context of objects that reside on the localsystem.

The first form of theoserv command is used to restart the objectdispatcher on a Tivoli management region server.

The second form of theoserv command is used to restart the objectdispatcher on a Tivoli client.

The third form of theoserv command is used to initialize the objectdispatcher on a Tivoli management region server.

The fourth form of theoserv command is used to initialize the objectdispatcher on a Tivoli client.

The third and fourth forms of theoserv command are used only whenyou are using the installation programs.

The object dispatcher saves its configuration options in its database sothat the object dispatcher resumes with its previous settings when it isrestarted. When restarting an object dispatcher, you typically specify the–k option plus the options for any settings you want to change. You canchange the object dispatcher settings without shutting down the objectdispatcher by using theodadmin command.

Options–a TRUE | FALSE

Sets the flag that controls client installations. Clientinstallations can be allowed (TRUE) or prohibited(FALSE). This option is only valid for the Tivolimanagement region server.

–b install_dir Specifies the path name of the method binariesinstallation directory. This option is required if the–i

oserv


Com

mands

option is specified. Note that$BINDIR/.. and%BINDIR%\.. are literal path name values, and thetwo dots after the slash are part of the name. The dotsare not an ellipses (…) indicating a continuation of apath name. This is the same directory referred to by$BINDIR/.. (UNIX) and%BINDIR%\..(Windows NT and Windows 2000).

–B libpath Specifies the shared library search path. If the–i optionis specified and this option is not specified, the librarysearch path is read from the invoker’s environment.This is the same directory referred to by$LIBDIR(UNIX) or %LIBDIR% (Windows NT andWindows 2000).

–ccrypt Specifies the intraregion encryption level. Thecryptoption can bedes, simple, ornone.

–C crypt Specifies the interregion encryption level. Thecryptoption can bedes, simple, ornone.

–d Does not detach the object dispatcher from thecontrolling terminal. This option is used for running anobject dispatcher in a debugger. Standard output is notmapped to/dev/null.

–E {default | cipher…}Sets one or more ciphers for managed nodes, in order ofpreference (for example, 0A09). This option setsciphers of a managed node’s initial connection to theserver. After the node connects, it defaults back to thevalue stored on the server. You also can specify that amanaged node has thedefault setting, which means thatthe managed node has the default Tivoli cipher list of05040A030609. For a list of cipher values, see theTivoli Management Framework User’s Guide.

–f TRUE | FALSEForces an object dispatcher to bind to a single socket forall Tivoli client connections. Use this option whenmultiple dispatchers are running on a machine that hasmultiple Internet Protocol (IP) addresses. This forces

oserv

1–118 Version 3.7.1

each dispatcher to use the same IP address each time itcommunicates with clients.

–h TMEhost Specifies the name of the new Tivoli installation’sTivoli management region server. This option is usedwhen starting the object dispatcher on a Tivoli client.

–i Initializes the object dispatcher. This option is used thefirst time the object dispatcher is started on a system. Itis not recommended that you use the–i option withoutassistance from Customer Support.

–I Indicates to the object dispatcher that the objectdispatcher is being started byinetd. This option is onlyspecified ininetd configuration files; it should not bespecified on the command line.

–k dbdir Specifies the path name of the object databasedirectory. This is the same directory referred to by$DBDIR (UNIX) or %DBDIR% (Windows NT orWindows 2000).

–K kerb_serv_instSets the Kerberos service instance name. This optioncan only be specified for the Tivoli management regionserver.

–l log_file Specifies the file to be used for logging messages. If thisoption is not specified, messages are logged to theoservlog file.

–m swapsize Specifies the size of the swap space allocated bymmap.

–n {none | SSL | FORCE_SSL}Sets the network security level of a managed node'sinitial connection to the Tivoli management regionserver. After the node connects, it defaults back to thevalue stored on the server. Options are as follows:

none Specifies that SSL is not used by themanaged node, except when it isSSL-capable and is communicating

oserv


Com

mands

with aFORCE_SSL managed node.This is the default setting.

SSL Specifies that the managed node usesSSL when communicating with otherSSL managed nodes. SSL is not usedwhen communicating to a node with asetting ofnone.

FORCE_SSL Specifies that the managed node onlycommunicates using SSL. Non-SSLconnections are not accepted by themanaged node.

–N { by_addr | by_name | ali}Refetches IP addresses forodlist entries usinggethostbyaddr (by_addr), gethostbyname(by_name), or by replacing the Tivoli managementregion server’sodlist entry with the name and addressof this system (ali). Do not move your Tivolimanagement region server to a new system by using theali option without first getting instructions for thisprocedure from Customer Support.

–p local_port Specifies the port number to use for communicationwith other processes. The port number must be less than1024. This option overrides the port specification in the/etc/services file. If this option is not specified, thedefault is the port specification in the/etc/servicesfile.

–Pali_port Specifies the port number to use for communicationwith the Tivoli management region server. The portnumber must be less than 1024. This option is requiredonly if the–i option is specified and the Tivoli serverport is different than the local object dispatcher’s port.This option is valid only for Tivoli clients.

Note: This option is meant for use in developmentand test environments only. It should not beused in a production environment.

–r region Sets the region number. This option can be used onlywith the–i option or the–N ali option.

oserv

1–120 Version 3.7.1

–R irkey Specifies the interregion encryption key. If theirkeyoption is not specified, the interregion encryption key isread from standard input. You cannot specify the–Roption if the–s option is specified.

–s install_key Specifies the installation key. If theinstall_keyoption isnot specified, the installation key is read from standardinput. You cannot specify the–soption if the–R optionis specified.

–S Suppresses the output of oserv errors tosyslogd.

–t max_trace_sizeSets the maximum size of theodtrace.log file createdfor use by thewtrace command.

–v Causes the oserv to usevfork() to spawn subprocessesinstead offork() on UNIX platforms. Specifying thisflag has no effect on Windows NT or Windows 2000systems.

–z TRUE | FALSEEnables (TRUE) or disables (FALSE) Kerberosauthentication.

Authorizationroot

Examples1. The following example starts the oserv, using all current defaults:

oserv –k /var/spool/Tivoli/myhost.db

2. The following example changes the path to the binary and librarydirectories. This is helpful if the mount point to these directories ischanged.

oserv –b /mnt/local/Tivoli/bin –B \/mnt/local/Tivoli/lib:/usr/lib \

–k /var/spool/Tivoli/myhost.db

oserv


Com

mands

See Alsoodadmin, odstat, idlcall , objcall, oinstall, wsettap, wtrace

tivoli

1–122 Version 3.7.1

tivoliStarts the Tivoli desktop and previews a new dialog.

Syntaxtivoli [–debug] [–displaydisplay] [–help] [–hosthost_name][–port port_number] [–preview file.d var_name var_value…][–useruser_name] [X_options]

DescriptionThetivoli command performs one of two different kinds of functions,depending on the options used. First, it can start the Tivoli desktop for aTivoli administrator. Second, it can preview a dialog created withdsl.

The–displayoption specifies the X window display on which to displaythe desktop or preview the dialog. If this option is omitted, thetivolicommand defaults to the value defined in theDISPLAY environmentvariable. See theTivoli Enterprise Installation Guide for moreinformation about X window resources.

The values of theX_options option are strings to be interpreted as Xresource settings, for example,–background blue sets the defaultbackground color of all dialog backgrounds to blue.

If the –preview switch is omitted, thetivoli command starts theadministrator’s desktop.

The–display andX_options options are not used for Windows NT orWindows 2000 systems.

For Tivoli Application Development Environment (ADE) developers, ifthe–preview option is specified, it instructs the User Interface (UI)server to preview the dialog contained infile.d. If the dialog containsdialog variables, the name and value of each dialog variable must followthe dialog file name. For example, if the dialog has two dialog variablesnamedvar1 andvar2, the command must be invoked in the followingway:tivoli –preview file.d var1 value-of-var-1 var2 value-of-var-2

If the value contains blanks, it needs to be enclosed in double quotationmarks and single quotation marks, for example:tivoli –preview file.d var1 "'value of var 1'"

tivoli


Com

mands

Options–debug Displays an additional dialog that contains debugging

information for ADE developers.

–displaydisplaySpecifies to display the desktop on the screen of thehost specified indisplay.

–help Prints a usage message.

–hosthost_nameSpecifies the managed node, including the Tivolimanagement region server where the Tivoli desktopshould connect.

–port port_numberSpecifies the port number used by the object dispatcher.

–preview file.d var_name var_valueInstructs the UI server to preview the file specified byfile.d. This option can be used by ADE developers topreview new dialogs before they are built into aproduct. Suboptions are as follows:

file.d Specifies the name of a.d file for ADEdevelopers.

var_name Specifies a Dialog SpecificationLanguage (DSL) variable name.

var_value Specifies the value associated withvar_value.

–useruser_nameSpecifies the login name to the managed node.

X_options Specifies the X resources to set for this session.

Authorizationuser, admin, senior, super

tmcmd

1–124 Version 3.7.1

tmcmdForces a change of state of a running transaction.

Syntaxtmcmd [–p port] state trans_id…

DescriptionThetmcmd command forces a transition of a transaction state. Thiscommand sends a message to the local transaction manager to forcetransactions into the state specified by thecommand option. Thecommandoption can specify one ofabort, commit, prepare, complete,prepared, orcompleted.

Thetmcmd command is primarily useful when testing and debuggingthe transaction manager, which is linked inside the oserv service, ordaemon. Customer Support may ask you to run this command to recoverfrom a severe or unusual problem as a last resort. It is stronglyrecommended that this command only be run with the direction andassistance of Customer Support, as this command can crash your oservdaemon or corrupt your database if used inappropriately.

Options–p port Specifies the local port number.

state Specifies the state to force the transactions to. Thisoption can be one ofabort, commit, prepare,complete, prepared, orcompleted.

trans_id Specifies the ID of the transaction for which a statechange is to be forced. You can specify more than onetransaction ID.

Authorizationsenior, super

tmcmd


Com

mands

DiagnosticsIf the command sent to the transaction manager violates the two-phasecommit protocol, the oserv daemon may abort or your database could becorrupted.

See Alsoodstat, tmstat

tmstat

1–126 Version 3.7.1

tmstatDisplays the status of current transactions and locks.

Syntaxtmstat [–k dbdir] [–p port] [–r region] [–va] [baseobjid…]

DescriptionThis command displays the currently running transactions and locks andtheir current state. This command is primarily a debugging tool for userswho are developing transaction-based applications; it allows such usersto observe their transaction hierarchy.

Each transaction ID that is displayed implicitly contains the transactionhierarchy; you can interpret {transA}{transB} to be a child of {transA}.

Options–k dbdir Specifies the database directory.

–p port Specifies the local port number.

–r region Queries a different region. Theregionoption specifiesthe base object ID on the remote Tivoli managementregion server.

–v Specifies verbose mode. Lists of subtransactions aredumped.

–a Displays all object IDs in the base list of the local regionor the region specified by–r region.

baseobjid… Specifies the object dispatcher to query. Multiplebaseobjid options can be specified.


tmstat


Com

mands

Examples1. The following example shows the output oftmstat with no

options. An explanation of the output follows the example.

tmstatTransactions for 0.0.0

Trid Type State Resources Polling Coord Parent MTid----------------------------------------------------------{202020:1,202020:1,2:3}

Top-T running Yes No running running 40{202020:1,202020:1,2:3},{202020:1,202020:1,2:4}

Sub-T commit Yes Yes running running 44{202020:1,202020:1,2:3},{202020:1,202020:1,2:5}



Sub-T commit Yes Yes running running 47----------------------------------------------------------Cannot truncate log file:

Undo information pendingRedo information pendingTransaction event callback information pending

The output oftmstat consists of four sections: a table listing thecurrent transactions, a section listing coordinators, a section statingwhy thetransactionlogfile cannot be deleted, and a section listingthe remote transactions with local resources.

The previous example shows only two of the four possiblesections. The table lists the transaction IDs of all local transactions,the transaction type, the transaction state, whether the transactionholds resources, whether the transaction is polling its parent orcoordinator, and the state the transaction believes its parent orcoordinator to be in. The MTid entry can be used to match atransaction ID with a method thread ID inodstat.

The second section, listing coordinators, was empty and wasskipped.

The third section indicates any current reasons why the transactionlog file cannot be deleted. If this section is empty, theodadmindb_sync command can be used to truncate the log fileimmediately.

tmstat

1–128 Version 3.7.1

The fourth section, listing remote transactions with local resources,was empty and was skipped.

2. The following example invokes thetmstat command on a remotemanaged node. For example, from the Tivoli management regionserver, you could display the status of transactions and locks on“dispatcher 2” by following these steps:

a. To determine the OID of the managed node in which you areinterested, enter the following command:

wlookup -ar ManagedNode


bushido 1248901349.1.348#TMF_ManagedNode::Managed_Node#tengu 1248901349.2.7 #TMF_ManagedNode::Managed_Node#

b. To invoke thetmstat command using the explicit OID of themanaged node, enter the following command (where1248901349.2.7 is the object ID):

tmstat 1248901349.2.7

Or you can use the$TMR variable to substitute for the uniqueTivoli management region identifier number as shown:

tmstat $TMR.2.7

See Alsoodstat, tmcmd

w4inslcf.pl


Com

mands

w4inslcf.plInstalls an endpoint on an AS/400 system.

Syntaxw4inslcf.pl [–a] [–F] [–ggw_label[+port]] [–I] [–l ep_port][–L config_options] [–N code] [–P] [–sdir_name] [–v] [–Y]{ endpoint… | –f file_name}

DescriptionThew4inslcf command installs and optionally starts an AS/400endpoint daemon job on one or more AS/400 systems. You can installmultiple endpoints by listing the system name on the command line orsupplying a file containing the system names. The file must contain onesystem name per line.

The command checks for prerequisites, sends code to the endpoint to beinstalled, using FTP, and then restores the product,1TMELCF , to theAS/400, usingRSTLICPGM . If requested, the endpoint is also startedby issuing the AS/400 command STRTMEEPT .

Options–a Specifies asynchronous installation of endpoints. By

default, the command waits for the endpoint to log in toits gateway before installing the next endpoint.

–f file_name Specifies the file containing a list of systems on whichto install endpoints. This file contains one system nameper line, specifying the user ID and password to beused. Each line in this file must be in the followingformat:

host [ userID [ password ]]

–F Forces an overwrite of an existing installation.

–ggw_label[+port]Specifies the IP address or host name and optionally theport number of the gateway to which the endpoint logsin.

w4inslcf.pl

1–130 Version 3.7.1

–I Indicates that the endpoint should be installed but notstarted.

–l ep_port Specifies the port number for the endpoint. The defaultport number is 9495.

–L config_optionsPasses configuration options to the daemon for startingthe endpoint. To pass multiple options, enclose them inquotation marks. Refer to thelcfd command for a list ofvalid options.

–N code Specifies additional languages to support by AS/400code. The following are the codes: 2980 (Brazilian,Portuguese), 2989 (Chinese, simplified), 2924 (Englishuppercase and lowercase), 2938 (English uppercase),2928 (French), 2929 (German), 2932 (Italian), 2962(Japanese), 2986 (Korean), and 2931 (Spanish). Tospecify multiple languages, enclose them in quotationmarks. The defaults are 2924 and 2938.

–P Specifies to prompt the user for a password. This optionoverrides existing entries in a$HOME/.netrc file usedfor automatic logins.

–sdir_name Specifies the directory that contains the endpointinstallation image. This directory can be on a compactdisc, the Tivoli management region server, a gateway,or a network drive.

–v Writes verbose messages to standard output. Errormessages are still written to standard error.

–Y Specifies that the installation should proceed withoutconfirmation. The default is to request confirmation.

endpoint… Specifies the names or IP addresses of AS/400 systemson which the endpoints are installed.

AuthorizationYou must have root access to install endpoints, but you do not need anyTivoli authorization roles. On the AS/400 system, you need authority to

w4inslcf.pl


Com

mands

use theRSTOBJandRSTLICPGM commands and *SAVSYSspecialauthority.

Return Valuesw4inslcf.pl returns one of the following:

0 Indicates successful completion.

-1 Indicates failure due to an error.

Note: Host names for failed installations are written toos4LcfH.errand can be retried with the command using the–f os4LcfH.errkeyword specified on the command.

Examples1. The following example installs the AS/400 endpoint on the

AS/400 systemsas41.tivoli.comandas42.tivoli.com, connects togatewaysmithers.tivoli.com using port 9494. The installationimage is located in the/cdrom/1tmelcf directory.

w4inslcf.pl -v -g smithers.tivoli.com+9494 as41.tivoli.com as42.tivoli.com -s /cdrom/1tmelcf

2. The following example installs the AS/400 endpoint on theAS/400 system as42.tivoli.com, connects to gatewaysmithers.tivoli.com using port 9494, and installs French andGerman language support.

w4inslcf.pl -v -g smithers.tivoli.com+9494 -N '2928 2929' as42.tivoli.com

waddicon

1–132 Version 3.7.1

waddiconAdds an icon to a Windows Program Manager group. (Windows 95,Windows NT, or Windows 2000 only)

Syntaxwaddicon –ggroup_name [–a] [–c "command_line"] [–i icon_file][–m "message"] [–r] [–t icon_title]

DescriptionThewaddicon command adds a new icon to a Windows ProgramManager group. If the group does not exist, it is created. Ifwaddicon islaunched as a batch from the Windows NT or Windows 2000 serviceagent, the created program group is a common program group. Ifwaddiconis launched from the Windows NT or Windows 2000 consoleagent, the created program group is a user program group.

Options–a Enables you to use this command asynchronously, such

as in a batch file that is distributed to a computer wherea user is not logged in. The command is actuallyexecuted when a user logs in to the computer. You mustuse the command in a batch file if you specify thisoption. This option is supported on Windows NT andWindows 2000 systems only.

–c "command_line"Specifies the command line invoked by the icon.

–ggroup_nameSpecifies the program group name to which the icon isadded.

–i icon_file Specifies the file containing the icon. If this option isnot specified, the Program Manager looks in theexecutable file specified by the–c option.

–m "message" Specifies a message to be written to theWADDICON.ERR file if an error occurs when using

waddicon


Com

mands

this command with the–aoption. This option issupported on Windows NT and Windows 2000 systemsonly.

–r Removes the specified icon. If no icon is specified,attempts to remove the entire program group.

–t icon_title Specifies the title (description) below the icon in theProgram Manager.

Return Valueswaddicon returns one of the following:

0 Indicates the successful addition of the icon.

nonzero Indicates thatwaddiconwas unsuccessful at adding theicon.

ExamplesThe following command example adds an icon namedWord Processorfor the word processor application to a Program Manager group calledApplications:waddicon –g "Applications" –c \WP\WPROCESS.EXE \–t "Word Processor"

To remove theWord Processor icon from theApplications group,enter the following command:waddicon –g "Applications" –c \WP\WPROCESS.EXE \–t "Word Processor" –r

To remove theApplications group, enter the following command:waddicon –g "Applications" –r

To add an icon to a user’s desktop (on a Windows NT or Windows 2000workstation), include the following command in a batch file anddistribute the file to the user’s computer. If an error occurs, the messagefollowing the–m option is written to theWADDICON.ERR file.C:\TIVOLI\TMEAGENT\WIN32\CLI\WADDICON \–c "C:\FILES\MY_PROG.EXE" –t "My Program" \–m "Call #1 of waddicon" –a

waddpath

1–134 Version 3.7.1

waddpathAdds an entry to the path statement in the registry hive of the currentcontrol set. This command should be run from an endpoint.(Windows NT and Windows 2000 only)

Syntaxwaddpath path_value

DescriptionThewaddpath command adds an entry to the Windows\SYSTEM\CurrentControlSet\Control\SessionManager\Environment key path in theHKEY_LOCAL_MACHINE registryhive. After you add the entry, other applications have a search path to theapplication.

This command returns a message indicating if it successfully completedor encountered an error.

Optionspath_value Specifies the path entry to add to the registry hive in the

current control set.

Authorizationadmin

ExamplesTo add the\APPS\MISC\EXEC directory path to the registry hive,enter the following command:waddpath \APPS\MISC\EXEC

waddrealm


Com

mands

waddrealmRegisters an HTTP 1.0 authentication realm with the HTTP daemon.

Syntaxwaddrealm –dRealmDir–p AuthProg–n RealmName

DescriptionThewaddrealm command adds an authentication realm to the HTTPdaemon’s list of authentication realms. Thewaddrealm command istypically used only by an application during installation.

Options–d RealmDir Specifies the realm directory. Specify this directory

relative to the Hypertext Transfer Protocol (HTTP)base directory or the Common Gateway Interface (CGI)base directory.

–p AuthProg Specifies the authentication program name.

–n RealmNameSpecifies the realm name. Any name is permissible forRealmName.


ExamplesThe following example launches the authentication programMyProgwhen the/cgi-bin/MyDir realm is accessed:waddrealm –d /cgi–bin/MyDir –p \/cgi-bin/MyDir/MyProg –n MyRealmName

See Alsowdelrealm, wlsrealms, wstarthttpd , wstophttpd

wadminep

1–136 Version 3.7.1

wadminepPerforms administrative operations on an endpoint.

Syntaxwadminep [–h] ep_nameupgrade [upgrade_path]

wadminepep_namewake_up

DescriptionThewadminep command is run from a managed node but administersall supported endpoint platforms. Usewadminep to upgrade theendpoint daemon or generate the endpoint wake-up packet forwake-on-LAN operations. To enable wake-on-LAN support, issue thelcfd –w command. By default, the wake-on-LAN technology is notenabled on endpoints.

Options–h Displays a detailed usage statement listing all the

commands available onwadminep.

upgrade [upgrade_path]Upgrades the endpoint software on the specified client.If a directory is not specified, the upgrade package isretrieved from$BINDIR/…/lcf_bundle on thegateway to which the endpoint is assigned.

wake_up Sends the wake-up packet that will be broadcast to thespecified endpoint’s network.

ep_name Specifies the name of the endpoint on which thecommand runs.

AuthorizationThesuperrole is required with the privilege of root or Administrator onthe endpoint. The role can be resource-specific only if the resource is apolicy region and the endpoint belongs to that policy region.

wadminep


Com

mands

ExamplesThe following example upgrades an existing endpoint to the newestrelease of the endpoint software. The upgrade package is located in/data/lcf_bundle.wadminep pine upgrade /data/lcf_bundle

See Alsolcfd, winstlcf

wauthadmin

1–138 Version 3.7.1

wauthadminAdds, removes, or displays the root authority of Tivoli administrators ina Tivoli management region.

Syntaxwauthadmin {–aadministrator | –r administrator | –l [–v]}

DescriptionThewauthadmin command serves two purposes in the management ofTivoli Administrator accounts:

■ Displays the names of all root administrators in a Tivolimanagement region.

■ Allows a root administrator to either grant root authorization toanother administrator or revoke it.

When you install a Tivoli management region, the process creates aninitial Tivoli account called theroot administrator. This accountpossesses full, unrestricted privileges for accessing and managingsystems. On UNIX platforms, the Tivoli root administrator account hasUNIX root permissions; on Windows, the account has Administratorpermissions. Thewauthadmin command enables a root administratorto promote existing Tivoli administrators to root administrators. ATivoli management region can have multiple root administrators.

Thewauthadmin command also removes root authority from rootadministrator accounts. You must, however, retain at least one rootadministrator for each Tivoli management region.

With the–l option, thewauthadmin command displays a list of Tivoliadministrators who possess root authority in the local Tivolimanagement region.

Options–aadministrator

Adds root authorization to the specified administrator.

–l Displays a list of administrators who have rootauthority in the Tivoli management region.

wauthadmin


Com

mands

–r administratorRemoves root authorization from the specifiedadministrator.

–v Used only with the–l option, provides more verboseinformation in the list.

Authorizationroot administrator to grant or revoke root authority,userto display thelist of root administrators.

Examples1. The following example grants root authority tokimiko@ohio in

the local Tivoli management region:

wauthadmin –a kimiko@ohio

2. The following example displays a verbose, detailed list of rootadministrators in the local Tivoli management region:

wauthadmin –lv

See Alsowgetadmin, wsetadmin

wbkupdb

1–140 Version 3.7.1

wbkupdbBacks up and restores Tivoli databases.

Syntaxwbkupdb –e [node_name…]

wbkupdb –e –l [object node_name…]

wbkupdb [–d device] [–f] [–h node_name] [node_name…]

wbkupdb –l [–d device] [–f] [–h node_name] [object node_name…]

wbkupdb –d device –r [–R] [node_name…]

wbkupdb –d device–r –l [–R] [object node_name…]

wbkupdb –s

DescriptionThewbkupdb command backs up and restores Tivoli databases. Youcan provide a list of managed node names as options to thewbkupdbcommand. If you do not specify any node options, thewbkupdbcommand backs up or restores every managed node in the Tivolimanagement region.

Note: If you are unable to capture a full backup because of the highactivity level of your Tivoli management region, you can use thewlocktmr command to place your region in maintenance modeand then run thewbkupdb command again. For moreinformation about placing a Tivoli management region inmaintenance mode, see theTivoli Management FrameworkMaintenance and Troubleshooting Guide.

When the–eoption is used, this command estimates the total size of thebackup archive. Thewbkupdb command estimates the size of thebackup of each managed node and the total size of the archive. Thisreport is an estimate, but it is very close to the actual size of the backupimage.

The third and fourth forms of this command (as shown in the syntax)back up the database and store it in the specified file or device on thespecified system. If the backup file already exists and is a disk file, youmust specify the–f option to overwrite the old backup file.

wbkupdb


Com

mands

When the–r option is used, this command restores Tivoli databases.This is primarily useful for reverting to a previously saved copy of theTivoli database. The Tivoli management region server or managed nodethat is to be restored must have Tivoli Management Frameworkoperational. If a restore operation is being performed from a systemother than the Tivoli server, you cannot restore both the Tivoli serverand the local database unless you specify the–R option. If you restorethe local database, you must use the explicitnode_name syntax andspecify the local node at the end or specify the–R option.

If the object dispatcher that is to be restored is not running (andpresumably cannot be run because its database is corrupted or missing),you can extract the database manually and put the files in the correctlocation in the database directory.

Thewbkupdb command also saves any old versions of files and thenotification database. Typically, these are not restored, because youprobably do not want to read notices that have already been read. If forsome reason the file is destroyed, you can restore it manually. Thefiles_versionsdirectory is not restored. If you want to see old revisionsof system files, the files can be moved from thefiles_versions.restoredirectory as necessary.

The following list details the files and databases backed up in thetemporary directory on UNIX and Windows managed nodes and Tivolimanagement region servers:

■ For UNIX managed nodes, recovered files are as follows:

• odb.bdb.restore

• odb.adj.restore

• odb.log.restore

• file_versions.restore (directory)

■ For UNIX Tivoli management region servers, recovered files areas follows:

• odb.bdb.restore

• odb.log.restore

• imdb.bdb.restore

• notice.bdb.restore

wbkupdb

1–142 Version 3.7.1

• notice.log.restore

• odlist.dat.restore

• epmgr.bdb.restore (directory)

• file_versions.restore (directory)

■ For Windows managed nodes, recovered files are as follows:

• odb.bdb

• odb.adj

• odb.log

• file_versions (directory)

■ For Windows Tivoli management region servers, recovered filesare as follows:

• odb.bdb

• odb.log

• imdb.bdb

• notice.log

• odlist.dat

• epmgr.db (directory)

• file_versions (directory)

Options–d device Specifies the file or device to which the backup file

should be saved or from which the backup file shouldbe retrieved. If you specify a file name with this option,you can insert a file date and time anywhere in the filename by adding the variable%t . The variable isreplaced with a date/time stamp in the formMondd-hhmm. For example, if you specify–d/usr/backups/TMR1%t.bk , the resulting file is namedTMR1Dec21-0955.bk. The time is displayed in24-hour mode.

–e Estimates the size of the backup.

wbkupdb


Com

mands

–f Overwrites a previous backup file of the same name.

–h node_nameSpecifies the system that contains thetar file. Thedefault is the Tivoli management region server.

–l Specifies that options on the command line are objectand label pairs. This option is for Tivoli internal useonly.

–r Restores the databases for the specified nodes.

–R Does not restart object dispatchers after restoring thedatabase files. A number of files named*.restore areplaced in the database directory. To effect the changes,useodadmin reexec or one of its derivatives toreexecute the dispatchers so that they pick up therestored copies of the databases.

-s Suppresses display of an initial desktop message foreach managed node being backed up.

node_name Specifies the node to be backed up. You can specifymultiple nodes.

object Specifies a backup object identifier.

AuthorizationYou must have thebackup role in the Tivoli management region tocreate a backup and therestorerole in the Tivoli management region toperform a restore operation. The default backup directory requires rootwrite access. Either log in as the root administrator or change thelocation of the backup file. If you are performing a “rescue” operation,you must beadmin or root on the machine where the crashed databaseis located.

Examples1. The following example backs up the Tivoli databases for all

managed nodes in the Tivoli management region from which thewbkupdb command is run. The backups are written to theuser-defined file/usr/backups/TMR1.bk.

wbkupdb –d /usr/backups/TMR1.bk

wbkupdb

1–144 Version 3.7.1

2. The following example backs up the database of a single managednode,sherman. In this example, a destination directory and filename for the backup file are not specified. The backup is,therefore, written to the Tivoli database directory under asubdirectory namedbackups. The subdirectory is created if it didnot exist when thewbkupdb command is run.

wbkupdb sherman

3. The following example restores a single managed node,sherman.The backup file used to restore the managed node is/usr/backups/TMR1.bk.

wbkupdb –r –d /usr/backups/TMR1.bk sherman

See Alsowchkdb, wclient, winstall, wpatch, wserver

wbindmsg


Com

mands

wbindmsgRetrieves a translated string from a local message catalog and binds anyvariables.

Syntaxwbindmsgcatalog_name message_number default_string [options…]

DescriptionThewbindmsg command retrieves the message corresponding tomessage_numberfrom the message catalog specified bycatalog_name.

If the specified message cannot be retrieved from the specified messagecatalog in the current language environment, then thedefault_string isused.wbindmsg always looks for the specified message in set 2 of thespecified message catalog.

Thewbindmsgcommand uses theLANG andNLSPATH environmentvariables to find the message catalog appropriate for the currentlanguage environment. For example, if

LANG=fr_FR

and

NLSPATH=/tivoli/msg_cat/%L/%N.cat;\

/tivoli/msg_cat/%1%N.cat;\

/tivoli/msg_cat/C/%N.cat

wbindmsgattempts to find the message catalog by using the followingpath names:

/tivoli/msg_cat/fr_FR/catalog_name.cat

/tivoli/msg_cat/fr/catalog_name.cat

/tivoli/msg_cat/C/catalog_name.cat

After the message is retrieved and bound, the resulting string is writtento standard output.

Optionscatalog_name Specifies the message catalog base name.

wbindmsg

1–146 Version 3.7.1

message_numberSpecifies the message number in the message catalog.

default_string Specifies the string to be used if the message cannot beretrieved from the message catalog.

[options…] Specifies any options to be bound in place of the formatdirectives in the message.

ExamplesThe following example retrieves the second message from the messagecatalog namedmy_catalog.cat. The default string is the same as theEnglish version of the message, which contains two options,jross andpolyglot.wbindmsg my_catalog 2 \

"User %1\$s does not have an account on %2\$s" jross polyglot

This command produces the following output in English:User jross does not have an account on polyglot.

wbroadcast


Com

mands

wbroadcastBroadcasts a message to all Tivoli desktops.

Syntaxwbroadcast [optional_text]

DescriptionThewbroadcast command reads a message from standard input andbroadcasts it to all desktops in the Tivoli environment. If theoptional_text option is used, this text, rather than standard input, isbroadcast to all desktops in the Tivoli environment.

Optionsoptional_text Specifies the text to be broadcast.

Authorizationadmin, senior, super

ExamplesThe following example is of a typical message broadcast:wbroadcast << EOFRestoring Tivoli in 5 minutes. Please exit your desktops.EOF

wcatcher

1–148 Version 3.7.1

wcatcherSaves custom dialogs before upgrading Tivoli Management Frameworkor a Tivoli application.

Syntaxwcatcher {–a | –rresource…} [ –d parent_dir] [–ssub_dir] [–v]

DescriptionThewcatcher command saves custom dialogs in Tivoli ManagementFramework or a Tivoli application before you upgrade to a new versionof Tivoli Management Framework or the application. Examples ofcustom dialogs are those with added text fields or buttons.

For example, if you are preparing to upgrade to a new version of TivoliUser Administration, use this command to save your custom dialogs.After upgrading, use thewmrgaef command to reapply the customdialogs to the new version.

Thewcatcher command stores each custom dialog, and itscorresponding original dialog, in a directory structure that you specifywith the–d option. Thewcatcher command creates a directory namedcustom.sav(unless you specify a different name with the–soption), andthen searches each specified resource type to find custom dialogs. Foreach dialog, it saves the custom version and the original version in asubdirectory undercustom.savthat has the same name as the resource.If a dialog has been customized on a per-instance basis, the dialogs aresaved in a directory that has the name of the label instance.

Options–a Searches all registered resources for custom dialogs.

–d parent_dir Specifies the path to the directory where each customdialog and its corresponding original version is saved.If you do not supply a path,wcatcher writes theinformation about the customized dialog to the currentworking directory.

–r resource Searches a specific resource type. You can specify

wcatcher


Com

mands

multiple resource types on a command line, but youmust supply–r each time.

–ssub_dir Specifies the name of the directory. The defaultdirectory name iscustom.sav.

–v Specifies verbose output.

Authorizationsuper

ExamplesThe following command searches for all custom dialogs, writes thesaved files to/tmp/aef, and names the directorymy.dir .wcatcher –d /tmp/aef –s my.dir

See Alsowmrgaef

wcd

1–150 Version 3.7.1

wcdChanges the current working collection.

Syntaxwcd [label]

DescriptionThewcd command changes the current working collection object to thecollection object specified by the given label path. Each administrator oruser has a separate current working collection associated with eachparent process ID.

Optionslabel

Specifies the new working collection; the specified object must be acollection object or policy region. This option can be a full label path(starting at the / collection) or a partial label path (relative to thecurrent working collection). If this option is omitted, this commandchanges the working collection to the home collection. Eachadministrator’s home collection is/Administrators/ name, wherename is the administrator’s Tivoli principal name.


Examples1. The following example changes the current working collection to

policy regionceridwen-region:

wcd /Regions/ceridwen-region

2. The following example changes the current working collection tothe object database directory:

wcd $DBDIR

wcd


Com

mands

See Alsowls, wpwd

wchkdb

1–152 Version 3.7.1

wchkdbVerifies and repairs the Tivoli database.

Syntaxwchkdb [–ooutfile] [–u] [–x] { –f infile | –i | object…}

DescriptionThewchkdb command verifies and repairs problems in the Tivolidatabase. This command does not affect any system files; it onlymodifies resources within the Tivoli environment.

Without the–u option,wchkdb only verifies the database and reportsdiscrepancies to standard output or, optionally, to an output file if the–ooption is used. The output file can later be passed towchkdb with the–u and–f options to correct the discrepancies.

The–u option attempts to find and fix any database discrepancies. The–f infile option reads input from an output file generated in a previousrun ofwchkdb. All objects in theinfile are checked. The–i option readsa list of objects from standard input. You can also specify a list of objectson the command line. If no input options or object references areprovided, all objects in the database are checked.

The–x option enables verification across Tivoli management regionboundaries. Without this option, only resources within the current regionare verified and repaired.

In a high-activity Tivoli environment, it can be advantageous to place aTivoli management region in maintenance mode, thereby stopping allactive Tivoli processes. For more information about placing a Tivolimanagement region in maintenance mode, see theTivoli ManagementFramework Maintenance and Troubleshooting Guide.

Options–f infile Reads the specified input file, which was created during

a previous run ofwchkdb, and checks only thoseobjects listed in the file. Only objects that failed duringthe previous run are included in the file.

wchkdb


Com

mands

–i Reads a list of objects from standard input. The listconsists of object IDs, object names, or both (eachseparated by a space).

–ooutfile Writes a binary version of the displayed output to thespecified file name.

–u Updates the database, fixing any discrepancies found inthe Tivoli resource database.

–x Verifies and repairs object references across regionboundaries.

object… Specifies an object ID or object name to be verified andrepaired.

Authorizationsenior or super

Return Valueswchkdb returns one of the following:

0 Indicates thatwchkdb started successfully.

nonzero Indicates thatwchkdb did not start successfully, eitherbecause of a syntax error or because the oserv is notavailable.

Examples1. The following example verifies and, if needed, repairs the Tivoli

database. Object references are checked across region boundaries.

wchkdb –u –x

2. The following example verifies object references in the currentTivoli management region only. No changes are made to the Tivolidatabase. Problems are, however, displayed to standard output andwritten to a binary output file,/tmp/check.out.

wchkdb –o /tmp/check.out

wchkdb

1–154 Version 3.7.1

3. The following example reads the results from a previous run ofwchkdb (/tmp/check.out) and updates the Tivoli database asneeded:

wchkdb –u –f /tmp/check.out

wchknode


Com

mands

wchknodeVerifies and updates references to a specific dispatcher number fromparts of the Tivoli database.

Syntaxwchknode [–c] [ –n] [ –s] [ –u] [ –v] [ –x] [dispatcher_num]

DescriptionThewchknode command synchronizes the Tivoli management regionserver database with the database ofdispatcher_num. wchknodeverifies the Tivoli name registry (–n), Tivoli collections (–c), orsubscription lists (–s). If neither the–n, –c, nor–soptions are specified,wchknode checks all these objects. If the–u option is specified,wchknode updates all references todispatcher_num. Without thisoption,wchknode finds all references and prints discrepancies to thescreen. Ifdispatcher_numis not specified,wchknodeverifies the entireTivoli management region.

Thewchknode command is run from the Tivoli management regionserver. By default, the command runs only in the local Tivolimanagement region. Use the–x option to verify references in connectedregions.

When you do not have time to run a full wchkdb, runwchknode tocheck the references to a dispatcher number after a managed node ordispatcher’s database has been restored.

Note: Invoke thewchknode command only on managed nodes thatare in a connected and communicating state. If you invoke thiscommand on a managed node that is down, the managed nodeis deleted from the Tivoli database. Also, do not invoke thiscommand without specifying the target dispatcher number of amanaged node. If you issue this command without specifying atarget, any managed node with a downed oserv is deleted fromthe Tivoli database.

wchknode

1–156 Version 3.7.1

Options–c Verifies references todispatcher_num in Tivoli

collections.

–n Verifies references todispatcher_num in the Tivoliname registry.

–s Verifies references todispatcher_num in subscriptionlists.

–u Updates any discrepancies found during theverification. If this option is not specified,wchknodeprints all discrepancies to the screen.

–v Prints verbose messages to the screen.

–x Verifies references todispatcher_num across regionboundaries.

dispatcher_numIdentifies the dispatcher number of the managed nodethatwchknode is to verify. To determine the correctdispatcher number, use theodadmin odlist command.

Authorizationsenior or super in the Tivoli management region

Examples1. The following example verifies and updates all references to

managed nodeyellow (dispatcher 7) in the Tivoli name registry,Tivoli collections, and subscription lists.wchknode searches thelocal Tivoli management region and all connected regions.

wchknode –u –x 7

2. The following example verifies the Tivoli name registry forreferences to managed nodethor (dispatcher 5). References arenot removed and are printed to the screen.

wchknode –n 5

wchknode


Com

mands

See Alsowchkdb, wrmnode

wchkpol

1–158 Version 3.7.1

wchkpolVerifies policy region members against policy.

Syntaxwchkpol [–a] [–ccollection] [–f file] [–l label] [–r resource]… region

DescriptionThewchkpol command verifies that all or a subset of a policy region’smembers comply with the policy enabled for the region. For eachmember that does not pass the policy verification, a message is sent tostandard output. The–f option sends the output to a log file. With the–coption,wchkpol can also create a collection of those members that didnot pass the verification.

Options–a Verifies all members of the policy region.

–ccollection Creates a collection in which to put members that failedthe policy verification.

–f file Creates a log file containing a list of members thatfailed the policy check.

–l label Verifies the resource specified bylabel.

–r resource Verifies all policy region members that are of theresource type specified.

region Specifies the policy region whose members are to beverified.


wchkpol


Com

mands

Examples1. The following example verifies the policy for all members of the

policy regionceridwen-region:

wchkpol –a /Regions/ceridwen-region

2. The following example verifies the policy for all managed nodesin the policy regionceridwen-region and creates a collectionnamedfailures to contain any managed nodes that do not pass thepolicy verification:

wchkpol –c failures –r ManagedNode ceridwen–region

See Alsowcrtpol , wcrtpr , wdelpr, wgetdfpol, wgetpolm, wlspol, wlspolm,wputpolm

wci

1–160 Version 3.7.1

wciChecks in Revision Control System (RCS) revisions.

Syntaxwci [options] file…

Descriptionwci stores new revisions into RCS files. Each path name matching anRCS suffix is taken to be an RCS file. All others are assumed to beworking files containing new revisions.wci deposits the contents ofeach working file into the corresponding RCS file. If only a working fileis given,wci tries to find the corresponding RCS file in an RCSsubdirectory and then in the working file’s directory. For more details,see the section “File Naming” on page 1-167.

Forwci to work, the caller’s login must be on the access list, unless theaccess list is empty or the caller is the super user or the owner of the file.To append a new revision to an existing branch, the tip revision on thatbranch must be locked by the caller. Otherwise, only a new branch canbe created. This restriction is not enforced for the owner of the file ifnon-strict locking is used (seewrcs). A lock held by someone else canbe broken with thewrcs command.

Unless the–f option is given,wci checks whether the revision to bedeposited differs from the preceding one. If not, instead of creating anew revision,wci reverts to the preceding one. To revert, ordinarywciremoves the working file and any lock;wci –l keeps andwci –u removesany lock, and then they both generate a new working file much as ifwco–l orwco –uhad been applied to the preceding revision. When reverting,any–n and–s options apply to the preceding revision.

For each revision deposited,wci prompts for a log message. The logmessage should summarize the change and must be terminated byend-of-file or by a line containing a period (.) by itself. If several filesare checked in,wci asks whether to reuse the previous log message. Ifthe standard input is not a terminal,wci suppresses the prompt and usesthe same log message for all files. See also–m.

If the RCS file does not exist,wci creates it and deposits the contents ofthe working file as the initial revision (default number: 1.1). The access

wci


Com

mands

list is initialized to empty. Instead of the log message,wci requestsdescriptive text (see–t).

The numberrev of the deposited revision can be given by any of theoptions–f, –I, –k, –l, –M, –q, –r, or –u. revcan be symbolic, numeric,or mixed. Ifrev is $, wci determines the revision number from keywordvalues in the working file.

If rev is a revision number, it must be higher than the latest one on thebranch to whichrev belongs or must start a new branch.

If rev is a branch rather than a revision number, the new revision isappended to that branch. The level number is obtained by incrementingthe tip revision number of that branch. Ifrev indicates a nonexistingbranch, that branch is created with the initial revision numberedrev.1.

If rev is omitted,wci tries to derive the new revision number from thecaller’s last lock. If the caller has locked the tip revision of a branch, thenew revision is appended to that branch. The new revision number isobtained by incrementing the tip revision number. If the caller locked anon-tip revision, a new branch is started at that revision by incrementingthe highest branch number at that revision. The default initial branch andlevel numbers are1.

If rev is omitted and the caller has no lock but owns the file and lockingis not set tostrict , the revision is appended to the default branch(typically the trunk; see the–b option ofwrcs).

The following exception applies on the trunk, revisions can be appendedto the end, but not inserted.

An RCS file created bywci inherits the read and execute permissionsfrom the working file. If the RCS file exists,wci preserves its read andexecute permissions.wci always turns off all write permissions of RCSfiles.

Options–l [rev] Works like–r, except it performs an additionalwco –l

for the deposited revision. Thus, the deposited revisionis immediately checked out again and locked. This isuseful for saving a revision although you want tocontinue editing it after the check-in.

wci

1–162 Version 3.7.1

–r [rev] Checks in a revision, releases the corresponding lock,and removes the working file. This is the default.

The–r option has an unusual meaning inwci. In otherRCS commands,–r merely specifies a revision number,but inwci it also releases a lock and removes theworking file. See–u for an example.

–u [rev] Works like–l, except that the deposited revision is notlocked. This lets you read the working file immediatelyafter check-in.

The–l, –r, and–u options are mutually exclusive and silently overrideeach other. For example,wci –u –r is equivalent towci –r because–roverrides–u.

–d " [date]" Usesdate for the check-in date and time. Thedate isspecified in free format as explained inwco. This isuseful for specifying a check-in date other than theactual date, and for–k if no date is available. Ifdateisempty, the working file’s time of last modification isused.

–f [rev] Forces a deposit; the new revision is deposited even ifit is not different from the preceding one.

–k [rev] Searches the working file for keyword values todetermine its revision number, creation date, state, andauthor (seewco), and assigns these values to thedeposited revision, rather than computing them locally.It also generates a default login message noting thelogin of the caller and the actual check-in date. Thisoption is useful for software distribution. A revisionthat is sent to several sites should be checked in with the–k option at these sites to preserve the original number,date, author, and state. The extracted keyword valuesand the default log message may be overridden with theoptions–d, –m, –s, –w, and any option that carries arevision number.

–I [rev] Interactive mode; the user is prompted and questionedeven if the standard input is not a terminal.

wci


Com

mands

–m msg Uses the stringmsgas the log message for all revisionschecked in.

–M [rev] Sets the modification time on any new working file tobe the date of the retrieved revision. For example,wci–d –M –u f does not alterf’s modification time, even iff’s contents change due to keyword substitution. Usethis option with care; it can confusemake.

–n name Assigns the symbolic namename to the number of thechecked-in revision.wci prints an error message ifname is already assigned to another number.

–N name Same as–n, except that it overrides a previousassignment ofname.

–q [rev] Quiet mode; diagnostic output is not printed. A revisionthat is not different from the preceding one is notdeposited, unless–f is given.

–sstate Sets the state of the checked-in revision to the identifierstate. The default state isExp.

–t file Writes descriptive text from the contents offile into theRCS file, deleting the existing text. Thefile may notbegin with a dash (–).

–t string Writes descriptive text from thestringinto the RCS file,deleting the existing text.

The–t option, in both its forms, has effect only duringan initial check-in; it is silently ignored otherwise.

During the initial check-in, if–t is not given,wciobtains the text from standard input, terminated byend-of-file or by a line containing a period (.) by itself.The user is prompted for the text if interaction ispossible; see–I.

For backward compatibility with older versions ofRCS,–t withoutstring is ignored.

–V n Emulates RCS versionn. Seewco for details.

wci

1–164 Version 3.7.1

–w login Useslogin for the author field of the deposited revision.Useful for specifying an author other than the actualauthor, and for–k if no author is available.

–x suffixes Specifies the suffixes for RCS files. A nonempty suffixmatches any path name ending in the suffix. An emptysuffix matches any path name of the formRCS/file orpath/RCS/file. The–x option can specify a list ofsuffixes separated by a slash (/). For example,–x,v/aspecifies two suffixes:,v and the empty suffix. If two ormore suffixes are specified, they are tried in order whenlooking for an RCS file; the first one that works is usedfor that file. If no RCS file is found but an RCS file canbe created, the suffixes are tried in order to determinethe new RCS file’s name. The default forsuffixes isinstallation-dependent; typically it is,v/ for hosts suchas UNIX hosts that permit commas in file names and isempty (for example, just the empty suffix) for otherhosts.

Using SETUID on UNIX (UNIX Only)

To prevent anybody but their RCS administrator from deletingrevisions, a set of users can employ setuid privileges as follows:

■ Check that the host supports RCS setuid use. Consult a trustworthyexpert if there are any doubts. It is best if thesetuid() system callworks as described in Posix 1003.1a Draft 5, because RCS canswitch back and forth easily between real and effective users, evenif the real user isroot. If not, the second best use is if thesetuid()system call supports saved setuid (the {_POSIX_SAVED_IDS}behavior of Posix 1003.1-1990); this fails only if the real user isroot. If RCS detects any failure in setuid, it quits immediately.

■ Choose a userA to serve as RCS administrator for the set of users.Only A is able to invoke thewrcs command on the users’ RCSfiles. A should not beroot or any other user with special powers.Mutually suspicious sets of users should use differentadministrators.

■ Choose a path nameB that is a directory of files to be executed bythe users.

wci


Com

mands

■ HaveA set upB to contain copies ofwci andwco that are setuidto A by copying the commands from their standard installationdirectoryD as follows:

mkdir Bcp D/wc[io] Bchmod go–w,u+s B/wc[io]

■ Have each user prependB to their path as follows:

PATH=B:$PATH; export PATH # ordinary shellset path=(B $path ) # C shell

■ HaveA create each RCS directoryR with write access only toAas follows:

mkdir Rchmod go–w R

■ If you want to let only certain users read the RCS files, put theusers into a groupG, and haveA further protect the RCS directoryas follows:

chgrp G Rchmod g–w,o–rwx R

■ HaveA copy old RCS files (if any) intoR, to ensure thatA ownsthem.

■ An RCS file’s access list limits who can check in and lockrevisions. The default access list is empty, which grants check-inaccess to anyone who can read the RCS file. If you want to limitcheck-in access, haveA invokewrcs –aaon the file; seewrcs. Inparticular,wrcs –e –a A limits access to justA.

■ HaveA initialize any new RCS files withwrcs –i before initialcheck-in, adding the–aoption if you want to limit check-in access.

■ Give setuid privileges only towci andwco.

■ Do not use other setuid commands to invoke RCS commands.

DiagnosticsFor each revision,wci prints the RCS file, the working file, and thenumber of both the deposited and the preceding revision. The exit statusis zero if and only if all operations were successful.

wci

1–166 Version 3.7.1

FilesSeveral temporary files might be created in the directory containing theworking file and also in the temporary directory (seeTMPDIR in thesection “Environment Variables” on page 1-167). Semaphore files arecreated in the directory containing the RCS file. With a nonempty suffix,the semaphore names begin with the first character of the suffix;therefore, do not specify a suffix whose first character could be that of aworking file name. With an empty suffix, the semaphore names end withan underscore (_), so working file names should not end with_.

wci never changes an RCS or working file. Typically,wci unlinks thefile and creates a new one; but instead of breaking a chain of one or moresymbolic links to an RCS file, it unlinks the destination file instead.Therefore,wci breaks any hard or symbolic links to any working file itchanges; and hard links to RCS files are ineffective, but symbolic linksto RCS files are preserved.

The effective user must be able to search and write the directorycontaining the RCS file. Typically, the real user must be able to read theRCS and working files and to search and write the directory containingthe working file; however, some older hosts cannot easily switchbetween real and effective users, so on these hosts the effective user isused for all accesses. The effective user is the same as the real userunless your copies ofwci andwcohave setuid privileges. As describedin the next section, these privileges yield extra security if the effectiveuser owns all RCS files and directories and if only the effective user canwrite RCS directories.

Users can control access to RCS files by setting the permissions of thedirectory containing the files; only users with write access to thedirectory can use RCS commands to change its RCS files. For example,in hosts that allow a user to belong to several groups, one can make agroup’s RCS directories writable to that group only. This approachsuffices for informal projects, but it means that any group member canarbitrarily change the group’s RCS files and can even remove thementirely. Hence more formal projects sometimes distinguish between anRCS administrator, who can change the RCS files at will, and otherproject members, who can check in new revisions but cannot otherwisechange the RCS files.

wci


Com

mands

File NamingPairs of RCS files and working files can be specified in three ways (seealso the example section):

1. Both the RCS file and the working file are given. The RCS pathname is of the formpath1/workfileXand the working path name isof the formpath2/workfile wherepath1/ andpath2/ are (possiblydifferent or empty) paths,workfile is a file name, andX is an RCSsuffix. If X is empty,path1/ must beRCS/ or must end in/RCS/.

2. Only the RCS file is given. Then the working file is created in thecurrent directory and its name is derived from the name of the RCSfile by removingpath1/ and the suffixX.

3. Only the working file is given. Thenwci considers each RCSsuffix X in turn, looking for an RCS file of the formpath2/RCS/workfileXa or (if the former is not found andX isnonempty)path2/workfileX.

If the RCS file is specified without a path in methods 1 and 2,wci looksfor the RCS file first in the directory./RCS and then in the currentdirectory.

wci reports an error if an attempt to open an RCS file fails for an unusualreason, even if the RCS file’s path name is just one of severalpossibilities. For example, to suppress the use of RCS commands indirectoryd, create a regular file namedd/RCSso that casual attempts touse RCS commands ind fail becaused/RCS is not a directory.

Environment VariablesRCSINIT Options attached to the option list, separated by spaces.

A backslash escapes spaces within an option. TheRCSINIT options are prepended to the option lists ofmost RCS commands. UsefulRCSINIT optionsinclude–q, –V, and–x.

TMPDIR Name of the temporary directory. If not set, theenvironment variablesTMP andTEMP are inspectedinstead and the first value found is taken; if none ofthem are set, a host-dependent default is used, typically/tmp.

wci

1–168 Version 3.7.1

Examples1. Suppose,v is an RCS suffix and the current directory contains a

subdirectoryRCS with an RCS fileio.c,v. Then each of thefollowing commands checks a copy ofio.caintoRCS/io.c,vas thelatest revision, removingio.c:

wci io.c; wci RCS/io.c,v; wci io.c,v;wci io.c RCS/io.c,v; wci io.c io.c,v;wci RCS/io.c,v io.c; wci io.c,v io.c;

2. Suppose instead that the empty suffix is an RCS suffix and thecurrent directory contains a subdirectoryRCS with an RCS fileio.c. Each of the following commands checks in a new revision:

wci io.c; wci RCS/io.c;wci io.c RCS/io.c;wci RCS/io.c io.c;

AuthorAuthor: Walter F. Tichy.Revision Number: 5.9; Release Date: 1991/110/07.Copyright © 1982, 1988, 1989 by Walter F. Tichy.Copyright © 1990, 1991 by Paul Eggert.

See Alsowco, wident, wrcs, wrcsdiff , wrcsmerge, wrlog; Walter F. Tichy,RCS—A System for Version Control,Software—Practice &Experience 15, 7 (July 1985), 637-654.

wclient


Com

mands

wclientInstalls a managed node.

Syntaxwclient –csource_dir[–d] [–f file_name] [–I] [–p policy_region] [–P][–t | –T traa] [–U user_acct] [–y] [ install_variables][managed_node…]

DescriptionThewclient command installs a managed node when invoked on amanaged node or the Tivoli management region server.

Options–csource_dir Specifies the complete path to the installation image.

–d Setsinstall_variables to their last set values.Commonly, each installed managed node uses the sameset of installation variables. This option provides ashortcut for setting the variables.

–f file_name Specifies a text file containing a list of machines to beinstalled. The file contains one line per machine withthe formathost_name,user,password. user andpassword are optional. If not specified, the default isroot or Administrator . There can be no spacesbetween entries. The content of each line determines thedefault method.

■ For the default, each entry contains only themachine name.

■ For account access, each entry contains themachine name followed by a comma (,), the userID followed by a comma (,), and then thepassword.

Note: Passwords are not encrypted. Anyonewith access to this file can see thepasswords.

wclient

1–170 Version 3.7.1

■ For trusted host access, each entry contains themachine name followed by a comma (,).

The following is an example of a machine file:

elm,oak,chris,&rewsliveoak,

–I Causeswclient to prompt for the installation password.If you do not use this option, there is not a passwordprompt.

–p policy_regionSpecifies the name of the policy region in which themanaged nodes are installed.

–P Causeswclient to prompt for the root password for themachine. If you specify more than one machine,wclient assumes they all have the same root password.

–t Specifies that the account and password specified withthe–U option should be used as the Tivoli remoteaccess account.

–T traa Specifies the account name to be used for the Tivoliremote access account. When you use this option, youare prompted for the password.

–U user_acct Specifies an account and password other than root forinstalling each managed node. When you use thisoption, you are prompted for the password.

–y Specifies that the installation should proceed withoutconfirmation. By default,wclient identifies the actionsthat must be taken to perform the installation andrequests confirmation before continuing. Using thisoption,wclient identifies the actions and performs theinstallation without requesting confirmation.

install_variablesIndicateskeyword=value pairs that control theinstallation. These variables can be set or defaulted onthe command line. These variables specify requiredinformation or override default information.

wclient


Com

mands

Note: Type the names of the installation optionsexactly as specified in the productdocumentation. Installation options are casesensitive.

Several of the installation variables specify thedirectories where the managed node will be installed. Ifa directory contains files from a previous installation,wclient does not install these files again. However, youcan force any of these directories to be reinstalled byusing a! character as the value for the variable.

The following are the installation variables related tothe installation directories:

BIN=binariesOverrides the default installation path(/usr/local/Tivoli/bin ) for the binaries.

LIB= librariesOverrides the default installation path(/usr/local/Tivoli/lib ) for the libraries.

DB=client_databaseOverrides the default installation path(/var/spool/Tivoli) for the object database.

MAN= manpageOverrides the default installation path(/usr/local/Tivoli/man) for the manual pages.

APPD=X11_defaultsOverrides the default installation path(/usr/lib/X11/app-defaults) for the X11application defaults.

CAT=message_catalogOverrides the default installation path(/usr/local/Tivoli/msg_cat) for the messagecatalogs.

The following are other useful installation variables:

@AutoStart@=0 | 1Indicates whether the Tivoli daemon should be

wclient

1–172 Version 3.7.1

started (1) at system boot time. By default, thedaemon is not started (0).

@SetPort@=0 | 1Indicates whether to configure or not configure (0)the remote start capability of the Tivoli daemon.Enabling remote start requires changes to systemfiles; for example,/etc/inetd.confand/etc/serviceson UNIX systems. By default, this capability isconfigured (1).

@CreatePaths@=0 | 1Indicates whether to create the specified directoriesif they do not already exist. By default, directoriesare created (1). It is an error if a directory youspecified withinstall_variables does not exist.

@ClientAddNoTrans@=yes | noIndicates whether managed nodes should be addedusing a transaction. Adding managed nodes withouta transaction can save significant time wheninstalling over slow links. If an error occurs,however, you should runwchkdb to verify the stateof the database.

@ForceBind@=yes | noIndicates whether communication connections areforced to bind to a single Internet Protocol (IP)address. This option is used in certainhigh-availability or failover configurations wheremultiple object dispatchers reside at different IPaddresses on a single physical system.

managed_nodeSpecifies the machines where a managed node isinstalled. If using the–f option, do not include anymachine that is listed in the file specified by this option.

Authorizationinstall_client or super

wclient


Com

mands

Files

UNIX Files

/tmp/tivoli.cinstallThis file resides on the Tivoli management region server andcontains verbose debugging information from all managed node andproduct installation attempts.

/tmp/install2.cfg.error /tmp/install2.cfg.outputThis transient file is created on a managed node during theinitialization of its object database. After a successful initialization,these files are removed.

/tmp/client.cfg.error /tmp/client.cfg.outputThis transient file is created on a managed node during theconfiguration of its object database. After a successful initialization,these files are removed.

/etc/Tivoli/setup_env.shThis file contains useful Bourne shell environment variables. Thefile can be sourced in from Bourne shell compatible shells afterinstallation.

/etc/Tivoli/setup_env.cshThis file contains useful C shell environment variables. The file canbe sourced in from C shell compatible shells after installation.

Windows Files

%TMPDIR%\tivoli.cinstallThis file resides on the Tivoli management region server andcontains verbose debugging information from all managed node andproduct installation attempts.

%TMPDIR%\install2.cfg.error %TMPDIR%\install2.cfg.outputThese transient files are created on a managed node during theinitialization of its object database. After a successful initialization,these files are removed.

%TMPDIR%\client.cfg.error %TMPDIR%\client.cfg.outputThese transient files are created on a managed node during the

wclient

1–174 Version 3.7.1

configuration of its object database. After a successful initialization,these files are removed.

Examples1. The following example installs managed nodesdanandbarney in

policy regionbedrock in the default locations. The user isprompted for the installation password and the root password forthese managed nodes. The complete path to the installation imageis /cdrom. The example also overrides the default location for theobject database directory and installs this database in/var/spool/database instead.

wclient –dIP –c /cdrom –p bedrock DB=/var/spool/databasedan barney

2. The following example installs managed nodescook andeverestin policy regionaustin:

wclient –d –c /cdrom –p austin cook everest

See Alsowchkdb, winstall, wserver

wclrblk


Com

mands

wclrblkRemoves a block of statements from a file. This command should be runfrom an endpoint.

Syntaxwclrblk [–r] –s "start_string" –e"end_string" [–ooutput_file]file_name

DescriptionThewclrblk command removes a block of statements from a file. Thiscommand is intended to remove a block of statements clearly delimitedat the beginning and end of the block (such as a block added usingwinsblk or wrplblk ). The caller must insert the delimiting lines alongwith the actual block of statements.

Options–e "end_string"

Specifies a string to search for that signifies the end ofthe block of statements in the file. You must surroundthe string with double quotation marks.

–ooutput_file Specifies the name of the file that receives theprocessed file. If this option is not specified, output iswritten to standard output. You cannot redirect theprocessed file to the file that you are modifying.

–r Removes the delimiter lines in addition to the block ofstatements.

–s "start_string"Specifies a string to search for that signifies the start ofthe block of statements in the file. You must surroundthe string with double quotation marks.

file_name Specifies the file from which the block should beremoved.

wclrblk

1–176 Version 3.7.1

Return Valueswclrblk returns one of the following:

0 Indicates thatwclrblk successfully removed thespecified block of statements.

nonzero Indicates thatwclrblk did not successfully remove thespecified block of statements.

ExamplesTo remove delimiter lines and the block of statements starting with[keyboard] and ending withtype=4 from theSYSTEM.INI file, enterthe following command:wclrblk –r –s "[keyboard]" –e "type=4" \–o C:\TEMP\OUTPUT.FIL C:\WINDOWS\SYSTEM.INI

The output is written to theOUTPUT.FIL file, as specified by the–ooption.

See Alsowinsblk, wrplblk

wclrline


Com

mands

wclrlineRemoves a single line from a file. This command should be run from anendpoint.

Syntaxwclrline [–f] –s"search_string" [–ooutput_file] file_name

DescriptionThewclrline command removes a line from a text file, as specified bythe search string. By default, output from this command is written tostandard output.

Options–f Processes only the first occurrence of the search string.

If this option is not specified, all lines containing thesearch string are removed.

–ooutput_file Specifies the name of the file that receives theprocessed file. If this option is not specified, output iswritten to standard output.

–s "search_string"Specifies a string to search for in the file. If the searchstring is contained in a line, the line is removed from thefile. You must surround the string with doublequotation marks.

file_name Specifies the name of the file from which to read.

Return Valueswclrline returns one of the following:

0 Indicates thatwclrline successfully removed thespecified line.

nonzero Indicates thatwclrline did not successfully remove thespecified line.

wclrline

1–178 Version 3.7.1

Examples1. To remove the first occurrence of a line starting with[boot] from

theSYSTEM.INI file, enter the following command:

wclrline –f –s "[boot]" –o C:\TEMP\OUTPUT.FIL \C:\WINDOWS\SYSTEM.INI

2. To remove all lines that havedevice= in them from theMYAPP.INI file, enter the following command:

wclrline –s "device=" –o C:\TEMP\OUTPUT.FIL \C:\WINDOWS\MYAPP.INI

Both example commands write their output to theOUTPUT.FIL file.

See Alsowinsline, wrplline

wco


Com

mands

wcoChecks out Revision Control System (RCS) revisions.

Syntaxwco [options] file

Descriptionwco retrieves a revision from each RCS file and stores it in thecorresponding working file.

Paths matching an RCS suffix denote RCS files; all others denoteworking files. Names are paired as explained inwci.

Revisions of an RCS file can be checked out locked or unlocked.Locking a revision prevents overlapping updates. A revision checkedout for reading or processing (such as compiling) need not be locked. Arevision checked out for editing and later check-in must typically belocked. Checkout with locking fails if the revision to be checked out iscurrently locked by another user. (A lock may be broken withwrcs.)Checkout with locking also requires the caller to be on the access list ofthe RCS file, unless the caller is the owner of the file or the super user,or the access list is empty. Checkout without locking is not subject toaccess list restrictions and is not affected by the presence of locks.

A revision is selected by options for revision or branch number, check-indate and time, author, or state. When the selection options are applied incombination,wco retrieves the latest revision that satisfies all of them.If none of the selection options is specified,wco retrieves the latestrevision on the default branch (typically the trunk; see the–b option ofwrcs). A revision or branch number can be attached to any of the options–f, –I, –l, –M, –p, –q, –r, or–u. The options–d (date),–s (state), and–w (author) retrieve from a single branch, theselectedbranch, which iseither specified by one of–f, …, –u, or the default branch.

A wco command applied to an RCS file with no revisions creates azero-length working file.wco always performs keyword substitution.

The working file inherits the read and execute permissions from the RCSfile. Also, the owner’s write permission is turned on, unless–kv is set orthe file is checked out unlocked and locking is set to strict (seewrcs).

wco

1–180 Version 3.7.1

If a file with the name of the working file exists and has writepermission,wco aborts the checkout, asking beforehand if possible. Ifthe existing working file is not writable or–f is given, the working fileis deleted without asking.

Options–d date Retrieves the latest revision on the selected branch

whose check-in date/time is less than or equal todate.The date and time may be given in free format. The timezoneLT stands for local time; other common time zonenames are understood. For example, the following datesare equivalent if local time is January 11, 1990, 8 p.m.Pacific Standard Time, 8 hours west of CoordinatedUniversal Time (UTC):

8:00 pm lt4:00 AM, Jan. 12, 1990 (default is UTC)1990/01/12 04:00:00 RCS date formatThu Jan 11 20:00:00 1990 LToutput ofctime(3) +LTThu Jan 11 20:00:00 PST 1990 output ofdateFri Jan 12 04:00:00 GMT 1990Thu, 11 Jan 1990 20:00:00 –0800Fri-JST, 1990, 1pm Jan 1212-January-1990, 04:00-WET

Most fields in the date and time may be defaulted. Thedefault time zone is UTC. The other defaults aredetermined in the order year, month, day, hour, minute,and second (most to least significant). At least one ofthese fields must be provided. For omitted fields thatare of higher significance than the highest providedfield, the time zone’s current values are assumed. Forall other omitted fields, the lowest possible values areassumed. For example, the date20, 10:30 defaults to10:30:00 UTC of the 20th of the UTC time zone’scurrent month and year. The date/time must be quotedif it contains spaces.

wco


Com

mands

–j joinlist Generates a new revision that is thejoin of the revisions onjoinlist. Thisoption is obsoleted bywrcsmergebutis retained for backwardscompatibility.

–M [rev] Set the modification time on the newworking file to be the date of theretrieved revision. Use this option withcare; it can confusemake.

–sstate Retrieves the latest revision on theselected branch whose state is set tostate.

–w [login] Retrieves the latest revision on theselected branch that was checked in bythe user with login namelogin. If theoption login is omitted, the caller’slogin is assumed.

The joinlist is a comma-separated list of pairs of theform rev2:rev3, whererev2 andrev3 are symbolic ornumeric revision numbers. For the initial pair,rev1denotes the revision selected by the options–f, …, and–w. For all other pairs,rev1 denotes the revisiongenerated by the previous pair. (Thus, the output of onejoin becomes the input to the next.)

For each pair,wco joins revisionsrev1 andrev3 withrespect torev2. This means that all changes thattransformrev2 into rev1 are applied to a copy ofrev3.This is particularly useful ifrev1andrev3are the endsof two branches that haverev2 as a common ancestor.If rev1<rev2<rev3 are on the same branch, joininggenerates a new revision that is likerev3, but with allchanges that lead fromrev1to rev2undone. If changesfrom rev2 to rev1 overlap with changes fromrev2 torev3, wco reports overlaps as described inmerge.

For the initial pair,rev2 can be omitted. The default isthe common ancestor. If any of the options indicate

wco

1–182 Version 3.7.1

branches, the latest revisions on those branches areassumed. The options–l and–u lock or unlockrev1.

–f [rev] Forces the overwriting of the working file; useful inconnection with–q. See also “FILE MODES.”

–I [rev] Interactive mode; the user is prompted and questionedeven if the standard input is not a terminal.

–k k Generates only keyword names in keyword strings;omits their values. See “KEYWORDSUBSTITUTION.” For example, for theRevisionkeyword, generates the string$Revision$ instead of$Revision: 5.7 $. This option is useful to ignoredifferences due to keyword substitution whencomparing different revisions of a file.

–k o Generates the old keyword string, present in theworking file just before it was checked in. For example,for theRevision keyword, generates the string$Revision: 1.1 $ instead of$Revision: 5.7 $ if that ishow the string appeared when the file was checked in.This can be useful for binary file formats that cannottolerate any changes to substrings that happen to takethe form of keyword strings.

–k kv Generates keyword strings using the default form, suchas$Revision: 5.7 $ for theRevision keyword. Alocker’s name is inserted in the value of theHeader, Id ,andLocker keyword strings only as a file is beinglocked, for example, bywci–l andwco–l. This is thedefault.

–k kvl Similar to–k kv, except that a locker’s name is alwaysinserted if the given revision is currently locked.

–k v Generates only keyword values for keyword strings.For example, for theRevision keyword, generates thestring5.7 instead of$Revision: 5.7 $. This can helpgenerate files in programming languages where it ishard to strip keyword delimiters such as$Revision:$from a string. However, further keyword substitutioncannot be performed after the keyword names are

wco


Com

mands

removed, so this option should be used with care.Because of the possibility of losing keywords, thisoption cannot be combined with–l, and the owner writepermission of the working file is turned off; to edit thefile later, check it out again without–k v.

–l [rev] Same as–r, except that it also locks the retrievedrevision for the caller.

–p [rev] Prints the retrieved revision on the standard outputrather than storing it in the working file. This option isuseful whenwco is part of a pipe.

–q [rev] Quiet mode; diagnostics are not printed.

–r [rev] Retrieves the latest revision whose number is less thanor equal torev. If rev indicates a branch rather than arevision, the latest revision on that branch is retrieved.If rev is omitted, the latest revision on the defaultbranch (see the–b option ofwrcs) is retrieved. Ifrev is$, wco determines the revision number from keywordvalues in the working file. Otherwise, a revision iscomposed of one or more numeric or symbolic fieldsseparated by periods. The numeric equivalent of asymbolic field is specified with the–n option of thecommandswci andwrcs.

–u [rev] Same as–r, except that it unlocks the retrieved revisionif it was locked by the caller. Ifrev is omitted,–uretrieves the revision locked by the caller, if there isone; otherwise, it retrieves the latest revision on thedefault branch.

–V n Emulates RCS versionn, wheren can be3, 4, or5. Thismay be useful when interchanging RCS files withothers who are running older versions of RCS. To seewhich version of RCS your correspondents are running,have them invokewrlog on an RCS file; if none of thefirst few lines of output contain the stringbranch: it isversion 3; if the dates’ years have just two digits, it isversion 4; otherwise, it is version 5. An RCS filegenerated while emulating version 3 loses its default

wco

1–184 Version 3.7.1

branch. An RCS revision generated while emulatingversion 4 or earlier has a time stamp that is off by up to13 hours. A revision extracted while emulating version4 or earlier contains dates of the formyy/mm/dd insteadof yyyy/mm/dd and can also contain different whitespace in the substitution for$Log$.

–x suffixes Usessuffixes to characterize RCS files. Seewci fordetails.

Keyword Substitution

Strings of the form$keyword$ and$keyword:…$ embedded in the textare replaced with strings of the form$keyword:value$, wherekeywordvalue are pairs listed below. Keywords can be embedded in literalstrings or comments to identify a revision. Initially, the user entersstrings of the form$keyword$. On checkout,wco replaces these stringswith strings of the form$keyword:value$. If a revision containingstrings of the latter form is checked back in, the value fields are replacedduring the next checkout. Thus, the keyword values are automaticallyupdated on checkout. This automatic substitution can be modified by the–k option.

Keywords and their corresponding values are as follows:

$Author$ The login name of the user who checked in the revision.

$Date$ The date and time (UTC) the revision was checked in.

$Header$ A standard header containing the full path name of theRCS file, the revision number, the date (UTC), theauthor, the state, and the locker (if locked).

$Id$ Same as$Header$, except that the RCS file name iswithout a path.

$Locker$ The login name of the user who locked the revision(empty if not locked).

$Log$ The log message supplied during check-in, preceded bya header containing the RCS file name, the revisionnumber, the author, and the date (UTC). Existing logmessages arenot replaced. Instead, the new log

wco


Com

mands

message is inserted after$Log:…$. This is useful foraccumulating a complete change log in a source file.

$RCSfile$ The name of the RCS file without a path.

$Revision$ The revision number assigned to the revision.

$Source$ The full path name of the RCS file.

$State$ The state assigned to the revision with the–soption ofwrcs or wci.

NotesLinks to the RCS and working files are not preserved.

There is no way to selectively suppress the expansion of keywords,except by writing them differently. In nroff and troff, this is done byembedding the null character\& into the keyword.

DiagnosticsThe RCS path name, the working path name, and the revision numberretrieved are written to the diagnostic output. The exit status is zero ifand only if all operations were successful.

Fileswcoaccesses files much aswci does, except that it does not need to readthe working file.

Environment VariablesRCSINIT Options prepended to the option list, separated by

spaces. Seewci for details.

DefectsOccasionally, the–d option accepts no date before 1970.

AuthorAuthor: Walter F. Tichy.

wco

1–186 Version 3.7.1

Revision Number: 5.7; Release Date: 1991/08/19.Copyright © 1982, 1988, 1989 by Walter F. Tichy.Copyright © 1990, 1991 by Paul Eggert.

See Alsowci, wident, wrcs, wrcsdiff , wrcsmerge, wrlog; Walter F. Tichy,RCS—A System for Version Control,“Software—Practice &Experience 15, 7 (July 1985), 637-654.

wconnect


Com

mands

wconnectConnects two Tivoli management regions.

Syntaxwconnect [–u] [–Pport] [–m mode] [–r encrypt_level] –sserverregion_num

wconnect [–nu][–Pport] [–cencrypt_level] [–l login][–m Two-way | Managing | Managed] [–r encrypt_level] server

DescriptionThewconnect command establishes a connection between the Tivolimanagement region servers in two regions. The first usage ofwconnectshown in the syntax performs a secure connection. To complete theconnection, this command must be run on both the Tivoli managementregion servers being connected. The second usage performs a remoteconnection. This command is run on only one Tivoli server. If theconnection being made is to be a one-way connection, the Tivoli serverfrom which the remote connection was performed becomes themanaging server.

Tivoli management regions can be connected in a one-way connectionor a two-way connection. With a one-way connection, one server is themanaging server and one is the managed server. An administrator on themanaging server can manage any resources on either the managingserver or the managed server. However, an administrator on themanaged server cannot manage resources on the managing server. Witha two-way connection, administrators on either server can manage anyresources of the other server.

Options–cencrypt_level

Specifies the interregion encryption level that is in usein the local Tivoli management region. Validencryption levels aresimple, none, orDES. If theencryption level isnone, no key is required. If the levelis simpleor DES, the command prompts for the key in

wconnect

1–188 Version 3.7.1

use. The encryption key is the same as the installationpassword specified during the server installation. Theencryption level must be the same as that specifiedduring the Tivoli management region serverinstallation. The default encryption level issimple.

–l login Supplies a login name for the remote connectionprocess. This login must be a valid login for a user onthe remote server, and the user must have a Tivoliadministrator with thesuper role defined in the remoteTivoli management region. If the–l option is specified,the command prompts for a password. If the trustedhost’s facility is used, do not type the password.Instead, press the Enter key to continue.

–m mode Specifies the mode of connection to be establishedbetween Tivoli management regions. Valid connectionmodes are as follows:

Two-way Establishes a two-way connectionbetween Tivoli management regions.In a two-way connection, both Tivolimanagement region servers havemanaging authority over the resourcesin both regions. This is the defaultvalue.

Managing Establishes a one-way connection withthe local Tivoli management regionserver as the managing server. Thelocal Tivoli server can manageresources in the remote Tivolimanagement region, but the remoteTivoli server cannot manage resourcesin the local region.

Managed Establishes a one-way connection withthe local Tivoli management regionserver as the managed server. Thisoption is valid on secure connectionsonly. For remote connections, the localserver can be only a managing server.

wconnect


Com

mands

–n Instructs Tivoli Management Framework not to promptfor passwords. You can use this option only when youhave trusted host access and do not require anencryption key.

Note: Because a Windows NT or Windows 2000system does not have trusted host access, thisoption cannot be used when connecting Tivolimanagement region servers on Windowssystems.

–Pport Specifies the port number to use for communicationwith the Tivoli management region server if differentfrom the local object dispatcher’s port.

Note: This option is meant for use in developmentand test environments only. It should not beused in a production environment.

–r encrypt_levelSpecifies the encryption level in use in the remoteTivoli management region. Valid encryption levels aresimple, none, orDES. If the encryption level isnone,no key is required. If the level issimple or DES, thecommand prompts for the key in use. The encryptionkey is the same as the installation password specifiedduring the server installation. The encryption level mustbe the same as that specified during the Tivolimanagement region server installation. The defaultencryption level issimple.

–s Establishes the connection using the secure connectionprocess. This requires runningwconnect –s on bothTivoli management region servers in the connection.

–u Updates resources between Tivoli management regionsin a two-way connection or from the remote region in aone-way connection. Note that because this is atime-intensive process, you can use thewlsconn –ucommand to perform this operation at a later date (notconnection time).

wconnect

1–190 Version 3.7.1

region_num Specifies the region number of the remote Tivolimanagement region.

server Specifies the name of the Tivoli management regionserver in the remote region.

Authorizationsuper

Examples1. The following example performs a remote two-way connection.

Both Tivoli management region servers use simple encryption.The administrator running this command has the loginsally on theremote server,elbert. Resource information is exchanged betweenthe servers as soon as the connection is complete.

wconnect –u –c simple –l sally –m Two-way –r simple\ elbert

2. The following example performs a remote one-way connection.The local server uses no encryption, but the remote server,cook,uses simple encryption. The local server becomes the managingserver and the remote server becomes the managed server.Resource information is updated on the local server.

wconnect –u –c none –m Managing –r simple cook

3. The following example performs a secure two-way connection.The remote server,pinatubo, uses simple encryption (by default).The region number of the remote server is4004418954. Resourceinformation is exchanged between the servers when the connectionhas been completed.

wconnect –u –s pinatubo 4004418954

wconnect


Com

mands

To complete the connection, you must runwconnecton the remoteserver also. The following command must be run frompinatubo.In this example, the encryption level is specified with the–roption, while the previous command used the default value.Resource information is updated between servers.

wconnect –u –r simple –s everest 4004598145

4. The following example performs a secure one-way connection.The remote server,meiron, uses simple encryption (by default).The region number of the remote server is0003432265. The localserver will be the managed server. Resource information isexchanged between the servers when the connection is complete.

wconnect –u –m Managed –s meiron 0003432265

To complete the connection, you must runwconnecton the remoteserver also. The following command must be run frommeiron.meiron will be the managing server.

wconnect –u –m Managing –s space 4004598145

Note: If you make a one-way connection using the secure connectionprocess and the first server you runwconnecton is specified asthe managing server instead of the managed server, you mustrun thewlsconn –u command to complete the exchange ofconnection information on the managing server.

See Alsowdisconn, wlsconn, wupdate

wcpcdrom

1–192 Version 3.7.1

wcpcdromCopies installation images from a CD to a system directory.

Syntaxwcpcdrom [–i start_index] [–a] [–c] [–n] cdrom_list new_cdrom_dir[interp_list]

DescriptionThewcpcdrom command copies Tivoli installation images from aTivoli CD into a system directory,new_cdrom_dir. Using thiscommand, you can copy the contents of a CD to a system directory,merge multiple CD images in a system directory, or copy a singleinterpreter type from one or more CDs to a system directory. If, forexample, you want to build an installation image for the HP-UX 10.01version of Tivoli Management Framework and all the Tivoliapplications, you could use this command to create a single directorythat contains only the HP-UX 10.01 binaries and libraries for all theTivoli applications you want to install. You can then install all theapplications from that directory.

By default,wcpcdrom creates symbolic links to the images on the CD.If you are copying images from multiple CDs, you should use the–coption, which copies the files instead of creating the symbolic link.

When copying images from multiple CDs, you must also use the–istart_index option. This option indicates the number thatwcpcdromshould start with when numbering packets innew_cdrom_dir. Forexample, suppose you have already copied one Tivoli CD to a directory.The directory containsfile1.pkt throughfile95.pkt. When you copy thesecond CD, you must use the–i start_indexoption to avoid overwritingthe existing files. You might, for example, specifywcpcdrom –i 96.Each packet on the second CD is then numbered sequentially starting atfile96.pkt.

Whennew_cdrom_dircontains the images you want, you can copy thefull image onto a tape using the following command:cd new_cdrom_dir tar–cvhf tape_device

wcpcdrom


Com

mands

To install from the new image, create aninstall_dirdirectory and run thewpreinst command in the same way that you would install from the CD.See the Tivoli Enterprise Installation Guide for installation procedures.

Options–a Copies all files and directories from the CD, including

PC (desktop and installation files), TRIP, BOOKS,DOCS, and PDF files.

–c Copies the CD images instead of creating symboliclinks to the CD.

–i start_index Indicates the number at whichwcpcdromshould beginnumbering packets copied intonew_cdrom_dir.start_index can be any number 1 through 9999.

–n Shows whatwcpcdrom does when executed. No filesare changed when this option is specified.

cdrom_list Identifies the path to the CD. Multiple paths must beseparated by commas.

interp_list Identifies the interpreter type to be copied from the CD.Multiple interpreter types must be separated by a space.If no interp_listis given, all interpreter types are copied.For a complete list of valid interpreter types, see theTivoli Management Framework Release Notes.

new_cdrom_dirIdentifies the directory into which the file packets arecopied.

AuthorizationNo special authorization is required to use this command.

Examples1. The following example copies the contents of CDcdrom1 to the

/tmp/tiv_install directory:

wcpcdrom –c /mycdrom/cdrom1 /tmp/tiv_install

wcpcdrom

1–194 Version 3.7.1

2. The following example copies only thesolaris2 interpreter typefrom the CDcdrom2 to the/tmp/tme_install directory. Filepackets are numbered sequentially starting at 96.

wcpcdrom –c –i 96 /mycdrom/cdrom2 /tmp/tme_install \solaris2

3. The following example copies the HP-UX 10.01 TivoliManagement Framework file packets from/mycdrom/tmp_cdrom and the HP-UX 10.01 Tivoli applicationfile packets from/urcdrom/apps_cdrom. All file packets arecopied to the/home/new_dirdirectory. File packets are numberedsequentially starting at 1.

wcpcdrom –c –i 1 /mycdrom/tmp_cdrom, /urcdrom/apps_cdrom \/home/new_dir hpux

See Alsowcrtimage

wcpyfile


Com

mands

wcpyfileEnables a NetWare configuration program (.NCF) to copy a file. Thiscommand should be run from an endpoint.

Syntaxwcpyfile –ssrc_path–d dest_path

DescriptionThewcpyfile command was created in support of.NCF configurationprograms. It enables you to copy files from one volume or directory toanother on the NetWare machine from within an.NCF configurationprogram.

Options–d dest_path Specifies the full path to the destination file.

–ssrc_path Specifies the full path to the source file.

ExamplesFrom an.NCF configuration program, enter the following command inthe program to copy theSYS:\TEMP\FILE.NLM file to theSYS:\SYSTEM\FILE.NLM file:wcpyfile –s SYS:\TEMP\FILE.NLM –d SYS:\SYSTEM\FILE.NLM

wcrtadmin

1–196 Version 3.7.1

wcrtadminCreates a new Tivoli administrator.

Syntaxwcrtadmin –l login… [–n noticegroup]…[–r group,role1:role2…] [–u user_id [–ggroup_id]]… name

DescriptionThewcrtadmin command creates a new Tivoli administrator.

Options–ggroup_id Sets the principal group ID for the new administrator.

–l login Sets up a Tivoli login for the new administrator. Thelogin can be entered in one of the following forms:

■ user_name

■ user_name@ManagedNode

■ NTdomain\user_name

■ NTdomain\user_name@ManagedNode

■ kerberos_name:realm

If only user_name or NTdomain\user_name isspecified, the user can log in from any system in theTivoli management region. Ifuser_name@ManagedNode orNTdomain\user_name@ManagedNodeis specified, theuser can log in only from the specified host.

–n noticegroupSets up a notice group subscription for the newadministrator. You can specify more than one noticegroup.

–r group,role1:role2Gives the new administrator roles in the specifiedgroup. This option must be entered in the form of@group,role1:role2 (for example,

wcrtadmin


Com

mands

@Administrator,admin:user or@DefaultRegion,super). To specify a role in a singleinstance of a group, specify the group type followed bythe instance name. Both names must be colonseparated. For example,@PolicyRegion:MyRegion,super:senior specifiessuperandsenior roles in policy regionMyRegion. Tospecify Tivoli management region roles, use the string“global” (for example,–r global,user).

–u user_id Sets the principal user ID for the new administrator.user_id can be entered in one of the following forms:

■ user_name

■ user_name@ManagedNode

■ NTdomain\user_name

■ NTdomain\user_name@ManagedNode

■ kerberos_name:realm

Note: All possible values for ManagedNode are listedunder the Hostname(s) column in the output ofodadmin odlist.

name The label of the new administrator. This label displayswith the Administrator icon in theAdministratorswindow. Administrator names can include anyalphanumeric character, an underscore (_), a dash (–), aperiod (.), and a space.

Authorizationsenior

Examples1. The following example creates an administrator with the Tivoli

login kimiko on systemohio, membership in theTivoli-Authorization notice group, theadmin authorization role in the

wcrtadmin

1–198 Version 3.7.1

Testing policy region, and the labelKimiko :

wcrtadmin –l kimiko@ohio –n Tivoli-Authorization \–r @PolicyRegion:Testing,admin Kimiko

2. The following example creates an administrator under theprincipalscallahan@sthelens andcallahan@dogma with therolesuser in the Tivoli management region, the rolessuper,admin, anduser in DefaultRegion, the rolessuperandsenior ingroupAdministrators , and the rolessuper, senior, admin, user,andbackup in theMyRegion policy region.callahan is added asa member of theTivoli Authorization group. The administratorruns as principal user IDcallahan and principal group IDstaff.The administrator’s label isSteve Callahan.

wcrtadmin –l callahan@sthelens –l callahan@dogma \–n "Tivoli Authorization" \–r global,user –r @DefaultRegion,super:admin:user \–r /Administrators,super:senior \–r @PolicyRegion:MyRegion,super:senior:admin:user:backup \–u callahan –g staff "Steve Callahan"

See Alsowgetadmin, wsetadmin

wcrtgate


Com

mands

wcrtgateCreates an endpoint gateway.

Syntaxwcrtgate {[ –h managed_node] [–i IPX_socket_num][–n gateway_name] [–p TCPIP_port] [–Pprotocols_list][–t default_session_timeout]}

DescriptionThewcrtgate command creates a new endpoint gateway on thespecified managed node. You must specify at least one of these options.

Options–h managed_node

Specifies the name of the managed node on which thegateway is created. If this option is not used, thegateway is created on the managed node from which thecommand was given.

–i IPX_socket_numSpecifies the port on which the gateway listens forSequenced Packet Exchange (SPX) packets. Thegateway also listens for Internetwork Packet Exchange(IPX) packets on theIPX_socket_num –1 port.

–n gateway_nameSpecifies the name of the gateway. If this option is notused, the gateway name ismanaged_node–gateway.

–p TCPIP_portSpecifies the Transmission Control Protocol/ InternetProtocol (TCP/IP) port number through which thegateway communicates with its assigned endpoints.The default is port 9494.

Note: Do not use the same port number used by theproxy managed node or by the endpoints.

wcrtgate

1–200 Version 3.7.1

–Pprotocols_listSpecifies the supported protocols for the specifiedgateway. Multiple protocols must be separated bycommas, for example,protocol1,protocol2.

–t default_session_timeoutSets the session timeout period used during downcallsfrom the gateway to an endpoint. The specified timerepresents the amount of time the gateway waits for aresponse from the endpoint.

Authorizationsenior

Examples1. The following example creates an endpoint gateway on managed

nodepearl. The resulting gateway is namedpearl-gateway andcommunicates on default port 9494.

wcrtgate –h pearl

2. The following example creates an endpoint gateway namedgemson managed nodediamond:

wcrtgate –h diamond –n gems

3. The following example creates an endpoint gateway namedsubnet30-gateway on managed nodevernon that communicatesthrough port 8432.

wcrtgate –h vernon –n subnet30-gateway –p 8432

4. The following example creates an endpoint gateway on managednodevernon that supports both TCP/IP and IPX protocols. Itcommunicates with TCP/IP endpoints on port 9999 and with IPXendpoints on port 6000:

wcrtgate –h vernon –P TCPIP,IPX –p 9999 –i 6000 –n gems

See Alsowdelgate

wcrtjob


Com

mands

wcrtjobCreates a job in a task library.

Syntaxwcrtjob –j job_name–l library_name–t task_name–M mode[–s interval–n number] –m timeout–ooutput_format[–D | –d node_name–f file_name] [–h node_name][–p prof_manager_name]

DescriptionThewcrtjob command creates a job using the specified task. A job is aresource in the Tivoli environment that can be run repeatedly.

Options–d node_nameSpecifies the managed node on which to save to the job

output.

–D Displays the job output to the screen.

–f file_name Specifies the file name in which to save the job output.

–h node_nameSpecifies the managed nodes on which to run the job.

–j job_name Specifies the name of the job being created. Job namescan include any alphanumeric character, an underscore(_), a dash (–), a period (.), and a space.

–l library_nameSpecifies the task library containing the task to beincluded in the job.

–m timeout Specifies the number of seconds that the task librarywaits for results to be returned from the task. Thisoption does not affect the execution of the job. If youare usingstaged mode, the timeout must be smallerthan the interval time.

wcrtjob

1–202 Version 3.7.1

–M mode Specifies the mode in which the job runs. Valid optionsare as follows:

parallel Runs the job on all specified managednodes and any subscriberssimultaneously.

serial Runs the job on one managed node at atime.

staged Runs the job on groups of managednodes at specified intervals.

–n number Specifies the number of managed nodes in each groupin staged mode. You must specify a value for thisoption if you selectedstaged mode.

–ooutput_formatDefines the format of the job output. The job outputcontains a summary of the job on each managed node.Task execution output format is specified with an octalnumber from 0 to 17. The format is constructed byadding the value of the desired output. For example, toprint the task’s return code and standard output, enter–o 12. Output values are as follows:

01 Prints a descriptive header for eachrecord

02 Prints the task’s return code

04 Prints the standard error output

10 Prints the standard output

–p prof_manager_nameSpecifies the profile managers on which the job runs.

–s interval Specifies the number of seconds between when the taskruns on one group of managed nodes and when it runson the next group. You must specify a value for thisoption if you selectedstaged mode.

–t task_name The name of the task to include in the job.

wcrtjob


Com

mands


Examples1. The following example creates a job nameddate_job. The job

includes taskdate_task, which is contained in task librarymy_tasks. The job runs in parallel on managed nodes thatsubscribe to themarketing profile manager. The job runs on eachmanaged node for 120 seconds before it times out. The output ofthe task displays to the screen.

wcrtjob –j date_job –t date_task –l my_tasks \–M parallel –m 120 –p marketing –o 017 –D

2. The following example creates a job nameddate_job2. The jobincludes taskdate_task, which is contained in task librarymy_tasks. The job runs in parallel on managed nodebald. The jobruns for 120 seconds before it times out. The job’s output is savedto a file named/tmp/date_job2.output on managed nodebald.

wcrtjob –j date_job2 –t date_task –l my_tasks \–M parallel –m 120 –h bald –o 017 –d bald \–f /tmp/date_job2.output

See Alsowcrttask, wdeljob, wruntask

wcrtpol

1–204 Version 3.7.1

wcrtpolCreates a new policy object for a class.

Syntaxwcrtpol [–d | –v] class name [parent]

DescriptionThewcrtpol command creates a new policy default or policy validationobject for a class. The new policy object inherits its first set of methodsand attributes from an existing class policy object. Use thewgetpolmandwputpolm commands to customize the new policy object.

Options–d Creates a policy default object. This action is the default

unless the–v option is present.

–v Creates a policy validation object.

class The new policy object’s class.

name The new policy object’s name. Policy object names caninclude any alphanumeric character, an underscore (_),a dash (–), a period (.), and a space.

parent The label of an existing class policy object from whichthe new policy object inherits its initial methods andattributes. The default parent is the default policy objectfor the class.


ExamplesThis example creates a policy validation object forProfileManager.The object is namedRestricted and inherits from theBasicProfileManager policy object.wcrtpol –v ProfileManager Restricted BasicProfileManager

wcrtpol


Com

mands

See Alsowchkpol, wcrtpr , wdelpol, wdelpr, wgetdfpol, wgetpolm, wls,wlspolm, wputpolm

wcrtpr

1–206 Version 3.7.1

wcrtprCreates a policy region.

Syntaxwcrtpr [–aadmin…] [–sregion] [–m resource…] name

DescriptionThewcrtpr command creates a policy region. When a policy region iscreated with this command, policy validation is disabled for all resourcetypes. Use thewsetpr command to enable policy validation.

Options–aadmin… Adds the new policy region to the specified

administrator’s desktop. You can use–aadminmultipletimes to add the region to the desktops of severaladministrators.

–m resource… Specifies a resource to be added to the new policyregion’s list of managed resources. You can use–mmultiple times to add several managed resources. Thepolicy authorization role is required if the–m option isused.

–sregion Creates the new policy region as a subregion ofregion.The new policy region inherits the supported classes ofits parent region. If you omit the–s option,wcrtprcreates the region as a top-level region.

name The name of the new policy region. Policy regionnames can include any alphanumeric character, anunderscore (_), a dash (–), a period (.), and a space.

Authorizationsenior; seniorandpolicy when the–m option is issued.

wcrtpr


Com

mands

Examples1. The following example creates a top-level policy region and

automatically adds it to the root administrator’s desktop:

wcrtpr –a Root_ceridwen-region new-region

2. The following example creates a subregion under the defaultregion and makes theManagedNode resource type a managedresource:

wcrtpr –s /Regions/test-region –m ManagedNode node-region

See Alsowchkpol, wcrtpol , wdelpol, wdelpr, wgetdfpol, wgetpolm, wlspolm,wputpolm

wcrtprf

1–208 Version 3.7.1

wcrtprfCreates a new profile or clones an existing profile.

Syntaxwcrtprf [–csource] profile_manager type profile_name

DescriptionThewcrtprf command creates a configuration profile of the typespecified in thetype option. The profile is created using the namespecified inprofile_name in the profile manager specified inprofile_manager.

If source is specified, thewcrtprf command clones an existing profileof the same type. Ifsource is not specified, the new profile will beinitialized empty.

Options–csource Specifies the name of an existing profile from which to

clone the new one. Valid formats for thesourceoptionare as follows:

■ @prof_name

■ @profile_type:prof_name

■ /Regions/PolicyRegionName/prof_manager_name/prof_name

profile_managerSpecifies the name of the profile manager in which tocreate the profile. Valid formats for theprofile_manager option are as follows:

■ @prof_manager_name

■ @ProfileManager:prof_manager_name

■ /Regions/PolicyRegionName/prof_manager_name

wcrtprf


Com

mands

profile_name Specifies the name of the new profile. Profile namescan include any alphanumeric character, an underscore(_), a dash (–), a period (.), and a space.

type Specifies the type of profile to create. The type can beUserProfile, GroupProfile , HostNamespace,NisDomain, SentryProfile, SoftwarePackage, orFilePackage.


Examples1. The following example creates a Tivoli Distributed Monitoring

profile namedDiskSpace. The profile is created in theDevelopment profile manager.

wcrtprf @ProfileManager:Development SentryProfile \DiskSpace

2. The following example clones theDiskSpace profile into theMarketing profile manager.

wcrtprf –c @SentryProfile:DiskSpace \@ProfileManager:Marketing SentryProfile OurDiskSpace

See Alsowcrtprfmgr , wdistrib , wgetprf, wgetsub, wlspol, wpopulate, wsub,wunsub, wvalidate

wcrtprfmgr

1–210 Version 3.7.1

wcrtprfmgrCreates a profile manager.

Syntaxwcrtprfmgr pol_region name

DescriptionThewcrtprfmgr command creates a profile manager using the namespecified in thenameoption. The profile manager is created in the policyregion specified in thepol_region option.

Note: To specify whether a profile manager runs in dataless mode, usethewsetpm command.

Optionsname Specifies the name of the new profile manager. Profile

manager names can include any alphanumericcharacter, an underscore (_), a dash (–), a period (.), anda space.

pol_region Specifies the policy region in which to create the profilemanager:

■ @pol_region

■ @PolicyRegion:pol_region

■ /Regions/pol_region


ExamplesThe following example creates theDevelopmentprofile manager in theDallas policy region:wcrtprfmgr @Dallas Development

wcrtprfmgr


Com

mands

See Alsowcrtprf , wdistrib , wgetprf, wgetsub, wlssub, wpopulate, wsetpm,wsub, wunsub, wvalidate

wcrtqlib

1–212 Version 3.7.1

wcrtqlibCreates a query library.

Syntaxwcrtqlib policy_region query_lib

DescriptionThewcrtqlib command creates a new query library in the specifiedpolicy region.

Optionspolicy_region Specifies the name of the policy region in which to

create the query library.

query_lib Specifies the name of the new query library.


ExamplesThe following example creates a query library namedNewQueries intheamon-sul-Region policy region.wcrtqlib amon-sul-Region NewQueries

See Alsowcrtquery , wdel, wgetquery, wruninvquery, wrunquery, wsetquery

wcrtquery


Com

mands

wcrtqueryCreates a query.

Syntaxwcrtquery [–d desc] [–r repository] [–v view] [–ccolumn]…[–i | –s | –w where_clause] [–x] query_lib query_name

DescriptionThewcrtquery command creates a new query in a query library. Youcan specify a description for the query, a repository, a view, the columnsto query, and SQL search (or where) clauses. You can specify theoptional where clauses through either standard input or on the commandline.

The defaults for the configuration repository, view, and columns aresupplied by the policy defaults in the policy region that contains thequery library.

You can view and edit these attributes with thewgetquery andwsetquery commands or from the Tivoli desktop.

Options–ccolumn Specifies the column or columns from which to retrieve

information. To include more than one column, usemultiple–c clauses. The columns in the output areordered according to how you enter them here.

–d desc Specifies a description of the query.

–i Reads the nonstructured where clause from standardinput.

–r repository Specifies the name of the configuration repository fromwhich to retrieve information.

–s Reads the structured where clause from standard input.The clause should be in the following format:

[AND | OR] [NOT] Column_Name {= | != | < | <= | > |>= | LIKE | IN} Column_Value

wcrtquery

1–214 Version 3.7.1

–v view Specifies the name of the view or table from which toretrieve information.

–w where_clauseProvides a where clause on the command line.

–x Specifies that the output of the query does not containduplicate rows.

query_lib Specifies the name of the query library in which tocreate the query.

query_name Specifies the name of the new query.

Authorizationadmin, senior, orsuper

Examples1. The following example creates a query namedDOS-machinesin

the query library namedNewQueries. This query uses a structuredwhere clause, read from standard input, to find information aboutmachines running DOS. The query looks in theinventoryrepository in theMACHINE_TYPE view and returns informationfrom thePROCESSOR_TYPE andOPERATING_SYSTEMcolumns for every instance ofBOOTED_OS_NAME that has avalue ofDOS.

wcrtquery –d "Find all DOS machines" –r inventory –v \MACHINE_TYPE –c PROCESSOR_TYPE –c OPERATING_SYSTEM –s \NewQueries \DOS-machines <<EOF

(BOOTED_OS_NAME = 'DOS')EOF

2. The following example creates the same query, except that anunstructured where clause specifies that the results will be sortedby HARDWARE_SYSTEM_ID :

wcrtquery –d "Find all DOS machines" –r inventory –v \MACHINE_TYPE –c PROCESSOR_TYPE –c HARDWARE_SYSTEM_ID \–w "(BOOTED_OS_NAME = 'DOS') ORDER BY HARDWARE_SYSTEM_ID" \NewQueries DOS-machines

wcrtquery


Com

mands

See Alsowcrtqlib , wdel, wgetquery, wruninvquery, wrunquery, wsetquery

wcrtrim

1–216 Version 3.7.1

wcrtrimCreates an RDBMS Interface Module (RIM) object.

Syntaxwcrtrim [–i] –v vendor [–h host_name | –ohost_oid] –d database–u user–H db_home–sserver_id [–I instance_home] rim_name

DescriptionThewcrtrim command creates a new RIM object on a specific managednode. If you use the–hor–ooption, specify a managed node that is localto the Tivoli management region where you enter thewcrtrimcommand and where the RIM object will reside. If you do not specifyeither the name or the object ID of a managed node, the RIM object iscreated on the Tivoli management region server. Theinstance_homeoption is required only for a DB2 database. You cannot change thevendor for a RIM object after it has been created. If you need to changethe vendor, you must delete the RIM object and create a new one.

Options–d database Specifies the name (database ID) of the database to

which the RIM object connects.

–h host_name Specifies the name of a managed node on which theRIM object resides. The managed node must be in thelocal Tivoli management region. If you do not useeither this or the–ooption, the RIM object is created onthe Tivoli management region server.

–H db_home Specifies the path to the database home directory. Thisoption actually sets the environment variablesORACLE_HOME , SYBASE, andDB2DIR forOracle, Sybase, and DB2, respectively.

–i Reads the database password from standard input. Ifyou specify this option, the password can be of anylength. If you do not specify this option, you are

wcrtrim


Com

mands

prompted for a password, and the password must belimited to eight characters.

–I instance_homeFor DB2 only, specifies the path and name of theinstance to which the RIM object connects.

–ohost_oid Specifies the managed node object ID as the locationfor the RIM object. The object ID must be in the localTivoli management region. If you do not use either thisor the–hoption, the RIM object is created on the Tivolimanagement region server.

–sserver_id Specifies the server ID for the database. This optionactually sets the environment variablesTWO_TASK ,DSQUERY, andDB2COMM for Oracle, Sybase, andDB2, respectively. For Microsoft SQL Server, this isthe name of the RDBMS server machine.

–u user Specifies the name of the database user that the RIMobject uses. If you are using DB2, specify a valid UNIXuser.

–v vendor Specifies the name of the database vendor that the RIMobject represents. Acceptable values includeInformix ,Oracle, Sybase, DB2, andMS_SQL.

rim_name Specifies the name of the RIM object to be created.


Examples1. The following example interactively creates a RIM object:

wcrtrim –v Oracle –h amon-sul –d amar –u tivoli –H \/tivoli/drm/2/amishra/ORACLE –s invdb.world inventory

2. The following example creates the same RIM object, but reads thepassword from a file:

wcrtrim –i –v Oracle –h amon-sul –d amar –u tivoli \–H /tivoli/drm/2/amishra/ORACLE –s invdb.world inventory \< ./passwd

wcrtrim

1–218 Version 3.7.1

See Also wdel, wgetrim, wsetrim, wsetrimpw

wcrttask


Com

mands

wcrttaskCreates a task in a task library.

Syntaxwcrttask –t task_name–l lib_name [–ggroup_name][–u user_name] –r role [–ccomments]{ –i interp_type node_name file_name}…

wcrttask [–F file_name] –t task_name–l lib_name[–u user_name] [–ggroup_name] –r role

DescriptionThewcrttask command creates a task in the specified task library. Atask is a method you run on specified managed nodes and theirsubscribers. Each time you run the task you must specify the runinformation.

If you specify only the–t and–l options, the task is created in thespecified task library but is not executed. To create the task and run itimmediately, you must specify the–i interp_type node_name file_nameset of options. You can specify the set multiple times, once for eachplatform on which the task runs.

Options–ccomments Adds any explanatory comments that help identify the

task and its purpose.

–F file_name Specifies a file that contains information about anexisting task. The specified file must be a tar file that iscreated by running thewgettask command. If thisoption is used, the specified file is imported and a newtask is created using the information in the file. Thisoption is useful when importing a task from one Tivolienvironment to another.

–ggroup_nameSpecifies the name of the group under which the taskruns.

wcrttask

1–220 Version 3.7.1

–i Defines the information required to execute the newtask on a managed node. You must supply the followingvalues with the–i option:

interp_type Specifies the interpreter type of theplatform on which the task is to be run.

node_name Specifies the managed node containingthe executable for the specifiedplatform.

file_name Specifies the name of the executable tobe run on the specified platform.

–l lib_name Specifies the task library in which to create the task.

–r role Specifies the authorization roles required to run thetask. Multiple roles can be specified in acolon-separated list, for example,admin:senior:super .

–t task_name Specifies the name of the new task. Task names caninclude any alphanumeric character, an underscore (_),a dash (–), a period (.), and a space.

–u user_name Specifies the name of the user under which the taskruns. If you use an asterisk (*) to setuser_name to thecurrent user ID (UID), enclose the asterisk in singlequotation marks (for example,–u '*').


Examples1. The following example creates a task calleddate_taskin the task

library my_tasks. Administrators must have thesuper, senior, oruserrole to execute this task. The task runs on the Solaris platform.The executables for this task are located in/bin/date on managednodebald. A comment is also included.

wcrttask –t date_task –l my_tasks \–r super:senior:user –i solaris2 bald /bin/date \–c "This task runs the /bin/date command"

wcrttask


Com

mands

2. The following example creates a task namedfind_coresin the tasklibrary my_tasks. This task requires thesuper role. The task runson the default platform. The task’s executable files are located in/tmp/find_cores.shon managed nodebald. The task runs asroot.

wcrttask –t find_cores –l my_tasks –r super \–i default bald /tmp/find_cores.sh –c "This task finds \core files and runs as root" –u root

See Alsowcrtjob , wdeltask, wgettask, wtll

wcrttlib

1–222 Version 3.7.1

wcrttlibCreates a task library.

Syntaxwcrttlib library_name pr_name

DescriptionThewcrttlib command creates a task library in the specified policyregion.

Optionslibrary_name Specifies the name of the task library being created.

Task library names can include any alphanumericcharacter, an underscore (_), a dash (–), a period (.), anda space.

pr_name Specifies the name of the policy region in which tocreate the task library.


ExamplesThe following example creates a task library namedmy_tasks in thepolicy regionbald-region:wcrttlib my_tasks bald-region

See Alsowcrtjob , wcrttask

wdate


Com

mands

wdatePrints the current date and time of the managed node.

Syntaxwdatehost_name

DescriptionThewdatecommand prints the current date and time (Greenwich meantime [GMT]) of the managed node specified byhost_name. The date isprinted in the locale-dependent format.

Optionshost_name Specifies the name of the host whose date to print.


ExamplesThe following example shows the current date and time of the managednodebald:wdate baldMon Nov 21 16:27:09 GMT 1998

See Alsowdiskspace, whostid, wifconfig, winstdir , winterp , wmannode,wmemsize, wping, wtimezone, wuname, wxterm

wdel

1–224 Version 3.7.1

wdelDeletes objects from the Tivoli database.

Syntaxwdel [–I] label…

DescriptionThewdel command deletes one or more objects. Thewdel command isintended for low-level administration of the Tivoli object database. Thedefault is for the command to fail if a suboperation fails. Tivoli providesthe following commands for commonly performed actions:

wdelep Deletes an endpoint from the Tivoli database.

wdeljob Deletes a job from a task library.

wdelpol Deletes a default policy object.

wdelpr Deletes a policy region.

wdelrealm Deletes an HTTP realm.

wdelsched Removes a job from the scheduler.

wdeltask Deletes a task from the task library.

wrmnode Removes a managed node from the Tivoli database.

Options–I Ignores all failed suboperations, allowing the command

to continue. This option is useful only when multiplelabels are passed to the command. The–I option allowsa deletion to fail for individual objects, but thecommand continues to the next object to be deleted.Without this option, if a deletion fails for an individualobject, the command restores any objects alreadydeleted, and then the command terminates with error.

label… Specifies the label of the object to be deleted. Thelabeloption can be either an object path or a registered name.An object path can be an absolute path (starting at the

wdel


Com

mands

“ /” collection), a relative path (relative to the currentworking collection), or a simple name (to be found inthe current working collection).


ExamplesThe following example deletes the profile managerpm2 from thesevenup-region policy region using its absolute path:wdel /Administrators/vwilburn/sevenup-region/pm2

See Alsowdelep, wdelgate, wdeljob, wdelpol, wdelpr, wdelrealm, wdelsched,wdeltask, wrm , wrmnode

wdelep

1–226 Version 3.7.1

wdelepDeletes an endpoint.

Syntaxwdelep [–d] ep_name

DescriptionThewdelepcommand deletes the endpoint specified byep_namefromthe Tivoli database. Using the–d option stops the lcfd daemon runningon the endpoint.

Note: If you are deleting an endpoint from a managed, one-wayinterconnected Tivoli management region, you must firstunsubscribe the endpoint from all profile managers in themanaging region. Use thewlssub command to list all profilemanagers to which the endpoint subscribes. Use thewunsubcommand from the managing region to delete all the endpoint’ssubscriptions.

Options–d Deletes thelcf.dat file from the endpoint system and

shuts downlcfd.exe.

ep_name Specifies the name of the endpoint to be deleted.

Authorizationsenior or super in the endpoint’s policy region

ExamplesThe following example deletes endpointruby :wdelep ruby

See Alsowep, wlssub, wunsub

wdelgate


Com

mands

wdelgateDeletes an endpoint gateway.

Syntaxwdelgategateway_name

DescriptionThewdelgate command deletes the endpoint gateway specified bygateway_name.

Optionsgateway_nameSpecifies the name of the gateway to be deleted.

Authorizationsenior

ExamplesThe following example deletes gatewaygems:wdelgate gems

See Alsowcrtgate

wdeljob

1–228 Version 3.7.1

wdeljobDeletes a job from a task library.

Syntaxwdeljob job_name lib_name

DescriptionThewdeljob command deletes a job from the task library.

Optionsjob_name Specifies the name of the job to be deleted.

lib_name Specifies the name of the task library where the jobresides.

Authorizationadmin, super, senior

ExamplesThe following example deletes jobdate_job from task librarymy_tasks:wdeljob date_job my_tasks

See Alsowcrtjob , wdeltask

wdelpol


Com

mands

wdelpolDeletes a default policy object.

Syntaxwdelpol [–d | –v] class name

DescriptionThewdelpol command deletes the specified policy default object orpolicy validation object for the resource with the specified label.

Options–d Deletes the resource’s policy default object. This option

is the default if–v is not specified.

–v Deletes the resource’s policy validation object.

class Specifies the label of the class of managed resourcewhose policy object is to be deleted.

name Specifies the name of the policy object that is to bedeleted.


ExamplesThe following example deletes the restricted policy validation object forProfileManager:wdelpol –v ProfileManager Restricted

See Alsowchkpol, wcrtpr , wdelpr, wgetdfpol, wgetpolm, wlspol, wlspolm,wputpolm

wdelpr

1–230 Version 3.7.1

wdelprDeletes a policy region.

Syntaxwdelpr region

DescriptionThewdelpr command deletes the policy region specified in theregionoption.

Optionsregion Specifies the policy region to be deleted. The policy

region must be empty.

AuthorizationThesenior role in the policy region to be deleted

ExamplesEach of the following examples deletes theDefaultRegion policyregion:wdelpr /Regions/DefaultRegion

wdelpr @PolicyRegion:DefaultRegion

wdelpr @DefaultRegion

See Alsowcrtpr

wdelrealm


Com

mands

wdelrealmDeletes a registered HTTP 1.0 authentication realm. The HTTP daemonmust be restarted before the realm is actually deleted.

Syntaxwdelrealm –dRealmDir

DescriptionThewdelrealm command removes a registered authentication realmfrom the list of HTTP realms that are administered by the HTTPdaemon. The HTTP daemon must be restarted before the realm isactually deleted.

Options–d RealmDir Specifies the realm directory relative to the Common

Gateway Interface (CGI) base directory.


ExamplesThe following example removes the authentication realm/cgi-bin/MyDir from the HTTP daemon’s list of authentication realms:wdelrealm –d /cgi-bin/MyDir

See Alsowcrtpr , wlsrealms, wstarthttpd , wstophttpd

wdelsched

1–232 Version 3.7.1

wdelschedRemoves jobs from the scheduler.

Syntaxwdelsched [–b 'mm/dd/yyyy hh:mm' ] [–a 'mm/dd/yyyy hh:mm' ]

wdelsched [–s id [–s id]…]

DescriptionThewdelsched command removes jobs from the scheduler. If nooptions are specified, information on all jobs is removed. The–aand–boptions are used to delimit jobs that fall within certain time ranges. The–s option is used to specify jobs by their ID number.

Options–a 'mm/dd/yyyy hh:mm'

Specifies jobs that are scheduled to execute after thistime.

–b 'mm/dd/yyyy hh:mm'Specifies jobs that are scheduled to execute before thistime.

–s id… Specifies the job ID.

Authorizationsuper, senior, admin

Examples1. The following example deletes all jobs scheduled to run before

May 6, 1998, at 1:00 a.m. and after May 8, 1998, at 1:00 p.m.:

wdelsched –b '05/06/1998 01:00' –a '05/08/1998 13:00'

2. The following example deletes job IDs 876 and 934:

wdelsched –s 876 –s 934

wdelsched


Com

mands

See Alsowedsched, wenblsched, wgetsched, wschedjob, wstartsched

wdeltask

1–234 Version 3.7.1

wdeltaskDeletes a task from a task library.

Syntaxwdeltask task_name lib_name

DescriptionThewdeltask command deletes a task from a task library.

Optionslib_name Specifies the name of the task library where the task

resides.

task_name Specifies the name of the task to be deleted.


ExamplesThe following example deletes taskdate_task from task librarymy_tasks:wdeltask date_task my_tasks

See Alsowcrttask, wdeljob

wdepot


Com

mands

wdepotManages MDist 2 repeater depots, which are repositories that storeMDist 2 distributions (either temporarily or permanently).

Syntaxwdepot repeater_nameadd " id^version" [src_host:]path_name

wdepot repeater_namedelete "id^version"" filter"

wdepot repeater_namedescribe

wdepot repeater_nameimage "id^version" [src_host:]path_nameimage_dir

wdepot repeater_namelist [" filter" ] [–l]

wdepot repeater_namepurge

DescriptionThewdepot command manages MDist 2 repeater depots. Thiscommand provides the ability to add segments to depots, delete depotentries, display depot configuration information, create distributionimages, list existing depots, and purge depot entries.

Optionsadd " id^version" [src_host:]path_name

Adds an entry to the depot with the specified segment.Options are as follows:

" id^version" Specifies the ID and the version of thefile segment. Separate the ID andversion with a caret(^) symbol if itcontains spaces. The following is anexample:

"Tivoli^3.7.1"

path_name Specifies the complete path and filename of the source file. OnWindows NT or Windows 2000systems, if the path name contains a

wdepot

1–236 Version 3.7.1

drive letter (for example,C:\), thesrc_host option must be specified.

src_host Specifies the host name for the sourcefile. If not specified, it defaults to thelocal host.

delete "id^version" " filter"Deletes entries (specified by filter) that are currentlylocked by distributions in the repeater’s queue." id^version" specifies the ID and the version of the filesegment. Before deletion, thewdepot deletecommandprompts the user for confirmation. Thefilter optionsupports wildcard characters, such as the asterisk (*).

describe Displays the configuration settings of the depot,including location, size, temporary storage, permanentstorage, total storage, and free space. These options canbe changed with thewmdist command.

image "id^version" [src_host:]path_name image_dirCreates a distribution image for use when installingfrom a file server or CD. Options are as follows:

" id^version" Specifies the ID and the version of thefile segment. Separate the ID andversion with a caret (^) symbol if itcontains spaces. The following is anexample:

"Tivoli^3.7.1"

src_host Specifies the host name for the sourcefile. If not specified, it defaults to thelocal host.

path_name Specifies the complete path and filename of the source file. OnWindows NT or Windows 2000systems, if the path name contains adrive letter (for example,C:\), thesrc_host option must be specified.

image_dir Specifies the complete path of the

wdepot


Com

mands

image directory, where the image willbe created.

list [" filter" ] [–l]Lists all entries in a depot. Use this option to view howmuch disk space the segments are occupying or todecide whether any segments are no longer needed.You might also list the contents of a depot to remindyourself what you preloaded in it or to verify that thedata is still there. Options are as follows:

" filter" Specifies the entries to be listed. If nofilter is specified, thewdepot listcommand lists all entries in the depot.Thefilter option also supportswildcard characters, such as theasterisk (*).

–l If present, the–l option lists allinformation for each entry. Otherwise,the list option lists the followinginformation only: ID, version, size,percentage completed, and lastmodification time.

purge Deletes all entries in the depot, excluding activedistributions. The user is prompted for confirmationbefore the depot is purged. To delete activedistributions in a repeater’s queue, see thewmdistcommand.

repeater_nameSpecifies the label, object ID, or managed node ID of arepeater.

AuthorizationTheadd, delete, image, andpurge options require theadminauthorization role. Thedescribe andlist options require any Tivoliauthorization role.

wdepot

1–238 Version 3.7.1

Examples1. The following example adds an entry with IDTivoli and version

3.7.1to the depot of repeaterbanshee. The source host isseesaw,and the path name is/data.

wdepot banshee add "Tivoli^3.7.1" seesaw:/data

2. The following example lists all the contents in the depot of repeaterbanshee:

wdepot banshee list

3. The following example lists detailed information for theprogram_a_install depot entry with versionver1 on thebansheerepeater:

wdepot banshee list "program_a_install^ver1" -l

4. The following example lists all entries and entry versions startingwith the characterT in the depot of repeaterbanshee:

wdepot banshee list "T*"

5. The following example lists detailed information for the depot ofrepeaterbanshee:

wdepot banshee list -l


Entry #1:Id: program_a_installVersion: ver1Bytes received: 6755840(100%)Location: /net/futura/programs/proram_a.tar.gzCreation time: 2000/04/04 14:11:31Last modification time:2000/04/04 14:11:31Receive time: 2000/04/04 14:11:31Last access time: 2000/04/04 14:11:31Update time: 2000/04/04 14:11:31Access count: 0Modification count: 1Reference count: 1Storage status: Permanent

wdepot


Com

mands

Entry #2:Id: program_a_dataVersion: ver1Bytes received: 13511680(100%)Location: /data/program_a_data.tar.gzCreation time: 2000/04/18 14:08:46Last modification time:2000/04/18 14:08:46Receive time: 2000/04/18 14:08:46Last access time: 2000/04/18 14:08:46Update time: 2000/04/18 14:08:46Access count: 0Modification count: 1Reference count: 0Storage status: Permanentroot@reality>

Note that if you do not specify the–l option, only the ID, version,size, percentage completed, and last modification time aredisplayed.

6. The following example deletes entries starting with the characterT from the depot of repeaterbanshee:

wdepot banshee delete "T*"

7. The following example displays the configuration of the depot ofrepeaterbanshee:

wdepot banshee describe


Depot Location = /usr/local/Tivoli/rpt_dir/depot/Depot Size = 512000 (KB)Temporary Storage = 0 (KB)Permanent Storage = 0 (KB)Total Storage = 0 (KB)Free Space = 512000 (KB)

8. The following example creates an image of theantivirus file onthebanshee repeater and transfers the image to theC:/datadirectory on a source host named seesaw:

wdepot banshee image "Tivoli^3.7.1" seesaw:C:/temp/antivirusC:/data

See Alsowmdist

wdisconn

1–240 Version 3.7.1

wdisconnDisconnects two Tivoli management regions.

Syntaxwdisconn [–s] region_name

wdisconn [–s] –r region

DescriptionThewdisconn command disconnects two Tivoli management regions.Disconnecting regions after they have exchanged resources is atime-consuming process and should be done with care. Keep in mindthatwdisconn removes only Tivoli management region resources. Toremove any objects in collections and to ensure database consistency,always runwchkdb –ux after disconnecting Tivoli managementregions.

Options–r region Specifies the number of the remote Tivoli management

region. This option is required if the region’s name isnot available.

–s Specifies that the connection to be broken is a one-wayconnection. Do not attempt to connect the other Tivolimanagement region server. You might use this option ifyou inadvertently specified both ends of a one-wayconnection as the managing server or if you specifiedthe same region number for both ends of a connection.This option disconnects one end of the connectionwithout impacting the other end. You can thenreconnect the Tivoli management region using thecorrect information.

region_name Specifies the name of the remote Tivoli managementregion. The name of a region is the same as that of theinitial policy region created when the server wasinstalled.

wdisconn


Com

mands

Authorizationsuper

Examples1. The following example disconnects region number4000447345

from the local Tivoli management region:

wdisconn –r 4000447345

2. The following example disconnects the Tivoli management regionwriters-Region from the local region. Only thewriters-Regionregion is disconnected.

wdisconn –s writers-Region

See Alsowchkdb, wconnect, wlsconn, wupdate

wdiskspace

1–242 Version 3.7.1

wdiskspacePrints the number of free kilobytes available in the specified directory(file system) of the specified managed node.

Syntaxwdiskspacehost_name directory

DescriptionThewdiskspace command prints the amount of free disk space inkilobytes in the specified directory (file system) of the specifiedmanaged node.

Optionsdirectory Specifies the directory in which to check for free disk

space. The directory must be specified as an absolutepath.

host_name Specifies the managed node on which to check for freedisk space.


ExamplesThe following example shows the available disk space in the/tmpdirectory on managed nodebald:wdiskspace bald /tmp11747

See Alsowdate, whostid, wifconfig, winterp , wmannode, wmemsize, wping,wtimezone, wuname, wxterm

wdistrib


Com

mands

wdistribDistributes one or more profile copies.

Syntaxwdistrib [–l maintain | over_all | over_opts | over_all_no_merge][–m] [–r] name [subscriber…]

DescriptionThewdistrib command distributes one or more copies of a profile to itsprofile manager’s subscribers. The command updates subscriberdatabases and configuration files from the Tivoli database. Thenameoption specifies the profile to distribute or the profile manager fromwhich all profiles will be distributed. The subscribers to distribute to arespecified insubscriber. If no subscribers are specified,wdistrib updatesall subscribers.

If the –m option is specified, profiles are distributed to all levels ofsubscribers. If–m is not specified, profiles are distributed to only thenext level of subscribers.

The–l option identifies the distribution level. If–l is not specified, thedefault ismaintain.

Options–l maintain | over_all | over_opts | over_all_no_merge

Specifies the distribution level. Themaintain optionkeeps local modifications. Theover_all optionoverwrites local modifications. Theover_opts optionmerges and distributes all records. Theover_all_no_merge option distributes only thespecified profile.

–m Specifies a multistep distribution.

–r Sets the return code to 1 if at least one profiledistribution or retrieval to or from a profile managerfails.

wdistrib

1–244 Version 3.7.1

name The name of the profile to be distributed or the profilemanager from which all profiles are distributed. Validformats for thename option are as follows:

■ @ProfileType:prof_name


subscriber… Specifies the names of the Tivoli resources to which todistribute a profile copy. Valid formats for thesubscriber option are as follows:

■ @ManagedNode:node_name



Examples1. The following example distributes profiles contained in the

Development profile manager to all subscribers of that profilemanager. Any local modifications to this profile are maintained.

wdistrib /Regions/Development

2. The following example distributes theAdmin user profile tosubscriberspinatubo, rushmore, and to profile managerMarketing . The profile is not distributed to subscribers ofMarketing . All local changes are overwritten by this distribution.

wdistrib –l over_all @UserProfile:Admin pinatubo \rushmore @ProfileManager:Marketing

3. The following example distributes theAdmin user profile to thesubscribing profile managerSales. The profile is furtherdistributed to endpoints or profile managers that subscribe toSales.

wdistrib –m @UserProfile:Admin @ProfileManager:Sales

wdistrib


Com

mands

See Alsowcrtprf , wcrtprfmgr , wgetprf, wgetsub, wlssub, wpopulate, wsub,wunsub, wvalidate

wdisttask

1–246 Version 3.7.1

wdisttaskControls the distribution of task binaries for a task library.

Syntaxwdisttask –q library_name

wdisttask –slibrary_name mode

wdisttask –d library_name task_name

DescriptionThewdisttaskcommand can query or set the distribution mode of a tasklibrary or can force a distribution of the binaries for a task to occur.

Task binaries can remain on the Tivoli management region server of thelocal region (ALI mode), be distributed to all file servers in the localregion (LOCAL mode), or be distributed to all file servers in everyconnected region (GLOBAL mode). You should use the GLOBALdistribution mode only when a Tivoli-based application requires that thetask binaries reside on a local file system. A global distribution is aresource-intensive operation that temporarily slows down your network.

Options–d Forces the distribution of task binaries to occur

immediately.

–q Determines the distribution mode of a task library.

–s Sets the distribution mode of a task library.

library_name Specifies a task library.

mode Specifies the mode to be used to distribute a tasklibrary. The mode can be one of the following:

ALI Specifies that the task binaries bestored only on the Tivoli managementregion server for the local region.

GLOBAL Distributes copies of the task binariesto every file server in every connectedregion.

wdisttask


Com

mands

If you perform a global distribution totwo or more regions that share thesame file server, the distribution fails.

LOCAL Distributes copies of the task binariesto every file server in the local region.

task_name Specifies the task binaries to be distributed.

Examples1. The following example queries the distribution mode of the task

library namedabc:

wdisttask –q abcGLOBAL

2. The following example changes the distribution mode of the tasklibrary namedabc to distribute task binaries to the file servers ofthe local Tivoli management region only:

wdisttask –s abc LOCAL

3. The following example immediately distributes the binaries for thetask namedrm_core_files in theabc task library:

wdisttask –d abc rm_core_files

See Alsowcrttask, wgettask

wdskspc

1–248 Version 3.7.1

wdskspcVerifies the amount of disk space available. This command should berun from an endpoint. (Windows and NetWare)

Syntaxwdskspc [–q] [–f output_file] [–srequired_size] volume_label

DescriptionThewdskspc command returns the amount of available disk space onthe specified volume. If you specify the–soption, the command sets thereturn code of the command to zero if the required disk space is availableand to nonzero if not available. If you do not specify the–s option, thewdskspc command displays the total available disk space.

Thewdskspccommand detects and displays up to 2 GB on Windows 95platforms. Thewdskspc command proceeds uninterrupted if it detectsmore available space.

Options–f output_file Redirects any information or errors to the specified

output file.

–q Limits the information returned to the required oravailable disk space depending on whether the–soption is specified.

–srequired_sizeSpecifies the amount of disk space required. Therequired_size option can have any of the followingsuffixes:

k: kilobytesm: megabytesg: gigabytes

The total amount of available disk space is notdisplayed with this option.

wdskspc


Com

mands

volume_label Returns the amount of available disk space on thevolume or disk for the specified volume or disk.

Return Valueswdskspc returns one of the following when used with the–s option:

0 Indicates thatwdskspc was successful in identifyingthat the specified amount of disk space is available.

nonzero Indicates that the required disk space is not available.

Examples1. To check driveC for 10 MB of available disk space, enter the

following command:

wdskspc –s 10m C:\

2. To check the total disk space available on driveC, enter thefollowing command:

wdskspc C:\

3. To check theSYSvolume for 20 MB of available disk space on aNetWare machine, enter the following command:

wdskspc –s 20m SYS:

weditini

1–250 Version 3.7.1

weditiniModifies the groups, variables, and values in an.INI file. This commandshould be run from an endpoint.

Syntaxweditini [–r] –gsection_name[–nvariable_name] [–vvalue] file_name

DescriptionTheweditini command edits the contents of an.INI file. Using thiscommand, you can add a variable and value to a section of the file,remove a variable or section, or replace the value of a specified variable.

Options–gsection_name

Specifies the name of the section in the.INI file toprocess. If you add a variable to a section that does notexist, the section is created and the variable is added.

–n variable_nameSpecifies the variable name to add, replace, or remove.

–r Removes the specified section or variable.

–v value Specifies the value to add or replace for the variablespecified by the–n option.

file_name Specifies the full path of the file to edit.

Return Valuesweditini returns one of the following:

0 Indicates thatweditini successfully edited the.INI file.

nonzero Indicates thatweditini did not successfully edit the.INIfile.

weditini


Com

mands

Examples1. To add theDefaultDirectory variable to theUserSettingssection

in theC:\WINDOWS\SYSTEM.INI file and set its value toC:\WORK , enter the following command:

weditini –g UserSettings –n DefaultDirectory –v C:\WORK \C:\WINDOWS\SYSTEM.INI

2. To remove the groupUserSettings from theC:\WINDOWS\SYSTEM.INI file, enter the followingcommand:

weditini –r –g UserSettings C:\WINDOWS\SYSTEM.INI

See Alsowmrgini

wedsched

1–252 Version 3.7.1

wedschedEdits a job that currently exists in the scheduler.

Syntaxwedsched [–c 'time_period' | OFF] [ –C {daytime | nighttime |weekday | weekend} { from to | OFF}][ –D] [–d desktop… | OFF][–f file | OFF] [–h host] [–ggroup | OFF] [–m email | OFF][–l label] [–o] [–R 'time_period' | ' iterations' | OFF][–r ' time_period' | ' iterations' | OFF] [–t 'mm/dd/yyyy hh:mm' ] id

DescriptionThewedsched command allows administrators to edit a job thatcurrently exists in the scheduler. Administrators must know the ID of thejob to edit. This can be found by using thewgetsched command.

Options–c Specifies when a job is canceled. Valid options are as

follows:

' time_period' Specifies when a job is canceled if itdid not start as scheduled. You mustspecify a number (amount of time) anda unit of time. The unit of time must beminute, hour, or day. For example, ifyou specify'3 hour' , the job iscanceled 3 hours after its originallyscheduled start time if it has notalready started.

OFF Turns off the cancellation feature. Thejob is not canceled.

–C Specifies the conditions or restrictions under which thejob runs. Thefromoption can be either a starting day ora starting time. Theto option can be either an endingday or an ending time. Times must be entered using a24-hour clock (for example, 9:00 for 9 a.m. or 14:00 for

wedsched


Com

mands

2 p.m.). Days must be entered as numeric values whereSunday is 0 and Saturday is 6. Valid options are asfollows:

daytime from to | OFFSpecifies that the job runs only duringthe day. Specifying theOFF optionremoves this restriction.

nighttime from to | OFFSpecifies that the job runs only atnight. Specifying theOFF optionremoves this restriction.

weekdayfrom to | OFFSpecifies that the job runs only duringthe week. Specifying theOFF optionremoves this restriction.

weekendfrom to | OFFSpecifies that the job runs only onweekends. Specifying theOFF optionremoves this restriction.

–d Specifies whether aStatus dialog is displayed on adesktop when any action is performed on the job. Validoptions are as follows:

desktop… Specifies which desktop displays theStatus dialog when any action isperformed on the job. Multipledesktops can be specified.

OFF Specifies that theStatus dialog is notdisplayed when any action isperformed on the job.

–D Disables the job. The job remains in the scheduler butdoes not run until it is enabled.

–f Specifies whether the job status is written to file whenany action is performed on the job. Valid options are as

wedsched

1–254 Version 3.7.1

follows:

file Specifies the file to which the jobstatus is written when any action isperformed on the job. If a file isspecified, the–h option must be usedto specify a host on which the file is tobe written.

OFF Specifies that the job status is notwritten to a file.

–g Specifies whether the job status is sent to a Tivoli noticegroup when any action is performed on the job. Validoptions are the following:

group Specifies the notice group to which thejob status is sent when any action isperformed on the job. Multiple noticegroups can be specified.

OFF Specifies that the job status is not sentto a notice group.

–h host Specifies the host on which the job status file is to bewritten. Must be used with the–f option.

–l label Specifies the name specific to this instance of the job.

–m Specifies whether the job status is sent to an e-mailaddress when any action is performed on the job. Validoptions are as follows:

email Specifies the e-mail address to whichthe job status is sent when any action isperformed on the job. Multiple e-mailaddresses can be specified.

OFF Specifies that the job status is not sentto an e-mail address.

–o Specifies that the time indicated in the–t option is in thepast. Overrides the warning message.

–r Specifies the repeat information. If theiterationsoptionis specified, the job repeats for a finite number of times.

wedsched


Com

mands

One of the following options must be specified:

' time_period' Specifies how often a job is repeated.You must specify a number (amount oftime) and a unit of time. The unit oftime must beminute, hour, day,week, month, oryear. For example, ifyou specify'3 hour' , the job isrepeated every 3 hours.

' iterations' Specifies how many times a job isrepeated. You must specify an amountof time, a unit of time, and a number oftimes to repeat. The unit of time mustbeminute, hour, day, week, month,or year. For example, if you specify'3 hour 6' , the job is repeatedevery 3 hours until it has been repeatedsix times.

OFF Turns off the repeat feature. The job isnot repeated.

–R Specifies the retry information. If theiterationsoptionis specified, the job retries for a finite number of times.One of the following options must be specified:

' iterations' Specifies how many times a job isretried. You must specify an amount oftime, a unit of time, and a number oftimes to retry. The unit of time must beminute, hour, or day. For example, ifyou specify'3 hour 6' , the job isretried every 3 hours until it has beenretried six times.

' time_period' Specifies how often a job is retried.You must specify a number (amount oftime) and a unit of time. The unit oftime must beminute, hour, orday.For example, if you specify

wedsched

1–256 Version 3.7.1

'3 hour ', the job retries every 3hours until it completes successfully.

OFF Turns off the retry feature. The job isnot retried if it fails to completesuccessfully.

–t 'mm/dd/yyyy hh:mm'Specifies the time the job is scheduled to initiallyexecute. You can enter the date and time in either order.You can also enter only the date or only the time. If youenter the time without a date, the job executes at thespecified time on the current date. If you enter the datewithout a time, the job executes at the current time onthe specified date. Times must be entered using a24-hour clock (for example, 9:00 for 9 a.m. or 14:00 for2 p.m.).

id Specifies the job ID.


Examples1. The following example changes the start time of job 782 to 6:00

p.m., November 30, 1998. (Use thewgetsched command to findthe job ID.)

wedsched –t '18:00 11/30/1998' 782

2. The following example edits job 35. The example turns off thecancellation feature and sets the retry for one day after each failure.The job status is not written to a file but is sent to the TivoliDiagnostics notice group.

wedsched –c OFF –R '1 day' –f OFF \–g 'Tivoli Diagnostics' 35

3. The following example edits job 728 to run every Monday throughFriday:

wedsched –r '1 day' –C 'weekday 1 5' 728

wedsched


Com

mands

4. The following example changes the restrictions on job 28 fromweekends (Saturday and Sunday) to weekdays (Monday throughFriday).

wedsched –C 'weekend OFF' –C 'weekdays 1 5' 28

See Alsowdelsched, wenblsched, wgetsched, wschedjob, wstartsched

wenblsched

1–258 Version 3.7.1

wenblschedDisables or enables scheduled jobs.

Syntaxwenblsched [–b 'mm/dd/yyyy hh:mm' ] [–a 'mm/dd/yyyy hh:mm' ] [–d]

wenblsched [–s id [–s id]…] [–d]

DescriptionThewenblschedcommand allows an administrator to disable or enablescheduled jobs. When a job is disabled it does not execute. If no optionsare specified, all jobs are enabled or disabled. The–aand–b options areused to delimit jobs that fall within certain time ranges. The–soption isused to specify jobs by their ID number. The–doption is used to disablescheduled jobs.




–d Specifies to disable jobs.

–s id… Specifies the job ID. You can specify more than one ID.


Examples1. The following example enables all jobs scheduled to run before

May 6, 1998, at 1:00 a.m. and after May 8, 1998, at 1:00 p.m.

wenblsched –b '05/06/1998 01:00' –a '05/08/1998 13:00'

wenblsched


Com

mands

2. The following example disables job IDs 529 and 734:

wenblsched –s 529 –s 734 –d

See Alsowdelsched, wedsched, wgetsched, wschedjob, wstartsched

wep

1–260 Version 3.7.1

wepPerforms actions on endpoint information contained in the endpoint list.

Syntaxwep

wepep_label

wepep_labelget {suboptions}

wepep_labelmigrate [–f] gw_label

wepep_labelset {suboptions}

wepep_labelset_label[–s] new_label

wepep_labelstatus

wepep_labelupgrade { disable | enable}

wep help[option]

wep ls [–d delimiter][–ggw_label][–i suboptions]

wep migrate_to_pref{ –a | –d | –n} [ –f] [–ggw_label]

wep set gateway {–eep_label | –g gw_label}

wep set interfaces {–eep_label | –ggw_label} gw_label+port[:gw_label+port]…

wep sync_gateways

Advanced Options

wep boot_method addtag prototype_object method_name ep_oid…

wep boot_method listtag ep_oid…

wep boot_method removetag ep_oid…

wep boot_method testtag ep_oid…

wep delep_oid gw_label…

wep viewep_oid gw_label…

Note: Advanced options are described on page 1-267.

DescriptionThewep command performs actions on the endpoint informationcontained in the endpoint list maintained by the endpoint manager.

wep


Com

mands

Using this command, you can list the endpoints in a Tivoli managementregion and their assigned gateway, retrieve and set endpointinformation, migrate an endpoint from one gateway to another, orupdate other endpoint data within a Tivoli management region.

Thewepep_labelget command gets information for the specifiedendpoint, thewep ls –ggw_label command gets information for thespecified gateway and its endpoints, and thewep lscommand getsinformation for all endpoints on multiple gateways.

Note: When specifying the OID of an endpoint, remember to appenda plus sign (+) as shown in “Examples”.

Optionsget {suboptions…}

Retrieves the following information from the endpointlist for the endpoint namedep_label.

Note: You can shorten an attribute name, but theabbreviation must be unambiguous. Forexample, you can typelast_l forlast_login_time, but notlast.

Suboptions are as follows:

address Gets the network address.

all Gets all attributes for the specifiedendpoint.

gateway Gets the assigned gateway.

httpd Gets the HTTP password. The HTTPpassword is used to modify endpointinformation through a Web browser.

id Gets the unique inventory identifier forthe specified endpoint.

interp Gets the interpreter type or operatingsystem running on the specifiedendpoint.

label Gets the endpoint label.

wep

1–262 Version 3.7.1

last_login_timeGets the last login time of an endpoint.

last_method_timeGets the time of the last method call onan endpoint.

last_migration_timeGets the last time the endpointmigrated.

login_mode For Windows systems only, displayswhether the endpoint is enabled tocontrol distributions using the TivoliMobile Computing console. If theendpoint is operating in mobile mode,the endpoint is enabled. If the endpointis operating in desktop mode, it is notenabled. This option also displayswhether the user can change theendpoint mode.

Note: To change an endpoint’s modeor to enable a user to changethe mode of an endpoint, usethewepep_labelsetlogin_mode command.

netload Displays the current netload setting.

object Displays the object ID of the specifiedendpoint.

policy Displays the policy region in which theendpoint resides. If you have not addedthe endpoint to a policy region, theresult of this command isOBJECT_NIL.

preferred_gatewayDisplays the preferred gateway for theendpoint. If there is no preferred

wep


Com

mands

gateway for the endpoint, thiscommand results in OBJECT_NIL.

protocol Displays the network protocol used bythe endpoint.

upgrade_modeDisplays whether the endpoint isenabled or disabled for upgrades.

help [get | set | del | migrate | upgrade]Displays the usage statement for thewepcommand. Ifyou specify a wep option, such aswep help get, listshelp for the specified option.

ls [–d delimiter][–ggw_label][–i suboptions…]Lists information for gateways and their associatedendpoints. Options are as follows:

–d delimiter Changes the delimiter used indisplaying data with the–i option. Thedefault delimiter is a comma.

Note: The HTTP password fielddoes not contain tabs but cancontain commas or othercommonly used delimiters.

–ggw_label Displays information only for thegateway specified bygw_labeland itsendpoints.

–i {suboptions…}Retrieves additional information fromthe endpoint list for gateways andassociated endpoints. Use suboptionslisted for thewep get option. Forsuboptions and their descriptions, seethewep get option on page 1-261.

Note: You can shorten an attributename, but the abbreviationmust be unambiguous. Forexample, you can typelast_l

wep

1–264 Version 3.7.1

for last_login_time, but notlast.

migrate [–f] gw_labelMigrates an endpoint from its assigned gateway to thegateway specified bygw_label. There is no contact withthe endpoint. The endpoint detects that it was migratedthe next time that there is communication between theendpoint and a gateway. Specifying the–f option forcesthe migration of an endpoint even if the gateway isdown.

migrate_to_pref {–a | –d | –n}[ –f] [–ggw_label]Migrates endpoints to their preferred gateway if thegateway is available. This migration is similar to thewepep_labelmigrate command. There is nocommunication with the endpoint. Only endpointmanager and gateway data are updated.

–a Causes all endpoints to migrate to theirpreferred gateway.

–d Displays a list of endpoints notcurrently assigned to their preferredgateway, but does not migrate.

–f Forces migration, even if the preferredgateway is down.

–ggw_label Restricts migrations to the preferredgateway specified bygw_label.

–n Causes all nonmobile endpoints tomigrate to their preferred gateway.

set {suboptions…}Sets the following information for the endpoint namedep_label.

Note: You can shorten an attribute name, but theabbreviation must be unambiguous. Forexample, you can typelast_l forlast_login_time, but notlast.

wep


Com

mands

Suboptions are as follows:

addressep_addressChanges the IP address of an endpoint.

httpd [user:password]Sets the HTTP password for thespecified endpoint. The HTTPpassword is used to modify endpointinformation through a Web browser.You must use thesync_gatewaysoption to synchronize changes betweenthe endpoint, gateway, and endpointmanager after making passwordchanges.

login_mode –m [mobile | desktop] –s [variable |constant]

For Windows endpoints only with theTivoli Mobile Computing consoleinstalled, sets the operating mode ofthe endpoint specified byep_label.Specify the–m mobile option todesignate an endpoint as mobile. Thisoption allows a user at the specifiedendpoint to receive and controlMDist 2 distributions through theconsole. Specify the–m desktopoption to disable console functions onthe endpoint.

Note: To synchronize changes withthe gateway when settinglogin_mode, use thesync_gateways option.

Use the–soption to allow or prohibitusers from changing the login mode ofan endpoint. Specify the–s variableoption if you want the endpoint to beable to change its login mode. If youspecify the–s constant option,

wep

1–266 Version 3.7.1

changes to the login mode are ignored.For more information about the TivoliMobile Computing console, see theTivoli Management Framework User’sGuide.

preferred_gateway [gw_label | nil ]Sets the preferred gateway field to thespecified gateway. Usenil to clear anendpoint’s preferred gateway.

upgrade_mode [enable | disable]Sets whether the endpoint isupgradable.

set gateway {–eep_label | –ggw_label}Informs the endpoint of its currently assigned gateway.Use the–e option to update the endpoint specified byep_label. Use the–g option to update all endpointsassigned to the gateway specified bygw_label.

set interfaces {–eep_label | –ggw_label} gw_hostname+portgw_IP_address+port [:gw_hostname+port|:gw_IP_address+port]…

Sets the address and port of one or more gateways towhich an endpoint can log in. This set of interfacesbecomes the endpoint’s list of gateways that theendpoint contacts when it becomes isolated. Use the–e option to invoke this command on the endpointspecified byep_label. Use the–goption to invoke thiscommand on all the endpoints assigned to the gatewayspecified bygw_label. You can specify more than onegateway address. Multiple addresses must be separatedby colons.

set_label [–s] new_labelChanges the current label (ep_label) of an endpoint to anew label specified bynew_label.Use the–soption tosync the endpoint’s gateway and update the endpointwith the new label. This command contacts theendpoint.

wep


Com

mands

status Lists the status of the specified endpoint. An endpoint’sstatus consists of either “alive” or “endpoint may beunreachable” if the status could not be determined. Thiscommand contacts the endpoint.

sync_gatewaysSynchronizes the endpoint data stored by the endpointmanager, gateways, and endpoints within a Tivolimanagement region. If you make changes to anendpoint’s HTTP password or policy region or decideto use one of the commands listed in “AdvancedOptions” on page 1-267, you must use this option forupdates to take effect. This option is useful as part of abatch file that uses the job scheduler function toschedule several endpoint data updates at once.

Note: To change the policy region of an endpoint, usethewmv command.

upgrade {disable | enable}Specifies whether the endpoint is upgradable.

ep_label Identifies the endpoint on which otherwepsuboptionsare run. Without suboptions,wepep_labeldisplays allinformation for the endpoint in a tabular format.

Advanced Options

If you are not explicitly familiar with the advanced implications of thewepcommand, call your Customer Support provider before attemptingto perform any of the followingwep operations:

del ep_oid gw_labelDeletes the endpoint from anepmgr.bdb file. Becausethere are separate.bdb files for each gateway, it isnecessary to specify the endpoint’s assigned gateway.gw_labelcan be found by issuing thewep lscommand.Thewep del command does not completely delete allreferences to the endpoint. To delete all references to anendpoint, use thewdelep command.

view ep_oid gw_labelDisplays endpoint information stored in the.bdb fileassociated with the gateway and located in the

wep

1–268 Version 3.7.1

$DBDIR/epmgr.bdb directory. Unlike thewepep_label command, thewep view command does notsearch the endpoint manager’s internal cache.gw_labelcan be found by issuing thewep ls command.

The following commands are used to configure boot methods created byapplication developers (using Tivoli Application DevelopmentEnvironment [ADE]) to run on an endpoint. Use these options toconfigure boot methods during the installation of an endpoint or duringthe distribution of application profiles. These methods run every time anendpoint logs in to a gateway.

boot_method addtag prototype_object method_name ep_oid…Adds the specified boot method to the endpoint, where:

tag Specifies the user specified name.

prototype_objectSpecifies the prototype object’s identificationnumber, which implements the method.

method_nameSpecifies the name of the method.

ep_oid…Specifies the object identification (OID) number ofone of several endpoints on which the method willrun. Separate OID numbers with spaces.

boot_method listtag ep_oidLists the prototype object number and method name ofthe specified boot method on the endpoint.

boot_method removetag ep_oid…Removes the specified boot method from the endpoint.

boot_method testtag ep_oidStarts the specified boot method on the endpoint.

Authorization■ To view endpoint information with thewepep_label, wep

ep_labelget, wep ls commands:user, admin, senior, orsuper

wep


Com

mands

■ To use thewep help [option] command:user, admin, senior, orsuper

■ To set the HTTP password, set an endpoint’s gateway or viewstatus with thewepep_labelset httpd, wep set interfaces –e, wepstatuscommands:senioror super in the endpoint’s policy region

To view the HTTP password, you must have theadmin role in theendpoint’s policy region.

■ To migrate an endpoint, view status, set all endpoints’ gateways orsynchronize endpoint data with thewep migrate, wep status, wepset interfaces –g, wep set gateway, wep sync_gatewayscommands:senior or super in the Tivoli management region

Examples1. The following example lists the endpoints assigned to the

jadams–gateway:

wep ls –g jadams–gateway

1122334455.1.512 jadams–gateway1122334455.10.500+ cookU1122334455.11.500+ cookA1122334455.12.500+ jadams1122334455.13.500+ jadamsM1122334455.15.500+ jadamsG

2. The following example returns all information contained in theendpoint list regarding endpointcookG:

wep cookG

object 1196743040.13.517+#TMF_Endpoint::Endpoint#label ep7612id 001454ED4C00gateway 1196743040.1.578pref_gateway OBJECT_NILnetload OBJECT_NILinterp aix4-r1login_mode Endpoint is operating in desktop mode

User may not change endpoint modeprotocol TCPIPaddress garlic.dev.tivoli.com+7612+146.84.42.86policy OBJECT_NIL

wep

1–270 Version 3.7.1

httpd tivoli:@+`t<XIralias OBJECT_NILupgrade_mode Endpoint is operating in upgrade enabled

modelast_login_time 2000/11/17-11:11:08last_migration_time 2000/11/17-11:11:06last_method_time 2000/11/17-11:11:09

3. The following example returns the network address of endpointcookG:

wep cookG get lab,addresscookG,146.84.26.26+9494

4. The following example returns the randomly generated HTTPpassword for endpointcookG:

wep cookG get httpdtivoli:WBHtK'y3

where:

tivoli Represents the user name

: Is the separator

wBHtK’y3 Represents the password

5. The following example returns the prototype object and methodname of thetest18 boot method on endpoint1802218143.13.500:

wep boot_method list test18 1802218143.13.500+

Boot Method(s) for Endpoint 1802218143.13.500+TagPrototype ObjectMethod Nametest181802218143.13.500admin

6. The following example gets the current login mode on endpointmsistrunk:

wep msistrunk get login_modeEndpoint is operating in mobile modeUser may not change endpoint mode

7. The following example clears the preferred gateway on themsistrunk endpoint:

wep msistrunk set preferred_gateway nil

See Alsowdelep, wmdist, wmv

wepmgr


Com

mands

wepmgrProvides control and configuration for the endpoint manager.

Syntaxwepmgr [fsck | get | help | ping | restart | setattribute…| start | stop |test_labelep_label| update]

DescriptionThewepmgr command provides control and configuration for theendpoint manager. With this command, you can start, stop, and restartthe endpoint manager. In addition, this command gets and sets endpointmanager attributes in the Tivoli object database to control endpointlogin.

Optionsfsck Rewrites the data in the Tivoli name registry endpoint

resource from the endpoint data in the endpointmanager.

get Returns a list of endpoint manager object attributes.

help [attribute] Displays the usage statement for thewepmgrcommandor information about the specified attribute.

ping Verifies that the endpoint manager is running.

restart Restarts the endpoint manager.

setattribute… Sets the endpoint manager object attributes in the Tivoliobject database. Use theget option to return a list ofthese attributes. Use theupdateoption for attributes totake effect immediately. Attribute values are as follows:

automigrate {off | on | nonmobile}Indicates whether endpoints should migrate to theirpreferred gateway when the gateway becomesavailable. This value defaults tooff, whichindicates that endpoints are not migrated to thepreferred gateway. To cause endpoints to migrate,

wepmgr

1–272 Version 3.7.1

setautomigrate to on or nonmobile. When agateway becomes available, any endpoints thathave that gateway as their preferred gatewaymigrate to the gateway.

Note: Mobile endpoints are excluded from thismigration if the attribute is set tononmobile. For endpoints that should beexcluded from automatic migration, usethewepep_label set preferred_gatewaycommand to clear the preferred gateway.

chk_cntl_charsWhen set to 1, disallows control characters inendpoint labels. Invalid endpoint labels aredetected in theallow_install_policy script. Youcan overwrite the existing label in this script. Thedefault value is 0. By default, endpoint labels arenot checked for control characters. For moreinformation, see “allow_install_policy” on page2-9.

epmgr_flagsWhen set to 1, recaptures orphaned endpointinformation. Orphaned endpoints are endpoints thatwere once a part of the Tivoli management region,but are no longer displayed inwep ls commandoutput. This can occur from a database restore, anaccidental deletion, or database corruption. Theendpoint is recaptured by the endpoint managerduring an isolation login attempt and a newdispatcher number is created for the endpoint. Thedefault value is 0.

invalid_charsSpecifies characters to be disallowed in an endpointlabel during the initial login. The default value is anempty list. Invalid endpoint labels are detected intheallow_install_policy script. You can overwritethe existing label in this script.

wepmgr


Com

mands

labelspace 'regular_expr'Defines the endpoint label name space and forcesendpoint labels to conform to a regular expressionduring initial login. Useregular_expr to specify aset of allowable characters for endpoint labels (forexample,'^[A-Za-z0-9$^_]*$' ). If a labeldoes not conform to the specified expression, thatendpoint cannot connect to the Tivoli managementregion. For more information, see“allow_install_policy” on page 2-9.

Note: Invalid endpoint labels are detected by theallow_install_policy script. You canoverwrite existing labels in this script.

login_interval [value]This interval is used by gateways and endpointmanagers and specifies a time value in seconds inwhich logins from the same network address areignored. This interval prevents the effects ofmultiple initial logins from the same endpoint. Thedefault value is 270 seconds. You must restart thegateways for a new setting to take effect.

In some cases, multiple logins are allowed withinonelogin_interval. For example, the logins afteran endpoint’s initial login request and after anupgrade are not ignored. For more informationabout endpoint logins, see theTivoli ManagementFramework Planning for Deployment Guide. Toturn off this login filter, setlogin_interval to 0.

max_afterSpecifies the number ofafter_install_policyscripts that can be run concurrently. The defaultvalue is 10.

max_iom_recordsSpecifies the number of endpoint entries in eachbatch that repopulates the name registry. This valueis used by thewepmgr fsckcommand.

wepmgr

1–274 Version 3.7.1

max_installSpecifies the number ofallow_install_policyscripts that can be run concurrently. The defaultvalue is 10.

max_sgpSpecifies the number ofselect_gateway_policyscripts that can be run concurrently. The defaultvalue is 10.

start Starts the endpoint manager.

stop Stops the endpoint manager.

test_labelep_label

Tests if a label conforms to the currently set labelspace.

update Refreshes the attributes in the running endpointmanager from the attributes on the endpoint managerobject in the Tivoli object database.


Examples1. The following example pings the endpoint manager to verify that

it is up and running:

wepmgr pingep_mgr is running.

2. The following example shows the result ofwepmgr get:

wepmgr getmax_install = 10max_sgp = 10max_after = 10login_interval = 0max_records = 500epmgr_flags = 0max_epmgr_rpc_threads = 250automigrate = offchk_cntl_chars = 0labelspace = ''invalid_chars = ''

wepmgr


Com

mands

3. The following example sets the endpoint managerlogin_intervalattribute to 0 seconds on the endpoint manager object in the Tivoliobject database. By default, endpoints send login requests at270-second intervals. If you reduce the number of secondsbetween endpoint initial login request attempts (usinglcfdudp_interval=seconds), you also should reduce the endpointmanager attribute so that endpoint login attempts are not filtered bythe gateways and endpoint managers. The following commandupdates the endpoint manager so that the attribute setting takeseffect on the running endpoint manager. Because this value is usedby gateways, you also need to restart gateways after issuing thiscommand.

wepmgr set login_interval 0wepmgr update

See Alsowep

wexpnotif

1–276 Version 3.7.1

wexpnotifExpires notices from a notice group.

Syntaxwexpnotif [–aage] ngroup

DescriptionThewexpnotif command expires notices from a notice group. Noticegroups typically have an associated expiration time. This command canbe used to force the expiration of notices before their usual expirationtime. If the–a option is specified, only notices older than the specifiedage are expired. If the–aoption is not specified, this command expiresall notices in the specified notice group immediately.

Options–aage Specifies that only notices older thanage are to be

expired.age is specified in hours. If this option is notspecified, all notices in the specified notice group areexpired immediately.

ngroup Specifies the notice group for which notices are to beexpired.

AuthorizationYou must have at least theseniorrole in the Tivoli management region.

ExamplesThe following example specifies that allTivoli Administration noticesshould be expired after 3 hours:wexpnotif -a 3 "Tivoli Administration"

See Alsowlsnotif, wsndnotif, wtailnotif

wgateway


Com

mands

wgatewayStarts, stops, or lists the properties of an endpoint gateway.

Syntaxwgateway

wgatewaygateway_name {describe | start | stop | restart | dbcheck |epact_dbcheck}

wgatewaygateway_nameadd_gatewayproxymanagednode_name

wgatewaygateway_nameget_gatewayproxies

wgatewaygateway_nameremove_gatewayproxymanagednode_name

wgatewaygateway_namereset_gatewayproxies

wgatewaygateway_name set_debug_levellevel

wgatewaygateway_name set_session_timeoutseconds

wgatewaygateway_name[add_protocolprotocol][get_method_trace_time] [rm_protocol IPX ] [set_ipx_portport][set_method_trace_timeseconds] [set_protocolsprotocol_list][set_tcp_portport]

DescriptionThewgatewaycommand starts a gateway, stops a gateway, or lists theproperties of the specified gateway. You can runwgateway to listgateway object identification numbers, names, and status within a Tivolimanagement region, as follows:wgateway

Object Name Status2002780303.1.524 tinman–gateway u

Status values are as follows:

d The gateway is not running.

D A communications error occurred. The objectdispatcher is down and possibly the computer as well.

u The gateway is running and responding to requests.

wgateway

1–278 Version 3.7.1

Optionsadd_gatewayproxy

Adds a managed node as an entry to the gatewayproxies list.

add_protocol [TCPIP | IPX ]Adds a supported protocol for the specified gateway.Supported protocols are TCP/IP (the default) and IPX.

dbcheck Synchronizes the gateway’s method cache with that onthe Tivoli management region server.

describe Lists the properties of the specified gateway. This is thedefault option.

epact_dbcheckChecks the consistency of theepact.bdb database.

get_gatewayproxiesDisplays the list of managed nodes that have beenadded to the named gateway.

get_method_trace_timeDisplays the resolution time in seconds for logging ofendpoint methods.

remove_gatewayproxyRemoves a managed node as an entry from the gatewayproxies list.

reset_gatewayproxiesClears the gateway proxies list.

restart Stops and restarts the specified gateway.

rm_protocol IPXRemoves the supported IPX protocol for the specifiedgateway. The TCP/IP protocol cannot be removed.

set_debug_levellevelDetermines the level (0 through 8) of messageinformation logged by the gateway. Levels are asfollows:

0 Errors. This is the default and recommended level.

1 Errors and warnings.

wgateway


Com

mands

2 Harmless exceptions.

3 Verbose communication information.

5 Verbose boot, database check, and endpoint logininformation.

6 Verbose upcall, downcall, and repeaterinformation.

7 Verbose job scheduler information.

8 Verbose gateway cache information.

Note: Level 4 does not exist.

set_ipx_portportSets the port number on which the specified gatewaylistens for IPX packets. The default port number is9494, but you should set your own value.

set_method_trace_timesecondsSpecifies the resolution time in seconds for logging ofendpoint methods. The default for value is 3600.

set_protocolsprotocol_listSets a supported protocol for the specified gateway.TCP/IP is the default.

set_session_timeoutsecondsDetermines the amount of time (in seconds) a gatewaywaits for a response from an endpoint after sending adowncall. The default is 300 seconds (5 minutes).

set_tcp_portportSets the port number on which the specified gatewaylistens for TCP/IP packets. The default port number is9494, but you should set your own value.

start Starts the specified gateway. Theoservrun commandstarts the object dispatcher from the NetWare console.

stop Stops the specified gateway. Theoservend commandstops the object dispatcher from the NetWare console.

gateway_nameIdentifies the name of the gateway.

wgateway

1–280 Version 3.7.1

Authorizationsenior

Examples1. The following example displays the results of thewgateway

command when the gateway uses IPX and TCP/IP protocols:

wgateway lux describe

Object : 1139479731.2.77#TMF_Gateway::Gateway#Protocols : TCPIP,IPXHostname : "lux"TCPIP Port : 9999IPX Port : 7787Timeout : 300

2. The following example displays the results of thewgatewaycommand when the gateway uses the TCP/IP protocol:

wgateway agodino-gateway describe

Object : 1139479731.1.644#TMF_Gateway::Gateway#Protocols : TCPIPHostname : "agodino"TCPIP Port : 6666Timeout : 300

3. The following example adds managed nodelradner as an entry tothe gateway proxies list of the NetWare gatewaylux:

wgateway lux add_gatewayproxy lradner

4. The following example displays the gateway proxy list of theNetWare gatewaylux:

wgateway lux get_gatewayproxies

See Alsowcrtgate, wdelgate, wrpt

wgetadmin


Com

mands

wgetadminLists information about a Tivoli administrator.

Syntaxwgetadmin [–n | –o | –p | –u [–i interp]] [name]

DescriptionThewgetadmincommand lists information about a Tivoli administratorto standard output. This command lists the administrator’s name, logins,roles, and notice groups. The administrator’s roles are listed by groups.If nameis not specified,wgetadmin lists the information of the currentadministrator.

Note: Thewgetadmin command does not show the user name orgroup name associated with the administrator. You must do thisfrom the desktop.

Options–i interp Resolves the user login name and group name of the

administrator using the interpreter specified ininterp.

–n Displays only the name of the administrator.

–o Displays only the object ID of the administrator.

–p Displays extended output for multiple notice groups.Appends the Tivoli management region namecorresponding to the notice groups listed. This ishelpful in an interconnected region environment.

–u Displays the user login name and the group name of theadministrator.

name Specifies the name of the Tivoli administrator whoseproperties to list.

wgetadmin

1–282 Version 3.7.1

AuthorizationYou must have at least theuser role to list information about anotheradministrator. Otherwise, you can only list the information about thecurrent administrator.

Examples1. The following example displays information about the

administrator currently logged in:

wgetadmin

2. The following example displays information about the specifiedadministrator:

wgetadmin callahan@sthelensAdministrator Steve Callahanlogins: callahan@sthelensroles: global user

DefaultRegion super, admin, userAdministrators super, seniorMyRegion super, senior, admin, user, backupSteve Callahan admin, user, rconnectsecurity_group_any_admin user

notice groups: Tivoli Authorization

See Alsowcrtadmin , wsetadmin

wgetallinst


Com

mands

wgetallinstDisplays all instances of a resource type.

Syntaxwgetallinst [–l] resource_type

DescriptionThewgetallinst command displays all instances of a resource type. Ifthe–l option is included, this command displays the resource type in theformat ‘ label oid’ .

wgetallinst is similar to thewlookup command. The difference is thatwlookup displays only those resource types registered in the nameregistry.wgetallinst displays both registered and unregistered resourcetypes, including resource types that are supersets of other resource types.For example,wgetallinst displays all instances of theProfileEndpointresource type, which includes instances of theProfileManager,ManagedNode, andNisDomain resource types.

Options–l Lists the instances in the format‘ label oid’ .

resource_type Specifies the resource type of the instances to bedisplayed.

ExamplesThe following example displays all instances of theProfileEndpointresource type:wgetallinst -l ProfileEndpoint

See Alsowlookup

wgetdfpol

1–284 Version 3.7.1

wgetdfpolLists a default policy object.

Syntaxwgetdfpol [–d | –v] class

DescriptionThewgetdfpol command lists the label of the default policy default orpolicy validation object for the resource with the specified label. Whena resource is added to a policy region as a managed resource, it receivesboth a default policy validation object and a default policy defaultobject. These defaults are predefined as part of the resource definition.A policy default object generates default values when creating objects ofa given resource type in a policy region. A policy validation objectimplements the checking of attribute values for the objects of a managedresource type in a policy region.

Options–d Lists the label of the resource’s default policy default

object. This option is the default if–v is not specified.

–v Lists the label of the resource’s default policyvalidation object.

class Specifies the type of managed resource whose defaultpolicy object’s label is to be listed.


ExamplesThe following example returns the name of the default policy defaultobject for theProfileManager class.wgetdfpol -d ProfileManager

wgetdfpol


Com

mands

See Alsowchkpol, wcrtpol , wcrtpr , wdelpol, wdelpr, wgetpolm, wlspol,wlspolm, wputpolm

wgeteppol

1–286 Version 3.7.1

wgeteppolLists the body and constant values of an endpoint policy script.

Syntaxwgeteppolpol_name

DescriptionThewgeteppol command lists the contents of the specified endpointpolicy script. You can modify the script to meet the needs of yourorganization. The endpoint policy scripts areallow_install_policy,after_install_policy, login_policy, andselect_gateway_policy. Formore information, see “Endpoint Policy” on page 2-1.

If you have not added an endpoint policy script yet, the output ofwgeteppolwill be the shell of a script as shown in “EXAMPLES.” Addthe contents of the policy script after the comments and before the exitstatement. Then use thewputeppol command to write the new script todisk.

Optionspol_name Specifies the name of the policy script to be returned.

Authorizationsenior

ExamplesThe following example returns theafter_install_policy script, whichcan then be modified as needed:wgeteppol after_install_policy#!/bin/sh## The following are the command line options passed to# this script from the Endpoint Manager.## $1 - The label of the endpoint machine# $2 - The object reference of the endpoint machine# $3 - The architecture type of the endpoint machine

wgeteppol


Com

mands

# $4 - The object reference of the gateway that the# endpoint logged into# $5 - The ip address of the endpoint logging in.# $6 - Region# $7 - Dispatcher# $8 - Version# $9 - The inventory id of the endpoint logging in.#The following command line option will be passed to this script#from the Endpoint Manager, when complied with the MULTIPROTO flag#turned on# $10 - The protocol of the endpoint logging in.#TCPIP -> TCP/IP#IPX -> IPX/SPX

#Note that the environment variable LCF_LOGIN_STATUS is also set by#the endpoint manager. A value of 2 indicates the endpoint#is isolated. That is, it was unable to contact its#assigned gateway. Isolated endpoints are automatically#migrated to another gateway unless the#select_gateway_policy terminates with a nonzero exit#status.##Also note that during the execution of#allow_install and select_gateway policy scripts,#the endpoint does not yet formally exist. For this#reason, the endpoint object reference will have a#value of OBJECT_NIL, and the object dispatcher number#will be 0. The endpoint label will have the value#suggested by the endpoint (or the user value lcfd -n),#but is not guaranteed to become the final endpoint#label. It will become the final endpoint label if#this value is not already taken by another endpoint.exit 0#

See Alsowputeppol

wgetjob

1–288 Version 3.7.1

wgetjobLists the properties of a job.

Syntaxwgetjob task_name library_name

DescriptionThewgetjob command lists the properties of a job. The output of thiscommand is sent to standard output.

Optionslibrary_name Specifies the name of the task library containing the

specified job.

task_name Specifies the name of the job to be listed.


ExamplesThe following example lists the properties for the Clean Queue job:wgetjob "Clean Queue" queue_libJob Name : Clean QueueTask Name : Clean QueueExecution Mode : parallelTimeout : 60Output Format : task header

return codetask standard outputtask standard errordisplay output on desktop

Managed Nodes : yogi

Profile Managers :

wgetjob


Com

mands

See Alsowcrtjob , wdeljob

wgetkey

1–290 Version 3.7.1

wgetkeyRetrieves the subkey listing in a registry hive. This command should berun from an endpoint. (Windows only)

Syntaxwgetkeyregistry_key_path [registry_hive]

DescriptionThewgetkey command retrieves the subkeys associated with thespecified key path from the specified registry hive. The output of thiscommand is returned to standard output (on the console).

Optionsregistry_hive Specifies the registry hive from which to retrieve the

subkeys. Valid hives are as follows:

■ HKEY_LOCAL_MACHINE

■ HKEY_CLASSES_ROOT

■ HKEY_CURRENT_USER

■ HKEY_USERS

If you do not specify this option, the command retrievesthe subkeys from theHKEY_LOCAL_MACHINEregistry hive.

registry_key_pathSpecifies a registry key name from which to retrieve thesubkeys.

Authorizationadmin

wgetkey


Com

mands

Examples1. To retrieve the subkeys from theHKEY_LOCAL_MACHINE

registry hive under theSOFTWARE key path, enter the followingcommand. This command outputs a list of subkeys.

wgetkey SOFTWARE

2. To retrieve the key values from theHKEY_CURRENT_USERregistry hive under theUSERS key path, enter the followingcommand:

wgetkey USERS HKEY_CURRENT_USER

wgetpolm

1–292 Version 3.7.1

wgetpolmLists the body or constant value of a default or validation policy method.

Syntaxwgetpolm [–d | –v] class name policy

wgetpolm [–d | –v] profile policy

DescriptionThewgetpolm command lists the body or constant value of a policymethod to standard output. This command returns one of two things. Ifthe policy method is implemented as a shell script (or executableprogram), this method returns the body of the script (or program). If thepolicy method is implemented as a constant value, it returns thatconstant value. This command does not explicitly indicate which waythe method is implemented.

Note: For policy methods that are executable programs, this commandreturns the binary image of the executable program.

The–d option (default) returns a default policy method, and–v returnsa validation policy method. Theclass andname options specify themanaged resource type and policy object name, respectively, while thepolicy option specifies the individual attribute whose policy method toreturn, in the same form as thewlspolm command.

The second form of the command is used to query a policy from aprofile. In this case,profile specifies the profile to query, andpolicyspecifies the individual attribute whose policy to return, again asreturned by thewlspolm command. If the policy is implemented as aconstant value, this command returns that value. If the policy isimplemented as a shell script (or executable program), it returns thescript (or program) body to standard output, and prints the options to thescript to standard error (see thewputpolm command). If the policy isundefined or specified asnone, a message to that effect is printed tostandard error and nothing is printed to standard output.

wgetpolm


Com

mands

Options–d Lists the specified policy default method. This action is

the default if the–v option is not specified.

–v Lists the specified policy validation method.

class Identifies the managed resource type whose policy is tobe returned.

name Identifies the name of the policy object.

policy Identifies the attribute whose policy to return.

profile Identifies the profile whose policy to return.

AuthorizationYou must have at least thesenior role.

ExamplesFor nonprofile usage:

This command returns the script body for thepm_val_subscribersmethod of theBasicProfileManager policy validation object forProfileManager:wgetpolm -v "ProfileManager" "BasicProfileManager" \"pm_val_subscribers"

Output similar to the following is displayed:TRUE$

$

For profile usage:

The following example returns the script body for the default user ID(UID) policy for the user profile namedEngineering.wgetpolm -d @UserProfile:user_profile_2 uidscript ARGUMENTS: $real_name $login_name

wgetpolm

1–294 Version 3.7.1

Output similar to the following is displayed:#!/bin/sh # # Component Name: user_get_uid # # $Date: 1996/08/01 15:40:31 $ # # $Source:/tivoli/development/src/2.0/apps/user_group/user/uto_def_policies/ug_uid.src,v $ # # $Revision: 1.4 $ # # Description: Given a new user's real name, output a # default numeric User ID (UID) for the new user # # Implementation: The allocate_id method of the # User ID Data Base Object (UID_DBO) is used to # get (and allocate) the next available User ID # greater than 100. Note that the real name # argument is unused in this version. # # (C) COPYRIGHT TIVOLI Systems, Inc. 1991, 1992 # Unpublished Work # All Rights Reserved # Licensed Material - Property of TIVOLI Systems, Inc. #MY_NAME=user_get_uid

#

# Initialize exit codes

#

E_OK=0 # Successful completion

E_USAGE=1 # Illegal option, argument, or parameter

E_ERROR=2 # Error in execution

#

# Set PATH to known safe value

#

PATH=/usr/bin:/usr/ucb:$PATH

export PATH

exitval=$E_OK

#

# Check usage

#

wgetpolm


Com

mands

if [ $# -ne 2 ]; then

echo "usage: $MY_NAME \"real_name\" login_name"

exit $E_USAGE

else

REAL_NAME=$1 # (Unused)

LOGIN_NAME=$2 # (Unused)

fi

#

# Get the uid instance object ID's

#

UID_DBO="UID"

#

# Get the next available UID > $MIN_UID (100) from the database.

# If there is an error in the cli command wallocid, then output

# the UID of the "nobody" user (65534).

#

MIN_UID=100

NOBODY_UID=65534

NEW_UID=`wallocid -l $MIN_UID -u $NOBODY_UID $UID_DBO`

return=$?

if [ $return -ne $E_OK ]; then

echo $NOBODY_UID

exitval=$E_ERROR

else

echo $NEW_UID

fi

#

# Always exit successfully

#

exit $exitval

$

wgetpolm

1–296 Version 3.7.1

See Alsowchkpol, wcrtpol, wcrtpr , wdelpol, wdelpr, wgetdfpol, wlspolm,wputpolm

wgetpr


Com

mands

wgetprLists the properties of a policy region.

Syntaxwgetpr region

DescriptionThewgetrp command lists the properties of a policy region.

Optionsregion Specifies the target policy region.


ExamplesThe following example lists all the managed resources in theDefaultRegion policy region:wgetpr @PolicyRegion:DefaultRegionTaskLibraryManagedNodeProfileManager

See Alsowsetpr

wgetprf

1–298 Version 3.7.1

wgetprfRetrieves subscription copies of one or more profiles.

Syntaxwgetprf [–l maintain | over_all] [–m] [–r] name

DescriptionThewgetprf command retrieves subscription copies of one or moreprofiles from the profile managers to which the current profile manageror endpoint (host or Network Information Services [NIS] domain)subscribes. This command updates the subscriber databases andconfiguration files from the Tivoli database. Thenameoption specifiesan endpoint to which to send the copy. It can also specify the currentprofile copy.

If the –m option is specified, a multistep distribution is performed fromthe profile manager. If–m is not specified, a single-step distribution isperformed.

The–l option identifies the distribution level. If unspecified, the defaultis maintain.

Options–l maintain | over_all

Specifies the distribution level. Themaintain optionkeeps local modifications. Theover_all optionoverwrites local modifications.

–m Specifies a multistep distribution.

–r Sets the return code to 1 if at least one profiledistribution or retrieval to or from a profile managerfails.

name Specifies the endpoint to which to send the copy, orspecifies a current profile copy. Valid formats are asfollows:

■ @node_name

wgetprf


Com

mands


■ /Regions/PolicyRegionName/node_name


Examples1. The following example retrieves the profile copy Users,

overwriting any local modifications:

wgetprf -l over_all @UserProfile:Users@rushmore

2. The following example retrieves all profile copies in managednoderushmore recursively, maintaining any local modification:

wgetprf -m @ManagedNode:rushmore

See Alsowcrtpr , wcrtprfmgr , wdistrib , wgetsub, wlssub, wpopulate, wsub,wunsub

wgetquery

1–300 Version 3.7.1

wgetqueryLists information about a query.

Syntaxwgetquery [–f] query_name

DescriptionThewgetquery command lists information about a Tivoli query. Thisinformation includes the name, description, repository, view, columnslist, and where clause.

Options–f Lists all information about the specified query. Without

the–f option, thewgetquerycommand returns only thewhere clause.

query_name Specifies the name of the query.

Authorizationquery_view, user, admin, senior, orsuper

ExamplesThe following example lists all information about theDOS-machinesquery:wgetquery -f DOS-machines

The output is as follows:Name: DOS-machinesDescription: Query for DOS PCsRepository: inventoryView: MACHINE_TYPEColumns:

PROCESSOR_TYPEOPERATING_SYSTEM

Where Clause:--------------------(BOOTED_OS_NAME = 'DOS')

wgetquery


Com

mands

See Alsowcrtqlib , wcrtquery , wgetquery, wruninvquery, wsetquery

wgetrim

1–302 Version 3.7.1

wgetrimLists information about an RDBMS Interface Module (RIM) object.

Syntaxwgetrim rim_name

DescriptionThewgetrim command lists the current information for the specifiedRIM object.

Optionsrim_name Specifies the label of the RIM object. This can be either

the Tivoli name registry label (such as@RIM: name) orthe RIM label. To ensure that you always find the RIMobject, you must precederim_name with @.


ExamplesThe following example returns the information for theinventory RIMobject. The Instance Home field applies only to DB2 databases.wgetrim @inventory

The output is as follows:RIM Host: amon-sulRDBMS User: tivoliRDBMS Vendor: DB2Database ID: amarDatabase Home: opt/ibmDB2/V.2.1Server ID: tcpipInstance Home: /data/DB2

See Alsowcrtrim , wsetrim, wsetrimpw

wgetsched


Com

mands

wgetschedRetrieves information about jobs currently scheduled.

Syntaxwgetsched [–b 'mm/dd/yyyy hh:mm'] [–a 'mm/dd/yyyy hh:mm'] [–v]

wgetsched [–s id [–s id]…] [–v]

DescriptionThewgetsched command retrieves information about jobs currentlyscheduled to execute. If no options are specified, information about alljobs is displayed.




–s id… Specifies the job ID. You can specify more than one jobID.

–v Specifies verbose mode.

Authorizationuser

ExamplesThe following are two examples of this command’s output, normal andverbose. The verbose output provides all information about allscheduled jobs. This output can be very large, so it is intended to beredirected to a file.

wgetsched

1–304 Version 3.7.1

Normal OutputJob ID Label Admin Date & Time Enbld Repeat Retry Cncl------ ----- ----- ----------- -----------------------000008 JOB #14 root@cook Fri May 6 01:00:00 1994 YES YES NO YES000002 JOB #2 root@cook Sun Jan 1 01:12:00 1995 YES NO NO NO000010 JOB #9 root@cook Wed Mar 1 06:55:00 1995 YES NO YES NO

Verbose OutputID : 2Name : BackupLabel : BackupDescription :Administrator : root@vernonOriginal Time : Tue Mar 05 16:00:00 1996Next Time : Tue Mar 05 16:00:00 1996Enabled : YesRepeat Type : InfiniteRepeat Increment : 1Repeat Unit : DayRepeat Times : 0Retry Type : NoneRetry Increment : 0Retry Unit : MinuteRetry Times : 0Cancel Job : YesCancel Increment : 10Cancel Unit : MinuteEmail :Notice : Tivoli SchedulerDesktop :Host Name :File Name :Daytime Rest. : NoDaytime From : 6Daytime To : 18Nighttime Rest. : NoNighttime From : 17Nighttime To : 8Weekday Rest. : NoWeekday From : 1Weekday To : 5Weekend Rest. : YesWeekend From : 6Weekend To : 0

wgetsched


Com

mands

The next two examples show how to use thewgetsched command incombination with the–a and–b options.

1. The following example lists all jobs scheduled to run before May6, 1998, at 1:00 a.m. and after May 8, 1998, at 1:00 p.m.:

wgetsched –b '05/06/1998 01:00' –a '05/08/1998 13:00'

2. The following example lists all jobs scheduled to run after August10, 1998, at midnight and before August 12, 1998, at 6:00 p.m.:

wgetsched –a '08/10/1998 00:00' –b '08/12/1998 18:00'

See Alsowdelsched, wedsched, wenblsched, wschedjob

wgetsub

1–306 Version 3.7.1

wgetsubLists a profile manager’s subscribers.

Syntaxwgetsub[–l] [–o] name

DescriptionThewgetsub command lists the Tivoli resources that subscribe to theprofile manager specified inname.

Options–l Specifies a long listing.

–o Lists the object identifier for each profile manager’ssubscribers.

name Specifies the name of the profile manager whosesubscribers are to be listed. Valid formats for thenameoption are as follows:





ExamplesThe following example lists all the subscribers of theDevelopmentprofile manager:wgetsub @Development

wgetsub


Com

mands

See Alsowcrtprf , wcrtprfmgr , wdistrib , wgetprf, wlssub, wpopulate, wsub,wunsub, wvalidate

wgettask

1–308 Version 3.7.1

wgettaskLists the properties of a task.

Syntaxwgettask [–F file_name] task_name library_name

DescriptionThewgettaskcommand lists the properties of a task. The output of thiscommand is sent to standard output.

Options–F file_name Specifies a file in which the task information is written.

This option creates a.tar file of the task binaries andcomments as well as a description of the task settings.This option is useful when exporting a task from oneTivoli environment to another.

library_name Specifies the name of the task library containing thespecified task.

task_name Specifies the name of the task to be listed.

Authorizationuser, senior, super

ExamplesThe following example lists all information about theClean Queuetaskin thequeue_lib task library:wgettask "Clean Queue" queue_libTask Name : Clean QueueUser ID : *Group ID :Task ACL : admin:senior:super:userSupported Platforms :

solaris2

wgettask


Com

mands

<install>/solaris2/TAS/TASK_LIBRARY/bin/200000/tasknpzmqdTask Documentation :

Task Name : Clean QueueTask Created : Wed Sep 14 20:20:16 1998Task Created By : root@yogiComments:-------------------------------------------

See Alsowcrttask, wdeltask

wgetval

1–310 Version 3.7.1

wgetvalRetrieves a registry subkey. (Windows only)

Syntaxwgetval [–h registry_hive] –k {key | @file_name} –n value_name

DescriptionThewgetvalcommand retrieves a subkey from a registry. The output ofthis command is returned to standard output.

Options–h registry_hive

Specifies the registry hive from which to retrieve the subkey. Validvalues are as follows:

■ HKEY_LOCAL_MACHINE

■ HKEY_CURRENT_USER

■ HKEY_CLASSES_ROOT

■ HKEY_USERS

■ HKEY_CURRENT_CONFIG

■ HKEY_DYN_DATA

–k key | @file_nameSpecifies the key or file from which the subkey is retrieved.

–n value_nameSpecifies the name of the value.

Authorization admin

wgetval


Com

mands

ExamplesTo retrieve the version number of the Novell drivers, enter the followingcommand:wgetval -h HKEY_LOCAL_MACHINE -k SOFTWARE\NOVELL \-n CurrentVersion

See Alsowsetval

whostid

1–312 Version 3.7.1

whostidPrints the host ID of the specified managed node.

Syntaxwhostid host_name

DescriptionThewhostidcommand prints the host ID of the managed node specifiedin thehost_name option.

Optionshost_name Specifies the name of the host whose ID to list.


ExamplesThe following example shows the host ID of managed nodebald:whostid bald8031ee30

See Alsowdate, wdiskspace, wifconfig, winstdir , winterp , wmannode,wmemsize, wping, wtimezone, wuname, wxterm

wiconv


Com

mands

wiconvConverts the characters or sequences of characters in a file from onecode set to another code set.

Syntaxwiconv [–f codeset] [–t codeset< input | codeset> output]

wiconv [–f codeset] [–t codeset] [–i input] [–ooutput]

DescriptionThewiconv command converts the characters or sequences ofcharacters in a file from one code set to another code set and then writesthe results to standard output. Before using this command it is necessaryto set the TISDIR environment variable.

Options–f codeset Identifies the input code set.

–i input Identifies the name of the input file instead of using thestandard input.

–ooutput Identifies the name of the output file instead of usingthe standard output.

–t codeset Identifies the output code set.

> output Writes the results to standard output.

< input Reads input data from standard input.

AuthorizationThis command does not require any Tivoli management regionauthorization roles to be executed.

wiconv

1–314 Version 3.7.1

ExamplesThe following example takes the data in the filesource.txt, converts itfrom SJIS encoding toUTF8 encoding, and then outputs the result tothe fileutf8.html :wiconv –f SJIS –t UTF8 –i source.txt –o utf8.html

wident


Com

mands

widentIdentifies files.

Syntaxwident [–q] [file…]

Descriptionwident searches for all occurrences of the pattern$keyword:…$ in thenamed file or, if no file name appears, the standard input.

These patterns are typically inserted automatically by the RevisionControl System (RCS) commandwcobut can also be inserted manually.The option–q suppresses the warning given if no patterns are in a file.

wident works on text files as well as object files and dumps. Forexample, if the C program inf.c contains the following:char rcsid[] = "$Id: f.c,v \*(iD $";

andf.c is compiled intof.o, the commandwident f.c f.o

outputs the following:f.c:

$Id: f.c,v \*(iD $f.o:

$Id: f.c,v \*(iD $

AuthorAuthor: Walter F. Tichy.Revision Number: 5.0; Release Date: 1980/08/22.Copyright © 1982, 1988, 1989 by Walter F. Tichy.Copyright © 1990 by Paul Eggert.

See Alsowci, wco, wrcs, wrcsdiff , wrcsmerge, wrlogWalter F. Tichy, RCS—A System for Version Control,Software—Practice & Experience15, 7 (July 1985), 637-654.

widmap

1–316 Version 3.7.1

widmapLists and modifies user login mappings.

Syntaxwidmap add_entry map_name interp entry_val

widmap add_mapmap_name

widmap list_entriesmap_name

widmap list_maps

widmap resolve_entrymap_name interp

widmap rm_entry map_name interp

widmap rm_map map_name

DescriptionThewidmap command enables you to create and maintain mappings ofuser logins across multiple platforms. A login map enables TivoliManagement Framework to associate a single user login name with thecorrect user account on a specified operating system. For example, thelogin namechris might be mapped to user namechriss on Solarissystems and to user namechris_sanders on Windows systems.

The following example shows two login mappings, one forroot_userand one forchris:root_user default rootroot_user w32-ix86 Administratorchris solaris2 chrisschris w32-ix86 chris_sanders

Map names can be entered into Tivoli dialogs as$map_name. Forexample,$chris can be entered into theLogin Name or Group Namefields of theCreate Administrator dialog.$chris then resolves to thecorrect user name depending on the system being used.

Thewidmap command creates, lists, adds, and deletes entire maps orentries of a map.

Optionsadd_entry Adds an entry tomap_name.

widmap


Com

mands

add_map Adds a map formap_name.

list_entries Lists the existing entries formap_name.

list_maps Lists the existing maps.

resolve_entry Returnsentry_val of the specifiedinterp.

rm_entry Removesinterp from map_name.

rm_map Removesmap_name.

entry_val Identifies the user name to whichmap_name willresolve.

interp Identifies the interpreter type or operating system onwhichentry_valis a valid user name. Specifyinginterpasdefault indicates thedefault entry_val should beused on any operating system that does not have aseparateinterp entry.

map_name Identifies the mapping to be viewed or modified.

Authorizationwidmap requires theuserrole to view maps and thesuperrole to create,edit, or delete maps.

Examples1. The following example lists all mappings:

widmap list_maps

2. The following example adds a default entry to the$chris map:

widmap add_entry chris default chris

As a result of this command, the$chris map looks like this:

chris solaris2 chrisschris w32-ix86 chris_sanderschris default chris

3. The following example removes thesolaris2entry from the$chrismap:

widmap rm_entry chris solaris2

widmap

1–318 Version 3.7.1

4. The following example returns the user name mapped in the$chrismap to the default interpreter type:

widmap resolve_entry chris default

The result of this command ischris.

Note: If the same command were run for the HP-UX operatingsystem, the result would be the same. Because there is notan entry for HP-UX, the default value is returned.

wifconfig


Com

mands

wifconfigQueries or changes the Internet Protocol (IP) interfaces on a managednode.

Syntaxwifconfig –h node_namewifconfig –h node_name–adevice IP_address name notify_serverwifconfig –h node_name–r device [IP_address name]wifconfig –h node_name–sdevice IP_address name notify_server

DescriptionThewifconfig command allows you to query or change the IP interfaceson a managed node in the Tivoli environment.

Options–a (UNIX only) Adds an IP interface to the managed node.

You must specify a device, IP address, and name for theinterface. You must also indicate whether the Tivolimanagement region server should be notified about thenew IP interface.

–h node_nameSpecifies the managed node on which you are queryingor changing the IP interfaces.

–r (UNIX only) Removes an IP interface from themanaged node. You must specify the device name. Youcan also optionally specify the IP address and interfacename.

–s (UNIX only) Changes the settings of a current IPinterface. You must specify the device name and thenew interface definition (IP address, interface name,and whether the Tivoli management region serverknows about the interface). You cannot change thedevice name with the–s option.

device Specifies the device used by the interface.

IP_address Specifies the IP address of the interface.

wifconfig

1–320 Version 3.7.1

name Specifies the name of the interface.

notify_server Controls whether the Tivoli management region serverin the local region is notified of the addition ormodification of the IP interface. This option’s valuemust beTRUE or FALSE.

AuthorizationTo query:user, admin, senior, super

To change:admin, senior, super

Examples1. The following example queries the IP address of the managed node

bald:

wifconfig -h baldDevice Address Name Used by dispatcherlo0 127.0.0.1 localhost unused

2. The following example adds an IP interface for managed nodebald. The device islel, the IP address is146.84.49.3, and theinterface name isbald2. The Tivoli management region server isnotified of the new interface.

wifconfig -h bald -a lel 146.84.49.3 bald2 TRUE

3. The following example removes IP interfacebald2 from managednodebald:

wifconfig -h bald -r lel 146.84.49.3 bald2

See Alsonetstat, odadmin

winsblk


Com

mands

winsblkInserts a block of statements into a file. This command should be runfrom an endpoint.

Syntaxwinsblk –s "search_string" {–a " insertion_string" | @file_name} |{ –b " insertion_string" | @file_name} [ –ooutput_file] file_name

DescriptionThewinsblk command inserts a block of statements into a file. Thiscommand enables you to add a block of statements delimited by uniquestrings, which you can later search for or remove using thewrplblk orwclrblk commands.

Options–a " insertion_string" | @file_name

Inserts a block of statements after the line containingthe search string. This option cannot be specified withthe–b option.

If you specifyinsertion_string, you must surround thestring with double quotation marks. If you specify@file_name, this command inserts the block ofstatements from the specified file.

–b " insertion_string" | @file_nameInserts a block of statements before the line containingthe search string. This option cannot be specified withthe–a option.

If you specifyinsertion_string, you must surround thestring with double quotation marks. If you specify@file_name, this command inserts the block ofstatements from the specified file.

–ooutput_file Writes that output to the file specified byoutput_file. Ifthis option is not specified, output is written to standardoutput.

winsblk

1–322 Version 3.7.1

–s "search_string"Specifies a search string. If the search string iscontained in a line, the block of statements is placedeither before (using the–boption) or after (using the–aoption) the line containing the search string. If thisoption is not specified, the block of statements isappended to the file.

file_name Specifies the file to insert the block into.

Return Valueswinsblk returns one of the following:

0 Indicates thatwinsblk successfully added the specifiedblock of statements.

nonzero Indicates thatwinsblk did not successfully add thespecified block of statements.

ExamplesTo insert the statements in theBLKSTMTS.FIL file after everyoccurrence of the device= string in theSYSTEM.INI file and redirectoutput to theOUTPUT.FIL file, enter the following command:winsblk -s "device=" -a @C:\TEMP\BLKSTMTS.FIL \-o C:\TEMP\OUTPUT.FIL C:\WINDOWS\SYSTEM.INI

See Alsowclrblk , winsline, wrplblk

winsline


Com

mands

winslineInserts a single line into a file. This command should be run from anendpoint.

Syntaxwinsline [–f] –s "search_string" {–a "insertion_string" |–b " insertion_string" } [ –ooutput_file] file_name

DescriptionThewinsline command adds a line to a text file. You can insert the linebefore or after a line that contains the search string.

Options–a "insertion_string"

Inserts the specified string or the lines contained in thespecified file after the line that contains the searchstring. This option cannot be specified with the–boption. You must surround the string with doublequotation marks.

–b " insertion_string"Inserts the specified string or the lines contained in thespecified file before the line that contains the searchstring. This option cannot be specified with the–aoption. You must surround the string with doublequotation marks.

–f Processes only the first occurrence of the search string.If this option is not specified, the command processeseach occurrence of the search string.

–ooutput_file Specifies that output is written to a file namedoutput_file. If this option is not specified, output iswritten to standard output.

–s "search_string"Specifies the search string. If the search string iscontained in a line, the insertion string is placed either

winsline

1–324 Version 3.7.1

before (using the–b option) or after (using the–aoption) the line containing the search string. You mustsurround the string with double quotation marks.

file_name Specifies the name of the file to insert the line into.

Return Valueswinsline returns one of the following:

0 Indicates thatwinslinesuccessfully added the specifiedline.

nonzero Indicates thatwinsline did not successfully add thespecified line.

Examples1. To insertlp01 after the first occurrence of thedevice=string in the

SYSTEM.INI file and redirect output to theOUTPUT.FIL file,enter the following command:

winsline -f -s "device=" -a "lp01" -o C:\TEMP\OUTPUT.FIL \C:\WINDOWS\SYSTEM.INI

2. To insertdev01before every occurrence of thetype= string in theSYSTEM.INI file, enter the following command:

winsline -s "type=" -b "dev01" -o C:\TEMP\OUTPUT.FIL \C:\WINDOWS\SYSTEM.INI

The output from this command is redirected from standard output to thefile OUTPUT.FIL .

See Alsowclrline , winsblk, wrplline

winstall


Com

mands

winstallInstalls a Tivoli product.

Syntaxwinstall [–csource_dir] [–sserver] [–i product] [–y][install_variables] [–n | managed_node…]

DescriptionThewinstall command installs a Tivoli product from the command linewhen invoked on the Tivoli management region server. Before installingany product, this command identifies the actions that are performedduring the installation.

Options–csource_dir Specifies the complete path to the directory containing

the installation image.

–i product Specifies the product index file from which the productis installed. Index files have an.IND extension. Forexample, the index file for Tivoli User Administrationis ADMIN.IND . You can specify this product as–i ADMIN or –i ADMIN.IND .

–n Installs the product on all managed nodes that do notcurrently have the product installed. This option isignored whenmanaged_node is specified.

–sserver Specifies the managed node to use as the installationserver. If not specified, the server is the Tivolimanagement region server.

–y Installs the product without requesting confirmation.

install_variablesSpecifies product-specifickeyword=value pairs. Fordetails, see “Installation Variables” on page 1-326.

Note: Type the names of the installation optionsexactly as specified in the product

winstall

1–326 Version 3.7.1

documentation. Installation options are casesensitive.

managed_nodeSpecifies the managed nodes on which to install thisTivoli product. You can specify multiple managednodes. If you do not specify a managed node, theproduct is installed on all managed nodes in this Tivolimanagement region.

Installation VariablesYou specify values for installation variables on the command line tocontrol the installation. If a Tivoli product has installation variables, youcan view the index (.IND) file for that product for its definitive list ofinstallation variables. Use these variables to specify required andoptional options as well as to override default installation information.

You can use installation variables to specify the directories where aTivoli product is to be installed. Specify these directories when youinstall Tivoli Management Framework; other Tivoli products use thesame directories as Tivoli Management Framework. If a directoryalready contains the files, the files are not reinstalled. You can, however,force any of these directories to be overwritten by entering anexclamation mark (!) as the value for the specified directory. Forexample, to reinstall the binaries, you would enterBIN=! instead ofentering the entire path to the binaries directory. This override featureapplies to all installation variables.

The following are the variables related to installation directories:

BIN=binaries_dirOverrides the default installation path for the productbinaries (/usr/local/Tivoli/bin ).

LIB= libraries_dirOverrides the default installation path for the productlibraries (/usr/local/Tivoli/lib ).

DB=client_databaseOverrides the default installation path for the productclient database (/var/spool/Tivoli).

winstall


Com

mands

MAN= manpageOverrides the default installation path for the productman pages (/usr/local/Tivoli/man).

CAT=message_catalogOverrides the default installation path for the productmessage catalogs (/usr/local/Tivoli/msg_cat).

The following is another useful variable:

@CreatePaths@=[0 | 1]Indicates whether to create (1) or not to create (0) anyspecified directory if it does not already exist. Bydefault, directories are not created. You receive an errormessage if a specified directory does not exist.

AuthorizationRequiresinstall_product or senior in the Tivoli management region

Examples1. The following example installs Tivoli User Administration on all

managed nodes in the Tivoli management region. The path to theinstallation image is/cdrom, and the product index file isADMIN .

winstall -c /cdrom -i ADMIN

2. The following example installs Tivoli Software Distribution onmanaged nodesdanandbarney. The path to the installation imageis /dev0/cdrom, and the product index file isCOURIER .

winstall -c /dev0/cdrom -i COURIER dan barney

3. The following example reinstalls Tivoli User Administration onthe managed node, overwriting existing files in the binarydirectory. The path to the installation image is/cdrom and theproduct index file isADMIN.TMR with the use of the BIN option:

winstall -c /cdrom -i ADMIN BIN=!

See Alsowclient, wpatch, wserver

winstdir

1–328 Version 3.7.1

winstdirPrints the path of the installation directory of the specified managednode.

Syntaxwinstdir host_name

DescriptionThewinstdir command prints the path of the installation directory of themanaged node specified in thehost_name option.

Optionshost_name Specifies the name of the host whose installation

directory to list.

Authorizationuser, admin, super, senior

ExamplesThe following example shows the installation directory for the managednodebald:winstdir bald/data/shadow/solaris2/as/bin

See Alsowdate, wdiskspace, whostid, wifconfig, winterp , wmannode,wmemsize, wping, wtimezone, wuname, wxterm

winstendpt


Com

mands

winstendptInstalls behavior for an endpoint resource type.

Syntaxwinstendpt ep_behavior [ep_res_type]

DescriptionThewinstendpt command installs behavior onto an endpoint resourcetype. If a profile-based application defines an endpoint behavior, thatbehavior can be added to the inheritance of an endpoint resource typesuch as a managed node.

This command would typically be run from the initialization script of aprofile-based application.

Optionsep_behavior Identifies the instance manager of the new endpoint

behavior resource type.

ep_res_type Identifies the endpoint resource type on which the newbehavior is installed. If noep_res_type is given, themanaged node resource type is assumed.

Authorizationsuper, senior

ExamplesThe following example installs the endpoint behavior of resource typeaef onto theManagedNode resource type:aef_CO=`wlookup -r Classes aef`managednode_CO=`wlookup -r Classes ManagedNode`winstendpt $aef_CO $managednode_CO

winstlcf

1–330 Version 3.7.1

winstlcfInstalls an endpoint on UNIX, Windows NT, and Windows 2000workstations.

Syntaxwinstlcf [–a] [–C locale_name] [–d dir_name] [–e] [–f file_name][–gmachine[+port] [:machine[+port]] [–i] [–L config_options][–l ep_port] [–N endpoint] [–n ep_label] [–P] [–R] [–r policy_region][–Sshare_name] [–sdir_name] [–T account] [–v] [–x TCPIP | IPX][–Y] host [user_acct passwd]…

DescriptionThewinstlcf command installs and starts the endpoint daemon (lcfd) onone or more workstations. This command installs UNIX, Windows NT,and Windows 2000 endpoints only. By default, endpoints startautomatically after installation. You can install multiple endpoints bylisting the machine names on the command line or by specifying a filecontaining the machine names. The file must contain one machine nameon each line of the file.

If you runwinstlcf on a machine more than once, you have more thanone instance of lcfd running on that machine. Only one instance of lcfdshould exist on each machine. Remove any additional instances.

Note: Because Windows NT and Windows 2000 systems do not havea remote execution service, the first Windows NT orWindows 2000 endpoint in a domain must be manuallyinstalled with InstallShield. You can then usewinstlcf with the–N option to reference that endpoint as a proxy to install allother Windows NT or Windows 2000 endpoints within thesame domain or trust.

After you specify an installation password with thewinstlcf command,that password becomes the default for all subsequent installations. Tochange the password, follow these steps:

1. Explicitly specify another password.

winstlcf


Com

mands

2. Attempt an installation on an unsupported operating system, whicherases the global variable containing the password.

3. Specify the–P option.

Options–a Specifies that endpoints be installed asynchronously.

Without this option,winstlcf waits for the endpoint tolog in to its gateway before installing the next endpoint.

–C locale_nameFor UNIX systems only, specifies the language localefor the target endpoint. If the–Coption is not specified,the language is inherited from lcfd’s environment.

–d dir_name Specifies the target directory in which to install theendpoint software. The default location is/opt/Tivoli/lcf for UNIX and c:\Tivoli\lcf forWindows NT and Windows 2000. When installing aWindows NT or Windows 2000 endpoint from a UNIXserver, forward slashes in path names are alsosupported.

–e For UNIX systems only, specifies to use the shellservice instead of exec.

–f file_name Specifies a file name containing a list of machine nameson which to install the endpoint software. The file mustcontain one machine name per line with the user ID andpassword that is used to install the endpoint. Forexample, the following could be two lines in the file:

red root mstr_Keyorange chris d1n0mite

–gmachine[+port][ :machine[+port]]…Specifies the Internet Protocol (IP) address or hostname and, optionally, the port number of the gateway towhich the endpoint logs in. Multiple gateway entriesmust be separated by colons (:). You must specify theport number if it is other than 9494, the default. If the

winstlcf

1–332 Version 3.7.1

–g option is omitted, the endpoint broadcasts to allgateways.

Note: In a network address translation (NAT)environment, gateways must be specified asfully qualified domain names and not as IPaddresses. Direct specification of gateway IPaddresses fails in a NAT environment.

–i Turns off auto-start configuration for a UNIX endpointafter installation. By default, Windows NT andWindows 2000 endpoints always start automaticallyafter installation.

–l ep_port Specifies the port number for the endpoint. The defaultport number is 9495.

–L config_optionsPasses configuration options to thelcfd command forstarting the endpoint. See thelcfd command for a list ofvalid options. For example, you can specify optionslisted for thelcfd –D command (as shown in Example5). If you specify multiple options or have spaces in asingle option, you must enclose the text in doublequotation marks (").

–n ep_label Specifies an endpoint label provided by a user.

Note: If you omit the–n option, the endpoint label isgenerated automatically. If you do not specifythe endpoint port number, the label is the hostname of the endpoint. If you specify theendpoint port number (for example, using the–l option), the endpoint label is generated asfollows:

■ On Windows NT, the label has the formathost-port.

■ On UNIX, the label has the formathost-instance, if the instance number isgreater than 1. The value ofinstancematches the instance number used in

winstlcf


Com

mands

$LCFROOT/dat/ instance.

–N endpoint Specifies an existing Windows NT or Windows 2000endpoint from which you can remotely install otherWindows NT and Windows 2000 endpoints. When youuse this option,winstlcf assumes that all endpoints tobe installed are Windows NT or Windows 2000 clients.Installing the Tivoli Remote Execution Service is notnecessary.

–P Causeswinstlcf to prompt for a password for eachmachine. This option is useful only when installing onremote hosts with different passwords. If each machinehas the same password or if you do not use the–Poption,winstlcf prompts for a global password to usefor each machine.

–r policy_regionSpecifies a policy region to install the endpoint to.

–R Requires the Windows NT or Windows 2000 endpointto restart after installation without prompting the user.This option is only needed if the Tivoli AuthenticationPackage,TivoliAP.dll , was not previously installed onthe endpoint or an older version of the TivoliAuthentication Package is being replaced.

–sdir_name Specifies the source directory containing the endpointinstallation image.

–Sshare_nameSpecifies a destination share name (default =C$).

–T account Specifies the Tivoli remote access account for theWindows NT or Windows 2000 endpoint.

–v Lists verbose installation information and errormessages.

–x TCPIP | IPXFor IPX endpoints only. Specifies the protocol used bythe endpoint. Supported protocols are the following:

TCPIP Specifies Transmission ControlProtocol/Internet Protocol (TCP/IP).This is the default. If you do not

winstlcf

1–334 Version 3.7.1

specify the–x option, the endpointuses TCP/IP.


To specify both TCP/IP and IPX protocols, specify theoption as–x=TCPIP,IPX. Note that you cannot turnoff the TCP/IP protocol for a gateway.

–Y Specifies that the installation should proceed withoutconfirmation. By default, this command identifies theactions that must be taken to perform the installationand requests confirmation before continuing. Using thisoption,winstlcf identifies the actions and performs theinstallation without requesting the confirmation.

host [user_acct passwd]Specifies the name of the machine on which theendpoint is installed. If you specify only the host name,the root or Administrator account is used. You areprompted for the password. You can specify a differentuser account and password by enclosing the threeentries in single quotation marks. For example, youmight enter the following:

winstlcf 'vernon DOMAIN-NT\chris d1n0mite'

If the Windows NT or Windows 2000 domain and thelocal computer use the sameuser_acct name (such asAdministrator), you must specify the fully qualifiedname for the account, as in the preceding example.Quotation marks are necessary when specifying fullyqualified user accounts.


winstlcf


Com

mands

Examples1. The following example installs the endpoint software on a UNIX

workstation namedvernon, sets the locale to French, and starts theendpoint daemon (lcfd).winstlcf uses the root account andprompts for the root password onvernon. The installation imageis placed in the default directory. The endpoint starts with thedefault configuration.

winstlcf -C fr vernon

2. The following example installs the endpoint software on aWindows NT workstation namedolympusand starts the endpointservice. Thewinstlcf command uses the Administrator accountand prompts for the Administrator password on olympus. Theinstallation image is taken from a Windows NT proxy namedfuji(a previously installed Windows NT endpoint). The software isinstalled in the default directory on olympus. The endpoint startswith the default configuration.

winstlcf -N fuji olympus

3. The following example installs the endpoint on a Windows NTworkstation in a directory other than the default directory. In thisexample, the endpoint is installed on workstationbonnell ondrive D with the share namesteve. For instances where the sharename of the destination drive is not the default name (D:\ = D$),–d specifies the directoryD:\tivoli\lcf , and–S specifies the sharenamesteve.

winstlcf -N pctmp107 -d D:\tivoli\lcf -S steve bonnell

4. The following example installs the endpoint software onworkstationmyoung. The endpoint performs its initial loginthrough IP address123.45.1.12.

winstlcf -g 123.45.1.12 myoung

5. The following example installs the endpoint on workstationbbunny and passes configuration options to thelcfd command touse when it starts the endpoint. In the example,–g cedar+1616specifies the gateway and port that the endpoint contacts for initiallogin.–Dlcs.machine_name=bbunny-epassigns a specific nameto the endpoint.

winstlcf

1–336 Version 3.7.1

winstlcf -L "-g cedar+1616 \-Dlcs.machine_name=bbunny-ep" bbunny

6. The following example installs machinescedarandmahoganyasendpoints. The installation process prompts for a global rootpassword, but does not prompt for confirmation before installing.

winstlcf -P -Y cedar mahogany

7. The following example installs multiple endpoints from theendpt.txt file. The installation process does not prompt forpassword or installation confirmation. The software is installed in/usr/lcf.

winstlcf -f endpt.txt -Y -d /usr/lcf

8. The following example installs a Windows NT endpoint namedantonella on the computer systemagodino using IPX to connectto the NetWare gatewaylux and using the endpointvernon as aproxy.

winstlcf -x IPX -N vernon -g lux+7787 -n antonella agodino

See Alsolcfd.sh, wdelep

winstruct


Com

mands

winstructProvides Tivoli Management Framework with information necessary toinstall and manage an application.

Syntaxwinstruct –a amp_file–sstaging_area [–t admin_tag][–D variable=value]…

DescriptionThewinstruct command passes information about an application toTivoli Management Framework and certain Tivoli tools installed in theenvironment. Tivoli Management Framework uses the information todistribute, install, and manage the application. In this context, TivoliManagement Framework is an application management tool.

Thewinstruct command first reads an application management package(AMP) and extracts its contents into a staging area directory. Thecontents of the AMP are an.aof, a.gdf, and one or more.cdf files. Theseare application description files based on the Application ManagementSpecification (AMS). The AMP can also contain the source files thatmake up the application.

The command then calls the appropriatewinstruct subcommand foreach installed Tivoli tool. Thewinstruct command passes any optionsit receives to the subcommands. Thewinstruct command andsubcommands use the contents of the AMP to inform, orinstruct, TivoliManagement Framework and the tools about information they need toinstall and manage the application.

Thewinstruct , winstruct_task, andwinstruct_plus commands areincluded in Tivoli Management Framework installation. The remainingcommands are installed when the Tivoli products are added to theenvironment. The following list summarizes the commands andproducts with which they are installed:

winstruct Installed with Tivoli Management Framework

winstruct_eventInstalled with Tivoli Enterprise Console

winstruct_file Installed with Tivoli Software Distribution

winstruct

1–338 Version 3.7.1

winstruct_inventoryInstalled with Tivoli Inventory

winstruct_monitorInstalled with Tivoli Distributed Monitoring

winstruct_plusInstalled with Tivoli Management Framework

winstruct_taskInstalled with Tivoli Management Framework

Thewinstruct subcommands ignore a repeated instruction, whichpermits the instruction process to continue for the remaininguninstructed tools. For example, suppose you execute thewinstructcommand for an application, but the process does not complete for somereason. When you correct the problem and issue the command again, theinstruction process continues from the point where it halted.

Options–aamp_file Specifies the path and file name of an AMP.

–D variable=valueSpecifies the name of an arbitrary variable and its value.You can specify multiple variables, but you must enter–D for each variable and value pair. Tivoli ManagementFramework and Tivoli products all receive the sameenvironment variables passed with–D, but eachmanagement tool uses only those variables that apply tothe tool. The tools ignore irrelevant variables.

–sstaging_areaSpecifies a directory into which thewinstructcommand extracts the contents of the AMP.

–t admin_tag Specifies an administrator tag for the instruct action.Unique administrator tags enable the instructing ofmultiple versions of an AMP.

Authorizationpolicy in addition tosenior or super

winstruct


Com

mands

ExamplesTo instruct the Tivoli system with information for managing anapplication, enter the following:winstruct -a /applications/amps/super_amp.amp \-s /install/staging -t rev1 -D src_dir=/cdrom

This command extracts the contents of the.amp file into the/install/stagingdirectory. The command then reads the contents, whichare an.aof, a.gdf, and one or more.cdf description files. The commandchecks the system for the presence of Tivoli tools. Thewinstructcommand executes the appropriate subcommand for each tool it detects,passing to the subcommands any options issued for the main command.For example, if it finds Tivoli Software Distribution and TivoliDistributed Monitoring,winstruct calls thewinstruct_file andwinstruct_monitor subcommands.

The instruction process is labeled with the “rev1” tag. The tagdistinguishes this version of the AMP from others. In this example, theapplication files are not included in the AMP, but are instead located ona CD, specified with the–D option. The command checks theManagement Tool Extension Group (specified in the AMS) forvariable=valuepairs and command line options to determine the sourcedirectory for the application files.

See Alsowinstruct_event, winstruct_ file, winstruct_inventory ,winstruct_monitor , winstruct_plus, winstruct_task

winstruct_plus

1–340 Version 3.7.1

winstruct_plusCreates Tivoli Application Management modules from ApplicationManagement Specification (AMS) files produced by the Tivoli ModuleBuilder.

Syntaxwinstruct_plus –aamp_file –sstaging_area [–t admin_tag][–D variable=value]…

DescriptionThewinstruct_plus command, a subcommand ofwinstruct , extractsthe contents of the application management package file (.amp) into aspecified staging area. The subcommand reads the extracted applicationdescription files (.aof, .gdf, and one or more.cdf), which are based onthe AMS. If these files include Management Tool Extension Group(MTEG) variables that have been generated by the Tivoli ModuleBuilder,winstruct_plus recognizes the variables and uses theinformation to create a Tivoli Application Management module for theapplication. A Tivoli Application Management module created in thisway provides a common interface for managing the application.Features in the Tivoli Application Management module interfaceinclude application launch, indicator collections, and subscription lists.The interface also includes a view of, and access to, pertinent Tivoliinformation and objects that have already been created by thewinstruct_file , winstruct_monitor , andwinstruct_tasksubcommands. Objects include the following:

■ Sentry profiles

■ File packages

■ Tasks

Becausewinstruct_plus refers to information and objects that arecreated by other subcommands, thewinstruct command callswinstruct_plus last. If a.gdf or .cdf file contains Tivoli AMS MTEGvariables that relate to a Tivoli object not yet created by anotherwinstruct subcommand,winstruct_plus ignores the variables untilthey are invoked again. If an administrator later issues thewinstruct

winstruct_plus


Com

mands

command and the subcommands create the required data objects,winstruct_plus provides information for managing the component withthe Tivoli Application Management module.

Thewinstruct_plus subcommand uses information that is provided inTivoli Application Management MTEG variables. These variables andcomponent information recognized by thewinstruct subcommands areincluded in the.gdf and.cdf files generated by the Tivoli ModuleBuilder. If a.gdf or .cdf file does not contain Tivoli ApplicationManagement MTEG variables, otherwinstruct subcommands mightprocess the information, butwinstruct_plus skips it. The correspondingcomponent is not managed with a Tivoli Application Managementmodule.

Thewinstruct_plus subcommand ignores a repeated instruction, whichpermits the instruction process to continue for the remaininguninstructed tools. For example, suppose you execute thewinstructcommand for an application, but the process does not complete for somereason. When you correct the problem and issue the command again, theinstruction process continues from the point where it halted.

You can execute this command directly instead of calling it from thewinstruct command. However, ifwinstruct_plus variables relate toobjects not yet created, the Tivoli Application Management moduledoes not manage the corresponding component. Typically, thissubcommand requires thewinstruct_task subcommand to have beenissued first.


–D variable=valueSpecifies the name of an environment variable and itsvalue. You can specify multiple variables, but you mustenter–D for each variable and value pair.

–sstaging_areaSpecifies a directory into which thewinstruct_pluscommand extracts the contents of the AMP.


winstruct_plus

1–342 Version 3.7.1


ExamplesTo instruct a Tivoli Application Management Module with informationfor managing an application, enter the following:winstruct_plus -a /applications/amps/super_app.amp \-s /install/staging -t rev1

This command extracts the contents of thesuper_app AMP into the/install/staging directory and reads the.aof, .gdf, and.cdf descriptionfiles. The instruction process is labeled with therev1 tag. The tagdistinguishes this version of the AMP from others.

See Alsowinstruct , winstruct_task

winstruct_task


Com

mands

winstruct_taskProvides Tivoli Management Framework with the information to createtasks and dependencies for installing and managing an application.

Syntaxwinstruct_task –aamp_file –sstaging_area [–t admin_tag][–D variable=value]…

DescriptionThewinstruct_task command, a subcommand ofwinstruct , extractsthe contents of the application management package file (.amp) into aspecified staging area. The subcommand reads the extracted applicationdescription files (.aof, .gdf, and one or more.cdf), which are based onthe Application Management Specification (AMS). If it does not alreadyexist,winstruct_task creates a top-level Applications policy region.The subcommand then creates subordinate policy regions, one for eachrevision level of the application.

Thewinstruct_task subcommand examines each.cdf file for thepresence of particular groups of information and creates data objects forthose it finds. The following list summarizes the groups and objects theycreate:

Operational Task groupTask library

Generic Dependency Type groupDependency library

Generic Dependency Instance groupDependency instance

Thewinstruct_task subcommand ignores a repeated instruction, whichpermits the instruction process to continue for the remaininguninstructed tools. For example, suppose you execute thewinstructcommand for an application, but the process does not complete for some

winstruct_task

1–344 Version 3.7.1

reason. When you correct the problem and issue the command again, theinstruction process continues from the point where it halted.

You can execute this command directly—instead of calling it from thewinstruct command—becausewinstruct_task is not dependent on anyof the otherwinstruct subcommands.


–D variable=valueSpecifies the name of an environment variable and itsvalue. You can specify multiple variables, but you mustenter–D for each variable and value pair.

–sstaging_areaSpecifies a directory into which thewinstruct_taskcommand extracts the contents of the AMP.



ExamplesTo instruct the Tivoli system with information for managing anapplication, enter the following:winstruct_task -a /applications/amps/super_app.amp \-s /install/staging -t rev1

This command extracts the contents of thesuper_app AMP into the/install/staging directory and reads the.aof, .gdf, and.cdf descriptionfiles. The instruction process is labeled with the “rev1” tag. The tagdistinguishes this version of the AMP from others.

See Alsowinstruct

winterp


Com

mands

winterpPrints the interpreter type of the specified managed node.

Syntaxwinterp host_name

DescriptionThewinterp command prints the interpreter type for the managed nodespecified in thehost_name option.

Optionshost_name Specifies the name of the host for which to list the

interpreter type.


ExamplesThe following example shows the interpreter type of the managed nodebald:winterp baldsolaris2

See Alsowdate, wdiskspace, whostid, wifconfig, winterp , wmannode,wmemsize, wping, wtimezone, wuname, wxterm

wlcftap

1–346 Version 3.7.1

wlcftapSets the properties of the Tivoli Authentication Package on aWindows NT or Windows 2000 client. Issue this command from thelocal machine (endpoint) to which it applies.

Syntaxwlcftap [–a][–B][–d][–P][–r [domain_name\user_name| user_name]][–k]

DescriptionThewlcftap command sets the properties of the Tivoli AuthenticationPackage,TivoliAP.dll . This file enables Tivoli ManagementFramework to access remote file systems in the context of a user. (SeetheTivoli Management Framework Planning for Deployment Guideformore information about accessing remote file systems.) It also enablesWindows NT and Windows 2000 systems to run setuid methods, that is,to run a method in the context of a user associated with the method.

The Tivoli remote access account specifies a user account. Tivoli usesthis account to access remote file systems.

Using thewlcftap command with no options prints version informationfrom the currently runningTivoliAP.dll .

When activating the Tivoli Authentication Package for the first time,which is usually immediately following Tivoli management regionserver installation, you must restart the machine for changes to takeeffect.

Options–a Sets the Tivoli Authentication Package internal key and

registers theTivoliAP.dll with the local securityauthority (LSA). The new internal key becomeseffective immediately. TheTivoliAP.dll file is loadedby the LSA when the machine is restarted.

–B Authenticates domain users using a domain controllerother than the primary domain controller. To

wlcftap


Com

mands

authenticate users using the primary domain controller,use the–P option.

–d Removes the Tivoli Authentication Package internalkey and unregisters theTivoliAP.dll with the LSA. TheTivoliAP.dll file is released by the LSA (so that it canbe deleted if Tivoli Management Framework isuninstalled) when the machine is restarted.

–k Specifies thatwlcftap should read the password foruser_name from standard input. If you do not specify–k, wlcftap prompts you for the password.

–P Authenticates domain users by using the primarydomain controller. This is the default setting. Toauthenticate users by using other domain controllers,such as backup domain controllers, use the–B option.

–r [domain_name\user_name | user_name]Sets the Tivoli remote access account touser_name.Tivoli accesses remote file systems using this useraccount.user_name can be prefixed with the domainname, separated by either a forward slash (/) or abackslash (\). If the domain is specified, it must be thedomain in which the machine running the TivoliAuthentication Package belongs or a domain trusted bythat domain. If no domain is specified, Windows looksfor the given user in the local domain or trusteddomains.wlcftap –r "" disables Tivoli access toremote file systems. To see changes take effectimmediately, restart the object dispatcher.

AuthorizationMember of the Administrators group. Tivoliadmin authorization isrequired to runwlcftap with no options. Windows NT permission isrequired to edit the registry to use this command.

wlcftap

1–348 Version 3.7.1

ExamplesThe following example sets the Tivoli remote access account to a useraccount nameduserTME. Thewlcftap command reads the passwordfor userTME from the password filepswd.txt:wlcftap -r userTME -k < pswd.txt

wln


Com

mands

wlnLinks an object into a collection.

Syntaxwln [–I] label… collection

DescriptionThewln command links an object with the specified label into theselected collection. Thelabelandcollectionoptions can both be full orpartial label paths.

If you use this command to link an endpoint, run thewepsync_gatewayscommand to synchronize the endpoint data stored by theendpoint manager, gateways, and endpoints within the Tivolimanagement region.


to continue. This option is useful only when multiplelabels are passed to the command. The–I option allowsa link operation to fail for individual objects, but thecommand continues to the next object to be linked.Without this option, if a link operation fails for anindividual object, the command unlinks any objectsalready linked, and then the command terminates witherror. The default is for the command to fail when thesuboperation fails.

collection The label of the collection into which the object is to belinked. This option also can be a full label path (startingat the ‘/’ collection), a partial label path (relative to thecurrent working collection), or a simple name (to befound in the current working collection). The linkedobject becomes a member of the selected collection.

label… The object’s label. This option can be a full label path(starting at the ‘/’ collection), a partial label path

wln

1–350 Version 3.7.1

(relative to the current working collection), or a simplename (to be found in the current working collection).


ExamplesThe following example creates a new administrator using thewcrtadmin command and then useswln to link the Tivoli managementregion server and scheduler objects from the default root desktop intothe newly created administrator’s desktop collection:wcrtadmin -a jack -r global,backup:admin:user \-r @ceridwen-region,admin:senior:user \-r @Administrators,admin:user -r @Scheduler,admin:user \-n "Tivoli Administration" -n "Tivoli Authorization" \-n "Tivoli Diagnostics" -n "Tivoli Scheduler" -u jack -g staff \"Jack Frost"wln /Administrators/Root_ceridwen-region/ceridwen-region \/Administrators/"Jack Frost"wln /Administrators/Root_ceridwen-region/Scheduler \/Administrators/"Jack Frost"

See Alsowep, wmv

wlocalhost


Com

mands

wlocalhostSets the name of the local host in the Windows NT or Windows 2000registry.

Syntaxwlocalhost [host_name]

DescriptionThewlocalhostcommand sets the local host name in the Windows NTor Windows 2000 registry. If you do not specifyhost_name, wlocalhostreturns the host name currently stored in the registry.

Optionshost_name Specifies the name of the local host.

AuthorizationMember of the Administrators group

wlocktmr

1–352 Version 3.7.1

wlocktmrPlaces the current Tivoli management region in maintenance mode.

Syntaxwlocktmr –pwlocktmr –e cmdstring

DescriptionThewlocktmr command places the current Tivoli management regionin maintenance mode. In this mode, you can perform variousmaintenance and diagnostic tasks. Note that issuing this commandimmediately terminates all active Tivoli processes.

You can invokewlocktmr in two ways. The first way is to place theregion in maintenance mode indefinitely. To do this, use the–p option.The–p option puts the region in maintenance mode and pauses until theprocess is terminated. You can perform maintenance and diagnosticoperations in another window.

The second way to invokewlocktmr is to run a single maintenancecommand or to run a batch or script file. To do this, use the–e option.The–eoption puts the Tivoli management region in maintenance mode,runs the specified command or file, and exits maintenance mode.

Use thevi command (or any text editor) to create the list of commands.Usechmod to make sure that the commands are executable. Then runthewlocktmr command with the–eoption and the command file name.

Options–ecmdstring

Places the Tivoli management region in maintenancemode, runs the command given bycmdstring, and exitsmaintenance mode.cmdstring can be the name of abatch or script file.

–p Places the Tivoli management region in maintenancemode and pauses until you kill the process.

wlocktmr


Com

mands

Authorizationsuper

wlocpath

1–354 Version 3.7.1

wlocpathReturns the path for the localized file or directory.

Syntaxwlocpath path [–d default_path] [–l language] [–ooutput]

DescriptionThis command searches for the localized file or directory and then printsthe path to standard output. If the path is not found, the command returnsnothing.

Note: This is the command line interface (CLI) command for thetis_get_loc_path function.

The wlocpath command uses theLANG environment variable to findthe message catalog appropriate for the current language environment.For example, if

LANG=fr_FR

and

NLSPATH=/tivoli/msg_cat/%L/%N.cat;\

/tivoli/msg_cat/%L%N.cat;\

/tivoli/msg_cat/C/%N.cat

Thewlocpath command tries the following path names to find themessage catalog:

/tivoli/msg_cat/fr_FR/ catalog_name .cat

/tivoli/msg_cat/fr/ catalog_name .cat

/tivoli/msg_cat/C/ catalog_name .cat

After the message is retrieved and bound, the resulting string is writtento standard output.

Options–d default_pathIdentifies the default path. If the command to obtain the

valid path from the path option fails, this option is used.

wlocpath


Com

mands

–l language Identifies the language name. If this option is notspecified, the current LANG environment option isused.

–ooutput Identifies the name of the output file instead of writingto the standard output.

path Inputs the path string. If this string contains “%L”, it issubstituted with the language name.

AuthorizationThis command does not require any Tivoli management regionauthorization roles to be executed.

ExamplesThe following example looks for thequery.txt file in the./msg_cat/%Lpath:wlocpath ./msg_cat/%L/query.txt -d/tmp –l fr

The result is what the LANG environment variable is for this file. If thisvariable is not found, the–doption looks in the/tmp path. If the variableis still not found, the–l option looks in the/fr path.

wlookup

1–356 Version 3.7.1

wlookupSearches for a resource instance in the Tivoli name registry.

Syntaxwlookup –l –R

wlookup –a [–L –o] –r resource_type

wlookup –r resource_type resource_name

wlookup –r resource_type–n instance_name { resource_name | –a}

DescriptionThewlookup command searches a resource’s object information in theTivoli name registry. If no type is specified, the default resource type isdistinguished. If neither –L nor–o are specified, both the objectidentifier and label of the specified resource are returned. If–l and –Rare specified, the time stamps for the modified resource types are listed.

Options–a Lists all instances of the specified resource type in the

name registry.

–l Lists the dates that the resource types were modified.

–L Lists the label of the specified resource without itsobject identifier.

–n instance_nameLooks up a nested resource under the specified instance.

–o Lists the object identifier of the specified resourcewithout its label.

–r resource_typeSpecifies the resource type to be retrieved. If omitted,the default resource type isdistinguished.

–R Displays a list of all resource types that are registered.

resource_nameSpecifies the name under which the resource isregistered.

wlookup


Com

mands


Examples1. The following example looks up all distinguished resources in the

Tivoli name registry:

wlookup -a

2. The following example displays a list of all registered resourcetypes:

wlookup -R

3. The following example displays all instances of the policy regionresource type:

wlookup -r PolicyRegion -a

4. The following example displays the object information for aparticular instance (MyTask) of a resource type (TaskLibrary ):

wlookup -r TaskLibrary MyTask

5. The following example displays theTaskExecute resources onmanaged nodevail:

wlookup -r ManagedNode -n vail TaskExecute

See Alsowregister

wls

1–358 Version 3.7.1

wlsLists a collection’s member objects.

Syntaxwls [–dlo] [path]

DescriptionThewls command lists the members of the selected collection.

Options–d Lists information about the collection itself, but not

about the collection members.

–l Lists the object identifier and the label of each member.

–o Lists the object identifier of each member.

path Specifies the path to the collection object whosemembers are to be listed. Valid formats for thepathoption are as follows:



The default collection is the current working collection.

If the –l and–o options are omitted, this command lists only themembers’ labels.

AuthorizationYou must have at least theuser role in a group that the collection is amember of.

wls


Com

mands

Examples1. The following example lists the members of the current working

collection:

wls

2. The following example lists the object identifiers and the labels ofthe members of theAdministrators collection. This command ishelpful in identifying administrators (or other objects) removedfrom the desktop but not deleted from the Tivoli database.

wls -l /Administrators

3. The following example lists the objects on administrator Jorge’sdesktop:

wls @Administrator:jorge

See Alsowcd, wpwd

wlsconn

1–360 Version 3.7.1

wlsconnLists the current Tivoli management region connections or informationabout a single connection, and completes the exchange of connectioninformation if the connection process could not.

Syntaxwlsconn [region_name]

wlsconn –uregion

DescriptionThewlsconn command lists current Tivoli management regionconnection information including region number, port, connectionmode, and resources and when they were last exchanged. If the–uoption is specified,wlsconn completes the exchange of connectioninformation between the local region and the connected remote region.If no options are specified,wlsconnlists all current connections with thelocal region.

When exchanging resources between connected regions, it is useful tocompare the output from thewlookup –l –R command to the outputfrom thewlsconn command to determine which resources to update.

If the –u option is specified,wlsconn completes the exchange ofconnection information if the connection process could not. If you usesecure procedures to create a one-way connection in which the first sideis the managing server and the second side is the managed server, youmust use this command with the–u option to exchange connectioninformation.

Options–u region Updates the Tivoli management region name, remote

server name, and other cached interregion informationwith the current information from the specified remoteregion.

region_name Specifies the name of the remote Tivoli managementregion.

wlsconn


Com

mands

Authorizationsuper if the–u option is specified; otherwise,user.

Examples1. The following example lists all current connections to the local

Tivoli management region:

wlsconnMODE NAME SERVER REGION<--> morie-Region morie 3333333333---> amon-sul-Region amon-sul 5555555555<--- ceridwen-Region ceridwen 2222222222

2. The following example lists the connection information for theconnection between the local region and a region namedmorie-Region:

wlsconn morie-RegionName: morie-RegionServer:morieRegion:3333333333Mode:two_wayPort:94

Resource Name Last Exchange--------------- ---------------TMF_Notice Fri Jan 09 11:33:10 1998Administrator Fri Jan 02 13:13:15 1998PolicyRegion Tue Jan 13 10:00:38 1998TaskLibrary Tue Nov 04 10:02:34 1997Job Wed Dec 31 19:00:00 1969QueryLibrary Wed Dec 31 19:00:00 1969Query Wed Dec 31 10:00:00 1969ProfileManager Wed Nov 05 17:49:38 1997ManagedNode Tue Jul 07 19:24:34 1998Repeater Thu Sep 04 10:04:32 1997CheckDB Thu Sep 04 20:04:23 1997RemoveNode Thu Sep 04 20:04:23 1997HTTPRealm Tue Nov 04 20:03:22 1997HTTPRealmMakerGroup Thu Sep 04 20:07:22 1997HTTPRealmMaker Thu Sep 04 20:07:23 1997DependencyMgr Thu Sep 04 20:07:23 1997Gateway Wed Dec 31 19:00:00 1969Endpoint Wed Dec 31 19:00:00 1969

wlsconn

1–362 Version 3.7.1

3. The following example exchanges connection informationbetween the local region and a region namedmorie_Region:

wlsconn -u morie-Region

See Alsowconnect, wdisconn, wlookup, wupdate

wlsendpts


Com

mands

wlsendptsLists all the endpoints subscribed to a profile manager.

Syntaxwlsendpts [–l] profile_manager

DescriptionThewlsendpts command lists all the endpoints directly or indirectlysubscribed to the specified profile manager. The endpoints listed may beon the first subscription level (that is, profile manager to subscriber) oron any subscription level below that (such as profile manager to profilemanager or profile manager to endpoint).

Options–l Prints the object ID of the endpoint as well as the

endpoint label.

profile_managerSpecifies the name of the profile manager for which youwant a list of endpoints. Valid formats for theprofile_manager option are as follows:




Authorizationuser

wlsendpts

1–364 Version 3.7.1

ExamplesThe following example lists the endpoints subscribed to theAdminprofile manager:wlsendpts "@ProfileManager:Admin PM"pepper (ManagedNode)gumby (ManagedNode)

wlsinst


Com

mands

wlsinstLists the products and patches installed in a Tivoli management region.

Syntaxwlsinst {–a | –h | –l | –p | –P | –sname| –V} [ –ivh]

DescriptionThewlsinst command lists the installed products, the installed patches,or both products and patches. Adding the optional–i, –v, or –h optionsincludes host information with the product or patch list. The–snameoption searches for the specified product or patch. Product or patchnames with spaces must be enclosed in quotation marks.

Options–a Lists all products and patches installed in the Tivoli

management region.

–h Lists the host name and interpreter type of the machineson which the products or patches are installed.

–i Sorts output by interpreter type. This option must beused with either–v or –h.

–l Lists all the patches installed for those products thathave been patched. If none of the products have beenpatched, no output is given.

–p Lists all products installed in the Tivoli managementregion.

–P Lists all patches installed in the Tivoli managementregion.

–sname Lists the product or patch specified byname.

–v Lists all host names, interpreter types, and thedirectories in which the various components (forexample: binaries, libraries, or man pages) of eachproduct or patch were installed.

wlsinst

1–366 Version 3.7.1

–V Prints out the path to each component, replacing anyspace at the end of the path name with a slash.

Authorizationsuper, senior, admin, oruser

Examples1. The following example lists all products and patches installed in

the Tivoli management region:

wlsinst –a*---------------------------------------------------*

Product List*---------------------------------------------------*Tivoli Management PlatformTivoli/Admin 2.5*---------------------------------------------------*

Patch List*---------------------------------------------------*Tivoli Management Platform 3.0 Patch 3.0-TMP-0005Tivoli Management Platform 3.0 Service Pack 01

2. The following example lists only the products installed in theTivoli management region:

wlsinst -p*---------------------------------------------------*

Product List*---------------------------------------------------*Tivoli Management PlatformTivoli/Admin 2.5

3. The following example lists the products installed, the host nameand interpreter type on which each product was installed, and thedirectories in which each product was installed:

wlsinst -p -v*---------------------------------------------------*

Product List*---------------------------------------------------*Tivoli Management Platform

ida solaris2ALIDB /var/spool/Tivoli ida.dbAPPD /usr/lib/X11/app-defaultsBIN /usr/local/Tivoli/bin solaris2BIN /usr/local/Tivoli/bin solaris2

wlsinst


Com

mands

BUN /usr/local/Tivoli/bin client_bundleCAT /usr/local/Tivoli/msg_catCONTRIB /usr/local/Tivoli/bin solaris2/contribGBIN /usr/local/Tivoli/bin generic_unixLIB /usr/local/Tivoli/lib solaris2

tornado solaris2APPD /usr/lib/X11/app-defaultsBIN /usr/local/Tivoli/bin solaris2CAT /usr/local/Tivoli/msg_catCONTRIB /usr/local/Tivoli/bin solaris2/contribDB /var/spool/Tivoli tornado.dbGBIN /usr/local/Tivoli/bin generic_unixLIB /usr/local/Tivoli/lib solaris2

wlsnotif

1–368 Version 3.7.1

wlsnotifLists notices on an administrator’s bulletin board.

Syntaxwlsnotif [–g]

wlsnotif [–l] [–n ngroup]

DescriptionThewlsnotif command lists the notices on an administrator’s bulletinboard. The–g option directswlsnotif to list all the notification groups.The–l option directswlsnotif to list only the headers of notices insteadof the entire message. The–n option directswlsnotif to list notices onlyfrom a specified notice group. If–n is omitted, the notice data from allnotice groups is listed. If no options are provided towlsnotif, all noticesfrom all notice groups are listed. Thewlsnotif command restricts thenotice groups to the subset of notice groups that the administratorsubscribes to. In all cases, the output from this command is written tostandard output.

Options–g Lists the valid notice groups, one per line. When this

option is used, it overrides the other options.

–l Lists the headers of the notices on the administrator’sbulletin board. If this option is omitted, this commandlists the actual notices. Output is truncated to 40characters.

–n ngroup Specifies the notice group from which notices are to belisted or the specific notices to list. If this option isomitted, this command lists notices from all noticegroups.


wlsnotif


Com

mands

Examples1. The following example lists all notices from all notice groups. This

output could be extremely long, so it should be redirected to a file.

wlsnotifDate: Mon Nov 21 10:29:12 1994Notice-Group-Name: Tivoli AdministrationPriority: NoticeSent-By-Administrator: root@bald

A new IP interface was added on bald by [email protected]: le1address: 146.84.49.3name: bald2

2. The following example lists all the notification groups to which theadministrator is subscribed:

wlsnotif -gTivoli AdministrationTivoli AuthorizationTivoli DiagnosticsTivoli Scheduler

3. The following example lists the header of all messages on theadministrator’s bulletin board:

wlsnotif -l#1 Mon Nov 21 10:29:12 A new IP interface was added onbald by#2 Mon Nov 21 10:30:25 An IP interface was deleted frombald by#3 Mon Nov 21 10:34:32 Deleted Objects#4 Mon Nov 21 10:37:08 A new task, date_task, wascreated by ro#5 Mon Nov 21 10:39:35 The task, date_task, of themy_tasks tas#6 Mon Nov 21 10:48:26 A new task, date_task2, wascreated by r#7 Mon Nov 21 10:49:33 The task, date_task2, of themy_tasks ta#8 Mon Nov 21 10:50:45 The task, date_task2, of themy_tasks ta#9 Mon Nov 21 10:55:52 A new task, find_cores, wascreated by r#10 Mon Nov 21 13:06:51 Created profile managermarketing.#11 Mon Nov 21 13:31:55 The job, date_job, wascreated by root@b

wlsnotif

1–370 Version 3.7.1

See Alsowexpnotif, wsndnotif, wtailnotif

wlspol


Com

mands

wlspolLists available policy default and validation objects for a Tivolimanaged resource type.

Syntaxwlspol [–d | –v] resource

DescriptionThewlspol command lists the names of the policy default objects andpolicy validation objects for the specified managed resource type.

Options–d Lists the labels of the policy default objects for the

specified managed resource type. Policy default objectsgenerate default attribute values for resources created ina policy region. This action is the default unless the–voption is specified.

–v Lists the labels of the policy validation objects for thespecified managed resource type. Policy validationobjects validate attribute values for managed resources.

resource Specifies the managed resource type whose policydefault objects or policy validation objects are to belisted.


ExamplesThe following example lists all the policy validation objects for theProfileManager managed resource type:wlspol -v ProfileManager

wlspol

1–372 Version 3.7.1

See Alsowchkpol, wcrtpol , wcrtpr , wdelpol, wdelpr, wgetdfpol, wgetpolm,wlspolm, wputpolm

wlspolm


Com

mands

wlspolmLists policy methods for a Tivoli managed resource type or lists attributenames for a profile.

Syntaxwlspolm [–d | –v] class

wlspolm [–d | –v] profile

DescriptionThewlspolm class command lists the names of the policy methodsassigned to the specified managed resource typeclass. Thewlspolmprofile command lists the attribute names (properties that can havepolicies associated with them) for the specifiedprofile. The final optioncan be any managed resource type that supports policy methods (forexample, a host, Network Information Services [NIS] domain, or filepackage) or a profile.

The names listed by this command can be used as input for thewgetpolm andwputpolm commands.

The–d option lists default policies (default), and the–v option listsvalidation policies. To set default and validation policies for specificTivoli applications, see the application’s reference guide.

Options–d Lists the policy default methods. This action is the

default unless the–v option is specified.

–v Lists the policy validation methods.

class Specifies the managed resource type whose policymethods are to be listed.

profile Specifies the profile whose attribute names are to belisted.


wlspolm

1–374 Version 3.7.1


The following example lists all the policy methods on aProfileManager policy validation object:wlspolm -v ProfileManagerpm_val_remove_subscriberspm_val_remove_subscriptionpm_val_subscriberspm_val_subscription

For Configuration Change Management System (CCMS) profile usage:

The following command lists the properties that can have policiesassociated with them for the phone list profile namedEngineering:wlspolm -d @PhoneListProfile:Engineeringnamephoneaddresscitystatecountrypostalownertypecomment

See Alsowchkpol, wcrtpol , wcrtpr , wdelpol, wdelpr, wgetdfpol, wlspol,wputpolm

wlsrealms


Com

mands

wlsrealmsLists the currently registered HTTP 1.0 authentication realms.

Syntaxwlsrealms

DescriptionThewlsrealms command lists the currently registered HTTP 1.0authentication realms.

OptionsNone


ExamplesThe following example lists the currently registered HTTP 1.0authentication realms:wlsrealms

See Alsowaddrealm, wdelrealm, wstarthttpd , wstophttpd

wlssub

1–376 Version 3.7.1

wlssubLists the profile managers to which an object, including a managednode, Network Information Services (NIS) domain, endpoint, or profilemanager, subscribes.

Syntaxwlssub –l [–o]name

DescriptionThewlssub command lists the profile managers to which a managednode, NIS domain, endpoint, profile manager, or other objectsubscribes.

Options–l Specifies a long listing.

–o Lists the object identifier for each profile manager towhich an object subscribes. This object can include amanaged node, an NIS domain, an endpoint, or a profilemanager.

name Specifies the name of the object whose subscriptionsare to be listed. Valid formats for thenameoption are asfollows:

■ @domain_name

■ @NisDomain:domain_name

■ /Regions/PolicyRegionName/domain_name


wlssub


Com

mands

ExamplesThe following example lists all the profile managers to which managednodecook subscribes:wlssub @ManagedNode:cook

See Alsowcrtpr , wcrtprfmgr , wdistrib , wgetprf, wgetsub, wpopulate, wsub,wvalidate

wlstlib

1–378 Version 3.7.1

wlstlibLists the contents of a task library.

Syntaxwlstlib library_name

DescriptionThewlstlib command lists the contents of a task library.

Optionslibrary_name Specifies the name of the library to be listed.


ExamplesThe following example lists the contents of thequeue_lib task library:wlstlib queue_libClean Queue (task)Clean Queue (job)

See Alsowcrttlib

wmailhost


Com

mands

wmailhostSpecifies the mail server used by Tivoli Management Framework onWindows NT and Windows 2000 systems.

Syntaxwmailhost [host_name]

DescriptionThewmailhost command provides a Simple Mail Transfer Protocol(SMTP) connection for Windows NT and Windows 2000 systems in theTivoli environment. Issuewmailhost on any Windows NT orWindows 2000 computer that you add as a Tivoli management regionserver or managed node. The Tivoli tools that generate e-mail send it tothe mail server that you specify. Without thehost_name option,wmailhost prints the current mail server.

The mail server must be either an SMTP server or one connected withan SMTP gateway. For example, if the network mail server hasMicrosoft Exchange or Lotus Notes installed on a Windows NTcomputer, you must install SMTP gateway software on the computer.For more information about configuring for SMTP e-mail, see theTivoliEnterprise Installation Guide.

Optionshost_name Specifies the host name of the mail server.

ExamplesThe following example sets the mail server toloki :wmailhost loki

wmannode

1–380 Version 3.7.1

wmannodeReturns system information about a managed node in the Tivolienvironment.

Syntaxwmannodenode_name

DescriptionThewmannodecommand returns system information about a managednode in the Tivoli environment. The managed node must be up andavailable when this command is run.

Optionsnode_name Specifies the name of a managed node.


ExamplesThe following example lists the system information for managed nodeyankee:wmannode yankeeSystem Name : yankeeInterpreter : solaris2Install Directory : /usr/local/TivoliHost ID : 945bd30System Architecture : sun4mMemory Size (MB) : 48System Timezone : 360OS Name : SunOSOS Release : 5.3OS Version : Generic_101318-21

See Alsowdiskspace, whostid, wident, winstdir , winterp , wmemsize,wtimezone

wmdist


Com

mands

wmdistConfigures MDist 2 repeaters and manages distributions.

Syntaxwmdist –B [–A] [–f] repeater_name

wmdist [–f] –cdist_id [dist_id…]

wmdist [–f] [–h] –d dist_id[dist_id…]

wmdist –D [debug_level]

wmdist –edist_id[–t ep_label] [–n node_type] [state…]

wmdist –I repeater_name

wmdist –l [–a] [–i dist_id] [–v]

wmdist –M [TRUE | FALSE]

wmdist [–f] –p dist_id

wmdist –q dist_id

wmdist [–f] –r dist_id

wmdist –R [rim_object]

wmdist –srepeater_name [keyword=value…]

wmdist –T [database_purge_interval]

DescriptionThewmdist command provides MDist 2 repeater configuration andmanages distributions. To configure a repeater using the MDist 2service, see thewrpt command. If you have not configured an RDBMSInterface Module (RIM) database, you can only use the–s and–Ioptions. For more information about MDist 2 and its services, see theTivoli Management Framework User’s Guide.

Options–A Deletes all entries from a repeater’s depot. Because you

must delete a repeater’s queue before its depot, youmust always use the–A option with the–B option. Usethis command only if instructed to do so by your Tivoliservice provider.

wmdist

1–382 Version 3.7.1

–B repeater_nameDeletes all entries from a repeater’s queue. You mightwant to use this command in the following emergencysituations:

■ If a gateway does not start or if a gateway crashesand you cannot restart it.

■ If you issued awmdist –I command and observeddata segments in the repeater queue fromdistributions that are no longer active.

Note that deleting entries from a repeater’s queue doesnot update the status database. Use this command onlyif instructed to do so by your Tivoli service provider.

–cdist_id [dist_id…]Cancels one or more active distributions. Thedistribution is specified bydist_id.

–d dist_id[dist_id…]Deletes one or more distributions from the MDist 2database. The distribution is specified bydist_id.

–D [debug_level]Changes the level of log messages written by thedistribution manager to its log file,$DBDIR/distmgr.log. Thedebug_leveloptionspecifies a value from 0 (least information) to 9 (mostinformation). The default value is0. This file continuesto increase in size unless you delete unwanted data andmaintain the amount of information that gets logged.Issuing this command without a value prints the currentvalue.

–edist_id [–t ep_label] [–n node_type][state…]Lists endpoint status for a distribution. Suboptions areas follows:

–n node_type Filters output to only show repeaters orendpoints.

state… Lists statuses for nodes (endpoints andrepeaters) in the specified states. If not

wmdist


Com

mands

specified, thewmdist command listsstatuses for all nodes. Supported statesare as follows:

■ CANCELED

■ EXPIRED

■ FAILED

■ INTERRUPTED

■ PAUSED

■ READY

■ RECEIVING

■ REJECTED

■ SENDING

■ STORED

■ SUCCESSFUL

■ UNAVAILABLE

■ WAITING

–t ep_label Specifies endpoints of the distribution.If endpoints are specified, thewmdistcommand lists status of theseendpoints only. Otherwise, it listsstatuses of all endpoints.

–f Forces the operation and suppresses any confirmationprompt.

–h Forces the removal from the database of distributionsthat have not completed.

–I repeater_nameEnables you to view which distributions (or jobs) arebeing sent and received by a specific repeater. You alsocan view how many connections are available and howmany connection sessions are in use.

wmdist

1–384 Version 3.7.1

–l [–i dist_id] [–a] [–v]Lists distribution status. Options are as follows:

–a Returns active distributions only.

–i dist_id Specifies the distribution ID. When nodist_id is specified, thewmdistcommand returns statuses for alldistributions.

–v Returns all information about thestatus. If–v is not specified, thewmdist command returns keywordvalue information only.

–M [TRUE | FALSE]Controls whether an active MDist 2 distribution isaccessible to an endpoint that migrates to anothergateway. Specify TRUE to have the distributionaccessible by the migrated endpoint;FALSE to not. Ifno option is provided, the current setting is displayed.

–p dist_id Pauses a distribution.

–q dist_id Displays the nodes associated with a given distributionin an indented format that indicates the route. Eachnode displayed is suffixed with its state.

–r dist_id Resumes a distribution.

–R [rim_object] Allows the user to change the RIM object used by thedistribution manager to store status. The default value ismdist2. Issuing this command without a value prints thecurrent value.

–srepeater_name [keyword=value…]Configures a repeater (specified byrepeater_name)using one or more of the following keywords andvalues. Ifvalueis not specified, the existing options forthe specified repeater are displayed. When nokeyword=value pairs are listed, thewmdist –scommand returns the configurations currently in use.

wmdist


Com

mands

Options are as follows:

keyword=value…Keywords and values are as follows:

conn_retry_interval=secondsSpecifies the frequency (in seconds) thatunavailable or interrupted targets are retried.

debug_level=numberControls the number of log messages written tothe managed node repeater’s log files($DBDIR/rpt2log ). Logging for the gatewayrepeater is controlled using thewgatewaydebug_level command.

disk_max=max_size_MBSpecifies the amount of disk space allocated tothe repeater depot. Units are in megabytes(MB). If the disk_maxnumber equals zero, nolimit is enforced. This number should notexceed the size of the disk. Every distributionflowing through a repeater is stored at leasttemporarily in the depot. The depot must belarge enough to hold the largest distributionthat you expect to distribute.

Note: If the new value is greater than the oldvalue, changes are not effective untilyou restart the repeater.

execute_timeout=secondsSpecifies the amount of time (in seconds) anendpoint method has to return results after ithas received all a distribution’s data. Someapplications may be running scripts afterreceiving data but before returning results tothe repeater.

max_sessions_high=numberSpecifies the maximum number of concurrentconnections a repeater opens for high-prioritydistributions. These connections are shared

wmdist

1–386 Version 3.7.1

among all active distributions. If the repeaterruns out of high-priority connections, it tries touse a medium-priority connection.


max_sessions_low=numberSpecifies the maximum number of concurrentconnections a repeater opens for low-prioritydistributions. This number must be one orgreater. These connections are shared amongall active distributions. If the repeater runs outof low-priority connections, it waits for an openconnection to complete before openingadditional connections.


max_sessions_medium=numberSpecifies the maximum number of concurrentconnections a repeater opens formedium-priority distributions. Theseconnections are shared among all activedistributions. If the repeater runs out ofmedium-priority connections, it tries to use alow-priority connection.


mem_max=max_size_MBSpecifies the amount of memory (in MB) thatare used to buffer data being sent to targets.This improves performance by reducing thenumber of disk accesses to the depot. Thememory is shared among all activedistributions.

wmdist


Com

mands


net_load=KB_per_secondSpecifies the maximum amount of networkbandwidth (in kilobytes per second) that therepeater is allowed to use. This allocation isshared among all active distributions. Thisoption is used withtarget_netload.

notify_interval= minutesSpecifies the frequency (in minutes) of statusreporting. When thenotify_interval haselapsed or the distribution has completed on alltargets, the results are flushed. The results aresent to the application using MDist 2 andupdated in the MDist 2 database.

packet_size=numberSpecifies the number of bytes written to thenetwork during each send request.

permanent_storage={ TRUE | FALSE}Configures the repeater to be a depot. IfTRUE,the depot retains segments marked forpermanent storage by applications after theirdistribution finishes. IfFALSE, adistribution’s segments are deleted after therepeater finishes sending the distribution to allits targets.

retry_ep_cutoff=secondsSpecifies the amount of time (in seconds) tocontinue retrying an unavailable or interruptedendpoint. Unavailable or interrupted repeatersare retried until the distribution’s deadline hasbeen reached.

rpt_dir= path_nameSpecifies the parent directory used to hold thedepot directory and thestates directory. The

wmdist

1–388 Version 3.7.1

depot directory contains all the segmentsstored in the database and must have enoughfree space to hold the value ofdisk_max. Thestates directory contains the database thatholds the persistent state of the repeater’squeue.

send_timeout=secondsSpecifies the timeout (in seconds) used todetect a network or target failure while sendingdata. A target is allowed the number of secondsspecified by thesend_timeout option toreceive each packet on the network. If a timeoutoccurs, the distribution remains in therepeater’s queue and a retry occurs inconn_retry_interval seconds.

target_netload=KB_per_secondSpecifies the maximum amount of networkbandwidth (in kilobytes per second) that can besent to an individual target. The default value of0 disables this check. This command is usedwith net_load.

repeater_nameSpecifies the label, object ID of the repeater, or oneof the following options:

all Specifies all repeaters including the defaultsetting.

defaultSpecifies the default setting for a new repeater.

–T [database_purge_interval]Sets the interval (in seconds) at which completeddistributions are deleted from the RIM database. Settingthis interval allows the distribution manager toautomatically delete completed distributions from thedatabase and prevent the database from running out ofspace. Issuing this command without a value prints thecurrent value.

wmdist


Com

mands

Settingdatabase_purge_interval to -1 disablesdatabase purges. The default value is-1 .

AuthorizationTo cancel, delete, pause, or resume a distribution, you need either theseniorauthorization role or both theDist_control authorization role andtheRIM_view authorization role.

To change the level of log messages written by the distribution managerto its log file, configure the repeater with tuning options, change a RIMobject to store status, or set the interval at which completed distributionsare removed from the RIM database, you need theseniorauthorizationrole.

To display the internal state of the specified repeater and listdistributions in the queue and connections in use, list endpoint status fora distribution, or display nodes associated with a given distribution in anindented format that indicates the route, you need either theseniorauthorization role or theRIM_view authorization role.

To delete the contents of a queue, you need either theadmin, senior, orsuper role.

To control whether a distribution follows an endpoint that migrates toanother gateway while the distribution is active, you need theseniorauthorization role.

Examples1. The following example deletes all contents from both thezyrus

repeater’s queue and depot:

wmdist -B -A zyrus

Note: Use this command only if instructed to by your Tivoliservice provider.

2. The following example lists statuses of all endpoints for adistribution with ID11268691349760in state SUCCESSFUL andFAILED:

wmdist -e 11268691349760 SUCCESSFUL FAILED

wmdist

1–390 Version 3.7.1


Name Status Start Time End Time

hops SUCCESSFUL 2000.12.05 10:31:25 2000.12.05 10:31:29

starn FAILED 2000.12.05 10:31:25 2000.12.05 10:31:29

3. The following example views the contents of the queue on repeaterzyrus:

wmdist -I zyrus


Repeater: zyrus

Jobs in SEND queue: 1

Jobs in RECEIVE queue: 0

=== Session Information ===

Low: available = 40 used = 0

Medium: available = 10 used = 0

High: available = 5 used = 0

=== Distribution Information ===

External Id: 1185150392.113

Internal Id: 1185150392.113

Label: bobg20

Priority: 3

Application: mftp2debug

Target: endpt123 State: PAUSED

4. The following example lists complete information about all activedistributions:

wmdist -l -a -v

5. The following example returns the configurations currently in use:

wmdist -s

wmdist


Com

mands

Output is similar to the following:

repeater_id: 1589385886.1.560rpt_dir:D:/Tivoli/20000215/db/jachtermann1.db/tmppermanent_storage: TRUEmax_sessions_high: 5max_sessions_medium: 10max_sessions_low: 40disk_max: 500 (MB)mem_max: 64 (MB)send_timeout: 300 (secs)execute_timeout: 600 (secs)notify_interval: 30 (mins)conn_retry_interval: 900 (secs)retry_ep_cutoff: 7200 (secs)net_load: 100 (KB/sec)packet_size: 16 (KB)target_netload: 0 (KB/secdebug_level: 3

Note: The listed values are the default values for a UNIXrepeater. The default repeater directory for a Windows NTor Windows 2000 system is$DBDIR/tmp .

6. The following example setspermanent_storageto FALSE andthedisk_max to 51200 for all repeaters, including the defaultconfiguration:

wmdist -s all permanent_storage=FALSE disk_max=51200

7. The following example allows you to view settings for a repeaterID 182894525:

wmdist -s 182894525

Note that you can specify the label, object ID, or managed node IDof the repeater. Output similar to the following is displayed:

repeater_id: 182894525rpt_dir: /usr/local/Tivoli/rpt_dirpermanent_storage: TRUEmax_sessions_high: 5max_sessions_medium: 10max_sessions_low: 40disk_max: 500 (MB)mem_max: 64 (MB)send_timeout: 300 (secs)execute_timeout: 600 (secs)notify_interval: 30 (mins)

wmdist

1–392 Version 3.7.1

conn_retry_interval: 900 (secs)retry_ep_cutoff: 7200 (secs)net_load: 500 (KB/sec)packet_size: 16 (KB)target_netload: 0 (KB/sec)debug_level: 3

See Alsowdepot, wep, wmdistgui, wrpt

wmdistgui


Com

mands

wmdistguiStarts the MDist 2 service’s Tivoli Distribution Status console from themanaged node on which this command is run. This console enablesadministrators to monitor and control distributions across a network.

Syntaxwmdistgui

DescriptionThe Distribution Status console must be installed on the managed nodeprior to running the command. To run this command on a UNIXmachine, you must enable connections to the X Window System on theUNIX machine. You must also ensure that remote logins are enabled.

OptionsNone.

AuthorizationYou must have either thesenior or RIM_view authorization role toview the status.

wmemsize

1–394 Version 3.7.1

wmemsizeReports the amount of physical memory installed on a managed node.

Syntaxwmemsizenode_name

DescriptionThewmemsize command reports the amount of physical memoryinstalled on a managed node in the Tivoli installation. The managednode must be up and available.

The command’s output is the number of megabytes of physical memoryin the machine. The command writes the memory size to its standardoutput.

Optionsnode_name Specifies the name of the managed node on which to

report.


ExamplesThe following example displays the amount of memory installed onebbets.wmemsize ebbets64

wmerge


Com

mands

wmergePerforms a three-way file merge.

Syntax wmerge [–L " label1" [–L " label3" ]] [–p] [–q] " file1 file2 file3"

DescriptionThewmerge command incorporates all changes that lead fromfile2 tofile3 into file1. The result goes to standard output if–p is present, intofile1 otherwise.wmergeis useful for combining separate changes to anoriginal. Supposefile2 is the original, and bothfile1 andfile3 aremodifications offile2. wmerge combines both changes.

An overlap occurs if bothfile1 andfile3 have changes in a commonsegment of lines. On a few older hosts wherediff3 does not support the–E option,wmerge does not detect overlaps and merely supplies thechanged lines fromfile3. On most hosts, if overlaps occur,wmergeoutputs a message (unless the–q option is given) and includes bothalternatives in the result. The alternatives are delimited as follows:

<<<<<<< "file1""lines in file1""=======""lines in file3">>>>>>> "file3"

If there are overlaps, the user should edit the result and delete one of thealternatives. If the–L "label1" and –L "label3" options are given, thelabels are output in place of the namesfile1 andfile3 in overlap reports.

DiagnosticsExit status is 0 for no overlaps, 1 for some overlaps, and 2 for manyoverlaps.

AuthorAuthor: Walter F. Tichy.Revision Number: 1.1.6.2; Release Date: 1993/10/07.

wmerge

1–396 Version 3.7.1

Copyright © 1982, 1988, 1989 by Walter F. Tichy.Copyright © 1990, 1991 by Paul Eggert.

See Alsowco, wrcsmerge

wmrgaef


Com

mands

wmrgaefMerge custom dialogs into Tivoli Management Framework or a Tivoliapplication after upgrading.

Syntaxwmrgaef [–r resource…] –d path

DescriptionThewmrgaef command merges Tivoli Management Framework orTivoli application custom dialogs after an upgrade. You must first savethe custom dialogs with thewcatcher command.

Thewmrgaef command attempts to merge the custom dialog with theupgraded dialog. The more similar the original and the upgradeddialogs, the easier it is to merge the custom dialog.

If the original and upgraded dialogs are completely different, it ispossible that the merge may produce invalid Dialog SpecificationLanguage (DSL). In this case,wmrgaef indicates that it was unable tomerge that dialog. It saves the original dialog, the upgraded dialog, andthe merged attempt in the directory specified with thewcatchercommand.

Options–d path Specifies the path to the file containing the custom

dialogs (the output of thewcatcher command). Thisincludes both the path and the name of the directorywhere the custom dialog resides.

–r resource Specifies a resource type to merge. If you do not specifya resource type,wmrgaef reads all the custom dialogsin the specified directory and tries to merge them.

Authorizationsuper

wmrgaef

1–398 Version 3.7.1

ExamplesThe following example merges custom dialogs saved in/tmp/aef/my.dir:wmrgaef -d /tmp/aef/my.dir

See Alsowcatcher

wmrgini


Com

mands

wmrginiMerges groups and variables from one.INI file into another. Thiscommand should be run from an endpoint.

Syntaxwmrgini dest_file merge_file

DescriptionThewmrgini command merges the contents of one.INI file in another.For each variable inmerge_file, the command creates or replaces anidentical variable indest_file.

Optionsdest_file Specifies the name of the destination file.

merge_file Specifies the name of the file to merge.

ExamplesTo merge theSYSTEM.INI file into theWIN.INI file, enter thefollowing:wmrgini C:\TEMP\WIN.INI C:\TEMP\SYSTEM.INI

See Alsoweditini

wmv

1–400 Version 3.7.1

wmvMoves objects between collections.

Syntaxwmv [–I] label… collection

DescriptionThewmv command moves the specified objects from the currentworking collection into the specified collection. Both of this command’soptions can be full or partial label paths.

If you use this command to move an endpoint, run thewepsync_gatewayscommand to synchronize the endpoint data stored by theendpoint manager, gateways, and endpoints within the Tivolimanagement region.


to continue. This option is useful only when multiplelabels are passed to the command. The–I option allowsa move process to fail for individual objects, but thecommand continues to the next object to be moved.Without this option, if a move process fails for anindividual object, the command restores any objectsalready removed and then the command fails. Thedefault is for the command to fail when a suboperationfails.

collection Specifies the label of the destination collection. Thisoption can be a full label path (starting at the ‘/’collection), a partial label path (relative to the currentworking collection), or a simple name (to be found inthe current working collection). The default is thecurrent working collection. The linked objects becomemembers of the selected collection.

label… Specifies the labels of one or more objects to be moved.This option can be a full label path (starting at the ‘/’

wmv


Com

mands

collection), partial label path (relative to the currentworking collection), or simple name (to be found in thecurrent working collection).

Authorizationadmin, senior, orsuper in the policy region where the resource ismoving

ExamplesThe following example moves the ManagedNode objectceridwenfromthelost-n-found collection into the desktop collection for administratorRoot.wmv /lost-n-found/ceridwen /Administrators/Root_ceridwen-region

See Alsowep, wln

wpatch

1–402 Version 3.7.1

wpatchInstalls a Tivoli patch.

Syntaxwpatch [–csrc_dir] –i patch–n –y [install_variables]…managed_node

DescriptionThewpatch command installs a Tivoli patch when invoked on theTivoli management region server.

Options–csrc_dir Specifies the complete path to the directory containing

the installation image.

–i patch Specifies the index file from which the patch isinstalled. Index files have an.IND extension. You canenter the file name with or without the file extension.For example, if the source directory contains the fileTMF.IND , specifying either–i TMF or –i TMF.INDindicates the correct index file.

–n Installs the patch on all managed nodes that do notcurrently have the patch installed. This option isignored if a managed node is specified.

–y Specifies that the installation should proceed withoutconfirmation. By default, this command identifies theactions that must be taken to perform the installationand requests confirmation before continuing. Using thisoption,wpatch identifies the actions and performs theinstallation without requesting the confirmation.

install_variablesSpecifies patch-specific installation variables. Thesegenerally take the form@variable@=value. For detailsabout the installation options for a specific product and

wpatch


Com

mands

its patches, refer to the product and patchdocumentation.


managed_nodeSpecifies the managed node on which a Tivoli patch isinstalled. Multiple managed nodes can be specified. Ifno managed nodes are specified, the patch is installedon all managed nodes in the Tivoli management region.In most cases, this option is not specified.

Authorizationinstall_product

See Alsowclient, winstall, wserver

wping

1–404 Version 3.7.1

wpingAttempts to contact the object dispatcher on a host.

Syntaxwping host_name [timeout]

DescriptionThewping command attempts to contact the object dispatcher on thespecified host. If the target host’s object dispatcher responds, thiscommand prints the following to standard output:object dispatcher on host_name is alive

If the target host’s object dispatcher does not respond, this commandprints the following to standard output:no response from object dispatcher on host_name

Optionshost_name The name of the host to be contacted.

timeout The number of seconds to wait for the host to replybefore reporting that the host is inactive.


ExamplesThe following example shows the status of the object dispatcher onmanaged nodebald:wping baldobject dispatcher on bald is alive

See Alsowdate, wdiskspace, whostid, wifconfig, winstdir , winterp ,wmannode, wtimezone, wuname, wxterm

wpopulate


Com

mands

wpopulatePopulates a profile from system files.

Syntaxwpopulate [–o] source name

DescriptionThewpopulatecommand adds existing configuration information froma system managed by Tivoli Management Framework to a configurationprofile.

This command populates the profile identified byname based on theconfiguration found in a profile endpoint, such as a host or NetworkInformation Services (NIS) domain. Thesource option identifies theprofile endpoint from which to populate. The type of information withwhich the profile is populated depends on the profile type ofname. Forexample, ifname is a user profile, it is populated with users from thespecified host’spasswd file (or the specified NIS domain’s passwordmap).

If –o is specified, thewpopulate command overwrites the currentprofile contents. If–o is not specified, the contents fromsource areappended to the profile contents.

Options–o Specifies to overwrite the specified profile’s current

contents.

name Specifies the name of the profile to populate.

source Specifies the name of the profile endpoint from whichto populate.


wpopulate

1–406 Version 3.7.1

ExamplesThe following example populates theUsersprofile with the contents ofthepasswdfile on pinatubo. The content of the file is appended to theUsers profile.wpopulate @ManagedNode:pinatubo @UserProfile:Users

See Alsowcrtprf , wcrtprfmgr , wdistrib, wgetprf, wgetsub, wlssub, wsub,wunsub, wxterm

wputeppol


Com

mands

wputeppolReplaces an endpoint policy script that has been modified.

Syntaxwputeppol pol_name

DescriptionThewputeppol command replaces an endpoint policy script. After thescript has been modified, this command saves the changes by writing thescript to the Tivoli database. Script contents must be entered throughstandard input.

Optionspol_name Specifies the name of the policy script to be replaced.

Authorizationsenior

ExamplesThe following example saves changes made to the login policy script bywriting the policy script to the database:wputeppol login_policy < login_policy

See Alsowgeteppol

wputpolm

1–408 Version 3.7.1

wputpolmReplaces a policy method’s body.

Syntaxwputpolm [–C | –c value] [–d | –v] class name policy

wputpolm [–d | –v] [–F | –N] [–n | –C | –cvalue] [args='a1,…']profile policy

DescriptionThewputpolm command replaces the body of the specified policymethod. There are two forms for thewputpolm command; the form forreplacing a policy method of a traditional Tivoli managed resource, andthe form for replacing the value of a policy on a profile.

In the first form, theclass option specifies the type of resource, andname specifies the label of the policy object on which to act. If the–doption is specified,name specifies a policy default object name anddefault policy for the resource.

This form of the command can be used to define the policy method inone of two ways. It can read from its standard input the body of thepolicy method. In this form,wputpolm is intended for defining methodsthat are implemented as shell scripts. However, this form also works onbinary files and accepts an executable program from the standard input.The command can also define a policy method that has a constant value.In this form, it is not necessary to write a shell script. These constantmethods require less storage space and execute more quickly thanshell-script methods. The command can read the constant return valueeither from the command line, using the–cvalue option, or fromstandard input, if the–C option is specified.

In the second form of the command, the profile option specifies theprofile name, and thepolicy option specifies the individual attributewhose policy to set, as returned by thewlspolm command. The–C, –c,–d, and–v options behave identically for profiles and managedresources and can be used to install constant- or script-valued policies ona profile. When runningwputpolm on a profile, the–n option is alsoavailable. The–n option indicatesnone. Used with–d for a defaultpolicy, –n means that there is no default value for the individual

wputpolm


Com

mands

attribute. Used in conjunction with–v for a validation policy,–nindicates that any value is valid for the policy.

The–F and–N options are used to set the policy to be fixed or not fixed,respectively. If neither flag is specified, the fixed status of the policy isleft unchanged.

The optionalargs list is valid only for script-valued policies, andidentifies the input options to pass to the policy script. For any inputoptions of the form$attribute, whereattributeis the name of an attributeof the resource type, the attribute value is passed as input to the script.

Input

If the –C option is present, this command reads from the command’sstandard input the constant return value to be set for the policy method.

If the –c option is present, this command ignores its standard input.

If the –C and–coptions are both omitted, this command reads the bodyof the method (usually a shell script) from the command’s standardinput.

Options–cvalue Specifies that the policy method is defined always to

return the specified constant value.value is analphanumeric American National Standard Code forInformation Interchange (ASCII) string. Numericvalues are read and stored as strings. If this option andthe–C option are omitted, this command reads themethod’s body from standard input.

–C Specifies that the policy method is defined always toreturn the specified constant value read from thiscommand’s standard input. If this option and the–coption are omitted, this command reads the method’sbody from standard input.

–d Specifies that the method is a default policy.

–F Specifies that the policy is fixed and the subscriberscannot override it.

wputpolm

1–410 Version 3.7.1

–n Specifies that either there is no default value for theattribute of the policy or any value is valid for thepolicy.

–N Specifies that the policy is not fixed. After distribution,subscribers can override the policy.

–v Specifies that the method is a validation policy.

args=a1… Specifies additional arguments to the method.

class Specifies the managed resource type to which thepolicy is assigned.

name Specifies the name of the managed resource.

policy Specifies the name of the method whose body is to bedefined or replaced.

profile Specifies the profile to which the policy is assigned.

AuthorizationFor the first form of the command,super andpolicy

For the second form of the command,senior or super


1. The following command installs a new policy script for thepm_val_subscribers method of theRestricted policy validationobject forProfileManager. The script is read from standard input.

wputpolm -v ProfileManager Restricted pm_val_subscribers < \new_script

2. The following command sets the policy forpm_val_subscribersto be the constantTRUE, which means that all subscribers areaccepted:

wputpolm -v -c TRUE ProfileManager Restricted \pm_val_subscribers

wputpolm


Com

mands

For profile usage:

1. The following command installs a new default policy script foruser ID (UID) generation for the user profile namedEngineering.The policy is fixed so that subscribers cannot override it. The scripttakes the user’s real name and login name as its arguments. Thescript is read from standard input.

wputpolm -d -F args='$real_name,$login_name' \@UserProfile:Engineering uid < new_script

See Alsowchkpol, wcrtpol, wcrtpr , wdelpol, wdelpr, wgetdfpol, wgetpolm,wlspol, wlspolm

wpwd

1–412 Version 3.7.1

wpwdDisplays the current working collection.

Syntaxwpwd [–o]

DescriptionThewpwd command displays the label of the administrator’s currentworking collection for the current parent process ID. Each administratorhas a separate current working collection associated with each parentprocess ID.

Options–o Displays the collection’s object ID. If this option is

omitted, this command displays the collection’s label.


ExamplesThe following example displays the label of the current workingcollection:wpwd

See Alsowcd

wrcs


Com

mands

wrcsChanges Revision Control System (RCS) file attributes.

Syntaxwrcs [options] file…

DescriptionThe wrcs command creates new RCS files or changes attributes ofexisting ones. An RCS file contains multiple revisions of text, an accesslist, a change log, descriptive text, and some control attributes. Forwrcsto work, the caller’s login name must be on the access list, except if theaccess list is empty, the caller is the owner of the file or the super user,or the–i option is present.

Paths matching an RCS suffix denote RCS files; all others denoteworking files. Names are paired as explained inwci. Revision numbersuse the syntax described inwci.

Options–a logins Appends the login names appearing in the

comma-separated listlogins to the access list of theRCS file.

–A oldfile Appends the access list ofoldfile to the access list of theRCS file.

–b [rev] Sets the default branch torev. If rev is omitted, thedefault branch is reset to the (dynamically) highestbranch on the trunk.

–cstring Sets the comment leader to string. An initialwci, or awrcs –i without–c, guesses the comment leader fromthe suffix of the working file name.

This option is obsolescent, because RCS typically usesthe preceding$Log$ line’s prefix when inserting loglines during checkout (seewco). However, olderversions of RCS use the comment leader instead of the$Log$ line’s prefix, so if you plan to access a file with

wrcs

1–414 Version 3.7.1

both old and new versions of RCS, make sure that itscomment leader matches its$Log$ line prefix.

–e [logins] Erases the login names appearing in thecomma-separated listlogins from the access list of theRCS file. If logins is omitted, erases the entire accesslist.

–i Creates and initializes a new RCS file, but does notdeposit any revision. If the RCS file has no path prefix,tries to place it first into the subdirectory./RCS, andthen into the current directory. If the RCS file alreadyexists, prints an error message.

–I Runs interactively, even if the standard input is not aterminal.

–k subst Sets the default keyword substitution tosubst. Theeffect of keyword substitution is described inwco.Giving an explicit–k option towco, wrcsdiff , andwrcsmergeoverrides this default. Do not usewrcs –kv,because–kv is incompatible withwco –l. Usewrcs –kkv to restore the usual default keyword substitution.

–l [rev] Locks the revision with numberrev. If a branch isgiven, locks the latest revision on that branch. Ifrev isomitted, locks the latest revision on the default branch.Locking prevents overlapping changes. A lock isremoved withwci or wrcs –u.

–L Sets locking tostrict. Strict locking means that theowner of an RCS file is not exempt from locking forcheck in. This option should be used for files that areshared.

–m rev:msg Replaces revisionrev’s log message withmsg.

–M Does not send mail when breaking somebody else’slock. This option is not meant for casual use; it is meantfor programs that warn users by other means and invokewrcs –u only as a low-level lock-breaking operation.

wrcs


Com

mands

–n name[:[rev]]Associates the symbolic namenamewith the branch orrevisionrev. Deletes the symbolic name if both: andrev are omitted; otherwise, prints an error message ifnameis already associated with another number. Ifrevis symbolic, it is expanded before association. Arevconsisting of a branch number followed by a ‘.’ standsfor the current latest revision in the branch. A: with anemptyrev stands for the current latest revision on thedefault branch, typically the trunk. For example,wrcs–nname: RCS/* associatesnamewith the current latestrevision of all the named RCS files; this contrasts withwrcs–nname: RCS/*, which associatesnamewith therevision numbers extracted from keyword strings in thecorresponding working files.

–N name[:[rev]]Acts like–n, except overrides any previous assignmentof name.

–o range Deletes (“outdates”) the revisions given byrange. Arange consisting of a single revision number means thatrevision. A range consisting of a branch number meansthe latest revision on that branch. A range of the formrev1:rev2 means revisionsrev1 to rev2 on the samebranch,:rev means from the beginning of the branchcontainingrevup to and includingrev, andrev: meansfrom revisionrev to the end of the branch containingrev. None of the outdated revisions may have branchesor locks.

–q Runs quietly; does not print diagnostics.

–sstate[:rev] Sets the state attribute of the revisionrev to state. If revis a branch number, assumes the latest revision on thatbranch. Ifrev is omitted, assumes the latest revision onthe default branch. Any identifier is acceptable forstate. A useful set of states isExp (for experimental),Stab(for stable), andRel (for released). By default,wcisets the state of a revision toExp.

wrcs

1–416 Version 3.7.1

–t [file] Writes descriptive text from the contents of the namedfile into the RCS file, deleting the existing text. Thefilepath name may not begin with a dash (–). If file isomitted, obtains the text from standard input,terminated by end-of-file or by a line containing ‘.’ byitself. Prompts for the text if interaction is possible; see–I. With –i, descriptive text is obtained even if–t is notgiven.

–t - string Writes descriptive text fromstring into the RCS file,deleting the existing text.

–T Preserves the modification time on the RCS file unlessa revision is removed. This option can suppressextensive recompilation caused by amakedependencyof some copy of the working file on the RCS file. Usethis option with care; it can suppress recompilationeven when it is needed, that is, when a change to theRCS file would mean a change to keyword strings in theworking file.

–u [rev] Unlocks the revision with numberrev. If a branch isgiven, unlocks the latest revision on that branch. Ifrevis omitted, removes the latest lock held by the caller.Typically, only the locker of a revision may unlock it.Somebody else unlocking a revision breaks the lock.This causes a mail message to be sent to the originallocker. The message contains a commentary solicitedfrom the breaker. The commentary is terminated byend-of-file or by a line containing ‘.’ by itself.

–U Sets locking to non-strict. Non-strict locking means thatthe owner of a file need not lock a revision for check in.This option shouldnotbe used for files that are shared.Whether default locking is strict is determined by yoursystem administrator, but it is typically strict.

–V Prints RCS’s version number.

–V n Emulates RCS Versionn. Seewco for details.


wrcs


Com

mands

–zzone Useszone as the default time zone. This option has noeffect; it is present for compatibility with other RCScommands.

At least one explicit option must be given to ensure compatibility withfuture planned extensions to thewrcs command.

Compatibility

The–b rev option generates an RCS file that cannot be parsed by RCSVersion 3 or earlier.

The–k substoptions (except–k kv) generate an RCS file that cannot beparsed by RCS Version 4 or earlier.

Usewrcs –V n to make an RCS file acceptable to RCS Versionn bydiscarding information that would confuse Versionn.

RCS Version 5.5 and earlier does not support the–x option and requiresa ,v suffix on an RCS path name.

DiagnosticsThe RCS path name and the revisions outdated are written to thediagnostic output. The exit status is zero if and only if all operationswere successful.

Fileswrcs accesses files much aswci does, except that it uses the effectiveuser for all accesses, it does not write the working file or its directory,and it does not read the working file unless a revision number of $ isspecified.



DefectsA catastrophe (for example, a system crash) can cause RCS to leavebehind a semaphore file that causes later invocations of RCS to claim

wrcs

1–418 Version 3.7.1

that the RCS file is in use. To fix this, remove the semaphore file. Asemaphore file’s name typically begins with, or ends with _.extensionsto thewrcs command.

The separator for revision ranges in the–ooption used to be– instead of:, but this leads to confusion when symbolic names contain–. Forbackward compatibility,wrcs –ostill supports the old– separator, but itwarns about this obsolete use.

Symbolic names need not refer to existing revisions or branches. Forexample, the–o option does not remove symbolic names for theoutdated revisions; you must use–n to remove the names.

AuthorAuthor: Walter F. Tichy.Revision Number: 5.13; Release Date: 1995/06/05.Copyright © 1982, 1988, 1989 by Walter F. Tichy.Copyright © 1990, 1991, 1992, 1993, 1994, 1995 by Paul Eggert.

See Alsowco, wci, wident, wrcsdiff , wrcsmerge, Walter F. Tichy, RCS—ASystem for Version Control,Software—Practice & Experience15, 7(July 1985), 637-654.

wrcsdiff


Com

mands

wrcsdiffCompares Revision Control System (RCS) revisions.

Syntaxwrcsdiff [–k subst] [–q] [–r rev1 [–r rev2]] [–T] [–V n] [–x suffixes][–zzone] [diff_options] file…

DescriptionThewrcsdiff command runsdiff to compare two revisions of each RCSfile given.


The option–q suppresses diagnostic output. Zero, one, or two revisionsmay be specified with–r. The option–k subst affects keywordsubstitution when extracting revisions, as described inwco; for example,–k k–r1.1–r1.2 ignores differences in keyword values when comparingrevisions1.1 and1.2. To avoid excess output from locker namesubstitution,–k kvl is assumed if (1) at most one revision option isgiven, (2) no–k option is given, (3)–k kv is the default keywordsubstitution, and (4) the working file’s mode would be produced bywco–l. Seewco for details about–T, –V, –x, and–z. Otherwise, all optionsof diff that apply to regular files are accepted, with the same meaning asfor diff .

If both rev1andrev2are omitted,wrcsdiff compares the latest revisionon the default branch (by default the trunk) with the contents of thecorresponding working file. This is useful for determining what youchanged since the last check in.

If rev1is given, butrev2is omitted,wrcsdiff compares revisionrev1ofthe RCS file with the contents of the corresponding working file.

If both rev1 andrev2 are given,wrcsdiff compares revisionsrev1 andrev2 of the RCS file.

Both rev1 andrev2 may be given numerically or symbolically.

wrcsdiff

1–420 Version 3.7.1

DiagnosticsExit status is 0 for no differences during any comparison, 1 for somedifferences, 2 for many differences.



ExamplesThe following command compares the latest revision on the defaultbranch of the RCS file to the contents of the working filef.c:wrcsdiff f.c

AuthorAuthor: Walter F. Tichy.Revision Number: 5.5; Release Date: 1993/11/03.Copyright © 1982, 1988, 1989 by Walter F. Tichy.Copyright © 1990, 1991, 1992, 1993 by Paul Eggert.

See Alsowco, wci, wident, wrcsdiff , wrlog, Walter F. Tichy, RCS—A Systemfor Version Control,Software—Practice & Experience15, 7 (July1985), 637-654.

wrcsmerge


Com

mands

wrcsmergeMerges Revision Control System (RCS) revisions.

Syntaxwrcsmerge [options] file

DescriptionThe wrcsmerge command incorporates the changes between tworevisions of an RCS file into the corresponding working file.


At least one revision must be specified with one of the options describedbelow, usually–r. At most two revisions may be specified. If only onerevision is specified, the latest revision on the default branch (typicallythe highest branch on the trunk) is assumed for the second revision.Revisions may be specified numerically or symbolically.

wrcsmerge prints a warning if there are overlaps and delimits theoverlapping regions as explained inmerge. The command is useful forincorporating changes into a checked-out revision.

Options–k subst Usessubst style keyword substitution. Seewco for

details. For example,–kk–r1.1–r1.2 ignoresdifferences in keyword values when merging thechanges from1.1 to 1.2.

–p [rev] Sends the result to standard output instead ofoverwriting the working file.

–q [rev] Runs quietly; does not print diagnostics.

–r [rev] Merges with respect to revisionrev. Here an emptyrevstands for the latest revision on the default branch,typically the head.

–V n Emulates RCS versionn. Seewco for details.

wrcsmerge

1–422 Version 3.7.1


DiagnosticsExit status is 0 for no overlaps, 1 for some overlaps, 2 for many overlaps.



Examples1. Suppose you have released revision 2.8 off.c. Assume furthermore

that after you complete an unreleased revision 3.4, you receiveupdates to release 2.8 from someone else. To combine the updatesto 2.8 and your changes between 2.8 and 3.4, put the updates to 2.8into file f.c and execute the following command:

wrcsmerge –p –r2.8 –r3.4 f.c >f.merged.c

Then examinef.merged.c. Alternatively, if you want to save theupdates to 2.8 in the RCS file, check them in as revision 2.8.1.1 andexecutewco –j:

wci –r2.8.1.1 f.cwco –r3.4 –j2.8:2.8.1.1 f.c

2. As another example, the following command undoes the changesbetween revision 2.4 and 2.8 in your currently checked out revisionin f.c:

wrcsmerge –r2.8 –r2.4 f.c

Note the order of the options and thatf.c is overwritten.


wrcsmerge


Com

mands

See Alsowco, wci, wident, wrcsdiff , wrcsmerge, wrlog, Walter F. Tichy,RCS—A System for Version Control,Software—Practice &Experience15, 7 (July 1985), 637-654.

wrefresh

1–424 Version 3.7.1

wrefreshRefreshes a Tivoli collection window.

Syntaxwrefresh collection

DescriptionThewrefresh command refreshes the collection window of thespecified collection.

Optionscollection Specifies which collection window is refreshed. To

refresh theAdministrators window, use the followingformat:

/Administrators/ administrator_name

To refresh other collection windows, use one of thefollowing formats:

/Regions/top_level_region_name/subregion_name@NisDomain:domain_name

Authorizationuser

Examples1. The following example refreshes every instance of administrator

Callahan’s desktop. If multiple Callahan desktops are open, all arerefreshed.

wrefresh /Administrator/Callahan

2. The following example refreshes all instances of theNew Yorkpolicy region:

wrefresh @PolicyRegions:NewYork

wregister


Com

mands

wregisterRegisters a new resource instance with the name registry.

Syntaxwregister –i [–f n] –r resource_typewregister [–i [–f n] –r resource_type] name objectwregister –u [–r resource_type] name

DescriptionThewregister command registers a new resource instance with theTivoli name registry. The command optionally initializes the cache fora new resource type. If–r is not specified, the default isdistinguished.

Options–f n Specifies that the resource type being created should be

nonexchangeable. Nonexchangeable resource typescannot be updated between connected Tivolimanagement regions.

–i Initializes the resource cache. If this option is notspecified and the specified resource type does notalready exist in the cache,wregistergenerates an error.

–r resource_typeSpecifies the resource type of the resource to beregistered. If omitted, the default resource type isdistinguished.

–u Removes a resource from a resource type.

name Specifies the name under which the resource is to beregistered.

object Specifies the object reference of the resource.


wregister

1–426 Version 3.7.1

Examples1. The following example adds a new resource type,MyResource, to

the name registry. The new resource type is nonexchangeable.

wregister -i -f n -r MyResource

2. The following example adds a resource namedmylabel toMyResource. The object ID formylabel is 400004.34.26.

wregister -r MyResource mylabel 400004.34.26

3. The following example removes the resourcemylabel fromMyResource.

wregister -r MyResource -u mylabel

4. The following example adds a new resource type,YourResource,and adds a resource namedyourlabel to YourResource. Theobject ID ofyourlabel is 400005.35.37.

wregister -i -r YourResource yourlabel 400005.35.37

See Alsowlookup

wrestart


Com

mands

wrestartInitiates a system restart and optional restart. (Windows NT andWindows 2000 only)

Syntaxwrestart [–b] [–c] [–f] [–t timeout_value] [–m " confirm_message" ]

DescriptionThewrestart command initiates a system restart and optional restart.

Options–b Restarts the system after shutdown.

–c Prompts the user for confirmation before restarting thesystem.

–f Forces a restart in spite of unsaved changes in otherapplications. This option does not cause applications toprompt users to save their changes.

–m " confirm_message"Specifies the confirmation message that is displayed.

–t timeout_valueSpecifies the number of seconds this command waitsfor user confirmation before initiating a restart.

Examples1. To prompt the user for confirmation before restarting the system,

enter the following command:

wrestart -c

2. To display a warning message before restarting the system in 60seconds, enter the following command:

wrestart -m "WARNING: The system will reboot in 60 \seconds!!" -t 60

wrimtest

1–428 Version 3.7.1

wrimtestVerifies an RDBMS Interface Module (RIM) object’s connectivity andfunctionality.

Syntaxwrimtest [–l RIM_object_label]

DescriptionThewrimtest command is an interactive command-line utility thatenables you to connect to a specified database and execute RIMmethods. If you do not specify the–l option, the default RIM object isinventory. Use thewlookup –ar RIM command to view a list ofavailable RIM objects.

Options–l RIM_object_label

Specifies the RIM object you want to test. Thewrimtest command connects to the database specifiedby RIM_object_label. A prompt enables you to enterone of the following command options:

c: RIM_commitCommits a transaction.

d: RIM_delete Deletes a row from the database.

e: RIM_execute_sqlExecutes a Structured Query Language(SQL) statement.

g: RIM_retrieve_rowsRetrieves rows from the database.

i: RIM_insert_rowsInserts a row into the database.

r: RIM_rollbackCancels a transaction.

wrimtest


Com

mands

u: RIM_update_rowsUpdates rows in the database.

?: Help List Prints a list of command options.

x: Exit Exits thewrimtest utility.

Authorizationrim_view, rim_update

ExamplesThe following example lists the attribute values for thetecRIM object.Following the list, the user is prompted for a command option.wrimtest -l tecResourceType:RIMResource Label:tecHost Name:lynxUser Name:tecVendor:SybaseDatabase:tecDatabase Home:/data/sybaseServer ID:tecInstance Home:Opening Regular Session…Session OpenedRIM : Enter Option >

See Alsowrimtrace

wrimtrace

1–430 Version 3.7.1

wrimtraceEnables or disables tracing for RDBMS Interface Module (RIM)objects.

Syntaxwrimtrace RIM_object_label [INFORMATION | ERROR |TRACE_OFF]

DescriptionThewrimtrace command enables or disables tracing for RIM objects.The contents of the Inter-Object Messaging (IOM) packets passedbetween the RIM object and client program and relational databasemanagement system (RDBMS) errors are printed to the RIM log filelocated in/tmp/rim_db_log. You can locate and change the defaultlocation of the RIM log file by following these steps:

1. Run the following command:

odadmin environ get > env.out

2. Edit theenv.out file and add the following:

RIM_DB_LOG=/tivoli/rim/rim_db_log

3. Run the following command:

odadmin environ set < env.out

Executing thewrimtrace command without a trace level option(INFORMATION , ERROR, orTRACE_OFF) prints the currenttrace level to standard output. The tracing function is intended fordebugging purposes. If enabled for extended periods of time, tracing candecrease performance and slow the processing of RIM callsconsiderably.

Note: When you change the RIM tracing level, you must manuallylocate and terminate the appropriateRIM_ database_prog orRIM _database_Agent process on your machine. RIMprocesses include the following:

Oracle RIM_Oracle_prog andRIM_Oracle_Agent

Sybase RIM_Sybase_prog

wrimtrace


Com

mands

DB2 RIM_DB2_prog

Microsoft SQL RIM_MS_SQL_prog

OptionsRIM_object_label

Specifies the RIM object you want to trace.

Choose one of the following trace levels:

ERROR Prints RDBMS errors to the RIM log file.

INFORMATIONPrints the contents of Inter-Object Messaging (IOM)packets to the RIM log file.

TRACE_OFF Turns tracing off.

Examples1. The following example prints the current trace level of the Tivoli

Inventory RIM object:

wrimtrace inventory

2. The following example prints IOM packet information to the RIMlog file:

wrimtrace inventory INFORMATION

3. The following example prints IOM packet information andRDBMS errors to the RIM log file:

wrimtrace inventory "INFORMATION|ERROR"

4. The following example turns RIM tracing off:

wrimtrace inventory TRACE_OFF

See Alsowrimtest

wrlog

1–432 Version 3.7.1

wrlogPrints log messages and other information about Revision ControlSystem (RCS) files.

Syntaxwrlog [options] file…

DescriptionThe wrlog command prints information about RCS files.


wrlog prints the following information for each RCS file: RCS pathname, working path name, head (for example, the number of the latestrevision on the trunk), default branch, access list, locks, symbolicnames, suffix, total number of revisions, number of revisions selectedfor printing, and descriptive text. This is followed by entries for theselected revisions in reverse chronological order for each branch. Foreach revision,wrlog prints revision number, author, date and time, state,number of lines added or deleted (with respect to the previous revision),locker of the revision (if any), and log message. All times are displayedin Coordinated Universal Time (UTC). Without options,wrlog printscomplete information. The following options restrict this output.

Options–b Prints information about the revisions on the default

branch, typically the highest branch on the trunk.

–d dates Prints information about revisions with a check-in dateand time in the ranges given by the semicolon-separatedlist of dates. A range of the formd1<d2ord2>d1selectsthe revisions that were deposited betweend1 andd2inclusive. A range of the form<d or d> selects allrevisions datedd or earlier. A range of the formd< or>d selects all revisions datedd or later. A range of theform d selects the single, latest revision datedd orearlier. The date and time stringsd, d1, andd2are in the

wrlog


Com

mands

free format explained inwco. Quoting is typicallynecessary, especially for< and>. Note that theseparator is a semicolon.

–h Prints only the RCS path name, working path name,head, default branch, access list, locks, symbolicnames, and suffix.

–l [lockers] Prints information about locked revisions only. Inaddition, if the comma-separated listlockers of loginnames is given, ignores all locks other than those heldby lockers. For example,wrlog –L –R –l wft RCS/*prints the name of RCS files locked by the userwft .

–L Ignores RCS files that have no locks set. This isconvenient in combination with–h, –l, and–R.

–r [revisions] Prints information about revisions given in thecomma-separated list,revisions, of revisions andranges. A rangerev1:rev2means revisionsrev1to rev2on the same branch,:rev means revisions from thebeginning of the branch up to and includingrev, andrev: means revisions starting withrev to the end of thebranch containingrev. An option that is a branch meansall revisions on that branch. A range of branches meansall revisions on the branches in that range. A branchfollowed by a ‘.’ means the latest revision in thatbranch. A bare–r without revisions means the latestrevision on the default branch, typically the trunk.

–R Prints only the name of the RCS file. This is convenientfor translating a working path name into an RCS pathname.

–sstates Prints information about revisions whose stateattributes match one of the states given in thecomma-separated liststates.

–t Prints the same information as–h, timeout plus thedescriptive text.

–V n Emulates RCS versionnwhen generating logs. Seewcofor more details.

wrlog

1–434 Version 3.7.1

–w [logins] Prints information about revisions checked in by userswith login names appearing in the comma-separated listlogins. If loginsis omitted, the user’s login is assumed.


wrlog prints the intersection of the revisions selected with the options–d, –l, –s, and–w, intersected with the union of the revisions selected by–b and–r.

DiagnosticsThe exit status is zero if, and only if, all operations were successful.



Examples1. The following command prints the names of all RCS files in the

subdirectoryRCS that have locks:

wrlog -L -R RCS/*

2. The following command prints the headers of those files:

wrlog -L -h RCS/*

3. The following command prints the headers plus the log messagesof the locked revisions:

wrlog –L –l RCS/*

4. The following command prints complete information:

wrlog RCS/*

DefectsThe separator for revision ranges in the–r option used to be– instead of:, but this leads to confusion when symbolic names contain–. Forbackward compatibility,wrlog –r still supports the old– separator, butit warns about this obsolete use.

wrlog


Com

mands


See Alsowco, wci, wident, wrcs, wrcsdiff , wrcsmerge, wrlog, Walter F. Tichy,RCS—A System for Version Control,Software—Practice &Experience15, 7 (July 1985), 637-654.

wrm

1–436 Version 3.7.1

wrmRemoves objects from a collection.

Syntaxwrm [–I] label…

DescriptionThewrm command removes the specified objects from the collection.label can be a label or a label path. This command removes onlyreferences to objects; it does not delete the objects themselves.


to continue. This option is useful only when multiplelabels are passed to the command. The–I option allowsa removal operation to fail for individual objects, butthe command continues to the next object to beremoved. Without this option, if a remove operationfails for an individual object, the command restores anyobjects already removed, and then the commandterminates with an error. The default is for thecommand to fail when the suboperation fails.

label… Specifies the labels of or label paths to the objects to beremoved. Objects are specified similarly to UNIX filenames. If a label path (full or relative) is specified, theobject is removed from the collection that the label pathnames; that is, the object is removed from the collectionnamed by the label path less its final component. If onlythe unadorned object label is specified, the object isremoved from the current working collection.


wrm


Com

mands

ExamplesThe following example removes the ManagedNode objectceridwenfrom the Administrators collection. The object itself is not removed.wrm /Administrators/Root_ceridwen-region/ceridwen

See Alsowdel

wrmnode

1–438 Version 3.7.1

wrmnodeRemoves a managed node from a Tivoli installation.

Syntaxwrmnode [–f] node_name [–d dispatcher_number][node_name [–d dispatcher_number]]…

DescriptionThewrmnode command removes the specified managed node from theTivoli database. For a UNIX managed node, this command shuts downthe dispatcher, and then removes the node from the Tivoli database.

Managed nodes are specified by name. If a managed node has beendamaged, it may be necessary to provide the dispatcher number. Thisnumber can be obtained by using theodadmin odlist command.

This command does not remove the Tivoli management region server.

After usingwrmnode, you may want to verify the database with thewchkdb command. This ensures that there are no references to the node.

Options–d dispatcher_number

Shuts down the specified dispatcher and removes adamaged managed node.

–f Performs all requested removals without requiringconfirmation from the user.

node_name Specifies the name of the managed node to be removed.

Authorizationinstall-client, super

NotesThis command does not remove the Tivoli executables, databases, andother files from the affected managed node.

wrmnode


Com

mands

Examples1. The following example removes the managed nodeshermanfrom

the Tivoli database:

wrmnode sherman

2. The following example removes a partially installed or partiallyremoved node. The dispatcher number must be provided becausethe node name is not fully known to the system. To determine thedispatcher number, enter the following:

odadmin odlist

Region Disp Flags Port IPaddr Hostname(s)2323231 ct- 737 146.84.25.15 ceridwen,ceridwen.tivoli.com2 -t- 737 146.84.29.12 elcap,elcap.tivoli.com

To remove the partially installed or partially removed node, enterthe following:

wrmnode elcap -d 2

See Alsoodadmin, wbkupdb, wchkdb, wclient, winstall, wpatch, wserver

wrplblk

1–440 Version 3.7.1

wrplblkReplaces a block of statements in a file. This command should be runfrom an endpoint.

Syntaxwrplblk [–r] –s "start_string" –e " end_string" [–ooutput_file]{ –i " replace_string" | @file_name} file_name

DescriptionThewrplblk command replaces a block of statements in a file. Thiscommand is intended to replace a block of statements that are clearlydelimited at the beginning and end of the block (such as those addedusing thewinsblk command).

Options–e "end_string"

Specifies a search string that signifies the end of theblock of statements. You must surround the string withdouble quotation marks.

–i { " replace_string" | @file_name}Specifies a string to replace the text between thedelimited statements, or a file containing a block ofstatements. You must surround the string with doublequotation marks.

–ooutput_file Writes the output of this command to theoutput_filefile, instead of standard output.

–r Replaces the delimiter lines in addition to the block ofstatements.

–s "start_string"Specifies a search string that signifies the start of theblock of statements. You must surround the string withdouble quotation marks.

file_name Specifies the file in which to replace the block ofstatements.

wrplblk


Com

mands

ExamplesTo replace a block of statements beginning with[boot] and ending withend in theSYSTEM.INI file with statements in theRPLBLK.FIL file,enter the following command:wrplblk -s "[boot]" -e "end" -o C:\TEMP\OUTPUT.FIL \-i @C:\TEMP\RPLBLK.FIL C:\WINDOWS\SYSTEM.INI

The output of this command is redirected to theOUTPUT.FIL file.

See Alsowclrblk , winsblk

wrplline

1–442 Version 3.7.1

wrpllineReplaces a single line in a file. This command should be run from anendpoint.

Syntaxwrplline [–f] –s "search_string" [–ooutput_file]–r " replace_string" file_name

DescriptionThewrplline command replaces a line in a text file. The line to bereplaced is found using a search string. Output from this command iswritten to standard output.

Options–f Processes only the first occurrence of the search string.

If this option is not specified, the command processeseach occurrence of the search string.

–ooutput_file Writes the output of this command to theoutput_filefile, instead of standard output.

–r " replace_string"Specifies a string to replace the line that contained thesearch string. You must surround the string with doublequotation marks.

–s "search_string"Specifies a search string. If the search string iscontained in a line, the line is replaced with the stringspecified by the–r option. You must surround the stringwith double quotation marks.

file_name Specifies the name of the file in which to replace theline.

wrplline


Com

mands

ExamplesTo replace every occurrence of a line beginning withdevice= in theSYSTEM.INI file with the type= string, enter the following command:wrplline -s "device=" -o C:\TEMP\OUTPUT.FIL -r "type=" \C:\WINDOWS\SYSTEM.INI

The output of this command is written to theOUTPUT.FIL file.

See Alsowclrline , winsline

wrpt

1–444 Version 3.7.1

wrptCreates a repeater on a managed node (for both MDist and MDist 2),configures MDist repeaters, and manages MDist distributions.

Syntaxwrpt

wrpt –A [–f] –k dist_id

wrpt –g [–e]

wrpt –L

wrpt [–n] src_host [always | noalways] [default | nodefault][wan | nowan] [range=value]

wrpt –q src_host destination [destination…]

wrpt –R –k dist_id

wrpt –r src_host

wrpt –T [seconds]

wrpt –t src_host [–k dist_id] [reinit | keyword=value…]

DescriptionThewrpt command is used to configure MDist repeaters and managedistributions using the MDist service. It also is used to create repeaterson managed nodes using MDist, MDist 2, or both. For more informationabout multiplexed distribution services, see theTivoli ManagementFramework User’s Guide.

Thesrc_hostoption specifies the name of a source host (managed node).Host numbers are the same as those in theDisp column of the outputfrom odadmin odlist.

Note: Thewrpt command cannot add Tivoli endpoints to or deleteTivoli endpoints from a gateway’s range. The gateway range isdynamically set as endpoints log in to gateways or are deletedfrom gateways.

wrpt


Com

mands

OptionsWhen no options are listed,wrpt returns a table that contains allrepeaters. The first column is the source host name with the host numberin square brackets ([ ]); the second column indicates that the repeater isa default repeater (d) or a wide area network (WAN) entry site (w); andthe third column lists the range of hosts served by the repeater.

Note: The resulting output lists only the managed nodes in a repeater’srange. Endpoints are not listed.

–A [–f] –k dist_idCancels the specified distribution and ends the activedistribution. You cannot restart a distribution after it hasbeen canceled. The user is prompted with anAre yousure? message unless the force option (–f) isspecified. Options are as follows:

–f Forces the cancel operation andsuppresses any confirmation prompt.

–k dist_id Specifies the target active process.dist_idspecifies the unique processnumber of an active distribution. Toobtain the value fordist_id, use the–Loption.

Note: Canceling a distribution does not remove filesthat have already been successfully installed ontargets.

–g [–e] Changes the format to match the input option format ofthewrpt add or change options. This makes it easier tocapture a repeater layout to restore later. The –e optionlists the range of endpoints served by the repeater.

–L Lists all active distributions in a four-column format.The first column is the unique active distributionnumber, the second column is the distribution name (alabel chosen by the application), the third column is thedistribution’s start time, and the fourth column givesstatistics for the distribution in the following format:in/est_size [out_min-out_max].

wrpt

1–446 Version 3.7.1

–n src_host [wan | nowan] [default | nodefault] [always | noalways][range=value]

Creates a new or modifies an existing repeater. Optionsare as follows:

src_host Specifies the source host (managednode) as it is registered in the Tivoliname registry.

always | noalwaysSpecifies that distributions go throughthis repeater although the repeater hasonly one client. By default, if arepeater has only one client, adistribution to that client goes directlyto the client, bypassing the repeater.Thealways option overrides thedefault behavior. Use thenoalwaysoption to disable thealwaysoption andrevert to default behavior.

default | nodefaultIndicates that the repeater serves allhosts that are not explicitly listed inanother repeater’s range. Usenodefault to disable this option.

range=value Specifies a comma-separated list ofhost numbers; consecutive numberscan be abbreviated with a dash (–). Forexample, 2–14 would be an inclusivelist of host numbers 2 through 14.Tivoli Management Framework doesnot check ranges. If you createconflicting or overlapping ranges,unexpected results can occur.

wan | nowan Enables or disables this repeater as theWAN entry point for the region. Alldistributions from other regions arerouted through this repeater. If you donot specify a WAN entry point for the

wrpt


Com

mands

region, any repeater can be the first hopof an interregion distribution.

–q src_host target[target…]Displays the distribution route between the specifiedsource host and target nodes. Output is shown in anindented format, displaying repeaters between thespecified source host and targets. Use this option toverify that a route is as you expect before you begin adistribution. Options are as follows:

src_host Specifies the label, object ID, or nameof the source host for the distribution.

target Specifies the label, object ID, or nameof the target for the distribution.

Note: If the managed node and target endpoint havethe same name, you can use @ManagedNodeand @Endpoint notation.

–r host Removes the specified repeater. The host optionspecifies the source host (managed node) as it isregistered in the Tivoli name registry.

–t src_host[–k dist_id] [reinit | keyword=value…]Displays and changes tuning options for a repeater.Options are as follows:

src_host Specifies the source host (managednode) as it is registered in the Tivoliname registry.

–k dist_id Causes configuration options to affectonly the active distributions.dist_idspecifies the unique process number ofan active distribution. To obtain thevalue fordist_id, use the–L option.

reinit Resets all options to the factorydefault.

keyword=value Enables you to specify one of thefollowing keywords and a value (eitheran integer or an absolute path name for

wrpt

1–448 Version 3.7.1

a directory) for the keyword. Ifvalueisnot specified, the existing options forthe specified repeater are displayed.Keywords are as follows:

disk_dirSpecifies the directory used fortemporary paging, or swap, space.Note that the repeatermust beconfigured with adequate swapspace to avoid hung distributions.This swap space must be at least aslarge asdisk_max.

disk_hiwatSpecifies the disk usage (in KB) atwhich a delay occurs between diskblock allocations. The delay periodis specified by thedisk_timetuning keyword. A disk blockallocation is 16 KB. Tivolirecommends that this value equalabout 50 percent of the maximumdisk space available to therepeater.

disk_maxSpecifies the maximum amount ofdisk space (in KB) to use forpaging. You must set thedisk_maxandmem_maxoptionsdependent on the type of repeateryou are distributing through. Fornongateway repeaters,mem_maxplusdisk_max should at leastequal the size of the largest filepackage distributed ifmax_connis less than the number of clientsthat are targets of the distribution.For gateway repeaters, only the

wrpt


Com

mands

disk_maxoption should be set to avalue at least equal to the size ofthe largest file package distributedif max_conn is less than thenumber of clients that are targetedby the distribution.

disk_timeSpecifies the delay (in seconds)between disk block allocations.The delay starts only after diskusage rises above the numberindicated by thedisk_hiwattuning keyword.

max_connSpecifies the maximum number ofsimultaneous parallel clientconnections initiated by therepeater during a distribution.

mem_maxSpecifies the maximum memory(in KB) to be used before paging todisk. You must set thedisk_maxandmem_maxoptions dependenton the type of repeater you aredistributing through. Fornongateway repeaters,mem_maxplusdisk_max should at leastequal the size of the largest filepackage distributed ifmax_connis less than the number of clientsthat are targets of the distribution.For gateway repeaters, only thedisk_maxoption should be set to avalue at least equal to the size ofthe largest file package distributedif max_conn is less than the

wrpt

1–450 Version 3.7.1

number of clients that are targetedby the distribution.

net_loadSpecifies the maximum amount ofdata (in KB per second) that therepeater sends to the network foreach distribution. Tivolirecommends that this value equalabout 25 percent of the networkbandwidth (between repeater andclients). Note that you cannot setnet_load to a value that is greaterthan 32 MB/sec. Also, if youspecify a negative number fornet_load, the option is set pertarget machine rather than perdistribution.

net_spacingSpecifies a delay (in milliseconds)to insert between each write to thenetwork.

stat_intvSpecifies a high-levelTransmission Control Protocol(TCP) timeout (in seconds) afterwhich an error terminates theblocked connection. This value isdependent on the network clientmachines’ processors, particularlythe PC processors and RAM.

–R –k dist_id Returns the distribution route of an active distribution.Use the–k dist_idoption to specify the distribution IDof the active distribution. Unlike the–q option, it is notnecessary to specify the source and destination nodes.To obtain the value fordist_id, use the–L option.

–T [seconds] Specifies the repeater manager timeout. This timeoutvalue is the maximum time (in seconds) that a repeater

wrpt


Com

mands

node waits after a distribution for final processing onthe target to complete before an error is forced toterminate the connection. A final timeout value of 0indicates no, or infinite, timeout.

Authorizationsenior

Examples1. To view a list of all repeaters in the region, enter the following

command:

wrpt


fuji [1] wd [default]

lazzaro [2] -- [2-14,18,20-40]

The first column displays the repeater name followed by itsdispatcher number in square brackets ([ ]). The first entry in thesecond column can be aw or a hyphen (–). Aw indicates that theentry is a WAN entry site. If the second entry in the second columnis ad, the entry is the default repeater for the region. The thirdcolumn contains the range of hosts served by the repeater. If norange is specified ([ ]), the repeater is the only repeater in theregion.

If you specify the–g option, the format is changed to match theinput option format of thewrpt add or change options. This makesit easier to capture a repeater layout to restore later.

2. To cancel a distribution namedpeppe, enter the followingcommand:

wrpt -A peppe

3. The following example creates a repeater on thepeppe host:

wrpt -n peppe range=2-14,18,20-40

wrpt

1–452 Version 3.7.1

where:

–n peppe Specifies hostpeppe as a new repeater.

range=2–14,18,20–40Specifies the host numbers that are in thedistribution range for the new repeater. The hostnumbers include 2 through 14, 18, and 20 through40.

4. To view the distribution route between a managed node namedsmith and an endpoint namedjones, enter the followingcommand:

wrpt -q smith jones


--[RPT:smith [1]] |--[RPT:smith [1]]

| |--[RPT:reality [6]]

| | |--jones [5]

You also can specify the node’s label or object ID. In addition, ifthe managed node and endpoint have the same name, you can use@ManagedNode and @Endpoint notation. For example, to viewthe distribution route between a managed node and an endpointnamedsmith, enter the following command:

wrpt -q @ManagedNode:smith @Endpoint:smith


--[RPT:smith [1]]

|--[RPT:jones [3]]

| |--smith [4]

|

5. To list all active distributions, enter the following command fromthe source repeater machine:

wrpt -L


4 fp_distribute 05 09 16:12:50 2816/0 [640-640]

where4 is the unique active distribution number,fp_distribute isthe distribution name (a label assigned by the application),05 09

wrpt


Com

mands

16:12:50is the distribution’s start date and time, and2816/0[640–640] provides statistics for the distribution.

Statistics indicated in the last column are displayed in thefollowing format:

in / est_size [ out_min - out_max ]

wherein indicates the amount of data the repeater received,est_size indicates the estimated size of the distribution,out_minindicates the number of bytes sent to the slowest target, andout_max indicates the number of bytes sent to the fastest target.

6. To view settings for thepeppe repeater, enter the followingcommand:

wrpt -t peppe

Note that you can specify the label, object ID, or managed node IDof the repeater. Output similar to the following is displayed:

mem_max = 10000disk_max = 50000disk_hiwat = 50000disk_time = 1disk_dir = "C:/TEMP/"net_load = 500max_conn = 100stat_intv = 180

Note: For descriptions of these options and instructions abouthow to configure a repeater’s settings, see theTivoliManagement Framework User’s Guide.

7. The following example gets the unique process number for anactive distribution, calls that distribution using its number, andchanges the maximum network load that the process can add to100 KB/sec. This command changes the network load only for thisdistribution.

wrpt -Ll fp_distribute Jun 16 12:53:27 1696/1696 [0-432]wrpt -k l -t peppe net_load=100

peppeis the name of the host (managed node) that the repeater isconfigured on.

wrunas

1–454 Version 3.7.1

wrunasRuns a given command as a given user. The password for the user isretrieved from the registry using a given key.

Syntaxwrunas [user_name | key | command]

DescriptionThewrunascommand retrieves the password from the registry, uses theMicrosoft authentication package, and launches a given command. Thewrunas command can be used in a task library script or a TivoliApplication Extension Facility (AEF) method script to launchexecutables from the Tivoli desktop. These scripts must be installed torun as$root_user.

Optionscommand Specifies the command to be executed.

key Specifies the key that stores the password for the username.

user_name Specifies the user name.

ExamplesThe following example retrieves the password forAdministrator whenthe key isadmin_key:wrunas Administrator admin_key net config workstation

wruninvquery


Com

mands

wruninvqueryQueries the database for inventory information and returns a list ofobject IDs and object labels of machines that match the query criteria.

Syntaxwruninvquery [–i] [–T idl_type] [–l | –t] query_name [input…]

DescriptionThewruninvquery command runs a query and returns a list of objectIDs and object labels in a format that can be used for a subscription list.The output of all queries is aSysAdminTypes_ObjectLabelList. Touse this command, the columns TME_OBJECT_ID andTME_OBJECT_LABEL must be included in the columns list of thequery. If these columns are not included in the query, or if you want tosimply display query output in text format, use thewrunquerycommand.

Thewruninvquery command returns only the following output:

■ A line-separated list of object IDs (the default)

■ A line-separated list of object labels

■ An American National Standard Code for Information Interchange(ASCII) Interface Definition Language (IDL)-encoded version ofan instance ofSysAdminTypes_ObjectLabelList

This command can also read a limited set of inputs that can narrow thequery results. If input is provided, the query combines the results of thequery with the input, and then returns only the results that are found inboth lists. Input types are accepted in the following formats:

■ A list of object IDs (the default) separated by spaces.

■ An ASCII representation of an IDL type. Currently, the only IDLtypes that are valid input are the following:

• SysAdminTypes_ObjectList

• SysAdminTypes_ObjectLabelList

• TMF_CCMS_subscriber_list

wruninvquery

1–456 Version 3.7.1

Options–i Reads query input, either object IDs or an ASCII

representation of the IDL data type, from standardinput. If the–T option is not specified, the input isinterpreted as a space-separated list of object IDs. If the–T option is specified, the input must be an ASCIIrepresentation of the IDL data type (similar to that usedby theidlcall andidlattr commands). Input can comefrom either standard input or the command line, but notboth.

–l Specifies that the output should be a new line-separated list of object labels.

–t Specifies that the output should be an ASCIIrepresentation of the IDL result as output.

–T idl_type Specifies the full name of an IDL data type. The input,whether coming from standard input or the commandline, must be an ASCII representation of the IDL type.

input… Specifies the input to the query. If the–T option is notspecified, the input is interpreted as a space-separatedlist of object IDs. If the–T option is specified, the inputmust be an ASCII representation of the IDL data type(similar to that used by theidlcall andidlattrcommands). Input can come from either standard inputor the command line, but not both.

query_name Specifies the name of the query to run.

Authorizationquery_execute, admin, senior, orsuper

Examples1. The following example runs theAIX-machines query and prints

the output as a list of object IDs:

wruninvquery AIX-machines

wruninvquery


Com

mands

The output is as follows:

1922582407.1.323#TMF_ManagedNode::Managed_Node#555555.1.332#TMF_ManagedNode::Managed_Node#

2. The following example runs theAIX-machines query and printsthe output as a list of object labels:

wruninvquery -l AIX-machines


manzanoamon-sul

3. The following example runs theAIX-machines query and printsthe output as an ASCII-encoded representation of theSysAdminTypes_ObjectLabelList type:

wruninvquery -t AIX-machines


{ 2 { 1922582407.1.323#TMF_ManagedNode::Managed_Node# \"manzano " } { 555555.1.332#TMF_ManagedNode::Managed_Node# \"amon-sul" } }

4. The following example runs theAIX-machines query, using thesubscribers of thepm1 profile manager, and produces a list oflabels for the output:

idlcall 555555.1.535#TMF_CCMS::ProfileManager# \_get_subscribers | wruninvquery -l -i \-T TMF_CCMS::subscriber_list aix-boxes amon-sul


manzano

Use thewrunquery command instead of thewruninvquery commandif you want to simply display the results of a query, or if the query doesnot include the TME_OBJECT_ID and TME_OBJECT_LABELcolumns.

See Alsoidlattr , idlcall , wcrtqlib , wcrtquery , wgetquery, wrunquery ,wsetquery

wrunjob

1–458 Version 3.7.1

wrunjobRuns a job in a task library.

Syntaxwrunjob job_name–l library [–aoption] [–ename=value] [–iEr ][–T trans_type]

DescriptionThewrunjob command runs a job that exists in a task library.

Options–aoption Specifies the argument to be passed to the task. If the

argument to be passed includes an option flag and anargument, enclose both in quotation marks (forexample,–a "–ooption").

–ename=value Sets an environment variable for the task (for example,DISPLAY=bald:0.0).

–E Passes to the task all environment variables set on theuser’s system.

–i Reads input options for the task from standard input.

–l library Specifies the task library containing the task to be run.

–r Returns an error code of1 if at least one endpoint failsto execute its job properly.

–T trans_type Specifies a transaction type. See “Tivoli Transactions”on page 1-6 for additional information abouttransaction types. This option can be one of thefollowing:

none No transaction.

revoke Revocable transaction.

sub Subtransaction.

top Top-level transaction. This is thedefault if the–T option is not specified.

wrunjob


Com

mands

job_name Specifies the name of the job to be run.

AuthorizationYou must have the role specified when the job was created. You can usethewgetjob command to find the required role.

Examples1. The following example runs jobdate_job, which is contained in

task librarymy_tasks.

wrunjob date_job -l my_tasks###################################################Task Name: date_taskManaged Node: baldReturn Code: 0-------Standard Output-------Mon Nov 21 14:24:16 CST 1998-------Standard Error Output-------####################################################

2. The following example executes jobdate_job, which is containedin task librarymy_tasks. The LANG environment variable is setto German.

wrunjob date_job -l my_tasks -e LANG=de#####################################################Task Name: date_taskManaged Node: baldReturn Code: 0-------Standard Output-------Montag, 21. November 1998 14:25:30 Uhr CST-------Standard Error Output-------#####################################################

3. The following example runs the jobps_vernon from the tasklibrary NoonTide. The example passes the optionaux to the task.

wrunjob ps_vernon -l NoonTide -a aux##############################################################Task Name: psTask Endpoint: vernon (ManagedNode)Return Code: 0------Standard Output------USER PID %CPU %MEM SZ RSS TT STAT START TIME COMMANDroot 2245 54.5 6.2 360 2368 ? S 13:10 0:02 task_endpointroot 2246 19.7 1.3 228 488 ? R 13:10 0:00 /tmp/taskAAAa02245 aux

wrunjob

1–460 Version 3.7.1

nobody 2244 14.6 5.2 176 1992 ? S 13:10 0:01 man_node_skel1nobody 2239 12.2 7.3 568 2800 ? S 13:10 0:02 repository_skel1root 134 8.4 2.9 1508 1100 ? S Apr 19 0:41 oserv -p -k

/usr/Tivonobody 2237 3.5 5.7 184 2188 ? S 13:10 0:01 library_skel1root 2236 1.1 5.5 120 2108 p0 S 13:09 0:01 wrunjobps_vernon -l Nooroot 172 0.0 1.8 136 684 ? S Apr 19 0:02 ./usrlnkd------Standard Error Output------###############################################################

See Alsowcrtjob , wcrttask, wgetjob

wrunquery


Com

mands

wrunqueryRuns a query and returns the results to either standard output or a file.

Syntaxwrunquery [–n] [[–h host_name] –f file_name] [–d delimiter]query_name

DescriptionThewrunquery command runs a query and enables you to eitherdisplay the results or save them to a file. By default, thewrunquerycommand returns the output to standard output. To get a list of objectIDs and object labels to use for a subscription list, use thewruninvquery command.

Options–d delimiter Specifies the delimiter that separates the entries in the

output file. The default delimiter is a comma.

–f file_name Specifies the path and name of the file in which to storethe query results.

–h host_name Specifies the name of the managed node on which tostore the query results. If you do not specify a managednode, the file is saved on the local machine.

–n Omits the headers from the output.

query_name Specifies the name of the query to run.

Authorizationquery_execute, RIM_view , admin, senior, orsuper

ExamplesThe following command runs the Operating-systems query and sendsthe output to a file namedquery.txt on a managed node namedamon-sul. The output file contains headers, and the entries are separatedby semicolons.

wrunquery

1–462 Version 3.7.1

wrunquery -h amon-sul -f query.txt -d ";" Operating-systems

The filequery.txt contains the following:Query Name Operating-systemsNumber of rows: 9BOOTED_OS_VERSION_TYPE BOOTED_OS_NAME PROCESSOR_SPEED3.2;AIX;UNKNOWN3.2;AIX;UNKNOWN3.2;AIX;UNKNOWN4.1;AIX;UNKNOWN4.1;AIX;UNKNOWN3.10;Windows 25;486 DX3.10;Windows 25;486 DX3.10;Windows 33;486 DX3.10;Windows 133;Intel Pentium

See Alsowcrtqlib , wcrtquery , wgetquery, wruninvquery , wsetquery

wruntask


Com

mands

wruntaskRuns a task in a task library.

Syntaxwruntask –t task_name–l library_name{ –h node… | –p profile_mgr…} [ –aoption][–ename=value] [–iE] [–T trans_type] [–M mode [–s interval–n number]] [–r] [–m timeout] [–ooutput_format]

DescriptionThewruntask command runs a task in a task library. The task must havebeen previously created withwcrttask.

Options–aoption Specifies the argument to be passed to the task. If the

argument to be passed includes an option flag and anargument, enclose both in quotation marks (forexample,–a "–o option" ). The–a option must berepeated for each option specified (for example,–a"–h node" –a "–p profile_mgr" ).

–ename=value Sets an environment variable for the task. The–eoptionmust be repeated for each environment variablespecified (for example,–e DISPLAY=bald:0.0 –eCOLOR=red).

–E Passes to the task all environment variables set in yourcurrent shell.

–h node… Specifies the nodes on which to run the task. You mustspecify at least one node or at least one profile manager(with the–poption). The–hoption must be repeated foreach node specified (for example,–h vernon –heverest –h fuji).

–i Reads standard input and passes it to the task as itsstandard input.

wruntask

1–464 Version 3.7.1

–l library_nameSpecifies the task library containing the task to be run.

–m timeout The amount of time, in seconds, the task library waitsfor results to be returned from the task. This option doesnot affect the execution of the task. If you do not use the–m option, the default timeout is 60 seconds.

–M mode Specifies the mode in which the task runs. Valid optionsare the following:

parallel Runs the task on all specified managednodes and any subscriberssimultaneously. This is the default ifyou do not specify the–M option.

serial Runs the task on one managed node ata time.

staged Runs the task on a set number ofmanaged nodes at specified intervals.

–n number Specifies the number of managed nodes on which to runthe task in each stage. You must supply a value for thisoption if you selectedstaged mode.

–ooutput_formatDefines the format of the task output. Task executionoutput format is specified with an octal number from 0to 17. The format is constructed by adding the value ofthe desired output. For example, to print the task’sreturn code to standard output, enter–o 05. To output toa file, use the standard redirection syntax. Output valuesare as follows:

01 Prints a descriptive header for eachrecord

02 Prints the task’s return code



–p profile_mgr…Specifies the profile managers on which the task runs.

wruntask


Com

mands

You must specify at least one profile manager or at leastone node (with the–h option). The–p option must berepeated for each profile manager specified (forexample,–p pm1 –p pm2 –p pm3).

–r Returns an error code of1 if at least one endpoint failsto execute its job properly.

–s interval Specifies the number of seconds between when the taskruns on one group of managed nodes and when it runson the next group. The interval is at the end of the firstgroup. You must specify a value for this option if youselectedstaged mode.

–t task_name Specifies the name of the task to be run.

–T trans_type Specifies a transaction type. See “Tivoli Transactions”on page 1-6 for additional information abouttransaction types. This option can be one of thefollowing:

none No transaction.

revoke Revocable transaction.

sub Subtransaction.

top Top-level transaction. This is thedefault if the–T option is not specified.

AuthorizationYou must have the role specified when the task was created. You can usethewgettask command to find the required role.

Examples1. The following example runs taskdate_taskon hostsbald andfuji .

The task is contained in task librarymy_tasks.

wruntask

1–466 Version 3.7.1

wruntask -t date_task -l my_tasks -h bald -h fuji#####################################################Task Name: date_taskManaged Node: baldReturn Code: 0-------Standard Output-------Mon Nov 21 10:49:34 CST 1998-------Standard Error Output-------#####################################################Task Name: date_taskManaged Node: fujiReturn Code: 0-------Standard Output-------Mon Nov 21 10:49:45 CST 1998-------Standard Error Output-------#####################################################

2. The following example runs taskdate_task2 on hostbald. Thetask is contained in task librarymy_tasks. The output of this taskis standard output.

wruntask -t date_task2 -l my_tasks -h bald -o 04#####################################################Mon Nov 21 10:50:47 CST 1998#####################################################

3. The following example runs the taskpson managed nodevernon.The task resides in the task libraryNoonTide. The example passesthe optionaux to the task.

wruntask -t ps -l NoonTide -h vernon -a aux############################################################Task Name: psTask Endpoint: vernon (ManagedNode)Return Code: 0------Standard Output------USER PID %CPU %MEM SZ RSS TT STAT START TIME COMMANDroot 2245 54.5 6.2 360 2368 ? S 13:10 0:02 task_endpointroot 2246 19.7 1.3 228 488 ? R 13:10 0:00 /tmp/taskAAAa02245 auxnobody 2244 14.6 5.2 176 1992 ? S 13:10 0:01 man_node_skel1nobody 2239 12.2 7.3 568 2800 ? S 13:10 0:02 repository_skel1root 134 8.4 2.9 1508 1100 ? S Apr 19 0:41 oserv -p 94 \

wruntask


Com

mands

-k /usr/Tivonobody 2237 3.5 5.7 184 2188 ? S 13:10 0:01 library_skel1root 2236 1.1 5.5 120 2108 p0 S 13:09 0:01 wrunjob ps_vernon -l Nooroot 172 0.0 1.8 136 684 ? S Apr 19 0:02 ./usrlnkd------Standard Error Output------###############################################################

See Alsowcrtjob , wcrttask, wgettask

wschedjob

1–468 Version 3.7.1

wschedjobSchedules a job that exists in a task library.

Syntaxwschedjob –nname–L library_name–t " mm/dd/yyyy hh:mm"[–c 'time_period' ] [–C daytime | nighttime | weekday |weekendfrom to][–D] [–d desktop] [–f file –h host] [–ggroup][–l label] [–m email] [–o] [–r ' time_period' | ' iterations' ][–R 'time_period' | ' iterations' ] [–sdescription]

DescriptionThewschedjobcommand allows administrators to schedule a job. Onlyjobs that exist in a task library can be scheduled from the command line.Administrators must also have the proper authorization to execute thejob. This is validated when the job is scheduled. If the administrator doesnot have the proper authorization at the time the job is run, it fails.

Options–c 'time_period'

Specifies when a job is canceled if it did not start asscheduled. You must specify a number (amount oftime) and a unit of time. The unit of time must beminute, hour, or day. For example, if you specify'3hour' , the job is canceled 3 hours after its originallyscheduled start time.

–C daytime | nighttime | weekday | weekendfrom toSpecifies the conditions or restrictions under which thejob runs. Thefromoption can be either a starting day ora starting time. Theto option can be either an endingday or an ending time. Times must be entered using a24-hour clock (for example, 9:00 for 9 a.m. or 14:00 for2 p.m.). Days must be entered as numeric values whereSunday is 0 and Saturday is 6. Valid options are asfollows:

'daytime from to'

wschedjob


Com

mands

Specifies that the job runs only duringthe day between the hours offromandto.

'nighttime from to'Specifies that the job runs only duringthe night between the hours offromandto.

'weekday from to'Specifies that the job runs only duringweekdays on and between the daysindicated byfrom andto.

'weekendfrom to'Specifies that the job runs only duringthe weekend on and between the daysindicated byfrom andto.

–d desktop Specifies which desktop displays theStatus dialogwhen any action is performed on the job. Multipledesktops can be specified.

–D Disables the job. The job remains in the scheduler butdoes not run until it is enabled.

–f file Specifies the file to which the job status is written whenany action is performed on the job. If a file is specified,–h must be used to specify a host.

–ggroup Specifies the notice group to which the job status is sentwhen any action is performed on the job. Multiplenotice groups can be specified.

–h host Specifies the host on which the job status file is to bewritten. Must be used with the–f option.

–l label Specifies the name specific to this instance of the job.

–L library_nameSpecifies the name of the task library where the jobresides. (Required)

wschedjob

1–470 Version 3.7.1

–m email Specifies the e-mail address to which the job status issent when any action is performed on the job. Multiplee-mail addresses can be specified.

–n name Specifies the name of the job with the task library thatis scheduled. (Required)

–o Specifies that the time indicated with the–t option is inthe past. Overrides warning message.

–r ' time_period' | ' iterations'Specifies the repeat information. If theiterationsoptionis specified, the job repeats for a finite number of times.The unit of time must be specified in the local language.

' time_period' Specifies how often a job is retried.You must specify a number (amount oftime) and a unit of time. The unit oftime must beminute, hour, day,week, month, oryear. For example, ifyou specify'3 hour' , the job isrepeated every 3 hours.

' iterations' Specifies how many times a job isrepeated. You must specify an amountof time, a unit of time, and a number oftimes. The unit of time must beminute, hour, day, week, month, oryear. For example, if you specify'3hour 6' , the job is repeated every 3hours until it has been repeated sixtimes.

–R 'time_period' | ' iterations'Specifies the retry information. If theiterationsoptionis specified, the job retries for a finite number of times.

' time_period' Specifies how often a job is repeated.You must specify a number (amount oftime) and a unit of time. The unit oftime must beminute, hour, orday.For example, if you specify '3 hour' ,the job is retried every 3 hours.

wschedjob


Com

mands

' iterations' Specifies how many times a job isretried. You must specify an amount oftime, a unit of time, and a number oftimes. The unit of time must beminute, hour, or day. For example, ifyou specify'3 hour 6 ', the job isretried every 3 hours until it has beentried six times.

–sdescription Describes the job. Multiword descriptions requirequotation marks.

–t " mm/dd/yyyy hh:mm"Specifies the time the job is scheduled to initiallyexecute. (Required)


Examples1. The following example schedules the jobSendWishList from the

task library,Holiday. The job executes at 6:00 a.m. on December24, 1998. When any action is performed on the job, a job statusmessage is sent [email protected].

wschedjob -t "12/24/1998 6:00" -m [email protected] -L \Holiday -n SendWishList

2. The following example schedules the jobSendWishList from thetask library,Holiday. The job executes at 6:00 a.m. on December24, 1998. In this example, when an action is performed on the job,a job status message is sent [email protected],[email protected], [email protected]. The job repeats every 5minutes. If the job fails, it retries once, 1 minute after failure.

wschedjob -t "12/24/1998 6:00" -m [email protected] \-L Holiday -n SendWishList -r '5 minute' \-m [email protected] -m [email protected] -R '1 minute 1'

3. The following example schedules the jobnice_list from the tasklibrary, MakeToys. The job runs Monday through Friday at 10p.m.

wschedjob

1–472 Version 3.7.1

wschedjob -t "3/4/1996 22:00" -L MakeToys -n nice_list \-r '1 day' -C 'weekday 1 5'

See Alsowdelsched, wedsched, wenblsched, wgetsched

wserver


Com

mands

wserverInstalls the Tivoli management region server on UNIX machines.

Syntaxwserver –ccdrom_path[–aserver_name] [–d] [–P] [–ppath_prefix[!]][install_variable=value…]

DescriptionThewserver command installs the initial Tivoli management regionserver for a region. Two modes of installation are supported: anX11-based installation and a command-line only installation. To use theX11 version ofwserver, make sure that yourDISPLAY environmentvariable is set and the environment variableDOGUI is not set. For thecommand-line only installation, set the environment variableDOGUI tono. By default, the X11 version of installation is chosen. To runwserverin either case, change directory to theinstall_dir directory; that is, thedirectory where you ranWPREINST.SH or the directory where youun-tarredFILE0.TAR . Alternatively, you could set the environmentvariableBINDIR to yourinstall_dir directory.

Options–aserver_name

Specifies the name of the Tivoli management regionserver. You can specify either the local host name or aremote host name. The default is the local host name.On some systems with host names longer than eightcharacters, thehostnamecommand returnsunknown .This option lets you fix that behavior.

Note: If you are installing on the local host andspecifying a fully qualified host name, theappropriate remote access must be enabled byupdating the local /.rhosts file.

–ccdrom_pathSpecifies the path to the CD-ROM image.

wserver

1–474 Version 3.7.1

–d Sets the installation variable (install_variable) to itsdefault value. This flag is used for only the commandline version ofwserver. This option is required unlessyou select between each and every one of the optionsand the environment variables.

–p path_prefix[!]Attachespath_prefix to the beginning of the defaultinstallation paths. If the optional ‘!’ is present,path_prefixis prepended to only the last component ofthe default installation paths. For example, the defaultinstallation path for Tivoli binaries is/usr/local/Tivoli/bin . If you specify–p /Tivoli, theinstallation path would be/Tivoli/usr/local/Tivoli/bin .If you specify–p /Tivoli! , the path would be/Tivoli/bin .

–P Specifies the use of a global root password instead oftrusted host access. This option is used only wheninstalling on remote hosts.

install_variable=value…Specifies a number of variables that control theinstallation, which can be set or defaulted on thecommand line. If you are using the X11-based methodof installation, you can also change these values in theinstallation dialog. Of course, when installing from thecommand line, the only way to set the values is to passthem on the command line. The installation variablesspecify required information or override defaultinformation.


Several of the installation variables specify thedirectories where the Tivoli management region serveris installed. If a directory already contains files from aprevious installation,wserverdoes not recopy the files.You can force any of these directories to be reinstalled

wserver


Com

mands

by entering a ‘!’ character after the specified directory.The following are the installation variables related tothe installation directories:

BIN=binaries_dirOverrides the default installation path(/usr/local/Tivoli/bin ) for TivoliManagement Framework binaries.

LIB= libraries_dirOverrides the default installation path(/usr/local/Tivoli/lib ) for TivoliManagement Framework libraries.

ALIDB= server_database_dirOverrides the default installation path(/var/spool/Tivoli) for TivoliManagement Framework serverdatabase.

MAN= man_page_dirOverrides the default installation path(/usr/local/Tivoli/man) for TivoliManagement Framework manualpages.

APPD=X11_app_defaults_dirOverrides the default installation path(/usr/lib/X11/app-defaults) for theX11 application defaults.

CAT=message_catalog_dirOverrides the default installation path(/usr/local/Tivoli/msg_cat) for TivoliManagement Framework messagecatalogs.

The following are other useful installation variables:

@EL@=None | Simple | DESDefines the encryption level to be usedwhen installing the server. The defaultlevel isSimple.

wserver

1–476 Version 3.7.1

LK= license_keySpecifies the license key for the Tivoliproduct.

RN=region_nameOverrides the default policy regionname. The default policy region namecan be changed later.

IP=installation_passwordSets the installation password. Bydefault, there is no password. Thispassword is the installation passwordwhen you install Tivoli ManagementFramework on clients, the default seedwhen you are using encryption, and theinterregion password when you areconnecting Tivoli management regionsusing encryption.

AutoStart=0 | 1Indicates whether the Tivoli daemonshould be started at system boot time.By default, the daemon is not started.

SetPort=0 | 1 Indicates whether to configure theremote start capability of the Tivolidaemon. By default, this capability isnot configured.

CreatePaths=0 | 1Indicates whether to create (1) thespecified directories if they do notalready exist. By default, thedirectories are created. It is consideredan error if a directory that youspecified withinstall_variable doesnot exist.

@ForceBind@=yes | noForces communication connections tobind to a single Internet Protocol (IP)

wserver


Com

mands

address. This option is used in certainhigh availability or failoverconfigurations where multiple objectdispatchers reside at different IPaddresses on a single physical system.

AuthorizationRoot access on the system being installed.

Files/tmp/tivoli.sinstall

Contains verbose debugging information from the latestinstallation attempt.

/tmp/install.cfg.error /tmp/install.cfg.outputTransient file created during the initialization of theTivoli management region server database. Afterinitialization, if there are no errors, these files areremoved.

/etc/Tivoli/setup_env.shA file that can be sourced in from Bourne shellcompatible shells after installation that contains usefulshell environment variables.

/etc/Tivoli/setup_env.cshA file that can be sourced in from C shell compatibleshells after installation that contains useful shellenvironment variables.

Environment VariablesA number of environment variables have installation implications:

DISPLAY Specifies the X11 display to be used for installation.

DOGUI If set to something other than the value of the$DISPLAY variable, the command line version ofwserver is used.

EtcTivoli The default is the/etc/Tivoli directory. Do not override.

wserver

1–478 Version 3.7.1

BINDIR If you do not want to runwserver from theinstall_dirdirectory (the directory where you ranWPREINST.SH from or the directory that youun-tarredFILE0.TAR into) you can set this variable toyour install_dir directory.

o_dispatch The default port is 94. Do not override.

SAVE_CFG_FILESThe debugging files used during initialization of theTivoli management region server,/tmp/install.cfg.output and/tmp/install/cfg.error , areremoved after a successful installation. If you want tokeep them, you can set this variable to a nonnull value.

ExamplesThe following examples show command line installations. Theenvironment variableDOGUI is set tono. The X11 version ofinstallation is similar.

1. The following example installs the Tivoli management regionserver on the local machine. The complete path to the CD-ROMimage is/cdrom/cdrom0. The binaries are installed in/Tivoli/bin .The libraries are installed in/Tivoli/lib . The Tivoli database isinstalled in/Tivoli/database. The man pages are installed in/Tivoli/man . The X11 application defaults are installed in/Tivoli/X11 . The message catalogs are installed in/Tivoli/cat . Theserver is installed with the license key1234567890XYZZY. Adefault policy region is created with the nameNoonTide-Region.The Tivoli daemon automatically starts at system boot time. Theremote start capability of the Tivoli daemon is configured. Thespecified directories are created if they do not exist. Theinstallation password is set toTivoli4Ever . The default encryptionlevel is not used.

./wserver –c /cdrom/cdrom0 BIN=Tivoli/bin \LIB=Tivoli/lib ALIDB=/Tivoli/database MAN=/Tivoli/man \APPD=/Tivoli/X11 CAT=/Tivoli/cat \LK=1234567890XYZZY RN=NoonTide-Region AutoStart=1 \SetPort=1 CreatePaths=1 IP=Tivoli4Ever

wserver


Com

mands

Note: To reinstall a Tivoli management region server, you mustforce the installation to overwrite the directory containingthe Tivoli database (ALIDB=! ). You can optionallyoverwrite any other directories. Use the exclamation mark(!) to force the installation to overwrite directories thatalready exist. The following command line reinstalls theTivoli management region server installed with thepreceding command, overwriting each directory:

./wserver –c /cdrom/cdrom0 \BIN=! LIB=! ALIDB=! MAN=! APPD=! CAT=! \LK=1234567890XYZZY RN=NoonTide-Region AutoStart=1 \SetPort=1 CreatePaths=1 IP=Tivoli4Ever

2. The following example installs the Tivoli management regionserver on the local machine. The complete path to the CD-ROMimage is/cdrom. The binaries are installed in/Tivoli/bin . Thelibraries are installed in/Tivoli/lib . The Tivoli database is installedin /Tivoli/database. The man pages are installed in/Tivoli/man .The server is installed with the license key1234567890. A defaultpolicy region is created with the nameNoonTide.

wserver -c /cdrom -d -p /Tivoli! ALIDB=/database \LK=1234567890 RN=NoonTide

3. The following example installs the Tivoli management regionserver on the local machine. The complete path to the CD-ROMimage is/cdrom. The binaries are installed in/Tivoli/bin . Thelibraries are installed in/Tivoli/lib . The Tivoli database is installedin /Tivoli/database. The man pages are installed in/Tivoli/man .The server is installed with the license key1234567890. A defaultpolicy region is created with the nameNoonTide.

wserver -c /cdrom BIN=/Tivoli/bin LIB=/Tivoli/lib \ALIDB=/Tivoli/database MAN=/Tivoli/man LK=1234567890 \RN=NoonTide

4. The following example installs the Tivoli management regionserver on the local machine. The complete path to the CD-ROMimage is/cdrom. Everything (binaries, libraries, and so on) isinstalled in the default locations under the user-specified directory/Tivoli . The server is installed with the license keyABCDEFGHIJKLMNO .

wserver -c /cdrom -d LK=ABCDEFGHIJKLMNO

wserver

1–480 Version 3.7.1

5. The following example installs the Tivoli management regionserver on the remote machinecook. The complete path to theCD-ROM image is/cdrom, and this path must be reachable fromboth the local machine and the remote machine (cook). The user isprompted to enter the root password of the machinecook.Everything (binaries, libraries, and so on) is installed in the defaultlocations. The server is installed with the license keyZYXWVUTSRQPONM .

wserver -c /cdrom -P -d -a cook LK=ZYXWVUTSRQPONM

See Alsowclient, winstall

wsetadmin


Com

mands

wsetadminChanges information about a Tivoli administrator.

Syntaxwsetadmin [–L login] [–l login] [–n notice_group][–N notice_group] [–R group] [–r group,role1:role2…] name

DescriptionThewsetadmin command changes the properties of an existing Tivoliadministrator. An administrator login can be added or removed, and anadministrator’s group roles and notice group subscriptions can bechanged.

Options–l login Adds the specified login.

–L login Removes the specified login.

–n notice_groupAdds a subscription to a notice group.

–N notice_groupRemoves a subscription from a notice group.

–r group,role1:role2…Changes the administrator’s role ingroup to thespecified role. The following are examples of validformats for this option:

@Administration@PolicyRegion:Administration/Regions/PolicyRegion:Administration

–R group Removes all roles for the administrator in the group.

name Specifies the name of the administrator whoseproperties to change.

wsetadmin

1–482 Version 3.7.1


Examples1. The following example changes information for administrator

Steve Callahan. The administrator’s role in theAccountingpolicy region isadmin. He is no longer subscribed to the TivoliAuthorization notice group, and the logincallahan@teton isadded.

wsetadmin -r @Accounting,admin -N "Tivoli Authorization" \-l callahan@teton "Steve Callahan"

2. The following example again changes information foradministratorSteve Callahan. The example removes hisauthorization in theAccounting policy region. It adds asubscription to the Tivoli Authorization notice group, and removesthe logincallahan@teton.

wsetadmin -R @Accounting -n "Tivoli Authorization" \-L callahan@teton "Steve Callahan"

DefectsYou cannot usewsetadminto change the user name, the group name, orthe label of the Administrator icon. You must make these changes fromthe desktop.

See Alsowcrtadmin , wgetadmin

wsetdfpol


Com

mands

wsetdfpolSets the default policy object for a class.

Syntaxwsetdfpol [–d | –v] class label

DescriptionThewsetdfpolcommand sets the names of the default policy default andpolicy validation objects for the specified managed class in the currentpolicy region. When a managed class is added to a policy region, itreceives the specified default policy objects.

A policy default object generates default attribute values for resourcescreated in a policy region. A policy validation object validates attributevalues for a managed class.

Options–d Sets the default policy default object. This action is the

default unless–v is specified.

–v Sets the default policy validation object.

class Specifies the class for which the default policy object isto be set.

label Specifies the label of the desired policy object.


ExamplesThe following example makes the policy validation object,Restricted,the default policy validation object for theProfileManager class.wsetdfpol -v ProfileManager Restricted

wsetdfpol

1–484 Version 3.7.1

See Alsowgetdfpol

wseterr


Com

mands

wseterrSets the return code from a batch file for a configuration program. Thiscommand should be run from an endpoint.

Syntaxwseterr return_code

DescriptionThewseterr command sets the return code for a batch file invoked as aconfiguration program. Tivoli recommends that you specify thiscommand at the end of all batch files to return the proper code to TivoliSoftware Distribution.

Optionsreturn_code Specifies the return code to be returned.

wsetjob

1–486 Version 3.7.1

wsetjobSets the properties of a job.

Syntaxwsetjob –j job_name–l library_name [–t task_name] [–M mode][–s interval–n number] [–m timeout] [–ooutput_format][–D] [–d node_name–f file_name] [–h node_name][–p prof_manager_name] [–N] [–X]

DescriptionThewsetjob command sets the properties of a job using the specifiedtask.

Options–d node_nameSpecifies the managed node on which to save the job

output.

–D Displays the job output to the desktop.

–f file_name Specifies the file name in which to save the job output.

–h node_nameSpecifies the managed node on which to run the job.

–j job_name Specifies the name of the job being created.

–l library_nameSpecifies the task library containing the task to beincluded in the job.

–m timeout Specifies the number of seconds the task library waitsfor results to be returned from the task. If you are usingstaged mode, the timeout must be smaller than theinterval time.

–M mode Specifies the mode in which the job runs. Valid optionsare the following:

parallel Runs the job on one managed node at atime.

wsetjob


Com

mands

serial Runs the job on all specified managednodes and any subscriberssimultaneously.

staged Runs the job in groups of managednodes at specified intervals. Therequired options for–M stagedare–sinterval, –n number, and–m timeout.

–n number Specifies the number of managed nodes in each groupin staged mode. You must specify a value for thisoption if you selectedstaged mode.

–N Disables writing job output to the file.

–ooutput_formatDefines the format of the job output. The job outputcontains a summary of the job on each managed node.Job output format is specified with a number from 0 to15. The format is constructed from the sum of any of thefollowing values:

1 Prints a descriptive header for each record

2 Prints the job’s return code



–p prof_manager_nameSpecifies the profile manager on which the job runs.

–s interval Specifies the number of seconds between when the taskruns on one group of managed nodes and when it runson the next group. You must specify a value for thisoption if you selectedstaged mode. The interval mustbe greater than the timeout value given with the–moption.

–t task_name Specifies the name of the task to include in the tasklibrary.

–X Disables writing job output to a the desktop.

wsetjob

1–488 Version 3.7.1


See Alsowcrttask, wdeljob, wrunjob, wsettask

wsetlang


Com

mands

wsetlangSets the locale for Tivoli method execution on a Tivoli managementregion server or managed node.

Syntaxwsetlang [–o] [–l locale_name]

DescriptionThewsetlang command sets the language environment for a Tivolimanagement region server or managed node. The specified locale namecan either be a valid operating system locale name or a standard localename. A locale name is composed of the two-letter ISO 639 languagecode followed by an optional underscore (_) and two-letter ISO 3166country code. The standard syntax is as follows:11[ _TT]

wherell represents the language code and_TT is the optional countrycode.

The operating system locale names on UNIX machines can be listedusing the following UNIX command:locale -a

On UNIX systems, the specified locale name is mapped to the installedoperating system locale name that it most closely matches. If nomatching locale name is found,C is used. Windows NT andWindows 2000 systems simply use the specified locale name. It is notvalidated.

Standard locale names include the following:

en or C English

fr French

de German

it Italian

ja Japanese

pt_BR Brazilian Portuguese

ko Korean

wsetlang

1–490 Version 3.7.1

zh_CN Simplified Chinese

zh_TW Traditional Chinese

Options–l locale_nameSpecifies the desired locale. If the–l option is not

specified, the current language environment is used.

–o Sets the language for this Tivoli management regionserver or managed node to the specified value.

Authorizationsuper or senior

Examples1. To set the locale to French and update theodadmin environment

for methods, enter the following command:

wsetlang –o –l fr

The method environment settings can be viewed using thefollowing command:

odadmin environ get

2. To just view the operating system locale name for French, enter thefollowing command. This does not update the methodenvironment.

wsetlang -l fr

wsetpkey


Com

mands

wsetpkeyEncrypts and stores a password in the registry.

Syntaxwsetpkey [–akey [–k]] | [–d key]

DescriptionThewsetpkey command encrypts and stores a password in theWindows NT or Windows 2000 registry. The encrypted password isstored under a key you provide.

Options–a Adds or replaces a key and password.

–d Reads the password from standard input withoutprompting, or from the console without echo.

–k Deletes the key and password.

ExamplesThe following example adds theadmin_key:wsetpkey –a admin_key

wsetpm

1–492 Version 3.7.1

wsetpmEnables or disables a profile manager to operate in dataless mode.

Syntaxwsetpm [–d | –D] @ProfileManager:prof_manager_name

DescriptionThewsetpm command specifies whether a profile manager runs indataless mode. The dataless mode enables profile managers to distributeto endpoints that have no client database. Endpoints can subscribe toprofile managers running in the dataless mode. A managed node cansubscribe to any profile manager regardless of the profile manager’sdistribution mode. If a dataless profile manager distributes to a managednode, the managed node’s database is ignored during the distribution.

Options–d Specifies thatprof_manager_name operates in a

dataless mode.

–D Specifies thatprof_manager_namedoes not operate ina dataless mode. You must remove all endpointsubscribers before you disable the dataless mode on aprofile manager.

@ProfileManager:prof_manager_nameIdentifies the name of the profile manager.


Examples1. The following example sets the profile manager,AdminServer, to

operate in dataless mode. Endpoint subscribers are allowed.

wsetpm -d @ProfileManager:AdminServer

wsetpm


Com

mands

2. The following example sets the profile manager,TopLevel, to notaccept endpoint subscribers. Dataless operation is disabled.

wsetpm -D @ProfileManager:TopLevel

wsetpr

1–494 Version 3.7.1

wsetprAssigns the policy used in a policy region, enables or disables policyvalidation, and adds or removes a managed resource in a policy region.

Syntaxwsetpr [–d default_pol] [–v validation_pol] [–E | –e] resource region

wsetpr [–r] resource region

DescriptionThewsetpr command specifies which default or validation policy isused for the specified resource in the specified policy region. If the–Eor –eoption is used, this command enables or disables policy validationfor the specified resource in the specified policy region. Thewsetprcommand also adds or removes a managed resource in a policy region.By default, the command adds the specified resource to the policyregion. To remove a managed resource, use the–r option.

Options–d default_pol Specifies the label of the default policy to be used for

the managed resource.

–e Enables policy validation.

–E Disables policy validation.

–r Removes the specified resource from the policy region.

–v validation_polSpecifies the label of the validation policy to be used forthe managed resource.

region Specifies the label of the target policy region.

resource Specifies the managed resource type.


wsetpr


Com

mands

Examples1. The following example adds resourceTaskLibrary to the

Engineering policy region:

wsetpr TaskLibrary @PolicyRegion:Engineering

2. The following example enables policy validation for theTaskLibrary resource in theEngineering policy region. Thedefault policy isBasicTaskLibrary and the validation policy isBasicTaskLibrary .

wsetpr -d BasicTaskLibrary -v BasicTaskLibrary -e \TaskLibrary @Engineering

See Alsowcrtpr , wdelpr, wgetpr

wsetquery

1–496 Version 3.7.1

wsetqueryEdits the properties of a query.

Syntaxwsetquery [–n name] [–d desc] [–r repository] [–v view][–ccolumn…] [–i | –s | –w where_clause] [–x] query_name

DescriptionThewsetquery command enables you to change information about anexisting query. You can change the query name, description, repository,view, columns list, and the where clause.

Options–ccolumn… Changes the column or columns from which the query

retrieves information. To include more than onecolumn, use multiple–c clauses. The columns in theoutput are ordered according to how you enter themhere.

–d desc Changes the description of the query.

–i Reads a new where clause from standard input.

–n name Changes the name of the query.

–r repository Changes the repository from which the query getsinformation.

–s Reads a new structured clause from standard input. Theclause should be in the following format:

[AND | OR] [NOT] Column_Name{= | != | < | <= | > |>= | LIKE | IN} Column_Value

–v view Changes the view or table that the query uses to retrieveinformation from the database.

–w where_clauseReads a new where clause from the command line.

wsetquery


Com

mands

–x Specifies that the output of the query does not containduplicate rows.

query_name Specifies the query to be changed.

Authorizationquery_edit, admin, senior, orsuper

Examples1. The following example changes the where clause of the

DOS-machines query to check the operating system version aswell as the operating system name. It reads the new where clausefrom the command line.

wsetquery -w "BOOTED_OS_NAME = 'DOS' AND \BOOTED_OS_VERSION LIKE '6.%'" DOS-machines

2. The following example changes the name of theDOS-machinesquery toAIX-machines, changes the description of the query, andreads a new where clause from standard input.

wsetquery -i -n AIX-machines -d "Find all the AIX \machines" DOS-machines <<EOF

(BOOTED_OS_NAME = 'AIX')

EOF

See Alsowcrtqlib , wcrtquery , wgetquery, wruninvquery , wrunquery

wsetrim

1–498 Version 3.7.1

wsetrimEdits the properties of an RDBMS Interface Module (RIM) object.

Syntaxwsetrim [–n name] [–d database] [–u user] [–H db_home][–sserver_id] [–I instance_home] rim_name

DescriptionThewsetrim command changes the database information for a givenRIM object. You can change the database ID, database user, databasehome, database server ID, and instance home. To change the managednode or vendor for a RIM object, you must delete the object using thewdelcommand and re-create it using thewcrtrim command. To changethe label, you can either delete and re-create the RIM object, or you canuse the_set_label method if Tivoli Application DevelopmentEnvironment is installed.

Options–d database Changes the name of the database to which the RIM

object connects. If you are using DB2, specify anyname other than “inventory.”

–H db_home Changes the path to the database home directory. Thisoption changes the environment variablesORACLE_HOME , SYBASE, andDB2DIR forOracle, Sybase, and DB2, respectively.

–I instance_homeFor DB2 only, changes the name and path of the DB2instance for the specified RIM object.

–n name Changes the name of the RIM object toname.

–sserver_id Changes the server ID for the database. This optionchanges the environment variablesTWO_TASK ,DSQUERY, andDB2COMM for Oracle, Sybase, andDB2, respectively. For Microsoft SQL Server, this is

wsetrim


Com

mands

the name of the relational database management system(RDBMS) server machine.

–u user Changes the name of the database user that the RIMobject uses. If you are using DB2, specify a valid UNIXuser.

rim_name Specifies the label of the RIM object to be modified.


ExamplesThe following example changes the database ID toinventory, thedatabase user totivoli2 , the database home directory to/ORACLE , andthe database server ID to invdb2.world for theinventory RIM object.wsetrim -d inventory -u tivoli2 -H /ORACLE \-s invdb2.world inventory

To verify the changes, use thewgetrim command:wgetrim inventory

The output is as follows. Note that the output for the Instance Home fieldis blank; this field applies only to DB2.RIM Host: amon-sulRDBMS User: tivoli2RDBMS Vendor: OracleDatabase ID: inventoryDatabase Home: /ORACLEServer ID: invdb2.worldInstance Home:

See Alsowcrtrim , wgetrim, wsetrimpw

wsetrimpw

1–500 Version 3.7.1

wsetrimpwSets the database password for an RDBMS Interface Module (RIM)object.

Syntaxwsetrimpw rim_name [old_pw new_pw]

DescriptionThewsetrimpw command sets the database password on a RIM object.The command prompts you for a password unless you specify theold_pw andnew_pw options.

Optionsnew_pw Specifies the new password.

old_pw Specifies the current password.

rim_name Specifies the label of the RIM object.


ExamplesThe following example changes the password fromfunEguy toDlite forthe inventory RIM object:wsetrimpw inventory funEguy Dlite

See Alsowcrtrim , wgetrim, wsetrim

wsettap


Com

mands

wsettapSets the properties of the Tivoli Authentication Package on aWindows NT or Windows 2000 client. Issue this command from thelocal machine (managed node) to which it applies.

Syntaxwsettap [–a] [–B] [–d] [–P][–r [domain_name\user_name | user_name]] [–k]

DescriptionThewsettap command sets the properties of Tivoli AuthenticationPackage,TivoliAP.dll . The Tivoli Authentication Package enablesTivoli Management Framework to access remote file systems in thecontext of a user. (See theTivoli Management Framework Planning forDeployment Guide for more information about accessing remote filesystems.) Thewsettap command also enables a Windows NT orWindows 2000 system to run setuid methods, that is, to run a method inthe context of a user associated with the method.

The Tivoli remote access account specifies a user account. TivoliManagement Framework uses this account to access remote filesystems.

Using thewsettapcommand with no options prints version informationfrom the currently runningTivoliAP.dll .

When activating the Tivoli Authentication Package for the first time,which is usually immediately following Tivoli management regionserver installation, you must restart the machine for changes to takeeffect.

Options–a Sets the Tivoli Authentication Package internal key and

registersTivoliAP.dll with the local security authority(LSA). The new internal key becomes effectiveimmediately. TheTivoliAP.dll file is loaded by theLSA when the machine is restarted.

wsettap

1–502 Version 3.7.1

–B Authenticates domain users using a domain controllerother than the primary domain controller. Toauthenticate users using the primary domain controller,use the–P option.

–d Removes the Tivoli Authentication Package internalkey and unregisters theTivoliAP.dll with the LSA. TheTivoliAP.dll file is released by the LSA (so that it canbe deleted if Tivoli Management Framework isuninstalled) when the machine is restarted.

–k Specifies thatwsettap should read the password foruser_name from standard input. If you do not specify–k, wsettap prompts you for the password.

–P Authenticates domain users using the primary domaincontroller. This is the default setting. To authenticateusers using other domain controllers, such as backupdomain controllers, use the–B option.

–r [domain_name\user_name | user_name]Sets the Tivoli remote access account touser_name.Tivoli accesses remote file systems using this useraccount.user_name can be prefixed with the domainname, separated by either a forward slash (/) or abackslash (\). If the domain is specified, it must be thedomain in which the machine running TivoliAuthentication Package belongs or a domain trusted bythat domain. If no domain is specified, Windows NT orWindows 2000 looks for the given user in the localdomain or trusted domains.wsettap –r "" disablesTivoli Management Framework access to remote filesystems. To see changes take effect immediately,restart the object dispatcher.

AuthorizationMember of the Administrators group. Tivoliadmin authorization isrequired to runwsettap with no options. Windows NT permission isrequired to edit the registry to use this command.

wsettap


Com

mands

ExamplesThe following example sets the Tivoli remote access account to a useraccount nameduserTME. The wsettap command reads the passwordfor userTME from thepswd.txt file.wsettap -r userTME -k < pswd.txt

wsettask

1–504 Version 3.7.1

wsettaskSets the properties of a task.

Syntaxwsettask –ttask_name–l lib_name [–ggroup_name][–u user_name] –r role [–ccomments]{ –i interp_type node_name file_name}…

DescriptionThewsettaskcommand sets the properties of a task in the specified tasklibrary.

Options–ccomments Adds any explanatory comments that help identify the

task and its purpose.

–ggroup_name(UNIX only) Specifies the name of the group underwhich the task runs.

–i Defines the information required to execute the newtask on a managed node. You must supply the followingvalues with the–i option:

file_name Specifies the name of the executablefile to be run on the specified platform.

interp_type Specifies the interpreter type of theplatform on which the task is to be run.

node_name Specifies the managed node containingthe executable file for the specifiedplatform.

–l lib_name Specifies the task library in which the task resides.

–r role Specifies the authorization roles required to run thetask. Multiple roles can be specified in acolon-separated list, for exampleadmin:senior:super.

–t task_name Specifies the name of the task being updated.

wsettask


Com

mands

–u user_name Specifies the name of the user under which the taskruns.


See Alsowcrttask, wdeltask, wgettask

wsetval

1–506 Version 3.7.1

wsetvalAdds or deletes a registry entry (key name) and sets its value (key value).This command should be run from an endpoint. (Windows only)

Syntaxwsetval [–b] [–d] [–h registry_hive] –k {key | @file_name}–n value_name–v { " value_string" | @file_name}

DescriptionThewsetval command adds or deletes a registry entry (key name) andsets its value (key value). If the key or value does not exist, it is created.

Options–b Creates the value as binary. Binary values must be read

from a file specified with the–v option.

–d Deletes a value name specified by the–noption or a keyname specified by the–k option. If the–n option ispresent, the value name specified by the–n option isdeleted. If the–n option is not present, the key (and allits subkeys) specified by the–k option is deleted.

–h registry_hiveSpecifies the registry hive to update. Valid values are asfollows:

HKEY_LOCAL_MACHINE (default)HKEY_CURRENT_USERHKEY_CLASSES_ROOTHKEY_USERSHKEY_CURRENT_CONFIG(Windows NT 4.0)HKEY_DYN_DATA (Windows NT 4.0)

–k key | @file_nameSpecifies the key in which the value is inserted. If thefirst character of the key is@, the key is read fromfile_name.

wsetval


Com

mands

–n value_nameSpecifies the name of the value. The–n option isoptional if–d is present.

–v " value_string" | @file_nameSpecifies the value or file that contains the value. The–v option is ignored if–d is present.

Authorizationadmin

ExamplesTo add theNOTEPAD subkey under the existingSOFTWARE key,and assign theNOTEPADVAR key value name in theHKEY_LOCAL_MACHINE hive, enter the following command:wsetval -h HKEY_LOCAL_MACHINE -k SOFTWARE\NOTEPAD \-n NOTEPADVAR -v C:\TEMP\NTPADVAR.FIL

wsndnotif

1–508 Version 3.7.1

wsndnotifTranslates standard input into a message structure and sends it to thenotification server.

Syntaxwsndnotif [–et] ngroup priority

DescriptionThewsndnotif command is a command line program that translatesstandard input into a message structure and sends it to the notificationserver. The–eand–t options enable shell scripts to send messages in alanguage-neutral format. If these options are not specified, thiscommand treats standard input as a single ASCII buffer and the messageis not translated into a language-neutral format. This command sends themessage to the specified notice group using the specified priority.

Options–e Specifies that standard input is the ASCII

representation of an exception, such as an exceptiongenerated from an Interface Definition Language (IDL)call.

–t Specifies that standard input should be translated as atmf_msg_t in the ASCII format used by the ExtendedInterface Definition Language (EIDL) shell methodtype. For more information about the ASCII formatused by the EIDL shell method type, see theTME 10ADE Framework Services Manual.

ngroup Specifies the notice group to send the translatedstandard input to.

priority Specifies the priority to use to send the translatedstandard input to the specified notice group. Validpriorities areCritical , Error , Warning , Notice, andDebug.

wsndnotif


Com

mands


Examples1. The following example sends a notice to theTivoli

Administration notice group. The priority isNotice.

wsndnotif "Tivoli Administration" NoticeThis notice is to inform all admins that I’m going tochange the name of managed node homer to marge this weekend.

Paul^D

2. The following example uses the–e option in a shell script. If anIDL call returns a nonzero exit status, the ASCII output is anexception. The ASCII data is logged to theTivoli Administrationnotice group as an error.

out=`idlcall $OID method`if [ $? -ne 0 ]thenwsndnotif -e "Tivoli Administration" Error <<EOF$outEOFfi

3. The following example uses the–t option in a shell script. Thisexample sends message 49 from thetask_msgmessage catalog totheTivoli Administration notice group. StringsAmar ,[email protected], andAmarLib are inserted into themessage. If message 49 cannot be found, the default message issent. The default message is “A new task, %1$s, was created by%2$s in the %3$s task library.”

echo ' { { 1 { "task_msg" "A new task, %1$s, was created by \%2$s \in the %3$s task library." 4 9 { { \TMF_Types::_sequence_string_StringList } \{ 3 "Amar" "[email protected]" \"AmarLib " } } } } }' | \

wsndnotif -t "Tivoli Administration" Critical

wsndnotif

1–510 Version 3.7.1

See Alsowexpnotif, wlsnotif, wtailnotif

wstarthttpd


Com

mands

wstarthttpdStarts the Tivoli Hypertext Transfer Protocol (HTTP) daemon.

Syntaxwstarthttpd [host_name]

DescriptionThewstarthttpd command starts the Tivoli HTTP daemon on the hostthat is specified byhost_name. If host_nameis not specified, the HTTPdaemon on the local managed node is started.

Optionshost_name Specifies the name of the managed node on which to

start the HTTP daemon.


ExamplesThe following example starts the HTTP daemon on the managed nodeccorley:wstarthttpd ccorley

See Alsowstophttpd

wstartsched

1–512 Version 3.7.1

wstartschedStarts the Tivoli scheduler.

Syntaxwstartsched

DescriptionThewstartsched command starts the Tivoli scheduler. The process itstarts isTMF_sched.

Authorizationsenior

See Alsowdelsched, wedsched, wenblsched, wgetsched, wschedjob

wstophttpd


Com

mands

wstophttpdStops the Tivoli Hypertext Transfer Protocol (HTTP) daemon.

Syntaxwstophttpd [host_name]

DescriptionThewstophttpd command stops the Tivoli HTTP daemon on the hostthat is specified byhost_name. If host_nameis not specified, the HTTPdaemon on the local managed node is stopped.

Optionshost_name Specifies the name of the managed node on which to

stop the HTTP daemon.


ExamplesThe following example stops the HTTP daemon on the managed nodeccorley:wstophttpd ccorley

See Alsowstarthttpd

wsub

1–514 Version 3.7.1

wsubSubscribes Tivoli resources to a profile manager.

Syntaxwsub [–r] name subscriber…

DescriptionThewsub command subscribes the Tivoli resources specified insubscriber to the profile manager specified inname.

Options–r Specifies that thewsubcommand returns an error code

(1) if any of the subscribers are unreachable. A failurecode is always returned if the specified subscriber doesnot exist.

name Specifies the name of the profile manager to which tosubscribe the resources. Valid formats for thenameoption are as follows:




subscriber Specifies the names of the Tivoli resources to add to thespecified profile manager’s subscription list. Thisoption can be specified multiple times. The followingare examples of valid formats for thesubscriberoption.If you are subscribing a resource other than a managednode, modify these examples to reflect your resourcetype.



wsub


Com

mands

Authorizationadmin, senior, orsuper in the policy region where the resource is beingsubscribed

ExamplesThe following example subscribes the managed nodespinatubo andnewcastle and the profile managerApps_Dev to theDevelopmentprofile manager:wsub @Development @ManagedNode:pinatubo \@ManagedNode:newcastle @ProfileManager:Apps_Dev

See Alsowcrtprf , wcrtprfmgr , wdistrib , wgetprf, wgetsub, wlssub,wpopulate, wunsub, wvalidate

wsupport

1–516 Version 3.7.1

wsupportCollects problem information from users to send to a customer supportrepresentative. (UNIX only)

Syntaxwsupport –s

DescriptionThewsupport command prompts you for essential information neededby a support representative to investigate technical problems.

After the information is entered, you are prompted whether theinformation is e-mailed to the support representative or saved to a textfile. If you specify e-mail, you must enter the e-mail address to which tosend the information. The provided information is mailed in a formatthat can be parsed, one item per line. If you choose to save theinformation to a text file, the information is presented in an orderedformat that can be faxed to a support representative. You can edit theinformation before faxing it. You can also e-mail the file at a later time.

If you are going to e-mail the file to a support representative later, it isrecommended that you choose the e-mail option when prompted, andthen specify No on the final confirmation.

You are prompted for the following customer information:

Name Name of the person submitting the support request.

Company NameName of the company.

E-mail AddressThe submitter’s e-mail address if e-mail is available.

Telephone NumberThe submitter’s telephone number. A telephonenumber is required if an e-mail address is not provided.

Fax Number The submitter’s fax number.

TMR Number The number of the licensed Tivoli management region.

wsupport


Com

mands

Support E-mail AddressThe e-mail address of the customer’s Tivoli supportprovider.

You are prompted for the following system information:

Call ID numberThe call tracking number of an existing problem loggedby your support provider.

System Type The system on which the problem occurred, such asSolaris, HP, or IBM.

Operating System ReleaseThe release level of the operating system on which theproblem occurred, such as 4.1.3.

Tivoli Product The name of the Tivoli product (such as Tivoli UserAdministration, Tivoli Remote Control, or TivoliInventory) in which the problem occurred.wsupportdisplays a list of Tivoli products from which to choose.

Tivoli Release The release number of the Tivoli product, such as 3.1 or3.6.

You are prompted for the following problem information:

Where the problem occurredWhether the problem occurred on the Tivolimanagement region server or the Tivoli client.

Name of server or clientName of the system on which the problem occurred.

Severity of the problemSeverity level of the problem. Valid options are asfollows:

Critical Customer cannot conduct business,product is inoperative, loss ofoperations, continuous failures orinterruptions, data corruption

Major Systems or application interrupted butrecovered, high risk of reoccurrence,

wsupport

1–518 Version 3.7.1

urgent, intermittent failures,significant performance degradation

Minor Problem encountered, irritant, minimalimpact to business operations,localized or isolated impact,operational nuisance

No Impact General questions or informationneeded

Short descriptionTen to twelve word description of the problem.

Attempted solutionsActions taken that did not solve the problem.

Long descriptionDetailed description of the problem.

The problem information can be saved to .tivoli_rc in the user’s homedirectory.

Options–s Skips the customer information questions. Prompting

begins with the system information questions.Customer information is read from the.tivoli_rc file.

Files/tmp/wsupport.$UNAME – Generated report file/tmp/sup.$UNAME.uu – Encoded compressed log files

wtailnotif


Com

mands

wtailnotifConnects to the notification server and displays new notices as they areposted.

Syntaxwtailnotif [–aadmin…] [–g group…] [–l] [–p priority…]

DescriptionThewtailnotif command connects to the notification server and displaysnew notices as they are posted. You can filter the notices by priority,administrator, or group. The–l option is used to list only notice headersrather than entire notices. If the–l option is not specified, all notice datais displayed. The–p option specifies that only notices with the specifiedpriority are to be displayed. Multiple priorities can be specified. The–aoption specifies that only notices posted by the specified administratorare to be displayed. Multiple administrators can be specified. The–goption specifies that only notices posted to the specified notice group areto be displayed. Multiple groups can be specified. If no options arespecified with this command, all notices from all notice groups aredisplayed as they are received.

Options–aadmin… Specifies that only notices posted by the administrator

specified byadmin are to be displayed. Multipleadministrators can be specified.

–ggroup… Specifies that only notices posted to the notice groupspecified bygroupare to be displayed. Multiple noticegroups can be specified.

–l Specifies that only notice headers are to be displayed. Ifthis option is not specified, all notice data is displayed.

–p priority… Specifies that only notices with the priority specified bypriority are to be displayed. Multiple priorities can bespecified.

wtailnotif

1–520 Version 3.7.1


ExamplesThe following example displays Tivoli administration notices as theyare posted to the notice group:wtailnotif -g "TME Administration"

The following sample output displays notices for creating a policyregion, adding resources to the region, and creating a task library:Date: Thu Feb 22 20:53:08 2001Notice-Group-Name: TME AdministrationPriority: NoticeSent-By-Administrator: [email protected]

Policy Region Southeastern-region Created

Created a policy region named Southeastern-region.

Date: Thu Feb 22 20:53:39 2001Notice-Group-Name: TME AdministrationPriority: NoticeSent-By-Administrator: [email protected]

Policy Region Southeastern-region Resources Changed

The resource types managed by policy region Southeastern-regionwere changed to the following resource types:

TaskLibrary Endpoint

Date: Thu Feb 22 20:54:25 2001Notice-Group-Name: TME AdministrationPriority: NoticeSent-By-Administrator: [email protected]

A task library, Daily reports, was created [email protected] in the Southeastern-region policyregion.

See Alsowexpnotif, wlsnotif, wsndnotif

wtaskabort


Com

mands

wtaskabortAborts a task transaction and rolls back any uncommitted changes.

Syntaxwtaskabort

DescriptionThewtaskabort command is for use within a task shell script. It cannotbe used from the command line to cancel a specific task.

When tasks are executed, a transaction model can be specified. UsingTivoli commands, it is possible to perform multiple operations as part ofone transaction. Any changes do not become permanent until the taskcompletes and the transaction is committed. If a failure occurs in the taskwith a non-Tivoli command, thewtaskabort command can be used toabort the transaction and roll back any changes that have not beencommitted.

NotesWhen thewtaskabort command is used, the task does not return anyoutput or the return code. Instead, an error message similar to thefollowing is displayed:bald (ManagedNode): The task failed to execute.bald (ManagedNode): System Exception: failure detected by \object adapter:completion status: NOTransaction Error

ExamplesIn the following example, a task was written that registers a specialresource in the Tivoli name registry that stores the path to a directory.Next, the directory is created. If themkdir command fails, the scriptexecutes theabort() function because the shell is running with the–eflag. In theabort() function,wtaskabort is called, which rolls back thechange made to the name registry. The special resource does not showup in any subsequent lookups.

wtaskabort

1–522 Version 3.7.1

1 #!/bin/sh2 set -e34 #5 # Function to be used to abort a transaction in task shell \

script67 #8 abort() {9 return_code=$?10 if [ $return_code -ne 0 ]; then11 wtaskabort12 fi13 }1415 trap 'abort' 01617 #18 # TASK MAIN19 #20 wregister -i -r special_directory /Tivoli/specials \

OBJECT_NIL21 mkdir /Tivoli/specials

See Alsowruntask, wrunjob , “Tivoli Transactions” on page 1-6

wtimezone


Com

mands

wtimezonePrints the value of the specified system’s time zone.

Syntaxwtimezonehost_name

DescriptionThewtimezone command prints the time zone of the system specifiedin thehost_name option by printing the number of minutes west ofGreenwich mean time (GMT).

Optionshost_name Specifies the name of the host time zone to print.


ExamplesThe following example shows the time zone of the managed nodebald:wtimezone bald360

See Alsowdate, wdiskspace, whostid, wifconfig, winstdir , winterp ,wmannode, wmemsize, wping, wuname, wxterm

wtemp

1–524 Version 3.7.1

wtempDisplays the name of the directory in which Tivoli products createtemporary files.

Syntaxwtemp [–s]

DescriptionThewtempcommand displays the name of the directory in which Tivoliproducts create temporary files. It can also confirm that the directoryexists and can be written to.

wtemp uses the forward slash (/) in all path names. On Windows NT orWindows 2000 systems, if you are not using the bash shell, you mightneed to convert forward slashes to backward slashes (\).

Options–s Confirms that the directory exists and can be written to.


Return ValuesIf the temporary directory does not exist or cannot be written to, it writesa null string to standard output.

Examples1. The following example displays the temporary directory on a

Solaris system:

wtemp/var/tmp

wtemp


Com

mands

2. The following example displays the temporary directory on aWindows NT or Windows 2000 system:

wtempc:/Tivoli/db/cdeamqs.db/tmp

3. The following example confirms that the temporary directory onan AIX system exists and can be written to:

wtemp -s/tmp

4. The following example shows that the temporary directory eitherdoes not exist or cannot be written to:

wtemp -s

wtll

1–526 Version 3.7.1

wtllImports and exports task library definitions.

Syntaxwtll [–r] –p region [–Ppreprocessor] import_file[preprocessor_options…]

wtll –i [–p region | –l library_name] [–t task…] [–Ppreprocessor]import_file [preprocessor_options…]

wtll –d [–l library_name] [–Ppreprocessor] import_file[preprocessor_options…]…

wtll –F export_file–l library_name

DescriptionThewtll command is a tool used to import (install) task librarydefinitions and create or modify Tivoli task libraries. The command isalso used to export existing task libraries in a form that allows them tobe saved offline or transferred to other installations. Task libraries aredescribed with the Task Library Language (TLL) for both import andexport purposes.

When importing a new task library into a Tivoli management region, aTLL source file is prepared. All programs or scripts to be used by thetasks are either included directly in the TLL source or are referenced asexternal files by TLL directives. Thewtll command reads and parses thetask library definition, validates the various attributes defined in thesource, and then either creates or modifies a task library object.

When exporting a task library,wtll creates a tar-format file that containsall materials needed to reconstruct the task library. The collected exportfiles include a TLL description of the tasks along with the code of eachtask for each platform type supported.

For more information about using thewtll command to create tasklibraries, see theTivoli Task Library Language Developer’s Guide.

wtll


Com

mands

Options–d Runs thewtll command in debug mode. Thewtll

command checks the syntax ofimport_file, but does notimport the file into the Tivoli management region.

–F export_file Creates a tar-format export file of the task libraryspecified bylibrary_name.

–i Inserts a new task or group of tasks into an existing tasklibrary. The import file is parsed, and specified tasks arecreated in the existing task library. The import file canbe a complete task library or a list of individual tasks.

Notes:

• It is recommended that you use thewcrttaskcommand to add a task to a task library.

• If the import file contains a task library, the taskcontained must be self contained. The taskcannot use the “layout” key word to specify anArgLayout defined in the task library.

–l library_nameSpecifies the name of the task library for eitherexporting or for modifying. The library must be definedin the local Tivoli management region.

–p region Specifies the policy region in which to create the newtask library. The policy region must exist within thelocal Tivoli management region.

–PpreprocessorSpecifies the path to the program to use as apreprocessor on the import file before it is parsed. Thecpp command is the mostly commonly usedpreprocessor.

Any options listed on the command line afterimport_file are assumed to be options to be passed tothe preprocessor (preprocessor_options).

–r Replaces a task library with the library specified inimport_file. The existing library and all its tasks and

wtll

1–528 Version 3.7.1

jobs are deleted, and then the library is re-created withthe features specified in the import file. If the librarydoes not already exist, a new one is created.

–t task Specifies the name of the task to import. The specifiedtask name must be unique within the task library orpolicy region.

import_file Specifies the file to import. This file can contain asingle task to be added to a task library or an entire newtask library, which replaces the existing task library.

preprocessor_optionsSpecifies additional preprocessor options. Refer to thedocumentation for the preprocessor for valid options.

Authorizationadmin, senior

Examples1. The following example creates a new task library in the policy

regionsandia-Region using the TLL source in the file/tmp/tll :

wtll -p sandia-Region /tmp/tll

2. The following example also creates a new task library in the policyregion, but it first runs the TLL source through thecpppreprocessor and uses include files from the user’s home directory.The–B and–P options are input tocpp. They parse C++comments in the task library file.

wtll -p sandia-Region -P /usr/lib/cpp /tmp/tll \-B -P

Note: The options for the preprocessor can use the same optionnames as those used forwtll (such as–P). Because of theirlocation in the syntax statement, the command processesthe options correctly.

wtll


Com

mands

3. This example replaces the task library namedmy_tasks, which isin the sandia-Region policy region, with the TLL source in/tmp/tll :

wtll -r -p sandia-Region -l my_tasks /tmp/tll

4. This example exports the task librarymy_tasks to the file named/tmp/my_tasks.tar:

wtll -F /tmp/my_tasks.tar -l my_tasks

See Alsocpp, tar, wcrttask

wtmrname

1–530 Version 3.7.1

wtmrnameDisplays or changes the name of the local Tivoli management region.

Syntaxwtmrname [–snew_name]

DescriptionThewtmrname command displays the name of the local Tivolimanagement region.wtmrname can also be used to change the name byproviding the–snew_name option. In this case, all regions must beconnected, so that the name can be verified as unique throughout theinstallation.

Options–snew_name Changes the Tivoli management region name to

new_name, after verifying the new name with allconnected regions.

AuthorizationThe caller must have these roles in the local Tivoli management region:

■ super—to set the name

■ super, senior, admin, oruser—to display the name

Examples1. The following example displays the local Tivoli management

region name:

wtmrnamesherman-region

2. The following example sets the local Tivoli management regionname topatton-region:

wtmrname -s patton-region

wtmrname


Com

mands

See Alsowconnect, wdisconn, wlsconn, wupdate

wtrace

1–532 Version 3.7.1

wtraceProvides information to debug methods.

Syntaxwtrace [–hjlnuvDEHIJOV ] [format_options] –k db_dir

DescriptionThewtrace command is used to diagnose problems in custom methodsand executable files by examining method input, transactions, andmethod output.

To usewtrace, you must first turn on tracing within the Tivoli objectdispatcher. This causes the creation of a trace log namedodtrace.log.This file is created in the database directory of the specified clients. Bydefault, the trace log is 1 MB (512 2-KB-trace records), but this can bechanged by restarting the object dispatcher and specifying a new sizewith the–t option.

Tracing is persistent across invocations of the object dispatcher. Thismeans that if the object dispatcher restarts, you do not have to reenabletracing. Becausewtrace examines the trace log directly, it does notrequire the object dispatcher to be active, although having an objectdispatcher available to runodstat is helpful.

You can use theodadmin command to enable tracing for single ormultiple object dispatchers. The following are some examples:

1. Enable tracing for all object calls on the current object dispatcher:

odadmin trace objcalls

2. Enable tracing for all object calls on all object dispatchers:

odadmin trace objcalls all

3. Enable tracing for error conditions on the current objectdispatcher:

odadmin trace errors

4. Enable tracing for object service calls on all object dispatchers:

odadmin trace services all

wtrace


Com

mands

5. Enable tracing of object service calls and errors on all objectdispatchers:

odadmin trace services allodadmin trace errors all

Output Format

Thewtrace command has numerous formatting options that providevarying amounts of displayed data. This section describes two of thecommon usages ofwtrace. See “Options” on page 1-535 for a full listof formatting options.

Four general rules apply to the output format ofwtrace:

1. Structure output is enclosed in curly braces ({}).

2. Arrays are enclosed in square brackets ([]).

3. Sequences are structures that have a count field followed by anarray of elements.

4. A top-level transaction has the following general format:

{111111:1,111111:1,2:3311

}#4

The most common usage ofwtrace is as follows:wtrace -jk /usr/Tivoli/spam.db

The j flag produces a preselected set of information. Output similar tothe following is displayed:loc-ec 676 15:10:36 M-H 1-289 0 NOT_FOUNDObject ID: 333333.1.387#FpPol::FilePackagePolDef#

Method: o_setattrMethod Args: fp_def_src_hostPrincipal: root@albundy (0/0)Path: o_setattrTrans Id:

{333333:1,333333:1,2:405

}, {333333:1,333333:1,2:406

}#3

This is a local object call on thread ID 676 run at 15:10:36 local time.The methodo_setattr was invoked on object reference

wtrace

1–534 Version 3.7.1

333333.1.387#FpPol::FilePackagePolDef# with the optionfp_def_src_host. Error status ofNOT_FOUND was returned.

In this verbose form, the transaction ID, the principal invoking themethod, the effective user ID and group ID of the method, and the pathto the method are also provided.

The following example entry shows an error condition (exception) thatwas detected:loc-ec 6073 16:28:01 M-hdoq 1-6047 26 e=12Object ID: 333333.1.26

Method: get_allPrincipal: root@ajax (60001/60001)Helper pid: 2419Path: /home/Tivoli/bin/solaris2/TMF/BASESVCS/TNR_prog1Trans Id:

{333333:1,333333:1,7:4042

},{

333333:1,333333:1,7:4063}#3

Input Data: (encoded): "NisDomain" 9999Results: (encoded):

"Exception:UserException:SysAdminException::ExException:SysAdminException::ExInvalid:SysAdminException::ExNotFound{

"Exception:UserException:SysAdminException::ExException:SysAdminException::ExInvalid:SysAdminException::ExNotFound" "TNR_errors"1 "The resource type %7$s was not found."779578081{

0}"NisDomain"

}

In this example,root@ajax invoked theget_all method on the nameregistry (object reference333333.1.26) with the effective user ID of“nobody” (60001). Input Data shows that the optionNisDomain waspassed to the method. From the error code (e=12) and the output inResults, you can see an exception was detected indicating that a specificresource of typeNisDomain was not found.

wtrace


Com

mands

Options–D Prints large blocks of input data.

–E Suppresses printing of error records.

–h Prints header used in the “old” format.

–H Suppresses printing of hex dumps.

–I Suppresses printing of input records.

–j Prints the preferred format for normal screens (80columns).

–J Prints the preferred format for wide screens (132columns).

–k db_dir Specifies the Tivoli database directory.

–l Prints the long form output.

–n Prints additional new lines between transactions.

–O Suppresses printing of output records.

–u Prints the command’s usage message.

–v Prints in verbose mode (included for backwardcompatibility).

–V Prints the version number of the command.

format_optionsSpecifies additional options that modify formatting ofthe output. The available formatting options are asfollows:

–e lines Specifies the threshold for line breaks.The default is 5.

–f Turns off printing of abbreviatednumbers (for example, 3.2K instead of3219).

–t tab_size Specifies the tab increment. Thedefault is four characters.

–w width Specifies maximum width of theformatted line. The default is 80.

wtrace

1–536 Version 3.7.1

–W width Specifies minimum width of theformatted line. The default is 70.

DefectsA corrupt trace log can causewtrace to dump core.

See Alsoodadmin

wuname


Com

mands

wunameLists operating system information.

Syntaxwunamehost_name

DescriptionThewunamecommand lists the operating system for the managed nodespecified in thehost_name option. The command lists the operatingsystem, version number, release number, and the hardware name.

Optionshost_name Specifies the host to list the operating system

information for.


ExamplesThe following example shows the operating system of the managednodebald:wuname baldSunOS bald 5.3 Generic_101318-21 sun4m

See Alsowdate, wdiskspace, whostid, wifconfig, winstdir , winterp ,wmannode, wmemsize, wping, wuname, wxterm

wuninst

1–538 Version 3.7.1

wuninstUninstalls Tivoli applications from a specified node or from the entireTivoli management region.

Syntaxwuninst

wuninst tag

wuninst –list

wuninst tag –list

wuninst tag node_name [–rmfiles] [options]

DescriptionThewuninst command is a wrapper script that invokes product-specificuninstall scripts. This section provides general usage information aboutthewuninst command. The usage statement for this command differsfor each product.

To view the general usage statement, enter the following on thecommand line:wuninst

To view the usage statement for an individual application, enter thefollowing on the command line:wuninst tag

Thetagoption is the registered product tag. To view a list of the producttags, enter the following on the command line:wuninst -list

If you include thenode_nameoption, the application specified withtagis removed from the specified node. Ifnode_name is the Tivolimanagement region server, the application is removed from the entireTivoli management region. You are prompted with a confirmationmessage before the application is removed from the Tivoli managementregion.

Use thewuninst command to remove Tivoli Management Frameworkand, therefore, remove the node from a Tivoli management region. Youshould use thewuninst command to remove all application files before

wuninst


Com

mands

running thewunstmn command.

Options–list Lists the installed application tags or the node on which

a product is installed. If used with thetag option,–listlists the nodes on which the specified product isinstalled. Without other options,–list shows the tags ofall installed products.

–rmfiles Indicates that all product files are to be removed fromnode_name. If this option is not included, thewuninstcommand removes only the database entries fornode_name. If –rmfiles is used on the Tivolimanagement region server, all entries for each node inthe region is removed.

node_name Specifies the node to remove the product from. Ifnode_nameis the Tivoli management region server, theproduct is removed from the entire region.

options Indicates options that might be required by eachproduct. To view the options required to uninstall aparticular product, enterwuninst tag on the commandline.

tag Specifies the product to remove.

Authorizationsuper

Examples1. The following example returns the general usage statement of the

wuninst wrapper script:

wuninst

2. The following example returns the usage statement to removeTivoli Software Distribution:

wuninst courier_3.7

wuninst

1–540 Version 3.7.1

3. The following example lists the tags of all products installed in theTivoli management region:

wuninst -list

4. The following example lists the nodes on which Tivoli SoftwareInstallation Service is installed:

wuninst SIS_3.6 -list

5. The following example removes Tivoli Software InstallationService from nodekiwi .

wuninst SIS_3.6 kiwi

6. The following example removes Tivoli Software InstallationService from nodepctmp83. Becausepctmp83 is the Tivolimanagement region server, Tivoli Software Installation Service isremoved from every node in the region. The–rmfiles optionindicates that all product files are removed as well as databaseentries.

wuninst SIS_3.6 pctmp83 -rmfiles

See Alsowunstmn

wunstmn


Com

mands

wunstmnRemoves Tivoli Management Framework files from a managed node.(UNIX, Windows NT, and Windows 2000 only)

Syntaxwunstmn [–A] [–f] [–r] [–y] […] [ name […]]

DescriptionThewunstmn command uninstalls Tivoli Management Frameworkfiles from specified managed nodes. Removing Tivoli ManagementFramework files removes the managed node from your Tivolimanagement region.

wunstmn can uninstall nodes that have a working connection to theTivoli management region server. If the managed node has lost itsconnection, you can specify the use ofrexec to remove the files.

You cannot uninstall the Tivoli management region server or the systemfrom which you invoke this command.

To remove a managed node that also has Tivoli applications installed,use thewuninst command to remove the applications. Then runwunstmn to remove the managed node.

Without the–A option,wunstmn removes only the client database.–Aremoves all files associated with Tivoli Management Framework,including libraries, binaries, manual pages, and so on. Thewunstmncommand is located in the$BINDIR/TAS/UNINST directory.

Note: Do not use the–A option if the managed node you are removingshares files with nodes that you want to keep in your Tivolienvironment.

After wunstmn removes the installed files, it invokeswrmnode toremove all entries to this node from the remaining Tivoli databases.After wunstmn completes, runwchkdb to synchronize the Tivolidatabases.

wunstmn

1–542 Version 3.7.1

Options–A Removes all Tivoli files from the specified managed

node. This includes libraries, binaries, manual pages,message catalogs, and so on. Without this option,wunstmn removes only the client database of thespecified managed node.

–f Specifies that the name option is a file name containinga list of managed nodes to be uninstalled. The fileformat is as follows:

ManagedNode_name user_name

–r Usesrexec as a communication protocol. Use thisoption to uninstall a managed node when theoserv isnot running.

–y Suppresses confirmation. This option allowswunstmnto run unattended on multiple managed nodes.

name Specifies either the name of a single managed node touninstall or the name of a text file containing multiplenodes to uninstall. If used with the–f option,namespecifies the path to a text file. You can specify multiplefile names. Without the–f option,nameis the name ofa single managed node.

Authorizationsuper

Examples1. The following example removes Tivoli Management Framework

and all files from nodeiandu-4:

wunstmn -A iandu-4

wunstmn


Com

mands

2. The following example uses a file namednodelist to uninstall agroup of managed nodes. The–y option suppresses theconfirmation. Because–A is omitted, only the databases areremoved. All Tivoli Management Framework files remain on thenodes.

wunstmn -f -y nodelist

See Alsowchkdb, wrmnode, wuninst

wunsub

1–544 Version 3.7.1

wunsubRemoves Tivoli resources from a profile manager’s subscription list.

Syntaxwunsub [–a] [–l] [–r] name [subscriber…]

DescriptionThewunsub command removes the Tivoli resources specified insubscriberfrom the subscription list of the profile manager specified inname.

If the –l option is specified, any configuration information distributed tothe subscriber databases from this profile is maintained in thesubscriber’s database, but is made local to the subscriber. If–l is notspecified, configuration information in the subscriber that wasdistributed from the profile specified byname is deleted from thesubscriber’s database.

Note: For Tivoli Distributed Monitoring, configuration information isalso deleted from the subscriber’s configuration files.

If the –a option is specified, all current subscribers are removed.

Options–a Removes all current subscribers to the specified profile

manager.

–l Specifies to maintain the subscriber’s database, butmake it local.

–r Specifies that thewunsub command returns an errorcode (1) if any of the subscribers are unreachable. Afailure code is always returned if the specifiedsubscriber does not exist.

name The name of the profile manager from which tounsubscribe the resources. Valid formats for thenameoption are as follows:

■ prof_manager_name

wunsub


Com

mands



subscriber… The names of the Tivoli resources to remove from thespecified profile manager’s subscription list. Thisoption can be specified multiple times. Valid formatsfor thesubscriber option are as follows:

■ @node_name


■ @Endpoint:ep_label



Examples1. The following example unsubscribes all subscribers of profile

managerpm1, maintaining configuration information in thesubscribers’ databases as local:

wunsub -a -l pm1

2. The following example unsubscribes subscriberspm2 andmn1from profile managerpm1. All configuration information isdeleted from the subscribers’ databases.

wunsub pm1 @ProfileManager:pm2 @ManagedNode:mn1

See Alsowcrtprf , wcrtprfmgr , wdistrib , wgetprf, wgetsub, wlssub,wpopulate, wsub, wvalidate

wupdate

1–546 Version 3.7.1

wupdateUpdates resources in the local name registry.

Syntaxwupdate [–f] –r resource [–r resource…] regions…

DescriptionThewupdate command updates resources in the local name registryfrom one or more remote Tivoli management regions. When thewupdatecommand is run, resources are locked in the name registry. Insome cases, the resource may already be locked, such as when anotherwupdateis running. Thewupdatecommand attempts to lock a resourcefor 60 seconds before timing out.

Options–f Forces the update regardless of time stamp.

–r resource… Specifies one or more resource types to be updated.You can specify the resource type or useAll to updateall resource types.

regions… Specifies one or more Tivoli management regions fromwhich to update. You can specify the region name oruseAll to update all regions.


Examples1. The following example updates the local name registry with the

NisDomain resource type from theceridwen-Region:

wupdate -r NisDomain ceridwen-Region

wupdate


Com

mands

2. The following example updates the local name registry with allresource types from theceridwen-Region and themeiron-Region:

wupdate -r All ceridwen-Region meiron-Region

3. The following example updates the local name registry with theProfileManager andAdministratorCollection resource typesfrom all connected regions:

wupdate -r ProfileManager -r AdministratorCollection All

4. The following example forces the update for all resource typesregardless of the time stamps on the resource types:

wupdate -f -r All meiron-Region

See Alsowconnect, wdisconn, wlsconn

wvalidate

1–548 Version 3.7.1

wvalidateValidates a profile against its validation policy.

Syntaxwvalidate name

DescriptionThewvalidate command validates the profile identified bynameagainst its validation policy.

Optionsname The profile whose policy is to be validated. Valid

formats for thename option are as follows:

■ @prof_name

■ @ProfileManager:prof_name



ExamplesThe following example validates the profilepr1 against the validationpolicy:wvalidate @TestProfile:pr1

See Alsowcrtprf , wcrtprfmgr , wdistrib , wgetprf, wgetsub, wlssub,wpopulate, wsub, wunsub

wxterm


Com

mands

wxtermOpens an Xterminal window on a specified display.

Syntaxwxterm –h node_name [xterm_options]

DescriptionThewxterm command opens an Xterminal window on a specifiedmanaged node. You can also supply configuration options as you wouldif you invoked thexterm program directly. If you do not supplyconfiguration options,wxterm uses the default configuration optionslocated ininstall_dir/bin/interp/TAS/xterm.sh.

Options–h node_nameSpecifies the managed node where thexterm program

is run.

xterm_options Specifies options that are passed to thexterm program(such as default font, colors, and so on).


wxterm

1–550 Version 3.7.1


2T

ivoli-defined Policy

2Tivoli-defined Policy

Tivoli Management Framework uses default and validation policy in thetask library and profile manager. These services use default andvalidation methods that call shell scripts to set or validate data. You canedit any of the shell scripts to create custom policies for yourorganization.

Tivoli endpoint gateways and endpoint managers also use policy scripts.The endpoint scripts differ from the default and validation policy in thatpolicy objects are associated with the endpoint scripts.

This chapter contains the following sections:

■ Endpoint Policy

■ Profile Manager Policy

■ Task Library Policy

■ Editing Endpoint Policy

■ Editing Profile Manager and Task Library Policy

■ EndPoint Policy Methods

■ Profile Manager Policy Methods

■ Task Library Policy Methods

Endpoint PolicyTivoli Management Framework is installed with empty endpoint policyscripts. Endpoint policy scripts can be any type of executable file that

2–2 Version 3.7.1

accepts command line options, exits with a return code, and sends outputto standard output. In most cases, a shell script is sufficient, althoughsome situations might require a more flexible programming language,such as Perl or C. The run time of these scripts (excludinglogin_policy)affects the amount and efficiency of logins that the endpoint managercan process at one time.

The following table contains the endpoint policy scripts and adescription of where and when the script is run.

Profile Manager PolicyTivoli Management Framework provides default and validation policyfor the profile manager service.

The profile manager default policy defines which managed nodes canbecome subscribers to a profile manager and defines the profilemanagers into which a profile can be cloned.

The validation policy validates the following:

■ Whether a subscriber can be removed from a profile manager

■ Whether a profile manager can cancel a subscription

■ Whether a subscriber can be added to a profile manager

Policy Name Origin Execution Time

allow_install_policy Executed by theendpoint manager.

Executed when the endpointinstallation begins.

after_install_policy Executed by theendpoint manager.

Executed after the endpoint’s existenceis recorded by the endpoint managerand before the endpoint receives itsinitial login information.

login_policy Executed by thegateway.

Executed each time the endpoint logsin.

select_gateway_policy Executed by theendpoint manager.

Executed each time an endpoint needsto be assigned to a gateway.


Tivoli-defined P

olicy■ Whether a profile manager can subscribe to another profile

manager

Default Policy MethodsThe following table contains the profile manager default policy methodsand their purpose.

Validation Policy MethodsThe following table contains the profile manager validation policymethods and their purpose.

Method Description

pm_def_profile_managers Provides a list of profile managers into which aprofile can be cloned

pm_def_profile_types Provides a list of profile types managed by agiven region

pm_def_subscribers Provides a list of managed nodes that canbecome subscribers to a profile manager

Method Description

pm_val_remove_subscribers Validates the removal of subscribers from aprofile manager

pm_val_remove_subscription Validates the cancellation of a subscription to aprofile manager

pm_val_subscribers Validates the addition of subscribers to a profilemanager

pm_val_subscription Validates the subscription of a profile manager toanother profile manager

2–4 Version 3.7.1

Task Library PolicyWithin the task library, default policy sets the list of managed nodes andprofiles managers that are associated with a task or job when it iscreated.

Validation policy verifies that existing tasks or jobs are associated withthe correct managed nodes and profile managers, and that the effectivegroup and user IDs under which the task or job will run are valid.

Default Policy MethodsThe following table contains the task library default policy methods andtheir purpose.

Validation Policy MethodsThe following table contains the task library validation policy methodsand their purpose.

Method Description

tl_def_dist_mode Provides the default mode for distributing taskbinaries throughout a Tivoli management region

tl_def_man_nodes Provides a default list of managed nodes for atask library

tl_def_prof_mgrs Provides a default list of profile managers for atask library

Method Description

tl_val_man_nodes Validates the list of target managed nodes onwhich a task or job will execute

tl_val_prof_mgrs Validates the list of target profile managersassociated with a task or job


Tivoli-defined P

olicy

Editing Endpoint PolicyTivoli Management Framework is installed with empty endpoint policyscripts. To add content to these scripts or, later, to edit existing scripts,you must use thewgeteppolandwputeppol commands. See Chapter 1,“Commands,” for more information.

Use the following steps to edit an endpoint policy script. This exampleuses thelogin_policy script. The same procedure works for all endpointpolicy scripts by replacinglogin_policywith the name of the policy youwant to edit.

Note: If you do not redirect the policy to a file, the policy is written toyour screen.

1. Enter the following command to extractlogin_policy and write itto a file:

wgeteppol login_policy > login_policy.txt

If you are editing this script for the first time, you see the followingoutput. On subsequent edits, you see the entire script.

#!/bin/sh## The following are the command line options passed# to this script from the gateway.## $1 - The label of the endpoint machine# $2 - The object reference of the endpoint machine# $3 - The interpreter type of the endpoint machine# $4 - The object reference of the gateway that the# endpoint logged into# $5 - The IP address of the endpoint logging in# $6 - Region# $7 - Dispatcher# $8 - Version

tl_val_set_gid Validates the effective group ID assigned to atask or job

tl_val_set_uid Validates the effective user ID assigned to a taskor job

Method Description

2–6 Version 3.7.1

# $9 - The inventory id of the endpoint logging in# $10 - The protocol of the endpoint logging in.# TCPIP -> TCP/IP# IPX -> IPX/SPX

exit 0#

2. Use a text editor to add the contents of the script or to modifyexisting content.

3. Enter the following command to return the updated policy script:

wputeppol login_policy < login_policy.txt

Editing Profile Manager and Task Library PolicyThe following example demonstrates the process for editing task libraryvalidation policy. You can use the same procedures for editing profilemanager validation policy. To edit default policy, replace the–v optionwith the–d option on thewlspolm, wgetpolm, andwputpolmcommands.

As shipped, the task library policy sets the valid managed nodes onwhich a job or task can be run to all managed nodes in the Tivolimanagement region. By modifying the validation policy, you can limitthe managed nodes on which the job or task actually executes.

1. Enter the following command to return the list of availablevalidation policies and their proper names:

wlspol -v TaskLibrary

2. Enter the following command to get the policy shell scriptassociated with thevalidate_execution_managed_nodesmethodand redirect it to a file namedaef. You must use the proper name.

wgetpolm -v TaskLibrary BasicTaskLibrary \tl_val_man_nodes > aef

Theaef file contains a shell script similar to the following:

#!/bin/sh########################################################### $Id: tl_val_man_nodes.sh,v 1.2 1998/09/09 15:41:23 paul$## This script implements the# "validate_execution_managed_nodes" policy method for the# Task Library. The script is provided with the name of the


Tivoli-defined P

olicy# task, the label of the Admin and all of the# managed nodes selected for execution targets of the task.# Modify the code below if you want something different# returned.## To debug your changes, you could add the lines:## set -xv# exec > /tmp/debug.output 2>&1## These lines will allow you to see any errors that occur# by looking in the /tmp/debug.output file.## NOTE: This script can also be called when a check_policy# operation is performed. In that case, the name of# the Admin will be "any". Make sure that you handle# that case if you modify this script.##########################################################

task_name=$1administrator=$2shift 2

## Example of how to validate the list of managed nodes. ##

# for i in $*; do# if [ $i = "the evil managed node" ]; then# echo FALSE# exit 0# fi# done

echo TRUEexit 0#

3. Use a text editor to modify theaef file.

Tivoli Management Framework provides a policy option to limitthe managed node on which the job or task executes. To use thisoption, remove the comment lines from the policy option TivoliManagement Framework provides and replace “the evil managednode” with the name of a managed node.

You can also add your own options.

2–8 Version 3.7.1

4. Enter the following command to replace the policy with the editedpolicy script:

wputpolm -d TaskLibrary BasicTaskLibrary \tl_val_man_nodes < aef

Enter the following command to create your own policy group:

wcrtpol -d TaskLibrary “Secure Tasks”

You can then get or set methods on this new group and assign thegroup to theTaskLibrary resource with theManaged ResourcePolicies dialog.

The methods call shell scripts that you can modify to set a newdefault policy. You can set default policy on a per policy regionbasis.

EndPoint Policy MethodsThis section describes the endpoint policy methods.

allow_install_policy


Tivoli-defined P

olicyallow_install_policy

Validates whether an endpoint should exist in the current Tivolimanagement region.

Syntax

allow_install_policy ep_label ep_oid ep_interp gw_oid ep_ipaddrregion dispatcher version unique_id protocol

Description

Theallow_install_policy script validates whether an endpoint shouldexist in the current Tivoli management region. The default behavior ofthis policy allows endpoints to log in as long as the endpoint’s label isvalid and not in use (the default isexit 0). You can also use this script toperform other processes before the endpoint is logged in. Remember,though, that the endpoint does not exist at the time this script is run. Thescript cannot, therefore, execute commands that reference the endpoint.

If the script fails, the installation process is terminated and noinformation is written to the Tivoli database.

The endpoint manager runsallow_install_policy when it receives anendpoint’s initial login packet from a gateway. The script is not run onsubsequent logins.allow_login_policy is run before theselect_gateway_policyscript. The syntax of the command is as follows:

Options

dispatcher Specifies the object dispatcher number of the endpoint.

ep_interp Specifies the interpreter type of the endpoint.

ep_ipaddr Specifies the Internet Protocol (IP) address and portnumber of the endpoint.

ep_label Specifies the label of the endpoint trying to log in.

ep_oid Specifies the object ID of the endpoint.

gw_oid Specifies the object ID of the intercepting gateway.

protocol Specifies the network protocol used by the endpointlogging in.


2–10 Version 3.7.1

region Specifies the region number in which the endpointresides.

unique_id Specifies the unique ID (also called the inventory ID) ofthe endpoint logging in.

version Specifies the current version of the endpoint software.

Environment Variables

These environment variables are automatically set when this script is runby the endpoint manager:

LCF_DUPL_GATEWAYSpecifies the object ID of the existing endpoint’sgateway.

LCF_DUPL_INTERPSpecifies the interp of the existing endpoint.

LCF_DUPL_INV_IDSpecifies the inventory ID of the existing endpoint.

LCF_DUPL_LOGINSpecifies the timestamp of the existing endpoint’s firstnormal login.

LCF_DUPL_NET_ADDRESSSpecifies the network address of the existing endpoint.

LCF_DUPL_OBJECTSpecifies the object ID of the existing endpoint.

LCF_INVALID_LABELSpecifies whether the endpoint’s label is validaccording towepmgr test_label.

Examples

The following is an example of theallow_install_policy script. Thisexample does not allow endpoints on the subnet146.84.26 to log in tothe Tivoli management region. It also does not allow endpoints that havethe stringdev in their name.



Tivoli-defined P

olicyThis script is intended for UNIX systems. For Windows NT orWindows 2000 systems, the awk utility does not support all thecapabilities of the awk utility on UNIX. In particular:

awk '{FS="." ; print $2}'

works to set a period as a record separator on UNIX, but onWindows NT and Windows 2000 it does not. For Windows NT orWindows 2000, awk requires this syntax:

awk -F'.' '{ print $2 }'

Note: The endpoint label identified in the following example is thelcfd proposed label and is almost always the host name, whichcould be fully qualified (spot.dev.tivoli.com) or not (spot).You can change the label with the–Dlcs.machine_name=nameoption. See thelcfd command for more information.

#!/bin/sh# Please do not remove the below Tivoli comments# --- Start of Tivoli comments ---## The following are the command line options passed to this script# from the Endpoint Manager.## $1 - The label of the endpoint machine# $2 - The object reference of the endpoint machine# $3 - The architecture type of the endpoint machine# $4 - The object reference of the gateway that the endpoint$ logged into# $5 - The ip/ipx address of the endpoint logging in (refer to# parameter $10 to determine the protocol of the endpoint).# $6 - region# $7 - dispatcher# $8 - version# $9 - The inventory id of the endpoint logging in.# $10 - The protocol of the endpoint logging in.# TCPIP -> TCP/IP# IPX -> IPX/SPX## A line with this format may be written to standard output to# change an endpoint’s label:# new_label = <label>## The normal exit code of 0 from the allow_install_policy will allow# the endpoint’s initial login to proceed. (If the label of this# endpoint is in use, or invalid, then this login won’t complete.)## An exit code of 10 also will allow this login to proceed and,# if this endpoint’s label matches the label of an existing# endpoint, or if the endpoint’s label is invalid, then a unique# label will be created for this endpoint.## An exit code of 6 will cause this login to be ignored.## Exiting the allow_install_policy with any other non-zero exit status will# stop this endpoint’s initial (or orphaned) login.


2–12 Version 3.7.1

## The environment variable LCF_LOGIN_STATUS is also set by the epmgr.# A value of 2 indicates the endpoint is isolated. That is, it was unable# to contact its assigned gateway. Isolated endpoints are automatically# migrated to another gateway unless the select_gateway_policy terminates# with a non-zero exit status. Other LCF_LOGIN_STATUS values are:# 0 Initial login (allow_install_policy, select_gateway_policy,# after_install_policy)# 2 Isolated login (select_gateway_policy)# 3 Migratory login (select_gateway_policy)# 7 Orphaned login (allow_install_policy, select_gateway_policy,# after_install_policy)## The allow_install_policy will have these environment variables set if# there is already an existing endpoint with the same label as the endpoint# which is attempting to login:# LCF_DUPL_OBJECT object id of existing endpoint# LCF_DUPL_ADDRESS network address of existing endpoint# LCF_DUPL_LOGIN timestamp of existing endpoint’s first normal login# LCF_DUPL_GATEWAY object id of existing endpoint’s gateway# LCF_DUPL_INV_ID inventory id of existing endpoint# LCF_DUPL_INTERP interp (architecture type) of existing endpoint# The initial login will fail for an endpoint whose label matches the label# of an existing endpoint, unless allow_install_policy is exited with code 10.## The allow_install_policy will have the environment variable# LCF_INVALID_LABEL set to TRUE, if the endpoint’s label, $1, is invalid.# Endpoint labels must not contain any invalid characters and must conform# to the labelspace regular expression. A label may be tested with the# wepmgr test label command. Invalid characters and the labelspace regular# expression may be displayed and set with the wepmgr get and set commands.# An initial login will fail if the endpoint’s label is invalid, unless# allow_login_policy is exited with code 10, in which case a generic# label stem, "eplabel", is used as the beginning of the endpoint label.# The object dispatcher number and arbitrary characters will be added to# make the label unique.## Also note that during the execution of allow_install and select_gateway# policy scripts, the endpoint does not yet formally exist. For this reason,# the endpoint object reference will have a value of OBJECT_NIL and the# object dispatcher number will be 0. The endpoint label will have the value# suggested by the endpoint (or the user value lcfd -n) but is not guaranteed# to become the final endpoint lable. It will become the final endpoint label# if this value is not already taken by another endpoint.# --- End of Tivoli comments ---#set -e

## Don't allow endpoints from subnet 26 log into this TMR.#

SUBNET=`echo $5 | awk '{FS="."}{ print $1"."$2"."$3 }'`if [ "$SUBNET" = "146.84.26" ]; then

exit 1fi

## Don't allow endpoints whose name contain the regular# expression "dev".



Tivoli-defined P

olicy## This line will force the script to exit nonzero if the# expression "dev" is in the label.#echo $1 | grep -v dev

exit 0

after_install_policy

2–14 Version 3.7.1

after_install_policyPerforms any processing that you want immediately after the endpointhas been created.

Syntax

after_install_policy ep_label ep_oid ep_interp gw_oidep_ipaddr region dispatcher version unique_id protocol

Description

Theafter_install_policy script performs any processing that you wantimmediately after the endpoint has been created. This policy is run onlyafter the initial login; it is not run on subsequent logins.

The failure of this script does not stop the login process. The endpointalready exists when this script is run. Only the post-processing specifiedin the script fails.

The endpoint manager runsafter_install_policy immediately followingthe initial gateway assignment but before the endpoint login methodreturns to the intercepting gateway. Because this occurs before theendpoint’s first normal login, you cannot run downcalls from this script.The syntax of the command is as follows:

Options



ep_ipaddr Specifies the IP address and port number of theendpoint.

ep_label Specifies the label of the endpoint for which the scriptwill run.


gw_oid Specifies the object ID of the assigned gateway.

protocol Specifies the network protocol used by the endpoint.




Tivoli-defined P

olicyunique_id Specifies the unique ID (also called the inventory ID) of

the endpoint.


Examples

The following example subscribes new endpoints to a profile managerthat represents endpoints of similar architecture types. If the policyregion or profile manager does not exist, the policy creates it.

#!/bin/sh# Please do not remove the below Tivoli comments# --- Start of Tivoli comments ---## The following are the command line options passed to# this script from the Endpoint Manager.## $1 - The label of the endpoint machine# $2 - The object reference of the endpoint machine# $3 - The interpreter type of the endpoint machine# $4 - The object reference of the assigned gateway that the# endpoint logged into# $5 - The IP address of the endpoint logging in# $6 - Region# $7 - Dispatcher# $8 - Version# $9 - The inventory id of the endpoint logging in# $10 - The protocol of the endpoint logging in.# TCPIP -> TCP/IP# IPX -> IPX/SPX## The environment variable LCF_LOGIN_STATUS is also set by the epmgr.# A value of 2 indicates the endpoint is isolated. That is, it was unable# to contact its assigned gateway. Isolated endpoints are automatically# migrated to another gateway unless the select_gateway_policy terminates# with a non-zero exit status. Other LCF_LOGIN_STATUS values are:# 0 Initial login (allow_install_policy, select_gateway_policy,# after_install_policy)# 2 Isolated login (select_gateway_policy)# 3 Migratory login (select_gateway_policy)# 7 Orphaned login (allow_install_policy, select_gateway_policy,# after_install_policy)# --- End of Tivoli comments ---LCF_POLICY_REGION=LCF-EndpointsPROFILE_MANAGER=LCF-$3EP=$1

## Check to see if our top-level policy region already# exists. If not create it and put it on this administrators# desktop.## Disable "exit on error" for this call since we will handle# the failure.#set +ewlookup -r PolicyRegion $LCF_POLICY_REGION > /dev/null


2–16 Version 3.7.1

ERR=$?set -e

if [ $ERR -ne 0 ]; thenALI=òbjcall 0.0.0 get_security_objid`set òbjcall $ALI get_identityÀDMIN="$1"ADMIN_OID=‘echo $2 |cut -d”#” -f1‘wcrtpr -m ProfileManager -a $ADMIN $LCF_POLICY_REGIONidlcall $ADMIN_OID refresh_collection

fi

## Check to see if our interp specific profile manager# already exists. If not create it and make it dataless so# that we can subscribe the endpoint to it.## Disable "exit on error" for this call since we will handle# the failure.#set +ewlookup -r ProfileManager $PROFILE_MANAGER > /dev/nullERR=$?set -e

if [ $ERR -ne 0 ]; thenwcrtprfmgr $LCF_POLICY_REGION $PROFILE_MANAGER > /dev/nullwsetpm -d /Library/ProfileManager/$PROFILE_MANAGER

fi

## Subscribe the endpoint to the profile manager which# contains the endpoints for that specific interp type.#wsub /Library/ProfileManager/$PROFILE_MANAGER \@Endpoint:$EP

exit 0

login_policy


Tivoli-defined P

olicylogin_policy

Performs any processing that you want each time an endpoint logs in.

Syntax

login_policy ep_label ep_oid ep_interp gw_oid ep_ipaddr regiondispatcher version unique_id protocol

Description

The login_policy script performs any processing that you want eachtime an endpoint logs in. This policy is run by the gateway to which theendpoint is assigned. The same policy script is run on all the gatewaysin a Tivoli management region.

Note: This policy does not support the use of binaries.

One feature of this script is that it can be configured to automaticallyupgrade the endpoint software on each client. To configure thelogin_policy script to upgrade endpoint software, follow these steps:

1. Enable the upgrade script (upgrade.sh) in$BINDIR/../lcf_bundle/upgrade by changing theupgrade_mode entry toauto in theupgrade.cntl file. This stepmust be performed on a per gateway basis.

2. Edit thelogin_policy script to callupgrade.sh. The followingexample script includes this option. The upgrade script does notlog output unless defined to do so.

The endpoint gateway runslogin_policy each time an endpoint logs in.The syntax of the command is as follows:

Options



ep_ipaddr Specifies the IP address and port number of theendpoint.

ep_label Specifies the label of the endpoint for which the scriptwill run.

login_policy

2–18 Version 3.7.1





unique_id Specifies the unique ID (also called the inventory ID) ofthe endpoint.


Examples

The following example logs a notice to an endpoint-related notice groupevery time an endpoint logs in and automatically upgrades the endpointsoftware:

#!/bin/sh

# Please do not remove the below Tivoli comments# --- Start of Tivoli comments ---## The following are the command line options passed to this script# from the Gateway.## $1 - The label of the endpoint machine# $2 - The object reference of the endpoint machine# $3 - The architecture type of the endpoint machine# $4 - The object reference of the gateway that the endpoint logged into# $5 - The ip/ipx address of the endpoint logging in (refer to parameter# $10 to determine the protocol of the endpoint).# $6 - region# $7 - dispatcher# $8 - version# $9 - The inventory id of the endpoint# $10 - The protocol of the endpoint logging in.# TCPIP -> TCP/IP# IPX -> IPX/SPX## --- End of Tivoli comments ---## AUTO UPGRADE# Invoke the upgrade script to check the current version of# the endpoint software and upgrade if necessary.BO=‘objcall 0.0.0 self‘OS=‘objcall $BO getattr oserv‘INSTALLDIR=‘objcall $OS query install_dir|tr '\134' '/'‘$INSTALLDIR/lcf_bundle/upgrade/upgrade.sh $1 $8 $3#LCF_NOTICE_GROUP=LCF_Endpoints## Send a notice to LCF endpoint notice group every time this# endpoint logs in.

login_policy


Tivoli-defined P

olicy#set +ewlookup -r TMF_Notice $LCF_NOTICE_GROUP > /dev/nullERR=$?set -eif [ $ERR -ne 0 ]; then

NTFGM=`wlookup -r Classes TMF_Noticeìdlcall -T top $NTFGM \

TMF_Notice::NoticeManager::create_notice_group \'"'$LCF_NOTICE_GROUP'" 72'

fi

GW=ìdlcall $4 _get_labelÈPOID=`wlookup -o -r Endpoint $1`

wsndnotif $LCF_NOTICE_GROUP Notice << LCF_NOTICEEndpoint $1 ($EPOID of interp type, $3, logged into gateway$GW ($4).LCF_NOTICE

exit 0

select_gateway_policy

2–20 Version 3.7.1

select_gateway_policyDetermines the set of gateways that are allowed to manage the endpoint.

Syntax

select_gateway_policyep_label ep_oid ep_interp gw_oid ep_ipaddrregion dispatcher version unique_id protocol

Description

Theselect_gateway_policy script determines the set of gateways thatare allowed to manage the endpoint.select_gateway_policy is run atinitial login, when an endpoint is isolated, or when an endpoint performsa migratory login.

If the script does not return gateways, the endpoint manager performs itsdefault selection process and generates a list of up to five gateways inthe endpoint’s region. The endpoint manager’s default selection processis overridden byselect_gateway_policy. If this policy is not defined, theintercepting gateway is added to the end of the list of candidategateways.

The intercepting gateway is also added to the end of theselect_gateway_policy list to ensure that the endpoint has at least onedefinite contact. If the endpoint manager cannot contact any of thegateways listed in the script, the endpoint manager assigns theintercepting gateway to the endpoint. If the script fails (returns nonzero),the login attempt fails. Ifselect_gateway_policyruns successfully, theobject ID of the assigned gateway is passed to the endpoint.

The endpoint manager runsselect_gateway_policywhen it receives theendpoint’s initial login packet after theallow_install_policy is run. Thesyntax of the command is as follows:

Options



ep_ipaddr Specifies the IP address of the endpoint.



Tivoli-defined P

olicyep_label Specifies the label of the endpoint for which the script

will run.




region Specifies the policy region in which the endpointresides.

unique_id Specifies the unique ID (also called the inventory ID) ofthe endpoint.

version Specifies the current version of the endpoint.

Examples

The options passed to this script from the endpoint manager are the sameas the previous three endpoint policy scripts. The variableLCF_LOGIN_STATUS is also set by the endpoint manager. A valueof 2 indicates that the endpoint is isolated (unable to contact its assignedgateway). Isolated endpoints are automatically migrated to anothergateway unless theselect_gateway_policy script terminates with anonzero exit status. For more information about endpoint isolation ormigration, see theTivoli Management Framework Planning forDeployment Guide.

Note: During the execution of this script, the endpoint does not yetformally exist. Therefore, the value of the endpoint objectreference isOBJECT_NIL and the object dispatcher number is0. The value of the endpoint label is suggested by the endpoint(or the user throughlcfd –n), but can only become the final labelif the value is not already taken by another endpoint.

If your gateways and endpoints are separated by a network addresstranslation (NAT) device, you must use the fully qualified host name ofthe gateway appended to its object identifier with a pipe (| ) symbol. Forexample, a gatewayparis fully qualified asparis.dev.server.comwithan object identifier of123267682.1.529 should be entered in theselect_gateway_policy script as follows:

123267682.1.529|paris.dev.server.com


2–22 Version 3.7.1

The following is an example script:

#!/bin/sh# Please do not remove the below Tivoli comments# --- Start of Tivoli comments ---## The following are the command line options passed to# this script from the Endpoint Manager.## $1 - The label of the endpoint machine# $2 - The object reference of the endpoint machine# $3 - The interpreter type of the endpoint machine# $4 - The object reference of the assigned gateway that the# endpoint logged into# $5 - The IP address of the endpoint logging in# $6 - Region# $7 - Dispatcher# $8 - Version# $9 - The inventory id of the endpoint logging in# $10 - The protocol of the endpoint logging in.# TCPIP -> TCP/IP# IPX -> IPX/SPX## The environment variable LCF_LOGIN_STATUS is also set by the epmgr.# A value of 2 indicates the endpoint is isolated. That is, it was unable# to contact its assigned gateway. Isolated endpoints are automatically# migrated to another gateway unless the select_gateway_policy terminates# with a non-zero exit status. Other LCF_LOGIN_STATUS values are:# 0 Initial login (allow_install_policy, select_gateway_policy,# after_install_policy)# 2 Isolated login (select_gateway_policy)# 3 Migratory login (select_gateway_policy)# 7 Orphaned login (allow_install_policy, select_gateway_policy,# after_install_policy)# Also note that during the execution of allow_install and select_gateway# policy scripts, the endpoint does not yet formally exist. For this reason,# the endpoint object reference will have a value of OBJECT_NIL and the# object dispatcher number will be 0. The endpoint label will have the value# suggested by the endpoint (or the user value lcfd -n) but is not guaranteed# to become the final endpoint label. It will become the final endpoint label# if this value is not already taken by another endpoint.## NB: That the version in $8 is not defined when the sgp is called during a# migratory completion by login or upcall.# --- End of Tivoli comments ---

# only ep_ip is needed for this exampleep_label=$1ep_oid=$2ep_interp=$3gateway=$4ep_ip=$5region=$6dispatcher=$7version=$8#FOUNDONE=FALSE# we just want the subnet of the endpointSUBNET=‘echo $ep_ip|cut -d'.' -f3‘# get all gateways and find ones that are on the same subnetGATEWAYS=‘wlookup -ar Gateway -o‘



Tivoli-defined P

olicy

for gwoid in $GATEWAYSdogwproxy=‘idlattr -tg $gwoid proxy Object‘mnips=‘wifconfig -h $gwproxy | grep -v Device | awk'(print $2)'‘

# a managed node might have multiple interfaces, so check each# one of them if the gateway subnet matches the endpoint number.# return gwoid if it matchesfor ip in $mnipsdogwsub=‘echo $ip | cut -d'.' -f3‘if [ $gwsub -eq $SUBNET ]thenecho $gwoidFOUNDONE=TRUEfidonedone

#if you did not find a gateway, and you still want the endpoint# to log in, exit 0, else exit 1if [ "$FOUNDONE" = "TRUE" ]then

exit 1else

exit 0fi

Profile Manager Policy MethodsThis section describes the default and validation policy methods forprofile managers.

pm_def_profile_managers

2–24 Version 3.7.1

pm_def_profile_managersProvides a list of profile managers into which a profile can be cloned.

Resource

ProfileManager

Syntax

pm_def_profile_managersmgr_name

Description

Thepm_def_profile_managers method provides a list of profilemanagers into which a profile can be cloned.

The method runs thepm_def_profile_managers script. The scriptwrites the profile manager list to standard output, one profile managerper line. This script can be customized. The output of the script must bein the formatlabel, followed by the tab character, followed by the objectID.

For example, if the label isPM1 and the OID is1214115201.1.616#TMF_CCMS::ProfileManager#, the followingASCII characters must be written to standard output:

PM1\t1214115201.1.616#TMF_CCMS::ProfileManager#\n

The output is displayed in theClone to Profile Managersscrolling listin the Clone Profile dialog.

The default implementation ofpm_def_profile_managersreturns a listof all instances in all Tivoli management regions of theProfileManagerresource type.

Options

mgr_name Specifies the name of the profile manager containingthe profile to clone.

pm_def_profile_managers


Tivoli-defined P

olicyReturn Values

This method exits with one of the following:

0 Indicates the successful completion of the method.

1 Indicates that the method exited with an error. Themethod’s standard output is undefined.

pm_def_profile_types

2–26 Version 3.7.1

pm_def_profile_typesProvides a list of profile types managed by a given region.

Resource

ProfileManager

Syntax

pm_def_profile_typesregion

Description

Thepm_def_profile_types method provides a list of profile typesmanaged by a given region.

The method runs thepm_def_profile_typesscript. The script writes theprofile types list to standard output, one profile type per line. The outputis displayed in the Create Profile dialog.

The default implementation ofpm_def_profile_types returns a list ofall profile types managed by the given region.

Options

region Specifies the name of the policy region in which aprofile is to be created.

Return Values


0 Indicates the successful completion of the method; themethod writes profile types to standard output.


pm_def_subscribers


Tivoli-defined P

olicypm_def_subscribers

Provides a list of managed nodes that can become subscribers to aprofile manager.

Resource

ProfileManager

Syntax

pm_def_subscribersmgr_name

Description

Thepm_def_subscribers method provides a list of managed nodes,profile managers, and endpoints that can become subscribers to a profilemanager.

The method runs thepm_def_subscribers script. The script writes thesubscriber list to standard output, one subscriber per line. This script canbe customized. The output of the script must be in the formatlabel,followed by the tab character, followed by the object ID.

For example, if the label isreality and the OID is1214115201.3.7#TMF_ManagedNode::ManagedNode#, thefollowing ASCII characters must be written to standard output:

reality\t1214115201.3.7#TMF_ManagedNode::Managed_Node#\n

The output is displayed in theAvailable to become Subscribersscrolling list in the Subscriber dialog.

The default implementation ofpm_def_subscribersreturns a list of allinstances in all Tivoli management regions of theProfileManager andManagedNode resource types.

Options

mgr_name Specifies the name of the profile manager that is to besubscribed to.

pm_def_subscribers

2–28 Version 3.7.1

Return Values




See Also

pm_val_remove_subscribers, pm_val_remove_subscription,pm_val_subscribers, pm_val_subscription

pm_val_remove_subscribers


Tivoli-defined P

olicypm_val_remove_subscribers

Validates the removal of subscribers from a profile manager.

Resource

ProfileManager

Syntax

pm_val_remove_subscribers { localize | delete} mgr_namesubscriber…

Description

Thepm_val_remove_subscribers method validates the removal ofsubscribers from a profile manager.

The method runs thepm_val_remove_subscribers script. The scriptwritesTRUE to standard output if the removal meets the validationcriteria,FALSE if it does not.

Tivoli Management Framework provides the default value ofTRUE.

Options

delete Indicates that this action will be taken when removingthe subscribers.

localize Indicates that this action will be taken when removingthe subscribers.

mgr_name Specifies the name of the profile manager.

subscriber… Specifies the list of subscribers being removed.Separate each subscriber with a space.

Return Values


0 Indicates the successful completion of the method; themethod writes eitherTRUE or FALSE to standardoutput.

pm_val_remove_subscribers

2–30 Version 3.7.1


See Also

pm_val_remove_subscription, pm_val_remove_subscribers,pm_val_subscription

pm_val_remove_subscription


Tivoli-defined P

olicypm_val_remove_subscription

Validates the cancellation of a subscription to a profile manager.

Resource

ProfileManager

Syntax

pm_val_remove_subscriptionsubscriber { localize | delete}mgr_name

Description

Thepm_val_remove_subscription method validates the cancellationof a subscription to a profile manager by a profile manager or endpoint.The method runs thepm_val_remove_subscription script. The scriptwritesTRUE to standard output if the removal meets the validationcriteria,FALSE if it does not. Tivoli Management Framework providesthe default value ofTRUE.

Options

delete Indicates that this action will be taken when removingthe subscribers.

localize Indicates that this action will be taken when removingthe subscribers.

mgr_name Specifies the profile manager to which the subscribersubscribes.

subscriber Specifies the name of the profile manager or endpointthat is the subscriber.

Return Values



pm_val_remove_subscription

2–32 Version 3.7.1


See Also

pm_val_remove_subscribers, pm_val_remove_subscription,pm_val_subscription

pm_val_subscribers


Tivoli-defined P

olicypm_val_subscribers

Validates the addition of subscribers to a profile manager.

Resource

ProfileManager

Syntax

pm_val_subscribersmgr_name subscriber…

Description

Thepm_val_subscribers method validates the addition of subscribersto a profile manager. The method runs thepm_val_subscribersscript.The script writesTRUE to standard output if the new subscribers meetthe validation criteria,FALSE if they do not. Tivoli ManagementFramework provides the default value ofTRUE.

Options

mgr_name Specifies the name of the profile manager.

subscriber… Specifies the list of new subscribers to validate.Separate each subscriber with a space.

Return Values




See Also


pm_val_subscription

2–34 Version 3.7.1

pm_val_subscriptionValidates the addition of a subscription of a profile manager to anotherprofile manager.

Resource

ProfileManager

Syntax

pm_val_subscriptionsubscribee mgr_name

Description

Thepm_val_subscription method validates the addition of asubscription to a profile manager by a profile manager or endpoint. Themethod runs thepm_val_subscriptionscript. The script writesTRUEto standard output if the subscription meets the validation criteria,FALSE if it does not. Tivoli Management Framework provides thedefault value ofTRUE.

Options

mgr_name Specifies the profile manager or endpoint that is thesubscriber.

subscribee Specifies the profile manager that is the subscribee.

Return Values




See Also


pm_val_subscription


Tivoli-defined P

olicyTask Library Policy Methods

This section describes the default and validation policy methods for tasklibraries.

tl_def_dist_mode

2–36 Version 3.7.1

tl_def_dist_modeProvides the default mode for distributing task binaries throughout aTivoli management region.

Resource

TaskLibrary

Syntax

tl_def_dist_mode

Description

Thetl_def_dist_mode method provides the default mode used todistribute task executable files when a task is created. The following arevalid distribution modes:

ALI Copies task binaries to the Tivoli management regionserver only.

LOCAL Copies task binaries to all managed nodes in the localTivoli management region.

GLOBAL Copies task binaries to all managed nodes in allconnected Tivoli management regions.

Return Values



1 Indicates that the method was invoked with invalidoptions.

2 Indicates an error.

tl_def_man_nodes


Tivoli-defined P

olicytl_def_man_nodes

Provides a default list of managed nodes for a task library.

Resource

TaskLibrary

Syntax

tl_def_man_nodestask_name admin_name

Description

Thetl_def_man_nodes method provides a default list of managednodes and endpoints for a task library. Thetl_def_man_nodesmethodruns thetl_def_man_nodes.shscript. This script must provide a list ofManagedNode andEndpoint resources where the task can run.

The method writes the list of managed nodes and endpoints to standardoutput, one node per line.

Options

admin_name Specifies the name of the administrator that invoked themethod.

task_name Specifies the task for which the list is being generated.

Return Values





See Also

tl_def_prof_mgrs

tl_def_prof_mgrs

2–38 Version 3.7.1

tl_def_prof_mgrsProvides a default list of profile managers for a task library.

Resource

TaskLibrary

Syntax

tl_def_prof_mgrs task_name admin_name

Description

Thetl_def_prof_mgrs method provides a default list of profilemanagers for a task library. This script must provide a list ofProfileManager resources where the task can run.

The method writes the list of profile managers to standard output, oneper line.

Options


task_name Specifies the task for which the list is being generated.

Return Values





See Also

tl_val_man_nodes

tl_val_man_nodes


Tivoli-defined P

olicytl_val_man_nodes

Validates the list of target managed nodes associated with a task or job.

Resource

TaskLibrary

Syntax

tl_val_man_nodestask_name admin_name node_name…

Description

Thetl_val_man_nodesmethod validates the list of managed nodes andendpoints associated with a task or job.

The script writesTRUE to standard output if the list meets thevalidation criteria,FALSE if it does not.


Options


node_name Specifies the list of managed nodes and endpoints tovalidate. Separate each name with a space.

task_name Specifies the name of the task or job.

Return Values




See Also

tl_def_prof_mgrs, tl_val_set_gid, tl_val_set_uid

tl_val_prof_mgrs

2–40 Version 3.7.1

tl_val_prof_mgrsValidates the list of target profile managers associated with a task or job.

Resource

TaskLibrary

Syntax

tl_val_prof_mgrs task_name admin_name mgr_name…

Description

Thetl_val_prof_mgrs method validates the list of target profilemanagers associated with a task or job.

The script writesTRUE to standard output if the list meets thevalidation criteria,FALSE if it does not. The default value isTRUE.

Options


mgr_name… Specifies the list of profile managers to validate.Separate each profile manager’s name with a space.

task_name Specifies the name of the task or job.

Return Values




See Also

tl_def_man_nodes, tl_val_set_gid, tl_val_set_uid

tl_val_set_gid


Tivoli-defined P

olicytl_val_set_gid

Validates the group ID assigned to a task or job.

Resource

TaskLibrary

Syntax

tl_val_set_gidadmin_name group_id

Description

Thetl_val_set_gidmethod validates the group ID associated with a taskor job.

The script writesTRUE to standard output if the group ID meets thevalidation criteria,FALSE if it does not.


Options


group_id Specifies the group ID to validate.

Return Values




See Also

tl_def_man_nodes, tl_val_set_gid, tl_val_set_uid

tl_val_set_uid

2–42 Version 3.7.1

tl_val_set_uidValidates the user ID assigned to a task or job.

Resource

TaskLibrary

Syntax

tl_val_set_uidadmin_name user_id

Description

Thetl_val_set_uidmethod validates the user ID associated with a taskor job.

The script writesTRUE to standard output if the user ID meets thevalidation criteria,FALSE if it does not.


Options


user_id Specifies the user ID to validate.

Return Values




See Also

tl_def_man_nodes, tl_val_prof_mgrs, tl_val_set_gid

Tivoli Management Framework Reference Manual Index–1

Index

Symbols.aof files 1-337, 1-340, 1-343.cdf files 1-337, 1-340, 1-343.gdf files 1-337, 1-340, 1-343

Aadding

block of statements into a file 1-321entries to a path statement in a registry

hive 1-134lines to a file 1-323

administrator commandstable of 1-7wauthadmin 1-138wcrtadmin 1-196wgetadmin 1-281widmap 1-316wsetadmin 1-481wsetlang 1-489

administrator tag 1-341, 1-344after_install_policy method 2-14allow_install_policy method 2-9AMP. See application management packageAMS. See Application Management

Specificationapplication

dependency instance 1-343dependency library 1-343distributing 1-337, 1-340installing 1-337, 1-340maintaining 1-337, 1-340, 1-343task library 1-343uninstall 1-538

application description file 1-337,1-340, 1-343

application management 1-337, 1-340,1-343

application management package (AMP)1-337, 1-340, 1-343

Application Management Specification(AMS) 1-337, 1-340, 1-343

Ccanceling a distribution 1-445command table

administrator 1-7configuration management 1-8endpoint 1-9gateway 1-9httpd 1-11installation 1-11interregion 1-12kerberos 1-13low-level mantenance 1-14managed node 1-15miscellaneous 1-22multiplexed distribution 1-16notification 1-17policy 1-17query 1-18RDBMS Interface Module 1-19Revision Control System 1-19scheduler 1-20task library 1-20

commandswcrtpol 2-8wgeteppol 2-5

Index–2 Version 3.7.1

wlspol 2-6wputeppol 2-6wputpolm 2-8

commands, using Tivoli 1-1configuration management commands

table of 1-8wcrtprf 1-208wcrtprfmgr 1-210wdistrib 1-243wgetprf 1-298wgetsub 1-306wlssub 1-376wpopulate 1-405wsetpm 1-492wsub 1-514wuninst 1-538wunsub 1-544wvalidate 1-548

Ddependency instance 1-343dependency library 1-343disk space verifying 1-248distribution, canceling 1-445

Ee-mail

configuring Windows 1-379SMTP 1-379specifying server 1-379

endpoint and gateway commandslcfd 1-66lcfd.sh 1-76table of 1-9w4inslcf.pl 1-129waddpath 1-134wadminep 1-136

wclrblk 1-175wclrline 1-177wcpyfile 1-195wcrtgate 1-199wdelep 1-226wdelgate 1-227wdskspc 1-248weditini 1-250wep 1-260wepmgr 1-271wgateway 1-277wgetkey 1-290wgetval 1-310winsblk 1-321winsline 1-323winstlcf 1-330wlsendpts 1-363wmrgini 1-399wrestart 1-427wrplblk 1-440wrplline 1-442wseterr 1-485wsetval 1-506

endpoint policyabout 2-1after_install_policy 2-14allow_install_policy 2-9editing 2-5enabling automatic software upgrade

2-17login_policy 2-17select_gateway_policy 2-20table of 2-2where and when it runs 2-2

environmentsourcing 1-1

environment variable 1-341, 1-344establishing the Tivoli environment 1-1


Ffiles

setup_env 1-1setup_env.csh 1-1

Ggateway commands.See endpoint and

gateway commands

Hhost

e-mail 1-379SMTP server 1-379

httpd commandstable of 1-11waddrealm 1-135wdelrealm 1-231wlsrealms 1-375wstarthttpd 1-511wstophttpd 1-513

Iidlarg command 1-25idlattr command 1-27idlcall command 1-29idlexception command 1-32idlinput command 1-34idlresult command 1-35INI files

merging groups and variables fromseveral files 1-399

modifying 1-250installation commands

oinstall 1-112table of 1-11

wclient 1-169wcpcdrom 1-192winstlcf 1-330wmailhost 1-379wpatch 1-402wserver 1-473wsettap 1-501

interpreter type xiiiinterregion commands

table of 1-12wconnect 1-187wdisconn 1-240wlookup 1-356wlsconn 1-360wregister 1-425wtmrname 1-530wupdate 1-546

Kkadmin command 1-37kadmind command 1-40kdb_destroy command 1-42kdb_edit command 1-44kdb_init command 1-46kdb_util command 1-48kdestroy command 1-50kerberos command 1-52Kerberos commands

kadmin 1-37kadmind 1-40kdb_destroy 1-42kdb_edit 1-44kdb_init 1-46kdb_util 1-48kdestroy 1-50kerberos 1-52kinit 1-56klist 1-58kpasswd 1-60


ksrvtgt 1-62kstash 1-64table of 1-13

kinit command 1-56klist command 1-58kpasswd command 1-60ksrvtgt command 1-62kstash command 1-64

Llcfd command 1-66lcfd.sh command 1-76libraries

dependency 1-343task 1-343

login_policy method 2-17logls command 1-77Lotus Notes, as Tivoli mail server 1-379low-level maintenance commands

idlarg 1-25idlattr 1-27idlcall 1-29idlexception 1-32idlinput 1-34idlresult 1-35logls 1-77objcall 1-79odadmin 1-83odbls 1-103odstat 1-105oserv 1-115table of 1-14tmcmd 1-124tmstat 1-126wlocalhost 1-351wlocktmr 1-352wmailhost 1-379

Mmail server

for Tivoli tools 1-379specifying for Windows 1-379

maintenance commands, low-leveltable of 1-14

maintenance, of an application 1-337,1-340, 1-343

managed node commandstable of 1-15wclient 1-169wdate 1-223wdiskspace 1-242whostid 1-312wifconfig 1-319winstdir 1-328winterp 1-345wmannode 1-380wmemsize 1-394wtimezone 1-523wuname 1-537wunstmn 1-541wxterm 1-549

management data 1-337, 1-340, 1-343Management Tool Extension Group

(MTEG) 1-340MDist, canceling a distribution 1-445merging groups and variables from INI files

1-399methods, endpoint policy

after_install_policy 2-14allow_install_policy 2-9login_policy 2-17select_gateway_policy 2-20

methods, profile manager default policypm_def_profile_managers 2-24pm_def_profile_types 2-26pm_def_subscribers 2-27

methods, profile manager validation policypm_val_remove_subscribers 2-29pm_val_remove_subscription 2-31


pm_val_subscribers 2-33pm_val_subscription 2-34

methods, task library default policytl_def_dist_mode 2-36tl_def_man_nodes 2-37tl_def_prof_mgrs 2-38

methods, task library validation policytl_val_man_nodes 2-39tl_val_prof_mgrs 2-40tl_val_set_gid 2-41tl_val_set_uid 2-42

Microsoft Exchange, as Tivoli mail server1-379

miscellaneous commandstable of 1-22tivoli 1-122waddicon 1-132wbindmsg 1-145wbkupdb 1-140wcatcher 1-148wcd 1-150wchkdb 1-152wchknode 1-155wdel 1-224wdepot 1-235wgetallinst 1-283wiconv 1-313winstendpt 1-329winstruct 1-337winstruct_plus 1-340winstruct_task 1-343wlcftap 1-346wln 1-349wlocpath 1-354wls 1-358wlsinst 1-365wmdist 1-381wmdistgui 1-393wmerge 1-395wmrgaef 1-397wmv 1-400wping 1-404

wpwd 1-412wrefresh 1-424wrm 1-436wrmnode 1-438wrpt 1-444wrunas 1-454wsetpkey 1-491wsupport 1-516wtemp 1-524wtrace 1-532

modifying groups, variables, and values in an.INI file 1-250

module 1-340MTEG. See Management Tool Extension

Groupmultiplexed distribution commands, table of

1-16

Nnotification commands

table of 1-17wbroadcast 1-147wexpnotif 1-276wlsnotif 1-368wsndnotif 1-508wtailnotif 1-519

Oobjcall command 1-79odadmin command 1-83odbls command 1-103odstat command 1-105oinstall command 1-112oserv command 1-115


Pplatform commands 1-7pm_def_profile_managers method 2-24pm_def_profile_types method 2-26pm_def_subscribers method 2-27pm_val_remove_subscribers method 2-29pm_val_remove_subscription method 2-31pm_val_subscribers method 2-33pm_val_subscription method 2-34policy commands

table of 1-17wchkpol 1-158wcrtpol 1-204wdelpol 1-229wdelpr 1-230wgetdfpol 1-284wgeteppol 1-286wgetpolm 1-292wgetpr 1-297wlspol 1-371wlspolm 1-373wputeppol 1-407wputpolm 1-408wsetdfpol 1-483wsetpr 1-494

policy methods,See endpoint policy, tasklibrary policy, profile managerpolicy

profile manager policyabout 2-2default policy methods

pm_def_profile_managers 2-24pm_def_profile_types 2-26pm_def_subscribers 2-27table of 2-3

editing 2-6validation policy methods

pm_val_remove_subscribers 2-29pm_val_remove_subscription

2-31

pm_val_subscribers 2-33pm_val_subscription 2-34table of 2-3

Qquery commands

table of 1-18wcrtqlib 1-212wcrtquery 1-213wgetquery 1-300wruninvquery 1-455wrunquery 1-461wsetquery 1-496

RRCS.See Revision Control SystemRDBMS Interface Module commands

table of 1-19wcrtrim 1-216wgetrim 1-302wrimtest 1-428wrimtrace 1-430wsetrim 1-498wsetrimpw 1-500

rebooting a system 1-427registry hives

adding an entry 1-134retrieving key values 1-290setting key values 1-506

removingblock statements from a file 1-175lines from a file 1-177

replacingblock of statements in a file 1-440lines in a file 1-442

restarting a system 1-427retrieving registry hive key values 1-290


Revision Control System commandstable of 1-19wci 1-160wco 1-179wident 1-315wrcs 1-413wrcsdiff 1-419wrcsmerge 1-421wrlog 1-432

RIM. See RDBMS Interface Module

Sscheduler commands

table of 1-20wdelsched 1-232wedsched 1-252wenblsched 1-258wgetsched 1-303wschedjob 1-468wstartsched 1-512

select_gateway_policy method 2-20setting

registry hive key values 1-506return codes from a batch file for a

BARC program 1-485setting up your environment 1-1setup_env.csh file 1-1, 1-2setup_env.sh file 1-1, 1-2SMTP

connecting to Windows 1-379gateway software 1-379mail server 1-379

sourcing the Tivoli environment 1-1staging directory 1-341, 1-344

Ttask library commands

table of 1-20wcrtjob 1-201wcrttask 1-219wcrttlib 1-222wdeljob 1-228wdeltask 1-234wdisttask 1-246wgetjob 1-288wgettask 1-308wlstlib 1-378wrunjob 1-458wruntask 1-463wsetjob 1-486wsettask 1-504wtaskabort 1-521wtll 1-526

task library policyabout 2-5default policy methods

table of 2-4tl_def_dist_mode 2-36tl_def_man_nodes 2-37tl_def_prof_mgrs 2-38

editing 2-6validation policy methods

table of 2-4tl_val_man_nodes 2-39tl_val_prof_mgrs 2-40tl_val_set_gid 2-41tl_val_set_uid 2-42

Tivoli Application Management module1-340

tivoli command 1-122tl_def_dist_mode method 2-36tl_def_man_nodes method 2-37tl_def_prof_mgrs method 2-38tl_val_man_nodes method 2-39tl_val_prof_mgrs method 2-40


tl_val_set_gid method 2-41tl_val_set_uid method 2-42tmcmd command 1-124tmstat command 1-126transactions

hierarchies 1-6revocable subtransactions 1-6subtransactions 1-6

Vverifying available disk space 1-248

Ww4inslcf.pl command 1-129waddicon command 1-132waddpath command 1-134waddrealm command 1-135wadminep command 1-136wauthadmin command 1-138wbindmsg command 1-145wbkupdb command 1-140wbroadcast command 1-147wcatcher command 1-148wcd command 1-150wchkdb command 1-152wchknode command 1-155wchkpol command 1-158wci command 1-160wclient command 1-169wclrblk command 1-175wclrline command 1-177wco command 1-179wconnect command 1-187wcpcdrom command 1-192wcpyfile command 1-195

wcrtadmin command 1-196wcrtgate command 1-199wcrtjob command 1-201wcrtpol command 1-204, 2-8wcrtpr command 1-206wcrtprf command 1-208wcrtprfmgr command 1-210wcrtqlib command 1-212wcrtquery command 1-213wcrtrim command 1-216wcrttask command 1-219wcrttlib command 1-222wdate command 1-223wdel command 1-224wdelep command 1-226wdelgate command 1-227wdeljob command 1-228wdelpol command 1-229wdelpr command 1-230wdelrealm command 1-231wdelsched command 1-232wdeltask command 1-234wdepot command 1-235wdisconn command 1-240wdiskspace command 1-242wdistrib command 1-243wdisttask command 1-246wdskspc command 1-248weditini command 1-250wedschd command 1-252wenblsched command 1-258wep command 1-260wepmgr command 1-271wexpnotif command 1-276wgateway command 1-277wgetadmin command 1-281wgetallinst command 1-283wgetdfpol command 1-284


wgeteppol command 1-286, 2-5wgetjob command 1-288wgetkey command 1-290wgetpolm command 1-292

commandswgetpolm 2-6

wgetpr command 1-297wgetprf command 1-298wgetquery command 1-300wgetrim command 1-302wgetsched command 1-303wgetsub command 1-306wgettask command 1-308wgetval command 1-310whostid command 1-312wiconv command 1-313wident command 1-315widmap command 1-316wifconfig command 1-319Windows mail

connecting to SMTP server 1-379SMTP gateway 1-379

winsblk command 1-321winsline command 1-323winstall command 1-325winstdir command 1-328winstendpt command 1-329winstlcf command 1-330winstruct command 1-337winstruct_plus command 1-340winstruct_task command 1-343winterp command 1-345wlcftap command 1-346wln command 1-349wlocalhost command 1-351wlocktmr command 1-352wlocpath command 1-354wlookup command 1-356wls command 1-358

wlsconn command 1-360wlsendpts command 1-363wlsinst command 1-365wlsnotif command 1-368wlspol command 1-371, 2-6wlspolm command 1-373wlsrealms command 1-375wlssub command 1-376wlstlib command 1-378wmailhost command 1-379wmannode command 1-380wmdist command 1-381wmdistgui command 1-393wmemsize command 1-394wmerge command 1-395wmrgaef command 1-397wmrgini command 1-399wmv command 1-400wpatch command 1-402wping command 1-404wpopulate command 1-405wputeppol command 1-407, 2-6wputpolm command 1-408, 2-8wpwd command 1-412wrcs command 1-413wrcsdiff command 1-419wrcsmerge command 1-421wrefresh command 1-424wregister command 1-425wrestart command 1-427wrimtest command 1-428wrimtrace command 1-430wrlog command 1-432wrm command 1-436wrmnode command 1-438wrplblk command 1-440wrplline command 1-442wrpt command 1-444


wrunas command 1-454wruninvquery command 1-455wrunjob 1-458wrunquery command 1-461wruntask command 1-463wschedjob command 1-468wserver command 1-473wsetadmin command 1-481wsetdfpol command 1-483wseterr command 1-485wsetjob command 1-486wsetlang command 1-489wsetpkey command 1-491wsetpm command 1-492wsetpr command 1-494wsetquery command 1-496wsetrim command 1-498wsetrimpw command 1-500wsettap command 1-501wsettask command 1-504wsetval command 1-506wsndnotif command 1-508wstarthttpd command 1-511wstartsched command 1-512wstophttpd command 1-513wsub command 1-514wsupport command 1-516wtailnotif command 1-519wtaskabort command 1-521wtemp command 1-524wtimezone command 1-523wtll command 1-526wtmrname command 1-530wtrace command 1-532wuname command 1-537wuninst command 1-538wunstmn command 1-541wunsub command 1-544

wupdate command 1-546wvalidate command 1-548wxterm command 1-549