ibm tivoli enterprise console: reference...

IBM Tivoli Enterprise Console

Reference ManualVersion 3.8

GC32-0666-02

NoteBefore using this information and the product it supports, read the information in “Notices” on page 181.

First Edition (September 2002)

This edition applies to version 3, release 8, of IBM Tivoli Enterprise Console (product number 5698-TEC) and to allsubsequent releases and modifications until otherwise indicated in new editions.

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

Contents

Preface . . . . . . . . . . . . . . . vWho Should Read This Manual . . . . . . . . vPublications . . . . . . . . . . . . . . v

IBM Tivoli Enterprise Console Library . . . . . vPrerequisite Publications . . . . . . . . . vRelated Publications . . . . . . . . . . vi

Accessing Publications Online . . . . . . . . viProviding Feedback about Publications . . . . . viAccessibility . . . . . . . . . . . . . . viContacting Customer Support . . . . . . . . viConventions Used in This Guide . . . . . . . vii

Typeface Conventions . . . . . . . . . . viiOperating System-dependent Variables and Paths vii

Chapter 1. Commands . . . . . . . . 1Establishing the Tivoli Environment . . . . . . 1Using Tivoli Commands . . . . . . . . . . 2Command Line Syntax . . . . . . . . . . . 2

String Limits . . . . . . . . . . . . . 2Object References . . . . . . . . . . . . . 3

Registered Names . . . . . . . . . . . 3Object Paths . . . . . . . . . . . . . 3

Tivoli Enterprise Console Commands . . . . . . 4Console Commands . . . . . . . . . . . 4Source Commands . . . . . . . . . . . 4Event Message Commands . . . . . . . . 4Event Server Commands . . . . . . . . . 5Rule Base Commands . . . . . . . . . . 6Database Commands . . . . . . . . . . 6Adapter Configuration Facility Commands . . . 6

chkclass . . . . . . . . . . . . . . . . 8postemsg . . . . . . . . . . . . . . . 9tec_console . . . . . . . . . . . . . . 11upgrade_gui.sh . . . . . . . . . . . . . 13waddac. . . . . . . . . . . . . . . . 14wchkclass . . . . . . . . . . . . . . . 18wconsole . . . . . . . . . . . . . . . 20wcrtsrc . . . . . . . . . . . . . . . . 35wcrtnvgroups . . . . . . . . . . . . . 37wdbconfig.sh . . . . . . . . . . . . . . 39wdbinstall.sh . . . . . . . . . . . . . . 40wdbmaint.sh . . . . . . . . . . . . . . 42wdelac . . . . . . . . . . . . . . . . 44wdelsrc . . . . . . . . . . . . . . . . 45wlsac . . . . . . . . . . . . . . . . 46wlsaddflt . . . . . . . . . . . . . . . 49wlsadenv . . . . . . . . . . . . . . . 52wlsadgui . . . . . . . . . . . . . . . 53wlsadval . . . . . . . . . . . . . . . 54wlsaeenv . . . . . . . . . . . . . . . 56wlsemsg . . . . . . . . . . . . . . . 58wlsesvrcfg . . . . . . . . . . . . . . . 60wlssrc . . . . . . . . . . . . . . . . 62wmigcon . . . . . . . . . . . . . . . 63wpostemsg . . . . . . . . . . . . . . 66

wrb . . . . . . . . . . . . . . . . . 69wrbupgrade . . . . . . . . . . . . . . 82wsendresp. . . . . . . . . . . . . . . 83wsetac . . . . . . . . . . . . . . . . 84wsetaddflt . . . . . . . . . . . . . . . 89wsetadenv. . . . . . . . . . . . . . . 97wsetadgui . . . . . . . . . . . . . . . 98wsetadval . . . . . . . . . . . . . . 100wsetaeenv . . . . . . . . . . . . . . 103wsetemsg. . . . . . . . . . . . . . . 106wsetesvrcfg . . . . . . . . . . . . . . 108wsetsrc . . . . . . . . . . . . . . . 110wstartesvr . . . . . . . . . . . . . . 111wstatesvr . . . . . . . . . . . . . . . 112wstopesvr . . . . . . . . . . . . . . 113wstoptecgw . . . . . . . . . . . . . . 114wtdbclear. . . . . . . . . . . . . . . 115wtdbclear.pl . . . . . . . . . . . . . . 118wtdbspace . . . . . . . . . . . . . . 120wtdbstat . . . . . . . . . . . . . . . 122wtdumper . . . . . . . . . . . . . . 123wtdumprl . . . . . . . . . . . . . . 125wtdumptr . . . . . . . . . . . . . . 127wtecexport . . . . . . . . . . . . . . 129wtecimport . . . . . . . . . . . . . . 132wtouchac . . . . . . . . . . . . . . . 135

Chapter 2. Tasks . . . . . . . . . . 137Task Names and Scripts . . . . . . . . . . 138Task Output . . . . . . . . . . . . . . 139Command Line Syntax . . . . . . . . . . 140Change_Severity . . . . . . . . . . . . 141Clean_Database . . . . . . . . . . . . 142Clear_Closed_Events . . . . . . . . . . . 144Clear_Reception_Log . . . . . . . . . . . 145Close_Event . . . . . . . . . . . . . . 146Dump_Event_Repository . . . . . . . . . 147Event_Query . . . . . . . . . . . . . 149Find_Similar_Events . . . . . . . . . . . 154Forward_Event . . . . . . . . . . . . . 156Log_Event_To_File . . . . . . . . . . . 157Popup_Message . . . . . . . . . . . . 158Send_Email . . . . . . . . . . . . . . 159Send_Event . . . . . . . . . . . . . . 160Wake_Up_Netscape . . . . . . . . . . . 163

Chapter 3. Environment VariablesAvailable to Tasks . . . . . . . . . 165Variable Descriptions . . . . . . . . . . . 165Examples . . . . . . . . . . . . . . . 169

Environment Variable Dump When Executing aTask from the Event Console . . . . . . . 169Environment Variable Dump When Executing aProgram from the Event Console . . . . . . 171

© Copyright IBM Corp. 2002 iii

Chapter 4. Event Flow. . . . . . . . 173Master Process . . . . . . . . . . . . . 174Reception Engine Process . . . . . . . . . 174Rule Engine Process . . . . . . . . . . . 176Dispatch Engine Process. . . . . . . . . . 176

User Interface Server . . . . . . . . . . 176Task Engine Process . . . . . . . . . . . 177

Appendix. Configuration Parameters 179

Notices . . . . . . . . . . . . . . 181Trademarks . . . . . . . . . . . . . . 183

Glossary . . . . . . . . . . . . . 185

Index . . . . . . . . . . . . . . . 191

iv IBM Tivoli Enterprise Console: Reference Manual

Preface

The Tivoli Enterprise Console Reference Manual provides detailed information aboutTivoli

®

Enterprise Console commands, tasks provided in the task library shippedwith the Tivoli Enterprise Console product, and environment variables available totasks in the task library.

Who Should Read This ManualThis manual is for administrators who want to use the command line interface andconfigure Tivoli Enterprise Console tasks. You should have prior knowledge of thefollowing:v UNIX

®

operating systemv Tivoli Management Framework

PublicationsThis section lists publications in the IBM Tivoli Enterprise Console library and anyother related documents. It also describes how to access Tivoli publications online,how to order Tivoli publications, and how to make comments on Tivolipublications.

IBM Tivoli Enterprise Console LibraryThe following documents are available in the Tivoli Enterprise Console library:v IBM Tivoli Enterprise Console Adapters Guide, GC32-0668

Provides information about the currently available adapters.v IBM Tivoli Event Integration Facility User’s Guide, GC32-0691

Discusses how to develop your own event adapters that are tailored to yournetwork environment and your specific needs. Additionally, the guide describeshow to filter events at the source.

v IBM Tivoli Enterprise Console Installation Guide, GC32-0823Discusses how to install, upgrade, and remove IBM Tivoli Enterprise Consolecomponents.

v IBM Tivoli Enterprise Console Rule Builder’s Guide, GC32-0669Discusses how to develop rules and integrate them for event correlation andautomated event management.

v IBM Tivoli Enterprise Console User’s Guide, GC32-0667Discusses how to plan for and configure your event database environment anddescribes components, roles, and other general information specific to for usingthe IBM Tivoli Enterprise Console product.

Prerequisite PublicationsYou should be familiar with the following manuals before attempting to use theTivoli Enterprise Console product.

The following documents provide detailed information about the desktop,managed nodes, administrators, policy regions, profiles, notices, tasks, scheduling,and CLI commands:

© Copyright IBM Corp. 2002 v

v IBM Tivoli Management Framework Planning for Deployment Guide

v IBM Tivoli Management Framework User’s Guide

v Tivoli Management Framework Maintenance and Troubleshooting Guide

v IBM Tivoli Management Framework Reference Manual

Related PublicationsThe Tivoli Glossary includes definitions for many of the technical terms related toTivoli software. The Tivoli Glossary is available, in English only, at the followingWeb site: http://www.tivoli.com/support/documents/glossary/termsm03.htm

Accessing Publications OnlinePublications in the product libraries are included in PDF or HTML formats, orboth, on the product CD. To access the publications using a Web browser, open theinfocenter.html file, which is located in the appropriate publications directory onthe product CD.

When IBM publishes an updated version of one or more online or hardcopypublications, they are posted to the Tivoli Information Center. You can accessupdated publications in the Tivoli Information Center from the following TivoliCustomer Support Web site: http://www.tivoli.com/documents/

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

Note: If you print PDF documents on other than letter-sized paper, select the Fit topage check box in the Adobe Acrobat Print dialog (which is available whenyou click File --> Print) to ensure that the full dimensions of a letter-sizedpage are printed on the paper that you are using.

Providing Feedback about PublicationsWe are very interested in hearing about your experience with Tivoli products anddocumentation, and we welcome your suggestions for improvements. If you havecomments or suggestions about our products and documentation, contact us in oneof the following ways:v Send an e-mail to [email protected] Complete our customer feedback survey at the following Web site:

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

AccessibilityAccessibility features help a user who has a physical disability, such as restrictedmobility or limited vision, to use software products successfully. For additionalinformation, see the Accessibility Appendix in the IBM Tivoli Enterprise ConsoleUser’s Guide.

Contacting Customer SupportIf you have a problem with any Tivoli product, you can contact Tivoli CustomerSupport. See the Tivoli Customer Support Handbook at the following Web site:

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

vi IBM Tivoli Enterprise Console: Reference Manual

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

you are locatedv What information you should gather before contacting support

Conventions Used in This Guide

Typeface ConventionsThe following typeface conventions are used in this book:

Bold Commands, keywords, file names, authorization roles, URLs, or otherinformation that you must use literally appear in bold. Names ofwindows, dialogs, and other controls also appear in bold.

Italics Variables and values that you must provide appear in italics. Words andphrases that are emphasized also appear in italics, as do new terms definedin the text.

MonospaceCode examples, output, and system messages appear in a monospace font.

Operating System-dependent Variables and PathsThis book uses the UNIX convention for specifying environment variables and fordirectory notation.

When using the Windows command line, replace $variable with %variable% forenvironment variables and replace each forward slash (/) with a backslash (\) indirectory paths.

This book also uses the backslash character (\) convention at the end of a line ofexample text to indicate that the text shown on the following line has wrappeddue to space restrictions of the page. The example should be interpreted as beingon one line.

Note: If you are using the bash shell on a Windows system, you can use the UNIXconventions.

Preface vii

viii IBM Tivoli Enterprise Console: Reference Manual

Chapter 1. Commands

Establishing the Tivoli EnvironmentWhen the Tivoli Management Framework was installed, two setup files werecreated that allow you to easily establish the correct search paths and environmentvariables. These files are available on any client or the server in the TivoliManagement Region (TMR).

Use the following steps to set up the UNIX system environment to execute TivoliEnterprise commands:1. Log in to a Tivoli Enterprise client or the Tivoli Enterprise server on which

your Tivoli Enterprise administrator has an alias with the super role for theTMR. See the Tivoli Management Framework User’s Guide for details aboutcreating Tivoli Enterprise administrators with authorization roles for the TMR.

2. There are two environment initialization and setup scripts available: one for theBourne shell and one for the C shell. If you are using the Bourne shell, executethe following command:. /etc/Tivoli/setup_env.sh

—OR—

If you are using the C shell, execute the following command:source /etc/Tivoli/setup_env.csh

Issue the following commands from a Windows command prompt to setup theWindows system environment for Tivoli commands:1. %SystemRoot%\system32\drivers\etc\Tivoli\setup_env

2. sh

Note: The second command is optional. Some Windows commands are scripts andmust be executed with sh; many commands can be executed from thecommand line.

You now have an environment ready to perform Tivoli operations.

Tivoli commands enable you to perform system operations from a command lineinstead of using the Tivoli desktop. This is often useful when you do not haveaccess to a graphical display, such as when logging in over a modem line, or if youare running maintenance scripts.

Most Tivoli end-user commands begin with a w to identify them as Tivolicommands. Tivoli end-user commands that do not use Tivoli services do not beginwith a w. Most commands are also developed with a w+verb+object syntax, whichmatches the way you would think of the action.

For example, if you want to create a user, use the wcrtusr command. To delete auser, use the wdelusr command.

© Copyright IBM Corp. 2002 1

Using Tivoli CommandsIt is often convenient or more appropriate to invoke a Tivoli managementapplication operation from the command line than from the GUI. For example:v You may not have access to a GUI, perhaps because you dialed in over a phone

line.v A number of operations are going to be grouped together inside a shell script.v You use the Emacs editor and do not want to leave the keyboard to use a mouse

and would rather invoke a command from a shell.v An operation is not available using the Tivoli desktop.

Command Line SyntaxThis document uses the following special characters to define the command syntax:

[ ] Identifies an optional argument. Arguments not enclosed in brackets arerequired.

... Indicates that you can specify multiple values for the previous argument.

| Indicates mutually exclusive information. You can use the argument to theleft of the separator or the argument to the right of the separator. Youcannot use both arguments in a single use of the command.

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

For example:

wsetsrc [–S server] [–b bitmap] [–l label] [–n name] source

The source argument is the only required argument for the wsetsrc command. Thebrackets around the other arguments indicate that these arguments are optional.

Another example is the wlsac command:

wlsac [ –l | –f format] [key... ] profile

In this example, the –l and –f format arguments are mutually exclusive andoptional. The profile argument is required. The key argument is optional. Also, theellipsis marks (...) following the key argument indicate that you can specifymultiple key names.

Another example is the wrb –import command:

wrb –import {rule_pack | rule_set} ...

In this example, the rule_pack and rule_set arguments are mutually exclusive, butone of the arguments must be specified. Also, the ellipsis marks (...) indicate thatyou can specify multiple rule packs or rule sets.

String LimitsThe maximum number of characters in an argument is 256.

2 IBM Tivoli Enterprise Console: Reference Manual

Object ReferencesWhen an object is referenced from a command, the reference is not an absolute“object reference” like those used in programming. Instead, a user-friendly name isused. This user-friendly name derives from a name given to the object by the userof the application (for example, when a policy region is created).

Two different forms of names can be used with command line interface (CLI)commands, as follows:v Registered namesv Object paths

Tivoli CLI programs support both naming schemes. Sometimes you will find itmore convenient to use one form over the other.

Registered NamesEach TMR contains a name registry. The name registry is a two-dimensional tablethat contains the names and types of objects.

Registered names are names of objects that can be looked up in the name registryby instance name and resource type. Every object or resource has a name and type.For example, a printer may have the name apple and the type printer.

All objects in the TMR that need to be looked up should be registered in the nameregistry when created, unregistered when deleted, and moved when their label ischanged. For most resources in the Tivoli Enterprise Console product, these actionsare handled automatically. See the IBM Tivoli Management Framework Planning forDeployment Guide for a complete listing of resource types and exchangeinformation.

Using the name registry facilitates the exchange of resources between multipleTMRs. See the for a complete discussion of TMRs and inter-region connections.

Use the wlookup command to look up a resource. For example, to view all theregistered resource types, use the following command:% wlookup –R

See the for a detailed description and syntax of the wlookup command.

Other commands that use registered names are wls and wmv. For example, to listthe objects on administrator Jerry’s desktop, enter the following:wls @Administrator:jerry

where Administrator is the resource and jerry is the instance.

Object PathsObject paths are similar to path names in file systems and may be relative orabsolute. An absolute path is one that starts with a slash (/) character. A relativepath can start with any character other than a slash (/), including the special pathcomponents for current directory (.) and parent directory (..). Some examples ofobject path names used as arguments for the wls and wmv commands are:wls /Regions/Servers

wmv ../Servers/ayers-rock /Regions/Servers

Chapter 1. Commands 3

The syntax for specifying a resource using the object path name style is as follows:

/distinguished/parent/[type:]name

where:

distinguishedis a resource type

parent is the start of the object path name

type is an optional explicit label

name is the particular instance on which you wish to perform some operation.

Use the optional type specifier when you need to name a particular resource thathas the same name as some other resource of a different type. For example,suppose policy region Engineering has a profile manager named Servers and apolicy subregion named Servers. To specify the profile manager using an objectpath name, you could use the following:wls /Regions/Engineering/ProfileManager:Servers

Tivoli Enterprise Console CommandsThe following sections briefly describe the Tivoli Enterprise Console commands bycomponent.

Console Commands

Command Purpose

tec_console Starts an event console.

wconsole Manages event consoles.

wcrtnvgroups Creates the event groups required to use the netview.rls rule set.

wmigcon Migrates Tivoli Enterprise Console, Version 3.6, consoles, event groups, andoperators to Version 3.7 and Version 3.8.

wsendresp Displays a directed response to an administrator.

wtecexport Exports event console definitions to a file.

wtecimport Imports event console definitions from a file into a different TMR.

Source Commands

Command Purpose

wdelsrc Deletes a source from the event server list.

wlssrc Lists existing sources at the event server.

wsetsrc Resets event source attributes.

Event Message Commands

Command Purpose

postemsg Posts an event to the event server. This command does not require TivoliManagement Framework services.


Command Purpose

wlsemsg Lists received events for a console. This command requires Tivoli ManagementFramework services.

wpostemsg Posts an event to the event server. This command requires Tivoli ManagementFramework services.

wsetemsg Modifies an event. This command requires Tivoli Management Frameworkservices.

Event Server Commands

Command Purpose

wlsesvrcfg Lists the configuration parameters of a running event server.

wsetesvrcfg Sets the configuration parameters for the event server.

wstartesvr Starts the event server.

wstatesvr Displays the status of the event server.

wstopesvr Stops the event server.


Rule Base Commands

Command Purpose

chkclass Checks an event class definition file for validity against a rule base directory.This command is for developing classes in a non-TME environment.

upgrade_gui.sh Upgrades rules that were generated by the version 3.6.2 and earlier rule builderto the syntax supported by the rule compiler provided in this version of theTivoli Enterprise Console product.

wchkclass Checks an event class definition file for validity against a rule base directory.This command is for developing classes in a Tivoli Enterprise Consoleenvironment.

wrb Manages rule bases.

wrbupgrade Upgrades rule bases and event BAROC files created with Tivoli EnterpriseConsole versions prior to 3.7 to the format for version 3.7 and later.

Database Commands

Command Purpose

wdbinstall.sh Runs the event database installation assistant.

wdbconfig.sh Runs the database configuration scrips.

wdbmaint.sh Updates database data distribution statistics and reorganizes the database.

wtdbclear Clears events from the event database.

wtdbspace Provides statistics for the database.

wtdbstat Displays the status of the database server.

wtdumper Generates an event report.

wtdumprl Generates a report of received events.

wtdumptr Generates a report of completed tasks.

Adapter Configuration Facility Commands

Command Purpose

waddac Adds an adapter configuration record for an adapter configuration profile.

wdelac Removes an adapter configuration record from an adapter configuration profile.

wlsac Shows adapter configuration records from an adapter configuration profile.

wlsaddflt Shows adapter configuration records from an adapter configuration profile.

wlsadenv Shows an installed list of adapter-specific EIF environment variables.

wlsadgui Shows an installed link to adapter-specific extended configuration tools.

wlsadval Shows installed validation information for an adapter type.

wlsaeenv Shows the environment variables available at an adapter configuration profileendpoint.

wsetac Modifies an existing adapter configuration record in an adapter configurationprofile.

wsetaddflt Adds or sets an adapter configuration record for an adapter type default.

wsetadenv Installs a list of recognized EIF environment variables for an adapter type.

wsetadgui Installs a link from the Adapter Configuration Facility GUI to a type-specificconfiguration tool.


Command Purpose

wsetadval Installs validation information for an adapter type.

wsetaeenv Modifies environment variables stored on adapter configuration profileendpoints.

wstoptecgw Stops the Tivoli Enterprise Console gateway.

wtouchac Updates the modification time on an adapter configuration profile record to forceredistribution.


chkclass

Checks an event class definition file for validity against a rule base directory.

Syntaxchkclass [–k rule_base_dir] class_file

DescriptionThe chkclass command ensures that an event class definition file is valid for therule base directory specified by the rule_base_dir argument. The rule_base_dirargument used with the –k option is optional only if you have not set theenvironment variable $TEC_KB_DIR (it is not set automatically). This command isprovided for developing classes on a system that does not have the TivoliManagement Environment installed.

Note: If the Tivoli Management Environment is installed on your system, use thewchkclass command.

Authorizationnone

Optionsclass_file

Specifies the path of the event class definition file to be checked. The pathargument must specify an absolute path name.

–k rule_base_dirSpecifies the rule base directory. The default is the directory defined byenvironment variable $TEC_KB_DIR.

ExamplesThe following example checks the /install/bin/hpux/TME/TEC /classfile1 eventclass definition file against the rule base directory specified by environmentvariable $TEC_KB_DIR:chkclass /install/bin/hpux/TME/TEC/classfile1

See Alsowchkclass


postemsg

Posts an event to the event server.

Syntaxpostemsg –S server | –f configuration file [–m message] [–r severity] [attribute=value...]class source

DescriptionThe postemsg command sends an event to an event server. This command doesnot require the use of Tivoli Framework services. Posting events is a good way totest the server after you have created new event groups, created event groupassignments, edited rules, or otherwise changed the method a server processesevents.

If your message contains an embedded single quote (’), you must preface theembedded quote with another single quote.

