ibm tivoli enterprise consolepublib.boulder.ibm.com/tividd/td/tec/sc32-1232-00/en_us/... · 2003....

IBM Tivoli Enterprise Console

Command and Task ReferenceVersion 3.9

SC32-1232-00

��

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.

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

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

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

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

http://www.ibm.com/software/tivoli/library/http://www.ibm.com/software/tivoli/library/http://www.elink.ibmlink.ibm.com/public/applications/publications/cgibin/pbi.cgihttp://www.elink.ibmlink.ibm.com/public/applications/publications/cgibin/pbi.cgi

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

http://www.ibm.com/software/tivoli/order-lit/http://www.ibm.com/software/sysmgmt/products/support/http://techsupport.services.ibm.com/guides/handbook.html

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 textItalic

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

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

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

x IBM Tivoli Enterprise Console: Command and Task Reference

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

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

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

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.


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.


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.


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


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.


–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


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


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.


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


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


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


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 &


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


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.


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


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


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


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.


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.


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


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


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


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.


–assignop Assigns operators to anevent console definition.


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


–crtconsole Creates a new event consoledefinition.


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

–crtoperator Creates a new consoleoperator.


–delconsole Deletes an event consoledefinition.


–deleg Deletes one or more eventgroups.


–delegflt Deletes one or more filtersfrom an event group.


–deloperator Deletes an existing consoleoperator.


–lsassigneg Lists event groups assignedto an event consoledefinition.

RIM_view, RIM_update, user


Option Description Region Roles

–lsconsole Lists event consoledefinitions.


–lsconsoleup Lists currently runningconsoles.


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


–seteg Changes the name anddescription of an eventgroup.


–setegflt Changes the name anddescription of an eventgroup filter.


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


–unassignop Unassigns operators from anevent console definition.


Notesv When issuing the wconsole command from a bash shell on 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.


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]


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.


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


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


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


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


–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’))"


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.


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:


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:


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


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


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.


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


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.


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 g