TEC - Comandos e referência - [PDF Document] (2024)

TEC - Comandos e referência - [PDF Document] (1)

IBM Tivoli Enterprise Console

Command and Task ReferenceVersion 3.9

SC32-1232-00

���

TEC - Comandos e referência - [PDF Document] (2)

TEC - Comandos e referência - [PDF Document] (3)

IBM Tivoli Enterprise Console

Command and Task ReferenceVersion 3.9

SC32-1232-00

���

TEC - Comandos e referência - [PDF Document] (4)

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

First Edition (August 2003)

This edition applies to version 3, release 9 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.

TEC - Comandos e referência - [PDF Document] (5)

Contents

About this book . . . . . . . . . . . vWho should read this book . . . . . . . . . vPublications . . . . . . . . . . . . . . v

IBM Tivoli Enterprise Console library . . . . . vRelated publications . . . . . . . . . . viAccessing publications online . . . . . . . viOrdering publications . . . . . . . . . . vi

Contacting software support . . . . . . . . viiParticipating in newsgroups. . . . . . . . . viiConventions used in this guide . . . . . . . viii

Typeface conventions . . . . . . . . . . viiiOperating system-dependent variables andpaths . . . . . . . . . . . . . . . viiiCommand line syntax . . . . . . . . . . ix

Chapter 1. Commands . . . . . . . . 1Establishing the Tivoli environment. . . . . . . 1Using Tivoli commands. . . . . . . . . . . 1Object references . . . . . . . . . . . . . 2

Registered names . . . . . . . . . . . . 2Object paths . . . . . . . . . . . . . 3

Tivoli Enterprise Console commands . . . . . . 3Console commands . . . . . . . . . . . 4Source commands . . . . . . . . . . . 4Event message commands . . . . . . . . . 4Event server commands . . . . . . . . . 5Rule base commands . . . . . . . . . . 5Database commands . . . . . . . . . . . 5Adapter Configuration Facility commands . . . 6Adapter commands . . . . . . . . . . . 6

chkclass . . . . . . . . . . . . . . . . 7postemsg . . . . . . . . . . . . . . . 8postzmsg . . . . . . . . . . . . . . . 10tec_console . . . . . . . . . . . . . . 12TECAgent . . . . . . . . . . . . . . . 14upgrade_gui.sh . . . . . . . . . . . . . 16waddac. . . . . . . . . . . . . . . . 17wchkclass . . . . . . . . . . . . . . . 21wconsole . . . . . . . . . . . . . . . 22wcrtdefcfg . . . . . . . . . . . . . . . 35wcrtebizgroups . . . . . . . . . . . . . 36wcrtmtgroups . . . . . . . . . . . . . 37wcrtnvgroups . . . . . . . . . . . . . 38wcrtsrc . . . . . . . . . . . . . . . . 39wcrtteccfg . . . . . . . . . . . . . . . 40wdbconfig.sh . . . . . . . . . . . . . . 41wdbmaint.sh . . . . . . . . . . . . . . 42wdelac . . . . . . . . . . . . . . . . 44wdelsrc . . . . . . . . . . . . . . . . 45wlsac . . . . . . . . . . . . . . . . 46wlsaddflt . . . . . . . . . . . . . . . 49wlsadenv . . . . . . . . . . . . . . . 51wlsadgui . . . . . . . . . . . . . . . 52wlsadval . . . . . . . . . . . . . . . 53wlsaeenv . . . . . . . . . . . . . . . 55

wlsemsg . . . . . . . . . . . . . . . 56wlsesvrcfg . . . . . . . . . . . . . . . 58wlssrc . . . . . . . . . . . . . . . . 59wmigcon . . . . . . . . . . . . . . . 60wpostemsg (endpoint version) . . . . . . . . 62wpostemsg (managed node version) . . . . . . 64wpostzmsg (endpoint version) . . . . . . . . 66wpostzmsg (managed node version) . . . . . . 68wrb . . . . . . . . . . . . . . . . . 70wrb_default_rb . . . . . . . . . . . . . 85wrbupgrade . . . . . . . . . . . . . . 86wsendresp. . . . . . . . . . . . . . . 87wsetac . . . . . . . . . . . . . . . . 88wsetaddflt . . . . . . . . . . . . . . . 92wsetadenv. . . . . . . . . . . . . . . 97wsetadgui . . . . . . . . . . . . . . . 98wsetadval . . . . . . . . . . . . . . 100wsetaeenv . . . . . . . . . . . . . . 102wsetemsg. . . . . . . . . . . . . . . 105wsetesvrcfg . . . . . . . . . . . . . . 107wsetsrc . . . . . . . . . . . . . . . 109wsighup . . . . . . . . . . . . . . . 110wstartesvr . . . . . . . . . . . . . . 111wstartmaint.sh . . . . . . . . . . . . . 112wstatesvr . . . . . . . . . . . . . . . 113wstopesvr . . . . . . . . . . . . . . 114wstopmaint.sh . . . . . . . . . . . . . 115wstoptecgw . . . . . . . . . . . . . . 116wtdbclear. . . . . . . . . . . . . . . 117wtdbclear.pl . . . . . . . . . . . . . . 119wtdbspace . . . . . . . . . . . . . . 121wtdbstat . . . . . . . . . . . . . . . 123wtdumper . . . . . . . . . . . . . . 124wtdumprl . . . . . . . . . . . . . . 126wtdumptr . . . . . . . . . . . . . . 128wtecexport . . . . . . . . . . . . . . 129wtecimport . . . . . . . . . . . . . . 131wtouchac . . . . . . . . . . . . . . . 133

Chapter 2. Tasks . . . . . . . . . . 135Task names and scripts . . . . . . . . . . 136Task output . . . . . . . . . . . . . . 137Change_Severity . . . . . . . . . . . . 138Clean_Database . . . . . . . . . . . . 139Clear_Closed_Events . . . . . . . . . . . 140Clear_Reception_Log . . . . . . . . . . . 141Close_Event . . . . . . . . . . . . . . 142Dump_Event_Repository . . . . . . . . . 143Event_Query . . . . . . . . . . . . . 144Find_Similar_Events . . . . . . . . . . . 147Forward_Event . . . . . . . . . . . . . 149Log_Event_To_File . . . . . . . . . . . 150Popup_Message . . . . . . . . . . . . 151Send_Email . . . . . . . . . . . . . . 152Send_Event . . . . . . . . . . . . . . 153

© Copyright IBM Corp. 2002 iii

TEC - Comandos e referência - [PDF Document] (6)

Start_Maintenance . . . . . . . . . . . . 155Wake_Up_Netscape . . . . . . . . . . . 157

Chapter 3. Environment variablesavailable to tasks. . . . . . . . . . 159Variable descriptions . . . . . . . . . . . 159Examples . . . . . . . . . . . . . . . 163

Environment variable dump when running atask from a rule . . . . . . . . . . . 163Environment variable dump when running aprogram from the event console . . . . . . 164

Appendix. Configuration parameters 167

Notices . . . . . . . . . . . . . . 169Trademarks . . . . . . . . . . . . . . 171

Index . . . . . . . . . . . . . . . 173

iv IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (7)

About this book

The IBM® Tivoli Enterprise Console® product is a rule-based, event managementapplication that integrates system, network, database, and application managementto help ensure the optimal availability of an organization’s IT services. The IBMTivoli Enterprise Console Command and Task Reference describes Tivoli EnterpriseConsole commands, tasks provided in the task library shipped with the TivoliEnterprise Console product, and environment variables available to tasks in thetask library.

Who should read this bookThis book is for Tivoli Enterprise Console administrators who want to use thecommand line interface and configure Tivoli Enterprise Console tasks.

You should have prior knowledge of the following software:v The operating systems that your enterprise usesv Tivoli® Management Framework

PublicationsThis section lists publications in the Tivoli Enterprise Console library and relateddocuments. It also describes how to access Tivoli publications online and how toorder Tivoli publications.

IBM Tivoli Enterprise Console libraryThe following documents are available in the Tivoli Enterprise Console library:v IBM Tivoli Enterprise Console Adapters Guide, SC32-1242

Provides information about supported adapters, including how to install andconfigure these adapters.

v IBM Tivoli Enterprise Console Command and Task Reference, SC32-1232Provides details about Tivoli Enterprise Console commands, predefined tasksthat are shipped in the task library, and the environment variables that areavailable to tasks that run against an event.

v IBM Tivoli Enterprise Console Installation Guide, SC32-1233Describes how to install, upgrade, and uninstall the Tivoli Enterprise Consoleproduct.

v IBM Tivoli Enterprise Console Release Notes, SC32-1238Provides release-specific information that is not available until just before theproduct is sent to market.

v IBM Tivoli Enterprise Console Rule Developer’s Guide, SC32-1234Describes how to develop rules and integrate them for event correlation andautomated event management.

v IBM Tivoli Enterprise Console Rule Set Reference, SC32-1282Provides reference information about the Tivoli Enterprise Console rule sets.

v IBM Tivoli Enterprise Console User’s Guide, SC32-1235

© Copyright IBM Corp. 2002 v

TEC - Comandos e referência - [PDF Document] (8)

Provides an overview of the Tivoli Enterprise Console product and describeshow to configure and use the Tivoli Enterprise Console product to manageevents.

v IBM Tivoli Enterprise Console Warehouse Enablement Pack: Implementation Guide,SC32-1236Describes how to install and configure the warehouse enablement pack for theTivoli Enterprise Console product and describes the data flow and structuresthat are used by the warehouse pack.

v Tivoli Event Integration Facility Reference, SC32-1241Describes how to develop your own event adapters that are tailored to yournetwork environment and the specific needs of your enterprise. This referencealso describes how to filter events at the source.

Related publicationsThe Tivoli Software Glossary includes definitions for many of the technical termsrelated to Tivoli software. The Tivoli Software Glossary is available, in English only,at the following Web site:

http://www.ibm.com/software/tivoli/library/

Access the glossary by clicking the Glossary link on the left pane of the Tivolisoftware library window.

Accessing publications onlineThe documentation CD contains the publications that are in the product library.The format of the publications is PDF, HTML, or both. Refer to the readme file onthe CD for instructions on how to access the documentation.

IBM posts publications for this and all other Tivoli products, as they becomeavailable and whenever they are updated, to the Tivoli Software InformationCenter Web site. Access the Tivoli Software Information Center by first going to theTivoli software library at the following Web address:

http://www.ibm.com/software/tivoli/library/

Scroll down and click the Product manuals link. In the Tivoli Technical ProductDocuments Alphabetical Listing window, click the IBM Tivoli Enterprise Consolelink to access the product library at the Tivoli Information Center.

Note: If you print PDF documents on other than letter-sized paper, select the Fit topage check box in the Adobe Acrobat Print window. This option is availablewhen you click File → Print. Fit to page ensures that the full dimensions of aletter-sized page print on the paper that you are using.

Ordering publicationsYou can order many Tivoli publications online at the following Web site:

http://www.elink.ibmlink.ibm.com/public/applications/publications/cgibin/pbi.cgi

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

vi IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (9)

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

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

Contacting software supportIf you have a problem with any Tivoli product, refer to the following IBM SoftwareSupport Web site:

http://www.ibm.com/software/sysmgmt/products/support/

If you want to contact software support, see the IBM Software Support Guide at thefollowing Web site:

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

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

you are locatedv Information you must have before contacting IBM Software Support

Participating in newsgroupsUser groups provide software professionals with a forum for communicating ideas,technical expertise, and experiences related to the product. They are located on theInternet and are available using standard news reader programs. These groups areprimarily intended for user-to-user communication and are not a replacement forformal support.

To access a newsgroup use the instructions appropriate for your browser.

Use these instructions for a Microsoft Internet Explorer browser.1. Open an Internet Explorer browser.2. From the Tools menu, click Internet Options.3. On the Internet Options window, click the Programs tab.4. In the Newsgroups list, click the Down Arrow and then click Outlook Express.5. Click OK.6. Close your Internet Explorer browser and then open it again.7. Cut and paste the newsgroup address of a product into the browser Address

field, and press Enter to open the newsgroup.

Use these instructions for a Netscape Navigator browser.1. Open a Netscape Navigator browser.2. From the Edit menu, click Preferences. The Preferences window is displayed.3. In the Category view, click Mail & Newsgroups to display the Mail &

Newsgroups settings.4. Select the Use Netscape mail as the default mail application check box.5. Click OK.6. Close your Netscape Navigator browser and then open it again.

About this book vii

TEC - Comandos e referência - [PDF Document] (10)

7. Cut and paste the newsgroup address of a product into the browser Addressfield, and press Enter to open the newsgroup.

IBM Tivoli Enterprise Console:

news://news.software.ibm.com/ibm.software.tivoli.enterprise-console

IBM Tivoli NetView® for UNIX® and IBM Tivoli NetView for Windows®:

news://news.software.ibm.com/ibm.software.tivoli.netview-unix-windows

Conventions used in this guideThis guide uses several conventions for special terms and actions, operatingsystem-dependent commands and paths, and command syntax.

Typeface conventionsThis guide uses the following typeface conventions:

Bold

v Lowercase commands and mixed case commands that are otherwisedifficult to distinguish from surrounding text

v Interface controls (check boxes, push buttons, radio buttons, spinbuttons, fields, folders, icons, list boxes, items inside list boxes,multicolumn lists, containers, menu choices, menu names, tabs, propertysheets), labels (such as Tip:, and Operating system considerations:)

v Keywords and parameters in text

Italic

v Words defined in textv Emphasis of words (words as words)v New terms in text (except in a definition list)v Variables and values you must provide

Monospace

v Examples and code examplesv File names, programming keywords, and other elements that are difficult

to distinguish from surrounding textv Message text and prompts addressed to the userv Text that the user must typev Values for arguments or command options

Operating system-dependent variables and pathsThis guide 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.

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

viii IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (11)

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 ([]).

Notes:

1. The maximum number of characters in an argument is 256.2. Enclose argument values that have embedded spaces with either single or

double quotation marks.

For example:

wsetsrc [–S server] [–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.

About this book ix

TEC - Comandos e referência - [PDF Document] (12)

x IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (13)

Chapter 1. Commands

This chapter describes how to establish a Tivoli environment for using Tivolicommands and provides details about each Tivoli Enterprise Console command.

Establishing the Tivoli environmentWhen the Tivoli Management Framework was installed, two setup files werecreated that you can use to easily establish the correct search paths andenvironment variables. These files are available on any client or the server in theTivoli management region.

Use the following steps to set up the UNIX system environment to run 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 theTivoli management region. See the Tivoli Management Framework User’s Guide fordetails about creating Tivoli Enterprise administrators with authorization rolesfor the region.

2. Two environment initialization and setup scripts are available: one for theBourne shell and one for the C shell. If you are using the Bourne shell, run thefollowing command:. /etc/Tivoli/setup_env.sh

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

Issue the following commands from a Windows command prompt to set up 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 run with sh; many commands can be run from the command line.

You now have an environment ready to perform Tivoli operations.

Using Tivoli commandsUse Tivoli commands to perform system operations from a command line insteadof using the Tivoli desktop. It is often convenient or more appropriate to call aTivoli management application operation from the command line than from thedesktop; for example:v You might not have access to a graphical display, such as when logging in over

a phone line or when running maintenance scripts.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 call a command from a shell.v An operation is not available using the Tivoli desktop.

© Copyright IBM Corp. 2002 1

TEC - Comandos e referência - [PDF Document] (14)

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, to create a user, use the wcrtusr command. To delete a user, use thewdelusr command.

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 commands, asfollows:v Registered namesv Object paths

Tivoli command-line programs support both naming schemes. Sometimes you canfind it more convenient to use one form over the other.

Registered namesEach Tivoli region contains a name registry. The name registry is a two-dimensionaltable that contains the names and types of objects.

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

All objects in the Tivoli region that need to be looked up should be registered inthe name registry when created, unregistered when deleted, and moved when theirlabel is changed. For most resources in the Tivoli Enterprise Console product, theseactions are handled automatically. See the IBM Tivoli Management FrameworkPlanning for Deployment Guide for a complete listing of resource types and exchangeinformation.

Using the name registry facilitates the exchange of resources between multipleTivoli regions. See the IBM Tivoli Management Framework Planning for DeploymentGuide for a complete description of Tivoli regions 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 IBM Tivoli Management Framework Reference Manual for a detaileddescription and syntax of the wlookup command.

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

where Administrator is the resource and jerry is the instance.

2 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (15)

Object pathsObject paths are similar to path names in file systems and can 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

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 command:wls /Regions/Engineering/ProfileManager:Servers

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

Chapter 1. Commands 3

TEC - Comandos e referência - [PDF Document] (16)

Console commands

Command Purpose

tec_console Starts an event console.

wconsole Manages event consoles.

wcrtdefcfg Creates a default configuration in the event console.

wcrtebizgroups Creates the e-business groups in the event console.

wcrtmtgroups Creates an event group for viewing hosts that are in maintenance mode in theevent console.

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

wcrtteccfg Creates a default configuration for the Tivoli Enterprise Console product.

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

wmigcon Migrates Tivoli Enterprise Console Version 3.6 consoles, event groups, eventgroup filters, and operators to Version 3.7.x, Version 3.8, and Version 3.9.

wsendresp Displays a directed response to an administrator.

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

wtecexport Exports event console definitions to a file.

wtecimport Imports event console definitions from a file into a different Tivoli region.

Source commands

Command Purpose

wcrtsrc Creates a source on the event server.

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.

postzmsg Posts an event to the event server using non-Tivoli communication.

TECAgent Posts an event to the event server using Tivoli or non-Tivoli communication.

wpostemsg (endpoint version) Posts an event to the event server. This command requires Tivoli ManagementFramework services.

wpostemsg (managed nodeversion)

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

wpostzmsg (endpoint version) Posts an event to the event server using Tivoli endpoint communication to aTivoli Enterprise Console gateway or non-Tivoli communication directly to theevent server.

wpostzmsg (managed nodeversion)

Posts an event to the event server using Tivoli managed node communication ornon-Tivoli communication.

4 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (17)

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.

wstartmaint.sh Informs the event server that a host has been placed in maintenance mode.

wstatesvr Displays the status of the event server.

wstopesvr Stops the event server.

wstopmaint.sh Informs the event server that an ongoing or scheduled maintenance mode for anetwork resource is being canceled.

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 an environment using non-Tivolicommunication..

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.

wrb_default_rb Deactivates active rule sets in the default rule base.

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

wdbconfig.sh Runs the generated database configuration scrips.

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

wtdbclear Clears events from the event database.

wtdbclear.pl Clears events from the event database.

wtdbspace Provides statistics for the database.

wtdbstat Displays the status of the database server.

wtdumper Generates a event report of processed events from the event repository.

wtdumprl Generates a report of received events from the reception log.

wtdumptr Generates a report of completed tasks.

Chapter 1. Commands 5

TEC - Comandos e referência - [PDF Document] (18)

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 Event Integration Facility environmentvariables.

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 Event Integration Facility environment variables foran adapter type.

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

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.

Adapter commands

Command Purpose

wsighup Reloads the configuration and format files for the Windows event log adapterand Windows NT® event log adapter.

6 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (19)

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 Framework installed.

Note: If the Tivoli Management Framework 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 value is the directory definedby environment 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

Chapter 1. Commands 7

TEC - Comandos e referência - [PDF Document] (20)

postemsg

Posts an event to the event server using non-Tivoli communication.

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 Management Framework services and works inenvironments where Tivoli software is not installed.

Notes:

1. Although this command is still supported, the postzmsg command is preferredfor sending events using non-Tivoli communication.

2. If the Tivoli Management Framework is installed on your system, you can usethe wpostzmsg (managed node version) or wpostzmsg (endpoint version)command.

3. Because cache files cannot be shared by applications, you should not use aconfiguration file for this command that is being used by another program(such as an adapter).

Because this command does not have access to the message catalogs for thelanguage support packs, postemsg displays error messages in English only.

AuthorizationNone

Optionsattribute=value

Assigns a value to any valid attribute. The attribute should be one definedfor the event class. Separate multiple attribute=value expressions withspaces.

class Specifies the class of the event. It must match a class that is configured atthe server. Classes are defined by the adapter and listed in the adapterBAROC file. If any blank spaces are in the class name, enclose the classname in double quotation marks.

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

–f configuration_fileSpecifies the name of the adapter configuration file. You must specifyeither the –S argument or the –f argument. See the IBM Tivoli EnterpriseConsole Event Integration Facility Reference for more information aboutconfiguration files.

–m messageSpecifies the text of the event, enclosed in double quotation marks.

–r severitySpecifies a severity. The severity must be one defined for the event class.

8 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (21)

–S serverSpecifies the host name or the IP address of the server. Use this optiononly if portmapper is running on the event server. You must specify eitherthe –S argument or the –f argument.

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 Alsopostzmsg, TECAgent, wpostemsg (endpoint version), wpostemsg (managed nodeversion), wpostzmsg (endpoint version), wpostzmsg (managed node version),wsetemsg

Chapter 1. Commands 9

TEC - Comandos e referência - [PDF Document] (22)

postzmsg

Posts an event to the event server using non-Tivoli communication.

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

DescriptionThe postzmsg command sends an event to an event server. This command doesnot require the use of Tivoli Management Framework services and works inenvironments where Tivoli software is not installed. Because this command doesnot have access to the message catalogs for the language support packs, postzmsgdisplays error messages in English only.

Notes:

1. If the Tivoli Management Framework is installed on your system, you can usethe wpostzmsg (endpoint version) or wpostzmsg (managed node version)command.

2. Because cache files cannot be shared by applications, you should not use aconfiguration file for this command that is being used by another program(such as an adapter).

AuthorizationNone

Optionsattribute=value

Assigns a value to any valid attribute. The attribute should be one definedfor the event class. Separate multiple attribute=value expressions withspaces.

class Specifies the class of the event. It must match a class that is configured atthe server. Classes are defined by the adapter and listed in the adapterBAROC file. If any blank spaces are in the class name, enclose the classname in double quotation marks.

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

–f configuration_fileSpecifies the name of the configuration file. You must specify either the –Sargument or the –f argument. See the IBM Tivoli Enterprise Console EventIntegration Facility Reference for more information about configuration files.

–m messageThe text of the event, enclosed in double quotation marks.

–r severitySpecifies a severity. The severity must be one defined for the event class.

–S serverSpecifies the host name or the IP address of the server. Use this optiononly if portmapper is running on the event server. You must specify eitherthe –S argument or the –f argument.

10 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (23)

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

See Alsopostemsg, TECAgent, wpostemsg (endpoint version), wpostemsg (managed nodeversion), wpostzmsg (endpoint version), wpostzmsg (managed node version),wsetemsg

Chapter 1. Commands 11

TEC - Comandos e referência - [PDF Document] (24)

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 event console. This command is found in$BINDIR/bin on a managed node with the event console installed. On any otherhost, the command is found in the directory where the event console was installed.

You can run this command in the background to get the session command promptto return. When running this command on a managed node, the Tivolienvironment must be initialized.

When issuing the tec_console command from a bash shell on a Windows system,include the .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 console of the user iscreated in the home directory of the user.

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.

AuthorizationFor operators: user, RIM_view, RIM_update

For administrators: user, RIM_view, RIM_update, senior

Tivoli Enterprise Console administrators and operators require Tivoli managementregion roles as shown in the following table. Also shown are the Tivoli EnterpriseConsole views available to the two types of users. See the Tivoli Enterprise ConsoleUser’s Guide for additional information about the roles required for TivoliEnterprise Console users.

Console UserTivoli Management RegionRoles 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

12 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (25)

Options& Run 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.

Note: For this option, you must designate a multiword event group namedifferently depending on whether you are using a UNIX operatingsystem or a Windows operating system. In all operating systems, theevent group name is case-sensitive.

For UNIX operating systems, surround the event group name withdouble quotation marks:tec_console -e "All Events"

For Windows operating systems, do not surround the event groupname with double quotation marks:tec_console.cmd -e All Events

–h hostname[:port]The host must be a managed node where the user ID and password mustbe authenticated by the Tivoli Management Framework. Specify this optionas hostname:port if a port other than port 94 is being used.

–nowindowSuppresses the DOS window (for Windows systems only).

–p passwordThe password for your Tivoli administrator login ID.

–u useridYour Tivoli administrator login ID.

ExamplesThe 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 &

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 &

Chapter 1. Commands 13

TEC - Comandos e referência - [PDF Document] (26)

TECAgent

Posts an event to the event server using Tivoli or non-Tivoli communication.

Syntaxjava com.tivoli.tec.event_delivery.TECAgent SENDER –f configuration_file [–mmessage] [–r severity] [attribute=value...] class source

DescriptionThe TECAgent command sends an event to an event server. This command canfunction using endpoint transport, managed node transport, or non-Tivolicommunication, depending on the configuration.

Note: Because cache files cannot be shared by applications, you should not use aconfiguration file for this command that is being used by another program(such as an adapter).

The TECAgent command is contained within evd.jar which can be found in$BINDIR/../generic_unix/TME/TEC. Before running this command, you need todo the following setup:v If you are going to use managed node (TME) or endpoint (LCF) transport in your

configuration file, you need to source the appropriate Tivoli environment, eithersetup_env.sh or lcf_env.sh

v Add the Java™ executable file to your path. A Java executable file shipped withthe Tivoli Enterprise Console product is in $BINDIR/TME/TEC/jre/bin.

v Add the appropriate jar files to your CLASSPATH from$BINDIR/../generic_unix/TME/TEC:– evd.jar and log.jar– jcf.jar, ibmjsse.jar, and jsafe.zip if you are going to use managed node (TME)

transport– zce.jar and xerces-3.2.1.jar if you are going to run State Based Correlation

Authorizationuser

Optionsattribute=value...

Assigns a value to any valid attribute. The attribute should be one definedfor the event class. Separate multiple attribute=value expressions withspaces.

class Specifies the class of the event. It must match a class that is configured atthe server. Classes are defined by the adapter and are listed in the adapterBAROC file. If any blank spaces are in the class name, enclose the classname in double quotation marks.

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

–f configuration_fileSpecifies the name of the configuration file. See the IBM Tivoli EnterpriseConsole Event Integration Facility Reference for more information aboutconfiguration files.

14 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (27)

–m messageThe text of the event, in double quotation marks.

–r severitySpecifies a severity. The severity must be one defined for the event class.

ExamplesThe following example sends a test message that displays an Su_Failure event onthe event consoles:java com.tivoli.tec.event_delivery.TECAgent SENDER –f myconfig.conf–m "su login failure." Su_Failure LOGFILE

See Alsopostemsg, postzmsg, wpostemsg (endpoint version), wpostemsg (managed nodeversion), wpostzmsg (endpoint version), wpostzmsg (managed node version),wsetemsg

Chapter 1. Commands 15

TEC - Comandos e referência - [PDF Document] (28)

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 theupgrade_gui.sh script in the $BINDIR/TME/RULE_BUILDER directory to convertthese rules to the syntax supported by the rule compiler provided in this version ofthe Tivoli Enterprise Console product. The converted rules take advantage offeatures implemented by the newer version of the compiler and are easier to read.If you convert rules with this script, you can no longer edit the converted ruleswith the rule builder—you must use a text editor.

Note: Make a backup copy of the .rule_builder.pro file before running 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

16 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (29)

waddac

Adds an adapter configuration record for an adapter configuration profile.

Syntaxwaddac adapter_details type profile

DescriptionThe waddac command adds a record for configuring a Tivoli Enterprise Consoleevent adapter to an existing adapter configuration profile. When distributed tosubscribing managed nodes, the new record makes effective the adapterconfiguration reflected by the supplied adapter_details arguments, combined withany installed type-specific defaults.

Each adapter type on each adapter configuration profile can be supported bydefault policies to supply initial values for parts of the configuration not given bya waddac call. Similarly, validation policies might be present to ensure that a givenconfiguration is valid according to the needs of the event adapter implementation,installation particulars, 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 adapterconfiguration profile entry panel or by 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 distributionparameters of the adapter.

–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 varyby endpoint, but those currently supported include the followingflags:

action_failControls the handling of failures of before (!command) andafter (!!command) distribution requests. For moreinformation about these requests, see the –D option. Valuesare:

abort Stop distribution.

ignore Ignore all failures.

report Report failures but continue with distributionactivity, the default behavior.

Chapter 1. Commands 17

TEC - Comandos e referência - [PDF Document] (30)

expandControls whether references to endpoint context variablesof the form $variable within attributes of the record shouldbe expanded by the endpoint code when the profile isdistributed. The value of the variable can be no to disableexpansion, yes to enable it for all attributes (the defaultbehavior), or a comma-separated list of attribute names toselectively expand only within the values of thoseattributes.

rm_on_delInstructs the endpoint code whether to removeconfiguration files and distributed files when the record isdistributed after being removed. The value can 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 primary adapter configuration file).

run_actionsControls whether before (!command) and after (!!command)distribution requests are performed. For more informationabout these requests, see the –D option. The value can beyes or no, with yes the default value.

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 adapter configurationprofile record. The comment text is written into the configurationfile when it is created 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 can be of the form !command or !!command. The givencommand, which can be any valid statement for the operatingsystem-dependent command line interpreter present on subscribernodes (generally /bin/sh, although, on non-UNIX operatingsystems, it might 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 wanted can 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 can be used at a higher level by specific adapters.

18 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (31)

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

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

The entire string needs to be enclosed in quotation marks toprevent the command-line interpreter from reacting to thesemicolons. To create a filter that is initially in a disabled state, thestring can 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 are 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 in the followingform:

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

The entire string needs to be enclosed in quotation marks toprevent the command-line interpreter from reacting to thesemicolons. To create a filter cache that is initially in a disabledstate, the string can 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 are prefixed with FilterCache:.)

Many –F options can be supplied.

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

–i on|off[,idname]Specifies whether the adapter should be assigned a uniqueidentifier and what identifier to use. Use this option when runningmultiple adapters on the same system to assign unique identifiersto the adapters. Specify on|off to indicate whether to use anidentifier, and specify idname to indicate the identifier to be used. Ifyou specify –i on without idname, the adapter does not have an IDafter you distribute the profile. If you specify –i off with idname,the configuration record contains the ID but the adapter does nothave an ID after you distribute the profile. You can change theconfiguration record using the wsetac command.

–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 value is OUT. If youuse IN or in, you must also supply the –p parameter to specify aPreFilter. The following example shows a command using thisargument:

Chapter 1. Commands 19

TEC - Comandos e referência - [PDF Document] (32)

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, with a fileextension of .conf (commonly known as the CONF file). Thecomplete file name for this file is formed by appending target tothe value given for dir with the –d option. (Note that default policyis generally established to set target and targdir to appropriatevalues.)

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

profile The adapter configuration profile to which the new adapter configurationrecord is to be added.

type Gives the adapter type for the new adapter. 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 targetadapter configuration profile might reject the new record. To see theavailable types, use the wlsaddflt command.

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

See Alsowdelac, wlsac, wsetac, wsetaddflt

20 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (33)

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

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 defaultserver is the local event server. To indicate a remote server, specify@EventServer#tmr, where tmr is the name of a Tivoli region.

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

Chapter 1. Commands 21

TEC - Comandos e referência - [PDF Document] (34)

wconsole

Manages event consoles.

Syntaxwconsole [option [suboption]]

DescriptionUse the wconsole command to create, copy, delete, and list event consoles, andconfigure, assign, and otherwise manage event groups and event group filters.

The first option of the wconsole command specifies its primary function.Subsequent suboptions are valid only within the context of the first option.

Authorizationsenior (region role for the command only, no options)

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

Option Description Region Roles

–addegflt Adds a new filter to an eventgroup.

RIM_view, RIM_update,senior

–assigneg Assigns an event group to anevent console definition.

RIM_view, RIM_update,senior

–assignop Assigns operators to anevent console definition.

RIM_view, RIM_update,senior

–copyconsole Copies the event groups,event group filters, andauthorization roleassignments for an eventconsole to another consoledefinition.

RIM_view, RIM_update,senior

–crtconsole Creates a new event consoledefinition.

RIM_view, RIM_update,senior

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

–crtoperator Creates a new consoleoperator.

RIM_view, RIM_update,senior

–delconsole Deletes an event consoledefinition.

RIM_view, RIM_update,senior

–deleg Deletes one or more eventgroups.

RIM_view, RIM_update,senior

–delegflt Deletes one or more filtersfrom an event group.

RIM_view, RIM_update,senior

–deloperator Deletes an existing consoleoperator.

RIM_view, RIM_update,senior

–lsassigneg Lists event groups assignedto an event consoledefinition.

RIM_view, RIM_update, user

22 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (35)

Option Description Region Roles

–lsconsole Lists event consoledefinitions.

RIM_view, RIM_update, user

–lsconsoleup Lists currently runningconsoles.

RIM_view, RIM_update, user

–lseg Lists event groups. RIM_view, RIM_update, user

–lsoperator Lists the operator definition. RIM_view, RIM_update, user

–setconsole Changes the name anddescription of an eventconsole definition.

RIM_view, RIM_update,senior

–seteg Changes the name anddescription of an eventgroup.

RIM_view, RIM_update,senior

–setegflt Changes the name anddescription of an eventgroup filter.

RIM_view, RIM_update,senior

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

RIM_view, RIM_update,senior

–unassignop Unassigns operators from anevent console definition.

RIM_view, RIM_update,senior

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

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

v Before running 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 managed node host where the user ID and password must beauthenticated by the Tivoli Management Framework. If you do not specify thesesuboptions and are running the wconsole command on a managed node, the ID ofthe user currently logged on is used; otherwise, if you are running on a host in anon-Tivoli environment, the login window is displayed.

Note: If you are running the wconsole command on a managed node with theAIX® operating system and are logged in as root, you must use the –h, –u,and –p suboptions to explicitly specify the host name, user ID, andpassword to prevent the login window from displaying. This is notnecessary if you are logged in to an AIX system under any other user ID.

The –h, –u, and –p suboptions are shown in the syntax statements in this section,but their definitions are shown only in the following table.

Chapter 1. Commands 23

TEC - Comandos e referência - [PDF Document] (36)

Common Suboption Definition

–h host[:port] The name of the managed node host where the user ID andpassword must be authenticated by the Tivoli ManagementFramework. Specify the port number if the port used by thehost is not port 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 criteria ofthe filter. These events are usually shown in the Event Viewer of anoperator console. (Either an operator at an Event Viewer or a rule cansuppress the visibility of these events in an Event Viewer).

Use event group filters to configure the selection criteria for events toinclude 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 filtercriteria. If no filters are 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 statements. Aconstraint is constructed using event attributes, SQL operators, and eventattribute values. Constraints for a filter can be linked together with theAND operator. Free-form SQL statements can be any valid statements for aWHERE 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 thespecified range. For example, [a-f] or[abcedf]

24 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (37)

Wildcard Meaning

[^] Any single character not within thespecified range. 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 constraintsOne or more constraints for the new filter. Do not specify theleading WHERE keyword—it is handled automatically. Linkmultiple constraints together with the AND operator. Eachindividual constraint /must be enclosed by parentheses. The entireconstraints argument must be enclosed within quotation marks; forexample:-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, and NOTBETWEEN.

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/5/01 10:59:55 PM EST’

Notes:

1. Specifying a filter constraint works the same as the eventconsole Constraint Editor dialog. The same event attributes,operators, and attribute values you can specify in theConstraint Editor can be specified with the –s suboption of the–addegflt option.

2. To specify multiple constraints, use the AND operator. Do notuse the –s suboption more than once on a single wconsolecommand.

Chapter 1. Commands 25

TEC - Comandos e referência - [PDF Document] (38)

–S free_form_SQLAny SQL statements that are valid for a WHERE clause and aresupported by the RDBMS used for the event database. Do notspecify 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.

Notes:

1. 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 statements foran event filter.

2. To specify multiple SQL statements, use the AND operator. Donot use the –S suboption more than once on a single wconsolecommand.

–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 Tivoli EnterpriseConsole roles, see the IBM Tivoli Enterprise Console User’s Guide.

–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 the event groups, event group filters, and authorization roleassignments of an event console to another console definition. EventViewer preferences are not copied. Event Viewer preferences are storedlocally on the hosts where the console clients are installed. The targetconsole must exist.

26 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (39)

–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 TivoliAdministrators 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 filters of the source event group are also copied.

Chapter 1. Commands 27

TEC - Comandos e referência - [PDF Document] (40)

–n nameThe name for the new event group.

–delconsole [–h host[:port]] [–u user] [–p password] –n nameDeletes an event console definition. If instances of the console are runningwhen this option is issued, the definition is not removed until no instancesare 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 Tivoli region towhich the user running the wconsole -lsconsoleup command is logged in.