For attribute values containing characters not in the following list of ASCIIcharacters, single quotation marks are automatically added to the beginning andend of the string:v a-zv A-Zv The characters $ - . / % & * + @ \ ^ _ ` | ~

If the Tivoli Management Environment is installed on your system, you can use thewpostemsg command.

Authorizationnone

Optionsattribute=value

Assigns a value to any valid attribute. The attribute must be one definedfor the event class.

class Specifies the class of the event. It must match a class that is configured atthe server. Classes are defined by the event adapter and are listed in theadapter’s .baroc file. If there are any blank spaces in the class name,enclose the class name in double quotes.

source Specifies the source of the event. If there are any blank spaces in the sourcename, enclose the source name in double quotes.

–f configuration fileSpecifies the name of the adapter configuration file. You must specifyeither the –S argument or the –f argument. The adapter configuration filemust specify a ServerLocation and, if necessary, a ServerPort. If the eventserver is installed on a Windows machine, the ServerPort must bespecified.

–m messageSpecifies the text of the event. If there are any blank spaces in the messagetext, enclose the text in double quotes.


–r severitySpecifies a severity, one of FATAL, CRITICAL, MINOR, WARNING,HARMLESS, and UNKNOWN.

–S serverSpecifies the host name or the Internet Protocol (IP) address of the server.You must specify either the –S argument or the –f argument.

Note: This option is for UNIX machines only. If the event server isinstalled on a Windows machine, use the –f option.

ExamplesThe following example for UNIX environments sends a test message that displaysan Su_Failure event on the event consoles:postemsg -S tecbox –r WARNING –m "su login failure." Su_Failure LOGFILE

See Alsowsetemsg, wpostemsg

In the IBM Tivoli Event Integration Facility User’s Guide, see wpostzmsg andpostzmsg.


tec_console

Starts the Tivoli Enterprise Console event console.

Syntaxtec_console [–u userid] [–p password] [–h hostname[:port]] [–e event_group][–nowindow] [&]

DescriptionThe tec_console command launches the Tivoli Enterprise Console event console.This command is found in $BINDIR/bin on a managed node with the eventconsole installed. On an endpoint or non-TME host, the command is found in thedirectory where the event console was installed.

You can execute this command in the background to get the session commandprompt to return. When executing this command on a managed node, the Tivolienvironment must be initialized.

When issuing the tec_console command from a bash shell on Windows, includethe .cmd file name extension; for example:tec_console.cmd &

The user interface (UI) server process interfaces with the event console to getevents from the event repository and to bundle database update requests and passthem to the Tivoli Enterprise Console dispatch process.

A .tmeconsole directory that saves the global values for the user’s console iscreated in the user’s home directory.

You must have the remote client login allowed Tivoli Management Frameworkoption set to TRUE for this command to work. You can view the current settingwith the odadmin odinfo command. To set this option, use the followingcommand:odadmin set_allow_rconnect TRUE

The change takes effect immediately.

Authorizationuser, RIM_view, RIM_update for operators.

senior for administrators.

Note: Administrators require all of the authorization roles for operators and thesenior role.

Options& Execute the command in the background so the command prompt is

available for use.

–e event_groupShows the specified event group in the Event Viewer when the consolestarts.


–h hostname[:port]The hostname of where the UI server is running. Specify this option ashostname:port if a port other than port 94 is being used.

–nowindowSuppresses the DOS window (Windows only).

–p passwordThe password for your Tivoli administrator login ID.

–u useridYour Tivoli administrator login ID.

Examples1. The following example starts an event console on a UNIX host in the

background. The user is prompted for host name, login ID, and password.tec_console &

2. The following example starts an event console on a Windows host in thebackground and shows the NT event group in the Event Viewer. The user isprompted for host name, login ID, and password.tec_console.cmd -e NT &


upgrade_gui.sh

Upgrades rules that were generated by the version 3.6.2 and earlier rule builder tothe syntax supported by the rule compiler provided in this version of the TivoliEnterprise Console product.

Syntaxupgrade_gui.sh rule_base_dir

DescriptionIf you have rules that were generated by the version 3.6.2 and earlier TivoliEnterprise Console rule builder, they were stored in the$BINDIR/TME/TEC/rulebase/TEC_RULES/.rule_builder.pro file. You can use the$BINDIR/TME/RULE_BUILDER/upgrade_gui.sh script to convert these rules tothe syntax supported by the rule compiler provided in this version of the TivoliEnterprise Console product. The converted rules take advantage of featuresimplemented by the newer version of the compiler and are easier to read. If youconvert rules with this script, you can no longer edit the converted rules with therule builder—you must use a text editor.

Note: Make a backup of the .rule_builder.pro file before executing this script.

The script upgrades the rules of each rule set in the .rule_builder.pro file andwrites them to rule_set_name.rls files in the TEC_RULES subdirectory of the rulebase. The .rule_builder.pro file is left empty.

Authorizationnone

Optionsrule_base_dir

The directory that contains the rule base which contains the rule builderrules to upgrade.

ExamplesThe following example upgrades the rule builder rules for the rule base located inthe /rulebases/test/test001 directory:upgrade_gui.sh /rulebases/test/test001

See Alsonone


waddac

Adds an adapter configuration record for an adapter configuration profile (ACP).

Syntaxwaddac adapter_details type profile

DescriptionThe waddac command adds a record for configuring a Tivoli Enterprise Consoleevent adapter to an existing ACP. When distributed to subscribing managed nodes,the new record will make effective the adapter configuration reflected by thesupplied adapter_details arguments, combined with any installed type-specificdefaults.

Each adapter type on each ACP may be supported by default policies to supplyinitial values for parts of the configuration not given by a waddac invocation.Similarly, validation policies may be present to ensure that a given configuration isvalid according to the needs of the event adapter implementation, installationparticulars, and security concerns.

The waddac command writes the key value for the new adapter configurationrecord to standard out. The key value later can be used to modify or remove therecord. You can see the key value in the upper right side of the ACP entry panel orby using the wlsac command.

Authorizationadmin

Optionsadapter_details

Gives the specific adapter configuration information such as distributionpaths, user IDs, and adapter filtering that are used for the adapter’sdistribution parameters.

–b flag=valueSets the given endpoint behavior flag to the given value. Endpointbehavior flags are interpreted during special situations whenprofiles are distributed, for example when processing a recordmarked as having been deleted. The specific flags supported willvary by endpoint, but those currently supported include thefollowing:

action_failControls the handling of failures of !command and!!command distribution requests. Values understood are:

abort = abort distribution

ignore = ignore all failures

report = report failures but continue with distributionactivity, the default behavior

expandControls whether references to endpoint context variablesof the form ${variable} within attributes of the record


should be expanded by the endpoint code when the profileis distributed. The value of the variable may be no todisable expansion, yes to enable it for all attributes (thedefault behavior), or a comma-separated list of attributenames to selectively expand only within the values ofthose attributes.

rm_on_delInstructs the endpoint code whether to removeconfiguration files and distributed files when the record isdistributed after being removed. The value may be yes (toforce removal, the default behavior), no (to disable removaland thus leave files in place after record deletion), or conf(to remove only the .conf file).

run_actionsControls whether !command and !!command distributionrequests are performed. The value may be yes or no, withyes the default.

Behavior flags or flag values that are not understood are allowed(unless validation policy rejects them) and ignored by the endpointcode.

–c commentComment text to be associated with the new ACP record. Thecomment text will be written into the configuration file when it iscreated the next time the profile is distributed.

–D destination=sourceRequests that the source file be distributed to the destination file oneach subscribing host when the profile is distributed. If thedestination name does not begin with a slash character, then theactual file name is formed by appending destination to the targetdirectory as given by a –d option (or from policy defaults).

Instead of the destination=source form for a distribution request, thestring may be of the form !command or !!command. The givencommand, which may be any valid statement for theplatform-dependent command line interpreter present onsubscriber nodes (generally, /bin/sh, however on non-UNIXplatforms it may be different), is run before (single !) or after (!!)the configuration information and all distributed files are written.

Many –D options can be supplied.

–d dir The directory on subscribing nodes to which the adapterconfiguration files should be distributed.

–e name=valueDefines an environment variable to be placed in the adapterconfiguration file. As many –e arguments as desired may be givento arrange for an arbitrary number of environment variables to becreated. Some environment variables are understood directly by theevent adapter libraries and control basic adapter operation. Othervariables may be used at a higher level by specific adapters.

–f filterDefines an event filter to be placed in the adapter configurationfile. The filter string must be of the following form:


Attribute=Value;Attribute=Value;Attribute=Value;...

The entire string needs to be quoted to prevent the command-lineinterpreter from reacting to the semicolons. To create a filter that isinitially in a disabled state, the string may be prefixed with #ilter:.Thus,waddac -f ’#ilter:Class=LogFile_Base;’ acp1

adds a single disabled filter record to the new profile acp1.(Enabled filters may optionally be prefixed with Filter:.)

Many –f options can be supplied.

–F filter cacheDefines an event filter cache to be placed in the adapterconfiguration file. The filter cache string must be of the followingform:Attribute=Value;Attribute=Value;Attribute=Value;...

The entire string needs to be quoted to prevent the command-lineinterpreter from reacting to the semicolons. To create a filter cachethat is initially in a disabled state, the string may be prefixed with#ilterCache:. Thus,waddac -F ’#ilterCache:Class=LogFile_Base;’ acp1

adds a single disabled filter cache record to the new profile acp1.(Enabled filter caches may optionally be prefixed withFilterCache:.)

Many –F options can be supplied.

–g gid Group ID value to be used for distributed files and commands onsubscriber endpoints. The gid may be given as a name or numericvalue.

–m prefiltermodeDefines the PreFilterMode to be placed in the adapterconfiguration file for Windows and NetWare adapters. The validvalues are IN, in, OUT, and out. The default is OUT. If you useIN or in, you must also supply the –p parameter to specify aPreFilter. The following example shows a command using thisargument:waddac -a -m ’OUT’ -p ’Log=System’ 1 ACPprofile

–p prefilterDefines the PreFilters to be placed in the adapter configuration filefor Windows and NetWare adapters. You must specify at least thelog specification and, optionally, the EventId, EventType, andSource specifications. The following example shows a commandusing this argument:waddac -a -p ’Log=Security’ 1 ACPprofile


–t targetThe name of the primary adapter configuration file, commonlyknown as the .conf file. The complete file name for this file isformed by appending target to the value given for dir with the –doption. (Note that default policy will generally be established to settarget and targdir to appropriate values.)

–u uid User ID value to be used for distributed files and commands onsubscriber endpoints. The uid may be given as a name or numericID value.

profile The ACP to which the new adapter configuration record is to beadded.

type Gives the adapter type for the new adapter. The adapter type isgenerally used to drive the workings of default and validationpolicies. If unknown adapter types are given to waddac, validationpolicies on the target ACP may reject the new record. To see theavailable types, use the wlsaddflt command.

ExamplesThe following example adds an ACP entry with the comment “My Logfile” in the.conf file, a user ID of 0, and a group ID of 0 for an adapter of typetecad_logfile_solaris2 in the profile named ACP Profile:waddac -c "My_Logfile" -u 0 -g 0 tecad_logfile_solaris2 "ACP Profile"

See Alsowdelac, wlsac


wchkclass

Checks an event class definition file for validity against a rule base directory.

Syntaxwchkclass [–S server] [–a class_file | –b class_file] [[host:]path] ... rule_base_directory

DescriptionThe wchkclass command ensures that an event class definition file is valid for therule base directory specified by the rule_base argument. This command is providedfor developing classes on a system that has the Tivoli Management Frameworkinstalled. If the Tivoli Management Framework is not installed, you must use thechkclass command.

Authorizationuser

Optionshost:path

Specifies the host that contains the class file to check and the path of theclass file to check. If you do not specify this argument, the current rulebase is checked for validity. Separate multiple file paths with a space.

rule_baseSpecifies the name of the rule base to check the class definition file against.

–a class_fileStarts checking as though the specified class file were inserted after thespecified class file in the rule base.

–b class_fileStarts checking as though the specified class file were inserted before thespecified class file in the rule base.


–S serverSpecifies the name of the event server in name registry format. The defaultis the local event server. To specify a remote server, enter@EventServer#tmr, where tmr is the name of a Tivoli Management Region(TMR).

ExamplesThe following example checks the /install/bin/hpux/TME/TEC /classfile1 eventclass definition file against rule base rb1:wchkclass /install/bin/hpux/TME/TEC/classfile1 rb1

See Alsochkclass


wconsole

Manages event consoles.

Syntaxwconsole [option [suboption]]

DescriptionThe wconsole command enables you to do such tasks as create, copy, delete, andlist event consoles, and configure, assign, and otherwise manage event groups andevent group filters.

The wconsole command’s first option specifies its primary function. Subsequentsuboptions are only valid within the context of the first option.

Authorizationuser (TMR role for the command only, no options)

Tivoli Enterprise Console administrators and operators require TMR roles forwconsole options as shown in the following table. Also shown in the table are theTivoli Enterprise Console views available to the two types of users. See the i foradditional information about the roles required for Tivoli Enterprise Console users.

Console User TMR Roles Console Views

Administrator RIM_view, RIM_update,senior

Configuration, Summary and PriorityViews, and Event Viewer

Operator RIM_view, RIM_update,user

Summary and Priority Views andEvent Viewer


TMR roles for specific options of the wconsole command are shown in thefollowing table, along with brief descriptions of the options.

Option Description TMR Roles

–addegflt Adds a new filter to an eventgroup.

RIM_view, RIM_update,senior

–assigneg Assigns an event group to anevent console definition.


–assignop Assigns operators to anevent console definition.


–copyconsole Copies an event console’sevent groups, event groupfilters, and authorization roleassignments to anotherconsole definition.


–crtconsole Creates a new event consoledefinition.


–crteg Creates a new event group. RIM_view, RIM_update,senior

-crtoperator Creates a new consoleoperator.


–delconsole Deletes an event consoledefinition.


–deleg Deletes one or more eventgroups.


–delegflt Deletes one or more filtersfrom an event group.


-deloperator Deletes an existing consoleoperator.


–lsassigneg Lists event groups assignedto an event consoledefinition.

RIM_view, RIM_update,user

–lsconsole Lists event consoledefinitions.


-lsconsoleup Lists currently runningconsoles.


–lseg Lists event groups. RIM_view, RIM_update,user

-lsoperator List event consoledefinitions.

RIM_view, RIM_update, user

–setconsole Changes the name anddescription of an eventconsole definition.


–seteg Changes the name anddescription of an eventgroup.


–setegflt Changes the name anddescription of an eventgroup filter.



Option Description TMR Roles

–unassigneg Unassigns one or more eventgroups from an eventconsole definition.


–unassignop Unassigns operators from anevent console definition.


Notesv When issuing the wconsole command from a bash shell on Windows, include

the .cmd file name extension, for example:wconsole.cmd -delconsole -h mfoster -u Administrator \-p chief10 -n “Personnel Systems”

v Before executing the wconsole command on a managed node, ensure that theTivoli environment is initialized.

v Shut down running event consoles whose properties are targeted for changes.When the changes are complete, restart the consoles for the changes to takeeffect.


OptionsEach option of the wconsole command contains optional –h, –u, and –psuboptions, for specifying the host name, user ID, and password, respectively, forlogging into the host where the user interface (UI) server is running. If you do notspecify these suboptions, a dialog box is displayed to enter the information whenthe wconsole command is executed. Your environment must be properlyconfigured to allow such a display. If it is not possible to configure it to allow adialog box to pop up, use the suboptions. The –h, –u, and –p suboptions areshown in the syntax statements in this section, but their definitions are shown onlyin the following table.

Common Suboption Definition

–h host[:port] The name of the host where the UI server is running.Specify the port number if the port used by the host is notport 94.

–u user The Tivoli administrator login ID.

–p password The password associated with the Tivoli administrator loginID.

Notes:

1. Arguments that contain spaces must be enclosed by double quotation marks.For example, names and descriptions can contain spaces.

2. Strings must be enclosed by single quotation marks.3. Numeric values must not be enclosed by any type of quotation marks.4. Enumerated values must be specified by their enumeration names, not their

numeric values. Enumerated values must be enclosed by single quotationmarks.

–addegflt [–h host[:port]] [–u user] [–p password] –E event_group –n name[–D description] [–s constraints] [–S free_form_SQL]

Adds a new filter to an event group.

An event group filter is actually an SQL WHERE clause, which is used toquery the event database to extract those events that meet the filter’scriteria. These events are usually shown in the Event Viewer of anoperator’s console (their visibility can be suppressed by an operator at anEvent Viewer or a rule can suppress their visibility in an Event Viewer).

Event group filters enable you to configure the selection criteria for eventsto include in an event group. An event group can have zero or more filters.An event is included in an event group if it satisfies at least one filter’scriteria. If there are no filters configured for an event group, all events areincluded in the event group.

Each filter in an event group can consist of zero or more constraints on theevent attributes of received events, and free-form SQL. A constraint isconstructed using event attributes, SQL operators, and event attributevalues. Constraints for a filter can be linked together with the ANDoperator. Free-form SQL can be any valid statements for a WHERE clause.

Notes:

1. No syntax checking is done by the wconsole command on free-formSQL statements you specify; that is, you are responsible for thecorrectness of free-form SQL statements for an event filter.

2. The LIKE operator supports the following wildcards on almost alldatabases:


Wildcard Meaning

% Any string of zero or more characters

_ Any single character

[ ] Any single character within the specifiedrange. For example, [a-f] or [abcedf]

[^] Any single character not within the specifiedrange. For example, [^a - f] or [^abcdef]

3. WHERE clause syntax must meet the requirements of the RDBMS usedfor the event database.

–D descriptionThe text description of the new filter.

–E event_groupThe name of the event group to contain the new filter.

–n nameThe name of the new filter.

–s constraintOne or more constraints for the new filter. Do not enter the leadingWHERE keyword—it is handled automatically. Link multipleconstraints together with the AND operator. Each individualconstraint /must be enclosed by parentheses. The entire constraintsargument must be enclosed within quotation marks; for example:-s "(severity IN (‘CRITICAL’,’FATAL’))AND \(source=’NT’)"

Valid operators for a constraint are =, <>, <, <=, >, >=, LIKE, NOTLIKE, IN, NOT IN, IS NULL, IS NOT NULL, BETWEEN, andNOT BETWEEN.

The following table shows event attributes that are set totimestamps and the format to use when specifying values for theseattributes with the –s suboption. Timestamp values must beenclosed with single quotation marks. Formatted timestamp valuesspecified in a constraint are converted internally to the appropriatedata types required by the event database.

Attributes ContainingTimestamp Values Format Examples

cause_date_receptiondate_receptionlast_modified_time

’m/d/yy h:mm:ss a z’

a is AM or PM.

z is the time zoneabbreviation.

’4/1/01 9:36:24 AM CST’

’3/13/01 9:36:24 AM CST’

’10/13/01 10:59:55 PM EST’

Note: Specifying a filter constraint works the same as the eventconsole’s Constraint Editor dialog. The same eventattributes, operators, and attribute values you can specify inthe Constraint Editor can be specified with the –s suboptionof the –addegflt option.


–S free_form_SQLAny SQL statements that are valid for a WHERE clause and aresupported by the RDBMS used for the event database. Do notenter the leading WHERE keyword—it is handled automatically.Enclose the entire free_form_SQL argument within quotation marks.You can use SQL wildcard characters as long as they are supportedby the RDBMS used for the event database.

Note: No syntax checking is done by the wconsole command onfree-form SQL statements you specify; that is, you areresponsible for the correctness of free-form SQL statementsfor an event filter.

–assigneg [–h host[:port]] [–u user] [–p password] –C console –E event_group[–r role:...]

Assigns an event group to an event console definition. You can alsooptionally assign the roles for the event group. Roles determine whether anoperator can acknowledge and close events belonging to the event group.

–C consoleThe name of the console to assign the event group.

–E event_groupThe name of the event group to assign.

–r role:...The roles to assign the event group. Separate each role with acolon (:). The default value is admin. Valid values are super,senior, admin, and user. For additional information about TivoliEnterprise Console roles, see the IBM Tivoli Enterprise Console User’sGuide.

–assignop [–h host[:port]] [–u user] [–p password] –C console –O operator:...Assigns operators to an event console definition.

–C consoleThe name of the console to assign the operators.


–O operator:...A list of operators to assign to the console. Separate each operatorwith a colon (:). The operators specified must have already beencreated as Tivoli administrators, and must not be currentlyassigned to another console. You must also have created thespecified operator using the “Create Operator” option on the eventconsole, or by using the wconsole -crtoperator command. If anoperator has not yet been defined as a Tivoli administrator or iscurrently assigned to another console, an error message is issuedand processing of the command continues. See the –lsconsoleoption for information about listing all currently defined consolesand their assigned operators.

–copyconsole [–h host[:port]] [–u user] [–p password] –n name –C consoleCopies an event console’s event groups, event group filters, andauthorization role assignments to another console definition. Event Viewerpreferences are not copied. Event Viewer preferences are stored locally onthe hosts where the console clients are installed. The target console mustexist.

–C consoleThe name of the target console.

–n nameThe name of the source console.

–crtconsole [–h host[:port]] [–u user] [–p password] [–C console] [–n name][–D description] [–O operator:...]

Creates a new event console definition.

–C consoleThe name of the source console from which to copy event groupsand their authorization roles, and event group filters to the newconsole definition.

–D descriptionThe text description of the new console. The default value is Newdescription.

–n nameThe name for the new console. The default value is New.

–O operator:...A list of operators to assign to the new console. Separate eachoperator with a colon (:). The operators specified must havealready been created as Tivoli administrators, and must not becurrently assigned to another console. You must have also createdthe operators specified using the “Create Operator” option of theevent console or by using the wconsole -crtoperator command. Ifan operator has not yet been defined as a Tivoli administrator or iscurrently assigned to another console, an error message is issuedand processing of the command continues. See the –lsconsoleoption for information about listing all currently defined consolesand their assigned operators.

-crtoperator [-h host[:port]] [-u user] [-password] -O operator:... [-C console]Creates a new console operator.

-O operator:...A list of operators to create. Separate each operator with a colon (:).The operators specified must have already been created as Tivoli


Administrators and must not be currently assigned to anotherconsole. If an operator has not yet been defined as a TivoliAdministrator or is currently assigned to another console, anderror message is issued and processing of the command continues.See the -lsconsole option for information about listing all currentlydefined consoles and their assigned operators.

-C consoleThe name of an existing console to which newly created operatorsare to be assigned.

–crteg [–h host[:port]] [–u user] [–p password] –n name [–D description][–E event_group]

Creates a new event group.

–D descriptionThe text description of the new event group.

–E event_groupThe name of a source event group to copy as the new event group.The source event group’s filters are copied, also.

–n nameThe name for the new event group.

–delconsole [–h host[:port]] [–u user] [–p password] –n nameDeletes an event console definition. If there are instances of the consolethat are running when this option is issued, the definition is not removeduntil no instances are running.

–n nameThe name of the console definition to delete.


–deleg [–h host[:port]] [–u user] [–p password] –e event_group:...Deletes one or more event groups, including their filters. If any eventgroups specified with this option are assigned to consoles, the eventgroups are unassigned from the consoles before being deleted.

–e event_group:...The names of the event groups to delete. Separate each eventgroup name with a colon (:).

–delegflt [–h host[:port]] [–u user] [–p password] –E event_group {–a | –n name}Deletes one or more filters from an event group.

–a Delete all filters from the event group.

–E event_groupThe name of the event group that contains the filters to delete.

–n nameThe name of the filter to delete.

-deloperator [-h host[:port]] [-u user] [-p password] -O operator:...Deletes an existing console operator.

-O operator:...A list of operators to delete. Separate each operator with a colon(:). Any assigned consoles are first unassigned. See the -lsconsoleoption for information about listing all currently defined consolesand their assigned operators.

–lsassigneg [–h host[:port]] [–u user] [–p password] –C consoleLists event groups assigned to an event console definition.

–C consoleThe name of the console to list.

–lsconsole [–h host[:port]] [–u user] [–p password] [–a] [–c console:...]Lists event console definitions. This option does not show console clientsthat are installed.

–a Lists the console description, event groups assigned and theirauthorization roles, and assigned operators for each consoledefinition. If this option is not specified, only console names arelisted.

–c console:...The names of specific console definitions to list. Separate eachconsole name with a colon (:). If this suboption is not specified, allconsole definitions are listed.

-lsconsoleup [–h host[:port]] [–u user] [–p password]Lists currently running consoles for the UI server in the TMR that the userexecuting the wconsole -lsconsoleup command is logged into. Thiscommand requires the Tivoli Enterprise Console UI server product, Version3.7.1 or higher. To use this option, all IBM Tivoli Enterprise Consoleproducts must be at the 3.7.1 level or higher.

–lseg [–h host[:port]] [–u user] [–p password] [–a] [–e event_group:...]Lists event groups.

–a Lists the description and filters of each event group. If thissuboption is not specified, only the event group names are listed.


–e event_group:...The names of specific event groups to list. Separate each eventgroup name with a colon (:). If this suboption is not specified, allevent groups are listed.

-lsoperator [-h host[:port]] [-u user] [-p password] [-a] -[O operator:...]Lists console operators definitions.

-a Lists the assigned console definition. If this option is not specified,only operator names are listed.

-O operator:...The names of specific console operators to list. Separate eachoperator with a colo (:). If this suboption is not specified, allconsole operators are listed.

–setconsole [–h host[:port]] [–u user] [–p password] –C console [–n name][–D description]

Changes the name and description of an event console definition.

–C consoleThe name of the console to change.

–D descriptionThe new text description for console.

–n nameThe new name for the console. The name is not changed if youspecify one already in use by another console.

–seteg [–h host[:port]] [–u user] [–p password] [–n name] [–D description]–E event_group

Changes the name and description of an event group. The changes arereplicated to assigned event groups.

–D descriptionThe new text description for the event group.

–E event_groupThe name of the event group to change.

–n nameThe new name for the event group. The name is not changed ifyou specify one already in use by another event group.

–setegflt [–h host[:port]] [–u user] [–p password] [–n name] [–D description]–E event_group –F filter

Changes the name and description of an event group filter.

–D descriptionThe new text description for the filter.

–E event_groupThe name of the event group containing the filter to change.

–F filterThe name of the filter to change.

–n nameThe new name for the filter. The name is not changed if youspecify one already in use by another filter within the event group.

–unassigneg [–h host[:port]] [–u user] [–p password] –C console –e event_group:...Unassigns one or more event groups from an event console definition.


–C consoleThe name of the console containing the event groups to unassign.

–e event_group:...The names of the event groups to unassign from the console.Separate each event group with a colon (:).

–unassignop [–h host[:port]] [–u user] [–p password] –C console –O operator:...Unassigns operators from an event console definition.

–C consoleThe name of the console to unassign the operators.

–O operator:...A list of operators to unassign from the console. Separate eachoperator with a colon (:). See the –lsconsole option for informationabout listing all currently defined consoles and their assignedoperators.

Return ValuesThe wconsole command returns one of the following values. Return values can beobtained with the $? shell variable. Any error message text is written to stderr.v 0 indicates that the wconsole command completed successfully.v 1 indicates that the wconsole command failed because of an unknown reason.v 2 indicates that the wconsole command failed because of an authorization

problem.

ExamplesThe following list provides examples of option usage for the wconsole command.In the examples, the backslash character (\) at the end of a line indicates that thetext shown on the following line has wrapped due to space restrictions on thepage. The example should be interpreted as being on one line.

–addegflt Examples

1. The following example creates the Immediate Attention event groupfilter in the Operators event group. The Operators event group mustalready exist. The Immediate Attention filter is comprised of oneconstraint: The severity event attribute is set to a value of CRITICAL orFATAL.wconsole -addegflt -E Operators\-n “Immediate Attention” \-s "(Immediate Attention IN\(’CRITICAL’,’FATAL’))"

2. The following example creates the LowRepeats event group filter in theLogfile event group. The Logfile event group must already exist. TheLowRepeats filter is comprised of the following two constraints, bothof which must be met for events to pass this filter and be included inthe event group:a. The source event attribute is set to a value of LOGFILE.b. The repeat_count event attribute is set to a value between 1 and 10.wconsole -addegflt -E Logfile -n LowRepeats \-s "(source=’LOGFILE’) AND \(repeat_count BETWEEN 1 AND 10)"

3. The following example adds a new filter named Router Ports to theSubnet event group. The Subnet event group must already exist. TheRouter Ports filter is comprised of the following two constraints and


free-form SQL statement. All three conditions must be met for events topass this filter and be included in the event group:a. The event class is Link_Down.b. The adapter_host event attribute does not contain a null value; that

is, there is a value set for the attribute.c. The repeat_count event attribute is not set to a value less than 10.

The relational operator used in this constraint is specific to aMicrosoft SQL Server RDBMS. The backslash character precedingthe operator is an escape character so the exclamation point isinterpreted correctly by the UNIX shell.

wconsole -addegflt -E Subnet \-n "Router Ports" -s "(class=’Link_Down’) \AND (adapter_host IS NOT NULL)" \-S "(repeat_count \!< 10)"

–assigneg Examples

The following example assigns the Subnet event group with super andsenior roles to the NetAdmin console:wconsole.cmd -assigneg -C NetAdmin \-E Subnet -r super:senior

–assignop Examples

The following example assigns the operator namedRoot_hmckinne-nt-region to the NetAdmin console:wconsole.cmd -assignop -C NetAdmin \-O Root_hmckinne-nt-region

–copyconsole Examples

The following example copies the event groups and their roles, andevent group filters from the Personnel Systems console to thePersonnel Systems Audit console. Note that operators are not copiedand the target console must exist.wconsole.cmd -copyconsole -h mfoster:6688 \-u Administrator -p chief10 \-n "Personnel Systems" \-C "Personnel Systems Audit"

–crtconsole Examples

1. The following example creates a console definition named PersonnelSystems and specifies its description. No event groups or operators areassigned to the console.wconsole.cmd -crtconsole -h mfoster:6688 \-u Administrator -p chief10 \-n "Personnel Systems" -D "Console \Definition for Managing Personnel \Systems Events"

2. The following example creates a console definition named PersonnelSystems, specifies its description, and assigns the operator namedmf_viewer to the console. No event groups are assigned to the console.wconsole.cmd -crtconsole -h mfoster:6688 \-u Administrator -p chief10 \-n "Personnel Systems" -D "Console \Definition for Managing Personnel \Systems Events" -O mf_viewer


3. The following example creates a console definition named PersonnelSystems, specifies its description, assigns the operator namedmf_viewer, and copies the event groups and their roles from theAdministratorConsole console to the Personnel Systems console. Notethat the –C option is a copy operation, not a move operation.wconsole.cmd -crtconsole -h mfoster:6688 \-u Administrator -p chief10 \-n "Personnel Systems" -D "Console \Definition for Managing Personnel Systems Events" \-O mf_viewer \-C AdministratorConsole

–crteg Examples

The following example creates an event group named Subnet. Thefilters from the Network event group are copied into the new eventgroup.wconsole.cmd -crteg -n Subnet -D "Subset \of the Network event group" -E Network

–delconsole Examples

The following example deletes the Personnel Systems consoledefinition:wconsole.cmd -delconsole -h mfoster:6688 \-u Administrator -p chief10 \-n "Personnel Systems"

–deleg Examples

The following example deletes the System event group:wconsole.cmd -deleg -e System

–delegflt Examples

1. The following example deletes the SNMP and OpenView filters fromthe Network event group:wconsole.cmd -delegflt -E Network \-n SNMP:OpenView

2. The following example deletes all of the filters from the Performanceevent group:wconsole.cmd -delegflt -E Performance -a

–lsassigneg Examples

The following example lists the event groups assigned to theNetAdmin console:wconsole.cmd -lsassigneg -C NetAdmin

The output displayed by this command is:SubnetNetworkSystem

–lsconsole Examples

1. The following example lists console definitions without details:wconsole.cmd -lsconsole -h mfoster:6688 \-u Administrator -p chief10

The output displayed by this command is:


AdministratorNewTest1Test2

2. The following example lists the Administrator and New consoledefinitions with details (the –a suboption):wconsole.cmd -lsconsole -h mfoster:6688 \-u Administrator -p chief10 \-a -c Administrator:New

The output displayed by this command is:Administrator

Description: Console for \Administrator User

Event Group: DM (User, Admin, \Senior, Super)

Event Group: UNIX_Logfile (User, \Admin, Senior, Super)

Event Group: NT (User, Admin, \Senior, Super)New

Description: New descriptionEvent Group: newEG2 (User, Admin)Event Group: newEG1 (User, Admin)

-lsconsoleup ExampleThe following is an example of the output for the –lsconsoleup optionwith defaults:There are currently 3 active TEC consoles.

Console Administrator/Operator_________________________________________Root_jbr01-region Admin1test1 TestAdminDB2 DB2Admin

–lseg Examples

The following example lists the event group description and filters(including constraints) for the Subnet and Network event groups:wconsole.cmd -lseg -a -e Subnet:Network

The output displayed by this command is:Subnet

Description: Subset of the Network \event group

SunNet Manager: (source = ’SNM’)AND \(class = ’EVENT’)

HP OpenView: (source = ’HPOV’)\AND(class = ’EVENT’)

NetView 6000: (source = ’NV6K’)\AND(class = ’EVENT’)

Router Ports: (class = ’Link_Down’)\AND(adapter_host IS NOT NULL)

AND(repeat_count !< 10)\Network

Description: General network eventsSNMP: (source = ’SNMP’)\

AND(class = ’EVENT’)SunNet Manager: (source = ’SNM’)\

AND(class = ’EVENT’)HP OpenView: (source = ’HPOV’)\

AND(class = ’EVENT’)NetView 6000: (source = ’NV6K’)\

AND(class = ’EVENT’)


–setconsole Examples

The following example changes the name of the Personnel Systemsconsole to Human Resources Systems.wconsole.cmd -setconsole -h mfoster:6688 \-u Administrator -p chief10 \-C "Personnel Systems" \-n "Human Resources Systems"

–seteg Examples

The following example changes the name of the Subnet event group toSubnetwork, and changes the description:wconsole.cmd -seteg -n Subnetwork \-D "Subnetwork Event Data" -E Subnet

–setegflt Examples

The following example changes the name of the SunNet Manager filterin the Subnetwork event group to SNM, and changes the description:wconsole -setegflt -n SNM -D "SNM Events" \-E Subnetwork -F "SunNet Manager"

–unassigneg Examples

The following example unassigns the Network and System eventgroups from NetAdmin console:wconsole.cmd -unassigneg -C NetAdmin \-e Network:System

–unassignop Examples

The following example unassigns the operator namedRoot_hmckinne-nt-region to the NetAdmin console:wconsole.cmd -unassignop -C NetAdmin \-O Root_hmckinne-nt-region

See AlsoNone.


wcrtsrc

Creates a source on the event server.

Syntaxwcrtsrc [–S server] [–b bitmap] [–l label] source

DescriptionThe wcrtsrc command appends a source to the current source list on the eventserver. The wcrtsrc command populates the Tivoli object database that eventconsoles use to create event filters. The source name is checked to be sure it is not aduplicate before it is added to the list. Sources send event information to theEnterprise Console via event adapters. The event adapter defines the name for asource.

Authorizationsenior

Optionssource Specifies the name of the source to create. The name must correspond to

the name specified by the event adapter.

–b bitmapDisplays the specified bitmap on the event console. The bitmap must bethe name of a bitmap stored at the server.

–l label Uses the specified label as the name of the source on event consoles. If thisargument is not specified, the value specified in source argument is used asthe label.



ExamplesThe following example adds the LOGFILE source to the local TMR and labels thesource Logfile:wcrtsrc –l "Logfile" LOGFILE

See Alsowdelsrc, wlssrc, wsetsrc


wcrtnvgroups

Creates event groups required to use the netview.rls rule set.

Syntaxwcrtnvgroups [-h host] [-u user] [-p password]

DescriptionThe wcrtnvgroups script uses the wconsole command to create the Tivoli Netviewevent groups required by the netview.rls rule set. These two groups are theOpenNetview event group and the ClosedNetview event group. The OpenNetviewevent group contains events from the Tivoli Netview product that are open in theIBM Tivoli Enterprise Console product. The ClosedNetview event group containsthe events from the Tivoli Netview product that have a status other than OPEN inthe IBM Tivoli Enterprise Console product.

If you do not specify the -h, -u, and -p options, a dialog box is displayed to enterthe information when the wcrtnvgroups command is executed. Your environmentmust be properly configured to allow such a display. If it is not possible toconfigure your environment to display a dialog box, you must use the -h, -u, and-p options instead.

Authorizationuser

Options-h host Specifies the hostname where the event console runs.

-u user Specifies the user name of the administrator.

-p passwordSpecifies the password of the administrator.


ExamplesThe following creates the event groups on a machine called phizer:wcrtnvgroups phizer.dev.tivoli.com jford my_password

See Alsowconsole


wdbconfig.shRuns the database configuration scripts from outside the installshield wizard.

Syntaxwdbconfig.sh [rm | rm_tbl | cr | cr_tbl | upg | upg_362]

DescriptionThe wdbconfig.sh script runs the database configuration scripts that the eventdatabase configuration assistant has generated. It is used when the generatedscripts must be copied to a RIM host machine that is located on a differentmachine than the event server.

The user must be logged in as the same user as the RIM user ID specified for theevent database RIM object. This user should have DBA access to the eventdatabase tables. The user must also have a corresponding login for the Tivolimanagement environment administrator.

For the Informix database, the wdbconfig.sh script can only be run on the machinewhere the database server is installed.

Authorizationuser

Optionsrm Runs the dbConfigure_rm.sh script to completely remove the database.

rm_tblRuns the dbConfigure_rm_tbl.sh script to remove the database tables,indexes, and views.

cr Runs the dbConfigure_cr.sh to do a new installation of the database. If youhave an existing database, it must be removed before doing a newinstallation.

cr_tbl Runs the dbConfigure_cr_tbl.sh script to add the database tables, indexes,and views.

upg Runs the dbConfigure_upg.sh script to upgrade the database from aversion 3.7.1 schema to a version 3.8 schema.

upg_362Runs the dbConfigure_upg_362.sh script to upgrade the database from aversion 3.6.2 schema to a version 3.8 schema.

ExamplesThe following example creates a new database:wdbconfig.sh cr

See Alsowdbinstall.sh


wdbinstall.sh

Runs the event database installation assistant. This database installation assistantcreates, updates, or removes the database schema.

Syntax./wdbinstall.sh &

DescriptionThe installation assistant allows the user to enter the desired databaseconfiguration parameters to generate and execute the database SQL scripts andshell scripts required to create the database schema. The database installationassistant generates the scripts based on the configuration parameters.

There are six possible actions, each of which creates a separate script. They are asfollows:v Install a new database and the database componentsv Upgrade the database schema from the 3.7.1 configuration to the 3.8

configurationv Upgrade the database schema from the 3.6.2 configuration schema to the 3.8

configuration schemav Remove the database and the database componentsv Install the database componentsv Remove the database components

The database components are the tables, the indexes, the views, and for the Sybaseand MS SQL Server 7 databases, the triggers.

Note: If the RIM host is not the same machine as the event server, choose only to“Generate” the database schema configuration scripts when thewdbinstall.sh script is run.

When you run the database installation assistant, you are asked for a directory toinstall in. Unless you use an Informix databases, be sure that the directorystructure is the same where generated scripts are written on the RIM host machine.If you are using an Informix database, this directory must be located on theInformix database server machine. If the scripts are not placed in the samedirectory on the RIM host, edit each generated script and change the SCRIPTDIRvariable to the new directory path.

Thewdbinstall.sh script must be run from the $BINDIR/TME/TEC/sql directory.For the Sybase, MS SQL Server and Oracle databases, the database environmentmust be sourced. The DB2 and Informix database environments must be sourcedwhen logged in as the IBM Tivoli Enterprise Console RIM user.

For all databases except Oracle, installing, upgrading, or removing the entiredatabase requires the database instance or database server to be stopped andrestarted. Also, back up the database instance or database server before runningthe configuration scripts.

Authorizationuser


OptionsNone.

Examples./wdbinstall.sh &

See Alsowdbconfig.sh


wdbmaint.shUpdates the database data distribution statistics or reorganizes the database.

Syntaxwdbmaint.sh [stats | reorg] [rim_object_name] [ db2 server | db2client]

DescriptionThe wdbmaint.sh command improves database runtime performance by updatingdatabase statistics or by reorganizing the database.

Updating the database statistics to reflect the current amount of data and thedistribution of data values helps the internal database manager choose the bestaccess plan to retrieve data from the database.

Reorganizing the database can put indexes or tables back into the sequential indexorder, which reduces fragmentation. After the reorganization utility is run, thestatistics are automatically updated.

Note: Reorganizing the databases or updating the statistics must be done while theevent server is down.

It is recommended that these utilities be run frequently. In particular, the utilitiesshould be run after large numbers of deletions or insertions occur. For this reason,the reorg utility should be run after wtdbclear.

The bash and wrimsql programs must be available to the machine where thiscommand is run. For the MS SQL Server database running the reorg option, thiscommand must be run from the RIM host. For all other databases this command isrun from the event server. For the IBM DB2 database, you must be logged in as theDB2 TEC RIM user and the command must be run from the DB2 command lineprocessor on the RIM host.

If this command is not run on the event server, the following files will need to becopied to the machine where the script is run:v wdbmaint.shv genreorg.shv genrunstats.sh

In addition, these files will need to be copied for the following databases:

Database File to be copied

DB2 Server reorg.db2

DB2 Client reorg_client.db2

Sybase reorg.syb

MS SQL Server reorg.mssql

Authorizationuser


Optionsreorg Reorganize the database indexes and tables.

stats Update the internal statistics of data distribution.

db2clientSpecifies that the IBM DB2 client is installed on the RIM host and is theconnection used by RIM. This parameter is only used with IBM DB2connections to RIM.

db2serverSpecifies that the IBM DB2 server is installed on the RIM host and is theconnection used by RIM. This parameter is only used with IBM DB2connections to RIM.

Examples$BINDIR/TME/TEC/sql/wdbmaint.sh reorg

$BINDIR/TME/TEC/sql/wdbmaint.sh stats

See Alsowtdbclear


wdelac

Removes an adapter configuration record from an adapter configuration profile.

Syntaxwdelac key... profile

DescriptionThe wdelac command deletes the records selected by the given keys from thenamed adapter configuration profile (ACP). When the profile is next distributed,the old configuration files will be removed or not based on the value of therm_on_del behavior flag.

Authorizationadmin

Optionskey... Key of the record(s) to remove. At least one key must be specified.

Separate multiple keys with a space. You can see the key value in theupper right side of the ACP entry panel or by using the wlsac command.

profile The name of the ACP from which records are to be removed. If the nameincludes spaces, enclose the whole name in quotes.

ExamplesThe following example deletes the records with key values 0, 1, and 4 from theprofile named ACP Logfile Profile:wdelac 0 1 4 "ACP Logfile Profile"

See Alsowaddac, wlsac


wdelsrc

Deletes a source from the event server list.

Syntaxwdelsrc [–S server] source...

DescriptionThe wdelsrc command deletes a source from the current source list at the eventserver. The removed source is not removed from event consoles, nor are existingevents from the source removed from the event cache. Therefore, the source can beadded back without reconfiguring event groups.

To display a list of available sources, use the wlssrc command.

Authorizationsenior

Optionssource...

Specifies the source name to delete. At least one source must be specified.Separate multiple sources with a space.


ExamplesThe following example deletes the SNMP source from the local TMR:wdelsrc SNMP

See Alsowcrtnvgroups, wlssrc, wsetsrc


wlsac

Shows adapter configuration records from an adapter configuration profile.

Syntaxwlsac [ –l | –f format] [key... ] profile

DescriptionThe wlsac command writes to standard output one or more records from anadapter configuration profile (ACP). One or more record keys can be supplied tochoose individual records. If no keys are given, all records are printed.

Records are printed in one of two forms. The default format includes the key,adapter type, and the complete target file name (that is, the name of the file onsubscriber hosts where the adapter configuration will be written upondistribution). An alternate format can be given with the –f option. With the –loption, each record is printed out as an actual adapter configuration in the sameform used when the configuration files are created upon distribution.

Authorizationadmin

Optionskey... Key of the record(s) to print. If key is omitted, all records are printed.

Separate multiple keys with a space. You can see the key value in theupper right side of the ACP entry panel or by using this command.

profile The name of the ACP from which records are to be printed. If the nameincludes spaces, enclose the whole name in quotes.

–f formatProvides an alternate format for printing records. The format string maycontain arbitrary text as well as references to the data from the record.Such references are of the same form used in constructing messagecatalogs, that being an index value and a format request. The followingvalues are available for formatting:

%1 The key.

%2 The adapter type.

%3 The target directory.

%4 The target file name.

%5 The record comment field.

%6 The sequence of environment variable definitions.

%7 The sequence of event filter definitions.

%8 The sequence of file distribution requests.

%9 The sequence of endpoint behavior flags.

%10 The user ID for distribution actions.

%11 The group ID for distribution actions.


The key, type, target directory, and file name values are all strings, andshould be formatted with the $s format. The sequence values are lists ofstrings; the simplest format for those values is something like’$I{%1$s}{\n}’, which prints each string from the sequence on a line byitself. The entire string must be enclosed in single quotes. The defaultformat is thus:’%1$s %2$s %3$s/%4$s’

To print simply the adapter type and the filters:’%2$s\n%6$I{\t%1$s}{\n}’

If you are writing applications using the Enterprise Console and TivoliADE, see the Tivoli ADE Application Services Manual, Vol. 1 for completedetails on message formats and message catalogs.

–l Shows all selected records as complete adapter configurations.

ExamplesThe following example shows how to use formats:wlsac -f \’%1$s %2$s %3$s/%4$s\nRecord comment [%5$s]\n\n \Env Var Defs BEGIN\n%6$I{%1$s}{\n}\nEnv Var Defs END\n\n \Event Filters BEGIN\n%7$I{%1$s}{\n}\nEvent Filters END\n\n \File Dists BEGIN\n%8$I{%1$s}{\n}\nFile Dists END\n\n \Endpt Behavior Flags [%9$s]\nUID [%10$s]\nGID [%11$s]’ \@"ACP:$1" # NT_Std_PD

The following example shows the output from the previous example:0 tecad_nt C:\TEMP/tecad_nt.confRecord comment tecad_nt Configuration!Env Var Defs BEGINServerLocation=@EventServerEventMaxSize=4096PollInterval=30BufEvtPath=C:\usr\local\Tivoli\bin\w32-ix86\TME\TEC\adapters\etc\ \tecad_nt.cacheAdapterCdsFile=C:\usr\local\Tivoli\bin\w32-ix86\TME\TEC\adapters\ \etc\tecad_nt.cdsAdapterErrorFile=C:\usr\local\Tivoli\bin\w32-ix86\TME\TEC\adapters\ \etc\tecad_nt.errAdapterSpecificFile=C:\usr\local\Tivoli\bin\w32-ix86\TME\TEC\ \adapters\etc\tecad_nt.confEnv Var Defs ENDEvent Filters BEGINFilter:Class=NT_BaseFilter:Class=NT_Base_Event;Filter:Class=NT_TimeServ_Worked;Filter:Class=NT_User_Logoff;Filter:Class=NT_Logon_Successful;Filter:Class=SNA_Connect;Filter:Class=NT_Document_Print_Success;Filter:Class=NT_Document_Print_Deleted;Filter:Class=NT_Privileged_Service_Called;Filter:Class=NT_Security_Database;Filter:Class=NT_Base_Event;Filter:Class=NT_Master_Browser;Filter:Class=NT_Account_Management_Success;Filter:Class=NT_Audit_Policy_Change;Event Filters ENDFile Dists BEGINtecad_nt.err=/usr/local/Tivoli/bin/generic_unix/TME/ACF_REP/ \tecad_nt.err


tecad_nt.fmt=/usr/local/Tivoli/bin/generic_unix/TME/ACF_REP/ \tecad_nt.fmttecad_nt.cds=/usr/local/Tivoli/bin/generic_unix/TME/ACF_REP/ \tecad_nt.cds!net stop TECNTAdapterc:cd \usr\local\Tivoli\bin\w32-ix86cd TME\TEC\adapters\etcdel tecad_nt.*cd \tempdel tecad_nt.*copy c:\temp\tecad_nt.* c:\usr\local\Tivoli\bin\w32-ix86\TME\TEC\ \adapters\etc\del c:\temp\tecad_nt.*!!net start TECNTAdapterFile Dists ENDEndpt Behavior Flags rm_on_del=yes!UID Operator!GID 0!

See Alsowaddac, wdelac


wlsaddflt

Shows global default information on the defined adapter types.

Syntaxwlsaddflt [ –l | –f format] [type... ]

DescriptionThe wlsaddflt fetches global default information for one or more adapter types. Ifno types are supplied, then wlsaddflt prints default information for all knownadapter types.

Records are printed in one of two forms. The default format includes the adaptertype and the complete target file name (that is, the name of the file on subscriberhosts where the adapter configuration will be written upon distribution). Analternate format can be given with the –f option. With the –l option, each record isprinted out as an actual adapter configuration in the same form used when theconfiguration files are created upon distribution.

Authorizationadmin

Optionstype... The adapter type(s) whose global defaults are to be printed. Separate

multiple types with a space. To see the available types, use the wlsaddfltcommand.

–f formatProvides an alternate format for printing records. The format string maycontain arbitrary text as well as references to the data from the record.Such references are of the same form used in constructing messagecatalogs, that being an index value and a format request. The followingvalues are available for formatting:

%1 The adapter type (same as %2).

%2 The adapter type.

%3 The target directory.

%4 The target file name.

%5 The record comment field.

%6 The sequence of environment variable definitions.

%7 The sequence of event filter definitions.

%8 The sequence of file distribution requests.

%9 The sequence of endpoint behavior flags.

%10 The user ID for distribution actions.

%11 The group ID for distribution actions.

The type, target directory, and file name values are all strings, and shouldbe formatted with the $s format. The sequence values are lists of strings;the simplest format for those values is something like ’$I{%1$s}{\n}’,


which prints each string from the sequence on a line by itself. The entirestring must be enclosed in single quotes. The default format is thus:’%1$s %2$s %3$s/%4$s’

To print simply the adapter type and the filters:’%2$s\n%6$I{\t%1$s}{\n}’

If you are writing applications using the Enterprise Console and TivoliADE, see the Tivoli ADE Application Services Manual, Vol. 1 for completedetails on message formats and message catalogs.

–l Shows all selected records as complete adapter configurations


ExamplesThe following example shows the configuration record for type tecad_hpov:# wlsaddflt -l tecad_hpov:::: record tecad_hpov ::::# Sun 06 Aug 2000 07:05:49 PM CDT## tecad_hpov Configuration#ServerLocation=@EventServerEventMaxSize=4096WellBehavedDaemon=TRUEBufEvtPath=$TIVOLIHOME/tec/${AC_TYPE}.cache

See Alsowaddac, wdelac


wlsadenv

Shows an installed list of adapter-specific Event Integration Facility (EIF)environment variables.

Syntaxwlsadenv type

DescriptionThe wlsadenv command writes to standard output the list of EIF environmentvariables recognized by the given adapter type, separated by new lines. The type“__generic__” is used by the Adapter Configuration Facility for the list of variablesunderstood by the EIF library itself.

Authorizationadmin

Optionstype The adapter type. To see the available types, use the wlsaddflt command.

ExamplesThe following example lists the EIF environment variables for the tecad_logfileadapter type:wlsadenv tecad_logfile

This example returns the following information:UnmatchLogLogSources

See Alsowaddac, wsetadenv, wlsadgui, wlsadval


wlsadgui

Show an installed link to adapter-specific extended configuration tools.

Syntaxwlsadgui type

DescriptionThe wlsadgui command writes to standard output the class name, instance name,and button label installed with wsetadgui for the given adapter type. If an adapterhas special extended configuration tools intended to be used with the adapterconfiguration file (ACF) graphical configuration tools, then a link should beestablished when the adapter is installed.

Authorizationadmin

Optionstype The adapter type. To see the available types, use the wlsaddflt command.

ExamplesThe following example shows extended configuration tools for the tecad_logfiletype:# wlsadgui tecad_logfile@LogfileConfiguration:LogfileConfiguration Logfile Format Editor...

See Alsowlsac, wlsadenv, wsetadgui, wlsadval


wlsadval

Shows installed validation information for an adapter type.

Syntaxwlsadval attribute type

DescriptionThe wlsadval command writes to standard output validation informationpreviously stored with wsetadval for the given attribute of the given adapter type.

Authorizationadmin

Optionsattribute

The name of the profile attribute whose validation information is to beprinted. The following list shows the attributes on a normal ACP:

ACPbhvThe sequence of profile behavior variables, separated by new lines.

ACPcommentThe comment field.

ACPdistThe sequence of distribution requests, separated by new lines.

ACPevThe sequence of environment variables, separated by new lines.

ACPfltThe sequence of filter definitions, separated by new lines.

ACPgidThe group ID for endpoint actions.

ACPtargdirThe configuration installation directory.

ACPtargetThe target primary configuration filename.

ACPtypeThe type of the record. This attribute generally needs novalidation.

ACPuidThe user ID for endpoint actions.

Other attributes may be present if they are added to the profile with theTivoli Application Extension Facility (AEF) tools.

type The adapter type. To see the available types, use the wlsaddflt command.

ExamplesThe following example shows the validation information for the ACPtargetattribute and the tecad_logfile_solaris2 type:


wlsadval ACPtarget tecad_logfile_solaris2case "$1" in

"tecad_logfile.conf")echo TRUE;;

*)echo FALSE;;

esac

exit 0

See Alsowlsac, wlsadenv, wsetadgui


wlsaeenv

Shows the environment variables available at an adapter configuration profileendpoint.

Syntaxwlsaeenv [–a] endpoint

DescriptionThe wlsaeenv command prints to standard output the list of environment variablesand their values for a given endpoint. The variables are printed one per line in theform name=value. This form can be used with wsetaeenv when that command isinvoked with its –i option. In combination, therefore, wlsaeenv and wsetaeenv canbe used to copy the environment of one endpoint to another.

Authorizationadmin

Optionsendpoint

The name of the endpoint object to be modified. The endpoint object canbe referenced with the standard @Classname:label notation; if not, it isassumed to be a reference to a managed node object.

–a Requests that the four endpoint-specific automatic variables(ACPEP_NAME, ACPEP_CLASS, ACPEP_NODE, and ACPEP_OID) beprinted along with all those established with wsetaeenv. The variableACPEP_NODE is printed only for managed nodes, not for endpoints. If thename of the endpoint is referenced as @Endpoint:label, the variableACPEP_NODE is not printed because it has no meaning for this classname.


ExamplesThe following example shows the environment variables and their values forendpoint ep1:wlsaeenv -a @Endpoint:ep1

This command returns the following information:ACPEP_NAME=@Endpoint:xeriusACPEP_OID=1170507881.2.508+#TMF_Endpoint::Endpoint#ACPEP_CLASS=Endpoint

See Alsowaddac, wdelac, wdistrib (in the IBM Tivoli Management Framework ReferenceManual), wsetaeenv


wlsemsg

Lists received events.

Syntaxwlsemsg [–k key] [–r severity] [–t status] console [event_group...]

DescriptionThe wlsemsg command lists received events in the event database. You must usethe options to specify a particular set of events or all events will be returned. Tospecify multiple values for a flag, use the flag multiple times, except as statedotherwise for the option.

When you use the options, only events that meet the specification of all of theoptions are returned. Use the –k option to specify sort keys for returned events.

Authorizationuser

Optionsconsole Lists events that match an administrator’s event console. Specify the name

of the console.

event_group...Lists events that match the event group definitions (that is, they pass theevent group’s filters). Separate multiple event groups with a space. Onlyevents passing the event group’s filters are listed.

–k key

Specifies the fields to sort by. Events are sorted in ascending order byevent_handle, server_handle, and date_reception. Other values areadministrator, class, hostname, id, message, origin, repeat_count,severity, source, status, sub_source, and sub_origin. The id field isdefined as the concatenation of event_handle, server_handle, anddate_reception.

Separate multiple values with a comma followed by a space (, ) andenclose the whole set of values in double quotes, as in the followingexample:wlsemsg -k "Class, Date, Status" ConsoleName

–r severitySpecifies a severity of FATAL, CRITICAL, MINOR, WARNING,HARMLESS, or UNKNOWN. Additional severities can also be configuredby the site.

–t statusSpecifies a status of OPEN, CLOSED, RESPONSE, or ACK.

ExamplesThe following example displays all open events of severity WARNING that arereported to event console “Network Events”:wlsemsg –r WARNING –t OPEN "Network Events"


See Alsowpostemsg, wsetemsg


wlsesvrcfg

Lists the configuration parameters for a running event server.

Syntaxwlsesvrcfg [–S server] [–b] [–c] [–e] [–k] [–m] [–n] [–r] [–t]

DescriptionThe wlsesvrcfg command lists configuration parameters for a running event server.The server in the local Tivoli Management Region (TMR) is the default unlessanother server is specified.

If no options are specified, all parameters are displayed.

Authorizationuser

Options–b Displays the maximum number of event messages buffered in the

reception buffer.

–c Displays the number of events that can be stored in the event cache.

–e Displays the number of seconds that received events are retained in thereception log.

–k Displays the number of seconds to keep closed events in the event cache.

–m Displays the number of seconds to allow the event server to initialize.

–n Displays the number of seconds to keep events that have not been closed.


–S serverSpecifies the name of the event server in name registry format. The defaultis the local event server. To specify a remote server, enter@EventServer#tmr, where tmr is the name of a TMR.

–t Displays whether rule tracing is enabled and the path name of the tracefile.

ExamplesThe following example lists information for the event server installed in thegray-region TMR:# wlsesvrcfg -S @EventServer#gray-region -t

The following is the output from this command:Trace rule execution: NoRule trace output file: /tmp/rules.trace

See Alsowsetesvrcfg


wlssrc

Lists existing sources on the event server.

Syntaxwlssrc [–S server] [–b] [–l] [source...]

DescriptionThe wlssrc command lists sources that are currently configured on the eventserver. If no source is specified, all sources are listed.

You can use options to list the bitmap and label for each source. The bitmap andlabel represent the source on administrators’ event consoles.

Authorizationuser

Optionssource...

Specifies a source to list or a Perl regular expression. All sources are listedif none are specified. Separate multiple sources with a space.

–b Displays the bitmap used for each source.

–l Displays the label that identifies each source.


ExamplesThe following example lists all information on all sources at the local event server:wlssrc –bl

See Alsowcrtnvgroups, wdelsrc


wmigcon

Migrates IBM Tivoli Enterprise Console, Version 3.6, consoles, event groups, andoperators to Version 3.7 and Version 3.8.

Syntaxwmigcon [–h host:port] [–u user] [–p password] [–x e | r | c]

DescriptionThe wmigcon command performs an automatic migration of consoles, eventgroups, and operators in an existing IBM Tivoli Enterprise Console version 3.6installation to the appropriate format for the version 3.7 and version 3.8 eventconsole. This command is typically used only once, during the initial setup of IBMTivoli Enterprise Console, Version 3.7 or version 3.8.

The following table indicates how the event group filters will be changed.

Old Filter New Filter

LOG LIKE %LOG%

^LOG LIKE LOG%

LOG$ LIKE %LOG

^LOGFILE$ LIKE LOGFILE

LOG* LIKE %LOG%

LOG+ LIKE %LOG%

LOG? LIKE %LOG%

LO[G,T] LIKE %LO[G,T]%

123.84.12.[0-5][0-9] LIKE %123.84.12.[0-5][0-9]%

123.84.12.0\b LIKE %123.84.12.0 %

^LO[G,T] LIKE LO[G,T]

LO[G,T]$ LIKE %LO[G,T]

^123.84.12.[0-5][0-9]$ LIKE 123.84.12.[0-5][0-9]

Notes:

1. This command attempts to translate each filter as accurately as possible, but anexact match cannot be made for each filter. The old filters are specified as Perlregular expressions, while the new filters are specified with the SQL LIKEoperator. Regular expressions and SQL do not map to one another in a preciseway. Therefore, you should inspect each filter after wmigcon has translated itto make sure that the resulting SQL filter is accurate.

2. The wmigcon command migrates all consoles, event groups, and operators. It isnot possible to selectively migrate these objects.

3. The event filter in Tivoli Enterprise Console, version 3.6 filters on five attributesof an event: class, source, sub_source, origin, and sub_origin. The sourceattribute is treated differently from the other attributes by the wmigconcommand. The wmigcon command will create a new filter that matches asingle source exactly. That is, there will be no wildcard characters (%) in theIBM Tivoli Enterprise Console, version 3.8 filter. So if the source and asubsource of a Tivoli Enterprise Console, version 3.6 are as follows:


source: “LOG”sub_source: “LOGFILE”

then the resulting IBM Tivoli Enterprise Console, version 3.8 filter will be asfollows:source “Equal to (=)” “LOG”sub_source “LIKE (LIKE)” “%LOGFILE%”

where the new sub_source contains wild card characters, allowing it to matchany string that contains the substring LOGFILE, but the source attribute onlymatches those strings that are exactly LOG.

Authorizationsuper, senior

Options–h host[:port]

The name of the managed node containing the IBM Tivoli EnterpriseConsole, Version 3.6, event console. Specify this option as host:port if aport other than port 94 is being used.

–p passwordThe password for the login specified in the –u user argument.

–u userThe login you use as a Tivoli administrator.


–x e | r | cHow to resolve conflicting object names. Use –x e to use the existing object(console, event group, or operator), –x r to replace the existing object withthe new one, or –x c to change the name of the object by appending anumber to the new object. The flags are case sensitive. The space betweenthe option and the flag is optional.

ExamplesThe following example performs the migration as the user root on the managednode mica. Name conflicts will be resolved by changing the name of the newobject.wmigcon -h mica -u root -p tivoli -x c


wpostemsg

Posts an event to the event server.

Syntaxwpostemsg –S server | –f configuration_file [–m message] [–r severity][attribute=value...] class source

DescriptionThe wpostemsg command sends an event to an event server. This commandrequires the use of Tivoli Framework services. Posting events is a good way to testthe server after you have created new event groups, created event groupassignments, edited rules, or otherwise changed the behavior of event processingat the server.

If your event message contains an embedded single quote (’), you must preface theembedded quote with another single quote.

For attribute values containing characters not in the following list of ASCIIcharacters, single quotation marks are automatically added to the beginning andend of the string:v a-zv A-Zv The characters $ - . / % & * + @ \ ^ _ ` | ~

