IBM FileNet System Monitor FSM Event Integration Whitepaper SC

Transcription

1 IBM FileNet System Monitor FSM Event Integration Whitepaper SC

2 Before using this information and the product it supports, read the information in Notices at the end of this document. This edition applies to version of IBM FileNet System Monitor (product number 5724-R93) and to all subsequent releases and modifications until otherwise indicated in new editions. Copyright CENIT AG, Germany; Copyright 2005, 2010 IBM Corp., USA US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

3 About this document This document describes different ways on how to integrate FSM Events (forward events) into Enterprise Systems Management tools like IBM Tivoli Monitoring (ITM), IBM Tivoli Enterprise Console (T/EC), HP OpenView Operations (OVO), CA Unicenter and others. The first chapter (Activating reporting / logging of events) describes the technical details on how to generate report files (logfiles) out of FSM events (permanent writing of event contents into one or more files).. This mechanism can be used to forward events into almost all ESM system (IBM Tivoli Monitoring or ITM, HP OpenView, CA Unicenter and others). For those systems not supporting logfile based event integration FSM additionally supports other integration technologies. The second vendor independent way to forward events is the SNMP based integration. FSM supports all important and industry leading SNMP versions. The corresponding chapter describes the various SNMP versions supported by FSM. Another way to forward events from FSM to an ESM system is based on a direct access to the FSM database. This passive way can for instance be implemented by the IBM ITM version 6 Universal Agent. The related chapter gives more information about the FSM database access mode. Additionally FSM supports vendor specific Event integration. FSM can directly communicate with IBM Tivoli Enterprise Console (via EEIF API) and with HP OpenView Operations (via OVO API). See the related sections for further information. FSM provides another powerful way to process events: triggering of external Command Line tool (CLI) like CA Unicenters cawto, Tivoli s wpostemsg/postemsg or HP OpenView s opcmsg or the CLI of a Trouble Ticketing System (TTS). This kind of integration needs to be configured manually on the FSM server, because the parameter settings depend on customer s requirements.

4 Activating reporting (logging) of events You can activate reporting for events of one or more datatypes. The events can be filtered by severity (e.g. only report syslog events of severity CRITICAL and FATAL). Parameters for reporting Datatypes for reporting Comma-separated list of datatypes that must be included in report file. You can find the list of all known FSM datatypes (data sources) in the field-specific online help. The datatype calamon is used for all monitoring events. There is currently no way to filter for specific monitoring events (e.g. only monitoring events for Oracle). You must specify a list of datatypes as well as a list of severities to activate reporting. Severities for reporting Comma-separated list of severities that must be included in report file. Valid severities are: HARMLESS, WARNING, MINOR, CRITICAL, ERROR and FATAL and numerical values between 0 (harmless) and 3 (fatal). You must specify a list of severities as well as a list of datatypes to activate reporting. Template for reporting The file specified in this field is used as template for the report. If this field is left empty, a multi-line default format will be used. The template report.tpl shipped with FSM provides a single-line report with the slots date, hostname, severity, $CLASS, value and logfilename, separated by ;; (double semicolon). See the description of reportemit in CALA Users Guide for an explanation of how to create your own template file. Outputfile for reporting This is the name of the report file that is created on the FSM server. You can either write a report with a fixed name or add variables to the filename to include the date or a timestamp. See the description of reportemit in FSMCALA Users Guide for an explanation of valid variables in the report filename. See chapter "Event forwarding to an ESM System via Logfile" for further information about this topic. Adjusting the selection of events that are reported This section describes how the events for reporting are identified. For each datatype that is listed in the Datatypes for reporting field, a mapping is created. This mapping creates the slot $report_flag in all events that have a severity that is listed in the field and sets this slot to 1. All events where $report_flag exists and is set to 1 will be included in the report file. You can use this slot to customize the selection of events.

