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