The managed node and endpoint versions of the utility can be found in thefollowing directories:v Managed node version: $BINDIR/bin

v Endpoint version: $LCF_BINDIR/../bin

Using the endpoint version of wpostemsg is dependent on the endpointenvironment variables which can be set from the lcf_env.sh or lcf_env.csh files thatare included in the endpoint installation. To set up the environment variables,source these files where EP_ROOT_DIR is your installation path for the endpoint:

C Shell:source EP_ROOT_DIR/dat/lcf number/lcf_env.csh

Bourne Shell:EP_ROOT_DIR/dat/lcf number/lcf_env.sh

To ensure you are always using wpostemsg to match your node on a machineconfigured both as an endpoint and a managed node, it is recommended that youcreate a shell alias for the endpoint version of wpostemsg.

Examples for Unix shells:

C Shell:alias wpostemsgep "$LCF_BINDIR/../bin/wpostemsg"

Korn Shell:alias wpostemsgep="$LCF_BINDIR/../bin/wpostemsg"


Example for Bash shell on Windows:alias wpostemsgep="/Program\ Files/Tivoli/lcf/bin/w32-ix86/bin/wpostemsg.exe"

The backslash following /Program is used to escape the space in the directoryname /Program Files.

For an endpoint only node, add the wpostemsg path to the PATH environmentvariable. Verify your PATH contents to eliminate the confusion of having bothmanaged node and endpoint paths defined at one time.

Example:wpostemsg –m "test message from EP" TEC_Notice LOGFILE

Note: For AS/400 usage, see the AS/400 Alert Adapter chapter in the IBM TivoliEnterprise Console Adapters Guide.

Authorizationuser

Optionsattribute=value...

Assigns a value to any valid attribute. The attribute must be the onedefined for the event class. Separate multiple attribute=value expressionswith a space.

class Specifies the class of the event. It must match a class that is configured atthe server. Classes are defined by the event adapter.

source Specifies the source of the event.

–f configuration_fileSpecifies the name of the adapter configuration file. The default locationfor the tecad_eif.conf configuration file is the /etc/Tivoli/ directory;however, this file does not exist by default.

–m messageThe text of the event, in double quotes.

–r severitySpecifies a severity, one of FATAL, CRITICAL, MINOR, WARNING,HARMLESS, or UNKNOWN.


Note: If the event server is installed on a Windows machine, the –S optioncannot be used. Instead, use the –f option.

ExamplesThe following example sends a test message that displays an Su_Failure event ofseverity WARNING on the event consoles:wpostemsg –r WARNING –m "su failure" Su_Failure LOGFILE


See Alsopostemsg, wsetemsg, wpostzmsg and postzmsg (in the IBM Tivoli Event IntegrationFacility User’s Guide)


wrb

Manage rule bases at the event server.

Syntaxwrb [option [suboption]]