5 Event forwarding to an ESM System via Logfile FSM supports the generation of report (log) files. Besides SNMP trap based event forwarding this is the most common way to forward events from one event management system to another. FSM server supports the generation of free formatted report / logfiles that can be parsed by other systems. Please refer to chapter "Activating reporting (logging) of events" of the FSM Install Guide for detailed information on how to activate and configure this functionality. Note: This is the common way to forward FSM events to IBM Tivoli Monitoring Version 6 and to IBM Tivoli Enterprise Console. Logfile based forwarding to IBM ITM v6 One way to forward FSM events to IBM ITM version 6 is to create a FSM logfile. The IBM ITM Universal Agent can parse the FSM logfile, contents is transformed into the IBM ITM system. IBM ITM consultants are used to configure this way of event integration. The configuration of the logfile name and format is done with the graphical FSM installer during FSM installation / configuration. Event integration to IBM ITM v6 via direct FSM Database access A passive way to integrate FSM events is the IBM ITM v6 Universal Agent based integration. This is a passive integration, because FSM doesn t forward events to ITM, but IBM ITM v6 collects the FSM Events, which are stored in a DB2, MSSQL or MySQL database, directly via THE ITM ODBC functionality. IBM ITM administrators are used to configure such integration, too. In this case FSM is just another Event source for IBM ITM v6. On the IBM Tivoli Monitoring system the new data source need to be defined, too.

6 Event integration to an (SMTP) system FSM can forward events as SMTP s. This way might be the preferred way, if the customer has an based escalation process (for instance an Trouble Ticketing system) in place. The configuration of one or more recipients is done by the graphical FSM installer during FSM server installation / configuration. Event integration to an ESM System via SNMP FSM servers support forwarding of FSM events as SNMP traps to any SNMP Manager. This is the easiest and most common way to forward FSM events into an existing Enterprise System Management environment. The system supports the following SNMP versions: SNMP V1 SNMP V2C SNMP V2C inform The SNMP forwarding mechanism needs to be configured during CALA Server installation. Please consult the CALA Users Guide, Chapter Installation, sub-chapter Non-Tivoli CALA Installer for further information about CALA installation. Prepared SNMP MIB files If you plan to forward SNMP messages to an SNMP Manager you need to import the appropriate MIB files into your SNMP Manager. You will find prepared MIB files on the installation media in the directory <INSTALL_MEDIUM_DIR>/MISC/SNMP. SNMP Version cenit_snmp_v1.mib cenit_snmp_v2.mib MIB Filename SNMPv1 SNMPv2c and SNMPv2c inform Please consult the SNMP Managers user guide for further information. NOTE You can import both files into your SNMP Manager.

