TEC - Comandos e Referência

IBM Tivoli Enterprise Console
Command and Task Reference

V ersion 3.9
SC32-1232-00
IBM Tivoli Enterprise Console
Command and Task Reference

V ersion 3.9
SC32-1232-00
Note Before 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 all subsequent 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 Contract with IBM Corp.
Contents
About this book . . . . . . . . . . . v
Who should read this book . . . . . . . . . v Publications . . . . . . . . . . . . . . v IBM Tivoli Enterprise Console library . . . . . v Related publications . . . . . . . . . . vi Accessing publications online . . . . . . . vi Ordering publications . . . . . . . . . . vi Contacting software support . . . . . . . . vii Participating in newsgroups . . . . . . . . . vii Conventions used in this guide . . . . . . . viii Typeface conventions . . . . . . . . . . viii Operating system-dependent variables and paths . . . . . . . . . . . . . . . viii Command line syntax . . . . . . . . . . ix wlsemsg . . . . . . . . . . wlsesvrcfg . . . . . . . . . . wlssrc . . . . . . . . . . . wmigcon . . . . . . . . . . wpostemsg (endpoint version) . . . wpostemsg (managed node version) . wpostzmsg (endpoint version) . . . wpostzmsg (managed node version) . wrb . . . . . . . . . . . . wrb_default_rb . . . . . . . . wrbupgrade . . . . . . . . . wsendresp . . . . . . . . . . wsetac . . . . . . . . . . . wsetaddflt . . . . . . . . . . wsetadenv . . . . . . . . . . wsetadgui . . . . . . . . . . wsetadval . . . . . . . . . wsetaeenv . . . . . . . . . wsetemsg. . . . . . . . . . wsetesvrcfg . . . . . . . . . wsetsrc . . . . . . . . . . wsighup . . . . . . . . . . wstartesvr . . . . . . . . . wstartmaint.sh . . . . . . . . wstatesvr . . . . . . . . . . wstopesvr . . . . . . . . . wstopmaint.sh . . . . . . . . wstoptecgw . . . . . . . . . wtdbclear. . . . . . . . . . wtdbclear.pl . . . . . . . . . wtdbspace . . . . . . . . . wtdbstat . . . . . . . . . . wtdumper . . . . . . . . . wtdumprl . . . . . . . . . wtdumptr . . . . . . . . . wtecexport . . . . . . . . . wtecimport . . . . . . . . . wtouchac . . . . . . . . . . . 56 . 58 . 59 . 60 . 62 . 64 . 66 . 68 . 70 . 85 . 86 . 87 . 88 . 92 . 97 . 98 . . . . . 100 . . . . . 102 . . . . . 105 . . . . . 107 . . . . . 109 . . . . . 110 . . . . . 111 . . . . . 112 . . . . . 113 . . . . . 114 . . . . . 115 . . . . . 116 . . . . . 117 . . . . . 119 . . . . . 121 . . . . . 123 . . . . . 124 . . . . . 126 . . . . . 128 . . . . . 129 . . . . . 131 . . . . . 133 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 1. Commands
. . . . . . . . 1
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 . 1 . 2 . 2 . 3 . 3 . 4 . 4 . 4 . 5 . 5 . 5 . 6 . 6 . 7 . 8 . 10 . 12 . 14 . 16 . 17 . 21 . 22 . 35 . 36 . 37 . 38 . 39 . 40 . 41 . 42 . 44 . 45 . 46 . 49 . 51 . 52 . 53 . 55
Establishing the Tivoli environment. . . . Using Tivoli commands. . . . . . . . Object references . . . . . . . . . . Registered names . . . . . . . . . Object paths . . . . . . . . . . Tivoli Enterprise Console commands . . . Console commands . . . . . . . . Source commands . . . . . . . . Event message commands . . . . . . Event server commands . . . . . . Rule base commands . . . . . . . Database commands . . . . . . . . Adapter Configuration Facility commands Adapter commands . . . . . . . . chkclass . . . . . . . . . . . . . postemsg . . . . . . . . . . . . postzmsg . . . . . . . . . . . . tec_console . . . . . . . . . . . TECAgent . . . . . . . . . . . . upgrade_gui.sh . . . . . . . . . . waddac. . . . . . . . . . . . . wchkclass . . . . . . . . . . . . wconsole . . . . . . . . . . . . wcrtdefcfg . . . . . . . . . . . . wcrtebizgroups . . . . . . . . . . wcrtmtgroups . . . . . . . . . . wcrtnvgroups . . . . . . . . . . wcrtsrc . . . . . . . . . . . . . wcrtteccfg . . . . . . . . . . . . wdbconfig.sh . . . . . . . . . . . wdbmaint.sh . . . . . . . . . . . wdelac . . . . . . . . . . . . . wdelsrc . . . . . . . . . . . . . wlsac . . . . . . . . . . . . . wlsaddflt . . . . . . . . . . . . wlsadenv . . . . . . . . . . . . wlsadgui . . . . . . . . . . . . wlsadval . . . . . . . . . . . . wlsaeenv . . . . . . . . . . . .
Copyright IBM Corp. 2002
Chapter 2. Tasks . . . . . . . . . . 135

Task names and scripts . Task output . . . . . Change_Severity . . . Clean_Database . . . Clear_Closed_Events . . Clear_Reception_Log . . Close_Event . . . . . Dump_Event_Repository Event_Query . . . . Find_Similar_Events . . Forward_Event . . . . Log_Event_To_File . . Popup_Message . . . Send_Email . . . . . Send_Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136 137 138 139 140 141 142 143 144 147 149 150 151 152 153
iii
Start_Maintenance . . Wake_Up_Netscape .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. 155 . 157
Appendix. Configuration parameters
167
Chapter 3. Environment variables available to tasks. . . . . . . . . . 159

Variable descriptions . . . . . . Examples . . . . . . . . . . Environment variable dump when task from a rule . . . . . . Environment variable dump when program from the event console . . . . . . . running . . . running . . . . . a . a . . 164 . 163 . 159 . 163
Notices . . . . . . . . . . . . . . 169
Trademarks . . . . . . . . . . . . . . 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 management application that integrates system, network, database, and application management to help ensure the optimal availability of an organizations IT services. The IBM Tivoli Enterprise Console Command and Task Reference describes Tivoli Enterprise Console commands, tasks provided in the task library shipped with the Tivoli Enterprise Console product, and environment variables available to tasks in the task library.
Who should read this book

This book is for Tivoli Enterprise Console administrators who want to use the command line interface and configure Tivoli Enterprise Console tasks. You should have prior knowledge of the following software: v The operating systems that your enterprise uses v Tivoli Management Framework
Publications
This section lists publications in the Tivoli Enterprise Console library and related documents. It also describes how to access Tivoli publications online and how to order Tivoli publications.
IBM Tivoli Enterprise Console library

The 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 and configure these adapters. v IBM Tivoli Enterprise Console Command and Task Reference, SC32-1232 Provides details about Tivoli Enterprise Console commands, predefined tasks that are shipped in the task library, and the environment variables that are available to tasks that run against an event. v IBM Tivoli Enterprise Console Installation Guide, SC32-1233 Describes how to install, upgrade, and uninstall the Tivoli Enterprise Console product. v IBM Tivoli Enterprise Console Release Notes, SC32-1238 Provides release-specific information that is not available until just before the product is sent to market. v IBM Tivoli Enterprise Console Rule Developers Guide, SC32-1234 Describes how to develop rules and integrate them for event correlation and automated event management. v IBM Tivoli Enterprise Console Rule Set Reference, SC32-1282 Provides reference information about the Tivoli Enterprise Console rule sets. v IBM Tivoli Enterprise Console Users Guide, SC32-1235
Provides an overview of the Tivoli Enterprise Console product and describes how to configure and use the Tivoli Enterprise Console product to manage events. v IBM Tivoli Enterprise Console Warehouse Enablement Pack: Implementation Guide, SC32-1236 Describes how to install and configure the warehouse enablement pack for the Tivoli Enterprise Console product and describes the data flow and structures that are used by the warehouse pack. v Tivoli Event Integration Facility Reference, SC32-1241 Describes how to develop your own event adapters that are tailored to your network environment and the specific needs of your enterprise. This reference also describes how to filter events at the source.
Related publications
The Tivoli Software Glossary includes definitions for many of the technical terms related 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 Tivoli software library window.
Accessing publications online

The 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 on the CD for instructions on how to access the documentation. IBM posts publications for this and all other Tivoli products, as they become available and whenever they are updated, to the Tivoli Software Information Center Web site. Access the Tivoli Software Information Center by first going to the Tivoli 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 Product Documents Alphabetical Listing window, click the IBM Tivoli Enterprise Console link 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 to page check box in the Adobe Acrobat Print window. This option is available when you click File Print. Fit to page ensures that the full dimensions of a letter-sized page print on the paper that you are using.
Ordering publications
You 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-2755 v In Canada: 800-426-4968
vi
In other countries, see the following Web site for a list of telephone numbers: http://www.ibm.com/software/tivoli/order-lit/
Contacting software support

If you have a problem with any Tivoli product, refer to the following IBM Software Support Web site: http://www.ibm.com/software/sysmgmt/products/support/ If you want to contact software support, see the IBM Software Support Guide at the following 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 eligibility v Telephone numbers and e-mail addresses, depending on the country in which you are located v Information you must have before contacting IBM Software Support
Participating in newsgroups
User groups provide software professionals with a forum for communicating ideas, technical expertise, and experiences related to the product. They are located on the Internet and are available using standard news reader programs. These groups are primarily intended for user-to-user communication and are not a replacement for formal 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. 3. 4. 5. 6. 7. From the Tools menu, click Internet Options. On the Internet Options window, click the Programs tab. In the Newsgroups list, click the Down Arrow and then click Outlook Express. Click OK. Close your Internet Explorer browser and then open it again. 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
7. Cut and paste the newsgroup address of a product into the browser Address field, 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 guide

This guide uses several conventions for special terms and actions, operating system-dependent commands and paths, and command syntax.
Typeface conventions
This guide uses the following typeface conventions: Bold v Lowercase commands and mixed case commands that are otherwise difficult to distinguish from surrounding text v Interface controls (check boxes, push buttons, radio buttons, spin buttons, fields, folders, icons, list boxes, items inside list boxes, multicolumn lists, containers, menu choices, menu names, tabs, property sheets), labels (such as Tip:, and Operating system considerations:) v Keywords and parameters in text Italic v v v v Words defined in text Emphasis of words (words as words) New terms in text (except in a definition list) Variables and values you must provide
Monospace v Examples and code examples v File names, programming keywords, and other elements that are difficult to distinguish from surrounding text v Message text and prompts addressed to the user v Text that the user must type v Values for arguments or command options
Operating system-dependent variables and paths

This guide uses the UNIX convention for specifying environment variables and for directory notation. When using the Windows command line, replace $variable with %variable% for environment variables and replace each forward slash (/) with a backslash (\) in directory paths. Note: If you are using the bash shell on a Windows system, you can use the UNIX conventions.
viii
Command line syntax

This document uses the following special characters to define the command syntax: [] ... | Identifies an optional argument. Arguments not enclosed in brackets are required. Indicates that you can specify multiple values for the previous argument. Indicates mutually exclusive information. You can use the argument to the left of the separator or the argument to the right of the separator. You cannot use both arguments in a single use of the command. Delimits a set of mutually exclusive arguments when one of the arguments is 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. The brackets 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 and optional. The profile argument is required. The key argument is optional. Also, the ellipsis marks (...) following the key argument indicate that you can specify multiple 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, but one of the arguments must be specified. Also, the ellipsis marks (...) indicate that you can specify multiple rule packs or rule sets.
About this book
ix
Chapter 1. Commands
This chapter describes how to establish a Tivoli environment for using Tivoli commands and provides details about each Tivoli Enterprise Console command.
Establishing the Tivoli environment

When the Tivoli Management Framework was installed, two setup files were created that you can use to easily establish the correct search paths and environment variables. These files are available on any client or the server in the Tivoli management region. Use the following steps to set up the UNIX system environment to run Tivoli Enterprise 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 the Tivoli management region. See the Tivoli Management Framework Users Guide for details about creating Tivoli Enterprise administrators with authorization roles for the region. 2. Two environment initialization and setup scripts are available: one for the Bourne shell and one for the C shell. If you are using the Bourne shell, run the following 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 the Windows 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 and must 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 commands

Use Tivoli commands to perform system operations from a command line instead of using the Tivoli desktop. It is often convenient or more appropriate to call a Tivoli management application operation from the command line than from the desktop; 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.
Most Tivoli end-user commands begin with a w to identify them as Tivoli commands. Tivoli end-user commands that do not use Tivoli services do not begin with a w. Most commands are also developed with a w+verb+object syntax, which matches the way you would think of the action. For example, to create a user, use the wcrtusr command. To delete a user, use the wdelusr command.
Object references
When 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 is used. This user-friendly name derives from a name given to the object by the user of the application (for example, when a policy region is created). Two different forms of names can be used with command line commands, as follows: v Registered names v Object paths Tivoli command-line programs support both naming schemes. Sometimes you can find it more convenient to use one form over the other.
Registered names
Each Tivoli region contains a name registry. The name registry is a two-dimensional table that contains the names and types of objects. Registered names are names of objects that can be looked up in the name registry by instance 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 in the name registry when created, unregistered when deleted, and moved when their label is changed. For most resources in the Tivoli Enterprise Console product, these actions are handled automatically. See the IBM Tivoli Management Framework Planning for Deployment Guide for a complete listing of resource types and exchange information. Using the name registry facilitates the exchange of resources between multiple Tivoli regions. See the IBM Tivoli Management Framework Planning for Deployment Guide 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 the registered resource types, use the following command:
% wlookup R
See the IBM Tivoli Management Framework Reference Manual for a detailed description and syntax of the wlookup command. Other commands that use registered names are wls and wmv. For example, to list the objects on the desktop of administrator Jerry, enter the following command:
wls @Administrator:jerry
where Administrator is the resource and jerry is the instance.
Object paths
Object paths are similar to path names in file systems and can be relative or absolute. An absolute path is one that starts with a slash (/) character. A relative path can start with any character other than a slash (/), including the special path components for current directory (.) and parent directory (..). Some examples of object 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: distinguished Is a resource type. parent type name Is the start of the object path name. Is an optional explicit label. 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 that has the same name as some other resource of a different type. For example, suppose policy region Engineering has a profile manager named Servers and a policy subregion named Servers. To specify the profile manager using an object path name, you could use the following command:
wls /Regions/Engineering/ProfileManager:Servers
Tivoli Enterprise Console commands

The following sections briefly describe the Tivoli Enterprise Console commands by component.
Chapter 1. Commands
Console commands
Command tec_console wconsole wcrtdefcfg wcrtebizgroups wcrtmtgroups wcrtnvgroups wcrtteccfg wlsemsg wmigcon wsendresp wsetemsg wtecexport wtecimport Purpose Starts an event console. Manages event consoles. Creates a default configuration in the event console. Creates the e-business groups in the event console. Creates an event group for viewing hosts that are in maintenance mode in the event console. Creates the event groups required to use the netview.rls rule set. Creates a default configuration for the Tivoli Enterprise Console product. Lists received events for a console. This command requires Tivoli Management Framework services. Migrates Tivoli Enterprise Console Version 3.6 consoles, event groups, event group filters, and operators to Version 3.7.x, Version 3.8, and Version 3.9. Displays a directed response to an administrator. Modifies an event. This command requires Tivoli Management Framework services. Exports event console definitions to a file. Imports event console definitions from a file into a different Tivoli region.
Source commands
Command wcrtsrc wdelsrc wlssrc wsetsrc Purpose Creates a source on the event server. Deletes a source from the event server list. Lists existing sources at the event server. Resets event source attributes.
Event message commands

Command postemsg postzmsg TECAgent wpostemsg (endpoint version) wpostemsg (managed node version) wpostzmsg (endpoint version) Purpose Posts an event to the event server. This command does not require Tivoli Management Framework services. Posts an event to the event server using non-Tivoli communication. Posts an event to the event server using Tivoli or non-Tivoli communication. Posts an event to the event server. This command requires Tivoli Management Framework services. Posts an event to the event server. This command requires Tivoli Management Framework services. Posts an event to the event server using Tivoli endpoint communication to a Tivoli Enterprise Console gateway or non-Tivoli communication directly to the event server. Posts an event to the event server using Tivoli managed node communication or non-Tivoli communication.
wpostzmsg (managed node version)
Event server commands

Command wlsesvrcfg wsetesvrcfg wstartesvr wstartmaint.sh wstatesvr wstopesvr wstopmaint.sh Purpose Lists the configuration parameters of a running event server. Sets the configuration parameters for the event server. Starts the event server. Informs the event server that a host has been placed in maintenance mode. Displays the status of the event server. Stops the event server. Informs the event server that an ongoing or scheduled maintenance mode for a network resource is being canceled.
Rule base commands

Command chkclass Purpose Checks an event class definition file for validity against a rule base directory. This command is for developing classes in an environment using non-Tivoli communication.. Upgrades rules that were generated by the version 3.6.2 and earlier rule builder to the syntax supported by the rule compiler provided in this version of the Tivoli Enterprise Console product. Checks an event class definition file for validity against a rule base directory. This command is for developing classes in a Tivoli Enterprise Console environment. Manages rule bases. Deactivates active rule sets in the default rule base. Upgrades rule bases and event BAROC files created with Tivoli Enterprise Console versions prior to 3.7 to the format for version 3.7 and later.
upgrade_gui.sh
wchkclass
wrb wrb_default_rb wrbupgrade
Database commands
Command wdbconfig.sh wdbmaint.sh wtdbclear wtdbclear.pl wtdbspace wtdbstat wtdumper wtdumprl wtdumptr Purpose Runs the generated database configuration scrips. Updates database data distribution statistics and reorganizes the database. Clears events from the event database. Clears events from the event database. Provides statistics for the database. Displays the status of the database server. Generates a event report of processed events from the event repository. Generates a report of received events from the reception log. Generates a report of completed tasks.
Chapter 1. Commands
Adapter Configuration Facility commands