DescriptionThe wrb command enables you to manage rule bases. You can do such tasks ascreate, view information, manipulate, delete, compile, load, and activate rule baseswith this command. The command’s first option specifies its primary function.Subsequent suboptions are only valid within the context of the first argument.

When working with a rule base that was created by someone else, you must haveread and write access to the top-level rule base directory and to the following rulebase files and subdirectories:v TEC_RULES/

– rule_sets

– rule_sets_EventServer

– rule_sets_target

– rule_packs

v TEC_CLASSES/

– .load_rules

You must also have read access to all other files in the rule base directory.

Certain tasks performed with the wrb command require that the rule base be in aconsistent state before the command completes. If the rule base is not consistent, thecommand displays an error message explaining the cause of the inconsistency. Fora rule base to be consistent, the syntax of class sets and rule sets is verified, as wellas references to those files in various rule base definition files. For a rule base to bein a consistent state, the following conditions must be true:v Enumerated types referred to by an event class attribute definition have been

defined in the BAROC file.v Parent classes referred to by a child class (the ISA relationship) have been

defined in the BAROC file.v Attribute and facet values are of the correct type and are within range.v No enumerations or event classes have been defined more than once.v No attributes within an event class have been defined more than once.v Event filters and attribute filters refer to event classes and event class attributes

that have been defined in a BAROC file.v Any rule sets referenced by a rule pack have been defined in the rule base.v Any rule sets or rule packs referenced by a rule base target have been defined in

the rule base.

Any command that checks rule base consistency will accept the –force argument toperform the task without checking rule base consistency first.

When class definition files (.baroc) or rule set files (.rls) are being imported into arule base, the name of the file (including the extension) must be given. Once these


objects have been imported into a rule base, you must use the logical name (that is,without the extension) in any command options.

When importing an object into a rule base (for example, rule sets, event classes,rule packs into rule base targets, and so forth), an object that already exists in therule base must be deleted before you can replace it with a newer version of theobject. Each command option below specifies whether you must specify the nameof the file or the name of the object.

Note: For naming conventions for all rule objects (rule bases, rule sets, rule packs,and so on), see the IBM Tivoli Enterprise Console Rule Builder’s Guide.

Authorizationuser (TMR role for wrb command)

The following table list the TMR roles for the wrb command options:

Command Option Authorization

–comprules user

–cprb –classes senior

–cprb –rulepacks user

–cprb –rulesets senior

–cprb –targets user

–crtrb senior

–crtrp user

–crttarget user

–delrb senior

–delrbclass senior

–delrbpack user

–delrbrule senior

–delrbtarget user

–delrprule user

–deltgtdata user

–deltgtrule user

–imprbclass senior

–imprbrule senior

–imprprule user

–imptgtdata user

–imptgtrule user

–loadrb senior

–lscurrb senior

–lsrb user

–lsrbclass user

–lsrbpack user

–lsrbrule user

–lsrbtarget user



–setrb senior

Options–comprules [–deprecation] [–profile] [–trace] rule_base

Compile the rules in the rule base specified by the rule_base argument intoProlog object files that the rule engine can process. A directory for eachrule base target is also created. Each directory contains a complete rulebase that can be loaded by a rule engine. Inactive rule sets are notcompiled.

Note: If you do not compile the rule base before attempting to load it, youwill get an error message.

rule_baseThe name of the rule base to compile.

–deprecationIssues a deprecation warning for every use of a deprecated Barocor rule language feature.

–profileEnables profiling for the rule base while compiling. To enable orsuppress profiling at the rule set or rule level within a rule base,see the profile directive information in the IBM Tivoli EnterpriseConsole Rule Builder’s Guide.

–trace Enables tracing for the rule base while compiling. To enable orsuppress tracing at the rule set or rule level within a rule base, seethe trace rule compiler directive information in the IBM TivoliEnterprise Console Rule Builder’s Guide.

–cprb [–classes] [–rulesets] [–rulepacks] [–targets] [–delete | overwrite] [–force]source destination

Copies an existing rule base to another existing rule base. If you do notspecify the –classes, –rulesets, –rulepacks or –targets arguments, the classsets, rule sets, rule packs, and rule base targets are all copied. The sourcerule base must be in a consistent state for it to be copied. You can skipconsistency checking with the –force argument.

Notes:

1. When a rule set or rule pack is copied from another rule base, youmust import it into a rule base target before the rule engine can use it.

2. If rule sets are copied, the inactive rule sets from the source rule baseare also copied to the destination rule base.

destinationThe name of the rule base to which information is copied.

source The name of the rule base from which information is copied.

–classesCopies event classes.

–deleteDeletes all existing files from the destination rule base beforewriting information from the source rule base.


–force Forces the source rule base to be copied even if this may cause rulebase inconsistency.

–overwriteDuplicate files are overwritten in the target rule base. By default,duplicate files are not copied.

–rulepacksCopies rule packs.

–rulesetsCopies rule sets.

–targetsCopies rule base targets.

–crtrb [–path path] [–force] rule_baseCreates a rule base on the event server in the current Tivoli ManagementRegion (TMR). If there is an existing rule base in path, the rule base ischecked for consistency and that rule base is used. You can skipconsistency checking with the –force argument. A rule base target namedEventServer is automatically created in the new rule base for the localevent server. You can define multiple rule bases at the server, but only onecan be loaded and active at a time.

Note: If you do not compile the rule base before attempting to load it, youwill get an error message.

rule_baseThe name of the rule base to create.

–force Forces the rule base to be created in path even if it contains anexisting rule base in an inconsistent state.

–path pathThe path where you want the new rule base located. If thisargument is not specified, the rule base is created in the user’scurrent working directory.

–crtrp rule_pack [–import rule_set ...] rule_baseCreates a rule pack in the rule base. A rule pack is a collection of rule sets.A rule pack may be imported into a rule base target just like a rule set.

rule_baseThe name of the rule base in which to create the rule pack.

rule_packThe name of the rule pack to create.

–import rule_set ...The name of one or more optional rule sets to import into the newrule pack. Separate multiple rule set names with a space. Inactiverule sets may not be imported into a rule pack. The rule sets areadded to the rule pack in the order in which you specify on thecommand line. The rule sets being imported into the rule packmust first have been imported into the rule base.

–crttarget target [–import {rule_pack | rule_set} ...] rule_baseCreates a rule base target in the rule base. The rule base target representsthe rule engine to which these rules will be distributed. The local eventserver is represented by the rule base target EventServer. This rule basetarget is created automatically when a rule base is created. When the rule


base is compiled, a complete rule base will be generated for each rule basetarget in the rule base. The AIM server will distribute and load each rulebase to the corresponding rule base target.

rule_baseThe name of the rule base in which to create this target.

target The name of the rule base target to create.

–import {rule_pack | rule_set} ...The name of one or more optional rule packs or rule sets toimport. You can specify both rule sets and rule packs at once.However, rule sets and rule packs cannot have the same namewithin a rule base. Separate multiple rule sets and rule packs witha space. Inactive rule sets may not be imported into a rule basetarget. Rule sets and rule packs are added to the rule base target inthe order in which you specify on the command line. The rule setor rule pack being imported into the rule base target must firstexist in the rule base.

–deltgtrule [rule_set | rule_pack] target rule_baseDeletes a rule set or rule pack from a rule base target.

rule_setThe name of the rule set to delete.

rule_packThe name of the rule pack to delete.

target The name of the rule base target from which the rule set or rulepack is to be deleted.

rule_baseThe name of the rule base from which the target is to be modified.


–delrb rule_base ...Delete one or more rule bases from the event server. Neither the rule basedirectory nor its contents are deleted.

rule_base ...The name of the rule base to delete. You must specify at least onerule base. Separate multiple rule bases with a space.

–delrbclass class_file [–force] rule_baseDeletes a class file from a rule base. An error message is issued if anyevent classes in the class file are referenced by any other classes or by anyrules. Specify the –force argument to delete the class file anyway.

Note: This option deletes the specified .baroc file from the rule base. Copythe .baroc file to a different location to save a copy for future use.

class_fileThe name of the class file to delete from the rule base specifiedwith rule_base.

rule_baseThe name of the rule base from which the class file is to bedeleted.

–force Deletes the class file even if it may cause rule base inconsistency.

–delrbpack rule_pack [–force] rule_baseDeletes a rule pack from a rule base. An error message is displayed if therule pack to be deleted is defined in a rule base target. Specify the –forceargument to delete the rule pack anyway.

rule_baseThe name of the rule base from which the rule pack is to bedeleted.

rule_packThe name of the rule pack to delete.

–force Delete the rule pack even if it may cause rule base inconsistency.


–delrbrule rule_set [–force] rule_baseDeletes a rule set from a rule base. An error message is displayed if therule set to delete is defined in a rule pack or a rule base target, or isinactive. Specify the -force argument to delete the rule set anyway.

Note: This option deletes the .rls file from a rule base for the specified ruleset. Copy the .rls file to a different location to save a copy for futureuse.

rule_baseThe name of the rule base from which the rule set is to be deleted.

rule_setThe name of the rule set to delete.

–force Delete the rule set even if it may cause rule base inconsistency.

–delrbtarget target rule_baseDeletes a rule base target from a rule base.

rule_baseThe name of the rule base from which the target is to be deleted.

target The name of the rule base target to delete.

–delrprule rule_set rule_pack rule_baseDeletes a rule set from a rule pack.

rule_baseThe name of the rule base in which the rule pack exists.

rule_packThe name of the rule pack from which the rule set is to be deleted.

rule_setThe name of the rule set to be deleted.

–deltgtdata data_file target rule_baseDeletes a supporting data file from a rule base target.

data_fileSpecifies the name of the file to be deleted from the named rulebase target. This must be the full name of the file in the rule basedirectory.

target Specifies the name of the rule base target from which to delete thedata file.

rule_baseSpecifies the name of the rule base that contains the target.


–imprbclass class_file [–encoding [encoding] ] [–before class_file | –after class_file][–force] rule_base

Imports a file of event class specifications (a .baroc file) into a rule base,appending it to the end of the class specifications unless otherwisespecified with arguments. An error message is displayed if the class set filecontains syntax errors, references to nonexistent event classes orenumerations, or if duplicate event classes or enumeration are defined. Ifthe classes in a class file are derived from classes in another file, import theclass files into the rule base in an order that preserves the inheritancestructure. For example, if class file B.baroc contains classes that are derivedfrom class file A.baroc, you must import class file A.baroc first.

class_fileSpecifies the name of the class file to import. This must be a pathto a .baroc file.

rule_baseThe name of the rule base to receive the imported class set.

–after class_fileSpecifies the name of the class file after which the imported classfile will be placed.

–before class_fileSpecifies the name of the class file before which the imported classfile will be placed.

–encoding [encoding]By default (when this option is not given), when importing a classfile into a rule base, the file is opened in UTF-8 character encoding.If this option is given without encoding, then the file is opened inthe default character encoding for the local machine. An alternatecharacter encoding may be specified with the encoding option. Formore information about international encodings, see theinternationalization section in the Tivoli Enterprise Installation Guide.

–force Imports the class file even if it may cause rule base inconsistency.

–imprbrule rule_file [–encoding [encoding] ] [–force] rule_baseImports a rule set file into the rule base. Because rule sets that have beenimported into the rule base must then be imported into a rule base targetbefore they are executed, the order that rule sets are imported into the rulebase is not important. The order in which rule sets are imported into a rulebase target specifies the order in which that particular rule engine willexecute the rules. An error message is displayed if the rule being importedreferences a non-existent event class. You can skip this consistencychecking by using the –force argument.

rule_baseThe name of the rule base to receive the imported rule set file.

rule_fileThe file name of the rule set to import to the rule base. This mustbe a path to a .rls file.

–encoding [encoding]By default (when this option is not given), when importing a classfile into a rule base, the file is opened in UTF-8 character encoding.If this option is given without encoding, then the file is opened inthe default character encoding for the local machine. An alternatecharacter encoding may be specified with the encoding option. For


more information about international encodings, see theinternationalization section in the Tivoli Enterprise Installation Guide.

–force Adds the rule set to the rule base even if a rule references anon-existent event class.

–imprprule rule_set [–before rule_set | –after rule_set] rule_pack rule_baseImports a rule set into a rule pack for the specified rule base. Inactive rulesets are not imported into rule packs.

rule_baseThe name of the rule base in which the rule pack lives.

rule_packThe name of the rule pack to receive the imported rule set. Therule pack must have been created with the –crtrp command optionfirst.

rule_setThe name of the rule set to import into the rule pack. The rule setmust have been imported into the rule base first.

–after rule_setSpecifies the name of the rule set after which the imported rule setwill be placed.

–before rule_setSpecifies the name of the rule set before which the imported ruleset will be placed.

–imptgtdata data_file target rule_baseImports a supporting data file to a rule base to be distributed to a rulebase target. This file will be distributed with the rule base in theTEC_RULES subdirectory. For example, a EIF configuration file or a Prologfact or data file might be imported as a supporting data file.

data_fileSpecifies the name of the file to be imported to the named rulebase target. This must be a path to the file.

target Specifies the name of the rule base target to receive the importeddata file.

rule_baseSpecifies the name of the rule base that contains the target.

–imptgtrule {rule_set | rule_pack} [{–before | –after} {rule_set | rule_pack}] targetrule_base

Imports a rule set or rule pack into a rule base target. Rule sets and rulepacks within a rule base cannot have the same name. Inactive rule sets arenot imported into rule base targets.

rule_baseThe name of the rule base that contains the rule base target.

rule_packThe name of the rule pack to import. The rule pack must havebeen imported into the rule base first.

rule_setThe name of the rule set to import. The rule set must have beenimported into the rule base first.


target The name of the rule base target to receive the imported rule set orrule pack. You must have first created the target with the –crttargetcommand option.

–after rule_set | rule_packSpecifies the name of the rule set or rule pack after which theimported rule set or rule pack should be located.

–before rule_set | rule_packSpecifies the name of the rule set or rule pack before which theimported rule set or rule pack should be located.

–loadrb [–use] rule_baseLoads a rule base onto the event server. This makes rule_base the currentlyactive rule base on the event server. The rule base must already be definedat the server, and any event class specification files and rule files in thedirectory must be valid. The loaded rule base replaces all event classspecifications and rules currently defined at the server. Only one rule basecan be active at a time. Loading another rule base overwrites the currentlyactive rule base. If you do not compile the rule base before attempting toload it, you will receive an error message.

rule_baseThe name of the rule base to load.

–use Activates the rule base immediately upon loading. If event classchanges were made to the rule base, restart the event server afterloading for the event class changes to take affect.

–lscurrbLists the name of the currently loaded rule base.

–lsrb [–path] [rule_base ...]Lists the rule bases that are currently defined on the event server. Manyrule bases may be defined on the event server, though only one can beloaded and active. Use the wrb –lscurrb command to display the currentlyloaded rule base. A rule base has a unique name and a path name thatpoints to a directory that contains event class definition files (.baroc), rulefiles (.rls), rule pack files (.rpk) and rule base target files (rule_sets_target).

rule_baseSpecifies the names of individual rule bases or a Perl regularexpression. By default, all rule bases are listed. Separate multiplerule base names with a space.

–path Lists the path of the rule base directory as well as the rule basename. By default, only the name of the rule base is displayed.

–lsrbclass [class_name ...] [–detailed] rule_baseLists the event classes in the specified rule base. Use regular expressions torestrict the list of event classes to be displayed.

class_name ...Specifies the names of individual event classes or a Perl regularexpression. This argument restricts the list of classes shown. Bydefault, all event classes in the specified rule base are displayed.Separate multiple event class names with a space.

rule_baseThe name of the rule base to view.


–detailedSpecifies detailed output. In addition to displaying class names, allslot values for each class are displayed.

–lsrbpack [rule_pack ...] [–detailed] rule_baseLists the names of the rule packs in the specified rule base.


rule_pack ...The name of a particular rule pack or a Perl regular expression. Ifyou do not specify this argument, all rule packs are displayed.Separate multiple rule packs with a space.

–detailedLists the rule sets in each rule pack.

–lsrbrule [rule_file ...] rule_baseLists the names of the rule set files which have been imported into thespecified rule base. Use regular expressions to restrict the list of rules to bedisplayed.


rule_file ...The name of a specific rule set file or a Perl regular expression. Ifyou do not specify this argument, all rule set files are displayed.Separate multiple rule set file names with a space.


–lsrbtarget [target ...] [–detailed] rule_baseLists the names of the rule base targets in the specified rule base.


target ...The name of a particular rule base target or a Perl regularexpression. If you do not specify this argument, all targets in therule base are displayed. Separate multiple targets with a space.

–detailedLists the rule sets and rule packs for each target.

–setrb [–name name] [–path path [–force]] rule_baseSets properties of an existing rule base. You can change the name, thedirectory containing rule base files, or both. If a new path is specified andthere is an existing rule base in path, the rule base is checked forconsistency. You can skip consistency checking with the –force argument.

rule_baseThe name of the rule base to be modified.

–force Forces the path to be changed to path even if it contains an existingrule base in an inconsistent state.

–name nameThe new name for the rule base.

–path pathSpecifies a new rule base directory for the rule base.

ExamplesThe following example creates a new rule base named MyRuleBase in the/RuleBases/MyRuleBase directory:wrb -crtrb -path /RuleBases/MyRuleBase MyRuleBase

The following example imports the tecad_nt.baroc class set into the rule baseMyRuleBase and places it after the tecad_logfile.baroc file:wrb -imprbclass tecad_nt.baroc -after tecad_logfile.baroc \MyRuleBase

The following example creates a rule pack named DefaultRules in the rule baseMyRuleBase and imports the rule sets ov_default.rls and log_default.rls into thenewly created rule pack:wrb –crtrp DefaultRules -import ov_default \log_default MyRuleBase

The following example creates a rule base target named SAPServer:wrb -crtarget SAPServer MyRuleBase

The following example imports the rule pack DefaultRules.rpk into the SAPServerrule base target:wrb -imptgtrule DefaultRules SAPServer \MyRuleBase

The following example imports the rule set tecad_snaevent.rls into the SAPServerrule base target and places it at the end of the list of rule sets to load:


wrb -imptgtrule tecad_snaevent.rls SAPServer \MyRuleBase

The following example displays detailed information about the classes defined inthe tecad_nt.baroc file in the rule base MyRuleBase:wrb -lsrbclass tecad_nt.baroc -detailed MyRuleBase

The following example compiles the MyRuleBase rule base with tracing enabled:wrb -comprules -trace MyRuleBase

The following example removes a rule set, MyRuleSet, from the target MyTarget:wrb -deltgtrule all_instances MyTarget MyRuleSet

After the rule set has been removed from the target, it can be removed from itsrule base as follows:wrb -delrbrule all_instances MyRuleSet


wrbupgrade

Upgrades rule bases and BAROC files created with Tivoli Enterprise Consoleversions prior to 3.7 to the format for version 3.7 and later.

Note: This command is located in the $BINDIR/TME/TEC directory, rather thanin the standard location ($BINDIR/BIN) for other IBM Tivoli EnterpriseConsole commands.

When working with a rule base that was created by someone else, you must haveread and write access to the top-level rule base directory and to the following rulebase files and subdirectories:v TEC_RULES/

– rule_sets

– rule_sets_EventServer

– rule_sets_target

– rule_packs

v TEC_CLASSES/

– .load_rules

You must also have read access to all other files in the rule base directory.

Syntaxwrbupgrade [ —f —p path_to_rulebase | —n rulebase_name]

DescriptionYou only need to execute the wrbupgrade command if you want to use rule packsand rule base targets with rule bases that were created with Tivoli EnterpriseConsole versions prior to version 3.7. You do not need to execute this command touse the wrb command.

Authorizationuser

Options—f Specifies that the wrbupgrade command should be executed even if the

specified rule base has already been upgraded. This option is only validwith the -p path_to_rulebase option.

—n rulebase_nameSpecifies the name of the rule base to upgrade.

—p path_to_rulebaseSpecifies the path to the rule base to upgrade.


wsendresp

Displays a message on an operator’s desktop.

Syntaxwsendresp operator [host:]filepath

DescriptionSends the contents of the specified file in a pop-up window to the specifiedconsole. The wsendresp command can also be invoked by a rule to display amessage to an operator. For example, when a HOST_DOWN event isacknowledged, a rule can invoke the wsendresp command to inform an operatorof the proper course of action for the affected host. The event server must berunning for this command to execute successfully and the specified operator’sconsole must be up.

Authorizationadmin

Options[host:]filepath

Specifies the path name of the file containing the desired message. You canoptionally specify the host that contains the file.

Note: You must use forward slash characters (/) for directory separators inthe filepath argument.

operatorSpecifies the name of a Tivoli Enterprise Console operator.

ExamplesThe following example displays the response message contained in the/usr/home/carl/fixhost file to the administrator Cathy:wsendresp Cathy /usr/home/carl/fixhost


wsetac

Modifies an adapter configuration record for an adapter configuration profile(ACP).

Syntaxwsetac adapter_details key profile

DescriptionThe wsetac command allows an existing record in an ACP to be modified.

Each adapter type on each ACP may be supported by default policies to supplyinitial values for parts of the configuration not given by a waddac invocation.Similarly, validation policies may be present to ensure that a given configuration isvalid according to the needs of the event adapter implementation, local installationparticulars, and security concerns.

The wsetac command writes the key value for the new adapter configurationrecord to standard out. The key value later can be used to modify or remove therecord.

Authorizationadmin



–a Indicates that values given on the command line for the “list”attributes (environment, filters, distribution actions, and behavior)should be appended to the current values on the profile instead ofcompletely replacing current values. Note that the presence of –aaffects all –e, –f, –D, and –b arguments on a given invocation ofthe command. If some of those attributes are to be replaced andothers augmented, then several invocations of the command willbe necessary.

When –a is present and new values are added to one or more ofthe list-type attributes, duplicates are removed as appropriate tothe nature of those attributes modified. For the environment andbehavior attributes, duplicate assignments to the same variable areeliminated (with new assignments overriding old, of course). Fordistribution actions, multiple copies onto the same path name areremoved. For filters, duplicate entries are removed.




ignore ignore all failures

report report failures but continue with distributionactivity, the default behavior

abort abort distribution

expandControls whether references to endpoint context variablesof the form ${variable} within attributes of the recordshould be expanded by the endpoint code when the profileis distributed. The value of the variable may be no todisable expansion, yes to enable it for all attributes (thedefault behavior), or a comma-separated list of attributenames to selectively expand only within the values ofthose attributes.








Multiple –D options can be supplied.




–f filterDefines an event filter to be placed in the adapter configurationfile. The filter string must be of the following form:Attribute=Value;Attribute=Value;Attribute=Value;...

The entire string needs to be quoted to prevent the command-lineinterpreter from reacting to the semicolons. To create a filter that isinitially in a disabled state, the string may be prefixed with #ilter:.Thus,wsetac -a -f ’#ilter:Class=EVENT;’ 12 acp1

adds a single disabled filter record to with key 12 of profile acp1.(Enabled filters may optionally be prefixed with Filter:.)

Many –f options can be supplied.


The entire string needs to be quoted to prevent the command-lineinterpreter from reacting to the semicolons. To create a filter cachethat is initially in a disabled state, the string may be prefixed with#ilterCache:. Thus,wsetac -f ’#ilterCache:Class=LogFile_Base;’ acp1


Many –F options can be supplied.



–m prefiltermodeDefines the PreFilterMode to be placed in the adapterconfiguration file for Windows and NetWare adapters. The validvalues are IN, in, OUT, and out. The default is OUT. If you useIN or in, you must also supply the –p parameter to specify aPreFilter. The following example shows a command using thisargument:wsetac -a -m ’OUT’ -p ’Log=System’ 1 ACPprofile

–p prefilterDefines the PreFilters to be placed in the adapter configuration filefor Windows and NetWare adapters. You must specify at least thelog specification and, optionally, the EventId, EventType, andSource specifications. The following example shows a commandusing this argument:wsetac -a -p ’Log=Security’ 1 ACPprofile

–t targetThe name of the primary adapter configuration file, commonlyknown as the .conf file. The complete file name for this file isformed by appending target to the value given for dir with a –doption. (Note that default policy will generally be established to settarget and targdir to appropriate values.)

–u uid The user ID value to be used for distributed files and commandson subscriber endpoints. The uid may be given as a name ornumeric ID value.

key Gives the key of the existing adapter configuration record to modify. Youcan see the key value in the upper right side of the ACP entry panel or byusing the wlsac command.

profile The ACP to which the new adapter configuration record is to be added. Ifthe name includes spaces, enclose the whole name in quotes.

ExamplesThe following example changes the ServerLocation value in the .conf file to quasarfor key 0 in the ACP profile named quasar:wsetac -e ServerLocation=quasar 0 ACP@quasar

See Alsowdelac, waddac, wlsac


wsetaddflt

Adds or sets an adapter configuration record for an adapter configuration profileor an adapter type default.

Syntaxwsetaddflt adapter_details type

DescriptionThe wsetaddflt command also creates or modifies an ACP record, but instead ofinstalling it on a profile object, the record is installed as the global default for thegiven event adapter type. The values of the attributes in the record can be fetchedlater with the wlsaddflt command from within policy scripts to obtain the basicdefault information for an adapter type. Policy scripts can then apply filtering ormodifications. Each ACP contains the following configuration information for oneor more event adapters:v Location of configuration filesv Adapter environment variable definitions, including such things as the location

of the event serverv Event filter definitionsv Additional file distribution requests

Each adapter type on each ACP may be supported by default policies to supplyinitial values for parts of the configuration not given by a waddac invocation.Similarly, validation policies may be present to ensure that a given configuration isvalid according to the needs of the event adapter implementation, local installationparticulars, and security concerns.

Authorizationsenior




–a Indicates that values given on the command line for the “list”attributes (environment, filters, distribution actions, and behavior)should be appended to the current values on the profile instead ofcompletely replacing current values. Note that the presence of –aaffects all –e, –f, –D, and –b arguments on a given invocation ofthe command. If some of those attributes are to be replaced andothers augmented, then several invocations of the command willbe necessary.

When –a is present and new values are added to one or more ofthe list-type attributes, duplicates are removed as appropriate tothe nature of those attributes modified. For the environment andbehavior attributes, duplicate assignments to the same variable areeliminated (with new assignments overriding old, of course). Fordistribution actions, multiple copies onto the same path name areremoved. For filters, duplicate entries are removed.

(The –a option is for wsetac and wsetaddflt.)




ignore = ignore all failures

report = report failures but continue with distributionactivity, the default behavior

abort = abort distribution

expandControls whether references to endpoint context variablesof the form ${variable} within attributes of the recordshould be expanded by the endpoint code when the profileis distributed. The value of the variable may be no todisable expansion, yes to enable it for all attributes (thedefault behavior), or a comma-separated list of attributenames to selectively expand only within the values ofthose attributes.








Many –D options can be supplied.




–f filterDefines an event filter to be placed in the adapter configurationfile. The filter string must be of the following form:Attribute=Value;Attribute=Value;Attribute=Value;...

The entire string needs to be quoted to prevent the command-lineinterpreter from reacting to the semicolons. To create a filter that isinitially in a disabled state, the string may be prefixed with #ilter:.Thus,wsetaddflt -a -f ’#ilter:Class=EVENT;’ 12 acp1

adds a single disabled filter cache record to the 12 of profile acp1.(Enabled filters may optionally be prefixed with Filter:.)

Multiple –f options can be supplied.



The entire string needs to be quoted to prevent the command-lineinterpreter from reacting to the semicolons. To create a filter cachethat is initially in a disabled state, the string may be prefixed with#ilterCache:. Thus,wsetaddflt -F ’#ilterCache:Class=LogFile_Base;’ acp1


Multiple –F options can be supplied.


–m prefiltermodeDefines the PreFilterMode to be placed in the adapterconfiguration file for Windows and NetWare adapters. The validvalues are IN, in, OUT, and out. The default is OUT. If you useIN or in, you must also supply the –p parameter to specify aPreFilter. The following example shows a command using thisargument:wsetaddflt -a -m ’OUT’ -p ’Log=System’ 1 ACPprofile


–p prefilterDefines the PreFilters to be placed in the adapter configuration filefor Windows and NetWare adapters. You must specify at least thelog specification and, optionally, the EventId, EventType, andSource specifications. The following example shows a commandusing this argument:wsetaddflt -a -p ’Log=Security’ 1 ACPprofile

–t targetThe name of the primary adapter configuration file, commonlyknown as the .conf file. The complete file name for this file isformed by appending target to the value given for dir with a –doption. (Note that default policy will generally be established to settarget and targdir to appropriate values.)

–u uid User ID value to be used for distributed files and commands onsubscriber endpoints. The uid may be given as a name or numericID value.

type Gives the adapter type for the new adapter or (for wsetaddflt) the adaptertype whose global defaults are to be set. The adapter type is generallyused to drive the workings of default and validation policies. If unknownadapter types are given to waddac, validation policies on the target ACPmay reject the new record. To see the available types, use the wlsaddfltcommand.


Examples1. The following example sets the default values for type tecad_hpov:

