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