28 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (41)

–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 colon (:). 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.

Chapter 1. Commands 29

TEC - Comandos e referência - [PDF Document] (42)

–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 in the UNIX, Linux, or bash shell or with the%ERRORLEVEL% shell variable in Windows operating systems. Any errormessage text is written to stderr (the standard error channel).v 0 indicates that the wconsole command completed successfully.v 1 indicates that the wconsole command failed because of an internal error; for

example, the database might not be reachable.v 2 indicates that the wconsole command completed but resulted in a warning

condition for one of the following reasons:– An object cannot be created because it already exists.– An object cannot be deleted, modified, or assigned because it does not exist.– An object cannot be modified or assigned because the user does not have the

necessary access rights.

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 "(severity IN (’CRITICAL’,’FATAL’))"

30 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (43)

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, both ofwhich must be met for events to pass this filter and be included in theevent 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 andfree-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, a value is 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 the PersonnelSystems Audit console. Note that operators are not copied and thetarget 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.

Chapter 1. Commands 31

TEC - Comandos e referência - [PDF Document] (44)

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 \-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

–crtoperator Examples

The following example creates an operator called achan.wconsole -crtoperator -O achan

–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 the NetAdminconsole:

32 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (45)

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 default values:There are currently 3 active TEC consoles.

Console Administrator/Operator_________________________________________Root_jbr01-region Admin1test1 TestAdminDB2 DB2Admin

–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:

Chapter 1. Commands 33

TEC - Comandos e referência - [PDF Document] (46)

wconsole.cmd -seteg -n Subnetwork \-D "Subnetwork Event Data" -E Subnet

–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

34 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (47)

wcrtdefcfg

Creates a default configuration in the event console.

Syntaxwcrtdefcfg operator [host[:port] user password]

DescriptionThe wcrtdefcfg command creates a default event group and a default eventconsole and assigns an operator to the event console. The default event groupcontains all open events.

Authorizationsenior

Optionsoperator

Specifies the operator to assign to the default console.

host[:port]Specifies the name of the host where the event console runs and, optionally,the port used by the host; if port 94 is not used, the port must be specified.

userSpecifies the user name of the administrator. If you do not specify this option,the ID of the user that is currently logged on is used.

passwordSpecifies the password of the administrator. This option is required if youspecify a user.

ExamplesThe following example creates a default configuration for operatorRoot_adasilva-region on host calculus; the name and password for theadministrator are root and my_passwrd:wcrtdefcfg Root_adasilva-region calculus root my_passwrd

See Alsowconsole

Chapter 1. Commands 35

TEC - Comandos e referência - [PDF Document] (48)

wcrtebizgroups

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

Syntaxwcrtebizgroups [host[:port] user password]

DescriptionThe wcrtebizgroups script uses the wconsole command to create the event groupsrequired by the ebusiness.rls rule set. These groups include:

Not Monitoring E-Business EventsThis event group includes all open TEC_ITS_Not_Monitoring_eBusinessevents, which are generated when the NetView component is notconfigured to properly monitor the e-business applications.

Probable Event Association EventsThis event group includes all open TEC_Probable_Event_Associationevents.

All WAS, DB2®, and MQ EventsThis event groups includes all other e-business events related to themonitored DB2, WebSphere® Application Server, and WebSphere MQservices.

Authorizationsenior

Optionshost[:port]

Specifies the name of the host where the event console runs and,optionally, the port used by the host; if port 94 is not used, the port mustbe specified.

user Specifies the user name of the administrator. If you do not specify thisoption, the ID of the user currently logged on is used.

passwordSpecifies the password of the administrator. This option is required if youspecify a user.

Note: If you are running on an AIX system and are logged in as root, you mustexplicitly specify the host name, user ID, and password to prevent the loginwindow from displaying. This is not necessary if you are logged in to anAIX system under any other user ID.

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

See Alsowconsole

36 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (49)

wcrtmtgroups

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

Syntaxwcrtmtgroups [host[:port] user password]

DescriptionThe wcrtmtgroups script uses the wconsole command to create the event grouprequired by the maintenance_mode.rls rule set. The Open Maintenance Eventsgroup includes any open TEC_Maintenance events, which are generated when amonitored system enters or exits maintenance mode.

Authorizationsenior

Optionshost[:port]

Specifies the name of the host where the event console runs and,optionally, the port used by the host; if port 94 is not used, the port mustbe specified.

user Specifies the user name of the administrator. If you do not specify thisoption, the ID of the user currently logged on is used.

passwordSpecifies the password of the administrator. This option is required if youspecify a user.

Note: If you are running on an AIX system and are logged in as root, you mustexplicitly specify the host name, user ID, and password to prevent the loginwindow from displaying. This is not necessary if you are logged in to anAIX system under any other user ID.

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

See Alsowconsole

Chapter 1. Commands 37

TEC - Comandos e referência - [PDF Document] (50)

wcrtnvgroups

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