wsetaddflt \-d ’$TECADHOME/etc’ \-t "tecad_hpov.conf" \-c "tecad_hpov Configuration" \-e "ServerLocation=@EventServer" \-e "EventMaxSize=4096" \-e "WellBehavedDaemon=TRUE" \-e ’BufEvtPath=$TIVOLIHOME/tec/${AC_TYPE}.cache’ \-e ’HPOVFilter={CORR{default}} .*’ \-D "!/opt/OV/bin/ovstop tecad_hpov" \-D "tecad_hpov.cds=$ACPHOST:$REPOSITORY/tecad_hpov.cds" \-D "tecad_hpov.err=$ACPHOST:$REPOSITORY/tecad_hpov.err" \-D "tecad_hpov.oid=$ACPHOST:$REPOSITORY/tecad_hpov.oid" \-D "!!/opt/OV/bin/ovstart tecad_hpov" \-b "rm_on_del=yes" \-b "run_actions=yes" \-b "action_fail=report" \-b "expand=yes" \-u "0" -g "0" \tecad_hpov

2. The following example checks to see if a new default type that you havecreated is present:wlookup -ar ACPdefaults

3. The following example deletes the added default type test_adapter:wregister -ur ACPdefaults test_adapter

4. The following example changes the default adapter settings that affect alladapters:wsetaddflt \

-t ’tecad_$(AC_TYPE).conf’ \-d ’$TECADHOME/etc’ \-c ’Generic Adapter Defaults’ \__generic__

Note: It is recommended that you do not delete the __generic__ ACP default,as this is the base definition for all adapter types.

See Alsowdelac, wlsac


wsetadenv

Installs a list of recognized Event Integration Facility (EIF) environment variablesfor an adapter type.

Syntaxwsetadenv [–a] variable_name... type

DescriptionThe wsetadenv command provides the Adapter Configuration Facility with a listof the EIF environment variables that are recognized by the adapter but are notpart of the common set of variables used directly by the EIF. The variable namesregistered with wsetadenv are made available to users of the AdapterConfiguration Facility graphical user interface when configuring environmentvariable lists. The list can also be used by profile validation scripts.

The Adapter Configuration Facility itself installs the list of basic EIF variablesunder the type “__generic__”. This list should not be modified.

Authorizationsenior

Optionstype The adapter type. If no environment or other type information has yet

been installed, then wsetadenv automatically registers the type. To see theavailable types, use the wlsaddflt command.

variable_name...Zero or more variables recognized by the given adapter type. It is notwrong to install any of the standard EIF variables here, but it isunnecessary. Separate multiple variable_names with a space.

–a Instructs wsetadenv to append the variable names to the list alreadyconfigured for the given adapter type. Normally, wsetadenv completelyreplaces an existing list.

ExamplesThe following example adds the environment variables SNMP_PORT andSNMP_TRAP_PORT to the SNMP adapter:wsetadenv SNMP_PORT SNMP_TRAP_PORT tecad_snmp

See Alsowlsadenv, waddac, wsetadgui, wsetadval


wsetadgui

Installs a link from the Adapter Configuration Facility (ACF) graphical userinterface (GUI) to a type-specific configuration tool.

Syntaxwsetadgui class name catalog text key type

DescriptionThe wsetadgui command provides the ACF with the name of an object thatsupplies a standard interface for performing extended type-specific graphicalconfiguration. The command also supplies a label to be used on the “launch”button on the ACF GUI that the user may click to invoke the extendedconfiguration tools.

Because Tivoli Enterprise Console event adapters may vary widely in their natureand scope, the ACF itself does not attempt to provide configuration tools for anydetails beyond the common subset of EIF configuration. However, becausegraphical configuration tools might be desirable for a variety of adapter types, theACF graphical interface can effectively be extended by constructing a configurationtool for a specific adapter and then hooking it up to the ACF with wsetadgui.

A type-specific configuration tool must be implemented as a method on a TivoliEnterprise object. The method must be called acf_extension and must match thefollowing IDL signature:TMF_CCMS::Database::nmval_listacf_extension(in TMF_Types::StringList uienv,in string prof_name, in string key,in TMF_CCMS::Database::nmval_list);

The ACF user interface will invoke the acf_extension method upon user request,passing the method the profile record as currently configured along with therecord key and the profile name. The user interface server environment is alsopassed so that the configuration tools will know where to present the dialogs. Theextended configuration tool can perform any necessary modifications to the record,returning a new version of the record when finished. Usually, environmentvariables and distribution requests will be the attributes of the record mostcommonly modified, but anything can be modified.

Authorizationsenior

Optionscatalog The name of the message catalog that contains the message to be used as

the “launch” button label on the ACF GUI.

class The name of the Tivoli Enterprise class of which the configuration object isa member.

key The message catalog key for the “launch” button label.

name The name of the configuration object (the object that supports theacf_extension method for the adapter type).


text The default text for the “launch” button label, used if the catalog cannot befound.

type The adapter type. If no environment or other type information has yetbeen installed, then wsetadenv automatically registers the type. To see theavailable types, use the wlsaddflt command.

ExamplesThe following example adds the Logfile Format Editor to the Tivoli EnterpriseConsole server GUI:wsetadgui LogfileConfiguration LogfileConfiguration _x_ \"Logfile Format Editor..." 1 tecad_logfile

See Alsowlsadgui, waddac, wsetadenv, wsetadval


wsetadval

Installs validation information for an adapter type.

Syntaxwsetadval file attribute type

DescriptionThe wsetadval command informs the Adapter Configuration Facility (ACF) thatthe named file contains validation information to be used in validating the value ofthe named attribute on adapter configuration profile records.

Generally, the validation information consists of all or part of a script of somekind. Validation policy scripts installed on adapter configuration profiles can laterextract and use the installed validation information.

The simplest form of an adapter configuration profile validation script is asfollows:#!/bin/sh

wlsadval "$1" "$2" | sh –s "$3"

Under this scheme the contents of the validation record are used directly as thereal validation script. The policy method is written so that it expects the attributename passed in as the first argument, and the record type as the second; see themanual page for the wlsadval command. The third argument is the value to bevalidated, and that is transmitted to the installed script.

Other ways of using the facility supplied by wsetadval are possible. Whatevermechanism is chosen, however, should be used consistently by all adapter types sothat policy scripts stored on profile objects scattered throughout the installation canremain generic. As shipped, the ACF validation policies expect that the installedadapter validation information will be shell scripts.

Authorizationsenior

Optionsattribute

The name of the attribute to which the validation information applies. Theattributes on an Adapter Configuration Profile normally include thefollowing:

ACPbhvSequence of profile behavior variables, separated by newlines.

ACPcommentComment field.

ACPdistSequence of distribution requests, separated by newlines.

ACPevSequence of environment variables, separated by newlines


ACPfltSequence of filter definitions, separated by newlines.

ACPgidGroup ID for endpoint actions.

ACPtargdirThe configuration installation directory.

ACPtargetThe target primary configuration file name.

ACPtypeThe type of the record; this generally needs no validation.

ACPuidThe user ID for endpoint actions.

Other attributes may be present if they are added to the profile with TivoliAEF tools.


file Name of the file containing the validation information. If file is a singledash, then wlsadval reads the validation information from its standardinput.

type The adapter type for which the validation information is to be installed. Tosee the available types, use the wlsaddflt command.

ExamplesThe following example adds the validation information from the script infile to theattribute ACPuid for an adapter of type tecad_logfile_hpux10:wsetadval - ACPuid tecad_logfile_hpux10 <<\infilecase "$1" in0 root ) exit 0;;*) exit 1;;esacinfile

See Alsowlsadval, waddac, wsetadenv, wsetadgui


wsetaeenv

Modifies environment variables stored on adapter configuration profile (ACP)endpoints.

Syntaxwsetaeenv [–a] [–d name...] name=value... endpoint

wsetaeenv [–a] [–d name...] –i file endpoint

Description

Note: Use this command on managed nodes only; do not use this command on anendpoint.

The wsetaeenv command allows the list of adapter configuration environmentvariables stored on a profile endpoint object to be set or modified. The new valueswill be used during the next adapter ACP distribution to the named endpoint.

ACPs use the environment information stored on endpoints by referring to them inrecord field values. References to environment variables are of the form $[name].When the profile is received at the endpoint during distribution, the environmentvariable references are expanded so that the actual value of the variable is used inwhatever context the reference was made. (Expansion is done under control of theexpand behavior flag; see the manual page for the waddac commands.)

In addition to the list of environment variables established under user control withwsetaeenv, some variables are created automatically by the adapter configurationendpoint code. These variables describe the endpoint object, the ACP containingthe record where a reference is made, and the record itself. These automaticenvironment variables are available for use in exactly the same way user-controlledvariables are. The list of automatic environment variables includes the following:

ACPEP_NAMEThe name of the endpoint object. Most commonly, the endpoint object is aTivoli managed node object.

ACPEP_CLASSThe class name of the endpoint object.

ACPEP_OIDThe object identifier of the endpoint object.

ACPEP_NODEThe object ID for the managed node where the endpoint resides. In thecommon case that the endpoint is the managed node, then this object ID isof course the same as ACPEP_OID.

ACP_NAMEThe name of the adapter configuration profile containing the record wherea reference to the variable is made.

ACP_ADMINThe user name of the administrator responsible for distributing the profile.

ACP_PRFMGRThe name of the profile manager object from which the profile was


distributed. (Note that this might be the name of a profile endpoint object,in which case it would be the same as ACPEP_NAME.)

AC_TYPEThe type of the record containing the variable reference.

AC_ACTIONThe activity being performed for the record, either UPDATE or DELETE.

AC_KEYThe record key of the record containing the variable reference.

AC_TARGDIRThe contents of the target directory field of the record containing thevariable reference.

The automatic environment variables are refigured as each record of the profile isprocessed (though clearly the ACPEP variables will not change), so, for example,references to AC_TYPE in three records of a single profile yield three differentvalues if the records are of differing types.

Authorizationsenior

Optionsendpoint

The name of the endpoint object to be modified. The endpoint object canbe referenced with the standard @Classname:label notation. If the standardnotation is not used, endpoint is assumed to be a reference to a managednode object.

name=value ...Creates an environment variable name with the given value on the namedendpoint. Separate multiple name=value expressions with a space.

–a Indicates that the environment variable assignments should be added tothe list already on the endpoint object (except that duplicates are avoided).Without –a, the list of variables given on the command line becomes thenew list on the endpoint, and all former variables are removed. If no newvariables are listed but one or more –d options are given, then the –doptions are processed and other variables are left unchanged. If no newvariables are given and no –d options are present, then the entireuser-controlled environment of the endpoint object is cleared.

–d name ...Deletes the named variable from the endpoint. Many –d options can begiven. Separate multiple names with a space.


–i file Directs that the list of environment variables to be installed on theendpoint should be read from the named file instead of from the commandline. Variable definitions should appear in the file, one per line. If file is asingle dash, then the list is read from the standard input to wsetaeenv.

ExamplesThe following example adds the environment variable BufEvtMaxSize to theprofile endpoint object of endpoint boston-box:wsetaeenv -a BufEvtMaxSize=500000 @Endpoint:boston-box

See Alsowaddac, wdelac, wdistrib (in the IBM Tivoli Management Framework ReferenceManual), wlsaeenv


wsetemsg

Modifies an event.

Syntaxwsetemsg [–t status [–f status] ] [–r severity] [attribute=value...] console event_ID

DescriptionThe wsetemsg command modifies the status, severity, or other attribute values ofan existing event. You must specify the event by the console that received it aswell as its event ID number, and you must be assigned as an operator to thatconsole.

Use the wlsemsg command to display a list of the event ID numbers.

AuthorizationThe authorization role required depends on which flags are used. The followingtable indicates the required roles:


–f admin or senior

–r user

–t user

Optionsconsole Specifies the name of the event console to use.

event_IDSpecifies the ID of the event to be modified. The event ID is comprised ofevent_handle, server_handle, and date_reception.

attribute=value...Assigns a value to any valid attribute. The attribute (attribute) must be theone defined for the event class. Separate multiple attribute=valueexpressions with a space.

–r severityChanges the severity to FATAL, CRITICAL, MINOR, WARNING,HARMLESS, UNKNOWN, or to a custom value.

–t status [–f force]Changes the status to OPEN, CLOSED, RESPONSE, ACK, or to a customvalue.

Note: Do not change the status of an event from ACK to OPEN.

–f forceForces an event to change status from CLOSED to OPEN, ACK, orRESPONSE.

ExamplesThe following example acknowledges event 11782052457 for event console“Network Events”:


wsetemsg –t ACK "Network Events" 11782052457

See Alsowlsemsg, wpostemsg


wsetesvrcfg

Sets the configuration parameters for the event server. You must stop and restartthe event server to put these parameters into effect.

Syntaxwsetesvrcfg [–S server] [–b events] [–c events] [–e [seconds] ] [–k seconds] [–mseconds] [–n seconds] [–r [seconds] ] [–t [file] ]

DescriptionThe wsetesvrcfg command sets configuration parameters for the event server. Theserver in the local Tivoli Management Region (TMR) is modified unless anotherserver is specified. You must specify at least one option, otherwise the commandreturns an error.

The server can keep a number of logs (such as events and event modifications).The logs are time-limited; at the end of the specified time, the log is deleted and anew one begun. They are not intended to be a substitute for system logs. Use themfor testing and short-term diagnostics.

Authorizationsenior

Options–b events

Specifies the maximum number of events to be buffered in the receptionbuffer while the rule engine processes other events. The default is 500events.

–c eventsSets the event cache to the number of events specified by events. Thedefault is 1000 events. It should be large enough to handle a peak numberof pending events. If the cache is too small, the server will do a forcedcache cleaning of the oldest events.


–e secondsSpecifies the number of seconds to keep logged events in the reception log.If the number of seconds is not specified, logging is turned off. The defaultis 84600 seconds.

This setting is not automatically enforced, but rather is used by theClean_Database task in the T/EC Tasks library. This task may be executeddirectly or scheduled as a job.

–k secondsRetains closed events going back the specified number of seconds. Thedefault value is 84600 seconds.

–m secondsSpecifies the number of seconds allowed for the event server to initialize.The default is 300 seconds.

–n secondsSpecifies the number of seconds to keep events that have not been closed.The default is 15552000 seconds.


–t file Specifies the path name of the trace file to use for tuning and debuggingrules. If a path is not specified, tracing is turned off. The default file is/tmp/rules.trace.

Note: After you have specified the trace filename, you must restart theevent server.

ExamplesThe following example sets the event server cache size to 1536 events for theserver in the AcmeTMR TMR:wsetesvrcfg –c 1536 –S @EventServer#AcmeTMR

See Alsowlsesvrcfg


wsetsrc

Resets event source attributes.

Syntaxwsetsrc [–S server] [–b bitmap] [–l label] [–n name] source

DescriptionThe wsetsrc command sets the name, bitmap, or label for a source registered onthe event server. Use the wlssrc command to display a list of defined sources.

Note: You must specify at least one of the optional arguments (–b, –l, –n, or –S).

Authorizationsenior

Optionssource Specifies the source to be modified.

–b bitmapSpecifies the bitmap to use for a source. The specified bitmap must be abitmap that is stored on the event server.

–l label Specifies the label to use to identify the source on an event console. Bydefault, the value specified by the source argument is used for the label.

–n nameRenames the source to name, which must be a unique source name. If itduplicates an existing name, an error is reported. The source name mustmatch the name of the source as specified in an event adapter’s .cdsconfiguration file.


ExamplesThe following example sets the label of the LOGFILE source to syslog anddesignates the myNetBitMap file as the default bitmap:wsetsrc –b myNetBitMap –l syslog LOGFILE

See Alsowcrtnvgroups, wdelsrc, wlssrc


wstartesvr

Starts the event server.

Syntaxwstartesvr [–S server]

DescriptionBy default, the wstartesvr command starts the event server in the local TivoliManagement Region (TMR). The event server reads configuration files, thedatabase of events, and loads the rule base. The event cache is loaded with eventsbased on time and buffer size parameters, and QUEUED and WAITING events (ifthere were events in these states when the server was last shut down) are loadedinto the reception buffer. Then the event server makes itself available forcommunication with event adapters and consoles. It begins processing QUEUEDand WAITING events and incoming events immediately.

Once the event server is running, administrators can use their event consoles.

If an event server goes down, any consoles that were connected to it areautomatically reconnected when the server is restarted.

Authorizationsenior

Options–S server

Specifies the name of the event server in name registry format. The defaultis the local event server. To specify a remote server, enter@EventServer#tmr, where tmr is the name of a Tivoli Management Region(TMR).

ExamplesThe following example starts the local event server:wstartesvr

See Alsowstopesvr


wstatesvr

Displays the status of an event server.

Syntaxwstatesvr [–S server]

DescriptionThe wstatesvr command displays the status of the event server.

Authorizationuser

Options–S server

Specifies the name of an event server in name registry format. The defaultis the local event server. To specify a remote server, enter@EventServer#tmr, where tmr is the name of a Tivoli Management Region(TMR).

ExamplesThe following example displays the status of the local event server:wstatesvr

See Alsowstartesvr, wstopesvr


wstopesvr

Stops the event server.

Syntaxwstopesvr [–S server]

DescriptionThe wstopesvr command stops the event server in the local Tivoli ManagementRegion (TMR).

If an event server goes down, any consoles that were connected to it areautomatically reconnected when the server is restarted.

Authorizationsenior

Options–S server

Specifies the name of the event server in name registry format. The defaultis the local event server. To specify a remote server, enter@EventServer#tmr, where tmr is the name of a Tivoli Management Region(TMR).

ExamplesThe following example stops the local event server:wstopesvr

See Alsowstartesvr


wstoptecgwStops the Tivoli Enterprise Console gateway.

Syntaxwstoptecgw

DescriptionThe wstoptecgw command stops a Tivoli Enterprise Console gateway that servicesendpoints. The Tivoli Enterprise Console gateway will restart automatically uponreceipt of an event, so there is no corresponding command to start the gateway.This command must be executed in the shell sourced on the endpoint installed onthe host (managed node) that contains the gateway.

To get the wstoptecgw command on the shell sourced on the endpoint installed onthe host (managed node) that contains the gateway, do the following:1. Install Adapter Configuration Profile (ACP) on the managed node to act as the

Tivoli Enterprise Console gateway.2. Create an endpoint on that managed node.3. Create an ACP entry for the tec_gateway configuration file.4. Distribute the tec_gateway ACP to the endpoint. The wstoptecgw command

will now reside in the $LCF_BINDIR/../bin/interp/bin directory on thisendpoint.

Authorizationuser


wtdbclear

Clears events from the event database.

Syntaxwtdbclear [–e] [–f] [–l] [–c classname] [–r severity] [–s status] –t seconds [–a records][-p TRUE | FALSE]

DescriptionThe wtdbclear command deletes events from the reception log, event repository orboth. Which tables it deletes rows from depends on the option specified.

The wtdbclear command must be executed from the event server.

Authorizationsenior

Options–a records

A commit is performed after x number of records are deleted.

–c classnameClears events with the specified class name.

Note: You cannot use the this option when clearing reception logs with the–l option.


–e Deletes events in the event repository, task repository, and extended eventattribute table. You must use the –t option to specify the age of the eventsto be deleted.

–f Forces deletion of QUEUED and WAITING events from the reception log.

Note: Never use this option while the Tivoli Enterprise Console server isrunning.

–l Deletes events in the reception log. You must use the –t option to specifythe age of the events to be deleted.

Note: You cannot use the –c, –r, or –s options when clearing the receptionlog with this option.

–p TRUE | FALSEIndicates whether the stored procedure, tec_p_clear_events, should becalled. The default is TRUE. The tec_p_clear_events procedure improvesthe runtime performance of wtdbclear. -

–r severityClears events with the specified severity. The valid default values areFATAL, CRITICAL, MINOR, WARNING, HARMLESS, and UNKNOWN.

Note: You cannot use the this option when clearing the reception log withthe –l option.

–s statusClears events with the specified status. The valid default values are OPEN,CLOSED, RESPONSE, and ACK.

Note: You cannot use the this option when clearing the reception log withthe –l option.

–t secondsDeletes events that are older than the specified number of seconds. Thisoption is required.


ExamplesThe following example deletes all events from the event repository:wtdbclear –e –t 0

The following example clears the entire database:wtdbclear –elf –t 0

The following example disables the use of the stored procedure:wtdbclear -elt 0 -p FALSE

See Alsowtdumper, wtdumprl, wtdumptr, wdbmaint.sh


wtdbclear.pl

Clears events from the event database.

Syntaxwtdbclear.pl [–e] [–f] [–l] [–c classname] [–r severity] [–s status] –t seconds [–a records][-R rim_name] [-D]

DescriptionThe wtdbclear.pl command deletes events from the reception lkog, eventrepository or both. Which tables it deletes rows from depends on the optionspecified.

Note: wtdbclear.pl is a Perl script that truncates tables when the arguments –left 0are used. This command is similar to the binary version of wtdbclear butclears the tables more quickly.

If wtdbclear.pl is executed from a node other than the Tivoli Enterprise Consoleserver, it uses the time from the local machine to determine which events to clear,and this might cause unexpected behavior. It is recommended that you do notexecute the wtdbclear.pl script during peak operational hours.

For example, if the time on the node is 9:00 and the Tivoli Enterprise Consoleserver is 9:30, a wtdbclear.pl –let 0 command executed from the node clears eventsreceived prior to 9:00. The last 30 minutes of events remain in the database.Running wtdbclear.pl on the Tivoli Enterprise Console server would completelyclear the database.

Note: This command is being deprecated with the IBM Tivoli Enterprise Console,version 3.8 release and might not be available in future releases. Use thewtdbclear command instead. The wtdbclear.pl command should only beused in the following situations:v If you use an IBM DB2 database and the C compiler is not installed or is

not configured for the database serverv If you use an IBM DB2 database and the tec_p_clear_events stored

procedure is not installed

Authorizationsenior

Options–a records

A commit is performed after the specified number of records are deleted.

–c classnameClears events with the specified class name.

–D Turns on tracing. When this option is used, tracing goes to stdout bydefault; you may want to redirect the output of the command to a file.


–e Deletes events in the event repository, task repository, and extended eventattribute table. You must use the –t option to specify the age of the eventsto be deleted.

–f Forces deletion of QUEUED and WAITING events from the reception log.

Note: Do not use this option while the Tivoli Enterprise Console server isrunning.

–l Deletes events in the reception log.

Note: You cannot use the –c, –r, or –s options when clearing the receptionlog with this option.

–p true | falseIndicates whether the stored procedures should be disabled. The default isTRUE.

–R The RIM object name. The default setting is tec.

–r severityClears events with the specified severity. The valid default values areFATAL, CRITICAL, MINOR, WARNING, HARMLESS, and UNKNOWN.

–s statusClears events with the specified status. The valid default values are OPEN,CLOSED, RESPONSE, and ACK.

–t secondsDeletes events that are older than the specified number of seconds. Thisoption is required.

ExamplesThe following example deletes all events older than 60 seconds from the event andtask repositories and the reception log, turns on tracing, and places the output inthe /tmp/output file:wtdbclear.pl -elt 60 -D > /tmp/output

See Alsowtdumper, wtdumprl, wtdumptr


wtdbspaceProvides space usage statistics for the event database.

Syntaxwtdbspace [-R rim_object_name] [-t temp_dev_name,...] [-d data_dev_name,...]

DescriptionThe wtdbspace command provides statistics about used and free space in theevent database.

Notes:

1. This must be run on the event server, unless noted otherwise.2. The machine where this command is run must have the bash and wrimsql

programs available, unless noted otherwise.

If you use an Informix database, you must execute the wtdbspace script as theTEC Informix user on the system that has the Informix database server installed,and the database environment must be sourced. If the Informix server is on adifferent system than the event server, you must copy the wtdbspace script(located in the $BINDIR/bin directory on the event server) to the Informix serveror make the script available by an NFS mount. The wrimsql command is notneeded when running wtdbspace on the Informix database server.

If you use an IBM DB2 database, you must execute the wtdbspace script as theTEC DB2 user on the RIM host from the IBM DB2 command line processor, andthe database environment must be sourced. If the RIM host is on a different systemthan the IBM Tivoli Enterprise Console server, you must copy the wtdbspace script(located in the $BINDIR/bin directory on the event server) and the db2_runstatsscript (located in the $BINDIR/TME/TEC/sql directory on the event server) to theDB2 server or make the script available by an NFS mount.

Authorizationuser

Options-d data_dev_name,...

The names of the data devices to report on. The following table indicatesthe data device types for each product:

Product Data device types

IBM DB2 table space names

Informix dbspace names

MS SQL Server file group names

Oracle table space names

Sybase logical device names

Each name is separated by a comma or a space. If using spaces to separatenames, the entire list should be enclosed in double quotes. If no names arespecified, then all device names in the database will be reported on.


This command supports the use of the asterisk character as a matchingcharacter. It may be used at the the beginning of a name, the end, or both.For example, to specify a list of data devices that all begin with “tec”,specify “tec*” for data_dev_name.

-R rim_object_nameThe name of the RIM object. The default is tec.

-t temp_dev_name,...

The name of the temporary devices to report on. The following tableindicates the temporary devices for each product:

Product Temporary Devices

IBM DB2 temporary table spaces defined for thedatabase

Informix DBSPACETEMP

MSSQL Server TEMPDB

Oracle temporary table spaces defined for thedatabase

Sybase TEMPDB

Each name is separated by a comma. If no names are specified, then alltemporary devices names in the database will be reported on.

This command supports the use of the asterisk character as a matchingcharacter. It may be used at the the beginning of a name, the end, or both.For example, to specify a list of temporary devices that all begin with“tec”, specify “tec*” for temp_dev_name.

-T Shows all Tivoli Enterprise Console data devices and all temporary datadevices. This parameter can not be used with the –d parameter.

ExamplesThe following example shows the space used for a RIM object named mssql_tecand shows the information for data devices TEC_DATA1 and TEC_DATA2 andtemporary devices TEC_TEMP1 and TEC_TEMP2:wtdbspace -R mssql_tec -d TEC_DATA2,TEC_TEMP2 -t “TEC_TEMP1 TEC_TEMP2”

The following example shows the space used for the RIM object for data devicesthat begin with the letters “TEC” and the temporary devices that begin with theletters “TEC”:wtdbspace -d TEC* -t TEC*


wtdbstat

Checks the availability of the database server that the Tivoli Enterprise Consoleserver uses.

Syntaxwtdbstat [–q]

DescriptionThe wtdbstat command displays the availability of the database server. Thiscommand takes longer to execute when the database server is down.

Authorizationsenior

Options–q Specifies that no output is to be printed (the wtdbstat command executes

quietly). The return code indicates the status. A return code of 0 indicatesthat the server is running. Any other return code indicates an error.

ExamplesThe following example displays the database server availability:wtdbstat

See Alsowstatesvr


wtdumper

Generates an event report.

Syntaxwtdumper [–f file] [–t start_time] [–e end_time] [–o ASC | DESC] [–m number] [–d]

DescriptionThe wtdumper command generates an event report from the event repository. TheEnterprise Console server maintains a log of these events in the database. Bydefault, events are listed in the order in which they occurred. However, the mostrecent event can be listed first by invoking the –o flag.

If wtdumper is executed from a node other than the Tivoli Enterprise Consoleserver, it uses the time from the local machine to determine which events todisplay, and this might cause unexpected behavior.

For example, if the time on the node is 9:00 and the Tivoli Enterprise Consoleserver is 9:30, a wtdumper executed from the node displays every event in thedatabase except for those occurring during the 30 minutes specified. The samecommand executed on the Tivoli Enterprise Console server would display theentire database.

Authorizationsenior

Options–d Lists detailed formatted information in the event report.

–e end_timeLists events that occurred prior to the specified date and time. Theend_time parameter must be a date in the format of “Mon dd hh:mm:ssyyyy”. If this flag is omitted, the command uses the current time as the endtime.

–f file Writes output to the specified file.

–m numberSpecifies the maximum number of events to record in the report. If thenumber of events in the database exceeds the specified value, thecommand omits entries from the end of the report. For example, if thereport is displayed in ascending order, the most recent database entries arenot included in the report.

–o ASC | DESCSets the order in which events are listed. The possible values are:

ASC Lists the oldest log entry first. This is the default value.

DESC Lists the most recent log entry first.

–t start_timeLists events that occurred after the specified date and time. The start_timeparameter must be a date in the format of “Mon dd hh:mm:ss yyyy”.


ExamplesThe following example generates an event report that includes events that occurredbetween 7 PM on March 9, 1999 and 9 AM on March 12, 1999:wtdumper –t "MAR 09 19:00:00 1999" –e "MAR 12 09:00:00 1999"

See Alsowtdbclear, wtdumprl, wtdumptr


wtdumprl

Generates a report of received events.

Syntaxwtdumprl [–f file] [–t start_time] [–e end_time] [–o ASC | DESC] [–m number]

DescriptionThe wtdumprl command generates a report of events received by the event server.The reception log maintains a list of these events in the database. By default,events are listed in the order they occurred. However, the most recent event can belisted first by invoking the –o flag.

If wtdumprl is executed from a node other than the Tivoli Enterprise Consoleserver, it uses the time from the local machine to determine which events todisplay, and this might cause unexpected behavior.

For example, if the time on the node is 9:00 and the Tivoli Enterprise Consoleserver is 9:30, a wtdumprl executed from the node displays every event in thedatabase except for those occurring during the 30 minutes specified. The samecommand executed on the Tivoli Enterprise Console server would display theentire database.

Authorizationsenior, RIM_view

Options–e end_time