Command waddac wdelac wlsac wlsaddflt wlsadenv wlsadgui wlsadval wlsaeenv wsetac wsetaddflt wsetadenv wsetadgui wsetadval wsetaeenv wstoptecgw wtouchac Purpose Adds an adapter configuration record for an adapter configuration profile. Removes an adapter configuration record from an adapter configuration profile. Shows adapter configuration records from an adapter configuration profile. Shows adapter configuration records from an adapter configuration profile. Shows an installed list of adapter-specific Event Integration Facility environment variables. Shows an installed link to adapter-specific extended configuration tools. Shows installed validation information for an adapter type. Shows the environment variables available at an adapter configuration profile endpoint. Modifies an existing adapter configuration record in an adapter configuration profile. Adds or sets an adapter configuration record for an adapter type default. Installs a list of recognized Event Integration Facility environment variables for an adapter type. Installs a link from the Adapter Configuration Facility GUI to a type-specific configuration tool. Installs validation information for an adapter type. Modifies environment variables stored on adapter configuration profile endpoints. Stops the Tivoli Enterprise Console gateway. Updates the modification time on an adapter configuration profile record to force redistribution.
Adapter commands
Command wsighup Purpose Reloads the configuration and format files for the Windows event log adapter and Windows NT event log adapter.
chkclass
Checks an event class definition file for validity against a rule base directory.
Syntax
chkclass [k rule_base_dir] class_file
Description
The chkclass command ensures that an event class definition file is valid for the rule base directory specified by the rule_base_dir argument. The rule_base_dir argument used with the k option is optional only if you have not set the environment variable $TEC_KB_DIR (it is not set automatically). This command is provided for developing classes on a system that does not have the Tivoli Management Framework installed. Note: If the Tivoli Management Framework is installed on your system, use the wchkclass command.
Authorization
None
Options
class_file Specifies the path of the event class definition file to be checked. The path argument must specify an absolute path name. k rule_base_dir Specifies the rule base directory. The default value is the directory defined by environment variable $TEC_KB_DIR.
Examples
The following example checks the /install/bin/hpux/TME/TEC /classfile1 event class definition file against the rule base directory specified by environment variable $TEC_KB_DIR:
chkclass /install/bin/hpux/TME/TEC/classfile1
See Also
wchkclass
Chapter 1. Commands
postemsg
Posts an event to the event server using non-Tivoli communication.
Syntax
postemsg S server | f configuration_file [m message] [r severity] [attribute=value...] class source
Description
The postemsg command sends an event to an event server. This command does not require the use of Tivoli Management Framework services and works in environments where Tivoli software is not installed. Notes: 1. Although this command is still supported, the postzmsg command is preferred for sending events using non-Tivoli communication. 2. If the Tivoli Management Framework is installed on your system, you can use the wpostzmsg (managed node version) or wpostzmsg (endpoint version) command. 3. Because cache files cannot be shared by applications, you should not use a configuration 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 the language support packs, postemsg displays error messages in English only.
Authorization
None
Options
attribute=value Assigns a value to any valid attribute. The attribute should be one defined for the event class. Separate multiple attribute=value expressions with spaces. class Specifies the class of the event. It must match a class that is configured at the server. Classes are defined by the adapter and listed in the adapter BAROC file. If any blank spaces are in the class name, enclose the class name in double quotation marks. Specifies the source of the event. If any blank spaces are in the source name, enclose the source name in double quotation marks.
source
f configuration_file Specifies the name of the adapter configuration file. You must specify either the S argument or the f argument. See the IBM Tivoli Enterprise Console Event Integration Facility Reference for more information about configuration files. m message Specifies the text of the event, enclosed in double quotation marks. r severity Specifies a severity. The severity must be one defined for the event class.
S server Specifies the host name or the IP address of the server. Use this option only if portmapper is running on the event server. You must specify either the S argument or the f argument.
Examples
The following example for UNIX environments sends a test message that displays an Su_Failure event on the event consoles:
postemsg -S tecbox -r WARNING -m "su login failure." Su_Failure LOGFILE
See Also
postzmsg, TECAgent, wpostemsg (endpoint version), wpostemsg (managed node version), wpostzmsg (endpoint version), wpostzmsg (managed node version), wsetemsg
Chapter 1. Commands
postzmsg
Posts an event to the event server using non-Tivoli communication.
Syntax
postzmsg S server | f configuration_file [m message] [r severity] [attribute=value...] class source
Description
The postzmsg command sends an event to an event server. This command does not require the use of Tivoli Management Framework services and works in environments where Tivoli software is not installed. Because this command does not have access to the message catalogs for the language support packs, postzmsg displays error messages in English only. Notes: 1. If the Tivoli Management Framework is installed on your system, you can use the wpostzmsg (endpoint version) or wpostzmsg (managed node version) command. 2. Because cache files cannot be shared by applications, you should not use a configuration file for this command that is being used by another program (such as an adapter).
Authorization
None
Options
source
f configuration_file Specifies the name of the configuration file. You must specify either the S argument or the f argument. See the IBM Tivoli Enterprise Console Event Integration Facility Reference for more information about configuration files. m message The text of the event, enclosed in double quotation marks. r severity Specifies a severity. The severity must be one defined for the event class. S server Specifies the host name or the IP address of the server. Use this option only if portmapper is running on the event server. You must specify either the S argument or the f argument.
10
Examples
The following example for UNIX environments sends a test message that displays an Su_Failure event on the event consoles:
postzmsg -S tecbox r WARNING m "su login failure." Su_Failure LOGFILE
See Also
postemsg, TECAgent, wpostemsg (endpoint version), wpostemsg (managed node version), wpostzmsg (endpoint version), wpostzmsg (managed node version), wsetemsg
Chapter 1. Commands
11
tec_console
Starts the Tivoli Enterprise Console event console.
Syntax
tec_console [u userid] [p password] [h hostname[:port]] [e event_group] [nowindow] [&]
Description
The 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 other host, 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 prompt to return. When running this command on a managed node, the Tivoli environment 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 get events from the event repository and to bundle database update requests and pass them to the Tivoli Enterprise Console dispatch process. A .tmeconsole directory that saves the global values for console of the user is created in the home directory of the user. You must have the remote client login allowed Tivoli Management Framework option set to TRUE for this command to work. You can view the current setting with the odadmin odinfo command. To set this option, use the following command:
odadmin set_allow_rconnect TRUE
The change takes effect immediately.
Authorization
For operators: user, RIM_view, RIM_update For administrators: user, RIM_view, RIM_update, senior Tivoli Enterprise Console administrators and operators require Tivoli management region roles as shown in the following table. Also shown are the Tivoli Enterprise Console views available to the two types of users. See the Tivoli Enterprise Console Users Guide for additional information about the roles required for Tivoli Enterprise Console users.
Console User Administrator Operator Tivoli Management Region Roles RIM_view, RIM_update, senior Console Views Configuration, Summary and Priority Views, and Event Viewer
RIM_view, RIM_update, user Summary and Priority Views and Event Viewer
12
Options
& Run the command in the background so the command prompt is available for use.
e event_group Shows the specified event group in the Event Viewer when the console starts. Note: For this option, you must designate a multiword event group name differently depending on whether you are using a UNIX operating system or a Windows operating system. In all operating systems, the event group name is case-sensitive. For UNIX operating systems, surround the event group name with double quotation marks:
tec_console -e "All Events"
For Windows operating systems, do not surround the event group name 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 must be authenticated by the Tivoli Management Framework. Specify this option as hostname:port if a port other than port 94 is being used. nowindow Suppresses the DOS window (for Windows systems only). p password The password for your Tivoli administrator login ID. u userid Your Tivoli administrator login ID.
Examples
The following example starts an event console on a UNIX host in the background. The user is prompted for host name, login ID, and password.
tec_console &
The following example starts an event console on a Windows host in the background and shows the NT event group in the Event Viewer. The user is prompted for host name, login ID, and password.
tec_console.cmd -e NT &
Chapter 1. Commands
13
TECAgent
Posts an event to the event server using Tivoli or non-Tivoli communication.
Syntax
java com.tivoli.tec.event_delivery.TECAgent SENDER f configuration_file [m message] [r severity] [attribute=value...] class source
Description
The TECAgent command sends an event to an event server. This command can function using endpoint transport, managed node transport, or non-Tivoli communication, depending on the configuration. Note: Because cache files cannot be shared by applications, you should not use a configuration 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 to do 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, either setup_env.sh or lcf_env.sh v Add the Java executable file to your path. A Java executable file shipped with the 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
Authorization
user
Options
attribute=value... Assigns a value to any valid attribute. The attribute should be one defined for the event class. Separate multiple attribute=value expressions with spaces. class Specifies the class of the event. It must match a class that is configured at the server. Classes are defined by the adapter and are listed in the adapter BAROC file. If any blank spaces are in the class name, enclose the class name in double quotation marks. Specifies the source of the event. If any blank spaces are in the source name, enclose the source name in double quotation marks.
source
f configuration_file Specifies the name of the configuration file. See the IBM Tivoli Enterprise Console Event Integration Facility Reference for more information about configuration files.
14
m message The text of the event, in double quotation marks. r severity Specifies a severity. The severity must be one defined for the event class.
Examples
The following example sends a test message that displays an Su_Failure event on the event consoles:
java com.tivoli.tec.event_delivery.TECAgent SENDER f myconfig.conf m "su login failure." Su_Failure LOGFILE
See Also
postemsg, postzmsg, wpostemsg (endpoint version), wpostemsg (managed node version), wpostzmsg (endpoint version), wpostzmsg (managed node version), wsetemsg
Chapter 1. Commands
15
upgrade_gui.sh
Upgrades rules that were generated by the version 3.6.2 and earlier rule builder to the syntax supported by the rule compiler provided in this version of the Tivoli Enterprise Console product.
Syntax
upgrade_gui.sh rule_base_dir
Description
If you have rules that were generated by the version 3.6.2 and earlier Tivoli Enterprise Console rule builder, they were stored in the $BINDIR/TME/TEC/rulebase/TEC_RULES/.rule_builder.pro file. You can use the upgrade_gui.sh script in the $BINDIR/TME/RULE_BUILDER directory to convert these rules to the syntax supported by the rule compiler provided in this version of the Tivoli Enterprise Console product. The converted rules take advantage of features 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 rules with the rule builderyou 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 and writes them to rule_set_name.rls files in the TEC_RULES subdirectory of the rule base. The .rule_builder.pro file is left empty.
Authorization
None
Options
rule_base_dir The directory that contains the rule base which contains the rule builder rules to upgrade.
Examples
The following example upgrades the rule builder rules for the rule base located in the /rulebases/test/test001 directory:
upgrade_gui.sh /rulebases/test/test001
16
waddac
Adds an adapter configuration record for an adapter configuration profile.
Syntax
waddac adapter_details type profile
Description
The waddac command adds a record for configuring a Tivoli Enterprise Console event adapter to an existing adapter configuration profile. When distributed to subscribing managed nodes, the new record makes effective the adapter configuration reflected by the supplied adapter_details arguments, combined with any installed type-specific defaults. Each adapter type on each adapter configuration profile can be supported by default policies to supply initial values for parts of the configuration not given by a waddac call. Similarly, validation policies might be present to ensure that a given configuration 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 configuration record to standard out. The key value later can be used to modify or remove the record. You can see the key value in the upper right side of the adapter configuration profile entry panel or by using the wlsac command.
Authorization
admin
Options
adapter_details Gives the specific adapter configuration information such as distribution paths, user IDs, and adapter filtering that are used for the distribution parameters of the adapter. b flag=value Sets the given endpoint behavior flag to the given value. Endpoint behavior flags are interpreted during special situations when profiles are distributed, for example when processing a record marked as having been deleted. The specific flags supported vary by endpoint, but those currently supported include the following flags: action_fail Controls the handling of failures of before (!command) and after (!!command) distribution requests. For more information about these requests, see the D option. Values are: abort Stop distribution.
ignore Ignore all failures. report Report failures but continue with distribution activity, the default behavior.
Chapter 1. Commands
17
expand Controls whether references to endpoint context variables of the form $variable within attributes of the record should be expanded by the endpoint code when the profile is distributed. The value of the variable can be no to disable expansion, yes to enable it for all attributes (the default behavior), or a comma-separated list of attribute names to selectively expand only within the values of those attributes. rm_on_del Instructs the endpoint code whether to remove configuration files and distributed files when the record is distributed after being removed. The value can be yes (to force removal, the default behavior), no (to disable removal and thus leave files in place after record deletion), or conf (to remove only the primary adapter configuration file). run_actions Controls whether before (!command) and after (!!command) distribution requests are performed. For more information about these requests, see the D option. The value can be yes 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 endpoint code. c comment Comment text to be associated with the new adapter configuration profile record. The comment text is written into the configuration file when it is created the next time the profile is distributed. D destination=source Requests that the source file be distributed to the destination file on each subscribing host when the profile is distributed. If the destination name does not begin with a slash character, then the actual file name is formed by appending destination to the target directory as given by a d option (or from policy defaults). Instead of the destination=source form for a distribution request, the string can be of the form !command or !!command. The given command, which can be any valid statement for the operating system-dependent command line interpreter present on subscriber nodes (generally /bin/sh, although, on non-UNIX operating systems, 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 adapter configuration files should be distributed. e name=value Defines an environment variable to be placed in the adapter configuration file. As many e arguments as wanted can be given to arrange for an arbitrary number of environment variables to be created. Some environment variables are understood directly by the event adapter libraries and control basic adapter operation. Other variables can be used at a higher level by specific adapters.
18
f filter Defines an event filter to be placed in the adapter configuration file. 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 to prevent the command-line interpreter from reacting to the semicolons. To create a filter that is initially in a disabled state, the string 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_cache Defines an event filter cache to be placed in the adapter configuration file. The filter_cache string must be in the following form: Attribute=Value;Attribute=Value;Attribute=Value;... The entire string needs to be enclosed in quotation marks to prevent the command-line interpreter from reacting to the semicolons. To create a filter cache that is initially in a disabled state, 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 on subscriber endpoints. The gid can be given as a name or numeric value. i on|off[,idname] Specifies whether the adapter should be assigned a unique identifier and what identifier to use. Use this option when running multiple adapters on the same system to assign unique identifiers to the adapters. Specify on|off to indicate whether to use an identifier, and specify idname to indicate the identifier to be used. If you specify i on without idname, the adapter does not have an ID after you distribute the profile. If you specify i off with idname, the configuration record contains the ID but the adapter does not have an ID after you distribute the profile. You can change the configuration record using the wsetac command. m prefiltermode Defines the PreFilterMode to be placed in the adapter configuration file for Windows and NetWare adapters. The valid values are IN, in, OUT, and out. The default value is OUT. If you use IN or in, you must also supply the p parameter to specify a PreFilter. The following example shows a command using this argument:
Chapter 1. Commands
19
waddac -a -m OUT -p Log=System 1 ACPprofile
p prefilter Defines the PreFilters to be placed in the adapter configuration file for Windows and NetWare adapters. You must specify at least the log specification and, optionally, the EventId, EventType, and Source specifications. The following example shows a command using this argument:
waddac -a -p Log=Security 1 ACPprofile
t target The name of the primary adapter configuration file, with a file extension of .conf (commonly known as the CONF file). The complete file name for this file is formed by appending target to the value given for dir with the d option. (Note that default policy is generally established to set target and targdir to appropriate values.) u uid User ID value to be used for distributed files and commands on subscriber endpoints. The uid can be given as a name or numeric ID value. profile type The adapter configuration profile to which the new adapter configuration record is to be added. Gives the adapter type for the new adapter. The adapter type is generally used to drive the workings of default and validation policies. If unknown adapter types are given to waddac, validation policies on the target adapter configuration profile might reject the new record. To see the available types, use the wlsaddflt command.
Examples
The following example adds an adapter configuration profile entry with the comment My Logfile in the CONF file, a user ID of 0, and a group ID of 0 for an adapter of type tecad_logfile_solaris2 in the profile named ACP Profile:
waddac -c "My_Logfile" -u 0 -g 0 tecad_logfile_solaris2 "ACP Profile"
See Also
wdelac, wlsac, wsetac, wsetaddflt
20
wchkclass
Checks an event class definition file for validity against a rule base directory.
Syntax
wchkclass [S server] [a class_file | b class_file] [[host:]path] ... rule_base
Description
The wchkclass command ensures that an event class definition file is valid for the rule base directory specified by the rule_base argument. This command is provided for developing classes on a system that has the Tivoli Management Framework installed. If the Tivoli Management Framework is not installed, you must use the chkclass command.
Authorization
user
Options
host:path Specifies the host that contains the class file to check and the path of the class file to check. If you do not specify this argument, the current rule base is checked for validity. Separate multiple file paths with a space. rule_base Specifies the name of the rule base to check the class definition file against. a class_file Starts checking as though the specified class file were inserted after the specified class file in the rule base. b class_file Starts checking as though the specified class file were inserted before the specified class file in the rule base. S server Specifies the name of the event server in name registry format. The default server is the local event server. To indicate a remote server, specify @EventServer#tmr, where tmr is the name of a Tivoli region.
Examples
The following example checks the /install/bin/hpux/TME/TEC /classfile1 event class definition file against rule base rb1:
wchkclass /install/bin/hpux/TME/TEC/classfile1 rb1
See Also
chkclass
Chapter 1. Commands
21
wconsole
Manages event consoles.
Syntax
wconsole [option [suboption]]
Description
Use the wconsole command to create, copy, delete, and list event consoles, and configure, 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.
Authorization
senior (region role for the command only, no options) Region roles for specific options of the wconsole command are shown in the following table, along with brief descriptions of the options.
Option addegflt assigneg assignop copyconsole Description Region Roles
Adds a new filter to an event RIM_view, RIM_update, group. senior Assigns an event group to an RIM_view, RIM_update, event console definition. senior Assigns operators to an event console definition. Copies the event groups, event group filters, and authorization role assignments for an event console to another console definition. Creates a new event console definition. Creates a new event group. Creates a new console operator. Deletes an event console definition. Deletes one or more event groups. Deletes one or more filters from an event group. Deletes an existing console operator. Lists event groups assigned to an event console definition. RIM_view, RIM_update, senior RIM_view, RIM_update, senior
crtconsole crteg crtoperator delconsole deleg delegflt deloperator lsassigneg
RIM_view, RIM_update, senior RIM_view, RIM_update, senior RIM_view, RIM_update, senior RIM_view, RIM_update, senior RIM_view, RIM_update, senior RIM_view, RIM_update, senior RIM_view, RIM_update, senior RIM_view, RIM_update, user
22
Option lsconsole lsconsoleup lseg lsoperator setconsole
Description Lists event console definitions. Lists currently running consoles. Lists event groups. Lists the operator definition. Changes the name and description of an event console definition. Changes the name and description of an event group. Changes the name and description of an event group filter.
Region Roles RIM_view, RIM_update, user RIM_view, RIM_update, user RIM_view, RIM_update, user RIM_view, RIM_update, user RIM_view, RIM_update, senior RIM_view, RIM_update, senior RIM_view, RIM_update, senior
seteg
setegflt
unassigneg
Unassigns one or more event RIM_view, RIM_update, groups from an event senior console definition. Unassigns operators from an event console definition. RIM_view, RIM_update, senior
unassignop
Notes
v 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 the Tivoli 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 take effect.
Options
Each option of the wconsole command contains optional h, u, and p suboptions, for specifying the host name, user ID, and password, respectively, for logging into the managed node host where the user ID and password must be authenticated by the Tivoli Management Framework. If you do not specify these suboptions and are running the wconsole command on a managed node, the ID of the user currently logged on is used; otherwise, if you are running on a host in a non-Tivoli environment, the login window is displayed. Note: If you are running the wconsole command on a managed node with the AIX 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, and password to prevent the login window from displaying. This is not necessary 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
Common Suboption h host[:port]
Definition The name of the managed node host where the user ID and password must be authenticated by the Tivoli Management Framework. Specify the port number if the port used by the host is not port 94. The Tivoli administrator login ID. The password associated with the Tivoli administrator login ID.
u user p password
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 quotation marks. 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 to query the event database to extract those events that meet the criteria of the filter. These events are usually shown in the Event Viewer of an operator console. (Either an operator at an Event Viewer or a rule can suppress the visibility of these events in an Event Viewer). Use event group filters to configure the selection criteria for events to include in an event group. An event group can have zero or more filters. An event is included in an event group if it satisfies at least one filter criteria. If no filters are configured for an event group, all events are included in the event group. Each filter in an event group can consist of zero or more constraints on the event attributes of received events, and free-form SQL statements. A constraint is constructed using event attributes, SQL operators, and event attribute values. Constraints for a filter can be linked together with the AND operator. Free-form SQL statements can be any valid statements for a WHERE clause. Notes: 1. No syntax checking is done by the wconsole command on free-form SQL statements you specify; that is, you are responsible for the correctness of free-form SQL statements for an event filter. 2. The LIKE operator supports the following wildcards on almost all databases:
Wildcard % _ [] Meaning Any string of zero or more characters Any single character Any single character within the specified range. For example, [a-f] or [abcedf]
24
Wildcard [^]
Meaning Any single character not within the specified range. For example, [^a - f] or [^abcdef]
3. WHERE clause syntax must meet the requirements of the RDBMS used for the event database. D description The text description of the new filter. E event_group The name of the event group to contain the new filter. n name The name of the new filter. s constraints One or more constraints for the new filter. Do not specify the leading WHERE keywordit is handled automatically. Link multiple constraints together with the AND operator. Each individual constraint /must be enclosed by parentheses. The entire constraints argument must be enclosed within quotation marks; for example:
-s "(severity IN (CRITICAL,FATAL))AND \ (source=NT)"
Valid operators for a constraint are =, <>, <, <=, >, >=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, BETWEEN, and NOT BETWEEN. The following table shows event attributes that are set to timestamps and the format to use when specifying values for these attributes with the s suboption. Timestamp values must be enclosed with single quotation marks. Formatted timestamp values specified in a constraint are converted internally to the appropriate data types required by the event database.
Attributes Containing Timestamp Values Format cause_date_reception date_reception last_modified_time Examples
m/d/yy h:mm:ss a z 4/1/01 9:36:24 AM CST a is AM or PM. z is the time zone abbreviation. 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 event console Constraint Editor dialog. The same event attributes, operators, and attribute values you can specify in the Constraint Editor can be specified with the s suboption of the addegflt option. 2. To specify multiple constraints, use the AND operator. Do not use the s suboption more than once on a single wconsole command.
Chapter 1. Commands
25
S free_form_SQL Any SQL statements that are valid for a WHERE clause and are supported by the RDBMS used for the event database. Do not specify the leading WHERE keywordit is handled automatically. Enclose the entire free_form_SQL argument within quotation marks. You can use SQL wildcard characters as long as they are supported by the RDBMS used for the event database. Notes: 1. No syntax checking is done by the wconsole command on free-form SQL statements you specify; that is, you are responsible for the correctness of free-form SQL statements for an event filter. 2. To specify multiple SQL statements, use the AND operator. Do not use the S suboption more than once on a single wconsole command. 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 also optionally assign the roles for the event group. Roles determine whether an operator can acknowledge and close events belonging to the event group. C console The name of the console to assign the event group. E event_group The name of the event group to assign. r role:... The roles to assign the event group. Separate each role with a colon (:). The default value is admin. Valid values are super, senior, admin, and user. For additional information about Tivoli Enterprise Console roles, see the IBM Tivoli Enterprise Console Users Guide. assignop [h host[:port]] [u user] [p password] C console O operator:... Assigns operators to an event console definition. C console The name of the console to assign the operators. O operator:... A list of operators to assign to the console. Separate each operator with a colon (:). The operators specified must have already been created as Tivoli administrators, and must not be currently assigned to another console. You must also have created the specified operator using the Create Operator option on the event console, or by using the wconsole crtoperator command. If an operator has not yet been defined as a Tivoli administrator or is currently assigned to another console, an error message is issued and processing of the command continues. See the lsconsole option for information about listing all currently defined consoles and their assigned operators. copyconsole [h host[:port]] [u user] [p password] n name C console Copies the event groups, event group filters, and authorization role assignments of an event console to another console definition. Event Viewer preferences are not copied. Event Viewer preferences are stored locally on the hosts where the console clients are installed. The target console must exist.
26
C console The name of the target console. n name The 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 console The name of the source console from which to copy event groups and their authorization roles, and event group filters to the new console definition. D description The text description of the new console. The default value is New description. n name The name for the new console. The default value is New. O operator:... A list of operators to assign to the new console. Separate each operator with a colon (:). The operators specified must have already been created as Tivoli administrators, and must not be currently assigned to another console. You must have also created the operators specified using the Create Operator option of the event console or by using the wconsole crtoperator command. If an operator has not yet been defined as a Tivoli administrator or is currently assigned to another console, an error message is issued and processing of the command continues. See the lsconsole option for information about listing all currently defined consoles and their assigned operators. crtoperator [h host[:port]] [u user] [password] O operator:... [-C console] Creates a new console operator. O operator:... A list of operators to create. Separate each operator with a colon (:). The operators specified must have already been created as Tivoli Administrators and must not be currently assigned to another console. If an operator has not yet been defined as a Tivoli Administrator or is currently assigned to another console, and error message is issued and processing of the command continues. See the lsconsole option for information about listing all currently defined consoles and their assigned operators. C console The name of an existing console to which newly created operators are to be assigned. crteg [h host[:port]] [u user] [p password] n name [D description] [E event_group] Creates a new event group. D description The text description of the new event group. E event_group The 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
n name The name for the new event group. delconsole [h host[:port]] [u user] [p password] n name Deletes an event console definition. If instances of the console are running when this option is issued, the definition is not removed until no instances are running. n name The 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 event groups specified with this option are assigned to consoles, the event groups are unassigned from the consoles before being deleted. e event_group:... The names of the event groups to delete. Separate each event group 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_group The name of the event group that contains the filters to delete. n name The 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 lsconsole option for information about listing all currently defined consoles and their assigned operators. lsassigneg [h host[:port]] [u user] [p password] C console Lists event groups assigned to an event console definition. C console The 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 clients that are installed. a Lists the console description, event groups assigned and their authorization roles, and assigned operators for each console definition. If this option is not specified, only console names are listed.
c console:... The names of specific console definitions to list. Separate each console name with a colon (:). If this suboption is not specified, all console definitions are listed. -lsconsoleup [h host[:port]] [u user] [p password] Lists currently running consoles for the UI server in the Tivoli region to which the user running the wconsole -lsconsoleup command is logged in.
28
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 this suboption is not specified, only the event group names are listed.
e event_group:... The names of specific event groups to list. Separate each event group name with a colon (:). If this suboption is not specified, all event 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 each operator with a colon (:). If this suboption is not specified, all console 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 console The name of the console to change. D description The new text description for console. n name The new name for the console. The name is not changed if you specify 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 are replicated to assigned event groups. D description The new text description for the event group. E event_group The name of the event group to change. n name The new name for the event group. The name is not changed if you 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 description The new text description for the filter. E event_group The name of the event group containing the filter to change. F filter The name of the filter to change.
Chapter 1. Commands
29
n name The new name for the filter. The name is not changed if you specify 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 console The 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 console The name of the console to unassign the operators. O operator:... A list of operators to unassign from the console. Separate each operator with a colon (:). See the lsconsole option for information about listing all currently defined consoles and their assigned operators.
Return Values
The wconsole command returns one of the following values. Return values can be obtained with the $? shell variable in the UNIX, Linux, or bash shell or with the %ERRORLEVEL% shell variable in Windows operating systems. Any error message 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.
Examples
The 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 the text shown on the following line has wrapped due to space restrictions on the page. The example should be interpreted as being on one line. addegflt Examples 1. The following example creates the Immediate Attention event group filter in the Operators event group. The Operators event group must already exist. The Immediate Attention filter is comprised of one constraint: The severity event attribute is set to a value of CRITICAL or FATAL.
wconsole -addegflt -E Operators \ -n "Immediate Attention" \ -s "(severity IN (CRITICAL,FATAL))"
30
2. The following example creates the LowRepeats event group filter in the Logfile event group. The Logfile event group must already exist. The LowRepeats filter is comprised of the following two constraints, both of which must be met for events to pass this filter and be included in the event group: a. The source event attribute is set to a value of LOGFILE. b. The repeat_count event attribute is set to a value between 1 and 10.
wconsole -addegflt -E Logfile -n LowRepeats \ -s "(source=LOGFILE) AND \ (repeat_count BETWEEN 1 AND 10)"
3. The following example adds a new filter named Router Ports to the Subnet event group. The Subnet event group must already exist. The Router Ports filter is comprised of the following two constraints and free-form SQL statement. All three conditions must be met for events to pass 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 a Microsoft SQL Server RDBMS. The backslash character preceding the operator is an escape character so the exclamation point is interpreted 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 and senior roles to the NetAdmin console:
wconsole.cmd -assigneg -C NetAdmin \ -E Subnet -r super:senior
assignop Examples The following example assigns the operator named Root_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, and event group filters from the Personnel Systems console to the Personnel Systems Audit console. Note that operators are not copied and the target console must exist.
wconsole.cmd -copyconsole -h mfoster:6688 \ -u Administrator -p chief10 \ -n "Personnel Systems" \ -C "Personnel Systems Audit"
crtconsole Examples 1. The following example creates a console definition named Personnel Systems and specifies its description. No event groups or operators are assigned to the console.
Chapter 1. Commands
31
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 Personnel Systems, specifies its description, and assigns the operator named mf_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 Personnel Systems, specifies its description, assigns the operator named mf_viewer, and copies the event groups and their roles from the AdministratorConsole console to the Personnel Systems console. Note that 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. The filters from the Network event group are copied into the new event group.
wconsole.cmd -crteg -n Subnet -D "Subset \ of the Network event group" -E Network
delconsole Examples The following example deletes the Personnel Systems console definition:
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 from the Network event group:
wconsole.cmd -delegflt -E Network \ -n SNMP:OpenView
2. The following example deletes all of the filters from the Performance event group:
wconsole.cmd -delegflt -E Performance -a
lsassigneg Examples The following example lists the event groups assigned to the NetAdmin console:
32
wconsole.cmd -lsassigneg -C NetAdmin
The output displayed by this command is:

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

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

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 description Event Group: newEG2 (User, Admin) Event Group: newEG1 (User, Admin)
-lsconsoleup Example The following is an example of the output for the lsconsoleup option with default values:
There are currently 3 active TEC consoles. Console Administrator/Operator _________________________________________ Root_jbr01-region Admin1 test1 TestAdmin DB2 DB2Admin
setconsole Examples The following example changes the name of the Personnel Systems console 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 to Subnetwork, and changes the description:
Chapter 1. Commands
33
wconsole.cmd -seteg -n Subnetwork \ -D "Subnetwork Event Data" -E Subnet
unassigneg Examples The following example unassigns the Network and System event groups from NetAdmin console:
wconsole.cmd -unassigneg -C NetAdmin \ -e Network:System
unassignop Examples The following example unassigns the operator named Root_hmckinne-nt-region to the NetAdmin console:
wconsole.cmd -unassignop -C NetAdmin \ -O Root_hmckinne-nt-region
34
wcrtdefcfg
Creates a default configuration in the event console.
Syntax
wcrtdefcfg operator [host[:port] user password]
Description
The wcrtdefcfg command creates a default event group and a default event console and assigns an operator to the event console. The default event group contains all open events.
Authorization
senior
Options
operator 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. user Specifies 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. password Specifies the password of the administrator. This option is required if you specify a user.
Examples
The following example creates a default configuration for operator Root_adasilva-region on host calculus; the name and password for the administrator are root and my_passwrd:
wcrtdefcfg Root_adasilva-region calculus root my_passwrd
See Also
wconsole
Chapter 1. Commands
35
wcrtebizgroups
Creates event groups required to use the ebusiness.rls rule set.
Syntax
wcrtebizgroups [host[:port] user password]
Description
The wcrtebizgroups script uses the wconsole command to create the event groups required by the ebusiness.rls rule set. These groups include: Not Monitoring E-Business Events This event group includes all open TEC_ITS_Not_Monitoring_eBusiness events, which are generated when the NetView component is not configured to properly monitor the e-business applications. Probable Event Association Events This event group includes all open TEC_Probable_Event_Association events. All WAS, DB2, and MQ Events This event groups includes all other e-business events related to the monitored DB2, WebSphere Application Server, and WebSphere MQ services.
Authorization
senior
Options
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. user Specifies the user name of the administrator. If you do not specify this option, the ID of the user currently logged on is used.
password Specifies the password of the administrator. This option is required if you specify a user. Note: If you are running on an AIX system and are logged in as root, you must explicitly specify the host name, user ID, and password to prevent the login window from displaying. This is not necessary if you are logged in to an AIX system under any other user ID.
Examples
The following creates the event groups on a system called phizer:
wcrtebizgroups phizer.dev.tivoli.com jford my_password
See Also
wconsole
36
wcrtmtgroups
Creates event groups required to use the maintenance_mode.rls rule set.
Syntax
wcrtmtgroups [host[:port] user password]
Description
The wcrtmtgroups script uses the wconsole command to create the event group required by the maintenance_mode.rls rule set. The Open Maintenance Events group includes any open TEC_Maintenance events, which are generated when a monitored system enters or exits maintenance mode.
Authorization
senior
Options
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. user Specifies the user name of the administrator. If you do not specify this option, the ID of the user currently logged on is used.
Examples
The following creates the event groups on a system called phizer:
wcrtmtgroups phizer.dev.tivoli.com jford my_password
See Also
wconsole
Chapter 1. Commands
37
wcrtnvgroups
Creates event groups required to use the netview.rls rule set.
Syntax
wcrtnvgroups [host[:port] user password]
Description
The wcrtnvgroups script uses the wconsole command to create the Tivoli NetView event groups required by the netview.rls rule set. These two groups are the OpenNetview event group and the ClosedNetview event group. The OpenNetview event group contains events from the Tivoli NetView product that are open in the Tivoli Enterprise Console product. The ClosedNetview event group contains the events from the Tivoli NetView product that have a status other than OPEN in the Tivoli Enterprise Console product.
Authorization
senior
Options
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. user Specifies 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.
Examples
The following example creates the event groups on a system called phizer:
wcrtnvgroups phizer.dev.tivoli.com jford my_password
See Also
wconsole
38
wcrtsrc
Creates a source on the event server.
Syntax
wcrtsrc [S server] [l label] source
Description
The wcrtsrc command appends a source to the current source list on the event server. The wcrtsrc command populates the Tivoli object database that event consoles use to create event filters. The source name is checked to be sure it is not a duplicate before it is added to the list. Sources send event information to the event console using event adapters. The event adapter defines the name for a source.
Authorization
senior
Options
source 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 this argument is not specified, the value specified in source argument is used as the label. S server Specifies the name of the event server in name registry format. The default server is the local event server. To indicate a remote server, specify @EventServer#tmr, where tmr is the name of a Tivoli region.
Examples
The following example adds the LOGFILE source to the local Tivoli region and labels the source Logfile:
wcrtsrc l "Logfile" LOGFILE
See Also
wdelsrc, wlssrc, wsetsrc
Chapter 1. Commands
39
wcrtteccfg
Creates a default Tivoli Enterprise Console configuration.
Syntax
wcrtteccfg host[:port] user password [operator]
Description
The wcrtteccfg command creates a default Tivoli Enterprise Console configuration. Use this command if the default Tivoli Enterprise Console configuration data does not get created because of a failure during the UI server installation. This command 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 this command to create the initial data.
Authorization
senior
Options
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. user Specifies the user name of the administrator. password Specifies the password of the administrator. operator Specifies the operator to assign to the default console. This parameter is optional.
Examples
The following example creates a default Tivoli Enterprise Console configuration for operator Root_adasilva-region on host calculus; the name and password for the administrator are root and my_passwrd:
wcrtteccfg calculus root my_passwrd Root_adasilva-region
40
wdbconfig.sh
Runs the database configuration scripts.
Syntax
wdbconfig.sh [rm | rm_tbl | cr | cr_tbl | upg | upg_362]
Description
The wdbconfig.sh script runs the database configuration scripts generated during the Tivoli Enterprise Console installation by the DB Assistant. It is used when the generated scripts must be copied to a RIM host system that is located on a different system than the event server. The wdbconfig.sh script is located in the same 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 the event database RIM object. This user should have DBA access to the event database tables. The user must also have a corresponding login for the Tivoli administrator. For the Informix database, the wdbconfig.sh script can be run only on the system where the database server is installed.
Authorization
user
Options
rm rm_tbl Runs 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 you have an existing database, it must be removed before doing a new installation. Runs the dbConfigure_rm.sh script to completely remove the database.
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 a version 3.7.1 schema to the schema for versions 3.8 and 3.9.
upg_362 Runs the dbConfigure_upg_362.sh script to upgrade the database from a version 3.6.2 schema to the schema for versions 3.8 and 3.9.
Examples
The following example creates a new database:
wdbconfig.sh cr
Chapter 1. Commands
41
wdbmaint.sh
Updates the database data distribution statistics or reorganizes the database.
Syntax
wdbmaint.sh [reorg | stats] [rim_object_name db2server | db2client]
Description
The wdbmaint.sh command improves database runtime performance by updating database statistics or by reorganizing the database. Updating the database statistics to reflect the current amount of data and the distribution of data values helps the internal database manager choose the best access plan to retrieve data from the database. For some databases, such as the DB2 database, updating the statistics also updates the information about the free pages in a table. That enables the database to reuse table pages that contain deleted rows. The database statistics must be updated regularly to prevent tablespace-full errors and should be updated after data is purged using the wtdbclear command. Reorganizing the database can put indexes or tables back into the sequential index order, which reduces fragmentation. After the reorganization utility is run, the statistics are automatically updated. Reorganizing the DB2 database also releases extents allocated to a table from a tablespace that are no longer needed by the table. For the DB2 database, an extent allocated by a table from a tablespace is released only if the table is reorganized; because of that, the wtdbspace report still shows that the tablespace has a lot of space allocated even after the wtdbclear command 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 utilities should 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 this command is run. For the Sybase, DB2, and Microsoft SQL Server databases running the reorg option, this command must be run from the RIM host. For all other 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 the command 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 from the $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 the directory in which the command is run so that temporary work files can be created.
Authorization
user
42
Options
reorg stats Reorganize the database indexes and tables. Update the internal statistics of data distribution.
rim_object_name Specifies the name of the RIM object associated with the event database. The default value is TEC. db2client Specifies that the DB2 client is installed on the RIM host and is the connection used by RIM. This parameter is used only with DB2 connections to RIM. The DB2 client prompts for the password to be used to connect to the database for the user defined in the specified RIM object. db2server Specifies that the DB2 server is installed on the RIM host and is the connection used by RIM. This parameter is used only with DB2 connections to RIM. For a DB2 database, if you do not specify either db2client or db2server, the default 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 Also
wtdbclear, wtdbspace
Chapter 1. Commands
43
wdelac
Removes an adapter configuration record from an adapter configuration profile.
Syntax
wdelac key... profile
Description
The wdelac command deletes the records selected by the given keys from the named adapter configuration profile. When the profile is next distributed, the old configuration files are removed or are not based on the value of the rm_on_del behavior flag.
Authorization
admin
Options
key... 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 the upper right side of the adapter configuration profile entry panel or by using the wlsac command. The name of the adapter configuration profile from which records are to be removed. If the name includes spaces, enclose the whole name in quotation marks.
profile
Examples
The following example deletes the records with key values 0, 1, and 4 from the profile named ACP Logfile Profile:
wdelac 0 1 4 "ACP Logfile Profile"
See Also
waddac, wlsac, wsetac, wsetaddflt
44
wdelsrc
Deletes a source from the event server list.
Syntax
wdelsrc [S server] source...
Description
The wdelsrc command deletes a source from the current source list at the event server. The removed source is not removed from event consoles, nor are existing events from the source removed from the event cache. Therefore, the source can be added back without reconfiguring event groups. To display a list of available sources, use the wlssrc command.
Authorization
senior
Options
source... Specifies the source name to delete. At least one source must be specified. Separate multiple sources with a space. S server Specifies the name of the event server in name registry format. The default server is the local event server. To indicate a remote server, specify @EventServer#tmr, where tmr is the name of a Tivoli region.
Examples
The following example deletes the SNMP source from the local Tivoli region:
wdelsrc SNMP
See Also
wcrtnvgroups, wlssrc, wsetsrc
Chapter 1. Commands
45
wlsac
Shows adapter configuration records from an adapter configuration profile).
Syntax
wlsac [ l | f format] [key... ] profile
Description
The wlsac command writes to standard output one or more records from an adapter configuration profile. One or more record keys can be supplied to choose individual records. If no keys are given, all records are printed. Records are printed in one of two forms. The default format includes the key, adapter type, and the complete target file name (that is, the name of the file on subscriber hosts where the adapter configuration is written upon distribution). An alternate format can be given with the f option. With the l option, each record is printed out as an actual adapter configuration in the same form used when the configuration files are created upon distribution.
Authorization
admin
Options
key... 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 the upper right side of the adapter configuration profile entry panel or by using this command. The name of the adapter configuration profile from which records are to be printed. If the name includes spaces, enclose the whole name in quotation marks.
profile
f format Provides an alternate format for printing records. The format string can contain arbitrary text as well as references to the data from the record. Such references are of the same form used in constructing message catalogs, that being an index value and a format request. The following values are available for formatting: %1 %2 %3 %4 %5 %6 %7 %8 %9 %10 The key. The adapter type. The target directory. The target file name. The record comment field. The sequence of environment variable definitions. The sequence of event filter definitions. The sequence of file distribution requests. The sequence of endpoint behavior flags. The user ID for distribution actions.
46
%11 %12 %13 %14 %15 %16
The group ID for distribution actions. The pre-filter mode. The sequence of pre-filter definitions. The sequence of filter cache definitions. The adapter identifier name. The adapter identifier switch.
The key, type, target directory, and file name values are all strings, and should be formatted with the $s format. The sequence values are lists of strings; the simplest format for those values is something like $I{%1$s}{\n}, which prints each string from the sequence on a line by itself. The entire string must be enclosed in single quotation marks. The default format is thus:
%1$s %2$s %3$s/%4$s
To print simply the adapter type and the filters:

%2$s\n%6$I{\t%1$s}{\n}
If you are writing applications using the Tivoli Enterprise Console and Tivoli ADE products, see the Tivoli ADE Application Services Manual, Volume 1 for complete details on message formats and message catalogs. l Shows all selected records as complete adapter configurations.
Examples
The 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.conf Record comment tecad_nt Configuration! Env Var Defs BEGIN ServerLocation=@EventServer EventMaxSize=4096 PollInterval=30 BufEvtPath=C:\usr\local\Tivoli\bin\w32-ix86\TME\TEC\adapters\etc\ \ tecad_nt.cache AdapterCdsFile=C:\usr\local\Tivoli\bin\w32-ix86\TME\TEC\adapters\ \ etc\tecad_nt.cds AdapterErrorFile=C:\usr\local\Tivoli\bin\w32-ix86\TME\TEC\adapters\ \ etc\tecad_nt.err AdapterSpecificFile=C:\usr\local\Tivoli\bin\w32-ix86\TME\TEC\ \ adapters\etc\tecad_nt.conf Env Var Defs END Event Filters BEGIN Filter:Class=NT_Base Filter: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
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 END File Dists BEGIN tecad_nt.err=/usr/local/Tivoli/bin/generic_unix/TME/ACF_REP/ \ tecad_nt.err tecad_nt.fmt=/usr/local/Tivoli/bin/generic_unix/TME/ACF_REP/ \ tecad_nt.fmt tecad_nt.cds=/usr/local/Tivoli/bin/generic_unix/TME/ACF_REP/ \ tecad_nt.cds !net stop TECNTAdapter c: cd \usr\local\Tivoli\bin\w32-ix86 cd TME\TEC\adapters\etc del tecad_nt.* cd \temp del 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 TECNTAdapter File Dists END Endpt Behavior Flags rm_on_del=yes! UID Operator! GID 0!
See Also
waddac, wdelac, wsetac, wsetaddflt
48
wlsaddflt
Shows global default information on the defined adapter types.
Syntax
wlsaddflt [ l | f format] [type... ]
Description
The wlsaddflt command fetches global default information for one or more adapter types. If no types are specified, then wlsaddflt prints default information for all known adapter types. Records are printed in one of two forms. The default format includes the adapter type and the complete target file name (that is, the name of the file on subscriber hosts where the adapter configuration is written upon distribution). An alternate format can be given with the f option. With the l option, each record is printed out as an actual adapter configuration in the same form used when the configuration files are created upon distribution.
Authorization
admin
Options
type... The adapter types whose global default values are to be printed. Separate multiple types with a space. To see the available types, use the wlsaddflt command.
f format Provides an alternate format for printing records. The format string can contain arbitrary text as well as references to the data from the record. Such references are of the same form used in constructing message catalogs, that being an index value and a format request. The following values are available for formatting: %1 %2 %3 %4 %5 %6 %7 %8 %9 %10 %11 The adapter type (same as %2). The adapter type. The target directory. The target file name. The record comment field. The sequence of environment variable definitions. The sequence of event filter definitions. The sequence of file distribution requests. The sequence of endpoint behavior flags. The user ID for distribution actions. The group ID for distribution actions.
The type, target directory, and file name values are all strings, and should be 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
which prints each string from the sequence on a line by itself. The entire string must be enclosed in single quotation marks. The default format is thus:
%1$s %2$s %3$s/%4$s
To print simply the adapter type and the filters:

%2$s\n%6$I{\t%1$s}{\n}
If you are writing applications using the Tivoli Enterprise Console and Tivoli ADE products, see the Tivoli ADE Application Services Manual, Volume 1 for complete details on message formats and message catalogs. l Shows all selected records as complete adapter configurations
Examples
The 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=@EventServer EventMaxSize=4096 WellBehavedDaemon=TRUE BufEvtPath=$TIVOLIHOME/tec/${AC_TYPE}.cache
See Also
waddac, wdelac
50
wlsadenv
Shows an installed list of adapter-specific Event Integration Facility environment variables.
Syntax
wlsadenv type
Description
The wlsadenv command writes to standard output the list of Event Integration Facility environment variables recognized by the given adapter type, separated by new lines. The type __generic__ is used by the Adapter Configuration Facility for the list of variables understood by the Event Integration Facility library itself.
Authorization
admin
Options
type The adapter type. To see the available types, use the wlsaddflt command.
Examples
The following example lists the Event Integration Facility environment variables for the tecad_logfile adapter type:
wlsadenv tecad_logfile
This example returns the following information:

UnmatchLog LogSources
See Also
waddac, wsetadenv, wlsadgui, wlsadval
Chapter 1. Commands
51
wlsadgui
Show an installed link to adapter-specific extended configuration tools.
Syntax
wlsadgui type
Description
The wlsadgui command writes to standard output the class name, instance name, and button label installed with wsetadgui for the given adapter type. If an adapter has special extended configuration tools intended to be used with the adapter configuration file graphical configuration tools, then a link should be established when the adapter is installed.
Authorization
admin
Options
type The adapter type. To see the available types, use the wlsaddflt command.
Examples
The following example shows extended configuration tools for the tecad_logfile type:
# wlsadgui tecad_logfile @LogfileConfiguration:LogfileConfiguration Logfile Format Editor...
See Also
wlsac, wlsadenv, wsetadgui, wlsadval
52
wlsadval
Shows installed validation information for an adapter type.
Syntax
wlsadval attribute type
Description
The wlsadval command writes to standard output validation information previously stored with wsetadval command for the given attribute of the given adapter type.
Authorization
admin
Options
attribute The name of the profile attribute whose validation information is to be printed. The following list shows the attributes on a typical adapter configuration profile: ACPbhv The sequence of profile behavior variables, separated by new lines. ACPcomment The comment field. ACPdist The sequence of distribution requests, separated by new lines. ACPev The sequence of environment variables, separated by new lines. ACPflt The sequence of filter definitions, separated by new lines. ACPgid The group ID for endpoint actions. ACPtargdir The configuration installation directory. ACPtarget The target primary configuration filename. ACPtype The type of the record. This attribute generally needs no validation. ACPuid The user ID for endpoint actions. Other attributes might be present if they are added to the profile with the Tivoli Application Extension Facility (AEF) tools. type The adapter type. To see the available types, use the wlsaddflt command.
Chapter 1. Commands
53
Examples
The following example shows the validation information for the ACPtarget attribute and the tecad_logfile_solaris2 type:
wlsadval ACPtarget tecad_logfile_solaris2 case "$1" in "tecad_logfile.conf") echo TRUE ;; *) echo FALSE ;; esac exit 0
See Also
wlsac, wlsadenv, wsetadgui
54
wlsaeenv
Shows the environment variables available at an adapter configuration profile endpoint.
Syntax
wlsaeenv [a] endpoint
Description
The wlsaeenv command prints to standard output the list of environment variables and their values for a given endpoint. The variables are printed one per line in the form name=value. This form can be used with wsetaeenv when that command is issued with the i option. In combination, therefore, wlsaeenv and wsetaeenv can be used to copy the environment of one endpoint to another.
Authorization
admin
Options
endpoint The name of the endpoint object to be modified. The endpoint object can be referenced with the standard @Classname:label notation; if not, it is assumed 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) be printed along with all those established with wsetaeenv. The variable ACPEP_NODE is printed only for managed nodes, not for endpoints. If the name of the endpoint is referenced as @Endpoint:label, the variable ACPEP_NODE is not printed because it has no meaning for this class name.
Examples
The following example shows the environment variables and their values for endpoint ep1:
wlsaeenv -a @Endpoint:ep1
This command returns the following information:

ACPEP_NAME=@Endpoint:xerius ACPEP_OID=1170507881.2.508+#TMF_Endpoint::Endpoint# ACPEP_CLASS=Endpoint
See Also
waddac, wdelac, wdistrib (in the IBM Tivoli Management Framework Reference Manual), wsetaeenv
Chapter 1. Commands
55
wlsemsg
Lists received events.
Syntax
wlsemsg [k key] [r severity] [t status] console [event_group...]
Description
The wlsemsg command lists received events in the event database. You must use the options to specify a particular set of events or all events are returned. To specify multiple values for a flag, use the flag multiple times, except as stated otherwise for the option. When you use the options, only events that meet the specification of all of the options are returned. Use the k option to specify sort keys for returned events.
Authorization
user
Options
console 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 the filters 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 by event_handle, server_handle, and date_reception. Other values are administrator, class, hostname, id, message, origin, repeat_count, severity, source, status, sub_source, and sub_origin. The id field is defined as the concatenation of event_handle, server_handle, and date_reception. Separate multiple values with a comma followed by a space (, ) and enclose the whole set of values in double quotation marks, as in the following example:
wlsemsg -k "Class, Date, Status" ConsoleName
r severity Specifies a severity of FATAL, CRITICAL, MINOR, WARNING, HARMLESS, or UNKNOWN. Additional severities can also be configured by the site. t status Specifies a status of OPEN, CLOSED, RESPONSE, or ACK.
Examples
The following example displays all open events of severity WARNING that are reported to event console Network Events:
wlsemsg r WARNING t OPEN "Network Events"
56
See Also
wtdumper on page 124, wtdumprl on page 126, wpostemsg (endpoint version), wsetemsg
Chapter 1. Commands
57
wlsesvrcfg
Lists the configuration parameters for a running event server.
Syntax
wlsesvrcfg [S server] [b] [c] [e] [k] [m] [n] [r] [t]
Description
The wlsesvrcfg command lists configuration parameters for a running event server. The server in the local Tivoli region is the default server unless another server is specified. If no options are specified, all parameters are displayed.
Authorization
user
Options
b c e k m n Displays the maximum number of event messages buffered in the reception buffer. Displays the number of events that can be stored in the event cache. Displays the number of seconds that received events are retained in the reception log. Displays the number of seconds to keep closed events in the event cache. Displays the number of seconds to allow the event server to initialize. Displays the number of seconds to keep events that have not been closed.
S server Specifies the name of the event server in name registry format. The default server 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 trace file.
Examples
The following example lists information for the event server installed in the Tivoli region gray-region:
# wlsesvrcfg -S @EventServer#gray-region -t
The following is the output from this command:

Trace rule execution: No Rule trace output file: /tmp/rules.trace
See Also
wsetesvrcfg
58
wlssrc
Lists existing sources on the event server.
Syntax
wlssrc [S server] [l] [source...]
Description
The wlssrc command lists sources that are currently configured on the event server. If no source is specified, all sources are listed. You can use options to list the label for each source. The label represents the source on the event consoles of administrators.
Authorization
user
Options
source... Specifies a source to list or a Perl regular expression. All sources are listed if none are specified. Separate multiple sources with a space. l Displays the label that identifies each source.
S server Specifies the name of the event server in name registry format. The default server is the local event server. To indicate a remote server, specify @EventServer#tmr, where tmr is the name of a Tivoli region.
Examples
The following example lists all information on all sources at the local event server:
wlssrc bl
See Also
wcrtsrc, wdelsrc, wsetsrc
Chapter 1. Commands
59
wmigcon
Migrates Tivoli Enterprise Console Version 3.6 consoles, event groups, event group filters, and operators to Version 3.7.x, Version 3.8, and Version 3.9.
Syntax
wmigcon [h host:port] [u user] [p password] [x e | r | c]
Description
The wmigcon command performs an automatic migration of consoles, event groups, and operators in an existing Tivoli Enterprise Console Version 3.6 installation to the appropriate format for the Version 3.7, Version 3.8, or Version 3.9 event console. This command is typically used only once, during the initial setup of 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 LOG ^LOG LOG$ ^LOGFILE$ LOG* LOG+ LOG? LO[G,T] 123.84.12.[0-5][0-9] 123.84.12.0\b ^LO[G,T] LO[G,T]$ ^123.84.12.[0-5][0-9]$ New Filter LIKE %LOG% LIKE LOG% LIKE %LOG LIKE LOGFILE LIKE %LOG% LIKE %LOG% LIKE %LOG% LIKE %LO[G,T]% LIKE %123.84.12.[0-5][0-9]% LIKE %123.84.12.0 % LIKE LO[G,T] LIKE %LO[G,T] LIKE 123.84.12.[0-5][0-9]
Notes: 1. This command attempts to translate each filter as accurately as possible, but an exact match cannot be made for each filter. The old filters are specified as Perl regular expressions, while the new filters are specified with the SQL LIKE operator. Regular expressions and SQL statements do not map to one another in a precise way. Therefore, you should inspect each filter after the wmigcon command 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 is not possible to selectively migrate these objects. 3. The event filter in Tivoli Enterprise Console Version 3.6 filters on five attributes of an event: class, source, sub_source, origin, and sub_origin. The source attribute is treated differently from the other attributes by the wmigcon command. The wmigcon command creates a new filter that matches a single source exactly. That is, there are no wildcard characters (%) in the Tivoli Enterprise Console version 3.9 filter. So if the source and a subsource of a Tivoli Enterprise Console version 3.6 filter are as follows:
60
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 match any string that contains the substring LOGFILE, but the source attribute matches only those strings that are exactly LOG.
Authorization
super, 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 other than port 94 is being used. p password The password for the login specified in the u user argument. This option is required if you use the u option to specify a user. u user The login you use as a Tivoli administrator. If you do not specify this option, the ID of the user currently logged on is used. x e | r | c How 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 with the new one, or x c to change the name of the object by appending a number to the new object. The flags are case sensitive. The space between the option and the flag is optional. Note: If you are running on an AIX system and are logged in as root, you must use the h, u, and p suboptions to explicitly specify the host name, user ID, and password to prevent the login window from displaying. This is not necessary if you are logged in to an AIX system under any other user ID.
Examples
The following example performs the migration as the user root on the managed node 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
wpostemsg (endpoint version)

Posts an event to the event server using Tivoli endpoint communication to a Tivoli Enterprise Console gateway.
Syntax
wpostemsg [S server | f configuration_file] [m message] [r severity ] [ attribute=value... ] class source
Description
The wpostemsg command sends an event to an event server using Tivoli endpoint communication to a Tivoli Enterprise Console gateway. Notes: 1. Although this command is still supported, the wpostzmsg command is preferred for sending events using Tivoli communication. 2. Because cache files cannot be shared by applications, you should not use a configuration 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 system where you are running the command. If you have distributed an adapter to the endpoint, this command can be found in the $LCF_BINDIR/../bin directory. This command is dependent upon the endpoint environment variables, which can be set using the lcf_env.sh or lcf_env.csh scripts that are included in the endpoint installation. If you are using wpostemsg on a system that is configured both as an endpoint and as a managed node, you might want to create a shell alias for the endpoint version 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.
Authorization
user
Options
attribute=value... Assigns a value to any valid attribute. The attribute should be one defined for the event class. Separate multiple attribute=value expressions with spaces. class Specifies the class of the event. It must match a class that is configured at the server. Classes are defined by the event adapter and are listed in the adapter BAROC file. If any blank spaces are in the class name, enclose the class name in double quotation marks.
62
source
Specifies the source of the event. If any blank spaces are in the source name, enclose the source name in double quotation marks.
f configuration_file Specifies the name of the configuration file. See the IBM Tivoli Enterprise Console Event Integration Facility Reference for more information about configuration files. m message The text of the event, in double quotation marks. r severity Specifies a severity. The severity must be one defined for the event class. S server Specifies the name of the event server in name registry format. Specify @EventServer to have events submitted to the locally named event server of the Tivoli Enterprise Console gateway. To indicate a remote server, specify @EventServer#tmr, where tmr is the name of a Tivoli region. If you do not specify the S or f option, the event is sent to the event server defined by the Tivoli Enterprise Console gateway. If portmapper is running on the event server, you can specify a TCP/IP host name or IP address instead. This results in non-Tivoli communication between the Tivoli Enterprise Console gateway and the event server.
Examples
The following example sends a test message that displays an Su_Failure event of severity WARNING on the event consoles:
wpostemsg r WARNING m "su failure" Su_Failure LOGFILE
See Also
postemsg, postzmsg, TECAgent, wpostemsg (managed node version), wpostzmsg (endpoint version), wpostzmsg (managed node version), wsetemsg
Chapter 1. Commands
63
wpostemsg (managed node version)

Posts an event to the event server using Tivoli managed node communication.
Syntax
wpostemsg [S server | f configuration_file] [m message] [r severity] [attribute=value...] class source
Description
The wpostemsg command sends an event to an event server using Tivoli managed node communication. Notes: 1. Although this command is still supported, the wpostzmsg command is preferred for sending events using Tivoli communication. 2. Because cache files cannot be shared by applications, you should not use a configuration 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 on the same system where you are running the command. This command can be found in the $BINDIR/bin directory. The managed node version of wpostemsg is dependent upon the Tivoli environment variables, which can be set using the setup_env.sh or setup_env.cmd scripts that are included in the installation.
Authorization
user
Options
attribute=value... Assigns a value to any valid attribute. The attribute should be one defined for the event class. Separate multiple attribute=value expressions with spaces. class Specifies the class of the event. It must match a class that is configured at the server. Classes are defined by the event adapter BAROC file. If any blank spaces are in the class name, enclose the class name in double quotation marks. Specifies the source of the event. If any blank spaces are in the source name, enclose the source name in double quotation marks.
source
f configuration_file Specifies the name of the adapter configuration file. See the IBM Tivoli Enterprise Console Event Integration Facility Reference for more information about configuration files. m message The text of the event, in double quotation marks. r severity Specifies a severity. The severity must be one defined for the event class.
64
S server Specifies the name of the event server in name registry format. The default value is @EventServer, the local event server. To specify a remote server, specify @EventServertmr, where tmr is the name of a Tivoli region. If no S or f option is specified, the event is sent to the locally named event server.
Examples
The following example sends a test message that displays an Su_Failure event of severity WARNING on the event consoles:
wpostemsg r WARNING m "su failure" Su_Failure LOGFILE
See Also
postemsg, postzmsg, TECAgent, wpostemsg (endpoint version), wpostzmsg (endpoint version), wpostzmsg (managed node version), wsetemsg
Chapter 1. Commands
65
wpostzmsg (endpoint version)