Syntaxwcrtnvgroups [host[:port] user 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 theTivoli Enterprise Console product. The ClosedNetview event group contains theevents from the Tivoli NetView product that have a status other than OPEN in theTivoli Enterprise Console product.

Authorizationsenior

Optionshost[:port]

Specifies the name of the host where the event console runs and,optionally, the port used by the host; if port 94 is not used, the port mustbe specified.

user Specifies the user name of the administrator. If you do not specify thisoption, the ID of the user that is currently logged on is used.

passwordSpecifies the password of the administrator. This option is required if youspecify a user.

Note: If you are running on an AIX system and are logged in as root, you mustexplicitly specify the host name, user ID, and password to prevent the loginwindow from displaying. This is not necessary if you are logged in to anAIX system under any other user ID.

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

See Alsowconsole

38 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (51)

wcrtsrc

Creates a source on the event server.

Syntaxwcrtsrc [–S server] [–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 the eventconsole using event adapters. The event adapter defines the name for a source.

Authorizationsenior

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

the name specified by the event adapter.

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

–S serverSpecifies the name of the event server in name registry format. The defaultserver is the local event server. To indicate a remote server, specify@EventServer#tmr, where tmr is the name of a Tivoli region.

ExamplesThe following example adds the LOGFILE source to the local Tivoli region andlabels the source Logfile:wcrtsrc –l "Logfile" LOGFILE

See Alsowdelsrc, wlssrc, wsetsrc

Chapter 1. Commands 39

TEC - Comandos e referência - [PDF Document] (52)

wcrtteccfg

Creates a default Tivoli Enterprise Console configuration.

Syntaxwcrtteccfg host[:port] user password [operator]

DescriptionThe wcrtteccfg command creates a default Tivoli Enterprise Console configuration.Use this command if the default Tivoli Enterprise Console configuration data doesnot get created because of a failure during the UI server installation. Thiscommand can also be run any time the configuration data is lost for any reason.

Note: Due to a limitation with AIX systems, administrators need to run thiscommand to create the initial data.

Authorizationsenior

Optionshost[:port]

Specifies the name of the host where the event console runs and, optionally,the port used by the host; if port 94 is not used, the port must be specified.

userSpecifies the user name of the administrator.

passwordSpecifies the password of the administrator.

operatorSpecifies the operator to assign to the default console. This parameter isoptional.

ExamplesThe following example creates a default Tivoli Enterprise Console configuration foroperator Root_adasilva-region on host calculus; the name and password for theadministrator are root and my_passwrd:wcrtteccfg calculus root my_passwrd Root_adasilva-region

40 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (53)

wdbconfig.shRuns the database configuration scripts.

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

DescriptionThe wdbconfig.sh script runs the database configuration scripts generated duringthe Tivoli Enterprise Console installation by the DB Assistant. It is used when thegenerated scripts must be copied to a RIM host system that is located on adifferent system than the event server. The wdbconfig.sh script is located in thesame directory as the generated event database installation scripts.

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

For the Informix® database, the wdbconfig.sh script can be run only on the systemwhere 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 the schema for versions 3.8 and 3.9.

upg_362Runs the dbConfigure_upg_362.sh script to upgrade the database from aversion 3.6.2 schema to the schema for versions 3.8 and 3.9.

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

Chapter 1. Commands 41

TEC - Comandos e referência - [PDF Document] (54)

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

Syntaxwdbmaint.sh [reorg | stats] [rim_object_name db2server | 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. For some databases, such as theDB2 database, updating the statistics also updates the information about the freepages in a table. That enables the database to reuse table pages that containdeleted rows. The database statistics must be updated regularly to preventtablespace-full errors and should be updated after data is purged using thewtdbclear command.

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. Reorganizing the DB2 database also releasesextents allocated to a table from a tablespace that are no longer needed by thetable. For the DB2 database, an extent allocated by a table from a tablespace isreleased only if the table is reorganized; because of that, the wtdbspace report stillshows that the tablespace has a lot of space allocated even after the wtdbclearcommand is run.

Note: Reorganizing the databases must be done while the event server is down.Statistics can be updated while the event server is running.

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 system where thiscommand is run. For the Sybase, DB2, and Microsoft SQL Server databasesrunning the reorg option, this command must be run from the RIM host. For allother databases, this command is run from the event server. For the DB2 database,you must be logged in as the DB2 Tivoli Enterprise Console RIM user and thecommand must be run from the DB2 command line processor on the RIM host.

If this command is not run on the event server, copy the wdbmaint.sh script fromthe $BINDIR/TME/TEC/sql directory to the system where the script is run.

The user running the wdbmaint.sh command must have write permission for thedirectory in which the command is run so that temporary work files can becreated.

Authorizationuser

42 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (55)

Optionsreorg Reorganize the database indexes and tables.

stats Update the internal statistics of data distribution.

rim_object_nameSpecifies the name of the RIM object associated with the event database.The default value is TEC.

db2clientSpecifies that the DB2 client is installed on the RIM host and is theconnection used by RIM. This parameter is used only with DB2connections to RIM. The DB2 client prompts for the password to be usedto connect to the database for the user defined in the specified RIM object.

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

For a DB2 database, if you do not specify either db2client or db2server, thedefault value is db2server.

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

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

$BINDIR/TME/TEC/sql/wdbmaint.sh reorg tec db2client

See Alsowtdbclear, wtdbspace

Chapter 1. Commands 43

TEC - Comandos e referência - [PDF Document] (56)

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. When the profile is next distributed, the oldconfiguration files are removed or are not based on the value of the rm_on_delbehavior flag.

Authorizationadmin

Optionskey... Key of the record or records 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 adapter configuration profile entry panel or byusing the wlsac command.

profile The name of the adapter configuration profile from which records are to beremoved. If the name includes spaces, enclose the whole name in quotationmarks.

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, wsetac, wsetaddflt

44 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (57)

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.

–S serverSpecifies the name of the event server in name registry format. The defaultserver is the local event server. To indicate a remote server, specify@EventServer#tmr, where tmr is the name of a Tivoli region.

ExamplesThe following example deletes the SNMP source from the local Tivoli region:wdelsrc SNMP

See Alsowcrtnvgroups, wlssrc, wsetsrc

Chapter 1. Commands 45

TEC - Comandos e referência - [PDF Document] (58)

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. One or more record keys can be supplied to chooseindividual 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 is 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

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 adapter configuration profile entry panel or byusing this command.

profile The name of the adapter configuration profile from which records are to beprinted. If the name includes spaces, enclose the whole name in quotationmarks.

–f formatProvides an alternate format for printing records. The format string cancontain 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.

46 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (59)

%11 The group ID for distribution actions.

%12 The pre-filter mode.

%13 The sequence of pre-filter definitions.

%14 The sequence of filter cache definitions.

%15 The adapter identifier name.

%16 The adapter identifier switch.

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 quotation marks. Thedefault 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 Tivoli Enterprise Console andTivoli ADE products, see the Tivoli ADE Application Services Manual, Volume1 for complete details 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;

Chapter 1. Commands 47

TEC - Comandos e referência - [PDF Document] (60)

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.errtecad_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, wsetac, wsetaddflt

48 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (61)

wlsaddflt

Shows global default information on the defined adapter types.

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

DescriptionThe wlsaddflt command fetches global default information for one or moreadapter types. If no types are specified, then wlsaddflt prints default informationfor all known adapter 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 is written upon distribution). An alternateformat can be given with the –f option. With the –l option, each record is printedout as an actual adapter configuration in the same form used when theconfiguration files are created upon distribution.

Authorizationadmin

Optionstype... The adapter types whose global default values 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 cancontain 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}’,

Chapter 1. Commands 49

TEC - Comandos e referência - [PDF Document] (62)

which prints each string from the sequence on a line by itself. The entirestring must be enclosed in single quotation marks. The default format isthus:’%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 Tivoli Enterprise Console andTivoli ADE products, see the Tivoli ADE Application Services Manual, Volume1 for complete details 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

50 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (63)

wlsadenv

Shows an installed list of adapter-specific Event Integration Facility environmentvariables.

Syntaxwlsadenv type

DescriptionThe wlsadenv command writes to standard output the list of Event IntegrationFacility environment variables recognized by the given adapter type, separated bynew lines. The type __generic__ is used by the Adapter Configuration Facility forthe list of variables understood by the Event Integration Facility library itself.

Authorizationadmin

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

ExamplesThe following example lists the Event Integration Facility environment variablesfor the tecad_logfile adapter type:wlsadenv tecad_logfile

This example returns the following information:UnmatchLogLogSources

See Alsowaddac, wsetadenv, wlsadgui, wlsadval

Chapter 1. Commands 51

TEC - Comandos e referência - [PDF Document] (64)

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 graphical configuration tools, then a link should be establishedwhen 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

52 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (65)

wlsadval

Shows installed validation information for an adapter type.

Syntaxwlsadval attribute type

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

Authorizationadmin

Optionsattribute

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

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

Chapter 1. Commands 53

TEC - Comandos e referência - [PDF Document] (66)

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

54 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (67)

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 isissued with the –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

Chapter 1. Commands 55

TEC - Comandos e referência - [PDF Document] (68)

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 are 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 the event console of an administrator. Specify the

name of the console.

event_group...Lists events that match the event group definitions (that is, they pass thefilters of the event group). Separate multiple event groups with a space.Only events passing the event group 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 is defined as theconcatenation of event_handle, server_handle, and date_reception.

Separate multiple values with a comma followed by a space (, ) andenclose the whole set of values in double quotation marks, as in thefollowing example: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"

56 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (69)

See Also“wtdumper” on page 124, “wtdumprl” on page 126, wpostemsg (endpointversion), wsetemsg

Chapter 1. Commands 57

TEC - Comandos e referência - [PDF Document] (70)

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 region is the default server unless another server isspecified.

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 defaultserver is the local event server. To indicate a remote server, specify@EventServer#tmr, where tmr is the name of a Tivoli region.

–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 the Tivoliregion gray-region:# 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

58 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (71)

wlssrc

Lists existing sources on the event server.

Syntaxwlssrc [–S server] [–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 label for each source. The label represents the sourceon the event consoles of administrators.

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.

–l Displays the label that identifies each source.

–S serverSpecifies the name of the event server in name registry format. The defaultserver is the local event server. To indicate a remote server, specify@EventServer#tmr, where tmr is the name of a Tivoli region.

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

See Alsowcrtsrc, wdelsrc, wsetsrc

Chapter 1. Commands 59

TEC - Comandos e referência - [PDF Document] (72)

wmigcon

Migrates Tivoli Enterprise Console Version 3.6 consoles, event groups, event groupfilters, and operators to Version 3.7.x, Version 3.8, and Version 3.9.

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 Tivoli Enterprise Console Version 3.6installation to the appropriate format for the Version 3.7, Version 3.8, or Version 3.9event console. This command is typically used only once, during the initial setupof the Tivoli Enterprise Console, Version 3.7, version 3.8, or Version 3.9 product.

The following table indicates how the event group filters are 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 statements do not map to one anotherin a precise way. Therefore, you should inspect each filter after the wmigconcommand has translated it to 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 creates a new filter that matches a singlesource exactly. That is, there are no wildcard characters (%) in the TivoliEnterprise Console version 3.9 filter.So if the source and a subsource of a Tivoli Enterprise Console version 3.6 filterare as follows:

60 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (73)

source: “LOG”sub_source: “LOGFILE”

then the resulting Tivoli Enterprise Console version 3.9 filter is as follows:source “Equal to (=)” “LOG”sub_source “LIKE (LIKE)” “%LOGFILE%”

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

Authorizationsuper, senior

Options–h host[:port]

The name of the managed node containing the Tivoli Enterprise Console,Version 3.6, event console. Specify this option as host:port if a port otherthan port 94 is being used.

–p passwordThe password for the login specified in the –u user argument. This optionis required if you use the –u option to specify a user.

–u userThe login you use as a Tivoli administrator. If you do not specify thisoption, the ID of the user currently logged on is used.

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

Note: If you are running on an AIX system and are logged in as root, you mustuse the –h, –u, and –p suboptions to explicitly specify the host name, userID, and password to prevent the login window from displaying. This is notnecessary if you are logged in to an AIX system under any other user ID.

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

Chapter 1. Commands 61

TEC - Comandos e referência - [PDF Document] (74)

wpostemsg (endpoint version)

Posts an event to the event server using Tivoli endpoint communication to a TivoliEnterprise Console gateway.

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

DescriptionThe wpostemsg command sends an event to an event server using Tivoli endpointcommunication to a Tivoli Enterprise Console gateway.

Notes:

1. Although this command is still supported, the wpostzmsg command ispreferred for sending events using Tivoli communication.

2. Because cache files cannot be shared by applications, you should not use aconfiguration file for this command that is being used by another program(such as an adapter).

This command requires the installation of a Tivoli endpoint on the same systemwhere you are running the command. If you have distributed an adapter to theendpoint, this command can be found in the $LCF_BINDIR/../bin directory.

This command is dependent upon the endpoint environment variables, which canbe set using the lcf_env.sh or lcf_env.csh scripts that are included in the endpointinstallation.

If you are using wpostemsg on a system that is configured both as an endpointand as a managed node, you might want to create a shell alias for the endpointversion of the command. The following examples show how you might do this:v C shell: alias wpostemsgep "$LCF_BINDIR/../bin/wpostemsg"

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

v Bash shell (on Windows systems): alias wpostemsgep="/Program\Files/Tivoli/lcf/bin/w32-ix86/bin/wpostemsg.exe

Make sure your PATH does not include both versions of the command.

Authorizationuser

Optionsattribute=value...

Assigns a value to any valid attribute. The attribute should be one definedfor the event class. Separate multiple attribute=value expressions withspaces.

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 BAROC file. If any blank spaces are in the class name, enclose theclass name in double quotation marks.

62 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (75)

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

–f configuration_fileSpecifies the name of the configuration file. See the IBM Tivoli EnterpriseConsole Event Integration Facility Reference for more information aboutconfiguration files.

–m messageThe text of the event, in double quotation marks.

–r severitySpecifies a severity. The severity must be one defined for the event class.

–S serverSpecifies the name of the event server in name registry format. Specify@EventServer to have events submitted to the locally named event serverof the Tivoli Enterprise Console gateway. To indicate a remote server,specify @EventServer#tmr, where tmr is the name of a Tivoli region. If youdo not specify the –S or –f option, the event is sent to the event serverdefined by the Tivoli Enterprise Console gateway.

If portmapper is running on the event server, you can specify a TCP/IPhost name or IP address instead. This results in non-Tivoli communicationbetween the Tivoli Enterprise Console gateway and the event server.

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, postzmsg, TECAgent, wpostemsg (managed node version), wpostzmsg(endpoint version), wpostzmsg (managed node version), wsetemsg

Chapter 1. Commands 63

TEC - Comandos e referência - [PDF Document] (76)

wpostemsg (managed node version)

Posts an event to the event server using Tivoli managed node communication.

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

DescriptionThe wpostemsg command sends an event to an event server using Tivoli managednode communication.

Notes:

1. Although this command is still supported, the wpostzmsg command ispreferred for sending events using Tivoli communication.

2. Because cache files cannot be shared by applications, you should not use aconfiguration file for this command that is being used by another program(such as an adapter).

This command requires the installation of the Tivoli Management Framework onthe same system where you are running the command. This command can befound in the $BINDIR/bin directory.

The managed node version of wpostemsg is dependent upon the Tivolienvironment variables, which can be set using the setup_env.sh or setup_env.cmdscripts that are included in the installation.

Authorizationuser

Optionsattribute=value...

Assigns a value to any valid attribute. The attribute should be one definedfor the event class. Separate multiple attribute=value expressions withspaces.

class Specifies the class of the event. It must match a class that is configured atthe server. Classes are defined by the event adapter BAROC file. If anyblank spaces are in the class name, enclose the class name in doublequotation marks.

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

–f configuration_fileSpecifies the name of the adapter configuration file. See the IBM TivoliEnterprise Console Event Integration Facility Reference for more informationabout configuration files.

–m messageThe text of the event, in double quotation marks.

–r severitySpecifies a severity. The severity must be one defined for the event class.

64 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (77)

–S serverSpecifies the name of the event server in name registry format. The defaultvalue is @EventServer, the local event server. To specify a remote server,specify @EventServertmr, where tmr is the name of a Tivoli region. If no –Sor –f option is specified, the event is sent to the locally named eventserver.

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, postzmsg, TECAgent, wpostemsg (endpoint version), wpostzmsg(endpoint version), wpostzmsg (managed node version), wsetemsg

Chapter 1. Commands 65

TEC - Comandos e referência - [PDF Document] (78)

wpostzmsg (endpoint version)

Posts an event to the event server using Tivoli endpoint communication to a TivoliEnterprise Console gateway or non-Tivoli communication directly to the eventserver.

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

DescriptionThe wpostzmsg command sends an event to an event server using Tivoli endpointcommunication to a Tivoli Enterprise Console gateway. This command requires theinstallation of a Tivoli endpoint on the same system where you are running thecommand. If you have distributed an adapter to the endpoint, this command canbe found in the $LCF_BINDIR/../bin directory.

Note: Because cache files cannot be shared by applications, you should not use aconfiguration file for this command that is being used by another program(such as an adapter).

This command is dependent upon the endpoint environment variables, which canbe set using the lcf_env.sh or lcf_env.csh scripts that are included in the endpointinstallation.

If you are using wpostzmsg on a system that is configured both as an endpointand as a managed node, you might want to create a shell alias for the endpointversion of the command. The following examples show how you might do this:v C shell: alias wpostzmsgep "$LCF_BINDIR/../bin/wpostzmsg"

v Korn shell: alias wpostzmsgep="$LCF_BINDIR/../bin/wpostzmsg"

v Bash shell (on Windows systems): alias wpostzmsgep="/Program\Files/Tivoli/lcf/bin/w32-ix86/bin/wpostzmsg.exe

Make sure your PATH does not include both versions of the command.

Authorizationuser

Optionsattribute=value

Assigns a value to any valid attribute. The attribute should be one definedfor the event class. Separate multiple attribute=value expressions withspaces.

class Specifies the class of the event. It must match a class that is configured atthe server. Classes are defined by the adapter and are listed in the adapterBAROC file. If any blank spaces are in the class name, enclose the classname in double quotation marks.

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

–f configuration_fileSpecifies the name of the configuration file. To send directly to the event

66 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (79)

server, specify SOCKET transport in your configuration file. See the IBMTivoli Enterprise Console Event Integration Facility Reference for moreinformation about configuration files.

–m messageThe text of the event, in double quotation marks.

–r severitySpecifies a severity. The severity must be one defined for the event class.

–S serverSpecifies the name of the event server in name registry format. Enter@EventServer to have events submitted to the locally named event serverof the Tivoli Enterprise Console gateway. To indicate a remote server,specify @EventServertmr, where tmr is the name of a Tivoli region. If youdo not specify the –S or –f option, the event is sent to the event serverdefined by the Tivoli Enterprise Console gateway.

If portmapper is running on the event server, you can specify a TCP/IPhost name or IP address instead. This results in non-Tivoli communicationbetween the Tivoli Enterprise Console gateway and the event server.

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

See Alsopostemsg, postzmsg, TECAgent, wpostemsg (endpoint version), wpostemsg(managed node version), wpostzmsg (managed node version), wsetemsg

Chapter 1. Commands 67

TEC - Comandos e referência - [PDF Document] (80)

wpostzmsg (managed node version)

Posts an event to the event server using Tivoli managed node communication ornon-Tivoli communication.

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

DescriptionThe wpostzmsg command sends an event to an event server using Tivoli managednode communication or non-Tivoli communication. This command requires theinstallation of the Tivoli Management Framework on the same system where youare running the command. This command can be found in the $BINDIR/bindirectory.

Note: Because cache files cannot be shared by applications, you should not use aconfiguration file for this command that is being used by another program(such as an adapter).

The managed node version of wpostzmsg is dependent upon the Tivolienvironment variables, which can be set using the setup_env.sh or setup_env.cmdscripts that are included in the installation.

Authorizationuser

Optionsattribute=value

Assigns a value to any valid attribute. The attribute should be one definedfor the event class. Separate multiple attribute=value expressions withspaces.

class Specifies the class of the event. It must match a class that is configured atthe server. Classes are defined by the adapter and listed in the adapterBAROC file. If any blank spaces are in the class name, enclose the classname in double quotation marks.

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

–f configuration_fileSpecifies the name of the configuration file. See the IBM Tivoli EnterpriseConsole Event Integration Facility Reference for more information aboutconfiguration files.

–m messageThe text of the event, in double quotation marks.

–r severitySpecifies a severity. The severity must be one defined for the event class.

–S serverSpecifies the name of the event server in name registry format. The defaultvalue is @EventServer, the local event server. To indicate a remote server,

68 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (81)

specify @EventServertmr, where tmr is the name of a Tivoli region. If no –Sor –f option is specified, the event is sent to the locally named eventserver.

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

See Alsopostemsg, postzmsg, TECAgent, wpostemsg (endpoint version), wpostemsg(managed node version), wpostzmsg (endpoint version), wsetemsg

Chapter 1. Commands 69

TEC - Comandos e referência - [PDF Document] (82)

wrb

Manage rule bases at the event server.

Syntaxwrb [option [suboption]]

DescriptionUse the wrb command to manage rule bases. You can do such tasks as create, viewinformation, manipulate, delete, compile, load, and activate rule bases with thiscommand. The first option of the command specifies its primary function.Subsequent suboptions are valid only within the context of the first argument.

When working with rule bases, your account must have read and write access tothe top-level rule base directory and to the following rule base files andsubdirectories: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. Thisaccess is not granted by adding a user to the Administrator login.

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 accepts the –force argument toperform the task without checking rule base consistency first.

When class definition files (with a file extension of .baroc) or rule set files (with afile extension of .rls) are being imported into a rule base, the name of the file

70 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (83)

(including the extension) must be given. Once these objects have been importedinto a rule base, you must use the logical name (that is, without the extension) inany 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 Developer’s Guide.

Authorizationuser (region role for wrb command)

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

Command Option Authorization

–comprules user

–cprb senior

–cprb –classes senior

–cprb –rulepacks user

–cprb –rulesets senior

–cprb –targets user

–crtrb senior

–crtrp user

–crttarget user

–deldp user

–delrb senior

–delrbclass senior

–delrbpack user

–delrbrule senior

–delrbtarget user

–delrprule user

–deltgtdata user

–deltgtrule user

–imprbclass senior

–imprbrule senior

–imprprule user

–imptdp user

–imptgtdata user

–imptgtrule user

–loadrb senior

–lscurrb senior

–lsrb user

Chapter 1. Commands 71

TEC - Comandos e referência - [PDF Document] (84)

Command Option Authorization

–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, youget 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 Developer’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 Developer’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 any of the –classes, –rulesets, –rulepacks, or –targets arguments,the class sets, rule sets, rule packs, and rule base targets are all copied. Thesource rule base must be in a consistent state for it to be copied. You canskip consistency 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,unless the –overwrite option is specified, for example:wrb -cprb -overwrite source_rule_base destination_rule_base

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.

72 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (85)

–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 can cause rulebase inconsistency.

–overwriteDuplicate files are overwritten in the target rule base. The defaultaction is that 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 region. If anexisting rule base is in path, the rule base is checked for consistency andthat rule base is used. You can skip consistency checking with the –forceargument. A rule base target named EventServer is automatically created inthe new rule base for the local event server. You can define multiple rulebases at the server, but only one can be loaded and active at a time.

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 currentworking directory of the user.

–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 can 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 cannot 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 are to be distributed. The local event

Chapter 1. Commands 73

TEC - Comandos e referência - [PDF Document] (86)

server is represented by the rule base target EventServer. This rule basetarget is created automatically when a rule base is created. When the rulebase is compiled, a complete rule base is generated for each rule basetarget in the rule base. The AIM server distributes and loads each rule baseto 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 cannot 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.

–deldp file_nameDeletes dependency relationships from the knowledge base. Before youissue the wrb –deldp command, the event server must be running and thedependency.rls rule set should be loaded and active; for more informationabout the dependency.rls rule set, see the Tivoli Enterprise Console Rule SetReference.

Note: This option uses the wpostemsg utility to send the dependencyinformation to the event server as events. You can define theconfiguration of the wpostemsg utility called by the deldp option bycreating a configuration file named $BINDIR/bin/wrb_eif.conf. Ifthis configuration file has event buffering turned off(BufferEvents=NO), then, if the event server is not running, the wrb–deldp command fails and returns an error. However, if the defaultwpostemsg configuration is used, events are buffered and, althoughevents are not sent to the event server, the wrb –deldp commanddoes not indicate any errors.

file_nameThe name of a text file containing dependency statements to beremoved from the knowledge base. For information about this fileand about defining dependency relationships for the e-businessrule set, see the Tivoli Enterprise Console Rule Set Reference.

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

74 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (87)

–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.Copy the BAROC file to a different location to save a copy forfuture 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 can 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 can 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 rule set file from a rule base for the specifiedrule set. Copy the rule set file to a different location to save a copyfor future use.

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

Chapter 1. Commands 75

TEC - Comandos e referência - [PDF Document] (88)

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 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 is to be placed.

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

–encoding encodingSpecifies the character encoding of the class file. If this option isnot specified, a class file being imported into a rule base is openedin UTF-8 character encoding. For more information aboutinternational encodings, see “Notes” on page 80.

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

76 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (89)

–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 run, the order that rule sets are imported into the rule baseis not important. The order in which rule sets are imported into a rule basetarget specifies the order in which that particular rule engine runs therules. An error message is displayed if the rule being imported references anon-existent event class. You can skip this consistency checking by usingthe –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 rule set file (with a file extension of .rls).

–encoding encodingSpecifies the character encoding of the class file. If this option isnot specified, a class file being imported into a rule base is openedin UTF-8 character encoding. For more information aboutinternational encodings, see “Notes” on page 80.

–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 setis to be placed.

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

–imptdp file_nameLoads dependency relationships into the knowledge base. Before you issuethe wrb –imptdp command, the event server must be running and thedependency.rls rule set should be loaded and active; for more informationabout the dependency.rls rule set, see the Tivoli Enterprise Console Rule SetReference.

Note: This option uses the wpostemsg utility to send the dependencyinformation to the event server as events. You can define theconfiguration of the wpostemsg utility called by the imptdp optionby creating a configuration file named $BINDIR/bin/wrb_eif.conf. If

Chapter 1. Commands 77

TEC - Comandos e referência - [PDF Document] (90)

this configuration file has event buffering turned off(BufferEvents=NO), then, if the event server is not running, the wrb–imptdp command fails and returns an error. However, if thedefault wpostemsg configuration is used, events are buffered and,although events are not sent to the event server, the wrb –imptdpcommand does not indicate any errors.

file_nameThe name of a text file containing dependency statements to beadded to the knowledge base as dependency facts. For informationabout this file and about defining dependency relationships for thee-business rule set, see the Tivoli Enterprise Console Rule SetReference.

–imptgtdata data_file target rule_baseImports a supporting data file to a rule base to be distributed to a rulebase target. This file is distributed with the rule base in the TEC_RULESsubdirectory. For example, an Event Integration Facility configuration fileor a Prolog fact 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 defined

78 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (91)

at 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 receive an error message.

Note: If you do not compile the rule base before attempting to load it, youget 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 can 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 (with a fileextension of .baroc), rule files (with an file extension of .rls), rule pack files(with a file extension of .rpk) and rule base target files (rule_sets_target).

rule_baseSpecifies the names of individual rule bases or a Perl regularexpression. The default action is that all rule bases are listed.Separate multiple rule base names with a space.

–path Lists the path of the rule base directory as well as the rule basename. The default action is that only the name of the rule base isdisplayed.

–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. Thedefault action is that all event classes in the specified rule base aredisplayed. Separate multiple event class names with a space.

rule_baseThe name of the rule base to view.

–detailedSpecifies detailed output. Displays class names and all slot valuesfor each class.

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

rule_baseThe name of the rule base to view.

Chapter 1. Commands 79

TEC - Comandos e referência - [PDF Document] (92)

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_baseThe name of the rule base to view.

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.

rule_baseThe name of the rule base to view.

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 andan existing rule base is in path, the rule base is checked for consistency. Youcan 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.

NotesDifferent operating systems often encode text in different ways. For example, PCoperating systems use SJIS (code page 932) for Japanese text, but UNIX systemsoften use EUC_JP. If you are importing an event class specification (BAROC) file orrule set file that has an encoding different from the default file for the local system,specify the –encoding option along with the name of the file character encoding onthe wrb –imprbclass or wrb –imprbrule command. You can specify any of thefollowing character encodings.ASCII American Standard Code for Information Interchange

80 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (93)

Cp1252 Windows Latin-1ISO8859_1 ISO 8859, Latin alphabet number 1UTF-16BE 16–bit Unicode Transformation Format, big-endian byte orderUTF-16LE 16–bit Unicode Transformation Format, little-endian byte orderUTF-8 8–bit Unicode Transformation FormatUTF-16 16–bit Unicode Transformation Format, byte order specified by a

mandatory initial byte-order markBig5 Big5, Traditional ChineseBig5_HKSCS Big5 with Hong Kong extensions, Traditional ChineseCp037 USA, Canada (bilingual, French), Netherlands, Portugal, Brazil,

AustraliaCp273 IBM Austria, GermanyCp277 IBM Denmark, NorwayCp278 IBM Finland, SwedenCp280 IBM ItalyCp284 IBM Catalan/Spain, Spanish Latin AmericaCp285 IBM United Kingdom, IrelandCp297 IBM FranceCp420 IBM ArabicCp424 IBM HebrewCp437 MS-DOS United States, Australia, New Zealand, South AfricaCp500 EBCDIC 500V1Cp737 PC GreekCp775 PC BalticCp838 IBM Thailand extended SBCSCp850 MS-DOS Latin-1Cp852 MS-DOS Latin-2Cp855 IBM CyrillicCp856 IBM HebrewCp857 IBM TurkishCp858 Variant of Cp850 with Euro characterCp860 MS-DOS PortugueseCp861 MS-DOS IcelandicCp862 PC HebrewCp863 MS-DOS Canadian FrenchCp864 PC ArabicCp865 MS-DOS NordicCp866 MS-DOS RussianCp868 MS-DOS PakistanCp869 IBM Modern GreekCp870 IBM Multilingual Latin-2Cp871 IBM IcelandCp874 IBM ThaiCp875 IBM GreekCp918 IBM Pakistan (Urdu)Cp921 IBM Latvia, Lithuania (AIX, DOS)Cp922 IBM Estonia (AIX, DOS)Cp930 Japanese Katakana-Kanji mixed with 4370 UDC, superset of 5026Cp933 Korean mixed with 1880 UDC, superset of 5029Cp935 Simplified Chinese Host mixed with 1880 UDC, superset of 5031Cp937 Traditional Chinese Host mixed with 6204 UDC, superset of 5033Cp939 Japanese Latin Kanji mixed with 4370 UDC, superset of 5035Cp942 IBM OS/2® Japanese, superset of Cp932Cp942C Variant of Cp942Cp943 IBM OS/2 Japanese, superset of Cp932 and Shift-JISCp943C Variant of Cp943

Chapter 1. Commands 81

TEC - Comandos e referência - [PDF Document] (94)

Cp948 OS/2 Chinese (Taiwan), superset of 938Cp949 PC KoreanCp949C Variant of Cp949Cp950 PC Chinese (Hong Kong, Taiwan)Cp964 AIX Chinese (Taiwan)Cp970 AIX KoreanCp1006 IBM AIX Pakistan (Urdu)Cp1025 IBM Multilingual Cyrillic: Bulgaria, Bosnia, Hezegovina,

Macedonia (FYR)Cp1026 IBM Latin-5, TurkeyCp1046 IBM Arabic — WindowsCp1097 IBM Iran (Farsi)/PersianCp1098 IBM Iran (Farsi)/Persian (PC)Cp1112 IBM Latvia, LithuaniaCp1122 IBM EstoniaCp1123 IBM UkraineCp1124 IBM Aix UkraineCp1140 Variant of Cp037 with Euro characterCp1141 Variant of Cp273 with Euro characterCp1142 Variant of Cp277 with Euro characterCp1143 Variant of Cp278 with Euro characterCp1144 Variant of Cp280 with Euro characterCp1145 Variant of Cp284 with Euro characterCp1146 Variant of Cp285 with Euro characterCp1147 Variant of Cp297 with Euro characterCp1148 Variant of Cp500 with Euro characterCp1149 Variant of Cp871 with Euro characterCp1250 Windows Eastern EuropeanCp1251 Windows CyrillicCp1253 Windows GreekCp1254 Windows TurkishCp1255 Windows HebrewCp1256 Windows ArabicCp1257 Windows BalticCp1258 Windows VietnameseCp1381 IBM OS/2, DOS People’s Republic of China (PRC)Cp1383 IBM AIX People’s Republic of China (PRC)Cp33722 IBM-eucJP — Japanese (superset of 5050)EUC_CN GB2312, EUC encoding, Simplified ChineseEUC_JP JIS X 0201, 0208, 0212, EUC encoding, JapaneseEUC_JP_LINUX

JIS X 0201, 0208, EUC encoding, JapaneseEUC_KR KS C 5601, EUC encoding, KoreanEUC_TW CNS11643 (Plane 1–3), EUC encoding, Traditional ChineseGBK GBK, Simplified ChineseISO2022CN ISO 2022 CN, Chinese (conversion to Unicode only)ISO2022JP JIS X 0201, 0208 in ISO 2022 form, JapaneseISO2022KR ISO 2022 KR, KoreanISO8859_2 ISO 8859–2, Latin alphabet number 2ISO8859_3 ISO 8859–3, Latin alphabet number 3ISO8859_4 ISO 8859–4, Latin alphabet number 4ISO8859_5 ISO 8859–5, Latin/Cyrillic alphabetISO8859_6 ISO 8859–6, Latin/Arabic alphabetISO8859_7 ISO 8859–7, Latin/Green alphabetISO8859_8 ISO 8850–8, Latin/Hebrew alphabetISO8859_9 ISO 8859–9, Latin alphabet number 5

82 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (95)

ISO8859_13 ISO 8859–13, Latin alphabet number 7ISO8859_15_FDIS

ISO 8859–15, Latin alphabet number 9JIS0201 JIS X 0201, JapaneseJIS0208 JIS X 0208, JapaneseJIS0212 JIS X 0212, JapaneseJISAutoDetect Detects and converst from Shift-JIS, EUC-JP, ISO 2022 JP

(conversion to Unicode only)Johab Johab, KoreanKOI8_R KOI8–R, RussianMS874 Windows ThaiMS932 Windows JapaneseMS936 Windows Simplified ChineseMS949 Windows KoreanMS950 Windows Traditional ChineseMacArabic Macintosh ArabicMacCentralEurope

Macintosh Latin-2MacCroatian Macintosh CroatianMacCyrillic Macintosh CyrillicMacDingbat Macintosh DingbatMacGreek Macintosh GreekMacHebrew Macintosh HebrewMacIceland Macintosh IcelandMacRoman Macintosh RomanMacRomania Macintosh RomaniaMacSymbol Macintosh SymbolMacThai Macintosh ThaiMacTurkish Macintosh TurkishMacUkraine Macintosh UkraineSJIS Shift-JIS, JapaneseTIS620 TIS620, Thai

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:

Chapter 1. Commands 83

TEC - Comandos e referência - [PDF Document] (96)

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

The following example copies everything over, which includes the class sets, rulesets, rule packs and rule base target:wrb -cprb DefaultRuleBase NewRuleBase

whereas the following example copies only the rule sets:wrb -cprb -rulesets DefaultRuleBase NewRuleBase

84 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (97)

wrb_default_rb

Deactivates active rule sets in the default rule base.

Syntaxwrb_default_rb –inactivate rulesets

DescriptionThe wrb_default_rb command deactivates any of the rule sets in the default rulebase that are activated by default, namely, the maintenance_mode, netview,ebusiness, heartbeat, and cleanup rule sets.

Note: The dependency rule set is also active by default, but its activity is linked tothe ebusiness rule set and can be changed only by changing the activity ofthe ebusiness rule set; that is, to deactivate the dependency rule set, youmust deactivate the ebusiness rule set.

AuthorizationNone

Optionsrulesets

Specifies the names of the rule sets to be deactivated. To deactivate morethan one rule set, insert blank spaces between the names.

ExamplesThe following example deactivates the netview and heartbeat rule sets:wrb_default_rb -inactivate netview heartbeat

Chapter 1. Commands 85

TEC - Comandos e referência - [PDF Document] (98)

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 Tivoli Enterprise Consolecommands.

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 need to run the wrbupgrade command only if you want to use rule packs andrule base targets with rule bases that were created with Tivoli Enterprise Consoleversions prior to version 3.7. You do not need to run this command to use the wrbcommand.

Authorizationuser

Options–f Specifies that the wrbupgrade command should be run even if the

specified rule base has already been upgraded. This option is valid onlywith 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.

86 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (99)

wsendresp

Displays a message on the desktop of the operator.

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 issued by a rule to display amessage to an operator. For example, when a HOST_DOWN event isacknowledged, a rule can issue the wsendresp command to inform an operator ofthe proper course of action for the affected host. For this command to runsuccessfully, the event server and the console of the specified operator must berunning.

Authorizationadmin

Options[host:]filepath

Specifies the path name of the file containing the preferred message. Youcan optionally 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

Chapter 1. Commands 87

TEC - Comandos e referência - [PDF Document] (100)

wsetac

Modifies an adapter configuration record for an adapter configuration profile.

Syntaxwsetac adapter_details key profile

DescriptionThe wsetac command enables an existing record in an adapter configurationprofile to be modified.

Each adapter type on each adapter configuration profile might be supported bydefault policies to supply initial values for parts of the configuration not given bya waddac call. Similarly, validation policies might be present to ensure that a givenconfiguration is valid according to the needs of the event adapter implementation,local installation particulars, 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

Optionsadapter_details

Gives the specific adapter configuration information such as distributionpaths, user IDs, and adapter filtering that are used for the distributionparameters of the adapter.

–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 call of thecommand. If some of those attributes are to be replaced and othersaugmented, then several calls of the command are 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.

–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 varyby endpoint, but those currently supported include the followingflags:

88 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (101)

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

ignore Ignore all failures.

report Report failures but continue with distributionactivity, the default behavior.

abort Stop distribution.

expandControls whether references to endpoint context variablesof the form $variable within attributes of the record shouldbe expanded by the endpoint code when the profile isdistributed. The value of the variable can be no to disableexpansion, yes to enable it for all attributes (the defaultbehavior), or a comma-separated list of attribute names toselectively expand only within the values of thoseattributes.

rm_on_delInstructs the endpoint code whether to removeconfiguration files and distributed files when the record isdistributed after being removed. The value can 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 primary adapter configuration file).

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

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 adapter configurationprofile record. The comment text is written into the configurationfile when it is created 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 can be of the form !command or !!command. The givencommand, which can be any valid statement for the operatingsystem-dependent command line interpreter present on subscribernodes (generally, /bin/sh, however on non-UNIX operatingsystems it might be different), is run before (single !) or after (!!)the configuration information and all distributed files are written.

Multiple –D options can be supplied.

Chapter 1. Commands 89

TEC - Comandos e referência - [PDF Document] (102)

–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 wanted can 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 can 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 in the following form:

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

The entire string needs to be enclosed in quotation marks toprevent the command-line interpreter from reacting to thesemicolons. To create a filter that is initially in a disabled state, thestring can 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 are 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 in the followingform:

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

The entire string needs to be enclosed in quotation marks toprevent the command-line interpreter from reacting to thesemicolons. To create a filter cache that is initially in a disabledstate, the string can be prefixed with #ilterCache:. Thus,wsetac -f ’#ilterCache:Class=LogFile_Base;’ acp1

adds a single disabled filter cache record to the new profile acp1.(Enabled filter caches are prefixed with FilterCache:.)

Many –F options can be supplied.

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

–i on|off[,idname]Specifies whether the adapter should be assigned a uniqueidentifier and what identifier to use. Use this option when runningmultiple adapters on the same system to assign unique identifiersto the adapters. Specify on|off to indicate whether to use anidentifier, and specify idname to indicate the identifier to be used. Ifyou specify –i on without idname, the previously defined identifier

90 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (103)

is used. If you specify –i off with idname, the configuration recordcontains the ID but the adapter does not have an ID after youdistribute the profile.

–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 value is OUT. If youuse IN 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 generally is 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 can 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 adapter configurationprofile entry panel or by using the wlsac command.

profile The adapter configuration profile to which the new adapter configurationrecord is to be added. If the name includes spaces, enclose the whole namein quotation marks.

ExamplesThe following example changes the ServerLocation value in the CONF file toquasar for key 0 in the adapter configuration profile named quasar:wsetac -e ServerLocation=quasar 0 @ACP:quasar

See Alsowaddac, wdelac, wlsac, wsetaddflt

Chapter 1. Commands 91

TEC - Comandos e referência - [PDF Document] (104)

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 adapter configuration profilerecord, but instead of installing it on a profile object, the record is installed as theglobal default record for the given event adapter type. The values of the attributesin the record can be fetched later with the wlsaddflt command from within policyscripts to obtain the basic default information for an adapter type. Policy scriptscan then apply filtering or modifications. Each adapter configuration profilecontains the following configuration information for one or 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 adapter configuration profile might be supported bydefault policies to supply initial values for parts of the configuration not given bya waddac call. Similarly, validation policies might be present to ensure that a givenconfiguration is valid according to the needs of the event adapter implementation,local installation particulars, and security concerns.

Authorizationsenior

Optionsadapter_details

Gives the specific adapter configuration information such as distributionpaths, user IDs, and adapter filtering that are used for the distributionparameters of the adapter.

–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 call of thecommand. If some of those attributes are to be replaced and othersaugmented, then several calls of the command are 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.

92 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (105)

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

–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 varyby endpoint, but those currently supported include the followingflags:

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

ignore Ignore all failures.

report Report failures but continue with distributionactivity, the default behavior.

abort Stop distribution.

expandControls whether references to endpoint context variablesof the form $variable within attributes of the record shouldbe expanded by the endpoint code when the profile isdistributed. The value of the variable can be no to disableexpansion, yes to enable it for all attributes (the defaultbehavior), or a comma-separated list of attribute names toselectively expand only within the values of thoseattributes.

rm_on_delInstructs the endpoint code whether to removeconfiguration files and distributed files when the record isdistributed after being removed. The value can 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 primary adapter configuration file).

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

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 adapter configurationprofile record. The comment text is written into the configurationfile when it is created 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).