Lists events that were received prior to the specified date and time. Theend_time parameter must be a date in the format of “Mon dd hh:mm:ssyyyy”. If this flag is omitted, the command uses the current time as the endtime.



–m numberSpecifies the maximum number of events to record in the report. If thenumber of events in the log exceeds the specified value, the commandomits entries from the end of the report. For example, if the report isdisplayed in ascending order, the most recent database entries are notincluded in the report.




–t start_timeLists events that were received after the specified date and time. Thestart_time parameter must be a date in the format of “Mon dd hh:mm:ssyyyy”.

ExamplesThe following example generates a report that includes all events received between7 PM on March 9, 1999 and 9 AM on March 12, 1999:wtdumprl –t "MAR 09 19:00:00 1999" –e "MAR 12 09:00:00 1999"

See Alsowtdbclear, wtdumper, wtdumptr


wtdumptr

Generates a report of completed tasks.

Syntaxwtdumptr [–f file] [–t start_time] [–e end_time] [–o ASC | DESC] [–m number]

DescriptionThe wtdumptr command generates a report of tasks performed by the eventserver. The task repository maintains a log of these tasks in the database. Bydefault, completed tasks are listed in the order they occurred. However, the mostrecent task can be listed first by invoking the –o flag.

Authorizationsenior, RIM_view

Options–e end_time

Lists tasks that were completed prior to the specified date and time. Theend_time parameter must be a date in the format of “Mon dd hh:mm:ssyyyy”. If this flag is omitted, the command uses the current time as the endtime.


–m numberSpecifies the maximum number of events to record in the report. If thenumber of events in the database exceeds the specified value, thecommand omits entries from the end of the report. For example, if thereport is displayed in ascending order, the most recent database entries arenot included in the report.





–t start_timeLists tasks that were completed after the specified date and time. Thestart_time parameter must be a date in the format of “Mon dd hh:mm:ssyyyy”.

ExamplesThe following example generates a report that includes all tasks completedbetween 7 PM on March 9, 1999 and 9 AM on March 12, 1999:wtdumptr –t "MAR 09 19:00:00 1999" –e "MAR 12 09:00:00 1999"

See Alsowtdbclear, wtdumper, wtdumprl


wtecexport

Exports IBM Tivoli Enterprise Consoleevent console definitions to a file.

Syntaxwtecexport –h [host [:port]] [–u user] [–p password] [–O operator1:operator2:...] [–cconsole1:console2:...] [–e event_group1:event_group2:...] [–f filename]

On Windows systems, the wtecexport command is invoked as wtecexport.cmd.The options are the same.

DescriptionThe definitions of event groups, consoles, and operators can be exported to a fileand then imported into another TMR by using the wtecimport command. Alladministrators have the same Configuration view of objects within a TMR.Exporting and importing console definitions provides the following benefits:v It is an efficient way to create a base set of event consoles in one TMR so that

the event consoles can be imported into other TMRs for additional configurationor implementation.

v The console definitions in one TMR can be used as a single point of control forconsole configuration in a multi-TMR environment.

v It is an efficient way to create backups of consoles.

This task can also be performed from within the event console GUI.

The –O, –c, and –e options can be used alone or in combination. For example, youcan export one or more consoles and any number of event groups withoutexporting any operators. If at least one of –O, –c, and –e is not specified, allconsole definitions are exported.

Note that wtecexport exports consoles, event groups, and operators for all users.

Authorizationsenior

Options—h [host [:port]]

The name of the event server. Specify this option as host:port if a port otherthan port 94 is used.

—c console1:console2:...A list of consoles, separated by colons, to export.

—e event_group1:event_group2:...A list of event groups, separated by colons, to export.

—f filenameThe path and name of the file to contain the exported definitions. If the filedoes not exist, it will be created. The path must already exist.

—O operator1:operator2:...A list of operators, separated by colons, to export.

—p passwordThe password for the login specified in the –u argument.


—u userThe Tivoli administrator login.

Examples1. The following example performs the export as the user root on the event server

mica from a system running Windows. Operators, consoles, and event groupsto be exported are shown and the resources are written to a file namedexport_file.wtecexport.cmd -h mica -u root -p tivoli \-O mfoster:mbock -c personnel:finance \-e Adap_NT:Adap_Unix_Logfile:DM_NT:DM_Unix \-f export_file


2. The following example performs the export as the user root on the event servermica from a system running Windows. In this case, all operators, consoles, andevent groups will be exported to export_file.wtecexport.cmd -h mica -u root -p tivoli \-f export_file

See Alsowtecimport


wtecimport

Imports event console definitions from an export file into a TMR.

Syntaxwtecimport –h host [:port] [–u user] [–p password] [–O operator1:operator2:...] [–cconsole1:console2:...] [–e event_group1:event_group2:...] [–f filename] [–x e | r | c]

On Windows systems, the wtecimport command is invoked as wtecimport.cmd.The options are the same.

DescriptionThe definitions of event groups, consoles, and operators can be exported to a filewith the wtecexport command and then imported into another TMR through anevent console. All administrators have the same Configuration view of objectswithin a TMR. Exporting and importing console definitions provides the followingbenefits:v It is an efficient way to create a base set of event consoles in one TMR so that

the event consoles can be imported into other TMR for additional configurationor implementation.

v The console definitions in one TMR can be used as a single point of control forconsole configuration in a multi-TMR environment.

v It is an efficient way to create backups of consoles.

This task can also be performed from within the event console GUI.

The –O, –c, and –e options can be used alone or in combination. For example, youcan import one or more consoles and any number of event groups withoutimporting any operators. If at least one of –O, –c, and –e is not specified, allconsole definitions are imported.

Note that wtecimport imports consoles, event groups, and operators for all users.When importing consoles, any operators or event groups assigned to the consolesmust already exist, or they must also be imported at the same time.

Only Tivoli administrators defined in the receiving TMR can be imported asoperators. You cannot create a new Tivoli administrator in a TMR by importing anoperator that is not defined in the receiving TMR.

Authorizationsenior

Options–c console1;console2;...

A list of consoles, separated by colons, to import.

–e event_group1;event_group2;...A list of event groups, separated by colons, to import.

–f filenameThe path and filename that contains the exported definitions.


-h [host [:port]]The name of the event server. Specify this option as host:port if a port otherthan port 94 is used.

–O operator1;operator2;...A list of operators, separated by colons, to import.

–p passwordThe password for the login specified in the –u argument.

–u userThe Tivoli administrator login.

–x e | r | cHow to resolve conflicting object names. Use –x e to use the existing object(console, event group, or operator), –x r to replace the existing object withthe new one, or –x c to change the name of the object by appending anumber to the new object. The flags are case sensitive. The space betweenthe argument and the flag is optional.


Examples1. The following example performs the import as the user root on the event server

mica. Operators, consoles, and event groups to be imported are enumeratedand the exported settings are contained in a file named export_file. Existingoperators, consoles, and event groups will be replaced in the event of a nameconflict.wtecimport.cmd -h mica -u root -p tivoli \-O mfoster:mbock -c personnel:finance \-e Adap_NT:Adap_Unix_Logfile:DM_NT:DM_Unix \-f export_file -x r

2. The following example imports all consoles, event groups and operatorscontained within export_file. Once again, the import is performed as the userroot on the event server mica. Existing operators, consoles, and event groupswill be replaced in the event of a name conflict.wtecimport.cmd -h mica -u root -p tivoli -f export_file -x r

See Alsowtecexport


wtouchac

Update the modification time on an adapter configuration profile (ACP) record toforce redistribution.

Syntaxwtouchac key... profile

DescriptionThe wtouchac command updates the timestamp on one or more records from anACP. The update forces the records to be distributed the next time a distribution isrequested from the Adapter Configuration Facility GUI or through the wdistcommand when Exact Copy is not specified.

Because adapter configurations involve other files not directly under control of theprofile mechanism in the Tivoli Enterprise, the fact that a record should beredistributed because an auxiliary file has changed is not apparent to theapplication. Thus, the wtouchac command is used when an auxiliary file haschanged but not the record.

Authorizationadmin

Optionskey... Keys of one or more records. Each record will be read and rewritten.

Separate multiple keys with a space. You can see the key value in theupper right side of the ACP entry panel or by using the wlsac command.

profile The adapter configuration profile to affect. If the name includes spaces,enclose the whole name in quotes.


ExamplesThe following example updates the time stamp on the ACP entry stored in key 1for profile ACP_Profile:wtouchac 1 @ACP:ACP_Profile

The following example updates the time stamp on the ACP entry stored in key 1for profile ACP Profile (which includes a space in its name):wtouchac 1 @"ACP:ACP Profile"

See Alsowdistrib (in the ), waddac


Chapter 2. Tasks

This chapter describes the predefined tasks shipped in the task library for theTivoli Enterprise Console product. The actual name of this task library is T/ECTasks, which appears in task dialogs and is used when specifying the task libraryfrom a command line. There are three types of Tivoli Enterprise Console tasks:

Console tasksThese tasks are configured and run immediately from the Event Viewer. Ifa console task requires any event attribute values, select the desired eventin the Event Viewer’s Working Queue to associate the event with the task.

Automated tasksThese tasks are configured ahead of time and run automatically when aparticular event with the specified event classes and attributes is receivedon the console on which the event was displayed. Automated tasks areconfigured with the Automated Tasks pull-down menu in the EventViewer.

Rule base tasksThese tasks are run when they are part of an action for a rule that has beentriggered. The exec_task and exec_task_local rule language predicates areused to execute rule base tasks. Rule base tasks are sometimes referred toas automated responses. For information about executing tasks from withinrules, see the Tivoli Enterprise Console Rule Builder’s Guide.

A task is a script, which usually executes other Tivoli commands. Variable valuesare passed to a task at execution time. The variable values can come from optionsand arguments you specify, or from event attributes available to the task. Forconsole tasks that need the attributes of an event available to them, you mustassociate the event with the task by selecting the event from the event console.Options and arguments you specify for tasks are described in this chapter. Eventattributes available to tasks are described in Chapter 3, “Environment VariablesAvailable to Tasks” on page 165.

Procedures to configure tasks from an event console are described in the onlinehelp for the current console.

From the Automated Tasks dialog, you can define or modify the followingproperties:v Namev Descriptionv When an event matchesv Execute these tasks

When an automated task completes, it issues information about its success orfailure, and any results created by the task. The task-completion icon is displayedin the first column of the Event Viewer when an automated task completes. Youcan click the icon in the column to view details about the automated task results.These details do not remain after the console has been restarted.


Automated tasks results can be written to a text file, which is configured in theConsole Properties dialog for each console. For detailed information aboutexecuting the Automated Task function from the event console, see the AutomatedTask entries provided in the online help.

When running a rule base task, information about success, failure, and results ofthe task is only issued if the watch status is YES. Otherwise, no information aboutthe task is displayed in the console. When the watch status is YES, thetask-completion icon is displayed in the first column of the Event viewer when thetask completes. You can click the icon in this column to view details about the rulebase task results. These details remain after the console has been restarted.

You can configure and execute all of the tasks using event console dialogs. You canconfigure and execute most of the tasks from the command line. For informationabout accessing the Tivoli Enterprise Console task-related dialogs, see the TivoliEnterprise Console User’s Guide.

The Tivoli Management Framework wruntask command is used to configure andexecute console tasks from the command line, and is shown in all of the examplesin this chapter. Tasks can also be executed by an action in a Tivoli EnterpriseConsole rule.

Note: The term configure in this chapter means to specify the input parameters andexecution options for Tivoli Enterprise Console tasks, and in the case of anautomated task to define a name for the task, define the event constraints tomatch event fields to trigger the task action, and define the name of the taskto execute if the event constraints are satisfied.

Task Names and ScriptsThe following table:v Lists the tasks with both their task names and their descriptive names. Task

names are used from the command line to identify tasks. You can view tasknames or descriptive names in the T/EC Tasks dialog of the Tivoli desktop byselecting and deselecting the Show by identifier check box to review task namesin the event viewer.

v Lists the file names of the task scripts. These scripts are located in the$BINDIR/../generic_unix/TAS/TASK_LIBRARY/bin/tmr_number directory. Youcan modify these scripts if necessary.


v Indicates whether you can execute the task from the command line. Certaintasks need the attributes of an event available to them. You cannot execute a taskthat needs the attributes of an event available to it from the command line.

Task Name Descriptive Name File Name Command Line

Change_Severity Change severity ofevent

T_EC_Tasks_C_zonctxba

No

Clean_Database Clean out TivoliEnterprise Consoledatabase

T_EC_Tasks_C_hmmeleka

Yes

Clear_Closed_Events Clear closed events T_EC_Tasks_C_onyloafa

Yes

Clear_Reception_Log Clear reception log T_EC_Tasks_C_rgetpzda

Yes

Close_Event Close event T_EC_Tasks_C_ylzejuna

No

Dump_Event_Repository Dump event repository T_EC_Tasks_D_ckqiqpka

Yes

Event_Query Query event repository T_EC_Tasks_E_wkxovwka

Yes

Find_Similar_Events Find matching event T_EC_Tasks_F_lozglmea

No

Forward_Event Forward event to TECserver

T_EC_Tasks_F_dpstmska

No

Log_Event_To_File Log event to file T_EC_Tasks_L_jfugucca

No

Popup_Message Popup message ondesktop

T_EC_Tasks_P_rsoomfna

Yes

Send_Email event information T_EC_Tasks_S_rsnlpxda

No

Send_Event Send event to T/ECserver

T_EC_Tasks_P_lwqpwqla

Yes

Wake_Up_Netscape Jump Netscape to URL T_EC_Tasks_W_mnnqzlga

Yes

Task OutputWhen a task completes it issues information about its success or failure, and anyresults created by the task (for example, the results from an event database query).For tasks that execute from the Event Viewer, a task output dialog is displayedwith this information.

For tasks that execute from the command line, the same level of information iswritten to stdout and stderr. For automated tasks, the results can be displayedwith the related event that triggered the task. The task can also be configured tosave the results to a log file. For rule base tasks, the results can be displayed by theconsole; the results are also stored in the database.

Chapter 2. Tasks 139

Command Line SyntaxThe syntax for tasks you can issue from the command line use the followingspecial characters:

[ ] Identifies an optional argument value. Values not enclosed in brackets arerequired.

... Indicates that you can specify multiple values for the argument.

| Indicates mutually exclusive argument values. You must use one of thevalues.

{ } Delimits a set of mutually exclusive argument values when one of thevalues is required.

Note: Enclose argument values that have embedded spaces with either single ordouble quotes.

For example:

wruntask –t Send_Event –l ″T/EC Tasks″ –h node–a {event_server | ″″}–a {msg | ″″}–a {hostname | ″″}–a {origin | ″″}–a {severity | ″″}–a {sub_origin | ″″}–a {sub_source | ″″}–a event_class–a source

All of the arguments to execute this task are required, in the order shown. The –tand –l arguments have specific values. The –h argument has a variable value. Allof the –a arguments must have either an actual variable value or an emptyplaceholder (defined by the ″″ characters).

Another example is:

wruntask –t Event_Query –l ″T/EC Tasks″ –h node–a {″class[, class...] ″ | ″*″}–a {″status[,status...]″ | ″*″}–a {″severity[,severity...]″ | ″*″}–a {″hostname[,hostname...]″ | ″*″}–a {″source[,source...]″ | ″*″}–a {″sub_source[,sub_source...]″ | ″*″}–a {″origin[,origin...]″ | ″*″}–a {″sub_origin[,sub_origin...]″ | ″*″}–a {″msg″ | ″*″}–a {″startpoint″ | ″*″}–a sort_order–a {″attribute[,attribute...]″ | ″*″]

Arguments like the first –a argument can optionally have more than one variablevalue (in this example, event class names). Each value must be separated by acomma. If you do not specify actual variable values, you must use the asterisk (*)wildcard character (meaning all event classes in this example). Also in thisexample, quotes are required around each –a argument.


Change_SeverityChanges the severity of an event. The severity is changed in the Event Viewer, theevent cache, and the event repository.

This task assumes the wsetemsg command is available on the host where the taskexecutes. The wsetemsg command is always available on the event server host.Also, the event server must be running for this task to execute successfully.

Authorizationsuper, senior, admin, user

Dialog Configuration OptionsSeverity The new severity for the event. Valid values are: FATAL,

CRITICAL, MINOR, WARNING, HARMLESS, or UNKNOWN.

Command SynopsisYou cannot execute this task from the command line.


Clean_Database

Deletes old events from the event database. Events are deleted from the receptionlog based on the value for the Time to keep event reception log information fieldin the Event Server Parameters dialog for the event server. Closed events in theevent repository that are older than the value for the Time to keep closed eventsin cache field in the Event Server Parameters dialog are deleted.

This task assumes the wtdbclear command is available on the host where the taskexecutes. The wtdbclear command is always available on the event server host. Ifthere was a problem while executing the wtdbclear command, an explanatorymessage is issued and the script exits immediately with a return code. The eventdatabase must be available. The event server does not have to be running.

Note: After executing this task, old events deleted from the event repository arenot removed from an event console until it is shut down and reopened. Oldevents in the event cache are not removed until the event server is stoppedand restarted, or until the old events reach their timeout value.

AuthorizationRIM_update, RIM_view, super, senior, admin, user

Dialog Configuration OptionsThere are no options for this task. It gets its parameters from the fields mentionedin the task description.

Command Synopsiswruntask –t Clean_Database –l ″T/EC Tasks″ –h node


Command Arguments–t Clean_Database

The task to execute.

–l ″T/EC Tasks″The task library.

–h node The managed node on which to execute the task.

Command Examplewruntask -t Clean_Database -l "T/EC Tasks" \-h orange


Clear_Closed_EventsDeletes closed events from the event repository, using an age you provide.

This task assumes the wtdbclear command is available on the host where the taskexecutes. The wtdbclear command is always available on the event server host.

The event database must be available. The event server does not have to berunning.


Dialog Configuration OptionsSeconds Old The age, in seconds, after which events are deleted. For example, a

value of 60 specifies to delete closed events older than 60 seconds.

Command Synopsiswruntask –t Clear_Closed_Events –l ″T/EC Tasks″ –h node –a seconds

Command Arguments–a seconds The starting age, in seconds, of events to delete.



–t Clear_Closed_EventsThe task to execute.

Command Examplewruntask -t Clear_Closed_Events -l "T/EC Tasks" \-h orange -a 6000


Clear_Reception_LogDeletes events from the reception log that were received more than 30 seconds ago.

This task assumes the wtdbclear command is available on the host where the taskexecutes. The wtdbclear command is always available on the event server host.



Dialog Configuration OptionsThere are no options for this task.

Command Synopsiswruntask –t Clear_Reception_Log –l ″T/EC Tasks″ –h node

Command Arguments–h node The managed node on which to execute the task.


–t Clear_Reception_LogThe task to execute.

Command Examplewruntask -t Clear_Reception_Log -l "T/EC Tasks" \-h orange


Close_Event

Changes the status of an event selected to CLOSED. The status is changed in theevent console, the event cache, and the event repository.

This task assumes the wsetemsg command is available on the host where the taskexecutes. The wsetemsg command is always available on the event server host.Also, the event server must be running for this task to execute successfully.


Dialog Configuration OptionsThere are no options for this task.



Dump_Event_RepositoryDisplays event details from the event repository in the task output dialog.

This task assumes the wtdumper command is available on the host where the taskexecutes. The wtdumper command is always available on the event server host.


AuthorizationRIM_view, super, senior, admin, user

Dialog Configuration OptionsAscending or Descending order?

The order in which events are listed in the output. Choices are:

ASC List the oldest event repository entry first.

DESC List the most recent event repository entry first.

Number of EventsThe maximum number of events to display in the output. If the number ofevents in the event repository exceeds the specified value, entries areomitted from the end of the output. For example, if the output is displayedin ascending order, the most recent database entries are not shown.

Command Synopsiswruntask –t Dump_Event_Repository –l ″T/EC Tasks″ –h node –a sort_order –anumber_events


Command Arguments–a number_events

The maximum number of events to display in the output. If thenumber of events in the database exceeds the specified value,entries are omitted from the end of the output. For example, if theoutput is displayed in ascending order, the most recent databaseentries are not shown.

–a sort_order The order in which events are listed in the output. Valid valuesare:

ASC List the oldest event repository entry first.

DESC List the most recent event repository entry first.



–t Dump_Event_RepositoryThe task to execute.

Command Examplewruntask -t Dump_Event_Repository -l "T/EC Tasks" \-h orange -a ASC -a 10


Event_QueryQueries the event repository. The results are displayed in the task output dialog.

This task assumes the wtdumper command is available on the host where the taskexecutes. The wtdumper command is always available on the event server host.



Dialog Configuration OptionsFor the following match-type options (Match Class through Match Message), yourchoices define which attributes and values to use for the selection criteria of thequery. All of the options let you manually enter text, including the asterisk (*)wildcard character to specify all the values for an attribute. If you manually entermultiple values for an option, separate each with a comma. Some of the optionsalso provide a push button to display a scrolling list from which you can select oneor more values.

Match Class Event classes.

Match Status Status of events. Valid status names are: OPEN, ACK, RESPONSE,and CLOSED.

Match SeverityEvent severities. Valid values are: FATAL, CRITICAL, MINOR,WARNING, HARMLESS, and UNKNOWN.

Match HostnameThe names of the systems on which the events occurred.


Match Source The sources of the events (for example, LOGFILE is the sourcename for the UNIX logfile adapter). A source is defined by anadapter type.

Match SubSourceFurther categorizations of sources.

Match Origin The protocol addresses or host names of the source systems.

Match SubOriginFurther categorization of origins.

Match MessageOne or more message text strings of the events. When specifyingmore than one message, enclose the entire value for the MatchMessage option with one type of quote (for example, doublequotes), and enclose each message within a different type of quote(for example, single quotes) separated by a comma. For example:"’msg text1’,’msg text2’". To specify all messages, use the *

wildcard character.

Starting Date and TimeSpecifies to query events received from this point to the present. Toenter a starting point, use the following format: monddhh:mm:ssyyyy.For example, Jan 01 00:01:01 2000. To query all events, enter the *wildcard character.

Order Events byThe order in which query results are listed in the output. Validvalues are:

ASC List the oldest event first.

DESC List the most recent event first.


Show values for attributesSpecifies which base event attributes to display in the output. Pressthe Attributes... button for a scrolling list of base event attributesto select from. All non-base event attributes are always displayed.If you don’t select any attributes, all (base and non-base) attributesare displayed in the output.

Command Synopsiswruntask –t Event_Query –l ″T/EC Tasks″ –h node–a {″class[,class...]″ | ″*″}–a {″status[,status...]″ | ″*″}–a {″severity[,severity...]″ | ″*″}–a {″hostname[,hostname...]″ | ″*″}–a {″source[,source...]″ | ″*″}–a {″sub_source[,sub_source...]″ | ″*″}–a {″origin[,origin...]″ | ″*″}–a {″sub_origin[,sub_origin...]″ | ″*″}–a {″’msg’[,’msg’...]″ | ″*″}–a {″start point″ | ″*″}–a sort_order–a {″attribute[,attribute...]″ | ″*″]

Command Arguments–a ″class...″ One or more event class names. If specifying more than one class

by name, separate each name with a comma and no interveningspace. To specify all event classes, use the * wildcard character. Foradditional information about event class names, see the TivoliEnterprise Console Adapters Guide or the BAROC files for theadapters generating the events.

–a ″status...″ One or more event status names. If specifying more than one statusby name, separate each name with a comma and no interveningspace. To specify all event status names, use the * wildcardcharacter. Valid status names are: OPEN, ACK, RESPONSE, andCLOSED.


–a ″severity...″ One or more event severity names. If specifying more than oneseverity by name, separate each name with a comma and nointervening space. To specify all event severity names, use the *wildcard character. Valid severity names are: FATAL, CRITICAL,MINOR, WARNING, HARMLESS, and UNKNOWN.

–a ″hostname...″One or more names of the systems on which the events occurred.If specifying more than one host by name, separate each namewith a comma and no intervening space. To specify all host names,use the * wildcard character.

–a ″source...″ One or more sources of the events (for example, LOGFILE is thesource name for the UNIX logfile adapter). A source is defined byan adapter type. If specifying more than one source by name,separate each source with a comma and no intervening space. Tospecify all sources, use the * wildcard character.

–a ″sub_source...″One or more subsource of the events. A subsource is a furthercategorization of a source. If specifying more than one subsourceby name, separate each subsource with a comma and nointervening space. To specify all subsources, use the * wildcardcharacter.

–a ″origin...″ One or more protocol addresses or host names of the sourcesystems. If specifying more than one origin by name, separate eachorigin with a comma and no intervening space. To specify allorigins, use the * wildcard character.


–a ″sub_origin...″One or more suborigins of the events. A suborigin is a furthercategorization of a origin. If specifying more than one suborigin byname, separate each suborigin with a comma and no interveningspace. To specify all suborigins, use the * wildcard character.

–a ″’msg...’″ One or more message text strings of the events. Enclose eachmessage within a different type of quote than the type enclosingthe entire value for the –a argument; that is, if the entire argumentvalue is enclosed by double quotes (as shown in the synopsis),enclose each message within single quotes. For example: -a "’msgtext1’,’msg text2’". To specify all messages, use the * wildcardcharacter.

–a ″start_point″Specifies to query events received from this point to the present. Toenter a starting point, use the following format: monddhh:mm:ssyyyy.For example, Jan 01 00:01:01 2000. To query all events, use the *wildcard character.

–a ″sort_order″ The order in which query results are listed in the output. Validvalues are:

ASC List the oldest event first.

DESC List the most recent event first.


–a ″attribute...″ Specifies one or more base event attributes to display in theoutput. All non-base event attributes are always displayed. Ifspecifying more than one attribute by name, separate each attributewith a comma and no intervening space. To specify all attributes,use the * wildcard character.


–t Event_QueryThe task to execute.

Command Examplewruntask -t Event_Query -l "T/EC Tasks" -h orange \-a "TEC_Notice" -a "*" -a "*" -a "*" -a "TEC" \-a "*" -a "*" -a "*" -a "*" -a "*" -a ASC \-a "server_handle,date_reception,event_handle"


Find_Similar_EventsQueries the event repository using an event for comparing attributes. The resultsare displayed in the task output dialog.

You must select the event in the Event Viewer before configuring this task. Thistask assumes the wtdumper command is available on the host where the taskexecutes. The wtdumper command is always available on the event server host.

The event database must be available. Also, the event server must be running forthis task to execute successfully.


Dialog Configuration OptionsFor the following match-type options (Match Class through Match Message),selecting the Yes radio button specifies to use the attribute in the selected event forcomparisons with the same attributes of events in the database. Selecting the Noradio button specifies not to use the attribute in the selected event for comparisons.

Match Class The event class.

Match Status The status of the event. Valid status names are: OPEN, ACK,RESPONSE, and CLOSED.

Match SeverityThe severity of the event. Valid values are: FATAL, CRITICAL,MINOR, WARNING, HARMLESS, and UNKNOWN.

Match HostnameThe name of the system on which the event occurred.

Match Source The source of the event.

Match SubSourceA further categorization of the source.

Match Origin The protocol address or host name of the source system.

Match SubOriginA further categorization of the origin.

Match MessageThe message text of the event.

Starting Date and TimeSpecifies to query events received from this point to the present. Toenter a starting point, use the following format: mon ddhh:mm:ss yyyy. For example, Jan 01 00:01:01 2000. To query allevents, enter an asterisk (*).

Order Events byThe order in which query results are listed in the output. Validvalues are:

AscendingList the oldest event first.

DescendingList the most recent event first.


Show values for attributesSpecifies which base event attributes to display in the output. Pressthe Attributes... button for a scrolling list of base event attributesto select from. All attributes for a non-base event are alwaysdisplayed. If you don’t select any attributes, all attributes aredisplayed in the output.



Forward_EventForwards an event to another event server registered in the current TivoliManagement Region (TMR).

This task assumes the wpostemsg command is available on the host where the taskexecutes. The wpostemsg command is always available on the event server host.


Dialog Configuration OptionsEvent Server’s Name

The event server to receive the forwarded event. You can manually type aname, or select from a scrolling list of known event servers by pressing theChoose... button. The local event server is named EventServer. To specify aremote event server, enter EventServer#tmr, where tmr is the name of theTMR where the remote event server is located; for example,EventServer#orange-region.



Log_Event_To_FileWrites details to a file about an event.

Authorizationsuper, senior, admin

Dialog Configuration OptionsLog File Name

The path and file name to which the event information is written. You canmanually type a path and file name, or you can press the Log File Namebutton to display a file browser dialog.



Popup_MessageDisplays a message on an operator’s desktop.

This task assumes the wsendresp command is available on the host where the taskexecutes. The wsendresp command is always available on the event server host.Also, the Event Viewer that receives the message must be running for this task toexecute successfully.


Dialog Configuration OptionsOperator’s Name

The name of the operator to receive the message. You canmanually type this value or press the Operator button for ascrolling list of known operators.

File Name The path and name of the file containing the message text todisplay. You can manually type a path and file name.

Managed NodeThe managed node on which to execute the task.

Command Synopsiswruntask –t Popup_Message –l ″T/EC Tasks″ –h node –a administrator –a path

Command Arguments–a administrator

The name of the event console of the Tivoli administrator toreceive the message.