Posts an event to the event server using Tivoli endpoint communication to a Tivoli Enterprise Console gateway or non-Tivoli communication directly to the event server.
Syntax
wpostzmsg [S server | f configuration_file] [m message] [r severity] [attribute=value...] class source
Description
The wpostzmsg command sends an event to an event server using Tivoli endpoint communication to a Tivoli Enterprise Console gateway. This command requires the installation of a Tivoli endpoint on the same system where you are running the command. If you have distributed an adapter to the endpoint, this command can be found in the $LCF_BINDIR/../bin directory. Note: Because cache files cannot be shared by applications, you should not use a configuration 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 can be set using the lcf_env.sh or lcf_env.csh scripts that are included in the endpoint installation. If you are using wpostzmsg on a system that is configured both as an endpoint and as a managed node, you might want to create a shell alias for the endpoint version 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.
Authorization
user
Options
attribute=value Assigns a value to any valid attribute. The attribute should be one defined for the event class. Separate multiple attribute=value expressions with spaces. class Specifies the class of the event. It must match a class that is configured at the server. Classes are defined by the adapter and are listed in the adapter BAROC file. If any blank spaces are in the class name, enclose the class name in double quotation marks. Specifies the source of the event. If any blank spaces are in the source name, enclose the source name in double quotation marks.
source
f configuration_file Specifies the name of the configuration file. To send directly to the event
66
server, specify SOCKET transport in your configuration file. See the IBM Tivoli Enterprise Console Event Integration Facility Reference for more information about configuration files. m message The text of the event, in double quotation marks. r severity Specifies a severity. The severity must be one defined for the event class. S server Specifies the name of the event server in name registry format. Enter @EventServer to have events submitted to the locally named event server of the Tivoli Enterprise Console gateway. To indicate a remote server, specify @EventServertmr, where tmr is the name of a Tivoli region. If you do not specify the S or f option, the event is sent to the event server defined by the Tivoli Enterprise Console gateway. If portmapper is running on the event server, you can specify a TCP/IP host name or IP address instead. This results in non-Tivoli communication between the Tivoli Enterprise Console gateway and the event server.
Examples
The following example for UNIX environments sends a test message that displays an Su_Failure event of severity WARNING on the event consoles:
wpostzmsg -r WARNING m "su login failure." Su_Failure LOGFILE
See Also
postemsg, postzmsg, TECAgent, wpostemsg (endpoint version), wpostemsg (managed node version), wpostzmsg (managed node version), wsetemsg
Chapter 1. Commands
67
wpostzmsg (managed node version)