Chapter 1. Commands 93

TEC - Comandos e referência - [PDF Document] (106)

Instead of the destination=source form for a distribution request, thestring can be of the form !command or !!command. The givencommand, which can be any valid statement for the operatingsystem-dependent command line interpreter present on subscribernodes (generally, /bin/sh, however on non-UNIX operatingsystems it might 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 wanted can 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 can 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 in the following form:

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

The entire string needs to be enclosed in quotation marks toprevent the command-line interpreter from reacting to thesemicolons. To create a filter that is initially in a disabled state, thestring can 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 are prefixed with Filter:.)

Multiple –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 in the followingform:

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

The entire string needs to be enclosed in quotation marks toprevent the command-line interpreter from reacting to thesemicolons. To create a filter cache that is initially in a disabledstate, the string can be prefixed with #ilterCache:. Thus,wsetaddflt -F ’#ilterCache:Class=LogFile_Base;’ acp1

adds a single disabled filter cache record to the new profile acp1.(Enabled filter caches are prefixed with FilterCache:.)

Multiple –F options can be supplied.

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

94 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (107)

–i on|off[,idname]Specifies whether the adapter should be assigned a uniqueidentifier and what identifier to use. Use this option when runningmultiple adapters on the same system to assign unique identifiersto the adapters. Specify on|off to indicate whether to use anidentifier, and specify idname to indicate the identifier to be used. Ifyou specify –i on without idname, the previously defined identifieris used. If you specify –i off with idname, the configuration recordcontains the ID but the adapter does not have an ID after youdistribute the profile.

–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 value is OUT. If youuse IN 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 generally is 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 can 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 targetadapter configuration profile might reject the new record. To see theavailable types, use the wlsaddflt command.

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" \

Chapter 1. Commands 95

TEC - Comandos e referência - [PDF Document] (108)

-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__ adapterconfiguration profile default definition, as this is the base definition forall adapter types.

See Alsowaddac, wdelac, wlsac, wsetac

96 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (109)

wsetadenv

Installs a list of recognized Event Integration Facility environment variables for anadapter type.

Syntaxwsetadenv [–a] variable_name... type

DescriptionThe wsetadenv command provides the Adapter Configuration Facility with a listof the Event Integration Facility environment variables that are recognized by theadapter but are not part of the common set of variables used directly by the EventIntegration Facility. The variable names registered with wsetadenv are madeavailable to users of the Adapter Configuration Facility graphical user interfacewhen configuring environment variable lists. The list can also be used by profilevalidation scripts.

The Adapter Configuration Facility itself installs the list of basic Event IntegrationFacility variables under 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 Event Integration Facility variableshere, but it is unnecessary. Separate multiple variable_names with a space.

–a Instructs wsetadenv to append the variable names to the list alreadyconfigured for the given adapter type. Typically, 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

Chapter 1. Commands 97

TEC - Comandos e referência - [PDF Document] (110)

wsetadgui

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

Syntaxwsetadgui class name catalog text key type

DescriptionThe wsetadgui command provides the Adapter Configuration Facility with thename of an object that supplies a standard interface for performing extendedtype-specific graphical configuration. The command also supplies a label to beused on the “launch” button on the Adapter Configuration Facility GUI that theuser can click to start the extended configuration tools.

Because Tivoli Enterprise Console event adapters can vary widely in their natureand scope, the Adapter Configuration Facility itself does not attempt to provideconfiguration tools for any details beyond the common subset of Event IntegrationFacility configuration. However, because graphical configuration tools might bewanted for a variety of adapter types, the Adapter Configuration Facility graphicalinterface can effectively be extended by constructing a configuration tool for aspecific adapter and then hooking it up to the Adapter Configuration Facility withwsetadgui.

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 Adapter Configuration Facility user interface calls the acf_extension methodupon user request, passing the method the profile record as currently configuredalong with the record key and the profile name. The user interface serverenvironment is also passed so that the configuration tools know where to presentthe dialogs. The extended configuration tool can perform any necessarymodifications to the record, returning a new version of the record when finished.Usually, environment variables and distribution requests are the attributes of therecord most commonly 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 Adapter Configuration Facility 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).

98 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (111)

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

Chapter 1. Commands 99

TEC - Comandos e referência - [PDF Document] (112)

wsetadval

Installs validation information for an adapter type.

Syntaxwsetadval file attribute type

DescriptionThe wsetadval command informs the Adapter Configuration Facility that thenamed file contains validation information to be used in validating the value of thenamed 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 Adapter Configuration Facility validation policiesexpect that the installed adapter validation information is shell scripts.

Authorizationsenior

Optionsattribute

The name of the attribute to which the validation information applies. Theattributes on an adapter configuration profile typically are as follows:

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.

100 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (113)

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 might be present if they are added to the profile withTivoli AEF 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

Chapter 1. Commands 101

TEC - Comandos e referência - [PDF Document] (114)

wsetaeenv

Modifies environment variables stored on adapter configuration profile 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 enables the list of adapter configuration environmentvariables stored on a profile endpoint object to be set or modified. The new valuesare used during the next adapter configuration profile distribution to the namedendpoint.

Adapter configuration profiles use the environment information stored onendpoints by referring to them in record field values. References to environmentvariables are of the form $[name]. When the profile is received at the endpointduring distribution, the environment variable references are expanded so that theactual value of the variable is used in whatever context the reference was made.(Expansion is done under control of the expand behavior flag; see the manual pagefor the waddac commands.)

In addition to the environment variables established under user control withwsetaeenv, some variables are created automatically by the adapter configurationendpoint code. These variables describe the endpoint object, the adapterconfiguration profile containing the record where a reference is made, and therecord itself. These automatic environment variables are available for use in exactlythe same way user-controlled variables are. The list of automatic environmentvariables is as follows:

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.

102 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (115)