–a path The path and name of the file containing the message text todisplay. To specify a remote host on which the file is located, usethe format: hostname:path; for example, red:/tmp/msg.txt.



–t Popup_MessageThe task to execute.

Command Examplewruntask -t Popup_Message -l "T/EC Tasks" \-h orange -a Root_orange-region \-a /tmp/msg.txt


Send_EmailSends details in an e-mail message about an event. This can be executed from thefrom the Event Viewer or from a rule.

This task assumes the sendmail command is available on UNIX and Linux hosts,and that the $BINDIR/bin/smtp_client.exe program is available on Windows NThosts.

Before this task can be run, an SMTP mail server must be set with the wmailhost

command. For more information on the wmailhost command, see the TivoliManagement Framework Reference Manual

.


Dialog Configuration OptionsAdministrator’s Name

The name of the person to receive the message. The name appearsin the e-mail’s To: field.

Administrator’s E-mail AddressThe e-mail ID of the person to receive the message.



Send_EventCreates a new event and sends it to the specified event server registered in thecurrent Tivoli Management Region (TMR).

This task assumes the wpostemsg command is available on the host where the taskexecutes. The wpostemsg command is always available on the event server hostand endpoints that have an event adapter installed.


Dialog Configuration OptionsOnly the CLASS_NAME and SOURCE options require values. The others areoptional; that is, you can leave any of them blank. Although you leave them blank,event server processing assigns default values.

Event Server’s NameThe event server to receive the event. You can manually type aname, or select from a scrolling list of known event servers bypressing the Choose... button. The local event server is namedEventServer. To specify a remote event server, enterEventServer#tmr, where tmr is the name of the TMR where theremote event server is located; for example, EventServer#orange-region. If no value is specified for this option, EventServer is usedby default.

message The message text of the event.

hostname The name of the system on which the event occurred.

origin The protocol address or host name of the source system.

severity The severity of the event. Valid severities are: FATAL, CRITICAL,MINOR, WARNING, HARMLESS, and UNKNOWN.

sub_origin A further categorization of the origin.

sub_source A further categorization of the source.

CLASS_NAMEThe event class. This option requires a value. For additionalinformation about event class names, see the IBM Tivoli EnterpriseConsole Adapters Guide or the BAROC file for a particular adapter.

SOURCE


The source of the event (for example, LOGFILE is the source namefor the UNIX logfile adapter). The source is defined by the adaptertype. This option requires a value.

Command SynopsisOnly the –a event_class and –a source arguments require actual values. Values forthe other arguments are optionalæthat is, you do not have to specify a value forthe argument, but you must still specify the argument flag with an emptyplaceholder; for example, –a ″″. You can optionally substitute pairs of single quotesfor the pairs of double quotes shown.

wruntask –t Send_Event –l ″T/EC Tasks″ –h node–a {event_server | ″″}–a {msg | ″″}–a {hostname | ″″}–a {origin | ″″}–a {severity | ″″}–a {sub_origin | ″″}–a {sub_source | ″″}–a event_class–a source


Command Arguments–a event_server The event server to receive the event. The local event server is

named EventServer. To specify a remote event server, enterEventServer#tmr, where tmr is the name of the TMR where theremote event server is located; for example, EventServer#orange-region. If no event server is specified for this argument,EventServer is used by default.

–a msg The message text of the event. If the message text containsembedded spaces, enclose within quotes.

–a hostname The name of the system on which the event occurred.

–a origin The protocol address or host name of the source system.

–a severity The event severity. Valid severities are: FATAL, CRITICAL,MINOR, WARNING, HARMLESS, and UNKNOWN.

–a sub_origin The suborigin of the event. A suborigin is a further categorizationof an origin.

–a sub_source The subsource of the event. A subsource is a further categorizationof a source.

–a class The event class name. This argument requires a value. Foradditional information about event class names, see the IBM TivoliEnterprise Console Adapters Guide or the BAROC file for a particularadapter.

–a source The source of the event (for example, LOGFILE is the source namefor the UNIX logfile adapter). A source is defined by an adaptertype. This argument requires a value.



–t Send_Event The task to execute.

Command Examplewruntask -t Send_Event -l "T/EC Tasks" -h orange \-a EventServer -a "Test for UNIX Logfile Event" \-a redhost -a 123.11.1.14 -a FATAL \-a "" -a "" -a Kernal_Panic -a LOGFILE


Wake_Up_NetscapeDisplays a Web page in a new window of the Netscape browser.

This task assumes a Netscape browser process is already running on the hostwhere the task executes.


Dialog Configuration OptionsURL to DISPLAY

The uniform resource locator (URL) of the Web page to display.

Netscape PathThe default path to the directory where Netscape is installed on the hostwhere the task executes. The default is /usr/local/bin.

Note: For Windows NT, the PATH environment variable must be set toinclude the directory where Netscape is installed. For UNIX, ifNetscape is not installed in the /usr/local/bin directory, the PATHenvironment variable must be set to include the directory whereNetscape is installed.

Command Synopsiswruntask –t Wake_Up_Netscape –l ″T/EC Tasks″ –h node –a url

Note: If your host is configured as both an endpoint and a managed node, andyou want the task to run in the managed node environment, you must usethe @ManagedNode syntax. For more information, see the Tivoli ManagementFramework Reference Manual.

Command Arguments–a url The URL of the Web page to display.


–l T/EC Tasks The task library.

–t Wake_Up_NetscapeThe task to execute.

Command Examplewruntask -t Wake_Up_Netscape -l "T/EC Tasks" \-h orange -a http://www.tivoli.com


Chapter 3. Environment Variables Available to Tasks

This chapter describes the environment variables available to Tivoli EnterpriseConsole programs and tasks that execute with an event. You can specify attributevalue constraints for tasks that execute with an event.

Variable DescriptionsThe following table describes the environment variables available to programs,console tasks, and automated tasks that execute with an event. It is organized asfollows:

Name The name of the environment variable.

Description A brief description of the environment variable.

Available to An X in any of the four subcolumns under this column means thatthe environment variable is available to console tasks, consoleprograms, rule base tasks, or rule base programs.

Environment variables that represent event attributes are located after the generalenvironment variables, in the section of the table titled Event Attributes. Bothsections of the table are in alphabetical order within each section.

Name Description

Available to

Con

sole

Task

s

Con

sole

Pro

gram

s

Ru

leB

ase

Task

s

Ru

leB

ase

Pro

gram

s

CHILD_OF_OSERV Indicates to the child process that it is achild of the oserv process and allows thechild process to take the following twoshortcuts:

v Does not need to re-authenticate withthe oserv process because the oservprocess created credentials when itcreated the child process.

v Does not need to initiate a newconnection to the oserv process becausethe oserv process created a socket-pairor pipe-pair to communicate with thechild process when it created the childprocess.

X X

CONSOLE_NAME Name of the event console from where thetask was invoked.

X

DISPLAY UNIX variable that controls the display ofthe X server.

X

ENDPOINT Node where the task executes. X X


Name Description

Available to

Con

sole

Task

s

Con

sole

Pro

gram

s

Ru

leB

ase

Task

s

Ru

leB

ase

Pro

gram

s

ENDPOINT_OID Object identifier of where the taskexecutes.

X X

EVENT_CLASS Event class passed to the exec_taskpredicate.

X X

INTERP Architecture type of machine where nodeis installed.

X X X

LANG Identifier for locale. X X X

LD_LIBRARY_PATH Path to the shared libraries on solaris2 andsunos4 interpreters.

X X

LIBPATH Path to the shared libraries on AIX. X X

NLSPATH Path to the directory used by applicationsto determine language.

X X X

PATH File search path. X X X

PRINCIPAL Tivoli user running the task.

SHLIB_PATH Path to the shared libraries on OpenView. X X

SLOTS Event attributes of the event associatedwith the task.

X X X X

TEC_BIN_DIR Directory where the Tivoli EnterpriseConsole product is installed.

X X X

TEC_KB_DIR Location of the loaded rule base within the$DBDIR directory.

X X

TEC_MASTER_PORT Port the tec_server process uses tocommunicate.

X X

TEC_MASTER_START_TIMEOUT

Number of seconds for event serverinitialization.

X X

TEC_RECV_BUFSIZE Maximum number of events buffered inmemory at the event server.

X X

TEC_RECV_LOG Indicates whether to log reception ofevents at the event server.

X X

TEC_RULE_CACHE_CLEAN_FREQ

The frequency, in seconds, of how oftenevents whose time has passed are purgedfrom the rules cache.

X X

TEC_RULE_CACHE_FULL_HISTORY

The time, in seconds, to keep closed eventsin the rules cache.

X X

TEC_RULE_CACHE_NON_CLOSED_HISTORY

The time, in seconds, to keep non-closedevents in the rules cache.

X X

TEC_RULE_CACHE_SIZE

Maximum number of events stored in theevent cache.

X X

TEC_RULE_TRACE Indicates whether rules processinggenerates trace information.

X X


Name Description

Available to

Con

sole

Task

s

Con

sole

Pro

gram

s

Ru

leB

ase

Task

s

Ru

leB

ase

Pro

gram

s

TEC_RULE_TRACE_FILE

File containing rule trace information. X X

TISDIR Directory for files pertaining to Tivoliinternationalization.

X X X

TZ Time zone. X X X

WLOCALHOST Name of the node as Tivoli knows it. X X X

Event Attributes

acl The list of event group roles that enablesan operator to modify the event.

X X X X

adapter_host The host on which the adapter is running. X X X X

administrator The operator who acknowledged or closedthe event.

X X X X

cause_date_reception The cause_date_reception attribute is usedto link an effect event to its cause event.This value is set to the value of thedate_reception attribute of the causeevent.

X X X X

cause_event_handle Used in linking an effect event to a causeevent, and contains the event_handleattribute value from the cause event.

X X X X

class Event class name X X

class_name Event class name. X X X

credibility Indicates how the event was sent from theadapter. The value is 1 if an event wassent using a communications channelprovided by Tivoli ManagementFramework services, or a TME adapter.The value is 0 if an event was sent from anon-TME adapter.

X X X X

date The date and time the event wasgenerated.

X X

date_event The date and time the event wasgenerated.

X X

date_reception A time stamp indicating the time the eventserver received the event. It is an integerrepresenting the number of seconds sincethe epoch, which is January 1, 1970. Thisvalue is also used as a component touniquely identify an event. An event isuniquely identified by a combination ofthe values for the date_reception,event_handle, and server_handleattributes.

X X X X

Chapter 3. Environment Variables Available to Tasks 167

Name Description

Available to

Con

sole

Task

s

Con

sole

Pro

gram

s

Ru

leB

ase

Task

s

Ru

leB

ase

Pro

gram

s

duration For closed events, the age (in seconds) ofthe event from when it was received bythe event server until it was closed. For allnon-closed events, the value is 0.

X X X X

ev_key Event identifier comprised of theevent_handle, server_handle, anddate_reception attribute values.

X

event_handle A number used to reference the event. Theevent server assigns this number.

X X X X

event_hndl A number used to reference the event. Theevent server assigns this number.

X X

hostname The name of the system on which theevent occurred.

X X X X

last_modified_time When the event was last modified. X X

msg A text summary of the event. X X X X

msg_catalog For future support of internationalizedevent messages; not currentlyimplemented.

X X X X

msg_index The message ID used to obtain theinternationalized message.

X X X X

num_actions The number of actions (tasks or programs)currently being tracked by the event serverfor this event.

X X X X

o_dispatch The port number used by the oservprocess.

X X X

origin The protocol address or host name of thesource system.

X X X X

repeat_count A counter for keeping track of the numberof times a duplicate type of event has beenreceived.

X X X X

server_handle A number identifying the event server thatreceived this event. An event is uniquelyidentified by a combination of the valuesfor the date_reception, event_handle, andserver_handle attributes.

X X X X

server_hndl A number identifying the event server thatreceived this event. An event is uniquelyidentified by a combination of the valuesfor the date_reception, event_handle, andserver_handle attributes.

X X

server_path Stores information describing the ruleengines that an event has passed through.

X X X X


Name Description

Available to

Con

sole

Task

s

Con

sole

Pro

gram

s

Ru

leB

ase

Task

s

Ru

leB

ase

Pro

gram

s

severity The severity of the event. The databasestores the severity as a number. Thismapping is defined in the root.baroc rulebase file and is set for the event serverdefault severities as follows:10 UNKNOWN20 HARMLESS30 WARNING40 MINOR50 CRITICAL60 FATAL

X X X X

source The source of the event (for example, theOpenView adapter). The source is definedby the adapter type.

X X X X

status Status of the event. X X X X

sub_origin A further categorization of the origin. Thisattribute is optional.

X X X X

sub_source A further categorization of the source. Thisattribute is optional.

X X X X

ExamplesThis section shows examples of environment variable dumps for an automatedtask executed from the event console, an automated task executed from a TivoliEnterprise Console rule, and a console task executed from the event console. Linewrapping of variable values may occur because of space limitations on the page.

Environment Variable Dump When Executing a Task from theEvent Console

The following example shows a dump of the environment variables whenexecuting a task from a Tivoli Enterprise Console rule.CHILD_OF_OSERV=ENDPOINT=xerius (ManagedNode)ENDPOINT_OID=1450268534.1.348#TMF_ManagedNode::Managed_Node#EVENT_CLASS=TEC_ErrorINTERP=solaris2LANG=CLD_LIBRARY_PATH=/data/TMP3.6/lib/solaris2:/usr/openwin/lib:/data/ \install/iblib/solaris2:/usr/openwin/lib:/usr/lib:/usr/ucblib:/data/ \TMP3.6/lib/solaris2:/usr/dt/lib:/usr/openwin/lib:/usr/lib:/usr/ucblibNLSPATH=/data/TMP3.6/msg_cat/%L/%N.cat:/data/TMP3.6/msg_cat/%l/ \%N.cat:/data/TMP3.6/msg_cat/C/%N.cat:/data/TMP3.6/msg_cat/%L/ \%N.cat:/data/TMP3.6/msg_cat/%l/%N.cat:/data/TMP3.6/msg_cat/C/%N.catPATH=/data/TMP3.6/bin/solaris2/bin:/bin:/usr/binSLOTS=server_handle date_reception event_handle source sub_source \origin sub_origin hostname adapter_host date status \administrator acl credibility severity msg msg_catalog msg_index \


duration num_actions repeat_count cause_date_reception \cause_event_handle server_pathTEC_BIN_DIR=/data/TMP3.6/bin/solaris2/TME/TECTEC_KB_DIR=tec/rb_dirTEC_MASTER_PORT=50561TEC_MASTER_START_TIMEOUT=300TEC_RECV_BUFSIZE=500TEC_RECV_LOG=YESTEC_RULE_CACHE_CLEAN_FREQ=3600TEC_RULE_CACHE_FULL_HISTORY=86400TEC_RULE_CACHE_NON_CLOSED_HISTORY=15552000TEC_RULE_CACHE_SIZE=1000TEC_RULE_TRACE=YESTEC_RULE_TRACE_FILE=/tmp/rules.traceTISDIR=/data/TMP3.6/bin/solaris2/../genericTZ=US/CentralWLOCALHOST=xeriusacl=[admin]adapter_host=administrator=cause_date_reception=0cause_event_handle=0class_name=TEC_Errorcredibility=1date=Aug 8 13:26:57 2000date_reception=965759217duration=0event_handle=1hostname=xeriusmsg=taskmsg_catalog=msg_index=0num_actions=2o_dispatch=94origin=146.84.39.78repeat_count=0server_handle=1server_path=[]severity=MINORsource=EVENTstatus=OPENsub_origin=sub_source=


Environment Variable Dump When Executing a Program fromthe Event Console

The following example shows a dump of the environment variables whenexecuting a console task from the event console.EVENT_CLASS=TEC_ErrorINTERP=solaris2LANG=CLD_LIBRARY_PATH=/data/TMP3.6/lib/solaris2:/usr/openwin/lib:/data/ \install/iblib/solaris2:/usr/openwin/lib:/usr/lib:/usr/ucblib:/data/ \TMP3.6/lib/solaris2:/usr/dt/lib:/usr/openwin/lib:/usr/lib:/usr/ucblibNLSPATH=/data/TMP3.6/msg_cat/%L/%N.cat:/data/TMP3.6/msg_cat/%l/ \%N.cat:/data/TMP3.6/msg_cat/C/%N.cat:/data/TMP3.6/msg_cat/%L/ \%N.cat:/data/TMP3.6/msg_cat/%l/%N.cat:/data/TMP3.6/msg_cat/C/%N.catPATH=/data/TMP3.6/bin/solaris2/bin:/bin:/usr/binSLOTS=server_handle date_reception event_handle source sub_source \origin sub_origin hostname adapter_host date status \administrator acl credibility severity msg msg_catalog msg_index \duration num_actions repeat_count cause_date_reception \cause_event_handle server_pathTEC_BIN_DIR=/data/TMP3.6/bin/solaris2/TME/TECTEC_KB_DIR=tec/rb_dirTEC_MASTER_PORT=50561TEC_MASTER_START_TIMEOUT=300TEC_RECV_BUFSIZE=500TEC_RECV_LOG=YESTEC_RULE_CACHE_CLEAN_FREQ=3600TEC_RULE_CACHE_FULL_HISTORY=86400TEC_RULE_CACHE_NON_CLOSED_HISTORY=15552000TEC_RULE_CACHE_SIZE=1000TEC_RULE_TRACE=YESTEC_RULE_TRACE_FILE=/tmp/rules.traceTISDIR=/data/TMP3.6/bin/solaris2/../genericTZ=US/CentralWLOCALHOST=xeriusacl=[admin]adapter_host=administrator=cause_date_reception=0cause_event_handle=0class_name=TEC_Errorcredibility=1date=Aug 8 13:26:57 2000date_reception=965759217duration=0event_handle=1hostname=xeriusmsg=taskmsg_catalog=msg_index=0num_actions=2o_dispatch=94origin=146.84.39.78repeat_count=0server_handle=1server_path=[]severity=MINORsource=EVENTstatus=OPENsub_origin=sub_source=


Chapter 4. Event Flow

The event server architecture consists of the following five processes, which impactrule development and rule execution. Their process names are shown inparentheses. There is an additional process, the user interface (UI) server, thatplays an integral part in the overall Tivoli Enterprise Console architecture. The UIserver is not part of the event server, although it communicates with the eventserver. For additional information, see “User Interface Server” on page 176.v Master process (tec_server)v Reception engine process (tec_reception)v Rule engine process (tec_rule)v Dispatch engine process (tec_dispatch)v Task engine process (tec_task)

These processes are also known as services when running in a Windows NTenvironment. The service names have a .exe file name extension.

If any of the event server processes fail, error information is written to theappropriate error log. The following table lists the names of some the error filesdefined in the $BINDIR/TME/TEC/.tec_diag_config file.

Process Error File

tec_server /tmp/tec_master

tec_reception /tmp/tec_reception

tec_rule /tmp/tec_rule

tec_dispatch /tmp/tec_dispatch

tec_task /tmp/tec_task

The names of the error files can be changed.


The following figure illustrates the relationships among the event server processes.The arrows represent the flow of communications.

Task engine(tec_task)

Master(tec_server)

External tasksor programs

UI server(tec_ui_server)

Eventcache(RAM)

IncomingTivoli events

Receptionengine

(tec_reception)

Receptionbuffer(RAM)

RDBMS

Rule engine(tec_rule)

Dispatchengine

(tec_dispatch) Console

Console

Console

from non-TMEadapter


from TMEadapter

Master ProcessThe master process coordinates all of the other event server processes. If one of theother processes dies, the master process will try to restart it. If the master processcan restart it, the master process will bring the rest of the processes downgracefully. Additionally, the master process initially receives incoming events sentfrom TME adapters (those that use the Tivoli Management Framework forcommunications) and forwards them to the reception engine.

Reception Engine ProcessThe reception engine:1. Receives incoming events and logs them to the reception log.2. Sends received events to the rule engine for processing.

The following figure illustrates the event reception steps in detail. The state of anevent during the reception process is explained after the figure. The callouts in thefigure are described as follows:1. The reception engine receives events directly from a non-TME adapter or from

the master process if the event was sent from a TME adapter.2. All incoming events are written to the reception log, and marked as QUEUED

or WAITING. The reception log is actually a table in the event database.3. Events marked QUEUED are sent to the reception buffer.4. QUEUED events are sent from the reception buffer to the rule engine for

processing.5. The dispatch engine signals the reception engine when rule engine processing

for an event is completed. The reception engine marks the event asPROCESSED in the reception log and removes it from the reception buffer. Ifthe rule engine could not successfully parse the event for processing, it ismarked as PARSING_FAILED in the reception log.


Master

1

1

Reception engine

Receptionbuffer

Receptionlog

Rule engine

Dispatchengine

1

2 3

4

5

IncomingTivoli eventsfrom non-TME

adapter


from TMEadapter

The state of an event during the reception process (PARSING_FAILED,PROCESSED, QUEUED, and WAITING) is specific to the reception engine and isnot an event attribute. The states are defined as follows:

PARSING_FAILEDThe event is invalid. It is not of a known event class to the event server orthe event class attributes are not formatted correctly. The event isdiscarded; that is, it is not inserted into the event repository, but it can stillbe viewed in the reception log.

PROCESSEDThe event is valid and has been successfully processed by the rule engine.

QUEUEDThe event is waiting in the reception buffer for rule engine processing. Thereception buffer is a FIFO queue. If you routinely see QUEUED events inthe output from the wtdumprl command, you have a rules engine that istoo busy. If you only see PROCESSED events in the output from thewtdumprl command, you have an adequately sized reception buffer andefficient rule engine processing.

WAITINGThe reception buffer is full. When the reception buffer can accept the event,it will be changed to a QUEUED state. If you routinely see WAITINGevents in the output of the wtdumprl command, your reception buffer isprobably configured too small, your rule engine is too busy, or both.

When the event server is restarted, the reception engine is reloaded with eventsfrom the reception log that are in a WAITING or QUEUED state.

Internally generated events (for example, those generated by rules) are notprocessed by the reception engine. They never appear in the reception log or thereception buffer.

The reception buffer is RAM and its size can be configured with the wsetesvrcfgcommand or from the Event Server Parameters dialog.

Chapter 4. Event Flow 175

Rule Engine ProcessThe rule engine is a rules-based event processor. An event is sent to the rule engineby the reception engine. Next, the event is evaluated against the rules. After ruleprocessing, the event is placed into the rule engine’s event cache. The event in therule engine currently being evaluated is referred to as the event under analysis. Anevent that satisfies the specification criteria of a rule causes the rule to run, whichmeans the rule’s actions are performed. This is the first input stream into the ruleengine.

A second input stream comes from the dispatch process. This input streamcontains changes made to events that have already been received by the eventserver, typically coming from a change made by activity at an event console.

A third input stream comes from requests for changes to events from the executionof actions by the task process. This input stream comes to the rule engine from atask process thread through the dispatch process.

The output stream from the rule engine goes to the dispatch process. Once anevent is evaluated against the rules, it is forwarded to the dispatch process forstorage in the event repository.

It is important to note that the rule engine evaluates and correlates events withother events in the rule engine’s event cache. The event cache is RAM. The ruleengine does not interact with the event database.

Dispatch Engine ProcessThe main functions of the dispatch engine are to keep the event database currentand send updated event information to event consoles. The dispatch enginecommunicates with the rule engine and the task engine to know when to updateevent information. If tasks or programs need to be run for an event, the dispatchengine contacts the task engine for running them. The dispatch engine also handlesrequests for event changes coming from an event console (by way of the UI server)and sends them to the rule engine. Additionally, when the event server is started,the dispatch engine retrieves events from the event database to reload the eventcache for the rule engine.

User Interface ServerThe UI server is a process that provides communication services between eventconsoles and the event server, and between event consoles and the event database.It communicates with the dispatch engine when it needs contact with the eventserver. The UI server provides the event consoles with updated event informationand provides the dispatch engine with change requests to events from eventconsoles.

The UI server can be installed on any managed node in the TMR, but only on onemanaged node. It doesn’t have to be located on the same host as the event server.The name of the UI server process is tec_ui_server. If the UI server fails, errormessages are written to the /tmp/ui_server file. The name of this error file isdefined in the $BINDIR/TME/TEC/.ui_server_diag_config file and can bechanged.


Task Engine ProcessThe task engine runs programs, tasks, scripts, and commands initiated by rules. Itmonitors these running items and can return their exit status to the dispatchengine, which writes the status to the event database.

The task engine runs these items as it receives requests to do so. It does not waitfor a running item to complete before starting another.

The num_actions attribute for an event contains the number of actions (tasks orprograms) currently being tracked by the event server for the event.

Chapter 4. Event Flow 177

Appendix. Configuration Parameters

The following are parameters which can be set in the .tec_config file. This file islocated in the $BINDIR/TME/TEC directory. The parameters can also be set withinrules by using the get_config_param predicate.

Note: The tec_recv_agent_port, tec_disp_rule_port, and tec_rec_rule_portparameters indicate which port numbers will be used for sending eventswithout using Tivoli Management Framework communication services. Portnumbers should be set to a value that is larger than 5000 to avoid conflictwith automatically assigned ports.

Parameter Use

tec_recv_agent_port Specifies the port used for inter-processcommunication by the tec_reception process.This parameter is required on UNIX.

tec_disp_rule_port Specifies the port used for inter-processcommunication for the tec_dispatch process.

tec_recv_rule_port Specifies the port used for inter-processcommunication for the tec_rule process.

tec_tmpfile_dir Specifies the directory where temporary filescan be created and manipulated. Thesetemporary files are used when rules write toa scratch directory.

tec_rule_cache_size Specifies the number of events stored in therule engine event cache.

tec_rule_cache_full_history Specifies, in seconds, the maximum time anopen event is allowed in the rule engineevent cache.

tec_rule_cache_non_closed_history Specifies, in seconds, the maximum time aclosed event is allowed in the rule engineevent cache.

tec_rule_cache_clean_freq Specifies the frequency for emptying the ruleengine event cache.

tec_rule_trace Activates or inhibits compiling rules withtracing. If set to YES, the parametertec_rule_trace_file must also be set.

tec_rule_trace_file Specifies the filename where tracinginformation will be written. Must be set iftec_rule_trace is set to YES.

tec_rule_host Specifies the host where the rule engineruns.

tec_server_handle Specifies the numeric identifier for theserver.

event_cache_file Specifies the filename of the event cache.This is used to cache incoming events whenevents are recieved faster than they can beprocessed.


Parameter Use

tec_exectask_dbcs Specifies how slot parameters of type stringshould be passed to the task engine. If set toTRUE, slot parameters are converted to thelocal code set before the task is executed. Ifset to FALSE, the parameters are passed asUTF8.

always_expect_utf8 Indicates whether all incoming events willbe in UTF8 format.


Notices

This information was developed for products and services offered in the U.S.A.IBM may not offer the products, services, or features discussed in this document inother countries. Consult your local IBM representative for information on theproducts and services currently available in your area. Any reference to an IBMproduct, program, or service is not intended to state or imply that only that IBMproduct, program, or service may be used. Any functionally equivalent product,program, or service that does not infringe any IBM intellectual property right maybe used instead. However, it is the user’s responsibility to evaluate and verify theoperation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matterdescribed in this document. The furnishing of this document does not give youany license to these patents.You can send license inquiries, in writing, to:

IBM Director of Licensing

IBM Corporation

North Castle Drive

Armonk, NY 10504-1785 U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBMIntellectual Property Department in your country or send inquiries, in writing, to:

IBM World Trade Asia Corporation

Licensing

2-31 Roppongi 3-chome, Minato-ku

Tokyo 106, Japan

The following paragraph does not apply to the United Kingdom or any othercountry where such provisions are inconsistent with local law:

INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THISPUBLICATION ″AS IS″ WITHOUT WARRANTY OF ANY KIND, EITHEREXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIEDWARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESSFOR A PARTICULAR PURPOSE.

Some states do not allow disclaimer of express or implied warranties in certaintransactions, therefore, this statement might not apply to you.

This information could include technical inaccuracies or typographical errors.Changes are periodically made to the information herein; these changes will beincorporated in new editions of the publication. IBM may make improvementsand/or changes in the product(s) and/or the program(s) described in thispublication at any time without notice.


Any references in this information to non-IBM Web sites are provided forconvenience only and do not in any manner serve as an endorsement of those Websites. The materials at those Web sites are not part of the materials for this IBMproduct and use of those Web sites is at your own risk.

IBM may use or distribute any of the information you supply in any way itbelieves appropriate without incurring any obligation to you.

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

IBM Corporation

2Z4A/101

11400 Burnet Road

Austin, TX 78758 U.S.A.

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

The licensed program described in this document and all licensed materialavailable for it are provided by IBM under terms of the IBM Customer Agreement,IBM International Program License Agreement or any equivalent agreementbetween us.

Any performance data contained herein was determined in a controlledenvironment. Therefore, the results obtained in other operating environments mayvary significantly. Some measurements may have been made on development-levelsystems and there is no guarantee that these measurements will be the same ongenerally available systems. Furthermore, some measurement may have beenestimated through extrapolation. Actual results may vary. Users of this documentshould verify the applicable data for their specific environment.

Information concerning non-IBM products was obtained from the suppliers ofthose products, their published announcements or other publicly available sources.IBM has not tested those products and cannot confirm the accuracy ofperformance, compatibility or any other claims related to non-IBM products.Questions on the capabilities of non-IBM products should be addressed to thesuppliers of those products.

