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