ACP_PRFMGRThe name of the profile manager object from which the profile wasdistributed. (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 do 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 be in the file, one per line. If file is a singledash, then the list is read from the standard input to wsetaeenv.

ExamplesThe following example adds the environment variable BufEvtMaxSize to the profileendpoint object of endpoint boston-box:

Chapter 1. Commands 103

TEC - Comandos e referência - [PDF Document] (116)

wsetaeenv -a BufEvtMaxSize=500000 @Endpoint:boston-box

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

104 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (117)

wsetemsg

Modifies an event.

Syntaxwsetemsg [–t status [–f] [–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:

Command Option Authorization

–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 should be one definedfor the event class. Separate multiple attribute=value expressions with aspace.

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

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

–f Forces an event to change status from CLOSED to OPEN, ACK, orRESPONSE. Also forces an event to change status from ACK toOPEN. If you do not specify the –f option, you cannot change thestatus of an event from ACK to OPEN, from CLOSED to OPEN,from CLOSED to ACK, from RESPONSE to ACK, from RESPONSEto OPEN, or from CLOSED to RESPONSE.

Chapter 1. Commands 105

TEC - Comandos e referência - [PDF Document] (118)

ExamplesThe following example acknowledges event 11782052457 for event consoleNetwork Events:wsetemsg –t ACK "Network Events" 11782052457

See Alsowlsemsg, wpostemsg (endpoint version), wpostzmsg (endpoint version)

106 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (119)

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 region is modified unless another server is specified. Youmust specify at least one option, otherwise the command returns 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 value is500 events.

–c eventsSets the event cache to the number of events specified by events. Thedefault value is 1000 events. It should be large enough to handle a peaknumber of pending events. If the cache is too small, the server does aforced cache 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 defaultvalue is 86400 seconds (1 day).

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

–k secondsRetains closed events going back the specified number of seconds. Thedefault value is 86400 seconds (1 day).

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

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

Chapter 1. Commands 107

TEC - Comandos e referência - [PDF Document] (120)

–S serverSpecifies the name of the event server in name registry format. The defaultserver is the local event server. To indicate a remote server, specify@EventServer#tmr, where tmr is the name of a Tivoli region.

–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 region:wsetesvrcfg –c 1536 –S @EventServer#AcmeTMR

See Alsowlsesvrcfg

108 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (121)

wsetsrc

Resets event source attributes.

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

DescriptionThe wsetsrc command sets the name or label for a source registered on the eventserver. Use the wlssrc command to display a list of defined sources.

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

Authorizationsenior

Optionssource Specifies the source to be modified.

–l label Specifies the label to use to identify the source on an event console. Thedefault value is the value specified by the source argument.

–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 CDSconfiguration file.

–S serverSpecifies the name of the event server in name registry format. The defaultserver is the local event server. To indicate a remote server,specify@EventServer#tmr, where tmr is the name of a Tivoli region.

ExamplesThe following example sets the label of the LOGFILE source to syslog:wsetsrc -l syslog LOGFILE

See Alsowcrtsrc, wdelsrc, wlssrc

Chapter 1. Commands 109

TEC - Comandos e referência - [PDF Document] (122)

wsighupSignals the Windows Event Log Adapter or Windows NT Event Log Adapter toreload the configuration and format files.

Syntaxwsighup adapter pid

DescriptionThe wsighup command causes the Windows Event Log Adapter or the WindowsNT Event Log Adapter to reload the configuration and format files. Use thiscommand if you have made changes to the configuration or format file and youwant to start using the changed configuration without having to stop the adapter.

Note: Use the wsighup command only on Windows systems. If you are using theUNIX operating system, use the command kill -HUP adapter_pid to reloadconfiguration and format files.

AuthorizationNone

Optionsadapter The name of the adapter service

pid The process ID of the adapter

ExamplesThe following example reloads the configuration and format files for the adaptertecwinadapter_myid with process ID 712:wsighup tecwinadapter_myid 712

110 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (123)

wstartesvr

Starts the event server.

Syntaxwstartesvr [–S server]

DescriptionThe default action of the wstartesvr command starts the event server in the localTivoli region. The event server reads configuration files, the database of events,and loads the rule base. The event cache is loaded with events based on time andbuffer size parameters, and QUEUED and WAITING events (if there were eventsin these states when the server was last shut down) are loaded into the receptionbuffer. Then the event server makes itself available for communication with eventadapters and consoles. It begins processing QUEUED and WAITING events andincoming events immediately.

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

If an event server stops, any consoles that were connected to it are automaticallyreconnected when the server is restarted.

Authorizationsenior

Options–S server

Specifies the name of the event server in name registry format. The defaultserver is the local event server. To indicate a remote server, specify@EventServer#tmr, where tmr is the name of a Tivoli region.

ExamplesThe following example starts the local event server:wstartesvr

See Alsowstopesvr

Chapter 1. Commands 111

TEC - Comandos e referência - [PDF Document] (124)

wstartmaint.sh

Informs the event server that a host has been placed in maintenance mode.

Syntaxwstartmaint.sh host_name duration "owner_info" [start_time]

DescriptionThe wstartmaint.sh command informs the event server that a network resource hasbeen put in maintenance mode by sending a TEC_Maintenance control event. Youcan use this command manually or you can automate it using the systemscheduler. The output for this command is the same as the output for theStart_Maintenance task.

AuthorizationNone

Optionshost_name

Specifies the fully qualified name of the host put in maintenance mode.

durationSpecifies the length of time, in minutes, that the host is to remain inmaintenance mode.

"owner_info"Specifies information about the user who started the maintenance window.

start_timeIndicates the time that the host is put in maintenance mode, specified as YYYYMM DD HH MM SS. If not specified, the default value is the current systemtime.

ExamplesThis example informs the event server that host myhost is to be put inmaintenance mode for 30 minutes starting immediately:wstartmaint.sh myhost.mynet.com 30 "my.email.com"

This example informs the event server that host myhost is to be put inmaintenance mode for 1 hour starting July 1, 2003 at 7:00 p.m.:wstartmaint.sh myhost.mynet.com 60 "my.email.com" 2003 07 01 19 00 0

This example informs the event server that all hosts are to be put in maintenancemode for 1 minute immediately:wstartmaint.sh "*" 1 "my.email.com"

See Alsowstopmaint.sh

112 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (125)

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 defaultserver is the local event server. To indicate a remote server, specify@EventServer#tmr, where tmr is the name of a Tivoli region.

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

See Alsowstartesvr, wstopesvr

Chapter 1. Commands 113

TEC - Comandos e referência - [PDF Document] (126)

wstopesvr

Stops the event server.

Syntaxwstopesvr [–S server]

DescriptionThe wstopesvr command stops the event server in the local Tivoli region.

If an event server stops, any consoles that were connected to it are automaticallyreconnected when the server is restarted.

Authorizationsenior

Options–S server

Specifies the name of the event server in name registry format. The defaultserver is the local event server. To indicate a remote server, specify@EventServer#tmr, where tmr is the name of a Tivoli region.

ExamplesThe following example stops the local event server:wstopesvr

See Alsowstartesvr

114 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (127)

wstopmaint.sh

Informs the event server that an ongoing or scheduled maintenance mode for anetwork resource is being canceled.

Syntaxwstopmaint.sh host_name [start_time]

DescriptionThe wstopmaint.sh command informs the event server either that an ongoingmaintenance window for a network resource is being canceled before thescheduled end time or that a future scheduled maintenance window for a networkresource is being canceled.

AuthorizationNone

Optionshost_name

Specifies the fully qualified name of the host to be taken out of maintenancemode.

start_timeIndicates the time that the host was placed in maintenance mode, specified asYYYY MM DD HH MM SS. If the time is not specified, the current and allfuture maintenance windows for the host are canceled.

ExamplesThis example informs the event server that the current maintenance window forhost myhost is being canceled early:wstopmaint.sh myhost.mynet.com 2003 04 21 12 10 00

This example informs the event server that all current and future scheduledmaintenance windows for host myhost are being canceled:wstopmaint.sh myhost.mynet.com

See Alsowstartmaint.sh

Chapter 1. Commands 115

TEC - Comandos e referência - [PDF Document] (128)

wstoptecgwStops the Tivoli Enterprise Console gateway.

Syntaxwstoptecgw

DescriptionThe wstoptecgw command stops a Tivoli Enterprise Console gateway that servicesendpoints. The Tivoli Enterprise Console gateway restarts automatically uponreceipt of an event, so there is no corresponding command to start the gateway.This command must be run in the shell sourced on the endpoint installed on thehost (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, follow these steps:1. Install the Adapter Configuration Facility on the managed node to act as the

Tivoli Enterprise Console gateway.2. Create an endpoint on that managed node.3. Create an adapter configuration profile entry for the tec_gateway configuration

file.4. Distribute the tec_gateway adapter configuration profile to the endpoint. The

wstoptecgw command now resides in the $LCF_BINDIR/../bin/ directory onthis endpoint.

Note: The wstoptecgw command is also distributed when you distribute thetec_gateway_sce adapter configuration profile.

Authorizationuser

116 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (129)

wtdbclear

Clears events from the event database.

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

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

The wtdbclear command must be run 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 the reception log withthe –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 value is TRUE. The tec_p_clear_events procedureimproves the 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.

Chapter 1. Commands 117

TEC - Comandos e referência - [PDF Document] (130)

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

–w Forces deletion of events that have not yet been processed by the datawarehouse extract, transform, and load (ETL) process. If the TivoliEnterprise Console warehouse enablement pack is installed, events in therepository are periodically processed by the warehouse ETL process. If youissue the wtdbclear command and specify a time window that includesevents that have not yet been processed by the warehouse ETL process, thewtdbclear command returns a warning message. Use the –w option toforce deletion of these events.

NotesIf more than one of the –c, –s, and –r options is specified, the result is a logical OR.

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

The following example, because it specifies more than one of the –c, –s,, and –roptions, deletes all events that have a severity of HARMLESS or all events thathave a class value of TEC_Start:wtdbclear -r HARMLESS -c TEC_Start -et 0

See Alsowdbmaint.sh, wtdumper, wtdumprl, wtdumptr

118 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (131)

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] [–w]

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

If the wtdbclear.pl script is run from a node other than the Tivoli EnterpriseConsole server, it uses the time from the local system to determine which events toclear, and this might cause unexpected behavior. It is recommended that you donot run 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 run 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 Tivoli Enterprise Console,version 3.8 release and might not be available in future releases. Use thewtdbclear command instead. The wtdbclear.pl command should be usedonly in the following situations:v If you use an DB2 database and the C compiler is not installed or is not

configured for the database serverv If you use an 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.

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

–D Turns on tracing. When this option is used, the default action is for tracingto go to stdout; you might want to redirect the output of the command toa 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.

Chapter 1. Commands 119

TEC - Comandos e referência - [PDF Document] (132)

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.

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

Note: You cannot use the this option when clearing reception logs with the–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 reception logs with the–l option.

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

–w Forces deletion of events that have not yet been processed by the datawarehouse extract, transform, and load (ETL) process. If the TivoliEnterprise Console warehouse enablement pack is installed, events in therepository are periodically processed by the warehouse ETL process. If yourun the wtdbclear.pl script and specify a time window that includes eventsthat have not yet been processed by the warehouse ETL process, thewtdbclear.pl script returns a warning message. Use the –w option to forcedeletion of these events.

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 Alsowdbmaint.sh, wtdbclear, wtdumper, wtdumprl, wtdumptr

120 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (133)

wtdbspaceProvides space usage statistics for the event database.

Syntaxwtdbspace [-R rim_object_name] [-t temp_dev_name,...] [-d data_dev_name,... | -T ]

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 system where this command is run must have the bash, perl, and wrimsql

programs available, unless noted otherwise. Run this program from bash.

If you use an Informix database, you must run the wtdbspace script as the TivoliEnterprise Console Informix user on the system that has the Informix databaseserver installed, and the database environment must be sourced. If the Informixserver is on a different system than the event server, you must copy the wtdbspacescript (located in the $BINDIR/bin directory on the event server) to the Informixserver or make the script available by an NFS mount. The wrimsql command isnot needed when running wtdbspace on the Informix database server.

If you use an DB2 database, you must run the wtdbspace script as the TivoliEnterprise Console DB2 user on the RIM host from the DB2 command lineprocessor, and the database environment must be sourced. If the RIM host is on adifferent system than the Tivoli Enterprise Console server, you must copy thewtdbspace script (located in the $BINDIR/bin directory on the event server) andthe db2_runstats script (located in the $BINDIR/TME/TEC/sql directory on theevent server) to the DB2 server or make the scripts available by an NFS mount.The wrimsql command is not needed when you are running the wtdbspacecommand for a DB2 database.

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

DB2 table space names

Informix dbspace names

Microsoft 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 quotation marks. If nonames are specified, then all device names in the database are reported on.

Chapter 1. Commands 121

TEC - Comandos e referência - [PDF Document] (134)

This command supports the use of the asterisk character as a matchingcharacter. It can 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 value 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

DB2 temporary table spaces defined for thedatabase

Informix DBSPACETEMP

Microsoft SQL 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 named in the database are reported on.

This command supports the use of the asterisk character as a matchingcharacter. It can 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 cannot 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*

122 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (135)

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 run when the database server is down.

Authorizationsenior

Options–q Specifies that no output is to be printed (the wtdbstat command runs

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

Chapter 1. Commands 123

TEC - Comandos e referência - [PDF Document] (136)

wtdumper

Generates an event report of processed events from the event repository.

Syntaxwtdumper [–f file] [–t start_time] [–e end_time] [–o ASC | DESC] [–m number] [–d][–w where_clause]

DescriptionThe wtdumper command generates an event report from the event repository. TheTivoli Enterprise Console server maintains a log of these events in the database.The default action is for events to be listed in the order in which they occurred.However, the most recent event can be listed first by using the –o flag.

If wtdumper is run from a node other than the Tivoli Enterprise Console server, ituses the time from the local system to determine which events to display, and thismight cause unexpected behavior.

For example, if the time on the node is 9:00 and the Tivoli Enterprise Consoleserver is 9:30, a wtdumper run from the node displays every event in the databaseexcept for those occurring during the 30 minutes specified. The same commandrun on the Tivoli Enterprise Console server would display the entire 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 event record first. This is the default value.

DESC Lists the most recent event record 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”.

124 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (137)

–w where_clauseSpecifies a partial SQL WHERE clause for the event database query. Thispartial clause is appended to the internally generated WHERE clause withthe AND operator.

Note: This option is useful if you are experienced with SQL statements.

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"

The following example specifies a partial SQL WHERE clause for the eventdatabase query:wtdumper -w "msg = ’There was a print error’"

See Alsowtdbclear, wtdumprl, wtdumptr

Chapter 1. Commands 125

TEC - Comandos e referência - [PDF Document] (138)

wtdumprl

Generates a report of received events from the reception log.

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. The defaultaction is for events to be listed in the order they occurred. However, the mostrecent event can be listed first by using the –o flag.

If wtdumprl is run from a node other than the Tivoli Enterprise Console server, ituses the time from the local system to determine which events to display, and thismight cause unexpected behavior.

For example, if the time on the node is 9:00 and the Tivoli Enterprise Consoleserver is 9:30, a wtdumprl run from the node displays every event in the databaseexcept for those occurring during the 30 minutes specified. The same commandrun on the Tivoli Enterprise Console server would display the entire 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.

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

–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 were received after the specified date and time. Thestart_time parameter must be a date in the format of “Mon dd hh:mm:ssyyyy”.

126 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (139)

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

Chapter 1. Commands 127

TEC - Comandos e referência - [PDF Document] (140)

wtdumptr

Generates a report of running or 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. Thedefault action is for completed tasks to be listed in the order they occurred.However, the most recent task can be listed first by using 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.

–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 event record first. This is the default value.

DESC Lists the most recent event record first.

–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

128 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (141)

wtecexport

Exports Tivoli Enterprise Console event 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 called as wtecexport.cmd. Theoptions are the same.

DescriptionThe definitions of event groups, consoles, and operators can be exported to a fileand then imported into another Tivoli region by using the wtecimport command.All administrators have the same Configuration view of objects within a region.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 Tivoli region so

that the event consoles can be imported into other regions for additionalconfiguration or implementation.

v The console definitions in one Tivoli region can be used as a single point ofcontrol for console configuration in a multi-region environment.

v It is an efficient way to create console backups.

This task can also be performed from the event console user interface.

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 host name of a managed node where the user ID and password mustbe authenticated by the Tivoli Management Framework. Specify this optionas host:port if a port other than 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 is created. The path must already exist.

—O operator1:operator2:...A list of operators, separated by colons, to export.

Chapter 1. Commands 129

TEC - Comandos e referência - [PDF Document] (142)

—p passwordThe password for the login specified in the –u argument. This option isrequired if you use the –u option to specify a user.

—u userThe Tivoli administrator login. If you do not specify this option, the ID ofthe user currently logged on is used.

Note: If you are running on an AIX system and are logged in as root, you mustuse the –h, –u, and –p suboptions to explicitly specify the host name, userID, and password to prevent the login window from displaying. This is notnecessary if you are logged in to an AIX system under any other user ID.

Examples1. The following example performs the export as the user root on the event server

mica from a system running a Windows operating system. Operators, consoles,and event groups to be exported are shown and the resources are written to afile named export_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 a Windows operating system. In this case, alloperators, consoles, and event groups are exported to export_file.wtecexport.cmd -h mica -u root -p tivoli \-f export_file

See Alsowtecimport

130 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (143)

wtecimport

Imports event console definitions from an export file into a Tivoli region.

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 called as wtecimport.cmd. Theoptions 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 Tivoli regionthrough an event console. All administrators have the same Configuration view ofobjects within a region. Exporting and importing console definitions provides thefollowing benefits:v It is an efficient way to create a base set of event consoles in one Tivoli region so

that the event consoles can be imported into other region for additionalconfiguration or implementation.

v The console definitions in one Tivoli region can be used as a single point ofcontrol for console configuration in a multi-region environment.

v It is an efficient way to create console backups.

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 Tivoli region can be importedas operators. You cannot create a new Tivoli administrator in a region by importingan operator that is not defined in the receiving region.

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 host name of a managed node where the user ID and password must

Chapter 1. Commands 131

TEC - Comandos e referência - [PDF Document] (144)

be authenticated by the Tivoli Management Framework. Specify this optionas host:port if a port other than 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. This option isrequired if you use the –u option to specify a user.

–u userThe Tivoli administrator login. If you do not specify this option, the ID ofthe user currently logged on is used.

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

Note: If you are running on an AIX system and are logged in as root, you mustuse the –h, –u, and –p suboptions to explicitly specify the host name, userID, and password to prevent the login window from displaying. This is notnecessary if you are logged in to an AIX system under any other user ID.

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 are 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 groupsare replaced in the event of a name conflict.wtecimport.cmd -h mica -u root -p tivoli -f export_file -x r

See Alsowtecexport

132 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (145)

wtouchac

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

Syntaxwtouchac key... profile

DescriptionThe wtouchac command updates the timestamp on one or more records from anadapter configuration profile. The update forces the records to be distributed thenext time a distribution is requested from the Adapter Configuration Facility GUIor through the wdist command 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 is read and rewritten. Separate

multiple keys with a space. You can see the key value in the upper rightside of the adapter configuration profile entry panel or by using the wlsaccommand.

profile The adapter configuration profile to affect. If the name includes spaces,enclose the whole name in quotation marks.

ExamplesThe following example updates the time stamp on the adapter configurationprofile entry stored in key 1 for profile ACP_Profile:wtouchac 1 @ACP:ACP_Profile

The following example updates the time stamp on the adapter configurationprofile entry stored in key 1 for profile ACP Profile (which includes a space in itsname):wtouchac 1 @"ACP:ACP Profile"

See Alsowdistrib (in the IBM Tivoli Management Framework Reference Manual), waddac

Chapter 1. Commands 133

TEC - Comandos e referência - [PDF Document] (146)

134 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (147)

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 is shown 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 event in theWorking Queue of the Event Viewer 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 run rule base tasks. Rule base tasks are sometimes referred to asautomated responses. For information about running tasks from within rules,see the Tivoli Enterprise Console Rule Builder’s Guide.

A task is a script, which usually issues other Tivoli commands. Variable values arepassed to a task at run time. The variable values can come from options andarguments you specify, or from event attributes available to the task. For consoletasks that need the attributes of an event available to them, you must associate theevent with the task by selecting the event from the event console. Options andarguments you specify for tasks are described in this chapter. Event attributesavailable to tasks are described in Chapter 3, “Environment variables available totasks”, on page 159.

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

© Copyright IBM Corp. 2002 135

TEC - Comandos e referência - [PDF Document] (148)

Automated tasks results can be written to a text file, which is configured in theConsole Properties dialog for each console. For detailed information about runningthe Automated Task function from the event console, see the Automated Taskentries provided in the online help.

When running a rule base task, information about success, failure, and results ofthe task is issued only 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 run all of the tasks using event console dialogs. You canconfigure and run most of the tasks from the command line. For information aboutaccessing the Tivoli Enterprise Console task-related dialogs, see the Tivoli EnterpriseConsole User’s Guide.

The Tivoli Management Framework wruntask command is used to configure andrun console tasks from the command line, and is shown in all of the examples inthis chapter. Tasks can also be run by an action in a Tivoli Enterprise Console rule.

Note: The term configure in this chapter means to specify the input parameters andrun 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 run 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 run the task from the command line. Certain tasksneed the attributes of an event available to them. You cannot run a task thatneeds the attributes of an event available to it from the command line.

Task Name Descriptive Name File Name Command Line

Change_Severity Change severity of event T_EC_Tasks_C_zonctxba No

Clean_Database Clean out Tivoli EnterpriseConsole database

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

136 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (149)

Task Name Descriptive Name File Name Command Line

Forward_Event Forward event to the TivoliEnterprise Console server

T_EC_Tasks_F_dpstmska No

Log_Event_To_File Log event to file T_EC_Tasks_L_jfugucca No

Popup_Message Popup message on desktop T_EC_Tasks_P_rsoomfna Yes

Send_Email Send event information T_EC_Tasks_S_rsnlpxda No

Send_Event Send event to TivoliEnterprise Console server

T_EC_Tasks_S_lwqpwqla Yes

Start_Maintenance Inform the event serverabout maintenance windows

T_EC_Tasks_S_jxixoxea 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 run from the Event Viewer, a task output dialog is displayed withthis information.

For tasks that run from the command line, the same level of information is writtento stdout and stderr. For automated tasks, the results can be displayed with therelated event that triggered the task. The task can also be configured to save theresults to a log file. For rule base tasks, the results can be displayed by the console;the results are also stored in the database.

Chapter 2. Tasks 137

TEC - Comandos e referência - [PDF Document] (150)

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 taskruns. The wsetemsg command is always available on the event server host. Also,the event server must be running for this task to run 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 run this task from the command line.

138 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (151)

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 taskruns. The wtdbclear command is always available on the event server host. If aproblem occurs while the wtdbclear command is running, an explanatory messageis issued and the script exits immediately with a return code. The event databasemust be available. The event server does not have to be running.

Note: After running this task, old events deleted from the event repository are notremoved 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 run.

–l "T/EC Tasks"The task library.

–h node The managed node on which to run the task.

Command Examplewruntask -t Clean_Database -l "T/EC Tasks" \-h orange

Chapter 2. Tasks 139

TEC - Comandos e referência - [PDF Document] (152)

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

AuthorizationRIM_update, RIM_view, super, senior, admin, user

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.

–h node The managed node on which to run the task.

–l "T/EC Tasks"The task library.

–t Clear_Closed_EventsThe task to run.

Command Examplewruntask -t Clear_Closed_Events -l "T/EC Tasks" \-h orange -a 6000

140 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (153)

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

AuthorizationRIM_update, RIM_view, super, senior, admin, user

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 run the task.

–l "T/EC Tasks"The task library.

–t Clear_Reception_LogThe task to run.

Command Examplewruntask -t Clear_Reception_Log -l "T/EC Tasks" \-h orange

Chapter 2. Tasks 141

TEC - Comandos e referência - [PDF Document] (154)

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 taskruns. The wsetemsg command is always available on the event server host. Also,the event server must be running for this task to run successfully.

Authorizationsuper, senior, admin, user

Dialog Configuration OptionsThere are no options for this task.

Command SynopsisYou cannot run this task from the command line.

142 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (155)

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 taskruns. The wtdumper command is always available on the event server host.

The event database must be available. The event server does not have to berunning.

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.

–h node The managed node on which to run the task.

–l "T/EC Tasks"The task library.

–t Dump_Event_RepositoryThe task to run.

Command Examplewruntask -t Dump_Event_Repository -l "T/EC Tasks" \-h orange -a ASC -a 10

Chapter 2. Tasks 143

TEC - Comandos e referência - [PDF Document] (156)

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 taskruns. The wtdumper command is always available on the event server host.

The event database must be available. The event server does not have to berunning.

AuthorizationRIM_view, super, senior, admin, user

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. With all of the options, you can you manually enter text, including theasterisk (*) wildcard character to specify all the values for an attribute. If youmanually enter multiple values for an option, separate each with a comma. Someof the options also provide a push button to display a scrolling list from whichyou can select one or 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 log-file 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 quotation mark (for example,double quotation marks), and enclose each message within adifferent type of quotation mark (for example, single quotationmarks) separated by a comma. For example: "’msg text1’,’msgtext2’". To specify all messages, use the * wildcard character.

Starting Date and TimeSpecifies to query events received from this point to the present. Tospecify a starting point, use the following format:monddhh:mm:ssyyyy. For example, Jan 01 00:01:01 2000. To query allevents, specify the * wildcard character.

144 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (157)

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. ClickAttributes for a scrolling list of base event attributes to select from.All non-base event attributes are always displayed. If you do notselect any attributes, all (base and non-base) attributes aredisplayed 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 log-file adapter). A source is defined by

Chapter 2. Tasks 145

TEC - Comandos e referência - [PDF Document] (158)

an 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 quotation mark than the typeenclosing the entire value for the –a argument; that is, if the entireargument value is enclosed by double quotation marks (as shownin the synopsis), enclose each message within single quotationmarks. For example: -a "’msg text1’,’msg text2’". To specify allmessages, use the * wildcard character.

–a "start_point" Specifies to query events received from this point to the present. Tospecify a starting point, use the following format:monddhh:mm:ssyyyy. For example, Jan 01 00:01:01 2000. To query allevents, 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.

–h node The managed node on which to run the task.

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

–l "T/EC Tasks"The task library.

–t Event_QueryThe task to run.

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"

146 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (159)

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 task runs.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 run successfully.

AuthorizationRIM_view, super, senior, admin, user

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. Tospecify a starting point, use the following format: mon dd hh:mm:ssyyyy. For example, Jan 01 00:01:01 2000. To query all events, specifyan 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.

Chapter 2. Tasks 147

TEC - Comandos e referência - [PDF Document] (160)

Show values for attributesSpecifies which base event attributes to display in the output. ClickAttributes for a scrolling list of base event attributes to select from.All attributes for a non-base event are always displayed. If you donot select any attributes, all attributes are displayed in the output.

Command SynopsisYou cannot run this task from the command line.

148 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (161)

Forward_EventForwards an event to another event server registered in the current Tivolimanagement region.

This task assumes the wpostemsg command is available on the host where the taskruns. The wpostemsg command is always available on the event server host.

Authorizationsuper, senior, admin, user

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 clickingChoose. The local event server is named EventServer. To indicate a remoteevent server, specify EventServer#tmr, where tmr is the name of the Tivoliregion where the remote event server is located; for example,EventServer#orange-region.

Command SynopsisYou cannot run this task from the command line.

Chapter 2. Tasks 149

TEC - Comandos e referência - [PDF Document] (162)

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 click Log File Name todisplay a file browser dialog.

Command SynopsisYou cannot run this task from the command line.

150 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (163)

Popup_MessageDisplays a message on the Tivoli desktop for an operator.

This task assumes the wsendresp command is available on the host where the taskruns. 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 to runsuccessfully.

Authorizationsuper, senior, admin

Dialog Configuration OptionsOperator’s Name

The name of the operator to receive the message. You canmanually type this value or click Operator for a scrolling list ofknown 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 run 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.

–h node The managed node on which to run the task.

–l "T/EC Tasks"The task library.

–t Popup_MessageThe task to run.

Command Examplewruntask -t Popup_Message -l "T/EC Tasks" \-h orange -a Root_orange-region \-a /tmp/msg.txt

Chapter 2. Tasks 151

TEC - Comandos e referência - [PDF Document] (164)

Send_EmailSends details in an e-mail message about an event. This can be run from the fromthe 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 wmailhostcommand. For more information on the wmailhost command, see the TivoliManagement Framework Reference Manual.

Authorizationsuper, senior, admin, user

Dialog Configuration OptionsAdministrator’s Name

The name of the person to receive the message. The name is shownin the To: field of the e-mail.

Administrator’s E-mail AddressThe e-mail ID of the person to receive the message.

Command SynopsisYou cannot run this task from the command line.

152 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (165)

Send_EventCreates a new event and sends it to the specified event server registered in thecurrent Tivoli region.

This task assumes the wpostemsg command is available on the host where the taskruns. The wpostemsg command is always available on the event server host andendpoints that have an event adapter installed.

Authorizationsuper, senior, admin, user

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 byclicking Choose. The local event server is named EventServer. Toindicate a remote event server, specify EventServer#tmr, where tmris the name of the Tivoli region where the remote event server islocated; for example, EventServer#orange-region. If no value isspecified for this option, EventServer is the default value.

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 log-file adapter). The source is defined by theadapter type. 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 singlequotation marks for the pairs of double quotation marks shown.

wruntask –t Send_Event –l "T/EC Tasks" –h node–a {event_server | ""}–a {msg | ""}–a {hostname | ""}

Chapter 2. Tasks 153

TEC - Comandos e referência - [PDF Document] (166)

–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 indicate a remote event server, specifyEventServer#tmr, where tmr is the name of the Tivoli region wherethe remote event server is located; for example,EventServer#orange-region. If no event server is specified for thisargument, EventServer is the default value.

–a msg The message text of the event. If the message text containsembedded spaces, enclose within quotation marks.

–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 log-file adapter). A source is defined by an adaptertype. This argument requires a value.

–h node The managed node on which to run the task.

–l "T/EC Tasks"The task library.

–t Send_Event The task to run.

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

154 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (167)

Start_Maintenance

Informs the event server about any ongoing or future scheduled maintenancewindows for one or all hosts. The output for this task is the same as the output forthe wstartmaint.sh command.

This task assumes that the wpostemsg command is available on the host where thetask runs. The wpostemsg command is always available on the event server hostand endpoints that have an event adapter installed.

Authorizationsuper, senior, admin, user

Dialog Configuration OptionsOnly the hostname and Maintenance Duration options require values. The othersare optional; that is, you can leave any of them blank. If you leave them blank,event server processing assigns default values.

Event Server’s NameThe event server to receive the event. You can manually type a name, orselect from a scrolling list of known event servers by clicking Choose. Thelocal event server is named EventServer. To indicate a remote event server,specify EventServer#tmr, where tmr is the name of the Tivoli region wherethe remote event server is located; for example, EventServer#orange-region. If no value is specified for this option, EventServer is the defaultvalue

hostnameThe fully qualified name of the system that either is in maintenance or isto be put in maintenance. A value of "*" indicates that all managed hostsin the network are being put in maintenance, and, consequently, that allevents from these hosts are to be dropped or closed. This option requires avalue.

Maintenance Owner InformationAny contact information for the person who started the maintenance modeon the host, such as e-mail or telephone number information.

Maintenance Duration (Minutes)The length of the maintenance window in minutes. The default value is 60minutes. This option requires a value.

Time To Start Maintenance (yyyy mm dd hh mm ss)The time at which maintenance is to start for the host. If a value is notspecified, the default value is the current system time. For a scheduledfuture maintenance window, the time must be specified in the formatYYYY MM DD HH MIN SS where YYYY is the 4-digit year, MM is themonth (1–12), DD is the day (1–31), HH is the hour (00–23), MIN is theminutes (00–59), and SS is the seconds (00–59).

Command Synopsiswruntask –t Start_Maintenance –l "T/EC Tasks" –h node–a {event_server | ""}–a host_name

Chapter 2. Tasks 155

TEC - Comandos e referência - [PDF Document] (168)

–a {owner_info | ""}–a duration–a {start_time | ""}

Only the –a host_name and –a duration arguments require actual values. Values forthe other arguments are optional; that is, you do not have to specify a value for theargument, but you must still specify the argument flag with an empty placeholder;for example: -a ""

Note: You can optionally substitute pairs of single quotation marks for the pairs ofdouble quotation marks.

If you are specifying the time to start maintenance, put the values within doublequotation marks, for example: -a "2003 10 10 10 10 10"

Command Arguments–a event_server

The event server to receive the event. The local event server is namedEventServer. To indicate a remote event server, specify EventServer#tmr, wheretmr is the name of the Tivoli region where the remote event server is located;for example, EventServer#orange-region. If no value is specified for thisoption, EventServer is the default value

–a host_nameThe fully qualified name of the system that either is in maintenance or is to beput in maintenance. A value of "*" indicates that all managed hosts in thenetwork are being put in maintenance, and, consequently, all events from thesehosts are to be dropped or closed.

–a owner_infoAny contact information for the person who started the maintenance mode onthe host, such as e-mail or telephone number information.

–a durationThe length of the maintenance window in minutes. The default value is 60minutes.

–a start_timeThe time at which maintenance is to start for the host. If a value is notspecified, the default value is the current system time. For a scheduled futuremaintenance window, the time must be specified in the format YYYY MM DDHH MIN SS where YYYY is the 4-digit year, MM is the month (1–12), DD isthe day (1–31), HH is the hour (00–23), MIN is the minutes (00–59), and SS isthe seconds (00–59).

–h nodeThe managed node on which to run the task.

–l "T/EC Tasks"The task library.

–t Start_MaintenanceThe task to run.

Command Examplewruntask -t Start_Maintenance -l "T/EC Tasks" -h orange -a EventServer \-a myhost.mynet.com -a "my_info" -a 30 -a "2003 10 10 10 15 59"

156 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (169)

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

Authorizationsuper, senior, admin

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

–h node The managed node on which to run the task.

–l T/EC Tasks The task library.

–t Wake_Up_NetscapeThe task to run.

Command Examplewruntask -t Wake_Up_Netscape -l "T/EC Tasks" \-h orange -a http://www.tivoli.com

Chapter 2. Tasks 157

TEC - Comandos e referência - [PDF Document] (170)

158 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (171)

Chapter 3. Environment variables available to tasks

This chapter describes the environment variables available to Tivoli EnterpriseConsole programs and tasks that run with an event. You can specify attributevalue constraints for tasks that run with an event.

Variable descriptionsThe following table describes the environment variables available to programs,console tasks, and automated tasks that run 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 called.

X

DISPLAY UNIX variable that controls the display ofthe X server.

X

ENDPOINT Node where the task runs. X X

ENDPOINT_OID Object identifier of where the task runs. X X

© Copyright IBM Corp. 2002 159

TEC - Comandos e referência - [PDF Document] (172)

Name Description

Available to

Con

sole

Task

s

Con

sole

Pro

gram

s

Ru

leB

ase

Task

s

Ru

leB

ase

Pro

gram

s

EVENT_CLASS Event class passed to the exec_taskpredicate.

X X

INTERP Architecture type of the system where thenode is 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 an AIXsystem.

X X

NLSPATH Path to the directory used by applicationsto determine language.

X X X

PATH File search path. X X X

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_ADMIN The name of the Tivoli Enterprise Consoleadministrator defined in the Tivolienvironment.

X X

TEC_BIN_DIR Directory where the Tivoli EnterpriseConsole product is installed.

X X X

TEC_EXECTASK_DBCS Indicates whether the tec_exectask_dbcsconfiguration parameter was enabled. IfTEC_EXECTASK_DBCS is set to TRUE, itindicates that tec_exectask_dbcs is set totrue in the .tec_config file and that slotparameters were converted to the localcode set before the task was run. IfTEC_EXECTASK_DBCS is not set, thentec_exectask_dbcs is not set (or is set tofalse) in the .tec_config file and slotparameters were not converted to the localcode set before the task was run.

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

160 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (173)

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_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

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 known in the Tivolienvironment.

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 cause event.

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

Chapter 3. Environment variables available to tasks 161

TEC - Comandos e referência - [PDF Document] (174)

Name Description

Available to

Con

sole

Task

s

Con

sole

Pro

gram

s

Ru

leB

ase

Task

s

Ru

leB

ase

Pro

gram

s

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

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

162 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (175)

Name Description

Available to

Con

sole

Task

s

Con

sole

Pro

gram

s

Ru

leB

ase

Task

s

Ru

leB

ase

Pro

gram

s

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

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 issued from a Tivoli Enterprise Console rule and a console task run from theevent console. Line wrapping of variable values can occur because of spacelimitations on the page.

Environment variable dump when running a task from a ruleThe following example shows a dump of the environment variables when runninga task from a Tivoli Enterprise Console rule.CHILD_OF_OSERV=ENDPOINT=xerius (ManagedNode)ENDPOINT_OID=1450268534.1.348#TMF_ManagedNode::Managed_Node#

Chapter 3. Environment variables available to tasks 163

TEC - Comandos e referência - [PDF Document] (176)

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 running a program from theevent console

The following example shows a dump of the environment variables when runninga console task from the event console.EVENT_CLASS=TEC_ErrorINTERP=solaris2LANG=CLD_LIBRARY_PATH=/data/TMP3.6/lib/solaris2:/usr/openwin/lib:/data/ \

164 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (177)

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 3. Environment variables available to tasks 165

TEC - Comandos e referência - [PDF Document] (178)

166 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (179)

Appendix. Configuration parameters

The following are parameters that 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 are to 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 a UNIXsystem.

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_recv_timeout Specifies a timeout, in seconds, for thetec_reception process when reading eventsfrom a socket. The default is 5. If thetec_reception process hangs fortec_recv_timeout seconds when reading anevent, it ends the connection and continuesreceiving events so that other agents are notdelayed.

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 name of the file where tracinginformation is to be written. Must be set iftec_rule_trace is set to YES.

tec_rule_host Specifies the host where the rule engineruns.

© Copyright IBM Corp. 2002 167

TEC - Comandos e referência - [PDF Document] (180)

Parameter Use

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 received faster than they can beprocessed.

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 run. If set toFALSE, the parameters are passed as UTF8.

always_expect_utf8 Indicates whether all incoming events are tobe in UTF8 format.

168 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (181)

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 LicensingIBM CorporationNorth Castle DriveArmonk, 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 CorporationLicensing2-31 Roppongi 3-chome, Minato-kuTokyo 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 endorsem*nt 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.

© Copyright IBM Corp. 2002 169

TEC - Comandos e referência - [PDF Document] (182)

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 Corporation2Z4A/10111400 Burnet RoadAustin, 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.

COPYRIGHT LICENSE:

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 toIBM, 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 to

170 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (183)

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

TrademarksIBM, the IBM logo, Tivoli, the Tivoli logo, AIX, DB2, Informix, NetView, OS/2,Tivoli Enterprise, Tivoli Enterprise Console, TME, and WebSphere are trademarksor registered trademarks of International Business Machines Corporation or TivoliSystems Inc. in the United States, other countries, or both.

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

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

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

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

Notices 171

TEC - Comandos e referência - [PDF Document] (184)

172 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (185)

Index

Aabsolute object reference 2absolute path 3acl environment variable 161adapter

commands, summary of 6identifiers for multiples on the same system 19, 90, 95installing environment variables for 97installing validation information for 100showing installed validation information 53

Adapter Configuration Facilitycommands, summary of 6interface, linking to configuration tools 98

adapter configuration profileadding an adapter configuration record for 17adding an adapter type default for 92modifying an adapter configuration record for 88modifying an adapter type default for 92modifying environment variables on adapter configuration

profile endpoints 102removing adapter configuration record from 44showing adapter configuration records in 46showing environment variables for endpoints 55updating adapter configuration profile record modification

time 133adapter configuration record

adding, for an adapter configuration profile 17adding, for an adapter type default 92modifying, for an adapter configuration profile 88modifying, for an adapter type default 92removing from an adapter configuration profile 44showing, in an adapter configuration profile 46

adapter_host environment variable 161adding

adapter configuration record for an adapter configurationprofile 17

adapter configuration record for an adapter typedefault 92

event group filters 24administrator environment variable 161assigned event groups, listing 28assigning

event groups 26event groups, unassigning 30operators to a console 26

attributeresetting event source 109

BBAROC file, importing into a rule base 76books

see publications vi

Ccause_date_reception environment variable 161cause_event_handle environment variable 161Change_Severity task 136, 138

checkingavailability of the database server 123event class definition file 21validity of event class definition file 7

CHILD_OF_OSERV environment variable 159chkclass command 5, 7class environment variable 161class file, deleting 75class_name environment variable 161Clean_Database task 136, 139Clear_Closed_Events task 136, 140Clear_Reception_Log task 136, 141clearing, events from the event database 117, 119Close_Event task 136, 142command line

executable tasks 136, 137syntax ix

command summariesadapter commands 6Adapter Configuration Facility commands 6console commands 4database commands 5event message commands 4event server commands 5rule base commands 5source commands 4

commandschkclass 5, 7postemsg 4, 8postzmsg 4, 10syntax ixtec_console 4, 12TECAgent 4, 14upgrade_gui.sh 5, 16waddac 6, 17wchkclass 5, 21wconsole 4, 22wcrtdefcfg 4, 35wcrtebizgroups 4, 36wcrtmtgroups 4, 37wcrtnvgroups 4, 38wcrtsrc 4, 39wcrtteccfg 4, 40wdbconfig.sh 5, 41wdbmaint.sh 5, 42wdelac 6, 44wdelsrc 4, 45wlsac 6, 46wlsaddflt 6, 49wlsadenv 6, 51wlsadgui 6, 52wlsadval 6, 53wlsaeenv 6, 55wlsemsg 4, 56wlsesvrcfg 5, 58wlssrc 4, 59wmigcon 4, 60wpostemsg (endpoint version) 4, 62wpostemsg (managed node version) 4, 64wpostzmsg (endpoint version) 4, 66wpostzmsg (managed node version) 4, 68

© Copyright IBM Corp. 2002 173

TEC - Comandos e referência - [PDF Document] (186)

commands (continued)wrb 5, 70wrb_default_rb 5, 85wrbupgrade 5, 86wruntask 136wsendresp 4, 87wsetac 6, 88wsetaddflt 6, 92wsetadenv 6, 97wsetadgui 6, 98wsetadval 6, 100wsetaeenv 6, 102wsetemsg 4, 105wsetesvrcfg 5, 107wsetsrc 4, 109wsighup 6, 110wstartesvr 5, 111wstartmaint.sh 5, 112wstatesvr 5, 113wstopesvr 5, 114wstopmaint.sh 5, 115wstoptecgw 6, 116wtdbclear 5, 117wtdbclear.pl 5, 119wtdbspace 5, 121wtdbstat 5, 123wtdumper 5, 124wtdumprl 5, 126wtdumptr 5, 128wtecexport 4, 129wtecimport 4, 131wtouchac 6, 133

compiling, rules 72completed tasks, generating report on 128configuration parameters

listing for an event server 58setting for the event server 107

configuration toolslinking to Adapter Configuration Facility interface 98showing installed link to 52

configure (definition in task context) 136console commands, summary of 4CONSOLE_NAME environment variable 159conventions

command syntax ixtypeface viii

copyingevent console 26rule base 72

creatingevent console 27event group 27event groups for ebusiness.rls 36event groups for maintenance_mode.rls 37event groups for netview.rls 38rule base at the event server 73rule base target 73rule pack 73source on the event server 39

credibility environment variable 161customer support

see software support vii

Ddatabase

commands, summary of 5

database (continued)configuration scripts, running 41reorganizing 42server, checking availability 123statistics, updating 42

date environment variable 161date_event environment variable 162date_reception environment variable 162deleting

class file 75event console 28event group 28event group filters 28rule base from the event server 75rule base target 75rule pack 75rule set from a rule base 75rule set from a rule pack 76source from an event server list 45

directory names, notation viiiDISPLAY environment variable 159displaying

event server status 113message to the desktop of the administrator 87

Dump_Event_Repository task 136, 143duration environment variable 162

Eendpoint

modifying environment variables on 102showing environment variables for an adapter

configuration profile 55ENDPOINT environment variable 159ENDPOINT_OID environment variable 159environment variable

acl 161adapter_host 161administrator 161availability to tasks running with event 159cause_date_reception 161cause_event_handle 161CHILD_OF_OSERV 159class 161class_name 161CONSOLE_NAME 159credibility 161date 161date_event 162date_reception 162descriptions of 159DISPLAY 159duration 162ENDPOINT 159ENDPOINT_OID 159ev_key 162event attribute 161EVENT_CLASS 160event_handle 162event_hndl 162examples

program from Java console 164task from Java console 163

for an adapter configuration profile endpoint, showing 55hostname 162installing for an adapter 97INTERP 160

174 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (187)

environment variable (continued)LANG 160last_modified_time 162LD_LIBRARY_PATH 160LIBPATH 160msg 162msg_catalog 162msg_index 162NLSPATH 160num_actions 162o_dispatch 162on adapter configuration profile endpoints, modifying 102origin 162PATH 160repeat_count 162server_handle 163server_hndl 163server_path 163severity 163SHLIB_PATH 160showing adapter-specific Event Integration Facility 51SLOTS 160source 163status 163sub_origin 163sub_source 163TEC_ADMIN 160TEC_BIN_DIR 160TEC_EXECTASK_DBCS 160TEC_KB_DIR 160TEC_MASTER_PORT 160TEC_MASTER_START_TIMEOUT 160TEC_RECV_BUFSIZE 160TEC_RECV_LOG 160TEC_RULE_CACHE_CLEAN_FREQ 161TEC_RULE_CACHE_FULL_HISTORY 161TEC_RULE_CACHE_NON_CLOSED_HISTORY 161TEC_RULE_CACHE_SIZE 161TEC_RULE_TRACE 161TEC_RULE_TRACE_FILE 161TISDIR 161TZ 161WLOCALHOST 161

environment variables, notation viiiev_key environment variable 162event

clearing from event database 117, 119generating report of events received by event server 126generating report on 124in server database, listing 56message commands, summary of 4modifying event 105number of, specifying for event cache 107posting to the event server 8, 62, 64resetting event source attributes 109severity level 8, 10, 15, 63, 64, 67, 68

event attribute variable 161event cache, specifying the number of events 107event class

definition file, checking validity of 7listing 79specifications, importing into a rule base 76

event class definition file, checking validity of 21event console

assign event group 26assign operators 26assigned event groups, listing 28

event console (continued)change name 29copy 26create 27create event group 27delete 28delete event group 28event group filter, changing name of 29event group, changing name of 29event groups, listing 29filters, event group, adding 24filters, event group, deleting 28managing 22show defined 28starting 12unassign event groups 30unassign operators 30

event databaseclearing events from 117, 119

event group filtersadding 24changing names of 29deleting 28

event groupsadding for ebusiness.rls 36adding for maintenance_mode.rls 37adding for netview.rls 38assigned, listing 28changing names of 29listing 29

event message commands, summary of 4event server 56

commands, summary of 5displaying status of 113generating report of events received by 126generating report on tasks completed by 128list, deleting a source from 45listing configuration parameters for 58listing sources on 59posting an event to 8, 62, 64setting configuration parameters for 107starting 111stopping 114

Event Viewer 150EVENT_CLASS environment variable 160event_handle environment variable 162event_hndl environment variable 162Event_Query task 136, 144

Ffilters, event group

adding 24changing names of 29deleting 28

Find_Similar_Events task 136, 147Forward_Event task 137, 149

Ggateway, stopping 116generating

event report 124report on completed tasks 128

Index 175

TEC - Comandos e referência - [PDF Document] (188)

Hhostname environment variable 162

Iidentifiers for multiple adapters on the same system 19, 90,

95importing

BAROC file into a rule base 76event class specifications into a rule base 76rule pack into a rule base target 78rule set into a rule base 77rule set into a rule base target 78rule set into a rule pack 77

installed link, to extended configuration tools, showing 52installing

environment variables for an adapter 97link from the Adapter Configuration Facility interface to

configuration tools 98validation information for an adapter type 100

internationalizationmessages and postzmsg 8, 10

INTERP environment variable 160

LLANG environment variable 160language support packs and postzmsg 8, 10last_modified_time environment variable 162LD_LIBRARY_PATH environment variable 160LIBPATH environment variable 160link, to extended configuration tools, showing 52linking, Adapter Configuration Facility interface to a

configuration tool 98listing

assigned event groups 28configuration parameters for an event server 58event classes 79event consoles, defined 28event groups 29events in database 56received events 56rule base targets 80rule base, loaded 79rule bases, defined on the event server 79rule packs 79rule sets 80sources on the event server 59

loading, rule base onto the event server 78Log_Event_To_File task 137, 150

Mmanuals

see publications vimessage, displaying to the desktop of the administrator 87modification time, updating in an adapter configuration

profile record 133modifying

adapter configuration record for an adapter configurationprofile 88

adapter configuration record for an adapter typedefault 92

environment variables on adapter configuration profileendpoints 102

modifying (continued)event 105

msg environment variable 162msg_catalog environment variable 162msg_index environment variable 162

Nname registry, described 2names, registered 2newsgroups viiNLSPATH environment variable 160notation

environment variables viiipath names viiitypeface viii

num_actions environment variable 162

Oo_dispatch environment variable 162object

paths 2, 3reference 2referenced from command 2

online publications, accessing vioperators

assigning to a console 26unassigning from a console 30

ordering publications viorigin environment variable 162

Pparent directory path component 3path component

absolute 3current directory 3parent directory 3relative 3

PATH environment variable 160path names, notation viiipaths, object 2, 3Popup_Message task 137, 151postemsg command 4, 8posting, event to the event server 8, 62, 64postzmsg command 4, 10publications

accessing online viordering vi

Rreception log, specifying time to retain events 107registered name, described 2relative path 3removing

adapter configuration record from an adapter configurationprofile 44

repeat_count environment variable 162reports

completed tasks 128events received by event server 126

resettingevent source attributes 109

176 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (189)

rulecompiling 26, 27, 28, 29, 30, 72

rule basecommands, summary of 5consistent state conditions 70copying 72creating, at the event server 73deleting, from the event server 75importing into 70listing defined 79listing loaded 79loading onto the event server 78managing 70setting properties 80upgrading pre-3.7 versions 86

rule base targetcreating 73deleting 75listing 80

rule builder rules, upgrading 16rule pack

creating 73deleting 75importing into a rule base target 78listing 79

rule setdeleting from a rule base 75deleting from a rule pack 76importing into a rule base 77importing into a rule base target 78importing into a rule pack 77listing 80

rule_builder.pro file 16

SSend_Email task 137, 152Send_Event task 137, 153server_handle environment variable 163server_hndl environment variable 163server_path environment variable 163setting

configuration parameters for the event server 107rule base properties 80time to retain in reception log 107

severity environment variable 163severity level, events 8, 10, 15, 63, 64, 67, 68SHLIB_PATH environment variable 160showing

adapter configuration records in an adapter configurationprofile 46

adapter-specific Event Integration Facility environmentvariables 51

adapter-type installed validation information 53See also listing 46

SLOTS environment variable 160software support, contacting viisource

commands, summary of 4creating, on the event server 39deleting from an event server list 45on event server, listing 59

source environment variable 163Start_Maintenance task 137, 155starting event console 12starting, event server 111status environment variable 163

stoppingevent server 114gateway 116

string, size limit ixsub_origin environment variable 163sub_source environment variable 163syntax for commands ix

TT/EC Tasks dialog 136task

Change_Severity 136, 138Clean_Database 136, 139Clear_Closed_Events 136, 140Clear_Reception_Log 136, 141Close_Event 136, 142descriptive names 136, 137Dump_Event_Repository 136, 143Event_Query 136, 144Find_Similar_Events 136, 147Forward_Event 137, 149Log_Event_To_File 137, 150output 137overview 135Popup_Message 137, 151script file names 136, 137Send_Email 137, 152Send_Event 137, 153Start_Maintenance 137, 155Wake_Up_Netscape 137, 157

Task Output dialog 137TEC_ADMIN environment variable 160TEC_BIN_DIR environment variable 160tec_console command 4, 12TEC_EXECTASK_DBCS environment variable 160TEC_KB_DIR environment variable 160TEC_MASTER_PORT environment variable 160TEC_MASTER_START_TIMEOUT environment variable 160TEC_RECV_BUFSIZE environment variable 160TEC_RECV_LOG environment variable 160TEC_RULE_CACHE_CLEAN_FREQ environment

variable 161TEC_RULE_CACHE_FULL_HISTORY environment

variable 161TEC_RULE_CACHE_NON_CLOSED_HISTORY environment

variable 161TEC_RULE_CACHE_SIZE environment variable 161TEC_RULE_TRACE environment variable 161TEC_RULE_TRACE_FILE environment variable 161TECAgent command 4, 14TISDIR environment variable 161Tivoli environment, setting up 1Tivoli Software Information Center vitypeface conventions viiiTZ environment variable 161

Uunassigning

event groups 30operators from a console 30

updating, adapter configuration profile record modificationtime 133

upgrade_gui.sh command 5, 16

Index 177

TEC - Comandos e referência - [PDF Document] (190)

upgradingpre-3.7 rule bases 86rule builder rules 16

Vvalidation information

adapter type, showing 53installing for an adapter type 100

variables, notation for viii

Wwaddac command 6, 17Wake_Up_Netscape task 137, 157wchkclass command 5, 21wconsole command 4, 22wcrtdefcfg command 4, 35wcrtebizgroups command 4, 36wcrtmtgroups command 4, 37wcrtnvgroups command 4, 38wcrtsrc command 4, 39wcrtteccfg command 4, 40wdbconfig.sh command 5, 41wdbmaint.sh command 5, 42wdelac command 6, 44wdelsrc command 4, 45WLOCALHOST environment variable 161wlsac command 6, 46wlsaddflt command 6, 49wlsadenv command 6, 51wlsadgui command 6, 52wlsadval command 6, 53wlsaeenv command 6, 55wlsemsg command 4, 56wlsesvrcfg command 5, 58wlssrc command 4, 59wmigcon command 4, 60wpostemsg command (endpoint version) 4, 62wpostemsg command (managed node version) 4, 64wpostzmsg command (endpoint version) 4, 66wpostzmsg command (managed node version) 4, 68wrb command 5, 70wrb_default_rb command 5, 85wrbupgrade command 5, 86wruntask command 136wsendresp command 4, 87wsetac command 6, 88wsetaddflt command 6, 92wsetadenv command 6, 97wsetadgui command 6, 98wsetadval command 6, 100wsetaeenv command 6, 102wsetemsg command 4, 105wsetesvrcfg command 5, 107wsetsrc command 4, 109wsighup command 6, 110wstartesvr command 5, 111wstartmaint.sh command 5, 112wstatesvr command 5, 113wstopesvr command 5, 114wstopmaint.sh command 5, 115wstoptecgw command 6, 116wtdbclear command 5, 117wtdbclear.pl command 5, 119wtdbspace command 5, 121

wtdbstat command 5, 123wtdumper command 5, 124wtdumprl command 5, 126wtdumptr command 5, 128wtecexport command 4, 129wtecimport command 4, 131wtouchac command 6, 133

178 IBM Tivoli Enterprise Console: Command and Task Reference

TEC - Comandos e referência - [PDF Document] (191)

TEC - Comandos e referência - [PDF Document] (192)

����

Printed in U.S.A.

SC32-1232-00

TEC - Comandos e referência - [PDF Document] (2024)
Top Articles
Latest Posts
Article information

Author: Carmelo Roob

Last Updated:

Views: 5315

Rating: 4.4 / 5 (45 voted)

Reviews: 92% of readers found this page helpful

Author information

Name: Carmelo Roob

Birthday: 1995-01-09

Address: Apt. 915 481 Sipes Cliff, New Gonzalobury, CO 80176

Phone: +6773780339780

Job: Sales Executive

Hobby: Gaming, Jogging, Rugby, Video gaming, Handball, Ice skating, Web surfing

Introduction: My name is Carmelo Roob, I am a modern, handsome, delightful, comfortable, attractive, vast, good person who loves writing and wants to share my knowledge and understanding with you.