All statements regarding IBM’s future direction or intent are subject to change orwithdrawal without notice, and represent goals and objectives only.

This information contains examples of data and reports used in daily businessoperations. To illustrate them as completely as possible, the examples include thenames of individuals, companies, brands, and products. All of these names arefictitious and any similarity to the names and addresses used by an actual businessenterprise is entirely coincidental.

This information contains sample application programs in source language, whichillustrate programming techniques on various operating platforms. You may copy,modify, and distribute these sample programs in any form without payment to


IBM, for the purposes of developing, using, marketing or distributing applicationprograms conforming to the application programming interface for the operatingplatform for which the sample programs are written. These examples have notbeen thoroughly tested under all conditions. IBM, therefore, cannot guarantee orimply reliability, serviceability, or function of these programs. You may copy,modify, and distribute these sample programs in any form without payment toIBM for the purposes of developing, using, marketing, or distributing applicationprograms conforming to IBM’s application programming interfaces.

If you are viewing this information in softcopy form, the photographs and colorillustrations might not appear.

TrademarksThe following terms are trademarks of International Business MachinesCorporation in the United States, other countries, or both:

AIX IBMLink Tivoli Logo

DB2 NetView Tivoli Enterprise

IBM OS/390 Tivoli Enterprise Console

IBM Logo Tivoli TME

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

Microsoft and Windows NT are registered trademarks of Microsoft Corporation inthe United States, other countries, or both.

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

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

Notices 183

Glossary

This glossary includes Tivoli product terminology as well as selected terms and definitions from:v The American National Standard Dictionary for Information Systems, ANSI X3.172-1990, copyright 1990 by

the American National Standards Institute (ANSI). Copies may be purchased from the AmericanNational Standards Institute, 11 West 42nd Street, New York, New York 10036. Definitions areidentified by the symbol (A) after the definition.

v The ANSI/EIA Standard--440-A, Fiber Optic Terminology. Copies may be purchased from the ElectronicIndustries Association, 2001 Pennsylvania Avenue, N.W., Washington, DC 20006. Definitions areidentified by the symbol (E) after the definition.

v The Information Technology Vocabulary developed by Subcommittee 1, Joint Technical Committee 1, ofthe International Organization for Standardization and the International Electrotechnical Commission(ISO/IEC JTC1/SC1). Definitions of published parts of this vocabulary are identified by the symbol (I)after the definition; definitions taken from draft international standards, committee drafts, and workingpapers being developed by ISO/IEC JTC1/SC1 are identified by the symbol (T) after the definition,indicating that final agreement has not yet been reached among the participating National Bodies ofSC1.

v The IBM Dictionary of Computing, New York: McGraw-Hill, 1994.v Internet Request for Comments: 1208, Glossary of Networking Terms.v Internet Request for Comments: 1392, Internet Users’ Glossary.v The Object-Oriented Interface Design: IBM Common User Access Guidelines, Carmel, Indiana: Que, 1992.


The following cross-references are used in this glossary:

Contrast with:This refers the reader to a term that has an opposed or substantively different meaning.

See: This refers the reader to (a) a related term, (b) a term that is the expanded form of anabbreviation or acronym, or (c) a synonym or more preferred term.

Obsolete term for:This indicates that the term should not be used and refers the reader to the preferred term.

AACF. See Adapter Configuration Facility

ACP. See adapter configuration profile.

adapter. (1) A part that electrically or physicallyconnects a device to a computer or to another device.(2) See event adapter.

Adapter Configuration Facility (ACF). In the TivoliEnterprise Console, a graphical user interface thatenables a Tivoli administrator to easily configure andcustomize event adapters.

adapter configuration profile (ACP). In a Tivolienvironment, a Tivoli Enterprise Console profile thatcontains information for one or more event adapters.

API. See application programming interface.

application programming interface (API). A softwareinterface that enables applications to communicate witheach other. An API is the set of programming languageconstructs or statements that can be coded in anapplication program to obtain the specific functionsand services provided by an underlying operatingsystem or service program.

attribute. A characteristic that identifies and describesa managed object. The characteristic can be determined,and possibly changed, through operations on themanaged object.

BBAROC. See Basic Recorder of Objects in C.

Basic Recorder of Objects in C (BAROC). In theevent server of the Tivoli Enterprise Console, theinternal representation of the defined event classes.

Cclass. (1) In object-oriented design or programming, amodel or template that can be instantiated to createobjects with a common definition and therefore,common properties, operations, and behavior. An objectis an instance of a class. (2) In the AIX operating

system, pertaining to the I/O characteristics of adevice. System devices are classified as block orcharacter devices.

CLI. See command line interface.

command line interface (CLI). A type of computerinterface in which the input command is a string of textcharacters. Contrast with graphical user interface.

Ddatabase. (1) A collection of data with a givenstructure for accepting, storing, and providing, ondemand, data for multiple users. (T) (2) A collection ofinterrelated data organized according to a databaseschema to serve one or more applications. (T) (3) Acollection of data fundamental to a system. (A) (4) Acollection of data fundamental to an enterprise. (A)

Eevent. (1) An occurrence of significance to a task (suchas the opening of a window or the completion of anasynchronous operation). (2) In the Tivoli environment,any significant change in the state of a system resource,network resource, or network application. An event canbe generated for a problem, for the resolution of aproblem, or for the successful completion of a task.Examples of events are: the normal starting andstopping of a process, the abnormal termination of aprocess, and the malfunctioning of a server.

event adapter. In a Tivoli environment, software thatconverts events into a format that the Tivoli EnterpriseConsole can use and forwards the events to the eventserver. Using the Tivoli Event Integration Facility, anorganization can develop its own event adapters,tailored to its network environment and specific needs.

event class. In the Tivoli Enterprise Console, aclassification for an event that indicates the type ofinformation that the event adapter will send to theevent server.

event console. In the Tivoli Enterprise Console, agraphical user interface (GUI) that enables systemadministrators to view and respond to dispatched


events from the event server. The Tivoli EventIntegration Facility does not directly use or affect eventconsoles.

event correlation. In the Tivoli Enterprise Console, theprocess of correlating separate events to a commoncause. For example, the Tivoli Enterprise Console mayreceive several NFS server not responding events fromseveral different applications, as well as a host downevent for the NFS server. The Tivoli Enterprise Consolecan then correlate the various NFS server notresponding events to their common cause, which is: theNFS server is “down.” See rule.

event filter. (1) In a Tivoli environment, software thatdetermines which events are forwarded to a specifieddestination. Filtering events helps to reduce networktraffic. Tivoli administrators configure the event filters.(2) In Tivoli NetView, a logical expression of criteriathat determine which events are forwarded to theapplication program that registers the event filter withthe event sieve agent. A filter is referred to as “simple”or “compound” depending on how it is handled by thefilter editor.

event group. In the Tivoli Enterprise Console, a set ofevents that meet certain criteria. Each event group isrepresented by an icon on the event console. Tivoliadministrators can monitor event groups that arerelevant to their specific areas of responsibility.

event server. In the Tivoli Enterprise Console, acentral server that processes events. The event servercreates an entry for each incoming event and evaluatesthe event against a rule base to determine whether itcan respond to or modify the event automatically. Theevent server also updates the event consoles with thecurrent event information. If the primary event serveris not available, events can be sent to a secondary eventserver.

Ggraphical user interface (GUI). A type of computerinterface consisting of a visual metaphor of areal-world scene, often of a desktop. Within that sceneare icons, representing actual objects, that the user canaccess and manipulate with a pointing device. Contrastwith command line interface.

GUI. See graphical user interface.

Hhost. (1) A computer that is connected to a network(such as the Internet or an SNA network) and providesan access point to that network. Also, depending on theenvironment, the host may provide centralized controlof the network. The host can be a client, a server, orboth a client and a server simultaneously. (2) In a Tivoli

environment, a computer that serves as a managednode for a profile distribution.

IInternet Protocol (IP). In the Internet suite ofprotocols, a connectionless protocol that routes datathrough a network or interconnected networks and actsas an intermediary between the higher protocol layersand the physical network.

IP. See Internet Protocol.

Mmanaged node. (1) In Internet communications, aworkstation, server, or router that contains a networkmanagement agent. In the Internet Protocol (IP), themanaged node usually contains a Simple NetworkManagement Protocol (SNMP) agent. (2) In a Tivolienvironment, any managed resource on which theTivoli Management Framework is installed.

managed resource. In a Tivoli environment, anyhardware or software entity (machine, service, system,or facility) that is represented by a database object andan icon on the Tivoli desktop. Managed resources mustbe a supported resource type in a policy region and aresubject to a set of rules. Managed resources include, butare not limited to, managed nodes, task libraries,monitors, profiles, and bulletin boards.

Nname registry. In a Tivoli environment, a name serviceconsisting of a two-dimensional table that mapsresource names to resource identifiers andcorresponding information within a Tivoli ManagementRegion.

Oobject path. In a Tivoli environment, an absolute orrelative path to a Tivoli object, similar to paths in filesystems.

PPerl. A scripting language that was originallydesigned by Larry Wall as a tool for writing programsin the UNIX environment but has evolved to includethe power and flexibility of a high-level programminglanguage such as C. The acronym Perl is derived fromPractical Extraction and Report Language. Perl is anopen-source language.

policy. In a Tivoli environment, a set of rules that areapplied to managed resources. A specific rule in apolicy is referred to as a policy method.

Glossary 187

policy region. In a Tivoli environment, a group ofmanaged resources that share one or more commonpolicies. Tivoli administrators use policy regions tomodel the management and organizational structure ofa network computing environment. The administratorscan group similar resources, define access to andcontrol the resources, and associate rules for governingthe resources. The policy region contains resource typesand the list of resources to be managed. A policy regionis represented on the Tivoli desktop by an icon thatresembles a capitol building (dome icon). When a TivoliManagement Region (TMR) is created, a policy regionwith the same name is also created. In this case, theTMR has only one policy region. However, in mostcases, a Tivoli administrator creates other policy regionsand subregions to represent the organization of theTMR. A TMR addresses the physical connectivity ofresources whereas a policy region addresses the logicalorganization of resources.

profile. In a Tivoli environment, a container forapplication-specific information about a particular typeof resource. A Tivoli application specifies the templatefor its profiles; the template includes information aboutthe resources that can be managed by that Tivoliapplication.

A profile is created in the context of a profile manager;the profile manager links a profile to the Tivoli resource(for example, a managed node) that uses theinformation contained in the profile. A profile does nothave any direct subscribers.

Rregistered name. In a Tivoli environment, the name bywhich a particular resource is registered with the nameregistry when it is created.

resource. (1) Any facility of a computing system oroperating system required by a job or task, andincluding main storage, input/output devices, theprocessing unit, data sets, and control or processingprograms. (2) In Tivoli NetView for OS/390, anyhardware or software that provides function to thenetwork. (3) See managed resource.

rule. In the Tivoli Enterprise Console, one or morelogical statements that enable the event server torecognize relationships among events (eventcorrelation) and to execute automated responsesaccordingly. See also rule base and rule set.

rule base. In the Tivoli Enterprise Console, one ormore rule sets and the event class definitions for whichthe rules are written. The Tivoli Enterprise Consoleuses the rule base in managing events. An organizationcan create many rule bases, with each rule basefulfilling a different set of needs for network computingmanagement.

rule set. In the Tivoli Enterprise Console, a file thatcontains one or more rules. See also rule base.

Sscript. A computer program that is interpreted. Seeshell script.

severity level. In the Tivoli Enterprise Console, aclassification for an event that indicates its degree ofseverity. Severity levels can be modified by a user or aTivoli Enterprise Console rule. The predefined severitylevels, in order of descending severity, include: fatal,critical, warning, minor, harmless, and unknown.

shell script. In the UNIX operating system, a series ofcommands, combined in a file, that carry out aparticular function when the file is run or when the fileis specified as a value to the sh command.

Simple Network Management Protocol (SNMP). Inthe Internet suite of protocols, a network managementprotocol that is used to monitor routers and attachednetworks. SNMP is an application layer protocol.Information on devices managed is defined and storedin the application’s Management Information Base(MIB).

SNMP. See Simple Network Management Protocol.

Ttask. (1) In a multiprogramming or multiprocessingenvironment, one or more sequences of instructionstreated by a control program as an element of work tobe accomplished by a computer. (I) (A) (2) In aTivoli environment, the definition of an action thatmust be routinely performed on various managednodes throughout the network. A task defines theexecutables to be run when the task is executed, theauthorization role required to execute the task, and theuser or group name under which the task will execute.

TEC. See Tivoli Enterprise Console.

Tivoli Enterprise Console (TEC). A Tivoli productthat collects, processes, and automatically initiatescorrective actions for system, application, network, anddatabase events; it is the central control point for eventsfrom all sources. The Tivoli Enterprise Consoleprovides a centralized, global view of the networkcomputing environment; it uses distributed eventmonitors to collect information, a central event serverto process information, and distributed event consolesto present information to system administrators.

Tivoli Enterprise software. The integrated suite ofTivoli products for systems management in a largeorganization. These products enable systemadministrators to manage their network computingenterprise according to the disciplines of availability


management, deployment management, operations andadministration, security management, and service-levelmanagement. This suite includes Tivoli GlobalEnterprise Manager, Tivoli NetView for OS/390, andTivoli Decision Support.

Tivoli Event Integration Facility. A Tivoli toolkit thatprovides a simple application programming interface(API) to enable customers and Tivoli Partners todevelop new event adapters that can forward events tothe Tivoli Enterprise Console.

Tivoli Management Region (TMR). In a Tivolienvironment, a Tivoli server and the set of clients thatit serves. An organization can have more than oneTMR. A TMR addresses the physical connectivity ofresources whereas a policy region addresses the logicalorganization of resources.

TME 10. See Tivoli Enterprise software.

TMR. See Tivoli Management Region.

Vvalidation. The checking of data for correctness or forcompliance with applicable standards, rules, andconventions. (A)

validation policy. In a Tivoli environment, policy thatensures that all resources in a policy region complywith the region’s established policy. Validation policyprevents Tivoli administrators from creating ormodifying resources that do not conform to the policyof the policy region in which the resources werecreated.

Glossary 189

Index

Special characters.baroc file, importing into a rule base 76.tec_diag_config file 173.ui_server_diag_config file 176’ (single quote) 9, 66

Aabsolute object reference 3absolute path 3ACF interface, linking to configuration tools 98ACF, See Adapter Configuration Facility 6acl environment variable 167ACP, See adapter configuration profile 14actions, described 176adapter

installing environment variables for 97installing validation information for 100showing installed validation information 54

Adapter Configuration Facility commandssummary of 6

adapter configuration profile (ACP)adding an adapter configuration record for 14adding an adapter type default for 89modifying an adapter configuration record for 84modifying an adapter type default for 89modifying environment variables on ACP endpoints 103removing adapter configuration record from 44showing adapter configuration records in 46showing environment variables for endpoints 56updating ACP record modification time 135

adapter configuration recordadding, for an ACP 14adding, for an adapter type default 89modifying, for an ACP 84modifying, for an adapter type default 89removing from an ACP 44showing, in an ACP 46

adapter_host environment variable 167adding

adapter configuration record for an ACP 14adapter configuration record for an adapter type

default 89event group filters 23

administrator environment variable 167argument, optional 2arguments (how used in command line) 140assigned event groups, listing 28assigning

event groups 25event groups, unassigning 29operators to a console 25

attributeresetting event source 110

Ccause_date_reception environment variable 167cause_event_handle environment variable 167Change_Severity task 139, 141

checkingavailability of the database server 122event class definition file 18validity of event class definition file 8

CHILD_OF_OSERV environment variable 165chkclass command 8class environment variable 167class file

deleting 74class_name environment variable 167Clean_Database task 139, 142Clear_Closed_Events task 139, 144Clear_Reception_Log task 139, 145clearing, events from the event database 115, 118Close_Event task 139, 146command

See also command line 140command line

arguments 140examples 140executable tasks 139syntax 140

command summariesACF commands 6console commands 4database commands 6event message commands 4event server commands 5rule base commands 6source commands 4

commandschkclass 8postemsg 9postzmsg 10tec_console 11upgrade_gui.sh 13waddac 14wchkclass 18wconsole 20wcrtnvgroups 37wcrtsrc 35wdbconfig.sh 39wdbmaint.sh 42wdelac 44wdelsrc 45wlsac 46wlsaddflt 49wlsadenv 52wlsadgui 53wlsadval 54wlsaeenv 56wlsemsg 58wlsesvrcfg 60wlssrc 62wmigcon 63wpostemsg 66wpostzmsg 10wrb 69wrbupgrade 82wruntask 140wsendresp 83


commands (continued)wsetac 84wsetaddflt 89wsetadenv 97wsetadgui 98wsetadval 100wsetaeenv 103wsetemsg 106wsetesvrcfg 108wsetsrc 110wstartesvr 111wstatesvr 112wstopesvr 113wstoptecgw 114wtdbclear 115wtdbclear.pl 118wtdbspace 120wtdbstat 122wtdumper 123wtdumprl 125wtdumptr 127wtecexport 129wtecimport 132wtouchac 135

compiling, rules 71completed tasks, generating report on 127configuration parameters

listing for an event server 60setting for the event server 108

configuration toolslinking to ACF interface 98showing installed link to 53

configure (definition in task context) 138console commands

summary of 4CONSOLE_NAME environment variable 165copying

event console 26rule base 71

creatingevent console 26event group 27event groups for netview.rls 37rule base at the event server 72rule base target 72rule pack 72source on the event server 35

credibility environment variable 167CRITICAL severity level 10Customer Support vi

Ddatabase commands

summary of 6database configuration scripts, running 39database server, checking availability 122database statistics, updating 42database, reorganizing 42date environment variable 167date_event environment variable 167date_reception environment variable 167deleting

class file 74event console 27event group 28event group filters 28

deleting (continued)rule base from the event server 74rule base target 75rule pack 74rule set from a rule base 75rule set from a rule pack 75source from an event server list 45

directory names, notation viidispatch engine process 173, 176DISPLAY environment variable 165displaying

event server status 112message to an administrator’s desktop 83

Dump_Event_Repository task 139, 147duration environment variable 168

Ee-mail contact viendpoint

modifying environment variables on 103showing environment variables for an ACP 56

ENDPOINT environment variable 165ENDPOINT_OID environment variable 166environment variable

acl 167adapter_host 167administrator 167availability to tasks executing with event 165cause_date_reception 167cause_event_handle 167CHILD_OF_OSERV 165class 167class_name 167CONSOLE_NAME 165credibility 167date 167date_event 167date_reception 167descriptions of 165DISPLAY 165duration 168ENDPOINT 165ENDPOINT_OID 166ev_key 168event attribute 167EVENT_CLASS 166event_handle 168event_hndl 168examples

program from Java console 171task from Java console 169

for an ACP endpoint, showing 56hostname 168installing for an adapter 97INTERP 166LANG 166last_modified_time 168LD_LIBRARY_PATH 166LIBPATH 166msg 168msg_catalog 168msg_index 168NLSPATH 166num_actions 168o_dispatch 168on ACP endpoints, modifying 103


environment variable (continued)origin 168PATH 166PRINCIPAL 166repeat_count 168server_handle 168server_hndl 168server_path 168severity 169SHLIB_PATH 166showing adapter-specific EIF 52SLOTS 166source 169status 169sub_origin 169sub_source 169TEC_BIN_DIR 166TEC_KB_DIR 166TEC_MASTER_PORT 166TEC_MASTER_START_TIMEOUT 166TEC_RECV_BUFSIZE 166TEC_RECV_LOG 166TEC_RULE_CACHE_CLEAN_FREQ 166TEC_RULE_CACHE_FULL_HISTORY 166TEC_RULE_CACHE_NON_CLOSED_HISTORY 166TEC_RULE_CACHE_SIZE 166TEC_RULE_TRACE 166TEC_RULE_TRACE_FILE 167TISDIR 167TZ 167WLOCALHOST 167

error files 173ev_key environment variable 168event

clearing from event database 115, 118generating report of events received by event server 125generating report on 123in server database, listing 58message commands 4modifying event 106posting to the event server 9, 66resetting event source attributes 110severity levels 10specifying the number of, for the event cache 108

event attribute variable 167event attributes

num_actions 177event cache, specifying the number of events for 108event class definition file, checking validity of 8, 18event class listing 78event class specifications, importing into a rule base 76event console

assign event group 25assign operators 25assigned event groups, list 28change name 29copy 26create 26create event group 27delete 27delete event group 28event group filter, change name of 29event group, change name of 29event groups, list 28filters, adding event group 23filters, deleting event group 28managing 20

event console (continued)show defined 28starting 11unassign event groups 29unassign operators 30

event databaseclearing events from 115, 118

event group filters, adding 23event group filters, changing names of 29event group filters, deleting 28event groups, adding for netview.rls 37event groups, changing names of 29event groups, listing 28event groups, listing assigned 28event message commands

summary of 4event server 58

architecture description 173commands 5displaying status of 112generating report of events received by 125generating report on tasks completed by 127listing configuration parameters for 60listing sources on 62posting an event to 9, 66setting configuration parameters for 108starting 111stopping 113

event server commandssummary of 5

event server list, deleting a source from 45event states

described 175PARSING_FAILED 175PROCESSED 175QUEUED 175WAITING 175

event under analysis 176Event Viewer 157EVENT_CLASS environment variable 166event_handle environment variable 168event_hndl environment variable 168Event_Query task 139, 149events

current 176event under analysis 176internal events, processing 175states 175

See also event states 175under analysis 176

FFATAL severity level 10feedback about publications vifiles

.tec_diag_config 173

.ui_server_diag_config 176error files 173, 176tec_dispatch 173tec_master 173tec_rule 173tec_task 173ui_server_diag_config 176

filters, adding event group 23filters, deleting event group 28Find_Similar_Events task 139, 154

Index 193

Forward_Event task 139, 156

Ggateway

stopping 114generating

event report 123report on completed tasks 127

HHARMLESS severity level 10hostname environment variable 168

Iimporting

.baroc file into a rule base 76event class specifications into a rule base 76rule pack into a rule base target 77rule set into a rule base 76rule set into a rule base target 77rule set into a rule pack 77

installed link, to extended configuration tools, showing 53installing

environment variables for an adapter 97link from the ACF interface to configuration tools 98validation information for an adapter type 100

internal events, processing 175internationalization, issues for postemsg 9internationalization, issues for wpostemsg 66INTERP environment variable 166

LLANG environment variable 166last_modified_time environment variable 168LD_LIBRARY_PATH environment variable 166LIBPATH environment variable 166link, to extended configuration tools, showing 53linking, ACF interface to a configuration tool 98listing

assigned event groups 28configuration parameters for an event server 60event classes 78event consoles, defined 28event groups 28events in database 58received events 58rule base targets 80rule base, loaded 78rule bases, defined on the event server 78rule packs 79rule sets 79sources on the event server 62

loading, rule base onto the event server 78Log_Event_To_File task 139, 157

Mmaster process 173, 174message, displaying to an administrator’s desktop 83MINOR severity level 10modification time, updating in an ACP record 135

modifyingadapter configuration record for an ACP 84adapter configuration record for an adapter type

default 89environment variables on ACP endpoints 103event 106

msg environment variable 168msg_catalog environment variable 168msg_index environment variable 168

Nname registry, described 3names, registered 3NLSPATH environment variable 166num_actions attribute 177num_actions environment variable 168

Oo_dispatch environment variable 168object

paths 3reference 3referenced from command 3

online publications vioperators, assigning to a console 25operators, unassigning from a console 30optional argument 2origin environment variable 168

Pparent directory path component 3PARSING_FAILED event state 175path component

absolute 3current directory 3parent directory 3relative 3

PATH environment variable 166path names, notation viipaths, object 3Popup_Message task 139, 158postemsg command 9posting, event to the event server 9, 66postzmsg command 10PRINCIPAL environment variable 166PROCESSED event state 175processes

dispatch engine 173, 176master 173, 174reception engine 173, 174rule engine 173, 176task engine 173, 177tec_dispatch 173, 176tec_reception 173, 174tec_rule 173, 176tec_server 173, 174tec_task 173, 177tec_ui_server 173, 176user interface (UI) server 173, 176


QQUEUED event state 175

Rreception buffer 174, 175reception engine process 174reception log, described 174reception log, specifying time to retain events 109reception process 173registered name, described 3relative path 3removing

adapter configuration record from an ACP 44repeat_count environment variable 168reports

completed tasks 127events received by event server 125

resettingevent source attributes 110

rulecompiling 25, 26, 27, 28, 29, 30, 71

rule actions, described 176rule base

commands 6consistent state conditions 69copying 71creating, at the event server 72deleting, from the event server 74importing into 69listing defined 78listing loaded 78loading onto the event server 78managing 69setting properties 80upgrading pre-3.7 versions 82

rule base commandssummary of 6

rule base targetcreating 72deleting 75listing 80

rule builder rules, upgrading 13rule engine

process 173, 176tec_rule process 173, 176

rule packcreating 72deleting 74importing into a rule base target 77listing 79

rule setdeleting from a rule base 75deleting from a rule pack 75importing into a rule base 76importing into a rule base target 77importing into a rule pack 77listing 79

rule_builder.pro file 13

SSend_Email task 139, 159Send_Event task 139, 160server_handle environment variable 168server_hndl environment variable 168

server_path environment variable 168services

See processes 174setting

configuration parameters for the event server 108rule base properties 80time to retain in reception log 109

severity environment variable 169severity level, events 10SHLIB_PATH environment variable 166showing

adapter configuration records in an ACP 46adapter-specific EIF environment variables 52adapter-type installed validation information 54See also listing 46

SLOTS environment variable 166source

commands 4creating, on the event server 35deleting from an event server list 45on event server, listing 62

source commandssummary of 4

source environment variable 169special characters

’ (single quote) 9, 66starting event console 11starting, event server 111status environment variable 169stopping

event server 113gateway 114

string, size limit 2sub_origin environment variable 169sub_source environment variable 169syntax, command line 140

TT/EC Tasks dialog 138task

Change_Severity 139, 141Clean_Database 139, 142Clear_Closed_Events 139, 144Clear_Reception_Log 139, 145Close_Event 139, 146descriptive names 139Dump_Event_Repository 139, 147Event_Query 139, 149Find_Similar_Events 139, 154Forward_Event 139, 156Log_Event_To_File 139, 157output 139overview 137Popup_Message 139, 158script file names 139Send_Email 139, 159Send_Event 139, 160Wake_Up_Netscape 139, 163

task engine process 173, 177Task Output dialog 139TEC_BIN_DIR environment variable 166tec_console command 11tec_diag_config file 173tec_dispatch error file 173tec_dispatch process 173, 176TEC_KB_DIR environment variable 166

Index 195

tec_master error file 173TEC_MASTER_PORT environment variable 166TEC_MASTER_START_TIMEOUT environment variable 166tec_reception process 173, 174TEC_RECV_BUFSIZE environment variable 166TEC_RECV_LOG environment variable 166tec_rule error file 173tec_rule process 173, 176TEC_RULE_CACHE_CLEAN_FREQ environment

variable 166TEC_RULE_CACHE_FULL_HISTORY environment

variable 166TEC_RULE_CACHE_NON_CLOSED_HISTORY environment

variable 166TEC_RULE_CACHE_SIZE environment variable 166TEC_RULE_TRACE environment variable 166TEC_RULE_TRACE_FILE environment variable 167tec_server process 173, 174tec_task error file 173tec_task process 173, 177tec_ui_server process 176TISDIR environment variable 167Tivoli Customer Support viTivoli environment, setting up 1TZ environment variable 167

UUI server process

See user interface server process 176ui_server_diag_config file 176unassigning

operators from a console 30unassigning event groups 29UNKNOWN severity level 10updating, ACP record modification time 135upgrade_gui.sh command 13upgrading rule builder rules 13upgrading, pre-3.7 rule bases 82user interface (UI) server process 173, 176

Vvalidation information

adapter type, showing 54installing for an adapter type 100

Wwaddac command 14WAITING event state 175Wake_Up_Netscape task 139, 163WARNING severity level 10wchkclass command 18wconsole command 20wcrtnvgroups command 37wcrtsrc command 35wdbconfig.sh command 39wdbmaint.sh command 42wdelac command 44wdelsrc command 45WLOCALHOST environment variable 167wlsac command 46wlsaddflt command 49wlsadenv command 52wlsadgui command 53

wlsadval command 54wlsaeenv command 56wlsemsg command 58wlsesvrcfg command 60wlssrc command 62wmigcon command 63wpostemsg command 66wpostzmsg command 10wrb command 69wrbupgrade command 82wruntask command 138, 140wsendresp command 83wsetac command 84wsetaddflt command 89wsetadenv command 97wsetadgui command 98wsetadval command 100wsetaeenv command 103wsetemsg command 106wsetesvrcfg command 108wsetsrc command 110wstartesvr command 111wstatesvr command 112wstopesvr command 113wstoptecgw command 114wtdbclear command 115wtdbclear.pl command 118wtdbspace command 120wtdbstat command 122wtdumper command 123wtdumprl command 125wtdumptr command 127wtecexport command 129wtecimport command 132wtouchac command 135


Printed in U.S.A.

GC32-0666-02

ibm tivoli enterprise console: reference...

Documents