7 Prepared SNMP trap definition files SNMP Managers (IBM Tivoli NetView, HP OpenView, Enterasys Networks NetSight Element Manager, CA Unicenter, e.g.) need trap definition files to handle SNMP traps correctly. You will find several trap definition files for FSM on the installation media. Filename Function cenit_trapd_ibm_nv_unix.conf: FSM SNMPv1 and SNMPv2 trapd.conf extensions for IBM NetView for UNIX Version 7 and newer cenit_trapd_ibm_nv_windows.conf: FSM SNMPv1 trapd.conf extensions for IBM NetView for Windows and IBM NetView for UNIX prior Version 7 cenit_trapd_hpov_and_nem.conf: FSM SNMPv1 and SNMPv2 trapd.conf extensions for HP Openview Node Manager and Enterasys Networks NetSight Element Manager. Note: This MIB file can be used for CE Unicenter SNMP integration, too. cenit.trapdef: Enterasys Networks NetSight Element Manager trap definition file for FSM SNMPv1 traps (enterprise cenit) cenitnotifications.trapdef Enterasys Networks NetSight Element Manager trap definition file for FSM SNMPv2 traps (enterprise cenitnotifications) If you want to forward FSM SNMP traps to another SNMP Manager you may need to change one of the prepared trap definition files. Please consult your SNMP Manager s user guide for further information about trap definition settings. The configuration of the SNMP version and destination is done with the graphical FSM installer during FSM installation / configuration. Event forwarding via vendor specific CLI tool FSM is able to trigger an external command line tool (CLI) from any vendor. Based on this method FSM events can directly be sent to an ESM system or for instance to a Trouble Ticketing system. The broad list of ESM and TTS tools doesn t allow preconfigured CLI settings; this requires manual adjustment on the FSM server. The following list gives an short overview about existing vendor specific event integration command line tools: CA Unicenters cawto IBM Tivoli s wpostemsg/postemsg HP OpenView s opcmsg CLI tools of Trouble Ticketing Systems (TTS). SMS (Short Messaging system CLI tools

8 Event integration to IBM Tivoli Enterprise Console (T/EC) via Tivoli EEIF API This kind of integration is based on the Tivoli Framework communication. Secure (Tivoli Endpoint) and unsecure (TCPIP) versions of the FSM-to-TEC communication component are available. The secure T/EC integration requires an Tivoli LCF endpoint be installed and configured on the FSM server. NOTE This integration does only support Tivoli Enterprise Console (T/EC) Event forwarding to HP OpenView Operations (OVO) FSM supports direct event integration FSM events into HP OpenView Operations (OVO) based on the OVO API. On the FSM server a HP Open-View Operations Agent has to be installed to forward events to HP OpenView Operations system. Events from FSM managed systems (clients) are forwarded by the FSM server communication via HP OpenView Agent to the HP Open View Server. IMPORTANT There are different types of HP OpenView Agents available. FSM message forwarding is only supported with the https-agents (HP OpenView OVO 8.x HTTPS Agent for Windows and HP-UX). Refer to the HP OpenView documentation about details on how to install and configure the required HP OpenView Agent from the HP OpenView Server on the FSM server. There is no need to install any HP OVO agent or software on FSM managed systems (clients). The FSM forwarding component uses the same mechanism as the HP Open-View command "opcmsg". If there are any issues with the transaction of FSM messages to the OVO system (for example the sent events are not received by the server), it is recommended to check the HP OpenView documentation about "how to send messages via opcmsg". If "opcmsg" works correctly from the FSM server then the FSM component will work correctly, too. Please refer to the FSM Release Notes regarding supported OVO agent version and required OVO patches.

9 Copyright Notices IBM FileNet System Monitor (30 July 2010) Copyright CENIT AG, Germany; Copyright 2005, 2010 IBM Corp, USA including this documentation and all software. No part of this publication may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any computer language, in any form or by any means, electronic, mechanical, magnetic, optical, chemical, manual, or otherwise, without prior written permission of the copyright owners. The copyright owners grants you limited permission to make hardcopy or other reproductions of any machine-readable documentation for your own use, provided that each such reproduction shall carry the original copyright notice. No other rights under copyright are granted without prior written permission of the copyright owners. The document is not intended for production and is furnished as is without warranty of any kind. All warranties on this document are hereby disclaimed including the warranties of merchantability and fitness for a particular purpose. Note to U.S. Government Users Documentation related to restricted rights Use, duplication or disclosure is subject to restrictions set forth in GSA.

10 Notices This information was developed for products and services offered in the U.S.A. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-ibm product, program, or service. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to: IBM Director of Licensing IBM Corporation North Castle Drive Armonk, NY U.S.A. For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to: IBM World Trade Asia Corporation Licensing 2-31 Roppongi 3-chome, Minato-ku Tokyo , Japan The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you. This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice. Any references in this information to non-ibm Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk. IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you. Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact: IBM Corporation J46A/G4 555 Bailey Avenue

11 San Jose, CA U.S.A. Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee. The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any equivalent agreement between us. Any performance data contained herein was determined in a controlled environment. Therefore, the results obtained in other operating environments may vary significantly. Some measurements may have been made on development-level systems and there is no guarantee that these measurements will be the same on generally available systems. Furthermore, some measurements may have been estimated through extrapolation. Actual results may vary. Users of this document should verify the applicable data for their specific environment. Information concerning non-ibm products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-ibm products. Questions on the capabilities of non-ibm products should be addressed to the suppliers of those products. All statements regarding IBM's future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only. This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental. COPYRIGHT LICENSE: This information contains sample application programs in source language, which illustrate programming techniques on various operating platforms. You may copy, modify, and distribute these sample programs in any form without payment to IBM, for the purposes of developing, using, marketing or distributing application programs conforming to the application programming interface for the operating platform for which the sample programs are written. These examples have not been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these programs. Trademarks IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International Business Machines Corporation in the United States, other countries, or both. If these and other IBM trademarked terms are marked on their first occurrence in this information with a trademark symbol ( or ), these symbols indicate U.S. registered or common law trademarks owned by IBM at the time this information was published. Such trademarks may also be registered or common law trademarks in other countries. A current list of IBM trademarks is available on the Web at "Copyright and trademark information" at Java is a trademark of Sun Microsystems, Inc. in the United States, other countries, or both. Microsoft and Windows are trademarks of Microsoft Corporation in the United States, other countries, or both. Other company, product, and service names may be trademarks or service marks of others.