Posts an event to the event server using Tivoli managed node communication or non-Tivoli communication.
Syntax
wpostzmsg [S server | f configuration_file] [m message] [r severity] [attribute=value...] class source
Description
The wpostzmsg command sends an event to an event server using Tivoli managed node communication or non-Tivoli communication. This command requires the installation of the Tivoli Management Framework on the same system where you are running the command. This command can be found in the $BINDIR/bin directory. Note: Because cache files cannot be shared by applications, you should not use a configuration 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 Tivoli environment variables, which can be set using the setup_env.sh or setup_env.cmd scripts that are included in the installation.
Authorization
user
Options
source
f configuration_file Specifies the name of the configuration file. See the IBM Tivoli Enterprise Console Event Integration Facility Reference for more information about configuration files. m message The text of the event, in double quotation marks. r severity Specifies a severity. The severity must be one defined for the event class. S server Specifies the name of the event server in name registry format. The default value is @EventServer, the local event server. To indicate a remote server,
68
specify @EventServertmr, where tmr is the name of a Tivoli region. If no S or f option is specified, the event is sent to the locally named event server.
Examples
The following example for UNIX environments sends a test message that displays an Su_Failure event of severity WARNING on the event consoles:
wpostzmsg -r WARNING m "su login failure." Su_Failure LOGFILE
See Also
postemsg, postzmsg, TECAgent, wpostemsg (endpoint version), wpostemsg (managed node version), wpostzmsg (endpoint version), wsetemsg
Chapter 1. Commands
69
wrb
Manage rule bases at the event server.
Syntax
wrb [option [suboption]]
Description
Use the wrb command to manage rule bases. You can do such tasks as create, view information, manipulate, delete, compile, load, and activate rule bases with this command. 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 to the top-level rule base directory and to the following rule base 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. This access 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 a consistent state before the command completes. If the rule base is not consistent, the command displays an error message explaining the cause of the inconsistency. For a rule base to be consistent, the syntax of class sets and rule sets is verified, as well as references to those files in various rule base definition files. For a rule base to be in 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 to perform the task without checking rule base consistency first. When class definition files (with a file extension of .baroc) or rule set files (with a file extension of .rls) are being imported into a rule base, the name of the file
70
(including the extension) must be given. Once these objects have been imported into a rule base, you must use the logical name (that is, without the extension) in any command options. When importing an object into a rule base (for example, rule sets, event classes, rule packs into rule base targets, and so forth), an object that already exists in the rule base must be deleted before you can replace it with a newer version of the object. Each command option below specifies whether you must specify the name of 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 Developers Guide.
Authorization
user (region role for wrb command) The following table list the region roles for the wrb command options:
Command Option comprules cprb cprb classes cprb rulepacks cprb rulesets cprb targets crtrb crtrp crttarget deldp delrb delrbclass delrbpack delrbrule delrbtarget delrprule deltgtdata deltgtrule imprbclass imprbrule imprprule imptdp imptgtdata imptgtrule loadrb lscurrb lsrb Authorization user senior senior user senior user senior user user user senior senior user senior user user user user senior senior user user user user senior senior user
Chapter 1. Commands
71
Command Option lsrbclass lsrbpack lsrbrule lsrbtarget setrb
Authorization user user user user senior
Options
comprules [deprecation] [profile] [trace] rule_base Compile the rules in the rule base specified by the rule_base argument into Prolog object files that the rule engine can process. A directory for each rule base target is also created. Each directory contains a complete rule base that can be loaded by a rule engine. Inactive rule sets are not compiled. Note: If you do not compile the rule base before attempting to load it, you get an error message. rule_base The name of the rule base to compile. deprecation Issues a deprecation warning for every use of a deprecated BAROC or rule language feature. profile Enables profiling for the rule base while compiling. To enable or suppress profiling at the rule set or rule level within a rule base, see the profile directive information in the IBM Tivoli Enterprise Console Rule Developers Guide. trace Enables tracing for the rule base while compiling. To enable or suppress tracing at the rule set or rule level within a rule base, see the trace rule compiler directive information in the IBM Tivoli Enterprise Console Rule Developers Guide. cprb [classes] [rulesets] [rulepacks] [targets] [delete | overwrite] [force] source destination Copies an existing rule base to another existing rule base. If you do not specify any of the classes, rulesets, rulepacks, or targets arguments, the class sets, rule sets, rule packs, and rule base targets are all copied. The source rule base must be in a consistent state for it to be copied. You can skip consistency checking with the force argument. Notes: 1. When a rule set or rule pack is copied from another rule base, you must 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 base are also copied to the destination rule base. destination The name of the rule base to which information is copied. source The name of the rule base from which information is copied.
72
classes Copies event classes. delete Deletes all existing files from the destination rule base before writing information from the source rule base. force Forces the source rule base to be copied even if this can cause rule base inconsistency. overwrite Duplicate files are overwritten in the target rule base. The default action is that duplicate files are not copied. rulepacks Copies rule packs. rulesets Copies rule sets. targets Copies rule base targets. crtrb [path path] [force] rule_base Creates a rule base on the event server in the current Tivoli region. If an existing rule base is in path, the rule base is checked for consistency and that rule base is used. You can skip consistency checking with the force argument. A rule base target named EventServer is automatically created in the new rule base for the local event server. You can define multiple rule bases at the server, but only one can be loaded and active at a time. rule_base The name of the rule base to create. force Forces the rule base to be created in path even if it contains an existing rule base in an inconsistent state. path path The path where you want the new rule base located. If this argument is not specified, the rule base is created in the current working directory of the user. crtrp rule_pack [import rule_set ...] rule_base Creates 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_base The name of the rule base in which to create the rule pack. rule_pack The name of the rule pack to create. import rule_set ... The name of one or more optional rule sets to import into the new rule pack. Separate multiple rule set names with a space. Inactive rule sets cannot be imported into a rule pack. The rule sets are added to the rule pack in the order in which you specify on the command line. The rule sets being imported into the rule pack must first have been imported into the rule base. crttarget target [import {rule_pack | rule_set} ...] rule_base Creates a rule base target in the rule base. The rule base target represents the rule engine to which these rules are to be distributed. The local event
Chapter 1. Commands
73
server is represented by the rule base target EventServer. This rule base target is created automatically when a rule base is created. When the rule base is compiled, a complete rule base is generated for each rule base target in the rule base. The AIM server distributes and loads each rule base to the corresponding rule base target. rule_base The 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 to import. You can specify both rule sets and rule packs at once. However, rule sets and rule packs cannot have the same name within a rule base. Separate multiple rule sets and rule packs with a space. Inactive rule sets cannot be imported into a rule base target. Rule sets and rule packs are added to the rule base target in the order in which you specify on the command line. The rule set or rule pack being imported into the rule base target must first exist in the rule base. deldp file_name Deletes dependency relationships from the knowledge base. Before you issue the wrb deldp command, the event server must be running and the dependency.rls rule set should be loaded and active; for more information about the dependency.rls rule set, see the Tivoli Enterprise Console Rule Set Reference. Note: This option uses the wpostemsg utility to send the dependency information to the event server as events. You can define the configuration of the wpostemsg utility called by the deldp option by creating a configuration file named $BINDIR/bin/wrb_eif.conf. If this 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 default wpostemsg configuration is used, events are buffered and, although events are not sent to the event server, the wrb deldp command does not indicate any errors. file_name The name of a text file containing dependency statements to be removed from the knowledge base. For information about this file and about defining dependency relationships for the e-business rule set, see the Tivoli Enterprise Console Rule Set Reference. deltgtrule [rule_set | rule_pack] target rule_base Deletes a rule set or rule pack from a rule base target. rule_set The name of the rule set to delete. rule_pack The name of the rule pack to delete. target The name of the rule base target from which the rule set or rule pack is to be deleted.
rule_base The name of the rule base from which the target is to be modified.
74
delrb rule_base ... Delete one or more rule bases from the event server. Neither the rule base directory nor its contents are deleted. rule_base ... The name of the rule base to delete. You must specify at least one rule base. Separate multiple rule bases with a space. delrbclass class_file [force] rule_base Deletes a class file from a rule base. An error message is issued if any event classes in the class file are referenced by any other classes or by any rules. 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 for future use. class_file The name of the class file to delete from the rule base specified with rule_base. rule_base The name of the rule base from which the class file is to be deleted. force Deletes the class file even if it can cause rule base inconsistency. delrbpack rule_pack [force] rule_base Deletes a rule pack from a rule base. An error message is displayed if the rule pack to be deleted is defined in a rule base target. Specify the force argument to delete the rule pack anyway. rule_base The name of the rule base from which the rule pack is to be deleted. rule_pack The 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_base Deletes a rule set from a rule base. An error message is displayed if the rule set to delete is defined in a rule pack or a rule base target, or is inactive. Specify the force argument to delete the rule set anyway. Note: This option deletes the rule set file from a rule base for the specified rule set. Copy the rule set file to a different location to save a copy for future use. rule_base The name of the rule base from which the rule set is to be deleted. rule_set The name of the rule set to delete. force Delete the rule set even if it can cause rule base inconsistency. delrbtarget target rule_base Deletes a rule base target from a rule base. rule_base The name of the rule base from which the target is to be deleted.
Chapter 1. Commands
75
target
The name of the rule base target to delete.
delrprule rule_set rule_pack rule_base Deletes a rule set from a rule pack. rule_base The name of the rule base in which the rule pack exists. rule_pack The name of the rule pack from which the rule set is to be deleted. rule_set The name of the rule set to be deleted. deltgtdata data_file target rule_base Deletes a supporting data file from a rule base target. data_file Specifies the name of the file to be deleted from the named rule base target. This must be the full name of the file in the rule base directory. target Specifies the name of the rule base target from which to delete the data file.
rule_base Specifies 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 otherwise specified with arguments. An error message is displayed if the class set file contains syntax errors, references to nonexistent event classes or enumerations, or if duplicate event classes or enumeration are defined. If the classes in a class file are derived from classes in another file, import the class files into the rule base in an order that preserves the inheritance structure. For example, if class file B.baroc contains classes that are derived from class file A.baroc, you must import class file A.baroc first. class_file Specifies the name of the class file to import. This must be a path to BAROC file. rule_base The name of the rule base to receive the imported class set. after class_file Specifies the name of the class file after which the imported class file is to be placed. before class_file Specifies the name of the class file before which the imported class file is to be placed. encoding encoding Specifies the character encoding of the class file. If this option is not specified, a class file being imported into a rule base is opened in UTF-8 character encoding. For more information about international encodings, see Notes on page 80. force Imports the class file even if it can cause rule base inconsistency.
76
imprbrule rule_file [encoding encoding ] [force] rule_base Imports a rule set file into the rule base. Because rule sets that have been imported into the rule base must then be imported into a rule base target before they are run, the order that rule sets are imported into the rule base is not important. The order in which rule sets are imported into a rule base target specifies the order in which that particular rule engine runs the rules. An error message is displayed if the rule being imported references a non-existent event class. You can skip this consistency checking by using the force argument. rule_base The name of the rule base to receive the imported rule set file. rule_file The file name of the rule set to import to the rule base. This must be a path to a rule set file (with a file extension of .rls). encoding encoding Specifies the character encoding of the class file. If this option is not specified, a class file being imported into a rule base is opened in UTF-8 character encoding. For more information about international encodings, see Notes on page 80. force Adds the rule set to the rule base even if a rule references a non-existent event class. imprprule rule_set [before rule_set | after rule_set] rule_pack rule_base Imports a rule set into a rule pack for the specified rule base. Inactive rule sets are not imported into rule packs. rule_base The name of the rule base in which the rule pack lives. rule_pack The name of the rule pack to receive the imported rule set. The rule pack must have been created with the crtrp command option first. rule_set The name of the rule set to import into the rule pack. The rule set must have been imported into the rule base first. after rule_set Specifies the name of the rule set after which the imported rule set is to be placed. before rule_set Specifies the name of the rule set before which the imported rule set is to be placed. imptdp file_name Loads dependency relationships into the knowledge base. Before you issue the wrb imptdp command, the event server must be running and the dependency.rls rule set should be loaded and active; for more information about the dependency.rls rule set, see the Tivoli Enterprise Console Rule Set Reference. Note: This option uses the wpostemsg utility to send the dependency information to the event server as events. You can define the configuration of the wpostemsg utility called by the imptdp option by creating a configuration file named $BINDIR/bin/wrb_eif.conf. If
Chapter 1. Commands
77
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 the default wpostemsg configuration is used, events are buffered and, although events are not sent to the event server, the wrb imptdp command does not indicate any errors. file_name The name of a text file containing dependency statements to be added to the knowledge base as dependency facts. For information about this file and about defining dependency relationships for the e-business rule set, see the Tivoli Enterprise Console Rule Set Reference. imptgtdata data_file target rule_base Imports a supporting data file to a rule base to be distributed to a rule base target. This file is distributed with the rule base in the TEC_RULES subdirectory. For example, an Event Integration Facility configuration file or a Prolog fact or data file might be imported as a supporting data file. data_file Specifies the name of the file to be imported to the named rule base target. This must be a path to the file. target Specifies the name of the rule base target to receive the imported data file.
rule_base Specifies the name of the rule base that contains the target. imptgtrule {rule_set | rule_pack} [{before | after} {rule_set | rule_pack}] target rule_base Imports a rule set or rule pack into a rule base target. Rule sets and rule packs within a rule base cannot have the same name. Inactive rule sets are not imported into rule base targets. rule_base The name of the rule base that contains the rule base target. rule_pack The name of the rule pack to import. The rule pack must have been imported into the rule base first. rule_set The name of the rule set to import. The rule set must have been imported into the rule base first. target The name of the rule base target to receive the imported rule set or rule pack. You must have first created the target with the crttarget command option.
after rule_set | rule_pack Specifies the name of the rule set or rule pack after which the imported rule set or rule pack should be located. before rule_set | rule_pack Specifies the name of the rule set or rule pack before which the imported rule set or rule pack should be located. loadrb [use] rule_base Loads a rule base onto the event server. This makes rule_base the currently active rule base on the event server. The rule base must already be defined
78
at the server, and any event class specification files and rule files in the directory must be valid. The loaded rule base replaces all event class specifications and rules currently defined at the server. Only one rule base can be active at a time. Loading another rule base overwrites the currently active rule base. If you do not compile the rule base before attempting to load it, you receive an error message. Note: If you do not compile the rule base before attempting to load it, you get an error message. rule_base The name of the rule base to load. use Activates the rule base immediately upon loading. If event class changes were made to the rule base, restart the event server after loading for the event class changes to take affect.
lscurrb Lists the name of the currently loaded rule base. lsrb [path] [rule_base ...] Lists the rule bases that are currently defined on the event server. Many rule bases can be defined on the event server, though only one can be loaded and active. Use the wrb lscurrb command to display the currently loaded rule base. A rule base has a unique name and a path name that points to a directory that contains event class definition files (with a file extension 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_base Specifies the names of individual rule bases or a Perl regular expression. 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 base name. The default action is that only the name of the rule base is displayed.
lsrbclass [class_name ...] [detailed] rule_base Lists the event classes in the specified rule base. Use regular expressions to restrict the list of event classes to be displayed. class_name ... Specifies the names of individual event classes or a Perl regular expression. This argument restricts the list of classes shown. The default action is that all event classes in the specified rule base are displayed. Separate multiple event class names with a space. rule_base The name of the rule base to view. detailed Specifies detailed output. Displays class names and all slot values for each class. lsrbpack [rule_pack ...] [detailed] rule_base Lists the names of the rule packs in the specified rule base. rule_base The name of the rule base to view.
Chapter 1. Commands
79
rule_pack ... The name of a particular rule pack or a Perl regular expression. If you do not specify this argument, all rule packs are displayed. Separate multiple rule packs with a space. detailed Lists the rule sets in each rule pack. lsrbrule [rule_file ...] rule_base Lists the names of the rule set files which have been imported into the specified rule base. Use regular expressions to restrict the list of rules to be displayed. rule_base The name of the rule base to view. rule_file ... The name of a specific rule set file or a Perl regular expression. If you do not specify this argument, all rule set files are displayed. Separate multiple rule set file names with a space. lsrbtarget [target ...] [detailed] rule_base Lists the names of the rule base targets in the specified rule base. rule_base The name of the rule base to view. target ... The name of a particular rule base target or a Perl regular expression. If you do not specify this argument, all targets in the rule base are displayed. Separate multiple targets with a space. detailed Lists the rule sets and rule packs for each target. setrb [name name] [path path [force]] rule_base Sets properties of an existing rule base. You can change the name, the directory containing rule base files, or both. If a new path is specified and an existing rule base is in path, the rule base is checked for consistency. You can skip consistency checking with the force argument. rule_base The name of the rule base to be modified. force Forces the path to be changed to path even if it contains an existing rule base in an inconsistent state. name name The new name for the rule base. path path Specifies a new rule base directory for the rule base.
Notes
Different operating systems often encode text in different ways. For example, PC operating systems use SJIS (code page 932) for Japanese text, but UNIX systems often use EUC_JP. If you are importing an event class specification (BAROC) file or rule 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 on the wrb imprbclass or wrb imprbrule command. You can specify any of the following character encodings. ASCII American Standard Code for Information Interchange
80
Cp1252 ISO8859_1 UTF-16BE UTF-16LE UTF-8 UTF-16 Big5 Big5_HKSCS Cp037 Cp273 Cp277 Cp278 Cp280 Cp284 Cp285 Cp297 Cp420 Cp424 Cp437 Cp500 Cp737 Cp775 Cp838 Cp850 Cp852 Cp855 Cp856 Cp857 Cp858 Cp860 Cp861 Cp862 Cp863 Cp864 Cp865 Cp866 Cp868 Cp869 Cp870 Cp871 Cp874 Cp875 Cp918 Cp921 Cp922 Cp930 Cp933 Cp935 Cp937 Cp939 Cp942 Cp942C Cp943 Cp943C
Windows Latin-1 ISO 8859, Latin alphabet number 1 16bit Unicode Transformation Format, big-endian byte order 16bit Unicode Transformation Format, little-endian byte order 8bit Unicode Transformation Format 16bit Unicode Transformation Format, byte order specified by a mandatory initial byte-order mark Big5, Traditional Chinese Big5 with Hong Kong extensions, Traditional Chinese USA, Canada (bilingual, French), Netherlands, Portugal, Brazil, Australia IBM Austria, Germany IBM Denmark, Norway IBM Finland, Sweden IBM Italy IBM Catalan/Spain, Spanish Latin America IBM United Kingdom, Ireland IBM France IBM Arabic IBM Hebrew MS-DOS United States, Australia, New Zealand, South Africa EBCDIC 500V1 PC Greek PC Baltic IBM Thailand extended SBCS MS-DOS Latin-1 MS-DOS Latin-2 IBM Cyrillic IBM Hebrew IBM Turkish Variant of Cp850 with Euro character MS-DOS Portuguese MS-DOS Icelandic PC Hebrew MS-DOS Canadian French PC Arabic MS-DOS Nordic MS-DOS Russian MS-DOS Pakistan IBM Modern Greek IBM Multilingual Latin-2 IBM Iceland IBM Thai IBM Greek IBM Pakistan (Urdu) IBM Latvia, Lithuania (AIX, DOS) IBM Estonia (AIX, DOS) Japanese Katakana-Kanji mixed with 4370 UDC, superset of 5026 Korean mixed with 1880 UDC, superset of 5029 Simplified Chinese Host mixed with 1880 UDC, superset of 5031 Traditional Chinese Host mixed with 6204 UDC, superset of 5033 Japanese Latin Kanji mixed with 4370 UDC, superset of 5035 IBM OS/2 Japanese, superset of Cp932 Variant of Cp942 IBM OS/2 Japanese, superset of Cp932 and Shift-JIS Variant of Cp943
Chapter 1. Commands
81
OS/2 Chinese (Taiwan), superset of 938 PC Korean Variant of Cp949 PC Chinese (Hong Kong, Taiwan) AIX Chinese (Taiwan) AIX Korean IBM AIX Pakistan (Urdu) IBM Multilingual Cyrillic: Bulgaria, Bosnia, Hezegovina, Macedonia (FYR) Cp1026 IBM Latin-5, Turkey Cp1046 IBM Arabic Windows Cp1097 IBM Iran (Farsi)/Persian Cp1098 IBM Iran (Farsi)/Persian (PC) Cp1112 IBM Latvia, Lithuania Cp1122 IBM Estonia Cp1123 IBM Ukraine Cp1124 IBM Aix Ukraine Cp1140 Variant of Cp037 with Euro character Cp1141 Variant of Cp273 with Euro character Cp1142 Variant of Cp277 with Euro character Cp1143 Variant of Cp278 with Euro character Cp1144 Variant of Cp280 with Euro character Cp1145 Variant of Cp284 with Euro character Cp1146 Variant of Cp285 with Euro character Cp1147 Variant of Cp297 with Euro character Cp1148 Variant of Cp500 with Euro character Cp1149 Variant of Cp871 with Euro character Cp1250 Windows Eastern European Cp1251 Windows Cyrillic Cp1253 Windows Greek Cp1254 Windows Turkish Cp1255 Windows Hebrew Cp1256 Windows Arabic Cp1257 Windows Baltic Cp1258 Windows Vietnamese Cp1381 IBM OS/2, DOS Peoples Republic of China (PRC) Cp1383 IBM AIX Peoples Republic of China (PRC) Cp33722 IBM-eucJP Japanese (superset of 5050) EUC_CN GB2312, EUC encoding, Simplified Chinese EUC_JP JIS X 0201, 0208, 0212, EUC encoding, Japanese EUC_JP_LINUX JIS X 0201, 0208, EUC encoding, Japanese EUC_KR KS C 5601, EUC encoding, Korean EUC_TW CNS11643 (Plane 13), EUC encoding, Traditional Chinese GBK GBK, Simplified Chinese ISO2022CN ISO 2022 CN, Chinese (conversion to Unicode only) ISO2022JP JIS X 0201, 0208 in ISO 2022 form, Japanese ISO2022KR ISO 2022 KR, Korean ISO8859_2 ISO 88592, Latin alphabet number 2 ISO8859_3 ISO 88593, Latin alphabet number 3 ISO8859_4 ISO 88594, Latin alphabet number 4 ISO8859_5 ISO 88595, Latin/Cyrillic alphabet ISO8859_6 ISO 88596, Latin/Arabic alphabet ISO8859_7 ISO 88597, Latin/Green alphabet ISO8859_8 ISO 88508, Latin/Hebrew alphabet ISO8859_9 ISO 88599, Latin alphabet number 5 Cp948 Cp949 Cp949C Cp950 Cp964 Cp970 Cp1006 Cp1025
82
ISO8859_13 ISO 885913, Latin alphabet number 7 ISO8859_15_FDIS ISO 885915, Latin alphabet number 9 JIS0201 JIS X 0201, Japanese JIS0208 JIS X 0208, Japanese JIS0212 JIS X 0212, Japanese JISAutoDetect Detects and converst from Shift-JIS, EUC-JP, ISO 2022 JP (conversion to Unicode only) Johab Johab, Korean KOI8_R KOI8R, Russian MS874 Windows Thai MS932 Windows Japanese MS936 Windows Simplified Chinese MS949 Windows Korean MS950 Windows Traditional Chinese MacArabic Macintosh Arabic MacCentralEurope Macintosh Latin-2 MacCroatian Macintosh Croatian MacCyrillic Macintosh Cyrillic MacDingbat Macintosh Dingbat MacGreek Macintosh Greek MacHebrew Macintosh Hebrew MacIceland Macintosh Iceland MacRoman Macintosh Roman MacRomania Macintosh Romania MacSymbol Macintosh Symbol MacThai Macintosh Thai MacTurkish Macintosh Turkish MacUkraine Macintosh Ukraine SJIS Shift-JIS, Japanese TIS620 TIS620, Thai
Examples
The 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 base MyRuleBase 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 base MyRuleBase and imports the rule sets ov_default.rls and log_default.rls into the newly 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 SAPServer rule base target:
Chapter 1. Commands
83
wrb -imptgtrule DefaultRules SAPServer \ MyRuleBase
The following example imports the rule set tecad_snaevent.rls into the SAPServer rule 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 in the 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 its rule base as follows:
wrb -delrbrule all_instances MyRuleSet
The following example copies everything over, which includes the class sets, rule sets, 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
wrb_default_rb
Deactivates active rule sets in the default rule base.
Syntax
wrb_default_rb inactivate rulesets
Description
The wrb_default_rb command deactivates any of the rule sets in the default rule base 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 to the ebusiness rule set and can be changed only by changing the activity of the ebusiness rule set; that is, to deactivate the dependency rule set, you must deactivate the ebusiness rule set.
Authorization
None
Options
rulesets Specifies the names of the rule sets to be deactivated. To deactivate more than one rule set, insert blank spaces between the names.
Examples
The following example deactivates the netview and heartbeat rule sets:
wrb_default_rb -inactivate netview heartbeat
Chapter 1. Commands
85
wrbupgrade
Upgrades rule bases and BAROC files created with Tivoli Enterprise Console versions 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 than in the standard location ($BINDIR/BIN) for other Tivoli Enterprise Console commands. When working with a rule base that was created by someone else, you must have read and write access to the top-level rule base directory and to the following rule base 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.
Syntax
wrbupgrade [ f p path_to_rulebase | n rulebase_name]
Description
You need to run the wrbupgrade command only if you want to use rule packs and rule base targets with rule bases that were created with Tivoli Enterprise Console versions prior to version 3.7. You do not need to run this command to use the wrb command.
Authorization
user
Options
f Specifies that the wrbupgrade command should be run even if the specified rule base has already been upgraded. This option is valid only with the -p path_to_rulebase option.
n rulebase_name Specifies the name of the rule base to upgrade. p path_to_rulebase Specifies the path to the rule base to upgrade.
86
wsendresp
Displays a message on the desktop of the operator.
Syntax
wsendresp operator [host:]filepath
Description
Sends the contents of the specified file in a pop-up window to the specified console. The wsendresp command can also be issued by a rule to display a message to an operator. For example, when a HOST_DOWN event is acknowledged, a rule can issue the wsendresp command to inform an operator of the proper course of action for the affected host. For this command to run successfully, the event server and the console of the specified operator must be running.
Authorization
admin
Options
[host:]filepath Specifies the path name of the file containing the preferred message. You can optionally specify the host that contains the file. Note: You must use forward slash characters (/) for directory separators in the filepath argument. operator Specifies the name of a Tivoli Enterprise Console operator.
Examples
The 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
wsetac
Modifies an adapter configuration record for an adapter configuration profile.
Syntax
wsetac adapter_details key profile
Description
The wsetac command enables an existing record in an adapter configuration profile to be modified. Each adapter type on each adapter configuration profile might be supported by default policies to supply initial values for parts of the configuration not given by a waddac call. Similarly, validation policies might be present to ensure that a given configuration 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 configuration record to standard out. The key value later can be used to modify or remove the record.
Authorization
admin
Options
adapter_details Gives the specific adapter configuration information such as distribution paths, user IDs, and adapter filtering that are used for the distribution parameters 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 of completely replacing current values. Note that the presence of a affects all e, f, D, and b arguments on a given call of the command. If some of those attributes are to be replaced and others augmented, then several calls of the command are necessary. When a is present and new values are added to one or more of the list-type attributes, duplicates are removed as appropriate to the nature of those attributes modified. For the environment and behavior attributes, duplicate assignments to the same variable are eliminated (with new assignments overriding old, of course). For distribution actions, multiple copies onto the same path name are removed. For filters, duplicate entries are removed. b flag=value Sets the given endpoint behavior flag to the given value. Endpoint behavior flags are interpreted during special situations when profiles are distributed, for example when processing a record marked as having been deleted. The specific flags supported vary by endpoint, but those currently supported include the following flags:
88
action_fail Controls the handling of failures of !command and !!command distribution requests. Values are: ignore Ignore all failures. report Report failures but continue with distribution activity, the default behavior. abort expand Controls whether references to endpoint context variables of the form $variable within attributes of the record should be expanded by the endpoint code when the profile is distributed. The value of the variable can be no to disable expansion, yes to enable it for all attributes (the default behavior), or a comma-separated list of attribute names to selectively expand only within the values of those attributes. rm_on_del Instructs the endpoint code whether to remove configuration files and distributed files when the record is distributed after being removed. The value can be yes (to force removal, the default behavior), no (to disable removal and thus leave files in place after record deletion), or conf (to remove only the primary adapter configuration file). run_actions Controls whether !command and !!command distribution requests are performed. The value can be yes 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 endpoint code. c comment Comment text to be associated with the new adapter configuration profile record. The comment text is written into the configuration file when it is created the next time the profile is distributed. D destination=source Requests that the source file be distributed to the destination file on each subscribing host when the profile is distributed. If the destination name does not begin with a slash character, then the actual file name is formed by appending destination to the target directory as given by a d option (or from policy defaults). Instead of the destination=source form for a distribution request, the string can be of the form !command or !!command. The given command, which can be any valid statement for the operating system-dependent command line interpreter present on subscriber nodes (generally, /bin/sh, however on non-UNIX operating systems 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. Stop distribution.
Chapter 1. Commands
89
d dir The directory on subscribing nodes to which the adapter configuration files should be distributed. e name=value Defines an environment variable to be placed in the adapter configuration file. As many e arguments as wanted can be given to arrange for an arbitrary number of environment variables to be created. Some environment variables are understood directly by the event adapter libraries and control basic adapter operation. Other variables can be used at a higher level by specific adapters. f filter Defines an event filter to be placed in the adapter configuration file. 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 to prevent the command-line interpreter from reacting to the semicolons. To create a filter that is initially in a disabled state, the string 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_cache Defines an event filter cache to be placed in the adapter configuration file. The filter_cache string must be in the following form: Attribute=Value;Attribute=Value;Attribute=Value;... The entire string needs to be enclosed in quotation marks to prevent the command-line interpreter from reacting to the semicolons. To create a filter cache that is initially in a disabled state, 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 on subscriber endpoints. The gid can be given as a name or numeric value. i on|off[,idname] Specifies whether the adapter should be assigned a unique identifier and what identifier to use. Use this option when running multiple adapters on the same system to assign unique identifiers to the adapters. Specify on|off to indicate whether to use an identifier, and specify idname to indicate the identifier to be used. If you specify i on without idname, the previously defined identifier
90
is used. If you specify i off with idname, the configuration record contains the ID but the adapter does not have an ID after you distribute the profile. m prefiltermode Defines the PreFilterMode to be placed in the adapter configuration file for Windows and NetWare adapters. The valid values are IN, in, OUT, and out. The default value is OUT. If you use IN or in, you must also supply the p parameter to specify a PreFilter. The following example shows a command using this argument:
wsetac -a -m OUT -p Log=System 1 ACPprofile
wsetac -a -p Log=Security 1 ACPprofile
t target The name of the primary adapter configuration file, commonly known as the CONF file. The complete file name for this file is formed by appending target to the value given for dir with a d option. (Note that default policy generally is established to set target and targdir to appropriate values.) u uid The user ID value to be used for distributed files and commands on subscriber endpoints. The uid can be given as a name or numeric ID value. key Gives the key of the existing adapter configuration record to modify. You can see the key value in the upper right side of the adapter configuration profile entry panel or by using the wlsac command. The adapter configuration profile to which the new adapter configuration record is to be added. If the name includes spaces, enclose the whole name in quotation marks.
profile
Examples
The following example changes the ServerLocation value in the CONF file to quasar for key 0 in the adapter configuration profile named quasar:
wsetac -e ServerLocation=quasar 0 @ACP:quasar
See Also
waddac, wdelac, wlsac, wsetaddflt
Chapter 1. Commands
91
wsetaddflt
Adds or sets an adapter configuration record for an adapter configuration profile or an adapter type default.
Syntax
wsetaddflt adapter_details type
Description
The wsetaddflt command also creates or modifies an adapter configuration profile record, but instead of installing it on a profile object, the record is installed as the global default record for the given event adapter type. The values of the attributes in the record can be fetched later with the wlsaddflt command from within policy scripts to obtain the basic default information for an adapter type. Policy scripts can then apply filtering or modifications. Each adapter configuration profile contains the following configuration information for one or more event adapters: v Location of configuration files v Adapter environment variable definitions, including such things as the location of the event server v Event filter definitions v Additional file distribution requests Each adapter type on each adapter configuration profile might be supported by default policies to supply initial values for parts of the configuration not given by a waddac call. Similarly, validation policies might be present to ensure that a given configuration is valid according to the needs of the event adapter implementation, local installation particulars, and security concerns.
Authorization
senior
Options
adapter_details Gives the specific adapter configuration information such as distribution paths, user IDs, and adapter filtering that are used for the distribution parameters 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 of completely replacing current values. Note that the presence of a affects all e, f, D, and b arguments on a given call of the command. If some of those attributes are to be replaced and others augmented, then several calls of the command are necessary. When a is present and new values are added to one or more of the list-type attributes, duplicates are removed as appropriate to the nature of those attributes modified. For the environment and behavior attributes, duplicate assignments to the same variable are eliminated (with new assignments overriding old, of course). For distribution actions, multiple copies onto the same path name are removed. For filters, duplicate entries are removed.
92
(The a option is for wsetac and wsetaddflt.) b flag=value Sets the given endpoint behavior flag to the given value. Endpoint behavior flags are interpreted during special situations when profiles are distributed, for example when processing a record marked as having been deleted. The specific flags supported vary by endpoint, but those currently supported include the following flags: action_fail Controls the handling of failures of !command and !!command distribution requests. Values understood are: ignore Ignore all failures. report Report failures but continue with distribution activity, the default behavior. abort expand Controls whether references to endpoint context variables of the form $variable within attributes of the record should be expanded by the endpoint code when the profile is distributed. The value of the variable can be no to disable expansion, yes to enable it for all attributes (the default behavior), or a comma-separated list of attribute names to selectively expand only within the values of those attributes. rm_on_del Instructs the endpoint code whether to remove configuration files and distributed files when the record is distributed after being removed. The value can be yes (to force removal, the default behavior), no (to disable removal and thus leave files in place after record deletion), or conf (to remove only the primary adapter configuration file). run_actions Controls whether !command and !!command distribution requests are performed. The value can be yes 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 endpoint code. c comment Comment text to be associated with the new adapter configuration profile record. The comment text is written into the configuration file when it is created the next time the profile is distributed. D destination=source Requests that the source file be distributed to the destination file on each subscribing host when the profile is distributed. If the destination name does not begin with a slash character, then the actual file name is formed by appending destination to the target directory as given by a d option (or from policy defaults). Stop distribution.
Chapter 1. Commands
93
Instead of the destination=source form for a distribution request, the string can be of the form !command or !!command. The given command, which can be any valid statement for the operating system-dependent command line interpreter present on subscriber nodes (generally, /bin/sh, however on non-UNIX operating systems 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 adapter configuration files should be distributed. e name=value Defines an environment variable to be placed in the adapter configuration file. As many e arguments as wanted can be given to arrange for an arbitrary number of environment variables to be created. Some environment variables are understood directly by the event adapter libraries and control basic adapter operation. Other variables can be used at a higher level by specific adapters. f filter Defines an event filter to be placed in the adapter configuration file. 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 to prevent the command-line interpreter from reacting to the semicolons. To create a filter that is initially in a disabled state, the string 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_cache Defines an event filter cache to be placed in the adapter configuration file. The filter_cache string must be in the following form: Attribute=Value;Attribute=Value;Attribute=Value;... The entire string needs to be enclosed in quotation marks to prevent the command-line interpreter from reacting to the semicolons. To create a filter cache that is initially in a disabled state, 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 on subscriber endpoints. The gid can be given as a name or numeric value.
94
i on|off[,idname] Specifies whether the adapter should be assigned a unique identifier and what identifier to use. Use this option when running multiple adapters on the same system to assign unique identifiers to the adapters. Specify on|off to indicate whether to use an identifier, and specify idname to indicate the identifier to be used. If you specify i on without idname, the previously defined identifier is used. If you specify i off with idname, the configuration record contains the ID but the adapter does not have an ID after you distribute the profile. m prefiltermode Defines the PreFilterMode to be placed in the adapter configuration file for Windows and NetWare adapters. The valid values are IN, in, OUT, and out. The default value is OUT. If you use IN or in, you must also supply the p parameter to specify a PreFilter. The following example shows a command using this argument:
wsetaddflt -a -m OUT -p Log=System 1 ACPprofile
wsetaddflt -a -p Log=Security 1 ACPprofile
t target The name of the primary adapter configuration file, commonly known as the CONF file. The complete file name for this file is formed by appending target to the value given for dir with a d option. (Note that default policy generally is established to set target and targdir to appropriate values.) u uid User ID value to be used for distributed files and commands on subscriber endpoints. The uid can be given as a name or numeric ID value. type Gives the adapter type for the new adapter or (for wsetaddflt) the adapter type whose global defaults are to be set. The adapter type is generally used to drive the workings of default and validation policies. If unknown adapter types are given to waddac, validation policies on the target adapter configuration profile might reject the new record. To see the available types, use the wlsaddflt command.
Examples
1. The following example sets the default values for type tecad_hpov:
wsetaddflt -d -t -c -e -e -e -e -e -D -D \ $TECADHOME/etc \ "tecad_hpov.conf" \ "tecad_hpov Configuration" \ "ServerLocation=@EventServer" \ "EventMaxSize=4096" \ "WellBehavedDaemon=TRUE" \ BufEvtPath=$TIVOLIHOME/tec/${AC_TYPE}.cache \ HPOVFilter={CORR{default}} .* \ "!/opt/OV/bin/ovstop tecad_hpov" \ "tecad_hpov.cds=$ACPHOST:$REPOSITORY/tecad_hpov.cds" \
Chapter 1. Commands
95
-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 have created 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 all adapters:
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__ adapter configuration profile default definition, as this is the base definition for all adapter types.
See Also
waddac, wdelac, wlsac, wsetac
96
wsetadenv
Installs a list of recognized Event Integration Facility environment variables for an adapter type.
Syntax
wsetadenv [a] variable_name... type
Description
The wsetadenv command provides the Adapter Configuration Facility with a list of the Event Integration Facility environment variables that are recognized by the adapter but are not part of the common set of variables used directly by the Event Integration Facility. The variable names registered with wsetadenv are made available to users of the Adapter Configuration Facility graphical user interface when configuring environment variable lists. The list can also be used by profile validation scripts. The Adapter Configuration Facility itself installs the list of basic Event Integration Facility variables under the type __generic__. This list should not be modified.
Authorization
senior
Options
type The adapter type. If no environment or other type information has yet been installed, then wsetadenv automatically registers the type. To see the available types, use the wlsaddflt command.
variable_name... Zero or more variables recognized by the given adapter type. It is not wrong to install any of the standard Event Integration Facility variables here, but it is unnecessary. Separate multiple variable_names with a space. a Instructs wsetadenv to append the variable names to the list already configured for the given adapter type. Typically, wsetadenv completely replaces an existing list.
Examples
The following example adds the environment variables SNMP_PORT and SNMP_TRAP_PORT to the SNMP adapter:
wsetadenv SNMP_PORT SNMP_TRAP_PORT tecad_snmp
See Also
wlsadenv, waddac, wsetadgui, wsetadval
Chapter 1. Commands
97
wsetadgui
Installs a link from the Adapter Configuration Facility graphical user interface (GUI) to a type-specific configuration tool.
Syntax
wsetadgui class name catalog text key type
Description
The wsetadgui command provides the Adapter Configuration Facility with the name of an object that supplies a standard interface for performing extended type-specific graphical configuration. The command also supplies a label to be used on the launch button on the Adapter Configuration Facility GUI that the user can click to start the extended configuration tools. Because Tivoli Enterprise Console event adapters can vary widely in their nature and scope, the Adapter Configuration Facility itself does not attempt to provide configuration tools for any details beyond the common subset of Event Integration Facility configuration. However, because graphical configuration tools might be wanted for a variety of adapter types, the Adapter Configuration Facility graphical interface can effectively be extended by constructing a configuration tool for a specific adapter and then hooking it up to the Adapter Configuration Facility with wsetadgui. A type-specific configuration tool must be implemented as a method on a Tivoli Enterprise object. The method must be called acf_extension and must match the following IDL signature:
TMF_CCMS::Database::nmval_list acf_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 method upon user request, passing the method the profile record as currently configured along with the record key and the profile name. The user interface server environment is also passed so that the configuration tools know where to present the dialogs. The extended configuration tool can perform any necessary modifications to the record, returning a new version of the record when finished. Usually, environment variables and distribution requests are the attributes of the record most commonly modified, but anything can be modified.
Authorization
senior
Options
catalog 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 key name The name of the Tivoli Enterprise class of which the configuration object is a member. The message catalog key for the launch button label. The name of the configuration object (the object that supports the acf_extension method for the adapter type).
98
text type
The default text for the launch button label, used if the catalog cannot be found. The adapter type. If no environment or other type information has yet been installed, then wsetadenv automatically registers the type. To see the available types, use the wlsaddflt command.
Examples
The following example adds the Logfile Format Editor to the Tivoli Enterprise Console server GUI:
wsetadgui LogfileConfiguration LogfileConfiguration _x_ \ "Logfile Format Editor..." 1 tecad_logfile
See Also
wlsadgui, waddac, wsetadenv, wsetadval
Chapter 1. Commands
99
wsetadval
Installs validation information for an adapter type.
Syntax
wsetadval file attribute type
Description
The wsetadval command informs the Adapter Configuration Facility that the named file contains validation information to be used in validating the value of the named attribute on adapter configuration profile records. Generally, the validation information consists of all or part of a script of some kind. Validation policy scripts installed on adapter configuration profiles can later extract and use the installed validation information. The simplest form of an adapter configuration profile validation script is as follows:
#!/bin/sh wlsadval "$1" "$2" | sh s "$3"
Under this scheme the contents of the validation record are used directly as the real validation script. The policy method is written so that it expects the attribute name passed in as the first argument, and the record type as the second; see the manual page for the wlsadval command. The third argument is the value to be validated, and that is transmitted to the installed script. Other ways of using the facility supplied by wsetadval are possible. Whatever mechanism is chosen, however, should be used consistently by all adapter types so that policy scripts stored on profile objects scattered throughout the installation can remain generic. As shipped, the Adapter Configuration Facility validation policies expect that the installed adapter validation information is shell scripts.
Authorization
senior
Options
attribute The name of the attribute to which the validation information applies. The attributes on an adapter configuration profile typically are as follows: ACPbhv Sequence of profile behavior variables, separated by newlines. ACPcomment Comment field. ACPdist Sequence of distribution requests, separated by newlines. ACPev Sequence of environment variables, separated by newlines ACPflt Sequence of filter definitions, separated by newlines.
100
ACPgid Group ID for endpoint actions. ACPtargdir The configuration installation directory. ACPtarget The target primary configuration file name. ACPtype The type of the record; this generally needs no validation. ACPuid The user ID for endpoint actions. Other attributes might be present if they are added to the profile with Tivoli AEF tools. file Name of the file containing the validation information. If file is a single dash, then wlsadval reads the validation information from its standard input. The adapter type for which the validation information is to be installed. To see the available types, use the wlsaddflt command.
type
Examples
The following example adds the validation information from the script infile to the attribute ACPuid for an adapter of type tecad_logfile_hpux10:
wsetadval - ACPuid tecad_logfile_hpux10 <<\infile case "$1" in 0 root ) exit 0;; *) exit 1;; esac infile
See Also
wlsadval, waddac, wsetadenv, wsetadgui
Chapter 1. Commands
101
wsetaeenv
Modifies environment variables stored on adapter configuration profile endpoints.
Syntax
wsetaeenv [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 an endpoint. The wsetaeenv command enables the list of adapter configuration environment variables stored on a profile endpoint object to be set or modified. The new values are used during the next adapter configuration profile distribution to the named endpoint. Adapter configuration profiles use the environment information stored on endpoints by referring to them in record field values. References to environment variables are of the form $[name]. When the profile is received at the endpoint during distribution, the environment variable references are expanded so that the actual 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 page for the waddac commands.) In addition to the environment variables established under user control with wsetaeenv, some variables are created automatically by the adapter configuration endpoint code. These variables describe the endpoint object, the adapter configuration profile containing the record where a reference is made, and the record itself. These automatic environment variables are available for use in exactly the same way user-controlled variables are. The list of automatic environment variables is as follows: ACPEP_NAME The name of the endpoint object. Most commonly, the endpoint object is a Tivoli managed node object. ACPEP_CLASS The class name of the endpoint object. ACPEP_OID The object identifier of the endpoint object. ACPEP_NODE The object ID for the managed node where the endpoint resides. In the common case that the endpoint is the managed node, then this object ID is of course the same as ACPEP_OID. ACP_NAME The name of the adapter configuration profile containing the record where a reference to the variable is made. ACP_ADMIN The user name of the administrator responsible for distributing the profile.
102
ACP_PRFMGR The name of the profile manager object from which the profile was distributed. (Note that this might be the name of a profile endpoint object, in which case it would be the same as ACPEP_NAME.) AC_TYPE The type of the record containing the variable reference. AC_ACTION The activity being performed for the record, either UPDATE or DELETE. AC_KEY The record key of the record containing the variable reference. AC_TARGDIR The contents of the target directory field of the record containing the variable reference. The automatic environment variables are refigured as each record of the profile is processed (though clearly the ACPEP variables do not change), so, for example, references to AC_TYPE in three records of a single profile yield three different values if the records are of differing types.
Authorization
senior
Options
endpoint The name of the endpoint object to be modified. The endpoint object can be referenced with the standard @Classname:label notation. If the standard notation is not used, endpoint is assumed to be a reference to a managed node object. name=value ... Creates an environment variable name with the given value on the named endpoint. Separate multiple name=value expressions with a space. a Indicates that the environment variable assignments should be added to the list already on the endpoint object (except that duplicates are avoided). Without a, the list of variables given on the command line becomes the new list on the endpoint, and all former variables are removed. If no new variables are listed but one or more d options are given, then the d options are processed and other variables are left unchanged. If no new variables are given and no d options are present, then the entire user-controlled environment of the endpoint object is cleared.
d name ... Deletes the named variable from the endpoint. Many d options can be given. Separate multiple names with a space. i file Directs that the list of environment variables to be installed on the endpoint should be read from the named file instead of from the command line. Variable definitions should be in the file, one per line. If file is a single dash, then the list is read from the standard input to wsetaeenv.
Examples
The following example adds the environment variable BufEvtMaxSize to the profile endpoint object of endpoint boston-box:
Chapter 1. Commands
103
wsetaeenv -a BufEvtMaxSize=500000 @Endpoint:boston-box
See Also
waddac, wdelac, wdistrib (in the IBM Tivoli Management Framework Reference Manual), wlsaeenv
104
wsetemsg
Modifies an event.
Syntax
wsetemsg [t status [f] [r severity] [attribute=value...] console event_ID
Description
The wsetemsg command modifies the status, severity, or other attribute values of an existing event. You must specify the event by the console that received it as well as its event ID number, and you must be assigned as an operator to that console. Use the wlsemsg command to display a list of the event ID numbers.
Authorization
The authorization role required depends on which flags are used. The following table indicates the required roles:
Command Option f r t Authorization admin or senior user user
Options
console Specifies the name of the event console to use. event_ID Specifies the ID of the event to be modified. The event ID is comprised of event_handle, server_handle, and date_reception. attribute=value... Assigns a value to any valid attribute. The attribute should be one defined for the event class. Separate multiple attribute=value expressions with a space. r severity Changes 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 custom value. f Forces an event to change status from CLOSED to OPEN, ACK, or RESPONSE. Also forces an event to change status from ACK to OPEN. If you do not specify the f option, you cannot change the status of an event from ACK to OPEN, from CLOSED to OPEN, from CLOSED to ACK, from RESPONSE to ACK, from RESPONSE to OPEN, or from CLOSED to RESPONSE.
Chapter 1. Commands
105
Examples
The following example acknowledges event 11782052457 for event console Network Events:
wsetemsg t ACK "Network Events" 11782052457
See Also
wlsemsg, wpostemsg (endpoint version), wpostzmsg (endpoint version)
106
wsetesvrcfg
Sets the configuration parameters for the event server. You must stop and restart the event server to put these parameters into effect.
Syntax
wsetesvrcfg [S server] [b events] [c events] [e [seconds] ] [k seconds] [m seconds] [n seconds] [r [seconds] ] [t [file] ]
Description
The wsetesvrcfg command sets configuration parameters for the event server. The server in the local Tivoli region is modified unless another server is specified. You must 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 a new one begun. They are not intended to be a substitute for system logs. Use them for testing and short-term diagnostics.
Authorization
senior
Options
b events Specifies the maximum number of events to be buffered in the reception buffer while the rule engine processes other events. The default value is 500 events. c events Sets the event cache to the number of events specified by events. The default value is 1000 events. It should be large enough to handle a peak number of pending events. If the cache is too small, the server does a forced cache cleaning of the oldest events. e seconds Specifies 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 default value is 86400 seconds (1 day). This setting is not automatically enforced, but rather is used by the Clean_Database task in the T/EC Tasks library. This task can be run directly or scheduled as a job. k seconds Retains closed events going back the specified number of seconds. The default value is 86400 seconds (1 day). m seconds Specifies the number of seconds allowed for the event server to initialize. The default value is 300 seconds. n seconds Specifies the number of seconds to keep events that have not been closed. The default value is 15552000 seconds (180 days).
Chapter 1. Commands
107
S server Specifies the name of the event server in name registry format. The default server 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 debugging rules. 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 the event server.
Examples
The following example sets the event server cache size to 1536 events for the server in the AcmeTMR region:
wsetesvrcfg c 1536 S @EventServer#AcmeTMR
See Also
wlsesvrcfg
108
wsetsrc
Resets event source attributes.
Syntax
wsetsrc [S server] [l label] [n name] source
Description
The wsetsrc command sets the name or label for a source registered on the event server. 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).
Authorization
senior
Options
source Specifies the source to be modified. l label Specifies the label to use to identify the source on an event console. The default value is the value specified by the source argument. n name Renames the source to name, which must be a unique source name. If it duplicates an existing name, an error is reported. The source name must match the name of the source as specified in an event adapter CDS configuration file. S server Specifies the name of the event server in name registry format. The default server is the local event server. To indicate a remote server, specify@EventServer#tmr, where tmr is the name of a Tivoli region.
Examples
The following example sets the label of the LOGFILE source to syslog:
wsetsrc -l syslog LOGFILE
See Also
wcrtsrc, wdelsrc, wlssrc
Chapter 1. Commands
109
wsighup
Signals the Windows Event Log Adapter or Windows NT Event Log Adapter to reload the configuration and format files.
Syntax
wsighup adapter pid
Description
The wsighup command causes the Windows Event Log Adapter or the Windows NT Event Log Adapter to reload the configuration and format files. Use this command if you have made changes to the configuration or format file and you want 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 the UNIX operating system, use the command kill -HUP adapter_pid to reload configuration and format files.
Authorization
None
Options
adapter The name of the adapter service pid The process ID of the adapter
Examples
The following example reloads the configuration and format files for the adapter tecwinadapter_myid with process ID 712:
wsighup tecwinadapter_myid 712
110
wstartesvr
Starts the event server.
Syntax
wstartesvr [S server]
Description
The default action of the wstartesvr command starts the event server in the local Tivoli 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 and buffer size parameters, and QUEUED and WAITING events (if there were events in these states when the server was last shut down) are loaded into the reception buffer. Then the event server makes itself available for communication with event adapters and consoles. It begins processing QUEUED and WAITING events and incoming 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 automatically reconnected when the server is restarted.
Authorization
senior
Options
Examples
The following example starts the local event server:
wstartesvr
See Also
wstopesvr
Chapter 1. Commands
111
wstartmaint.sh
Informs the event server that a host has been placed in maintenance mode.
Syntax
wstartmaint.sh host_name duration "owner_info" [start_time]
Description
The wstartmaint.sh command informs the event server that a network resource has been put in maintenance mode by sending a TEC_Maintenance control event. You can use this command manually or you can automate it using the system scheduler. The output for this command is the same as the output for the Start_Maintenance task.
Authorization
None
Options
host_name Specifies the fully qualified name of the host put in maintenance mode. duration Specifies the length of time, in minutes, that the host is to remain in maintenance mode. "owner_info" Specifies information about the user who started the maintenance window. start_time Indicates the time that the host is put in maintenance mode, specified as YYYY MM DD HH MM SS. If not specified, the default value is the current system time.
Examples
This example informs the event server that host myhost is to be put in maintenance 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 in maintenance 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 maintenance mode for 1 minute immediately:
wstartmaint.sh "*" 1 "my.email.com"
See Also
wstopmaint.sh
112
wstatesvr
Displays the status of an event server.
Syntax
wstatesvr [S server]
Description
The wstatesvr command displays the status of the event server.
Authorization
user
Options
S server Specifies the name of an event server in name registry format. The default server is the local event server. To indicate a remote server, specify @EventServer#tmr, where tmr is the name of a Tivoli region.
Examples
The following example displays the status of the local event server:
wstatesvr
See Also
wstartesvr, wstopesvr
Chapter 1. Commands
113
wstopesvr
Stops the event server.
Syntax
wstopesvr [S server]
Description
The wstopesvr command stops the event server in the local Tivoli region. If an event server stops, any consoles that were connected to it are automatically reconnected when the server is restarted.
Authorization
senior
Options
Examples
The following example stops the local event server:
wstopesvr
See Also
wstartesvr
114
wstopmaint.sh
Informs the event server that an ongoing or scheduled maintenance mode for a network resource is being canceled.
Syntax
wstopmaint.sh host_name [start_time]
Description
The wstopmaint.sh command informs the event server either that an ongoing maintenance window for a network resource is being canceled before the scheduled end time or that a future scheduled maintenance window for a network resource is being canceled.
Authorization
None
Options
host_name Specifies the fully qualified name of the host to be taken out of maintenance mode. start_time Indicates the time that the host was placed in maintenance mode, specified as YYYY MM DD HH MM SS. If the time is not specified, the current and all future maintenance windows for the host are canceled.
Examples
This example informs the event server that the current maintenance window for host 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 scheduled maintenance windows for host myhost are being canceled:
wstopmaint.sh myhost.mynet.com
See Also
wstartmaint.sh
Chapter 1. Commands
115
wstoptecgw
Stops the Tivoli Enterprise Console gateway.
Syntax
wstoptecgw
Description
The wstoptecgw command stops a Tivoli Enterprise Console gateway that services endpoints. The Tivoli Enterprise Console gateway restarts automatically upon receipt 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 the host (managed node) that contains the gateway. To get the wstoptecgw command on the shell sourced on the endpoint installed on the 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 on this endpoint. Note: The wstoptecgw command is also distributed when you distribute the tec_gateway_sce adapter configuration profile.
Authorization
user
116
wtdbclear
Clears events from the event database.
Syntax
wtdbclear [e] [f] [l] [c classname] [r severity] [s status] t seconds [a records] [-p TRUE | FALSE] [w]
Description
The wtdbclear command deletes events from the reception log, event repository or both. Which tables it deletes rows from depends on the options specified. The wtdbclear command must be run from the event server.
Authorization
senior
Options
a records A commit is performed after x number of records are deleted. c classname Clears events with the specified class name. Note: You cannot use the this option when clearing the reception log with the l option. e Deletes events in the event repository, task repository, and extended event attribute table. You must use the t option to specify the age of the events to be deleted. Forces deletion of QUEUED and WAITING events from the reception log. Note: Never use this option while the Tivoli Enterprise Console server is running. l Deletes events in the reception log. You must use the t option to specify the age of the events to be deleted. Note: You cannot use the c, r, or s options when clearing the reception log with this option. p TRUE | FALSE Indicates whether the stored procedure, tec_p_clear_events, should be called. The default value is TRUE. The tec_p_clear_events procedure improves the runtime performance of wtdbclear. r severity Clears events with the specified severity. The valid default values are FATAL, CRITICAL, MINOR, WARNING, HARMLESS, and UNKNOWN. Note: You cannot use the this option when clearing the reception log with the l option.
Chapter 1. Commands
117
s status Clears 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 with the l option. t seconds Deletes events that are older than the specified number of seconds. This option is required. w Forces deletion of events that have not yet been processed by the data warehouse extract, transform, and load (ETL) process. If the Tivoli Enterprise Console warehouse enablement pack is installed, events in the repository are periodically processed by the warehouse ETL process. If you issue the wtdbclear command and specify a time window that includes events that have not yet been processed by the warehouse ETL process, the wtdbclear command returns a warning message. Use the w option to force deletion of these events.
Notes
If more than one of the c, s, and r options is specified, the result is a logical OR.
Examples
The 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 r options, deletes all events that have a severity of HARMLESS or all events that have a class value of TEC_Start:
wtdbclear -r HARMLESS -c TEC_Start -et 0
See Also
wdbmaint.sh, wtdumper, wtdumprl, wtdumptr
118
wtdbclear.pl
Clears events from the event database.
Syntax
wtdbclear.pl [e] [f] [l] [c classname] [r severity] [s status] t seconds [a records] [-R rim_name] [-D] [w]
Description
The wtdbclear.pl command deletes events from the reception log, event repository or 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 Enterprise Console server, it uses the time from the local system to determine which events to clear, and this might cause unexpected behavior. It is recommended that you do not run the wtdbclear.pl script during peak operational hours. For example, if the time on the node is 9:00 and the Tivoli Enterprise Console server is 9:30, a wtdbclear.pl let 0 command run from the node clears events received prior to 9:00. The last 30 minutes of events remain in the database. Running wtdbclear.pl on the Tivoli Enterprise Console server would completely clear 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 the wtdbclear command instead. The wtdbclear.pl command should be used only 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 server v If you use an DB2 database and the tec_p_clear_events stored procedure is not installed
Authorization
senior
Options
a records A commit is performed after the specified number of records are deleted. c classname Clears 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 tracing to go to stdout; you might want to redirect the output of the command to a file. Deletes events in the event repository, task repository, and extended event attribute table. You must use the t option to specify the age of the events to be deleted. Forces deletion of QUEUED and WAITING events from the reception log.
Chapter 1. Commands
119
Note: Do not use this option while the Tivoli Enterprise Console server is running. l Deletes events in the reception log. Note: You cannot use the c, r, or s options when clearing the reception log with this option. R The RIM object name. The default setting is tec.
r severity Clears events with the specified severity. The valid default values are FATAL, CRITICAL, MINOR, WARNING, HARMLESS, and UNKNOWN. Note: You cannot use the this option when clearing reception logs with the l option. s status Clears 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 seconds Deletes events that are older than the specified number of seconds. This option is required. w Forces deletion of events that have not yet been processed by the data warehouse extract, transform, and load (ETL) process. If the Tivoli Enterprise Console warehouse enablement pack is installed, events in the repository are periodically processed by the warehouse ETL process. If you run the wtdbclear.pl script and specify a time window that includes events that have not yet been processed by the warehouse ETL process, the wtdbclear.pl script returns a warning message. Use the w option to force deletion of these events.
Examples
The following example deletes all events older than 60 seconds from the event and task repositories and the reception log, turns on tracing, and places the output in the /tmp/output file:
wtdbclear.pl -elt 60 -D > /tmp/output
See Also
wdbmaint.sh, wtdbclear, wtdumper, wtdumprl, wtdumptr
120
wtdbspace
Provides space usage statistics for the event database.
Syntax
wtdbspace [-R rim_object_name] [-t temp_dev_name,...] [-d data_dev_name,... | -T ]
Description
The wtdbspace command provides statistics about used and free space in the event 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 Tivoli Enterprise Console Informix user on the system that has the Informix database server installed, and the database environment must be sourced. If the Informix server is on a different system than the event server, you must copy the wtdbspace script (located in the $BINDIR/bin directory on the event server) to the Informix server or make the script available by an NFS mount. The wrimsql command is not needed when running wtdbspace on the Informix database server. If you use an DB2 database, you must run the wtdbspace script as the Tivoli Enterprise Console DB2 user on the RIM host from the DB2 command line processor, and the database environment must be sourced. If the RIM host is on a different system than the Tivoli Enterprise Console server, you must copy the wtdbspace script (located in the $BINDIR/bin directory on the event server) and the db2_runstats script (located in the $BINDIR/TME/TEC/sql directory on the event 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 wtdbspace command for a DB2 database.
Authorization
user
Options
-d data_dev_name,... The names of the data devices to report on. The following table indicates the data device types for each product:
Product DB2 Informix Microsoft SQL Server Oracle Sybase Data device types table space names dbspace names file group names table space names logical device names
Each name is separated by a comma or a space. If using spaces to separate names, the entire list should be enclosed in double quotation marks. If no names are specified, then all device names in the database are reported on.
Chapter 1. Commands
121
This command supports the use of the asterisk character as a matching character. 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_name The 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 table indicates the temporary devices for each product:
Product DB2 Informix Microsoft SQL Server Oracle Sybase Temporary Devices temporary table spaces defined for the database DBSPACETEMP TEMPDB temporary table spaces defined for the database TEMPDB
Each name is separated by a comma. If no names are specified, then all temporary devices named in the database are reported on. This command supports the use of the asterisk character as a matching character. 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 data devices. This parameter cannot be used with the d parameter.
Examples
The following example shows the space used for a RIM object named mssql_tec and shows the information for data devices TEC_DATA1 and TEC_DATA2 and temporary 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 devices that begin with the letters TEC and the temporary devices that begin with the letters TEC:
wtdbspace -d TEC* -t TEC*
122
wtdbstat
Checks the availability of the database server that the Tivoli Enterprise Console server uses.
Syntax
wtdbstat [q]
Description
The wtdbstat command displays the availability of the database server. This command takes longer to run when the database server is down.
Authorization
senior
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 indicates that the server is running. Any other return code indicates an error.
Examples
The following example displays the database server availability:
wtdbstat
See Also
wstatesvr
Chapter 1. Commands
123
wtdumper
Generates an event report of processed events from the event repository.
Syntax
wtdumper [f file] [t start_time] [e end_time] [o ASC | DESC] [m number] [d] [w where_clause]
Description
The wtdumper command generates an event report from the event repository. The Tivoli 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, it uses the time from the local system to determine which events to display, and this might cause unexpected behavior. For example, if the time on the node is 9:00 and the Tivoli Enterprise Console server is 9:30, a wtdumper run from the node displays every event in the database except for those occurring during the 30 minutes specified. The same command run on the Tivoli Enterprise Console server would display the entire database.
Authorization
senior
Options
d Lists detailed formatted information in the event report. e end_time Lists events that occurred prior to the specified date and time. The end_time parameter must be a date in the format of Mon dd hh:mm:ss yyyy. If this flag is omitted, the command uses the current time as the end time. f file Writes output to the specified file.
m number Specifies the maximum number of events to record in the report. If the number of events in the database exceeds the specified value, the command omits entries from the end of the report. For example, if the report is displayed in ascending order, the most recent database entries are not included in the report. o ASC | DESC Sets 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_time Lists events that occurred after the specified date and time. The start_time parameter must be a date in the format of Mon dd hh:mm:ss yyyy.
124
w where_clause Specifies a partial SQL WHERE clause for the event database query. This partial clause is appended to the internally generated WHERE clause with the AND operator. Note: This option is useful if you are experienced with SQL statements.
Examples
The following example generates an event report that includes events that occurred between 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 event database query:
wtdumper -w "msg = There was a print error"
See Also
wtdbclear, wtdumprl, wtdumptr
Chapter 1. Commands
125
wtdumprl
Generates a report of received events from the reception log.
Syntax
wtdumprl [f file] [t start_time] [e end_time] [o ASC | DESC] [m number]
Description
The 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 default action is for events to be listed in the order they occurred. However, the most recent event can be listed first by using the o flag. If wtdumprl is run from a node other than the Tivoli Enterprise Console server, it uses the time from the local system to determine which events to display, and this might cause unexpected behavior. For example, if the time on the node is 9:00 and the Tivoli Enterprise Console server is 9:30, a wtdumprl run from the node displays every event in the database except for those occurring during the 30 minutes specified. The same command run on the Tivoli Enterprise Console server would display the entire database.
Authorization
senior, RIM_view
Options
e end_time Lists events that were received prior to the specified date and time. The end_time parameter must be a date in the format of Mon dd hh:mm:ss yyyy. If this flag is omitted, the command uses the current time as the end time. f file Writes output to the specified file.
m number Specifies the maximum number of events to record in the report. If the number of events in the log exceeds the specified value, the command omits entries from the end of the report. For example, if the report is displayed in ascending order, the most recent database entries are not included in the report. o ASC | DESC Sets 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_time Lists events that were received after the specified date and time. The start_time parameter must be a date in the format of Mon dd hh:mm:ss yyyy.
126
Examples
The following example generates a report that includes all events received between 7 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 Also
wtdbclear, wtdumper, wtdumptr
Chapter 1. Commands
127
wtdumptr
Generates a report of running or completed tasks.
Syntax
wtdumptr [f file] [t start_time] [e end_time] [o ASC | DESC] [m number]
Description
The wtdumptr command generates a report of tasks performed by the event server. The task repository maintains a log of these tasks in the database. The default 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.
Authorization
senior, RIM_view
Options
e end_time Lists tasks that were completed prior to the specified date and time. The end_time parameter must be a date in the format of Mon dd hh:mm:ss yyyy. If this flag is omitted, the command uses the current time as the end time. f file Writes output to the specified file.
m number Specifies the maximum number of events to record in the report. If the number of events in the database exceeds the specified value, the command omits entries from the end of the report. For example, if the report is displayed in ascending order, the most recent database entries are not included in the report. o ASC | DESC Sets 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_time Lists tasks that were completed after the specified date and time. The start_time parameter must be a date in the format of Mon dd hh:mm:ss yyyy.
Examples
The following example generates a report that includes all tasks completed between 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 Also
wtdbclear, wtdumper, wtdumprl
128
wtecexport
Exports Tivoli Enterprise Console event console definitions to a file.
Syntax
wtecexport h [host [:port]] [u user] [p password] [O operator1:operator2:...] [c console1:console2:...] [e event_group1:event_group2:...] [f filename] On Windows systems, the wtecexport command is called as wtecexport.cmd. The options are the same.
Description
The definitions of event groups, consoles, and operators can be exported to a file and 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 additional configuration or implementation. v The console definitions in one Tivoli region can be used as a single point of control 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, you can export one or more consoles and any number of event groups without exporting any operators. If at least one of O, c, and e is not specified, all console definitions are exported. Note that wtecexport exports consoles, event groups, and operators for all users.
Authorization
senior
Options
h [host [:port]] The host name of a managed node where the user ID and password must be authenticated by the Tivoli Management Framework. Specify this option as 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 filename The path and name of the file to contain the exported definitions. If the file does 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
p password The password for the login specified in the u argument. This option is required if you use the u option to specify a user. u user The Tivoli administrator login. If you do not specify this option, 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 must use the h, u, and p suboptions to explicitly specify the host name, user ID, and password to prevent the login window from displaying. This is not necessary if you are logged in to an AIX system under any other user ID.
Examples
1. 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 a file 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 server mica from a system running a Windows operating system. In this case, all operators, consoles, and event groups are exported to export_file.
wtecexport.cmd -h mica -u root -p tivoli \ -f export_file
See Also
wtecimport
130
wtecimport
Imports event console definitions from an export file into a Tivoli region.
Syntax
wtecimport h host [:port] [u user] [p password] [O operator1:operator2:...] [c console1:console2:...] [e event_group1:event_group2:...] [f filename] [x e | r | c] On Windows systems, the wtecimport command is called as wtecimport.cmd. The options are the same.
Description
The definitions of event groups, consoles, and operators can be exported to a file with the wtecexport command and then imported into another Tivoli region through an event console. 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 region for additional configuration or implementation. v The console definitions in one Tivoli region can be used as a single point of control 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, you can import one or more consoles and any number of event groups without importing any operators. If at least one of O, c, and e is not specified, all console 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 consoles must already exist, or they must also be imported at the same time. Only Tivoli administrators defined in the receiving Tivoli region can be imported as operators. You cannot create a new Tivoli administrator in a region by importing an operator that is not defined in the receiving region.
Authorization
senior
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 filename The 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
be authenticated by the Tivoli Management Framework. Specify this option as host:port if a port other than port 94 is used. O operator1;operator2;... A list of operators, separated by colons, to import. p password The password for the login specified in the u argument. This option is required if you use the u option to specify a user. u user The Tivoli administrator login. If you do not specify this option, the ID of the user currently logged on is used. x e | r | c How 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 with the new one, or x c to change the name of the object by appending a number to the new object. The flags are case sensitive. The space between the argument and the flag is optional. Note: If you are running on an AIX system and are logged in as root, you must use the h, u, and p suboptions to explicitly specify the host name, user ID, and password to prevent the login window from displaying. This is not necessary if you are logged in to an AIX system under any other user ID.
Examples
1. The following example performs the import as the user root on the event server mica. Operators, consoles, and event groups to be imported are enumerated and the exported settings are contained in a file named export_file. Existing operators, consoles, and event groups are replaced in the event of a name conflict.
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 operators contained within export_file. Once again, the import is performed as the user root on the event server mica. Existing operators, consoles, and event groups are replaced in the event of a name conflict.
wtecimport.cmd -h mica -u root -p tivoli -f export_file -x r
See Also
wtecexport
132
wtouchac
Update the modification time on an adapter configuration profile record to force redistribution.
Syntax
wtouchac key... profile
Description
The wtouchac command updates the timestamp on one or more records from an adapter configuration profile. The update forces the records to be distributed the next time a distribution is requested from the Adapter Configuration Facility GUI or through the wdist command when Exact Copy is not specified. Because adapter configurations involve other files not directly under control of the profile mechanism in the Tivoli Enterprise, the fact that a record should be redistributed because an auxiliary file has changed is not apparent to the application. Thus, the wtouchac command is used when an auxiliary file has changed but not the record.
Authorization
admin
Options
key... 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 right side of the adapter configuration profile entry panel or by using the wlsac command. The adapter configuration profile to affect. If the name includes spaces, enclose the whole name in quotation marks.
profile
Examples
The following example updates the time stamp on the adapter configuration profile entry stored in key 1 for profile ACP_Profile:
wtouchac 1 @ACP:ACP_Profile
The following example updates the time stamp on the adapter configuration profile entry stored in key 1 for profile ACP Profile (which includes a space in its name):
wtouchac 1 @"ACP:ACP Profile"
See Also
wdistrib (in the IBM Tivoli Management Framework Reference Manual), waddac
Chapter 1. Commands
133
134
Chapter 2. Tasks
This chapter describes the predefined tasks shipped in the task library for the Tivoli Enterprise Console product. The actual name of this task library is T/EC Tasks, which is shown in task dialogs and is used when specifying the task library from a command line. There are three types of Tivoli Enterprise Console tasks: Console tasks These tasks are configured and run immediately from the Event Viewer. If a console task requires any event attribute values, select the event in the Working Queue of the Event Viewer to associate the event with the task. Automated tasks These tasks are configured ahead of time and run automatically when a particular event with the specified event classes and attributes is received on the console on which the event was displayed. Automated tasks are configured with the Automated Tasks pull-down menu in the Event Viewer. Rule base tasks These tasks are run when they are part of an action for a rule that has been triggered. The exec_task and exec_task_local rule language predicates are used to run rule base tasks. Rule base tasks are sometimes referred to as automated responses. For information about running tasks from within rules, see the Tivoli Enterprise Console Rule Builders Guide. A task is a script, which usually issues other Tivoli commands. Variable values are passed to a task at run time. The variable values can come from options and arguments you specify, or from event attributes available to the task. For console tasks that need the attributes of an event available to them, you must associate the event with the task by selecting the event from the event console. Options and arguments you specify for tasks are described in this chapter. Event attributes available to tasks are described in Chapter 3, Environment variables available to tasks, on page 159. Procedures to configure tasks from an event console are described in the online help for the current console. From the Automated Tasks dialog, you can define or modify the following properties: v Name v Description v When an event matches v Run tasks When an automated task completes, it issues information about its success or failure, and any results created by the task. The task-completion icon is displayed in the first column of the Event Viewer when an automated task completes. You can 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.
135
Automated tasks results can be written to a text file, which is configured in the Console Properties dialog for each console. For detailed information about running the Automated Task function from the event console, see the Automated Task entries provided in the online help. When running a rule base task, information about success, failure, and results of the task is issued only if the watch status is YES. Otherwise, no information about the task is displayed in the console. When the watch status is YES, the task-completion icon is displayed in the first column of the Event viewer when the task completes. You can click the icon in this column to view details about the rule base 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 can configure and run most of the tasks from the command line. For information about accessing the Tivoli Enterprise Console task-related dialogs, see the Tivoli Enterprise Console Users Guide. The Tivoli Management Framework wruntask command is used to configure and run console tasks from the command line, and is shown in all of the examples in this 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 and run options for Tivoli Enterprise Console tasks, and, in the case of an automated task, to define a name for the task, define the event constraints to match event fields to trigger the task action, and define the name of the task to run if the event constraints are satisfied.
Task names and scripts

The 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 task names or descriptive names in the T/EC Tasks dialog of the Tivoli desktop by selecting and deselecting the Show by identifier check box to review task names in 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. You can modify these scripts if necessary. v Indicates whether you can run the task from the command line. Certain tasks need the attributes of an event available to them. You cannot run a task that needs the attributes of an event available to it from the command line.
Task Name Change_Severity Clean_Database Clear_Closed_Events Clear_Reception_Log Close_Event Dump_Event_Repository Event_Query Find_Similar_Events Descriptive Name Change severity of event Clean out Tivoli Enterprise Console database Clear closed events Clear reception log Close event Dump event repository Query event repository Find matching event File Name T_EC_Tasks_C_zonctxba T_EC_Tasks_C_hmmeleka T_EC_Tasks_C_onyloafa T_EC_Tasks_C_rgetpzda T_EC_Tasks_C_ylzejuna T_EC_Tasks_D_ckqiqpka T_EC_Tasks_E_wkxovwka T_EC_Tasks_F_lozglmea Command Line No Yes Yes Yes No Yes Yes No
136
Task Name Forward_Event Log_Event_To_File Popup_Message Send_Email Send_Event Start_Maintenance Wake_Up_Netscape
Descriptive Name Forward event to the Tivoli Enterprise Console server Log event to file Popup message on desktop Send event information Send event to Tivoli Enterprise Console server
File Name T_EC_Tasks_F_dpstmska T_EC_Tasks_L_jfugucca T_EC_Tasks_P_rsoomfna T_EC_Tasks_S_rsnlpxda T_EC_Tasks_S_lwqpwqla
Command Line No No Yes No Yes Yes Yes
Inform the event server T_EC_Tasks_S_jxixoxea about maintenance windows Jump Netscape to URL T_EC_Tasks_W_mnnqzlga
Task output
When a task completes it issues information about its success or failure, and any results 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 with this information. For tasks that run from the command line, the same level of information is written to stdout and stderr. For automated tasks, the results can be displayed with the related event that triggered the task. The task can also be configured to save the results 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
Change_Severity
Changes the severity of an event. The severity is changed in the Event Viewer, the event cache, and the event repository. This task assumes the wsetemsg command is available on the host where the task runs. The wsetemsg command is always available on the event server host. Also, the event server must be running for this task to run successfully.
Authorization
super, senior, admin, user
Dialog Configuration Options

Severity The new severity for the event. Valid values are: FATAL, CRITICAL, MINOR, WARNING, HARMLESS, or UNKNOWN.
Command Synopsis
You cannot run this task from the command line.
138
Clean_Database
Deletes old events from the event database. Events are deleted from the reception log based on the value for the Time to keep event reception log information field in the Event Server Parameters dialog for the event server. Closed events in the event repository that are older than the value for the Time to keep closed events in cache field in the Event Server Parameters dialog are deleted. This task assumes the wtdbclear command is available on the host where the task runs. The wtdbclear command is always available on the event server host. If a problem occurs while the wtdbclear command is running, an explanatory message is issued and the script exits immediately with a return code. The event database must be available. The event server does not have to be running. Note: After running this task, old events deleted from the event repository are not removed from an event console until it is shut down and reopened. Old events in the event cache are not removed until the event server is stopped and restarted, or until the old events reach their timeout value.
Authorization
RIM_update, RIM_view, super, senior, admin, user

There are no options for this task. It gets its parameters from the fields mentioned in the task description.
Command Synopsis
wruntask 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 Example
wruntask -t Clean_Database -l "T/EC Tasks" \ -h orange
Chapter 2. Tasks
139
Clear_Closed_Events
Deletes closed events from the event repository, using an age you provide. This task assumes the wtdbclear command is available on the host where the task runs. The wtdbclear command is always available on the event server host. The event database must be available. The event server does not have to be running.
Authorization

Seconds 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 Synopsis
wruntask t Clear_Closed_Events l "T/EC Tasks" h node a seconds
Command Arguments
a seconds h node l "T/EC Tasks" The task library. t Clear_Closed_Events The task to run. The starting age, in seconds, of events to delete. The managed node on which to run the task.
Command Example
wruntask -t Clear_Closed_Events -l "T/EC Tasks" \ -h orange -a 6000
140
Clear_Reception_Log
Deletes 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 task runs. The wtdbclear command is always available on the event server host. The event database must be available. The event server does not have to be running.
Authorization

There are no options for this task.
Command Synopsis
wruntask t Clear_Reception_Log l "T/EC Tasks" h node
Command Arguments
h node l "T/EC Tasks" The task library. t Clear_Reception_Log The task to run. The managed node on which to run the task.
Command Example
wruntask -t Clear_Reception_Log -l "T/EC Tasks" \ -h orange
Chapter 2. Tasks
141
Close_Event
Changes the status of an event selected to CLOSED. The status is changed in the event console, the event cache, and the event repository. This task assumes the wsetemsg command is available on the host where the task runs. The wsetemsg command is always available on the event server host. Also, the event server must be running for this task to run successfully.
Authorization

There are no options for this task.
Command Synopsis
142
Dump_Event_Repository
Displays event details from the event repository in the task output dialog. This task 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. The event server does not have to be running.
Authorization
RIM_view, super, senior, admin, user

Ascending 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 Events The maximum number of events to display in the output. If the number of events in the event repository exceeds the specified value, entries are omitted from the end of the output. For example, if the output is displayed in ascending order, the most recent database entries are not shown.
Command Synopsis
wruntask t Dump_Event_Repository l "T/EC Tasks" h node a sort_order a number_events
Command Arguments
a number_events The maximum number of events to display in the output. If the number of events in the database exceeds the specified value, entries are omitted from the end of the output. For example, if the output is displayed in ascending order, the most recent database entries are not shown. a sort_order The order in which events are listed in the output. Valid values are: ASC List the oldest event repository entry first.
DESC List the most recent event repository entry first. h node l "T/EC Tasks" The task library. t Dump_Event_Repository The task to run. The managed node on which to run the task.
Command Example
wruntask -t Dump_Event_Repository -l "T/EC Tasks" \ -h orange -a ASC -a 10
Chapter 2. Tasks
143
Event_Query
Queries 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 task runs. The wtdumper command is always available on the event server host. The event database must be available. The event server does not have to be running.
Authorization

For the following match-type options (Match Class through Match Message), your choices define which attributes and values to use for the selection criteria of the query. With all of the options, you can you manually enter text, including the asterisk (*) wildcard character to specify all the values for an attribute. If you manually enter multiple values for an option, separate each with a comma. Some of the options also provide a push button to display a scrolling list from which you can select one or more values. Match Class Match Status Match Severity Event severities. Valid values are: FATAL, CRITICAL, MINOR, WARNING, HARMLESS, and UNKNOWN. Match Hostname The names of the systems on which the events occurred. Match Source The sources of the events (for example, LOGFILE is the source name for the UNIX log-file adapter). A source is defined by an adapter type. Match SubSource Further categorizations of sources. Match Origin The protocol addresses or host names of the source systems. Match SubOrigin Further categorization of origins. Match Message One or more message text strings of the events. When specifying more than one message, enclose the entire value for the Match Message option with one type of quotation mark (for example, double quotation marks), and enclose each message within a different type of quotation mark (for example, single quotation marks) separated by a comma. For example: "msg text1,msg text2". To specify all messages, use the * wildcard character. Starting Date and Time Specifies to query events received from this point to the present. To specify a starting point, use the following format: monddhh:mm:ssyyyy. For example, Jan 01 00:01:01 2000. To query all events, specify the * wildcard character. Event classes. Status of events. Valid status names are: OPEN, ACK, RESPONSE, and CLOSED.
144
Order Events by The order in which query results are listed in the output. Valid values are: ASC List the oldest event first.
DESC List the most recent event first. Show values for attributes Specifies which base event attributes to display in the output. Click Attributes for a scrolling list of base event attributes to select from. All non-base event attributes are always displayed. If you do not select any attributes, all (base and non-base) attributes are displayed in the output.
Command Synopsis
wruntask t Event_Query l "T/EC Tasks" h node a {"class[,class...]" | "*"} a {"status[,status...]" | "*"} a {"severity[,severity...]" | "*"} a {"hostname[,hostname...]" | "*"} a {"source[,source...]" | "*"} a {"sub_source[,sub_source...]" | "*"} a {"origin[,origin...]" | "*"} a {"sub_origin[,sub_origin...]" | "*"} a {"'msg'[,'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 intervening space. To specify all event classes, use the * wildcard character. For additional information about event class names, see the Tivoli Enterprise Console Adapters Guide or the BAROC files for the adapters generating the events. One or more event status names. If specifying more than one status by name, separate each name with a comma and no intervening space. To specify all event status names, use the * wildcard character. Valid status names are: OPEN, ACK, RESPONSE, and CLOSED. One or more event severity names. If specifying more than one severity by name, separate each name with a comma and no intervening space. To specify all event severity names, use the * wildcard character. Valid severity names are: FATAL, CRITICAL, MINOR, WARNING, HARMLESS, and UNKNOWN. One or more names of the systems on which the events occurred. If specifying more than one host by name, separate each name with 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 the source name for the UNIX log-file adapter). A source is defined by
Chapter 2. Tasks
a "status..."
a "severity..."
a "hostname..."
145
an adapter type. If specifying more than one source by name, separate each source with a comma and no intervening space. To specify all sources, use the * wildcard character. a "sub_source..." One or more subsource of the events. A subsource is a further categorization of a source. If specifying more than one subsource by name, separate each subsource with a comma and no intervening space. To specify all subsources, use the * wildcard character. a "origin..." One or more protocol addresses or host names of the source systems. If specifying more than one origin by name, separate each origin with a comma and no intervening space. To specify all origins, use the * wildcard character.
a "sub_origin..." One or more suborigins of the events. A suborigin is a further categorization of a origin. If specifying more than one suborigin by name, separate each suborigin with a comma and no intervening space. To specify all suborigins, use the * wildcard character. a "'msg...'" One or more message text strings of the events. Enclose each message within a different type of quotation mark than the type enclosing the entire value for the a argument; that is, if the entire argument value is enclosed by double quotation marks (as shown in the synopsis), enclose each message within single quotation marks. For example: -a "msg text1,msg text2". To specify all messages, use the * wildcard character.
a "start_point" Specifies to query events received from this point to the present. To specify a starting point, use the following format: monddhh:mm:ssyyyy. For example, Jan 01 00:01:01 2000. To query all events, use the * wildcard character. a "sort_order" The order in which query results are listed in the output. Valid values 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 the output. All non-base event attributes are always displayed. If specifying more than one attribute by name, separate each attribute with a comma and no intervening space. To specify all attributes, use the * wildcard character. l "T/EC Tasks" The task library. t Event_Query The task to run.
Command Example
wruntask -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
Find_Similar_Events
Queries the event repository using an event for comparing attributes. The results are displayed in the task output dialog. You must select the event in the Event Viewer before configuring this task. This task 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 for this task to run successfully.
Authorization

For the following match-type options (Match Class through Match Message), selecting the Yes radio button specifies to use the attribute in the selected event for comparisons with the same attributes of events in the database. Selecting the No radio button specifies not to use the attribute in the selected event for comparisons. Match Class Match Status Match Severity The severity of the event. Valid values are: FATAL, CRITICAL, MINOR, WARNING, HARMLESS, and UNKNOWN. Match Hostname The name of the system on which the event occurred. Match Source The source of the event. Match SubSource A further categorization of the source. Match Origin The protocol address or host name of the source system. Match SubOrigin A further categorization of the origin. Match Message The message text of the event. Starting Date and Time Specifies to query events received from this point to the present. To specify a starting point, use the following format: mon dd hh:mm:ss yyyy. For example, Jan 01 00:01:01 2000. To query all events, specify an asterisk (*). Order Events by The order in which query results are listed in the output. Valid values are: Ascending List the oldest event first. Descending List the most recent event first.
Chapter 2. Tasks
The event class. The status of the event. Valid status names are: OPEN, ACK, RESPONSE, and CLOSED.
147
Show values for attributes Specifies which base event attributes to display in the output. Click Attributes for a scrolling list of base event attributes to select from. All attributes for a non-base event are always displayed. If you do not select any attributes, all attributes are displayed in the output.
Command Synopsis
148
Forward_Event
Forwards an event to another event server registered in the current Tivoli management region. This task assumes the wpostemsg command is available on the host where the task runs. The wpostemsg command is always available on the event server host.
Authorization

Event Servers Name The event server to receive the forwarded event. You can manually type a name, or select from a scrolling list of known event servers by clicking Choose. The local event server is named EventServer. To indicate a remote event server, specify EventServer#tmr, where tmr is the name of the Tivoli region where the remote event server is located; for example, EventServer#orange-region.
Command Synopsis
Chapter 2. Tasks
149
Log_Event_To_File
Writes details to a file about an event.
Authorization
super, senior, admin

Log File Name The path and file name to which the event information is written. You can manually type a path and file name, or you can click Log File Name to display a file browser dialog.
Command Synopsis
150
Popup_Message
Displays a message on the Tivoli desktop for an operator. This task assumes the wsendresp command is available on the host where the task runs. 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 run successfully.
Authorization

Operators Name The name of the operator to receive the message. You can manually type this value or click Operator for a scrolling list of known operators. File Name Managed Node The managed node on which to run the task. The path and name of the file containing the message text to display. You can manually type a path and file name.
Command Synopsis
wruntask 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 to receive the message. a path The path and name of the file containing the message text to display. To specify a remote host on which the file is located, use the format: hostname:path; for example, red:/tmp/msg.txt. The managed node on which to run the task. The task library. t Popup_Message The task to run.
h node l "T/EC Tasks"
Command Example
wruntask -t Popup_Message -l "T/EC Tasks" \ -h orange -a Root_orange-region \ -a /tmp/msg.txt
Chapter 2. Tasks
151
Send_Email
Sends details in an e-mail message about an event. This can be run from the from the Event Viewer or from a rule. This task assumes the sendmail command is available on UNIX and Linux hosts, and that the $BINDIR/bin/smtp_client.exe program is available on Windows NT hosts. Before this task can be run, an SMTP mail server must be set with the wmailhost command. For more information on the wmailhost command, see the Tivoli Management Framework Reference Manual.
Authorization

Administrators Name The name of the person to receive the message. The name is shown in the To: field of the e-mail. Administrators E-mail Address The e-mail ID of the person to receive the message.
Command Synopsis
152
Send_Event
Creates a new event and sends it to the specified event server registered in the current Tivoli region. This task assumes the wpostemsg command is available on the host where the task runs. The wpostemsg command is always available on the event server host and endpoints that have an event adapter installed.
Authorization

Only the CLASS_NAME and SOURCE options require values. The others are optional; that is, you can leave any of them blank. Although you leave them blank, event server processing assigns default values. Event Servers Name The event server to receive the event. You can manually type a name, or select from a scrolling list of known event servers by clicking Choose. The local event server is named EventServer. To indicate a remote event server, specify EventServer#tmr, where tmr 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 this option, EventServer is the default value. message hostname origin severity sub_origin sub_source CLASS_NAME The event class. This option requires a value. For additional information about event class names, see the IBM Tivoli Enterprise Console Adapters Guide or the BAROC file for a particular adapter. SOURCE The source of the event (for example, LOGFILE is the source name for the UNIX log-file adapter). The source is defined by the adapter type. This option requires a value. The message text of the event. The name of the system on which the event occurred. The protocol address or host name of the source system. The severity of the event. Valid severities are: FATAL, CRITICAL, MINOR, WARNING, HARMLESS, and UNKNOWN. A further categorization of the origin. A further categorization of the source.
Command Synopsis
Only the a event_class and a source arguments require actual values. Values for the other arguments are optionalthat is, you do not have to specify a value for the argument, but you must still specify the argument flag with an empty placeholder; for example, a "". You can optionally substitute pairs of single quotation 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
a a a a a a
{origin | ""} {severity | ""} {sub_origin | ""} {sub_source | ""} event_class 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, specify EventServer#tmr, where tmr is the name of the Tivoli region where the remote event server is located; for example, EventServer#orange-region. If no event server is specified for this argument, EventServer is the default value. a msg a hostname a origin a severity a sub_origin a sub_source a class The message text of the event. If the message text contains embedded spaces, enclose within quotation marks. The name of the system on which the event occurred. The protocol address or host name of the source system. The event severity. Valid severities are: FATAL, CRITICAL, MINOR, WARNING, HARMLESS, and UNKNOWN. The suborigin of the event. A suborigin is a further categorization of an origin. The subsource of the event. A subsource is a further categorization of a source. The event class name. This argument requires a value. For additional information about event class names, see the IBM Tivoli Enterprise Console Adapters Guide or the BAROC file for a particular adapter. The source of the event (for example, LOGFILE is the source name for the UNIX log-file adapter). A source is defined by an adapter type. This argument requires a value. The managed node on which to run the task. The task library. t Send_Event The task to run.
a source
h node l "T/EC Tasks"
Command Example
wruntask -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
Start_Maintenance
Informs the event server about any ongoing or future scheduled maintenance windows for one or all hosts. The output for this task is the same as the output for the wstartmaint.sh command. This task assumes that the wpostemsg command is available on the host where the task runs. The wpostemsg command is always available on the event server host and endpoints that have an event adapter installed.
Authorization

Only the hostname and Maintenance Duration options require values. The others are optional; that is, you can leave any of them blank. If you leave them blank, event server processing assigns default values. Event Servers Name The event server to receive the event. You can manually type a name, or select from a scrolling list of known event servers by clicking Choose. The local event server is named EventServer. To indicate a remote event server, specify EventServer#tmr, where tmr is the name of the Tivoli region where the remote event server is located; for example, EventServer#orangeregion. If no value is specified for this option, EventServer is the default value hostname The fully qualified name of the system that either is in maintenance or is to be put in maintenance. A value of "*" indicates that all managed hosts in the network are being put in maintenance, and, consequently, that all events from these hosts are to be dropped or closed. This option requires a value. Maintenance Owner Information Any contact information for the person who started the maintenance mode on 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 60 minutes. 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 not specified, the default value is the current system time. For a scheduled future maintenance window, the time must be specified in the format YYYY MM DD HH MIN SS where YYYY is the 4-digit year, MM is the month (112), DD is the day (131), HH is the hour (0023), MIN is the minutes (0059), and SS is the seconds (0059).
Command Synopsis
wruntask t Start_Maintenance l "T/EC Tasks" h node a {event_server | ""} a host_name
Chapter 2. Tasks
155
a {owner_info | ""} a duration a {start_time | ""} Only the a host_name and a duration arguments require actual values. Values for the other arguments are optional; that is, you do not have to specify a value for the argument, 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 of double quotation marks. If you are specifying the time to start maintenance, put the values within double quotation 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 named EventServer. To indicate a remote event server, specify EventServer#tmr, where tmr 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 this option, EventServer is the default value a host_name The fully qualified name of the system that either is in maintenance or is to be put in maintenance. A value of "*" indicates that all managed hosts in the network are being put in maintenance, and, consequently, all events from these hosts are to be dropped or closed. a owner_info Any contact information for the person who started the maintenance mode on the host, such as e-mail or telephone number information. a duration The length of the maintenance window in minutes. The default value is 60 minutes. a start_time The time at which maintenance is to start for the host. If a value is not specified, the default value is the current system time. For a scheduled future maintenance window, the time must be specified in the format YYYY MM DD HH MIN SS where YYYY is the 4-digit year, MM is the month (112), DD is the day (131), HH is the hour (0023), MIN is the minutes (0059), and SS is the seconds (0059). h node The managed node on which to run the task. l "T/EC Tasks" The task library. t Start_Maintenance The task to run.
Command Example
wruntask -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
Wake_Up_Netscape
Displays a Web page in a new window of the Netscape browser. This task assumes a Netscape browser process is already running on the host where the task runs.
Authorization

URL to DISPLAY The uniform resource locator (URL) of the Web page to display. Netscape Path The default path to the directory where Netscape is installed on the host where the task runs. The default is /usr/local/bin. Note: For Windows NT, the PATH environment variable must be set to include the directory where Netscape is installed. For UNIX, if Netscape is not installed in the /usr/local/bin directory, the PATH environment variable must be set to include the directory where Netscape is installed.
Command Synopsis
wruntask 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, and you want the task to run in the managed node environment, you must use the @ManagedNode syntax. For more information, see the Tivoli Management Framework Reference Manual.
Command Arguments
a url h node The URL of the Web page to display. The managed node on which to run the task.
l T/EC Tasks The task library. t Wake_Up_Netscape The task to run.
Command Example
wruntask -t Wake_Up_Netscape -l "T/EC Tasks" \ -h orange -a http://www.tivoli.com
Chapter 2. Tasks
157
158
Chapter 3. Environment variables available to tasks

This chapter describes the environment variables available to Tivoli Enterprise Console programs and tasks that run with an event. You can specify attribute value constraints for tasks that run with an event.
Variable descriptions
The following table describes the environment variables available to programs, console tasks, and automated tasks that run with an event. It is organized as follows: Name Description Available to The name of the environment variable. A brief description of the environment variable. An X in any of the four subcolumns under this column means that the environment variable is available to console tasks, console programs, rule base tasks, or rule base programs.
Environment variables that represent event attributes are located after the general environment variables, in the section of the table titled Event Attributes. Both sections of the table are in alphabetical order within each section.
Available to Rule Base Programs Console Programs
Name CHILD_OF_OSERV
Description Indicates to the child process that it is a child of the oserv process and allows the child process to take the following two shortcuts: v Does not need to re-authenticate with the oserv process because the oserv process created credentials when it created the child process. v Does not need to initiate a new connection to the oserv process because the oserv process created a socket-pair or pipe-pair to communicate with the child process when it created the child process.
CONSOLE_NAME DISPLAY ENDPOINT ENDPOINT_OID
Name of the event console from where the task was called. UNIX variable that controls the display of the X server. Node where the task runs. Object identifier of where the task runs.
X X X X X X
Rule Base Tasks X
Console Tasks
159
Available to Rule Base Programs X X X X X X X X X X X X X X X X X X X X X Console Programs
Name EVENT_CLASS INTERP LANG LD_LIBRARY_PATH LIBPATH NLSPATH PATH SHLIB_PATH SLOTS TEC_ADMIN
Description Event class passed to the exec_task predicate. Architecture type of the system where the node is installed. Identifier for locale. Path to the shared libraries on solaris2 and sunos4 interpreters. Path to the shared libraries on an AIX system. Path to the directory used by applications to determine language. File search path. Path to the shared libraries on OpenView. Event attributes of the event associated with the task. The name of the Tivoli Enterprise Console administrator defined in the Tivoli environment. Directory where the Tivoli Enterprise Console product is installed. Indicates whether the tec_exectask_dbcs configuration parameter was enabled. If TEC_EXECTASK_DBCS is set to TRUE, it indicates that tec_exectask_dbcs is set to true in the .tec_config file and that slot parameters were converted to the local code set before the task was run. If TEC_EXECTASK_DBCS is not set, then tec_exectask_dbcs is not set (or is set to false) in the .tec_config file and slot parameters were not converted to the local code set before the task was run. Location of the loaded rule base within the $DBDIR directory. Port the tec_server process uses to communicate. Number of seconds for event server initialization. Maximum number of events buffered in memory at the event server. Indicates whether to log reception of events at the event server.
X X X X X X X X X
TEC_BIN_DIR TEC_EXECTASK_DBCS
TEC_KB_DIR TEC_MASTER_PORT TEC_MASTER_START_ TIMEOUT TEC_RECV_BUFSIZE TEC_RECV_LOG
160
Rule Base Tasks X X X X X X X X X X
Console Tasks
Available to Rule Base Programs X X X X X X X X X X X X X X X X X Console Programs
Name TEC_RULE_CACHE_ CLEAN_FREQ TEC_RULE_CACHE_ FULL_HISTORY TEC_RULE_CACHE_ NON_CLOSED_HISTORY TEC_RULE_CACHE_ SIZE TEC_RULE_TRACE TEC_RULE_TRACE_ FILE TISDIR TZ WLOCALHOST
Description The frequency, in seconds, of how often events whose time has passed are purged from the rules cache. The time, in seconds, to keep closed events in the rules cache. The time, in seconds, to keep non-closed events in the rules cache. Maximum number of events stored in the event cache. Indicates whether rules processing generates trace information. File containing rule trace information. Directory for files pertaining to Tivoli internationalization. Time zone. Name of the node as known in the Tivoli environment. Event Attributes
X X X
acl adapter_host administrator cause_date_reception
The list of event group roles that enables an operator to modify the event. The host on which the adapter is running. The operator who acknowledged or closed the event. The cause_date_reception attribute is used to link an effect event to its cause event. This value is set to the value of the date_reception attribute of the cause event. Used in linking an effect event to a cause event, and contains the event_handle attribute value from the cause event. Event class name Event class name. Indicates how the event was sent from the adapter. The value is 1 if an event was sent using a communications channel provided by Tivoli Management Framework services, or a TME adapter. The value is 0 if an event was sent from a non-TME adapter. The date and time the event was generated.
X X X X
X X X X
cause_event_handle
class class_name credibility
X X X
X X X X
date
Rule Base Tasks X X X X X X X X X X X X X X X
Console Tasks
161
Available to Rule Base Programs X X X X X X X X X X X Console Programs
Name date_event date_reception
Description The date and time the event was generated. A time stamp indicating the time the event server received the event. It is an integer representing the number of seconds since the epoch, which is January 1, 1970. This value is also used as a component to uniquely identify an event. An event is uniquely identified by a combination of the values for the date_reception, event_handle, and server_handle attributes. For closed events, the age (in seconds) of the event from when it was received by the event server until it was closed. For all non-closed events, the value is 0. Event identifier comprised of the event_handle, server_handle, and date_reception attribute values. A number used to reference the event. The event server assigns this number. A number used to reference the event. The event server assigns this number. The name of the system on which the event occurred. When the event was last modified. A text summary of the event. For future support of internationalized event messages; not currently implemented. The message ID used to obtain the internationalized message. The number of actions (tasks or programs) currently being tracked by the event server for this event. The port number used by the oserv process. The protocol address or host name of the source system. A counter for keeping track of the number of times a duplicate type of event has been received.
X X
X X X
duration
ev_key
event_handle event_hndl hostname last_modified_time msg msg_catalog
X X X X X X
X X X X X X
msg_index num_actions
X X
X X
o_dispatch origin repeat_count
X X X X X
162
Rule Base Tasks X X X X X X X X X X
Console Tasks
Available to Rule Base Programs X X X X X X X Console Programs
Name server_handle
Description A number identifying the event server that received this event. An event is uniquely identified by a combination of the values for the date_reception, event_handle, and server_handle attributes. A number identifying the event server that received this event. An event is uniquely identified by a combination of the values for the date_reception, event_handle, and server_handle attributes. Stores information describing the rule engines that an event has passed through. The severity of the event. The database stores the severity as a number. This mapping is defined in the root.baroc rule base file and is set for the event server default severities as follows: 10 UNKNOWN 20 HARMLESS 30 WARNING 40 MINOR 50 CRITICAL 60 FATAL The source of the event (for example, the OpenView adapter). The source is defined by the adapter type. Status of the event. A further categorization of the origin. This attribute is optional. A further categorization of the source. This attribute is optional.
server_hndl
server_path severity
X X
X X
source
status sub_origin sub_source
X X X
X X X
Examples
This section shows examples of environment variable dumps for an automated task issued from a Tivoli Enterprise Console rule and a console task run from the event console. Line wrapping of variable values can occur because of space limitations on the page.
Environment variable dump when running a task from a rule

The following example shows a dump of the environment variables when running a task from a Tivoli Enterprise Console rule.
CHILD_OF_OSERV= ENDPOINT=xerius (ManagedNode) ENDPOINT_OID=1450268534.1.348#TMF_ManagedNode::Managed_Node#
Rule Base Tasks X X X X X X X
Console Tasks
163
EVENT_CLASS=TEC_Error INTERP=solaris2 LANG=C LD_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/ucblib NLSPATH=/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.cat PATH=/data/TMP3.6/bin/solaris2/bin:/bin:/usr/bin SLOTS=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_path TEC_BIN_DIR=/data/TMP3.6/bin/solaris2/TME/TEC TEC_KB_DIR=tec/rb_dir TEC_MASTER_PORT=50561 TEC_MASTER_START_TIMEOUT=300 TEC_RECV_BUFSIZE=500 TEC_RECV_LOG=YES TEC_RULE_CACHE_CLEAN_FREQ=3600 TEC_RULE_CACHE_FULL_HISTORY=86400 TEC_RULE_CACHE_NON_CLOSED_HISTORY=15552000 TEC_RULE_CACHE_SIZE=1000 TEC_RULE_TRACE=YES TEC_RULE_TRACE_FILE=/tmp/rules.trace TISDIR=/data/TMP3.6/bin/solaris2/../generic TZ=US/Central WLOCALHOST=xerius acl=[admin] adapter_host= administrator= cause_date_reception=0 cause_event_handle=0 class_name=TEC_Error credibility=1 date=Aug 8 13:26:57 2000 date_reception=965759217 duration=0 event_handle=1 hostname=xerius msg=task msg_catalog= msg_index=0 num_actions=2 o_dispatch=94 origin=146.84.39.78 repeat_count=0 server_handle=1 server_path=[] severity=MINOR source=EVENT status=OPEN sub_origin= sub_source=
Environment variable dump when running a program from the event console
The following example shows a dump of the environment variables when running a console task from the event console.
EVENT_CLASS=TEC_Error INTERP=solaris2 LANG=C LD_LIBRARY_PATH=/data/TMP3.6/lib/solaris2:/usr/openwin/lib:/data/ \
164
install/iblib/solaris2:/usr/openwin/lib:/usr/lib:/usr/ucblib:/data/ \ TMP3.6/lib/solaris2:/usr/dt/lib:/usr/openwin/lib:/usr/lib:/usr/ucblib NLSPATH=/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.cat PATH=/data/TMP3.6/bin/solaris2/bin:/bin:/usr/bin SLOTS=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_path TEC_BIN_DIR=/data/TMP3.6/bin/solaris2/TME/TEC TEC_KB_DIR=tec/rb_dir TEC_MASTER_PORT=50561 TEC_MASTER_START_TIMEOUT=300 TEC_RECV_BUFSIZE=500 TEC_RECV_LOG=YES TEC_RULE_CACHE_CLEAN_FREQ=3600 TEC_RULE_CACHE_FULL_HISTORY=86400 TEC_RULE_CACHE_NON_CLOSED_HISTORY=15552000 TEC_RULE_CACHE_SIZE=1000 TEC_RULE_TRACE=YES TEC_RULE_TRACE_FILE=/tmp/rules.trace TISDIR=/data/TMP3.6/bin/solaris2/../generic TZ=US/Central WLOCALHOST=xerius acl=[admin] adapter_host= administrator= cause_date_reception=0 cause_event_handle=0 class_name=TEC_Error credibility=1 date=Aug 8 13:26:57 2000 date_reception=965759217 duration=0 event_handle=1 hostname=xerius msg=task msg_catalog= msg_index=0 num_actions=2 o_dispatch=94 origin=146.84.39.78 repeat_count=0 server_handle=1 server_path=[] severity=MINOR source=EVENT status=OPEN sub_origin= sub_source=
165
166
Appendix. Configuration parameters

The following are parameters that can be set in the .tec_config file. This file is located in the $BINDIR/TME/TEC directory. The parameters can also be set within rules by using the get_config_param predicate. Note: The tec_recv_agent_port, tec_disp_rule_port, and tec_rec_rule_port parameters indicate which port numbers are to be used for sending events without using Tivoli Management Framework communication services. Port numbers should be set to a value that is larger than 5000 to avoid conflict with automatically assigned ports.
Parameter tec_recv_agent_port Use Specifies the port used for inter-process communication by the tec_reception process. This parameter is required on a UNIX system. Specifies the port used for inter-process communication for the tec_dispatch process. Specifies the port used for inter-process communication for the tec_rule process. Specifies a timeout, in seconds, for the tec_reception process when reading events from a socket. The default is 5. If the tec_reception process hangs for tec_recv_timeout seconds when reading an event, it ends the connection and continues receiving events so that other agents are not delayed. Specifies the directory where temporary files can be created and manipulated. These temporary files are used when rules write to a scratch directory. Specifies the number of events stored in the rule engine event cache. Specifies, in seconds, the maximum time an open event is allowed in the rule engine event cache. Specifies, in seconds, the maximum time a closed event is allowed in the rule engine event cache. Specifies the frequency for emptying the rule engine event cache. Activates or inhibits compiling rules with tracing. If set to YES, the parameter tec_rule_trace_file must also be set. Specifies the name of the file where tracing information is to be written. Must be set if tec_rule_trace is set to YES. Specifies the host where the rule engine runs.
tec_disp_rule_port tec_recv_rule_port tec_recv_timeout
tec_tmpfile_dir
tec_rule_cache_size tec_rule_cache_full_history
tec_rule_cache_non_closed_history
tec_rule_cache_clean_freq tec_rule_trace
tec_rule_trace_file
tec_rule_host
167
Parameter tec_server_handle event_cache_file
Use Specifies the numeric identifier for the server. Specifies the filename of the event cache. This is used to cache incoming events when events are received faster than they can be processed. Specifies how slot parameters of type string should be passed to the task engine. If set to TRUE, slot parameters are converted to the local code set before the task is run. If set to FALSE, the parameters are passed as UTF8. Indicates whether all incoming events are to be in UTF8 format.
tec_exectask_dbcs
always_expect_utf8
168
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 in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the users responsibility to evaluate and verify the operation of any non-IBM product, program, or service. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not give you any license to these patents.You can send license inquiries, in writing, to: IBM Director of Licensing IBM Corporation North Castle Drive Armonk, NY 10504-1785 U.S.A. For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to: IBM World Trade Asia Corporation Licensing 2-31 Roppongi 3-chome, Minato-ku Tokyo 106, Japan The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, 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 be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice. Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk.
169
IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you. Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact: IBM Corporation 2Z4A/101 11400 Burnet Road Austin, TX 78758 U.S.A. Such information may be available, subject to appropriate terms and conditions, including in some cases payment of a fee. The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any equivalent agreement between us. Any performance data contained herein was determined in a controlled environment. Therefore, the results obtained in other operating environments may vary significantly. Some measurements may have been made on development-level systems and there is no guarantee that these measurements will be the same on generally available systems. Furthermore, some measurement may have been estimated through extrapolation. Actual results may vary. Users of this document should verify the applicable data for their specific environment. Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products. All statements regarding IBMs future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only. This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental. COPYRIGHT LICENSE: This information contains sample application programs in source language, which illustrate programming techniques on various operating platforms. You may copy, modify, and distribute these sample programs in any form without payment to IBM, for the purposes of developing, using, marketing or distributing application programs conforming to the application programming interface for the operating platform for which the sample programs are written. These examples have not been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these programs. You may copy, modify, and distribute these sample programs in any form without payment to
170
IBM for the purposes of developing, using, marketing, or distributing application programs conforming to IBMs application programming interfaces. If you are viewing this information in softcopy form, the photographs and color illustrations might not appear.
Trademarks
IBM, the IBM logo, Tivoli, the Tivoli logo, AIX, DB2, Informix, NetView, OS/2, Tivoli Enterprise, Tivoli Enterprise Console, TME, and WebSphere are trademarks or registered trademarks of International Business Machines Corporation or Tivoli Systems Inc. in the United States, other countries, or both. Microsoft, Windows, and Windows NT are registered trademarks of Microsoft Corporation in the United States, other countries, or both. Java and all Java-based trademarks and logos are trademarks or registered 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 other countries. Other company, product, and service names may be trademarks or service marks of others.
Notices
171
172
Index A
absolute object reference 2 absolute path 3 acl environment variable 161 adapter commands, summary of 6 identifiers for multiples on the same system 19, 90, 95 installing environment variables for 97 installing validation information for 100 showing installed validation information 53 Adapter Configuration Facility commands, summary of 6 interface, linking to configuration tools 98 adapter configuration profile adding an adapter configuration record for 17 adding an adapter type default for 92 modifying an adapter configuration record for 88 modifying an adapter type default for 92 modifying environment variables on adapter configuration profile endpoints 102 removing adapter configuration record from 44 showing adapter configuration records in 46 showing environment variables for endpoints 55 updating adapter configuration profile record modification time 133 adapter configuration record adding, for an adapter configuration profile 17 adding, for an adapter type default 92 modifying, for an adapter configuration profile 88 modifying, for an adapter type default 92 removing from an adapter configuration profile 44 showing, in an adapter configuration profile 46 adapter_host environment variable 161 adding adapter configuration record for an adapter configuration profile 17 adapter configuration record for an adapter type default 92 event group filters 24 administrator environment variable 161 assigned event groups, listing 28 assigning event groups 26 event groups, unassigning 30 operators to a console 26 attribute resetting event source 109 checking availability of the database server 123 event class definition file 21 validity of event class definition file 7 CHILD_OF_OSERV environment variable 159 chkclass command 5, 7 class environment variable 161 class file, deleting 75 class_name environment variable 161 Clean_Database task 136, 139 Clear_Closed_Events task 136, 140 Clear_Reception_Log task 136, 141 clearing, events from the event database 117, 119 Close_Event task 136, 142 command line executable tasks 136, 137 syntax ix command summaries adapter commands 6 Adapter Configuration Facility commands 6 console commands 4 database commands 5 event message commands 4 event server commands 5 rule base commands 5 source commands 4 commands chkclass 5, 7 postemsg 4, 8 postzmsg 4, 10 syntax ix tec_console 4, 12 TECAgent 4, 14 upgrade_gui.sh 5, 16 waddac 6, 17 wchkclass 5, 21 wconsole 4, 22 wcrtdefcfg 4, 35 wcrtebizgroups 4, 36 wcrtmtgroups 4, 37 wcrtnvgroups 4, 38 wcrtsrc 4, 39 wcrtteccfg 4, 40 wdbconfig.sh 5, 41 wdbmaint.sh 5, 42 wdelac 6, 44 wdelsrc 4, 45 wlsac 6, 46 wlsaddflt 6, 49 wlsadenv 6, 51 wlsadgui 6, 52 wlsadval 6, 53 wlsaeenv 6, 55 wlsemsg 4, 56 wlsesvrcfg 5, 58 wlssrc 4, 59 wmigcon 4, 60 wpostemsg (endpoint version) 4, 62 wpostemsg (managed node version) 4, 64 wpostzmsg (endpoint version) 4, 66 wpostzmsg (managed node version) 4, 68
B
BAROC file, importing into a rule base books see publications vi 76
C
cause_date_reception environment variable 161 cause_event_handle environment variable 161 Change_Severity task 136, 138
173
commands (continued) wrb 5, 70 wrb_default_rb 5, 85 wrbupgrade 5, 86 wruntask 136 wsendresp 4, 87 wsetac 6, 88 wsetaddflt 6, 92 wsetadenv 6, 97 wsetadgui 6, 98 wsetadval 6, 100 wsetaeenv 6, 102 wsetemsg 4, 105 wsetesvrcfg 5, 107 wsetsrc 4, 109 wsighup 6, 110 wstartesvr 5, 111 wstartmaint.sh 5, 112 wstatesvr 5, 113 wstopesvr 5, 114 wstopmaint.sh 5, 115 wstoptecgw 6, 116 wtdbclear 5, 117 wtdbclear.pl 5, 119 wtdbspace 5, 121 wtdbstat 5, 123 wtdumper 5, 124 wtdumprl 5, 126 wtdumptr 5, 128 wtecexport 4, 129 wtecimport 4, 131 wtouchac 6, 133 compiling, rules 72 completed tasks, generating report on 128 configuration parameters listing for an event server 58 setting for the event server 107 configuration tools linking to Adapter Configuration Facility interface showing installed link to 52 configure (definition in task context) 136 console commands, summary of 4 CONSOLE_NAME environment variable 159 conventions command syntax ix typeface viii copying event console 26 rule base 72 creating event console 27 event group 27 event groups for ebusiness.rls 36 event groups for maintenance_mode.rls 37 event groups for netview.rls 38 rule base at the event server 73 rule base target 73 rule pack 73 source on the event server 39 credibility environment variable 161 customer support see software support vii
database (continued) configuration scripts, running 41 reorganizing 42 server, checking availability 123 statistics, updating 42 date environment variable 161 date_event environment variable 162 date_reception environment variable 162 deleting class file 75 event console 28 event group 28 event group filters 28 rule base from the event server 75 rule base target 75 rule pack 75 rule set from a rule base 75 rule set from a rule pack 76 source from an event server list 45 directory names, notation viii DISPLAY environment variable 159 displaying event server status 113 message to the desktop of the administrator Dump_Event_Repository task 136, 143 duration environment variable 162
87
E
endpoint modifying environment variables on 102 showing environment variables for an adapter configuration profile 55 ENDPOINT environment variable 159 ENDPOINT_OID environment variable 159 environment variable acl 161 adapter_host 161 administrator 161 availability to tasks running with event 159 cause_date_reception 161 cause_event_handle 161 CHILD_OF_OSERV 159 class 161 class_name 161 CONSOLE_NAME 159 credibility 161 date 161 date_event 162 date_reception 162 descriptions of 159 DISPLAY 159 duration 162 ENDPOINT 159 ENDPOINT_OID 159 ev_key 162 event attribute 161 EVENT_CLASS 160 event_handle 162 event_hndl 162 examples program from Java console 164 task from Java console 163 for an adapter configuration profile endpoint, showing hostname 162 installing for an adapter 97 INTERP 160
98
D
database commands, summary of 5
55
174
environment variable (continued) LANG 160 last_modified_time 162 LD_LIBRARY_PATH 160 LIBPATH 160 msg 162 msg_catalog 162 msg_index 162 NLSPATH 160 num_actions 162 o_dispatch 162 on adapter configuration profile endpoints, modifying 102 origin 162 PATH 160 repeat_count 162 server_handle 163 server_hndl 163 server_path 163 severity 163 SHLIB_PATH 160 showing adapter-specific Event Integration Facility 51 SLOTS 160 source 163 status 163 sub_origin 163 sub_source 163 TEC_ADMIN 160 TEC_BIN_DIR 160 TEC_EXECTASK_DBCS 160 TEC_KB_DIR 160 TEC_MASTER_PORT 160 TEC_MASTER_START_TIMEOUT 160 TEC_RECV_BUFSIZE 160 TEC_RECV_LOG 160 TEC_RULE_CACHE_CLEAN_FREQ 161 TEC_RULE_CACHE_FULL_HISTORY 161 TEC_RULE_CACHE_NON_CLOSED_HISTORY 161 TEC_RULE_CACHE_SIZE 161 TEC_RULE_TRACE 161 TEC_RULE_TRACE_FILE 161 TISDIR 161 TZ 161 WLOCALHOST 161 environment variables, notation viii ev_key environment variable 162 event clearing from event database 117, 119 generating report of events received by event server 126 generating report on 124 in server database, listing 56 message commands, summary of 4 modifying event 105 number of, specifying for event cache 107 posting to the event server 8, 62, 64 resetting event source attributes 109 severity level 8, 10, 15, 63, 64, 67, 68 event attribute variable 161 event cache, specifying the number of events 107 event class definition file, checking validity of 7 listing 79 specifications, importing into a rule base 76 event class definition file, checking validity of 21 event console assign event group 26 assign operators 26 assigned event groups, listing 28
event console (continued) change name 29 copy 26 create 27 create event group 27 delete 28 delete event group 28 event group filter, changing name of 29 event group, changing name of 29 event groups, listing 29 filters, event group, adding 24 filters, event group, deleting 28 managing 22 show defined 28 starting 12 unassign event groups 30 unassign operators 30 event database clearing events from 117, 119 event group filters adding 24 changing names of 29 deleting 28 event groups adding for ebusiness.rls 36 adding for maintenance_mode.rls 37 adding for netview.rls 38 assigned, listing 28 changing names of 29 listing 29 event message commands, summary of 4 event server 56 commands, summary of 5 displaying status of 113 generating report of events received by 126 generating report on tasks completed by 128 list, deleting a source from 45 listing configuration parameters for 58 listing sources on 59 posting an event to 8, 62, 64 setting configuration parameters for 107 starting 111 stopping 114 Event Viewer 150 EVENT_CLASS environment variable 160 event_handle environment variable 162 event_hndl environment variable 162 Event_Query task 136, 144
F
filters, event group adding 24 changing names of 29 deleting 28 Find_Similar_Events task 136, 147 Forward_Event task 137, 149
G
gateway, stopping 116 generating event report 124 report on completed tasks 128
Index
175
H
hostname environment variable 162
I
identifiers for multiple adapters on the same system 19, 90, 95 importing BAROC file into a rule base 76 event class specifications into a rule base 76 rule pack into a rule base target 78 rule set into a rule base 77 rule set into a rule base target 78 rule set into a rule pack 77 installed link, to extended configuration tools, showing 52 installing environment variables for an adapter 97 link from the Adapter Configuration Facility interface to configuration tools 98 validation information for an adapter type 100 internationalization messages and postzmsg 8, 10 INTERP environment variable 160
modifying (continued) event 105 msg environment variable 162 msg_catalog environment variable 162 msg_index environment variable 162
N
name registry, described 2 names, registered 2 newsgroups vii NLSPATH environment variable 160 notation environment variables viii path names viii typeface viii num_actions environment variable 162
O
o_dispatch environment variable 162 object paths 2, 3 reference 2 referenced from command 2 online publications, accessing vi operators assigning to a console 26 unassigning from a console 30 ordering publications vi origin environment variable 162
L
LANG environment variable 160 language support packs and postzmsg 8, 10 last_modified_time environment variable 162 LD_LIBRARY_PATH environment variable 160 LIBPATH environment variable 160 link, to extended configuration tools, showing 52 linking, Adapter Configuration Facility interface to a configuration tool 98 listing assigned event groups 28 configuration parameters for an event server 58 event classes 79 event consoles, defined 28 event groups 29 events in database 56 received events 56 rule base targets 80 rule base, loaded 79 rule bases, defined on the event server 79 rule packs 79 rule sets 80 sources on the event server 59 loading, rule base onto the event server 78 Log_Event_To_File task 137, 150
P
parent directory path component 3 path component absolute 3 current directory 3 parent directory 3 relative 3 PATH environment variable 160 path names, notation viii paths, object 2, 3 Popup_Message task 137, 151 postemsg command 4, 8 posting, event to the event server 8, 62, 64 postzmsg command 4, 10 publications accessing online vi ordering vi
M
manuals see publications vi message, displaying to the desktop of the administrator 87 modification time, updating in an adapter configuration profile record 133 modifying adapter configuration record for an adapter configuration profile 88 adapter configuration record for an adapter type default 92 environment variables on adapter configuration profile endpoints 102
R
reception log, specifying time to retain events 107 registered name, described 2 relative path 3 removing adapter configuration record from an adapter configuration profile 44 repeat_count environment variable 162 reports completed tasks 128 events received by event server 126 resetting event source attributes 109
176
rule compiling 26, 27, 28, 29, 30, 72 rule base commands, summary of 5 consistent state conditions 70 copying 72 creating, at the event server 73 deleting, from the event server 75 importing into 70 listing defined 79 listing loaded 79 loading onto the event server 78 managing 70 setting properties 80 upgrading pre-3.7 versions 86 rule base target creating 73 deleting 75 listing 80 rule builder rules, upgrading 16 rule pack creating 73 deleting 75 importing into a rule base target 78 listing 79 rule set deleting from a rule base 75 deleting from a rule pack 76 importing into a rule base 77 importing into a rule base target 78 importing into a rule pack 77 listing 80 rule_builder.pro file 16
stopping event server 114 gateway 116 string, size limit ix sub_origin environment variable 163 sub_source environment variable 163 syntax for commands ix
T
T/EC Tasks dialog 136 task Change_Severity 136, 138 Clean_Database 136, 139 Clear_Closed_Events 136, 140 Clear_Reception_Log 136, 141 Close_Event 136, 142 descriptive names 136, 137 Dump_Event_Repository 136, 143 Event_Query 136, 144 Find_Similar_Events 136, 147 Forward_Event 137, 149 Log_Event_To_File 137, 150 output 137 overview 135 Popup_Message 137, 151 script file names 136, 137 Send_Email 137, 152 Send_Event 137, 153 Start_Maintenance 137, 155 Wake_Up_Netscape 137, 157 Task Output dialog 137 TEC_ADMIN environment variable 160 TEC_BIN_DIR environment variable 160 tec_console command 4, 12 TEC_EXECTASK_DBCS environment variable 160 TEC_KB_DIR environment variable 160 TEC_MASTER_PORT environment variable 160 TEC_MASTER_START_TIMEOUT environment variable 160 TEC_RECV_BUFSIZE environment variable 160 TEC_RECV_LOG environment variable 160 TEC_RULE_CACHE_CLEAN_FREQ environment variable 161 TEC_RULE_CACHE_FULL_HISTORY environment variable 161 TEC_RULE_CACHE_NON_CLOSED_HISTORY environment variable 161 TEC_RULE_CACHE_SIZE environment variable 161 TEC_RULE_TRACE environment variable 161 TEC_RULE_TRACE_FILE environment variable 161 TECAgent command 4, 14 TISDIR environment variable 161 Tivoli environment, setting up 1 Tivoli Software Information Center vi typeface conventions viii TZ environment variable 161
S
Send_Email task 137, 152 Send_Event task 137, 153 server_handle environment variable 163 server_hndl environment variable 163 server_path environment variable 163 setting configuration parameters for the event server 107 rule base properties 80 time to retain in reception log 107 severity environment variable 163 severity level, events 8, 10, 15, 63, 64, 67, 68 SHLIB_PATH environment variable 160 showing adapter configuration records in an adapter configuration profile 46 adapter-specific Event Integration Facility environment variables 51 adapter-type installed validation information 53 See also listing 46 SLOTS environment variable 160 software support, contacting vii source commands, summary of 4 creating, on the event server 39 deleting from an event server list 45 on event server, listing 59 source environment variable 163 Start_Maintenance task 137, 155 starting event console 12 starting, event server 111 status environment variable 163
U
unassigning event groups 30 operators from a console 30 updating, adapter configuration profile record modification time 133 upgrade_gui.sh command 5, 16
Index
177
upgrading pre-3.7 rule bases 86 rule builder rules 16
V
validation information adapter type, showing 53 installing for an adapter type variables, notation for viii 100
wtdbstat command 5, 123 wtdumper command 5, 124 wtdumprl command 5, 126 wtdumptr command 5, 128 wtecexport command 4, 129 wtecimport command 4, 131 wtouchac command 6, 133
W
waddac command 6, 17 Wake_Up_Netscape task 137, 157 wchkclass command 5, 21 wconsole command 4, 22 wcrtdefcfg command 4, 35 wcrtebizgroups command 4, 36 wcrtmtgroups command 4, 37 wcrtnvgroups command 4, 38 wcrtsrc command 4, 39 wcrtteccfg command 4, 40 wdbconfig.sh command 5, 41 wdbmaint.sh command 5, 42 wdelac command 6, 44 wdelsrc command 4, 45 WLOCALHOST environment variable 161 wlsac command 6, 46 wlsaddflt command 6, 49 wlsadenv command 6, 51 wlsadgui command 6, 52 wlsadval command 6, 53 wlsaeenv command 6, 55 wlsemsg command 4, 56 wlsesvrcfg command 5, 58 wlssrc command 4, 59 wmigcon command 4, 60 wpostemsg command (endpoint version) 4, 62 wpostemsg command (managed node version) 4, 64 wpostzmsg command (endpoint version) 4, 66 wpostzmsg command (managed node version) 4, 68 wrb command 5, 70 wrb_default_rb command 5, 85 wrbupgrade command 5, 86 wruntask command 136 wsendresp command 4, 87 wsetac command 6, 88 wsetaddflt command 6, 92 wsetadenv command 6, 97 wsetadgui command 6, 98 wsetadval command 6, 100 wsetaeenv command 6, 102 wsetemsg command 4, 105 wsetesvrcfg command 5, 107 wsetsrc command 4, 109 wsighup command 6, 110 wstartesvr command 5, 111 wstartmaint.sh command 5, 112 wstatesvr command 5, 113 wstopesvr command 5, 114 wstopmaint.sh command 5, 115 wstoptecgw command 6, 116 wtdbclear command 5, 117 wtdbclear.pl command 5, 119 wtdbspace command 5, 121
178
Printed in U.S.A.
SC32-1232-00

TEC - Comandos e Referência

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

TEC - Comandos e Referência

Uploaded by

Copyright:

Available Formats

IBM Tivoli Enterprise Console

Command and Task Reference

IBM Tivoli Enterprise Console

Command and Task Reference

Chapter 2. Tasks . . . . . . . . . . 135

Appendix. Configuration parameters

Chapter 3. Environment variables available to tasks. . . . . . . . . . 159

IBM Tivoli Enterprise Console: Command and Task Reference

About this book

Who should read this book

IBM Tivoli Enterprise Console library

Copyright IBM Corp. 2002

Accessing publications online

IBM Tivoli Enterprise Console: Command and Task Reference

Contacting software support

About this book

Conventions used in this guide

Operating system-dependent variables and paths

IBM Tivoli Enterprise Console: Command and Task Reference

Command line syntax

About this book

IBM Tivoli Enterprise Console: Command and Task Reference

Establishing the Tivoli environment

If you are using the C shell, run the following command:

Using Tivoli commands

Copyright IBM Corp. 2002

where Administrator is the resource and jerry is the instance.

IBM Tivoli Enterprise Console: Command and Task Reference

Tivoli Enterprise Console commands

Event message commands

wpostzmsg (managed node version)

IBM Tivoli Enterprise Console: Command and Task Reference

Event server commands

Rule base commands

wrb wrb_default_rb wrbupgrade

Adapter Configuration Facility commands

IBM Tivoli Enterprise Console: Command and Task Reference

IBM Tivoli Enterprise Console: Command and Task Reference

IBM Tivoli Enterprise Console: Command and Task Reference

The change takes effect immediately.

IBM Tivoli Enterprise Console: Command and Task Reference

IBM Tivoli Enterprise Console: Command and Task Reference

IBM Tivoli Enterprise Console: Command and Task Reference

IBM Tivoli Enterprise Console: Command and Task Reference

waddac -a -m OUT -p Log=System 1 ACPprofile

IBM Tivoli Enterprise Console: Command and Task Reference

crtconsole crteg crtoperator delconsole deleg delegflt deloperator lsassigneg

IBM Tivoli Enterprise Console: Command and Task Reference

Option lsconsole lsconsoleup lseg lsoperator setconsole

Common Suboption h host[:port]

IBM Tivoli Enterprise Console: Command and Task Reference

IBM Tivoli Enterprise Console: Command and Task Reference

IBM Tivoli Enterprise Console: Command and Task Reference

IBM Tivoli Enterprise Console: Command and Task Reference

crtoperator Examples The following example creates an operator called achan.

IBM Tivoli Enterprise Console: Command and Task Reference

wconsole.cmd -lsassigneg -C NetAdmin

The output displayed by this command is:

The output displayed by this command is:

The output displayed by this command is:

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

IBM Tivoli Enterprise Console: Command and Task Reference