GC32-0668-01
Adapters Guide
IBM Tivoli Enterprise Console
Version
Page
GC32-0668-01
Adapters Guide
IBM Tivoli Enterprise Console
Version
First Edition September
Chapter 1. Understanding Adapters
Contents
Preface
Chapter 2. AS/400 Alert Adapter
iv IBM Tivoli Enterprise Console Adapters Guide
Appendix C. Class Definition
vi IBM Tivoli Enterprise Console Adapters Guide
Preface
Who Should Read This Guide
What This Guide Contains
Related Publications
Publications
IBM Tivoli Enterprise Console Library
Prerequisite Publications
Conventions Used in this Guide
Accessing Publications Online
Providing Feedback about Publications
Contacting Customer Support
Monospace
Operating System-dependent Variables and Paths
bold
Italics
How Events Get to the Event Server From an Endpoint
Chapter 1. Understanding Adapters
Adapter Overview
How Events Get Sent to the Event Server
The TME adapters currently supported for an endpoint are the following
Internationalization Support for Events
How Events Get to the Event Server From a Managed Node
How Events Get to the Event Server From a Non-TME Adapter
Event Attributes
Event Information
Attribute Name
serverpath listofstrings
Stores information describing the rule engines that an event has
v datereception v eventhandle v serverhandle
Adapter Files
Cache File
Example
Configuration File
File Location
File Format
BufEvtPath
AdapterErrorFile=path
AdapterCdsFile=path
BufEvtMaxSize
FilterMode
FilterCache
getporttotaltimeoutusec
getporttimeoutseconds
getporttimeoutusec
getporttotaltimeoutseconds
ServerPort
ServerLocation
Event Filtering
TestMode
1. Set FilterMode to IN
1. Set FilterMode to IN
Event Buffer Filtering
BAROC File
Example
2. Set BufferEvents to YES
Example
Rule File
Format File
Example
Example
Class Definition Statement File
UTILS
Error File
modulename errorlevel outputfile
ERROR
FETCH
Initial Files
KERNEL
SELECT
Managed Node Adapters
Troubleshooting Adapters
Adapter Startup Errors
All Adapters
22 IBM Tivoli Enterprise Console Adapters Guide
Non-TME Adapters
QSYS.LIB/QUSRSYS.LIB/CFGALERT.FILE/ALRCDS.MBR The CDS file
Chapter 2. AS/400 Alert Adapter
Adapter Files
QSYS.LIB/QUSRSYS.LIB/CFGALERT.FILE/ALRCFG.MBR
BufEvtPath
Configuration File
ENDTECADP
AdapterCdsFile
Keywords
SELECT Statement Example
FETCH Statement Example
Class Definition Statement File
$ALERTCDPT
Configuring the AS/400 Alert Filters Default Alert Filter
PERMANENT, TEMPORARY, or IMPENDING PROBLEM $HOSTNAME
$ADAPTERHOSTSNANODE
Integrating with an Existing Alert Filter
Starting the Adapter
CRTDTAQ DTAQlibrary/name TYPE*STD MAXLEN592 FORCE*NO SEQ*FIFO
DESCRIPTION
Authorization
STRTECADP
SYNOPSIS
Stopping the Adapter
Authorization
ENDTECADP
Context
Comments
Examples
ENDTECADP EVTADPMYCFG OPTION*CNTRLD DELAY60
ENDTECADP EVTADPALERTADP
Event Class
Events Listing
Event Class Structure
Default Event
Default Event
Event Class
Severity
Troubleshooting the AS/400 Adapter
Default Severity
Alert Type
Adding an Autostart Job to QSYSWRK
Logging Events in Test Mode
TCP/IP Considerations
Starting an AS/400 Adapter after an IPL
Changing the AS/400 Startup Program
Multiple AS/400 Alert Adapters
QSECOFR
To create the configuration file, perform the following steps
Configuration File
38 IBM Tivoli Enterprise Console Adapters Guide
POSTEMSG
Context
Examples
QSYS.LIB/QUSRSYS.LIB/CFGMSG.FILE/MSGCDS.MBR The CDS file
Chapter 3. AS/400 Message Adapter
Adapter Files
QSYS.LIB/QUSRSYS.LIB/CFGMSG.FILE/MSGCFG.MBR
40 IBM Tivoli Enterprise Console Adapters Guide
Configuration File
AdapterCdsFile
JobDescription
FETCH Statement Example
MAP Statement Example
Class Definition Statement File
SELECT Statement Example
IMMED
$ADAPTERHOST
$ALERTOPTION
DEFER
$MSGSEVERITY
$MSGFILENAME
$MSGFILELIBRARY
$MSGLIBRARYUSED
$SUBORIGIN
$SENDPROGRAMNAME
$SENDTIME
$SENDUSERPROFILE
Starting the Adapter
Comments
Flags
Authorization
STRTECADP
Chapter 3. AS/400 Message Adapter
Stopping the Adapter
ENDTECADP
Authorization
ENDTECADP EVTADPname *ALL OPTION*CNTRLD *IMMED DELAYseconds
DELAYseconds
ENDTECADP EVTADPMYAPP OPTION*CNTRLD DELAY60
Examples
ENDTECADP EVTADPSYSOPR
hostname
Events Listing
Event Class Structure
subsource
WRKJOB JOBname
Troubleshooting the AS/400 Adapter
Logging Events in Test Mode
TCP/IP Considerations
Starting an AS/400 Adapter after an IPL
Adding an Autostart Job to QSYSWRK
Changing the AS/400 Startup Program
DONE RETURN CHGVAR VAR&CPYR VALUE&CPYR ENDPGM
Using FTP to Execute AS/400 Commands
Multiple AS/400 Message Queues
Configuration File
54 IBM Tivoli Enterprise Console Adapters Guide
Adapter Files
Chapter 4. NetWare Log File Adapter
NetWare Log File Adapter Reference Information
Error File
EventId
Prefiltering NetWare Events
Configuration File
Source
PreFilterMode
Format File
PollInterval
PreFilter
nwmsgid
Events Listing
Event Class Structure
nwmsgversion
alertclass
alertlocus
60 IBM Tivoli Enterprise Console Adapters Guide
The following NetWare events are defined in the BAROC file
TECADNW4.NLM
Examples
tecadnw4.nlm
Flags
Description
Troubleshooting the NetWare Log File Adapter
64 IBM Tivoli Enterprise Console Adapters Guide
Determining the OpenView NNM Version
Chapter 5. OpenView Adapter
OpenView Driver
Reception of OpenView Messages
agent-addr
Incoming Messages Format
Event Correlation With NNM
enterprise
Chapter 5. OpenView Adapter
Determining the OVsnmpEventOpen Filter Value
Testing Event Correlation With NNM
Testing Tools
This trace file is located in $OVLOG/ecs/ecs-instance#/ecsin.evt#
Event Correlation Example
Adapter Files
WellBehavedDaemon
OpenView Event Example
Class Definition Statement File
HPOVFilter=filter
$ENTERPRISE
Object Identifier File
Keywords
$COMMUNITY
name object identifier
LRF File
Starting and Stopping the Adapter
Error File
subsource
Events Listing
Event Class Structure
source
Event Class
Default Severity
Node Marginal
OpenView Traps SNMP Traps
OpenView Traps
50462720 Warnings
50790403
Troubleshooting the OpenView Adapter
50790402
Segment Marginal
78 IBM Tivoli Enterprise Console Adapters Guide
The adapter installation assist executable file
Chapter 6. OS/2 Adapter
Configuration File
install.exe
Format File
Starting the Adapter
UnmatchLog
source OS2 subsource OS2
Stopping the Adapter
Events Listing
Event Class Structure
Troubleshooting the OS/2 Adapter
Reception of SNMP Messages
Server Configuration
Chapter 7. SNMP Adapter
SNMP Driver
Keywords
SNMP Event Example
Configuration File
Class Definition Statement File
$AGENTADDR
Error File
Object Identifier File
Starting and Stopping the Adapter
Events Listing
Cold Start
Warm Start
Stopping the Adapter
Proxy agent that forwarded the event to the adapter
adapterhost
Host on which the adapter runs
forwardingagent
Rules Listing
SNMP Traps Generic Traps
Enterprise-specific Traps
Creating a New SNMP Trap Event
BAROC File Changes
v tecadsnmp.baroc v tecadsnmp.cds v tecadsnmp.oid
Agent-independent Data
SYNTAX INTEGER 0..4294967295 ACCESS not-accessible
90 IBM Tivoli Enterprise Console Adapters Guide
Page
Class Definition Statement File Changes
Object Identifier File Changes
Troubleshooting the SNMP Adapter
94 IBM Tivoli Enterprise Console Adapters Guide
c configurationfile
Chapter 8. IBM Tivoli Enterprise Console Gateways
Controlling Event Traffic at the Gateway
Example
3. Calculate the value for the EventSendThreshold keyword
Microsoft Windows
Worksheets and Calculations
Configuration File
UNIX
$TIVOLIHOME/tec/$ACTYPE.cache@ EventServer#region on endpoints
tec/gatewaycache@EventServer#tmr-central
UNIX /etc/Tivoli/tec/cache@EventServer#region
Windows $DBDIR/cache.dat@EventServer#region on managed nodes
MaxGWCacheSizeMegs
GatewayTMEAckEnabled
GatewayQueueSize
GatewaySendInterval
The default value is @EventServer
Event Server Configuration
Chapter 9. UNIX Log File Adapter
Starting the Adapter
Running Multiple UNIX Log File Adapters
Stopping the Adapter
init.tecadlogfile -s start stop AdapterID
tecadlogfile.cfg
Configuration File
logdefault.rls
Adapter Files
Events Listing
Error File
Format File
Class Definition Statement File
Event Class
Default Severity
Default Severity
Event Class
106 IBM Tivoli Enterprise Console Adapters Guide
Event Class
Default Severity
PrinterPaperOut PrinterTonerLow PrinterOffline PrinterOutputFull
Default Rules
PrinterPaperOut PrinterTonerLow PrinterOffline PrinterOutputFull
PrinterPaperJam PrinterDoorOpen
Troubleshooting the UNIX Log File Adapter
RepeatedLoginFailure RepeatedLoginFailureFrom RootLoginSuccessFrom
LogfileAmd LogfileCron LogfileOserv LogfileDateSet
110 IBM Tivoli Enterprise Console Adapters Guide
tecadwins.exe
Chapter 10. Windows Event Log Adapter
Adapter Files
tecinstlwin.cmd
HostnameIsAdapterHost
Configuration File
DEFAULT
tecadwin.baroc
PreFilterLog=lognameEventId=value EventType=valueSource=value
NumEventsToCatchUp
PreFilterLog=ApplicationSource=re’TEC.*’
SpaceReplacement
PreFilterMode
WINEVENTLOGS
EventId
Prefiltering Windows Log Events
Source
Jan 15 150619 1998 0 Error N/A ServiceControlManager 7024 \
The UPS service terminated with service-specific error
Format File
DirectoryEventsProcessed
Registry Variables
ApplicationEventsProcessed
ApplicationEventsProcessedTimeStamp
FileReplicationEventsProcessed
DirectoryEventsProcessedTimeStamp
DNSEventsProcessed
DNSEventsProcessedTimeStamp
SystemEventsProcessed
Low Memory Registry Variables
TECInstallPath
SecurityEventsProcessedTimeStamp
Starting the Adapter
Adapter Administrator Roles for Windows
1. Select Create Administrators from the Administrators icon
3. Type in SYSTEM in the Set Login Names dialog
hostname
Event Class Structure
source NT
subsource
NTPrinterWasSet
tecadwin Command
EXAMPLES
tecadwin
SYNOPSIS
DESCRIPTION
Troubleshooting the Windows Event Log Adapter
126 IBM Tivoli Enterprise Console Adapters Guide
Adapter Files
Chapter 11. Windows NT Event Log Adapter
tecadnt.err
Configuration File
The error file
DEFAULT
Chapter 11. Windows NT Event Log Adapter
HKEYLOCALMACHINE\SYSTEM\ CurrentControlSet\Services\ TECNTAdapter\
NumEventsToCatchUp
PreFilterLog=lognameEventId=valueEventType=valueSource=value
130 IBM Tivoli Enterprise Console Adapters Guide
Prefiltering Windows NT Log Events
SpaceReplacement
PreFilterMode
EventType
Format File
EventId
Source
132 IBM Tivoli Enterprise Console Adapters Guide
Non-English Format Files
Registry Variables
ApplicationEventsProcessed
SecurityEventsProcessed
TECInstallPath
ApplicationEventsProcessedTimeStamp
PollingInterval
Low Memory Registry Variables
Adapter Administrator Roles for Windows NT
1. Select Create Administrators from the Administrators icon
3. Type in SYSTEM in the Set Login Names dialog
Event Class Structure
Starting the Adapter
Stopping the Adapter
Events Listing
Default Severity
Event Class
136 IBM Tivoli Enterprise Console Adapters Guide
tecadnt Command
c ConfigFile
tecadnt
tecadnt.exe -d -c ConfigFile -L none EventLog
Authorization none Arguments
Troubleshooting the Windows NT Event Log Adapter
140 IBM Tivoli Enterprise Console Adapters Guide
Appendix A. Files Shipped with Adapters
142 IBM Tivoli Enterprise Console Adapters Guide
Appendix A. Files Shipped with Adapters
144 IBM Tivoli Enterprise Console Adapters Guide
Format File Location
Appendix B. Format File Reference
v %lengths
Format Specifications
v %t
Log File Example
v %lengths
v %lengths+
su ’su su ’su
succeeded for succeeded for
on on
Mappings
Windows NT Example
LABEL keyword
DEFAULT keyword
string constant
PRINTF statement
Additional Mapping Considerations
The following list describes how values were assigned
UNIX log file
Activating Changes Made with a Format File
Generating a New Class Definition Statement File for a TME Adapter
NetWare log file
UNIX log file
Windows event log
Windows NT event log
NetWare log file
Appendix C. Class Definition Statement File Reference
File Format
Operators
Class Definition Statement File Details
SELECT
FETCH
Note AS/400 adapters do not support KEY parts in CDS files
FETCH Statement
1 ATTR=,$TYPE,VALUE=,4
1$TYPE=4
nexpression
MAPDEFAULT Statement
MAP Statement
Example
name objectidentifier
Object Identifier to Name Translation
SELECT
Class Definition Statement File Syntax Diagrams
keydecl = KEY ’’ kop ’,’ vopval ’’ aop = ’=’ PREFIX SUFFIX EXISTS
Page
164 IBM Tivoli Enterprise Console Adapters Guide
Notices
IBM Corporation 2Z4A/101 11400 Burnet Road Austin, TX 78758 U.S.A
Notices
Trademarks
168 IBM Tivoli Enterprise Console Adapters Guide
Obsolete term for
Glossary
Page
5, 6
Index Special characters
10, 24
CDS file keywords continued
Page
files continued
Page
Page
TCP/IP continued
Page
180 IBM Tivoli Enterprise Console Adapters Guide
Page
GC32-0668-01
Program Number 5698-TEC Printed in U.S.A