Summary of the content on the page No. 1
IBM Tivoli Enterprise Console
Adapters Guide
Version 3.8
GC32-0668-01
Summary of the content on the page No. 2
Summary of the content on the page No. 3
IBM Tivoli Enterprise Console Adapters Guide Version 3.8 GC32-0668-01
Summary of the content on the page No. 4
Note Before using this information and the product it supports, read the information in “Notices” on page 165. First Edition (September 2002) This edition applies to version 3, release 8, 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 restric
Summary of the content on the page No. 5
Contents Preface .............. vii Chapter 2. AS/400 Alert Adapter.... 23 Who Should Read This Guide........vii Adapter Files..............23 What This Guide Contains .........vii Configuration File ...........24 Publications.............. viii Class Definition Statement File.......25 IBM Tivoli Enterprise Console Library.... viii SELECT Statement Example.......25 Prerequisite Publications......... viii FETCH Statement Example.......25 Related Publications .......... viii Keywords.............2
Summary of the content on the page No. 6
Configuration File ............56 Warm Start .............86 Format File ..............57 Stopping the Adapter..........86 Events Listing .............58 Events Listing .............86 Event Class Structure..........58 Event Class Structure..........86 TECADNW4.NLM............61 Rules Listing..............88 tecadnw4.nlm ............62 SNMP Traps..............88 Troubleshooting the NetWare Log File Adapter . . 63 Generic Traps.............88 Enterprise-specific Traps.........88 Creating a New SN
Summary of the content on the page No. 7
Format File.............131 Generating a New Class Definition Statement Non-English Format Files .......132 File for a TME Adapter.........153 Registry Variables............132 Generating a New Class Definition Statement Low Memory Registry Variables......134 File for a Non-TME Adapter .......153 Adapter Administrator Roles for Windows NT . . 134 Starting the Adapter...........135 Appendix C. Class Definition Stopping the Adapter...........135 Statement File Reference ...... 155 Events Listing .
Summary of the content on the page No. 8
vi IBM Tivoli Enterprise Console: Adapters Guide
Summary of the content on the page No. 9
Preface ® ® The IBM Tivoli Enterprise Console Adapters Guide provides detailed descriptions ® for the currently available IBM Tivoli Enterprise Console adapters. Who Should Read This Guide This guide is for IBM Tivoli Enterprise Console administrators who configure event adapters and IBM Tivoli Enterprise Console gateways. You should have prior knowledge of the following: ® v UNIX operating system ® ® ® v Microsoft Windows 2000 or Windows NT operating systems v Tivoli Management Framework v Adap
Summary of the content on the page No. 10
Publications This section lists publications in the IBM Tivoli Enterprise Console library and any other related documents. It also describes how to access Tivoli publications online and how to make comments on Tivoli publications. IBM Tivoli Enterprise Console Library The following documents are available in the IBM Tivoli Enterprise Console library: v Tivoli Event Integration Facility User’s Guide, GC32-0691 Discusses how to develop your own event adapters that are tailored to your network envi
Summary of the content on the page No. 11
Accessing Publications Online Publications in the product libraries are included in PDF or HTML formats, or both, on the product CD. To access publications using a Web browser, open the infocenter.html file, which is located in the appropriate publications directory on the product CD. When IBM publishes an updated version of one or more online or hardcopy publications, they are posted to the Tivoli Information Center. You can access updated publications in the Tivoli Information Center from the
Summary of the content on the page No. 12
other information that you must use literally appear in bold. Names of windows, dialogs, and other controls also appear in bold. Italics Variables and values that you must provide appear in italics. Words and phrases that are emphasized also appear in italics. Monospace Code examples, output, and system messages appear in a monospace font. Operating System-dependent Variables and Paths This book uses the UNIX convention for specifying environment variables and for directory notation. When using
Summary of the content on the page No. 13
Chapter 1. Understanding Adapters Event adapters are software programs that collect information, perform local filtering, and convert relevant events into a format that can be used by the IBM Tivoli Enterprise Console product. Because adapters are located on or near their event sources and can perform local filtering of events, the adapters create a minimal amount of additional network traffic. Adapters use a minimal amount of system resources to perform their functions. Network management appli
Summary of the content on the page No. 14
bundles them up and forwards them on to an event server. A TME interface is used for communications. The IBM Tivoli Enterprise Console gateway uses a connection-oriented service to the server by default. A connection-oriented service means that a connection is established when the adapter is initialized and the connection is maintained for all events to be sent. The IBM Tivoli Enterprise Console gateway runs on the same managed node as the Tivoli Management Framework gateway that is providing th
Summary of the content on the page No. 15
The following figure shows an example of the IBM Tivoli Enterprise Console product and Tivoli Management Framework component relationships in a network with endpoints. How Events Get to the Event Server From a Managed Node For network management OpenView adapters, events are sent from the managed node adapter directly to the event server using a TME interface. In other words, the oserv of the managed node that the adapter runs on sends the event to the oserv of the event server when these are se
Summary of the content on the page No. 16
The event server can receive events in both UTF-8 encoding or the encoding of the event server host. The event server automatically determines the type of encoding (UTF-8 or non-UTF-8) of an event by evaluating a particular flag in the event data. The adapter automatically reads the format file from the appropriate directory. If the adapter is sending events to an event server running a version earlier than the IBM Tivoli Enterprise Console 3.7 product, the format files in the localization direc
Summary of the content on the page No. 17
Attribute Name Contents acl The list of authorization roles that enables an administrator to modify the event. adapter_host The host on which the adapter is running. administrator The administrator who acknowledged or closed the event. cause_date_ The cause_date_reception attribute is used to link an effect event to reception its cause event. This value is set to the value of the date_reception attribute of the cause event. cause_event_ handle The cause_event_handle attribute is used to link an
Summary of the content on the page No. 18
Attribute Name Contents server_path Stores information describing the rule engines that an event has passed through. server_path has the following definition: server_path list_of_strings; Each element in the list represents one rule engine that the event has visited, and each element contains a rule engine identifier, server number, reception ID, and event handle. The following is an example of a list: chair 1 12121212 3 where: chair The rule engine identifier 1 The server number 12121212 The ev
Summary of the content on the page No. 19
Attribute Name Contents status The status of an event. It is initially set to OPEN or to a default value specified by the event class. Possible values during an event lifetime are as follows: ACK An administrator or rule has acknowledged the event. CLOSED An administrator or rule has fixed the problem that was reported by the event. An event adapter can also send an event with a status of CLOSED to indicate that a previously received event of the specified class should have its status changed to
Summary of the content on the page No. 20
File Type Description Configuration Defines configuration options for adapters. Error Defines error logging and tracing options for the adapter. Format Defines the format of messages and matches them to event classes for the UNIX log file, NetWare log file, OS/2, and Windows and Windows NT event log adapters. Installation script Configures the adapter to start when the operating system starts. Object identifier Defines object-identifier-to-name mappings for the ® NetView /6000, OpenView, and SNM
