BMC® Impact Integration for PATROL® Enterprise Manager Installation and Configuration Guide
Supporting BMC Impact Integration for PATROL Enterprise Manager 3.7.00
February 24, 2006
Contacting BMC Software You can access the BMC Software website at http://www.bmc.com. From this website, you can obtain information about the company, its products, corporate offices, special events, and career opportunities.
United States and Canada Address
BMC SOFTWARE INC 2101 CITYWEST BLVD HOUSTON TX 77042-2827 USA
Telephone
713 918 8800 or 800 841 2031
Fax
(01) 713 918 8000
Fax
713 918 8000
Outside United States and Canada Telephone
(01) 713 918 8800
Copyright 2006 BMC Software, Inc., as an unpublished work. All rights reserved. BMC Software, the BMC Software logos, and all other BMC Software product or service names are registered trademarks or trademarks of BMC Software, Inc. All other trademarks belong to their respective companies. BMC Software considers information included in this documentation to be proprietary and confidential. Your use of this information is subject to the terms and conditions of the applicable End User License Agreement for the product and the proprietary and restricted rights notices included in this documentation.
Restricted rights legend U.S. Government Restricted Rights to Computer Software. UNPUBLISHED -- RIGHTS RESERVED UNDER THE COPYRIGHT LAWS OF THE UNITED STATES. Use, duplication, or disclosure of any data and computer software by the U.S. Government is subject to restrictions, as applicable, set forth in FAR Section 52.227-14, DFARS 252.227-7013, DFARS 252.227-7014, DFARS 252.227-7015, and DFARS 252.227-7025, as amended from time to time. Contractor/Manufacturer is BMC SOFTWARE INC, 2101 CITYWEST BLVD, HOUSTON TX 77042-2827, USA. Any contract notices should be sent to this address.
Customer support You can obtain technical support by using the Support page on the BMC Software website or by contacting Customer Support by telephone or e-mail. To expedite your inquiry, please see “Before Contacting BMC Software.”
Support website You can obtain technical support from BMC Software 24 hours a day, 7 days a week at http://www.bmc.com/support_home. From this website, you can ■ ■ ■ ■ ■ ■ ■
read overviews about support services and programs that BMC Software offers find the most current information about BMC Software products search a database for problems similar to yours and possible solutions order or download product documentation report a problem or ask a question subscribe to receive e-mail notices when new product versions are released find worldwide BMC Software support center locations and contact information, including e-mail addresses, fax numbers, and telephone numbers
Support by telephone or e-mail In the United States and Canada, if you need technical support and do not have access to the web, call 800 537 1813 or send an e-mail message to
[email protected]. Outside the United States and Canada, contact your local support center for assistance.
Before contacting BMC Software Before you contact BMC Software, have the following information available so that Customer Support can begin working on your problem immediately: ■
product information — — —
■
product name product version (release number) license number and password (trial or permanent)
operating system and environment information — — — — —
machine type operating system type, version, and service pack or other maintenance level such as PUT or PTF system hardware configuration serial numbers related software (database, application, and communication) including type, version, and service pack or maintenance level
■
sequence of events leading to the problem
■
commands and options that you used
■
messages received (and the time and date that you received them) — — —
product error messages messages from the operating system, such as file system full messages from related software
3
4
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Contents About this book
15
Related publications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Chapter 1
Introduction
21
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Event management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Service impact management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . BAROC class generator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuration files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Mapping schemes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Architecture and process flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Daemon configuration option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Filter path configuration option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Multiple instances from a single installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Bidirectional event communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Event association with service model components . . . . . . . . . . . . . . . . . . . . . . . . . Data consistency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Synchronization of event/alert states. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Cross-launching BMC IX views from PATROL Central Alerts - Web Edition . . Encrypted communications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Default propagation policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
22 22 23 24 24 24 26 28 30 30 30 31 31 32 32 32 33 33 34
Chapter 2
35
Installation
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Software components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . System requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Product versions and operating system platforms. . . . . . . . . . . . . . . . . . . . . . . . . . BMC II for PATROL EM runtime requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installation planning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Upgrade considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Guidelines for integrating multiple BMC IM instances (cells) with a single PATROL EM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installing BMC II for PATROL EM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . To install BMC II for PATROL EM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Contents
36 36 36 36 37 38 38 38 39 39 39 5
To install another BMC IM for PATROL EM instance. . . . . . . . . . . . . . . . . . . . . . . To remove a BMC IM for PATROL EM instance . . . . . . . . . . . . . . . . . . . . . . . . . . . To remove all BMC IM for PATROL EM instances . . . . . . . . . . . . . . . . . . . . . . . . . To list all BMC IM for PATROL EM instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . To re-install product files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . To upgrade from version 3.5 or 3.6.x . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . How to enable the BMC IM connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Establishing a connection to the gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring the propagation policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Enabling the event classes created by the BAROC class generator . . . . . . . . . . . . Creating a SIM_NOTIFICATION_REGISTRY data instance . . . . . . . . . . . . . . . . . Configuration example: multiple BMC II for PATROL EM instances . . . . . . . . . Uninstalling BMC II for PATROL EM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deleting the BMC_BSM user after uninstallation. . . . . . . . . . . . . . . . . . . . . . . . . . . Cleaning up after uninstallation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
50 51 53 54 54 55 66 67 68 70 71 73 74 76 76
Chapter 3
79
Configuration
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . BMC Impact Integration configuration file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring the gateway server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring BMC IM communication settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring encryption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring the EHD host name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring the AGC host name property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring the PATROL EM supervisor name. . . . . . . . . . . . . . . . . . . . . . . . . . . . Enabling or disabling synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring reconnection interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring PATROL EM alert (PEMAlert) properties . . . . . . . . . . . . . . . . . . . . . Specifying filter delimiter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Enabling or disabling the leading delimiter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Enabling filter path specific logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring time-out interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Handling undefined tokens in CEF210 message . . . . . . . . . . . . . . . . . . . . . . . . . . . Logging key:value pairs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Specifying the Impact Manager slot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Mc Smc mapping configuration file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Modifying the configuration file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Mapping specification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Example 1: Basic mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Example 2: Specifying multiple values for an alertType . . . . . . . . . . . . . . . . . . . . . Example 3: Using reserved words . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Example 4: Using literal double quotes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Checking the format of McSmcMapping.cfg. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . How to update bidirectional communication settings . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring the BMC IM events to PATROL EM alerts mapping scheme. . . . . . . . . Editing the IMToPEMMapping.cfg file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Editing the IMToCEFMapping.cfg file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Mapping BMC IM MCEvent slots to PATROL EM CEF token names (daemon option) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Contents
80 81 83 84 85 86 86 86 87 88 88 89 90 90 91 91 92 92 93 93 93 94 94 94 95 95 95 96 97 97 98 6
Mapping BMC IM MCEvent slots to CEF210 token names (filter path option). . 98 Changing the default toolId and toolType values . . . . . . . . . . . . . . . . . . . . . . . . . 100 Mapping BMC IM MCEvent severity to PATROL EM alert type . . . . . . . . . . . . 100 Mapping BMC IM SMCState severity to PATROL EM alert type . . . . . . . . . . . . 101 Controlling SMC status propagation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 Specifying which PATROL EM alerts to send to BMC IM . . . . . . . . . . . . . . . . . . . . . 103 Selector criteria. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 Adding alert selector criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 How to associate PATROL EM alerts with service model components . . . . . . . . . . 109 Aliases and component IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 Default alias mapping. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110 Service model component mapping criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110 Mapping PATROL EM alerts with component IDs . . . . . . . . . . . . . . . . . . . . . . . . 112 Other mapping criteria examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 Chapter 4
Using the Integration
119
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . How to launch BMC II for PATROL EM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Starting the BMC II for PATROL EM service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Verifying that the BMC IM instance (cell) is connected to PATROL EM . . . . . . Checking the log file for connection problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . Validating that BMC II for PATROL EM is running . . . . . . . . . . . . . . . . . . . . . . . Launching a BMC IX service view from PATROL Central Alerts . . . . . . . . . . . . Validating that BMC IM events are forwarded. . . . . . . . . . . . . . . . . . . . . . . . . . . . How to regenerate BAROC files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Troubleshooting tips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Cell encryption not set error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Incorrect NetCmmnd Sybase password specified during installation . . . . . . . . Incorrect Sybase System Administrator password specified during installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Recovering after a connection failure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Continually disrupted connectivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Severe errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Enabling IIPEM Debugging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Failure of events to close in Impact Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
120 120 120 121 122 123 123 125 126 127 127 128
Appendix A
135
Connection Mappings
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Common event format tokens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Alert mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Mappings for CEF and non-CEF alerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Mappings for CEF alerts only . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Mappings for Non-CEF alerts only. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Example mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Data consistency mapping tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents
129 130 131 131 131 134
136 136 137 137 138 139 139 141
7
Appendix B
Configuration File Reference
143
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 ImpactIntegration.cfg file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 IMToCEFMapping.cfg file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148 IMtoPEMMapping.cfg file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150 McSmcMapping.cfg.example file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151 PEMSelector.cfg.example file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
8
Glossary
159
Index
189
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Contents
9
10
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Figures System architecture of BMC II for PATROL EM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Configuration example: multiple BMC II for PATROL EM instances . . . . . . . . . . . . 73 BMC IM slot name to PATROL EM CEF token name default mapping . . . . . . . . . . 98 BMC IM slot name to CEF210 token name default mapping . . . . . . . . . . . . . . . . . . . . 99 BMC IM MCEvent severity to PATROL EM alert type and severity . . . . . . . . . . . . 101 BMC IM SMCState severity to PATROL EM alert type and severity . . . . . . . . . . . . 102 Java Plug-in Control Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125 User Management window (PATROL EM 4.3.01) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130 Example ImpactIntegration.cfg file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145 Example IMToCEFMapping.cfg file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148 Example IMToPEMMapping.cfg file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150 McSmcMapping.cfg.example file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152 PEMSelector.cfg.example file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Figures
11
12
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Tables BMC II for PATROL EM supported products and operating systems . . . . . . . . . . . . 37 Installation location of integration component files . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 Version 3.5 and 3.6.00 configuration files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 Version 3.6.x configuration files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 Installation location of integration component files . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 Sample propagation files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 BMC II for PATROL EM Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 Configurable properties in the ImpactIntegration.cfg file . . . . . . . . . . . . . . . . . . . . . . 82 Syntax for alert selector variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 McSmcMapping.cfg variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111 Tokens used in CEF-compliant PATROL EM alerts . . . . . . . . . . . . . . . . . . . . . . . . . . 136 Common mappings for CEF and non-CEF alerts - MCEvent slots . . . . . . . . . . . . . . 137 Common mappings for CEF and Non-CEF alerts - BMC IM PEM_EV slots . . . . . . 138 Mappings for CEF alert tokens and BMC IM MCEvent slots . . . . . . . . . . . . . . . . . . . 138 Mappings for CEF alert tokens and MC PEM EV slot . . . . . . . . . . . . . . . . . . . . . . . . . 139 Mappings for Non-CEF Alerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 Example Alert Event Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 Converted event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 Data Consistency Between Events and Alerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 Data Consistency Between Alerts and Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
Tables
13
14
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
About this book This book documents the installation, configuration, and operating guidelines of the BMC® Impact Integration for PATROL® Enterprise Manager (BMC II for PATROL EM) product component. Like most BMC Software documentation, this book is available in printed and online formats. Visit the BMC Software Customer Support page at http://www.bmc.com/support_home to request additional printed books or to view online books and notices (such as release notes and technical bulletins). Some product shipments also include the online books on a documentation CD.
NOTE Online books are formatted as Portable Document Format (PDF) or HTML files. To view, print, or copy PDF books, use the free Acrobat Reader from Adobe Systems. If your product installation does not install the reader, you can obtain the reader at http://www.adobe.com.
Related publications The following related publications supplement this book: Category
Document
release notes
BMC Impact Solutions Release Notes contains system requirements, last-minute product information, and support information for the BMC® Impact Solutions products and components
installation and system configuration
Description
BMC Portal Release Notes
contains system requirements, last-minute product information, and support information for the BMC® Portal and its components
BMC Impact Solutions Installation Guide
provides an overview for installing the components of BMC Impact Solutions and instructions for installing the BMC® Impact Manager and BMC® Impact Explorer
BMC Portal Getting Started Guide
provides instructions for installing the BMC Portal and the BMC® Impact Portal
About this book
15
Related publications
Category
Document
Description
installation and system configuration (continued)
BMC Impact Solutions System Configuration, Administration, and Maintenance Guide
provides instructions for configuring and maintaining the BMC Impact Manager, BMC Impact Explorer, and BMC Impact Portal provides reference information about the BMC Impact Manager Command Line Interface (CLI)
BMC Atrium CMDB Configuration provides instructions for installing and configuring Guide the BMC® Atrium Configuration Management Database BMC Impact Event Adapters provides instructions for installing and configuring Installation and Configuration Guide BMC® Impact Event Adapters, BMC® Impact Event Log Adapter for Windows, and SNMP Adapter Configuration Manager; you use these components to capture source events from IT components through log files, SNMP traps, or message streams and convert them to BMC Impact Manager events PATROL Enterprise PATROL Enterprise Manager Manager core Installation and Configuration Guide documents PATROL Enterprise Manager Administrator Guide
event management implementation
16
contains detailed information on installing and configuring PATROL EM provides instructions for maintaining PATROL EM, such as creating users and backing up databases and configuration files
PATROL Enterprise Manager Automation Reference Manual
provides instructions for defining automated actions for alerts, commands, and other interfaces referenced in EXECs; also information about using API emulations
PATROL Enterprise Manager Customization Guide
provides instructions for collecting messages from managed systems, defining rules to generate alerts, and configuring monitoring and display applications
PATROL Enterprise Manager Administration Interface Getting Started
provides instructions for installing and using PATROL EM Administrator Interface as a portable administrative alternative to the PATROL EM Console
PATROL Enterprise Manager User Guide
provides instructions for using the Unix-based PATROL EM Console applications to manage alerts from a wide range of devices and applications
BMC Event Management Administrator Guide
provides instructions for defining event groups, image views, and event management policies in BMC Impact Explorer
BMC Impact Manager Knowledge Base Reference Guide
provides instructions for creating Knowledge Bases, provides reference information about the Basic Record of Objects in C (BAROC) language for defining events, and provides reference information about the Master Rule Language (MRL) for writing event management rules
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Related publications
Category
Document
Description
service impact management implementation
BMC Service Model Development, Maintenance, and Administration Guide
provides reference information and instructions for designing, developing, and maintaining BMC Impact Manager Service Models
event monitoring and management
BMC Impact Explorer User Guide
provides instructions for IT to view and respond to events that impact business services and for service managers to define and manage Service Models
service impact monitoring and management
BMC Service Impact Monitoring and provides instructions for monitoring and Management Guide managing both the BMC Impact Portal and the BMC Impact Explorer consoles and obtaining service management reports in BMC Impact Reporting
reporting
BMC Impact Reporting Release Notes
contains system requirements, last-minute product information, and support information for BMC® Impact Reporting
BMC Reporting Foundation Release Notes
contains system requirements, last-minute product information, and support information for the BMC® Reporting Foundation
BMC Impact Reporting Installation and Configuration Guide
provides instructions for installing and configuring BMC® Impact Reporting
BMC Reporting Foundation Installation Guide
provides instructions for installing and configuring the BMC Reporting Foundation
Supervisor’s Guide
provides instructions for using Business Objects’ Supervisor product to manage users
About this book
17
Conventions
Category
Document
Description
additional integrations
BMC Impact Integration for Remedy provides instructions for installing and configuring AR System Installation and the BMC® Impact Integration for Remedy® AR Configuration Guide System®, which automatically creates trouble tickets for events and updates the event or trouble ticket when either is modified BMC Impact Integration Web Services Installation and Configuration Manual
provides instructions for installing, configuring, and maintaining BMC® Impact Integration Web Services Server
BMC Impact Database Gateway Release Notes
contains system requirements, last-minute product information, and support information for the BMC® Impact Database Gateway
BMC Impact Database Gateway User Guide
contains information about exporting data from BMC Impact Manager into a database
BMC Impact Integration for Tivoli Release Notes
contains system requirements, last-minute product information, and support information for the BMC® Impact Integration for Tivoli
BMC Impact Integration for Tivoli User Guide
provides instructions for installing and configuring the BMC® Impact Integration for Tivoli, which enables the synchronized, bidirectional interchange of EIF events from any Tivoli TEC event source to BMC Impact Manager
BMC Impact Integration for PATROL Installation and Configuration Guide
provides instructions for installing and configuring BMC® Impact Integration for PATROL® (BMC II for PATROL)
BMC Impact Integration for PATROL User Guide
provides instructions for using BMC II for PATROL to transfer event information generated by PATROL Agents to BMC Impact Manager and discovers PATROL Agents
BMC Impact Integration for provides instructions for installing and configuring PATROL Enterprise Manager the BMC® Impact Integration for PATROL® Installation and Configuration Guide Enterprise Manager, which enables the synchronized, bidirectional interchange of PATROL Enterprise Manager alerts to BMC Impact Manager events
Conventions The following conventions are used in this book: ■
18
This book includes special elements called notes, warnings, examples, and tips:
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Conventions
NOTE Notes provide additional information about the current subject.
WARNING Warnings alert you to situations that can cause problems, such as loss of data, if you do not follow instructions carefully.
EXAMPLE An example clarifies a concept discussed in text.
TIP Tips contain information that might improve product performance or that might make procedures easier to follow.
■
In instructions, boldface type highlights information that you enter. File names, directories, Web addresses, e-mail addresses, and names of GUI elements also appear in boldface type.
■
The symbol => connects items in a menu sequence. For example, Actions => Create Test instructs you to choose the Create Test command from the Actions menu.
About this book
19
Conventions
20
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Chapter
1
1
Introduction This chapter explains the features and functions of BMC Impact Integration for PATROL Enterprise Manager (BMC II for PATROL EM). Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Event management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Service impact management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . BAROC class generator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuration files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Mapping schemes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Architecture and process flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Daemon configuration option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Filter path configuration option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Multiple instances from a single installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Bidirectional event communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Event association with service model components . . . . . . . . . . . . . . . . . . . . . . . . . Data consistency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Synchronization of event/alert states. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Cross-launching BMC IX views from PATROL Central Alerts - Web Edition . . Encrypted communications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Default propagation policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 1
Introduction
22 22 23 24 24 24 26 28 30 30 30 31 31 32 32 32 33 33 34
21
Overview
Overview BMC II for PATROL EM (also referred to as the integration component) enables event communication between BMC IM and PATROL Enterprise Manager. You can use the integration component to ■
recognize PATROL EM alerts automatically in BMC Impact Manager without defining new event classes
■
forward PATROL EM alerts to BMC Impact Manager
■
forward BMC Impact Manager events to PATROL EM
■
communicate bidirectionally between PATROL EM and BMC Impact Manager, synchronizing cell events and PATROL EM alerts upon close and acknowledge actions
■
recognize automatically in PATROL EM the service problems that originate from the service model published to BMC Impact Manager instances
■
cross-launch service views from PATROL Central Alerts – Web Edition
Event management Using the integration component, you can create event management scenarios that enable you to monitor a specific set of events and alerts between BMC Impact Manager instances and PATROL EM. Using the BMC II for PATROL EM configuration files, you can ■ ■
■ ■ ■ ■
specify which PATROL EM alerts to send to BMC Impact Manager change the mapping of the BMC IM MCEvent severity type to the PATROL alert type change the mapping between BMC IM slots and CEF210 tokens customize the severity level mappings of PATROL EM alerts with BMC IM events change the BMC IM MCEvent slot to CEF token name mapping change toolId and toolType values
NOTE For more information on event management, see the BMC Event Management Guide and the BMC Impact Manager Knowledge Base Reference Guide.
22
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Service impact management
Service impact management The concept of service impact management (SIM) includes the identification, definition, and management of the objects and processes that underlie a business service. Applying the principles and processes of SIM, you can define and model the physical and logical enterprise resources that comprise a business service and then relate the business service resources to IT resources. In its service management implementation, the product BMC® Impact Manager (BMC IM) uses a service model to depict data objects and relationships, both of which represent the physical and logical objects and relationships of a business service. These data objects and relationships are stored in the BMC® Atrium Configuration Management Database (BMC Atrium CMDB) repository. Using the service management implementation of BMC IM, you can manage a business service by monitoring the data objects and relationships of the service model. You can report their status changes and calculate the impact of failures on the business service. The BMC IM cell provides the core technology. The core technology includes ■
processing the events that are received from the IT resources
■
associating the events with the service model component instances that represent the IT resources
■
analyzing the relationships (impacts and causes) among the component instances to determine the statuses of the underlying resources
■
making the information available as event messages to other applications
BMC II for PATROL EM is the integration component through which you can associate PATROL EM alerts with corresponding BMC IM events. These events can result from incidents unrelated to the service model or from status changes in the components or relationships of your BMC SIM service model. When the BMC IM detects a problem with the monitored component instance or instances, it can propagate an event message to the connected PATROL EM server. This propagated event is displayed as a corresponding PATROL EM alert type in the PATROL EM Active Alerts Display (AAD) window. The event flow is bidirectional. This also means that not only can BMC IM events propagate to PATROL EM as alerts, but that PATROL EM alerts can propagate to BMC IM as events. These events are then displayed on the BMC Impact Explorer console. Bidirectional event flow also means that the PATROL EM user can perform a management action on the PATROL EM alert type, and this action is propagated back to the corresponding BMC IM event. Conversely, a BMC IM user can perform certain management actions on a BMC IM event, and this action is propagated back to the corresponding PATROL EM alert type.
Chapter 1
Introduction
23
Components
By integrating PATROL EM with BMC IM instances within the BMC SIM environment, you can better monitor and manage your IT resources through your PATROL EM console.
NOTE For more information on service management, see the BMC Service Model Development, Maintenance, and Administration Guide, the BMC Atrium CMDB Configuration Guide, and the BMC Service Impact Monitoring and Management Guide.
Components BMC II for PATROL EM employs a series of scripts, configuration files and mapping schemes to support event and service management.
BAROC class generator The BAROC (Basic Recorder of Objects in C) class generator is a script that runs automatically during BMC II for PATROL EM installation. It identifies the defined non-Common Event Format (CEF) compliant PATROL EM alert and tool types on the PATROL EM server. It then generates BAROC files that contain additional event classes which correspond to the non-CEF compliant tool types and alert types. You manually add these classes to the KB directory of the connected cell. (See “Enabling the event classes created by the BAROC class generator” on page 70 for the procedure.)
NOTE .BAROC files are not generated for CEF compliant filters.
Configuration files This topic lists and briefly describes the configuration files, which you can find in the ./iipemInstallDirectoryPath/instanceName/conf directory path.
24
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Configuration files
ImpactIntegration.cfg The ImpactIntegration.cfg file defines the system properties for the BMC II for PATROL EM instance, properties such as the gateway.jServer host name, Impact Manager connection settings, filter path settings, and so forth. You enter these system properties during installation, but you can modify them later.
NOTE The jServer is a Java API that is designed to handle events for BMC IM server communications. It provides the capability to implement a gateway server that obtains events and event updates from the BMC IM cell. In BMC II for PATROL EM, the jServer is the gateway service that receives the BMC IM events and event updates.
In version 3.7.00, the ImpactIntegration.cfg file introduces the following parameters most of which apply to the new filter path installation option: ■ ■ ■ ■ ■ ■ ■
PEMFilterDelimiter PEMUseTransformer PEMLogCEF PEMShowNulls PEMLogKeyValue ImpactManagerVerion ImpactManagerWaitTime
IMToPEMMapping.cfg The IMToPEMMapping.cfg file defines different sets of BMC Impact Manager to PATROL Enterprise Manager event mappings. It includes the default mappings of ■
BMC Impact Manager MCEvent slot name to PATROL EM Common Event Format (CEF) token name
■
toolID (path name) and toolType (filter name) mappings that define the path and filter that the integration component uses for BMC IM events which will be forwarded to PATROL EM as alerts
■
BMC IM Event_Impact_Manager_event_severity to PEM_alert_type, where PEM_alert_type is EVENT_PEM_alert_severity
■
SMCState_Impact_Manager_event_severity to PEM_alert_type, where PEM_alert_type is SMC_PEM_alert_severity
Chapter 1
Introduction
25
Mapping schemes
IMToCEFMapping.cfg The IMToCEFMapping.cfg file supports the new filter path installation option. It determines the event slot mappings between BMC IM slot names and CEF210 token names. It also defines the severity mappings between MCEvent_ and SMCState_ severity levels and PATROL EM alert types. You can customize the BMC IM slot to CEF210 token mappings, except for the _origin, _originClass, and _originKey mappings.
PEMSelector.cfg The PEMSelector.cfg file lets you specify which PATROL EM alerts are sent to the BMC Impact Manager cell. By default, all PATROL EM alerts sent to the BMC Impact Manager. To specify which alerts are sent to the cell, you enter selection criteria in the PEMSelector.cfg file. The selection criteria consist of specified parameters and
variables. You enter the criteria using a special selector syntax (described in “Selector criteria” on page 103) and following prescribed language rules.
McSmcMapping.cfg The McSmcMapping.cfg file is where you map the token values of a PATROL EM alert into the mc_smc_alias slot of a version 5.x BMC Impact Manager event. By mapping token values to the mc_smc_alias slot, you can associate PATROL EM alerts with service model components. The McSmcMapping.cfg file is essential to performing service management.
Mapping schemes BMC II for PATROL EM makes use of two different types of mapping schemes: those you can edit and those you cannot. You can edit the five mapping schemes that are defined in the configuration files. They are ■ ■ ■ ■ ■
26
PATROL EM alert severity to BMC IM MCEvent severity BMC IM slot names to CEF210 token names (filter path option) BMC IM slot names to PATROL EM CEF token names (daemon option) BMC IM MCEvent severity to PATROL EM alert type and severity BMC IM service model component state change event severity to PATROL EM alert type and severity
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Mapping schemes
PATROL EM alert severity to BMC IM MCEvent severity You can find this editable map in the ImpactIntegration.cfg file. This mapping scheme matches the severity levels of PATROL EM alerts with those of BMC IM events. The integration component uses the severity level of the PATROL EM alert to determine the severity level of the BMC IM event.
BMC IM slot names to CEF210 token names You can find this editable map in the IMToCEFMapping.cfg file. Use this mapping if you have installed BMC II for PATROL EM as a PATROL EM filter path. This mapping scheme matches the BMC IM slot names with CEF210 token names. Except for the _origin, _originClass, and _originKey mappings, you can customize the slots associated with the CEF token names.
WARNING Do not modify the _origin, _originClass, and _originKey mappings. Changing any of
these mappings disables the filter path option.
BMC IM slot names to PATROL EM CEF token names You can find this editable map in the IMToPEMMapping.cfg file. Use this mapping scheme if you have installed BMC II for PATROL EM as a daemon. This mapping scheme matches the BMC IM slot names with their counterpart PATROL EM CEF token names (from PATROL EM alerts). Any token names that you use must already exist in the filter path definition.
BMC IM MCEvent severity to PATROL EM alert type and severity You can find this editable map in the IMToPEMMapping.cfg file. This mapping scheme matches the event severity level of a BMC IM MCEvent to that of a PATROL EM alert.
BMC IM service model component state change event severity to PATROL EM alert type and severity You can find this editable map in the IMToPEMMapping.cfg file. This mapping scheme matches the severity level of service model component state change events to that of PATROL EM service model component alerts.
Chapter 1
Introduction
27
Architecture and process flow
The following three mapping schemes are predefined and cannot be edited: ■ ■ ■
PATROL EM CEF alerts to BMC IM PEM_EV slots PATROL EM non-CEF alerts to BMC IM MCEvent slots PATROL EM CEF tokens to BMC IM PEM_EV and BMC IM MCEvent slots
PATROL EM CEF alerts to BMC IM PEM_EV slots BMC II for PATROL EM uses this mapping scheme to link PATROL EM CEFcompliant alerts with instances of the predefined BMC IM PEM_EV slots for a CEF tool type. For example, the PATROL EM CEF alert Tooltype name is mapped to the BMC IM PEM_EV slot pem_filter. You cannot edit this mapping scheme.
PATROL EM non-CEF alerts to BMC IM MCEvent slots BMC II for PATROL EM uses this mapping scheme to link PATROL EM non-CEF compliant alerts to the BAROC-generated BMC IM MCEvent slots. For example, the PATROL EM non-CEF alert Event time is mapped to the BMC IM MCEvent slot mc_incident_time. You cannot edit this mapping scheme.
PATROL EM CEF tokens to BMC IM PEM_EV and BMC IM MCEvent slots This mapping scheme links PATROL EM CEF tokens to specific BMC IM PEM_EV and BMC IM MCEvent slots. For example, the PATROL EM CEF token domain is mapped to the BMC IM MCEvent slot mc_host, and the token service is mapped to the BMC IM PEM_EV slot pem_service. You cannot edit this mapping scheme.
Architecture and process flow Figure 1 on page 1-29 depicts the system architecture of BMC II for PATROL EM in a BMC Impact Manager 5.x environment.
28
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Architecture and process flow
Figure 1
System architecture of BMC II for PATROL EM
The central event communication path is between PATROL Enterprise Manager and BMC Impact Manager. The integration component is the conduit that receives events and alerts from their sources, converts them into compatible formats, and forwards them to their destinations. 1. The first steps towards configuring the integration component occur automatically at installation. The BAROC class generator examines the defined tool types and alert types on the PATROL EM. It identifies the non-CEF compliant ones and generates BAROC files containing additional cell event classes to accommodate them. 2. After you complete the integration component installation, you must manually transfer the BAROC files to the cell and compile them into the cell’s knowledge base (KB). 3. You perform most of the integration component’s dynamic configuration in a text file, ImpactIntegration.cfg, which is always installed on the same host as the integration component itself. The remaining configuration data is entered either directly into dynamic data tables on the cell or through the BMC Impact Service Model Editor. 4. You enter or update the following configuration data in the dynamic data files of BMC IM: ■ ■ ■ ■
event classes generated by the BAROC class generator propagation policies gateway.jserver entry in the mcell.dir file encryption properties in the mcell.conf file
5. You enter or update aliases to associate PATROL EM alerts with service model component instances through the BMC Impact Service Model Editor.
Chapter 1
Introduction
29
Features
6. After you associate the alias with the component instance, you manually define the alias format in the McSmcMapping.cfg file. 7. PATROL EM alerts are asynchronously received by the integration component and forwarded to BMC IM as instances of the event classes previously defined by the output from the BAROC class generator, except for CEF alerts, which always go to BMC IM PEM_EV. 8. Cell events are asynchronously received by the integration component and forwarded to PATROL EM as instances of alert types from the ImpactIntegration or iipemCEFv210, tool type installed with the integration component (ImpactIntegration tool type is installed with a daemon connection, iipemCEF210 tool type is installed with the filter path connection).
Features BMC II for PATROL EM provides the following features.
Daemon configuration option The daemon configuration uses the EHD client mechanism to communicate to PATROL EM. This method does not require the use of a filter path. So, if you have no requirement to introduce functionality that filter paths can take advantage of (such as transformers), then you should choose this option. This is the same configuration as in all the BMC II for PATROL EM releases prior to 3.7.00.
Filter path configuration option The filter path configuration uses sockets to communicate to PATROL EM. In this configuration, BMC II for PATROL EM is configured as the LHS (Left Hand Side) component of the filter path. It uses an enrichment transformer (based on the standard PMEP enrichment transformer) and a CEF210 filter engine. You can also modify this filter path and introduce your own transformers if required.
30
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Multiple instances from a single installation
Multiple instances from a single installation You can create multiple instances of BMC II of PATROL EM from a single installation. Each instance has its distinct configuration parameters and log. You can configure each instance independently of the others. For example, you can define one instance as daemon and another using the filter path option. Multiple instances do not interfere with each other.
Bidirectional event communication As a PATROL EM user, you have already invested time and effort in creating alert definitions for your site-specific needs. BMC II for PATROL EM automatically recognizes PATROL EM alerts; thus, you do not have to create event classes in BMC IM.
Automatic recognition of PATROL EM alerts The integration component understands CEF-compliant PATROL EM alerts out-ofthe box. For non-CEF alerts, the integration component provides event class definitions (through the BAROC class generator) that are easily imported into a BMC IM cell. Thus BMC IM can receive and understand non-CEF compliant PATROL EM alerts.
PATROL EM alert selection Using the text file PEMSelector.cfg, which resides on the same host as the BMC II for PATROL EM component, you can specify which PATROL EM alerts are sent to a BMC Impact Manager instance. The selection criteria include one or more combinations of tool type name, tool ID name, alert type name, OSISeverity, OSICategory, and Priority. The default selection criteria select all alerts. For more information, see “Specifying which PATROL EM alerts to send to BMC IM” on page 103.
PATROL EM alerts to BMC IM The integration component receives PATROL EM alerts and forwards them to the BMC IM as an instance of a BMC IM PEM_EV event class for a CEF tool type or as an instance of the BMC IM MCEvent class originally defined by the BAROC class generator for a non-CEF tool type. See Appendix A, “Connection Mappings” for more information. To see how the CEF tool type is defined, see Table 11, “Tokens used in CEF-compliant PATROL EM alerts,” on page 136. Chapter 1
Introduction
31
Event association with service model components
BMC IM events to PATROL EM The integration component receives BMC IM events and forwards them to PATROL EM as instances of alert types from the ImpactIntegration tool type. See “Alert mapping” on page 137 for more information.
Event association with service model components Using the text file McSmcMapping.cfg, which resides on the same host as the BMC II for PATROL EM component, you can create and configure SMC alias configuration data. Configuration data is entered for a specific alert type and includes the list of token names, along with a substitution pattern for creating the value of the BMC IM event’s mc_smc_alias slot. This mapping is how events are associated with managed components in the SIM model. For more information, see “How to associate PATROL EM alerts with service model components” on page 109.
Data consistency BMC II for PATROL EM enforces data consistency between a BMC IM event and a PATROL EM alert, regardless of whether the event was created in response to the alert or the alert was created in response to the event. When the status of a BMC IM event is modified, a predefined operation is performed on the corresponding PATROL EM alert. When an operation is performed on a PATROL EM alert, the status of the of the corresponding BMC IM event or the corresponding slot of the event type is modified based on predefined rules. See “Data consistency mapping tables” on page 141 for a description of the reciprocal effects that management actions have on PATROL EM alerts and BMC IM events.
Synchronization of event/alert states Upon startup, BMC II for PATROL EM synchronizes the states of BMC IM and PATROL EM by insuring the following:
32
■
all BMC IM events previously created by the integration component in response to a PATROL EM alert are closed if the PATROL EM alert is now closed
■
all active PATROL EM alerts that meet the integration component’s configured selection criteria are represented as open BMC IM events
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Cross-launching BMC IX views from PATROL Central Alerts - Web Edition
Whether this synchronization occurs is controlled by the PEMSynchronization property in the text file ImpactIntegration.cfg. By default, the synchronization does occur. Before it resumes processing real-time PATROL EM data, the integration component creates a DataSynchronized alert in the ImpactIntegration filter which indicates that all historical data has been retrieved. To read more about synchronization, see “Enabling or disabling synchronization” on page 87.
Cross-launching BMC IX views from PATROL Central Alerts Web Edition If a selected alert is coming from BMC IM through BMC II for PATROL EM integration, you can launch the corresponding BMC Impact Explorer (BMC IX) service view using the PATROL Central Alerts - Web Edition AAD. If the BMC IX is not currently running when you try to view the console from PATROL Central Alerts - Web Edition AAD, you are prompted for a userid and password. For the cross-launching procedure, see “Launching a BMC IX service view from PATROL Central Alerts” on page 123.
Encrypted communications You can configure encrypted communication between BMC II for PATROL EM and BMC IM by modifying the following configuration files in a text editor: ■
mcell.conf, which is part of the BMC IM installation, located at $MCELL_HOME/etc
■
ImpactIntegration.cfg, which exists on BMC II for PATROL EM
The encryption key that is present in both files must be identical The default setting for the encryption property in ImpactIntegration.cfg is enabled, with a pre-defined key. The default setting for encryption in mcell.conf is also enabled. For more information about encryption, see “Configuring encryption” on page 85.
Chapter 1
Introduction
33
Default propagation policies
NOTE Encrypted communication between PATROL EM and BMC II for PATROL EM is not available at this time.
Default propagation policies You can choose one or both default propagation policies: ■ ■
propagate all events to PATROL EM, except SMC_STATE_CHANGE events propagate only SMC_STATE_CHANGE events
These propagation policies are defined in the following BAROC files, which are installed as part of BMC IM: File name
Propagation policy
iipem_em_propagation.baroc
propagates all events except SMC_STATE_CHANGE events
iipem_sim_propagation.baroc
propagates only SMC_STATE_CHANGE events
You can find these files in the respective directory paths on the host system where BMC IM is installed. Unix platforms: ■
$MCELL_HOME/etc/cellName/kb/data/iipem_em_propagation.baroc
■
$MCELL_HOME/etc/cellName/kb/data/iipem_sim_propagation.baroc
Windows: ■
%MCELL_HOME%\etc\cellName\kb\data\iipem_em_propagation.baroc
■
%MCELL_HOME%\etc\cellName\kb\data\iipem_sim_propagation.baroc
NOTE You do not have to use the default propagation policies. You can choose to set up event management policies for BMC IM in the Administration tab of the BMC Impact Explorer. Refer to the BMC Event Management Administrator Guide.
34
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Chapter
2
2
Installation This chapter covers the installation tasks that you must perform to install BMC Impact Integration for PATROL Enterprise Manager. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Software components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . System requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Product versions and operating system platforms. . . . . . . . . . . . . . . . . . . . . . . . . . BMC II for PATROL EM runtime requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installation planning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Upgrade considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Guidelines for integrating multiple BMC IM instances (cells) with a single PATROL EM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installing BMC II for PATROL EM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . To install BMC II for PATROL EM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . To install another BMC IM for PATROL EM instance. . . . . . . . . . . . . . . . . . . . . . . To remove a BMC IM for PATROL EM instance . . . . . . . . . . . . . . . . . . . . . . . . . . . To remove all BMC IM for PATROL EM instances . . . . . . . . . . . . . . . . . . . . . . . . . To list all BMC IM for PATROL EM instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . To re-install product files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . To upgrade from version 3.5 or 3.6.x . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . How to enable the BMC IM connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Establishing a connection to the gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring the propagation policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Enabling the event classes created by the BAROC class generator . . . . . . . . . . . . Creating a SIM_NOTIFICATION_REGISTRY data instance . . . . . . . . . . . . . . . . . Configuration example: multiple BMC II for PATROL EM instances . . . . . . . . . Uninstalling BMC II for PATROL EM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deleting the BMC_BSM user after uninstallation. . . . . . . . . . . . . . . . . . . . . . . . . . . Cleaning up after uninstallation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 2
Installation
36 36 36 36 37 38 38 38 39 39 39 50 51 53 54 54 55 66 67 68 70 71 73 74 76 76
35
Overview
Overview The installation process consists of two procedures that you must perform in sequence. First, you install the BMC II for PATROL EM integration component. Second, you configure your BMC IM instance to accept the BMC II for PATROL EM connection.
Software components The BMC II for PATROL EM integration component consists of ■
the BMC II for PATROL EM service that transmits data between PATROL EM and a connected cell
■
PATROL EM components — a CEF v2.1.0 compliant filter — a static PATROL EM operator for those PATROL EM operations that require a user ID — an RMD registration
■
cell components — propagation policies — gateway definition — BAROC classes
System requirements This section describes the product versions of PATROL EM and the operating system platforms supported by BMC II for PATROL EM. This section also provides information about the requirements for running BMC II for PATROL EM on a server.
Product versions and operating system platforms Table 1 lists the product versions for BMC II for PATROL EM and PATROL EM and the operating system platforms supported by BMC II for PATROL EM.
36
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
BMC II for PATROL EM runtime requirements
Table 1
BMC II for PATROL EM supported products and operating systems
Product
Version
PATROL EM
4.2.00 4.2.03 4.3.00
Operating Systems ■ ■
See PATROL EM documentation for supported operating systems. PATROL EM is not supported on AIX 4.3.x and HP-UX 10.20.
4.3.01 BMC Impact Manager
5.0, 5.0.01, 5.1, 5.1.01
■
See the BMC Impact Solutions documentation and release notes for the supported operating systems.
BMC II for PATROL EM
3.7.00
■
AIX 5.1, 5.2 HP-UX 11.0, 11i Solaris 2.6, 7, 8, 9
■ ■
BMC II for PATROL EM runtime requirements The following list contains the requirements for running BMC II for PATROL EM on the PATROL EM server. ■
BMC II for PATROL EM requires version 1.4 of the Java Runtime Environment (JRE)
■
The PATROL EM server must be installed and running.
■
The BMC Impact Manager (BMC IM) server must be installed and running somewhere reachable in the IP network. It does not have to be on a PATROL EM host.
■
A minimum of 8MB of disk space must be available in the /usr/nc/Solutions directory. Debugging requires more space.
■
You must have access to the installation files on the BMC Impact Integration component CD (contained in the BMC Impact Solutions kit) either through a CDROM drive or the network.
■
The correct Java version must be installed on the system where BMC II for PATROL EM is installed.
■
(Optional) A PATROL Central Alerts client, version 7.2.x, is available in case you want to cross-launch BMC IX service views from the PATROL Central Alerts Active Alerts Display (AAD).
Chapter 2
Installation
37
Installation planning
Installation planning This section discusses installation planning considerations. It describes upgrade considerations, multiple installations of BMC II for PATROL EM, and general prerequisites.
Upgrade considerations ■
Before upgrading your current BMC II for PATROL EM installation, you must first upgrade your BMC Impact Manager environment to a compatible version. — If you are upgrading from version 3.5.00 or 3.6.00, you must upgrade your BMC Impact Manager environment to a 5.x version (5.0.00, 5.0.01, 5.1, or 5.1.01). — If you are upgrading from version 3.6.01, 3.6.02, or 3.6.03 you can choose to upgrade your BMC Impact Manager environment to the latest 5.x version.
■
Before installing the new BMC II for PATROL EM component, you must — copy and save specified configuration files — uninstall the current installation
See “To upgrade from version 3.5 or 3.6.x” on page 55 for more information.
Guidelines for integrating multiple BMC IM instances (cells) with a single PATROL EM
38
■
If you want to integrate two different cells with the same PATROL EM (which requires a separate instance installation), you must create a unique service name for each BMC II for PATROL EM instance. For example, you might have one cell that is a BMC Service Impact Manager with a BMC II for PATROL EM service name ServiceImpact and another cell that is a BMC Event Manager with BMC II for PATROL EM service name EventManager.
■
If you are performing multiple instances installation of BMC II for PATROL EM on the same Unix server, assign each instance a unique jServer port number.
■
See “Configuration example: multiple BMC II for PATROL EM instances” on page 2-73 for an illustration of multiple BMC II for PATROL EM instances configured with two cells and a single jServer host.
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Prerequisites
Prerequisites Before launching the installation script, you should have the following information available: ■
the base directory where BMC II for PATROL EM will be installed
■
the directory path where the Java Runtime Environment is installed
■
the BMC IM cell information that is typically entered in its mcell.dir file, such as cell name, host name or IP address, port number, and encryption key
■
the PATROL EM server information such as EHD host name, AGC host name, Sybase System Administrator password, and NetCmmnd Sybase password
In addition, the PATROL EM AAD console should be up, running, and set to display on the same system where the BMC II for PATROL EM installation script will be launched.
Installing BMC II for PATROL EM This section describes how to install the BMC II for PATROL EM 3.7.00 component.
NOTE As a reminder, if you are upgrading from a previous version, you should save relevant configuration files and then uninstall your existing BMC II for PATROL EM component. Refer to “Upgrade considerations” on page 38 for more information.
To install BMC II for PATROL EM Use the procedure in this section to install the BMC II for PATROL EM component on a Unix operating system.
Before you begin You must be logged on as NetCmmnd.
Chapter 2
Installation
39
To install BMC II for PATROL EM
To Install BMC II for PATROL EM on Unix 1 Insert the BMC Impact Integration component CD, and run the installation script. ./IIPEMINST
NOTE The installation script verifies that it is running on a PATROL EM system. If the installation is not running on a PATROL EM system, then the script stops.
The installation script displays the following introductory text: Welcome to the BMC Impact Integration for PATROL Enterprise Manager This will install version 3.7.00. Note: A full BMC Impact Integration for PATROL Enterprise Manager installation requires about 6,954 K of space. Press 'Enter' to continue Response:
2 Press Enter. The End-User License Agreement is displayed, followed by this prompt: Enter 'accept' to accept the Agreement, 'q' to quit, 'p' for the previous page, 't' to go to top, or just Enter for the next page. Response (or < for back):
3 Enter accept to accept the agreement and continue. The script asks for the base location where you want to install the integration component. The default file path is /usr/nc/Solutions/iipem. Where do you want to install the BMC Impact Integration for PATROL Enterprise Manager? Enter the directory name: Current value ('Enter' to accept): /usr/nc/Solutions/iipem Value:
4 Press Enter to accept the default directory path; or enter a specified installation directory next to Value, and then press Enter. 40
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
To install BMC II for PATROL EM
The script displays a summary of your installation directory, space requirements, and asks whether you want to continue. Installation directory is: /usr/nc/Solutions/iipem Available disk space: 6,586,804 K ..................................................... Do you wish to continue with the installation? Enter ‘y’ for yes or ‘n’ for no. Response:
5 Enter y to continue. The script searches for the Java Runtime Environment. If it finds the JRE, it displays the path next to Current Value. General configuration information Where is your Java Runtime Environment located? (This product requires Java version 1.4) Enter the directory name: Current value ('Enter' to accept):/ Value: /usr/local/j2sdk1.4.2_05
6 Press Enter to accept the current value, or specify a different value and then press Enter.
The script asks for the host name of the event handler daemon. It defaults to the local host. Please specify/confirm the EHD hostname. Current value ('Enter' to accept): hostName Value (or < for back):
7 Press Enter to accept the value of the EHD hostName, or specify a different EHD host name and press Enter. The script asks for the local host name of the AGC (PATROL EM) database. The default is the local host system. Please specify/confirm the AGC hostname.
Chapter 2
Installation
41
To install BMC II for PATROL EM
Current value ('Enter' to accept): hostname Value (or < for back):
8 Press Enter to accept the value of the AGC hostName, or specify a different AGC host name and press Enter. The script asks for the Sybase System Administrator password. Please specify the Sybase System Administrator password (or < for back).
9 Type the Sybase System Administrator (sa) password, and press Enter. The string is not displayed. You are then asked to confirm the password. Retype the password, and press Enter again. The script asks for the NetCmmnd Sybase password. Please specify the NetCmmnd Sybase password (or < for back).
10 Type the NetCmmnd Sybase password, and press Enter. The string is not displayed.
WARNING If you supply an incorrect NetCmmnd Sybase password, multiple parts of the integration component’s installation fail. You will have to uninstall and then reinstall BMC II for PATROL EM.
You are then asked to confirm the password. Retype the password, and press Enter again. The installation routine starts to create the default filters.
42
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
To install BMC II for PATROL EM
Calling installPathProto.sh... Create the Path Prototype iipemPath ........................................................ BMC Impact Integration for PATROL EM (3.7.00) filter installation... Is a DeskTop running at DISPLAY ($DISPLAY)? Enter 'y' for yes or 'n' for no. Response:
DeskTop refers to the PATROL EM console. $DISPLAY refers to the system where PATROL EM console is opened. ■
If the PATROL EM console is running at the specified display system, enter y and go to step 19.
■
If the PATROL EM console is not running, enter n. You receive the following prompt:
Should a DeskTop be started at DISPLAY ($DISPLAY)? Enter 'y' for yes or 'n' for no.
To complete the installation of the integration component’s filter path, you must have the PATROL EM console running.
11 If the PATROL EM Console is not already running, type y for yes. The installation script prompts you for the status of the PATROL EM console. Sleeping for 30 Seconds while the DeskTop starts... Has the DeskTop started at Display ($DISPLAY)? Enter ‘y’ for yes or ‘n’ for no. Response:
If the PATROL EM console has started, enter y to complete the installation. A system transcript window is opened to indicate that batch processing has started.
Results The installation script ■
creates the path prototype iipemPath
■
creates the PATROL EM operator BMC_BSM for use by PATROL EM operations that require a user ID Chapter 2
Installation
43
To install BMC II for PATROL EM
■
generates ImpactIntegration and iipemCEFv210 filters
■
creates the PATROL EM alias definition ImpactIntegration
■
creates the path definition ImpactIntegration
■
generates the createSelector script, which converts the PATROL EM selection criteria in PEMSelector.cfg into a form usable by the integration component
■
generates the checkFormatMcSmcMap script, which verifies the formatting of the alias mapping data in the McSmcMapping.cfg file
■
generates the IIPEM runtime script iipatrolem
■
generates the baroc class generator runtime script runEventClassFactory
■
generates *.baroc files for non-CEF compliant PATROL EM alert tool types. The .baroc files are used to create additional event classes in the BMC IM cell’s KB directory.
■
generates the uninstallation script IIPEMUNIST in the base installation directory.
■
sets up the integration component as a new RMD path.
The installation script copies files to the directory specified in step 4 on page 40 and to the following subdirectories: Table 2
Installation location of integration component files (part 1 of 2)
Subdirectory
Files
bin
executable files checkFormatMcSmcMap, createSelector, iipatrolem, and runEventClassFactory
conf
configuration files ■ ■ ■ ■ ■ ■ ■
files
BMC II for PATROL EM filter files and the KB subdirectory where resides the PEM_NetCmmnd.baroc file containing the BMC IM event class definitions and other *.baroc files generated for non-CEF compliant PATROL EM tool types
inst
secondary installation scripts and uninstallation scripts software .jar files
lib
44
DefaultImpactIntegration.cfg ImpactIntegration.cfg IMToCEFMapping.cfg IMToPEMMapping.cfg McSmcMapping.cfg.example PEMSelector.cfg PEMSelector.cfg.example
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
To install BMC II for PATROL EM
Table 2
Installation location of integration component files (part 2 of 2)
Subdirectory
Files
log
run-time logs: ■ ■ ■ ■ ■ ■ ■
iipatrolem.log iipatrolem.err iipatrolem.out createSelector.log eventClassFactory.log filterGenerate.log installFilter.log
transformers
contains the transformer configuration and log files
setup
contains the IIPEMINST script used to install instances or to reinstall the product files. This subdirectory also contains the product files
When the filter installation is complete, the following message is displayed: BMC Impact Integration for PATROL EM filter installation complete.
NOTE The installation script itself does not perform any verification.
The installation script checks for currently installed instances. Select the operation you want to perform Select from the list below by entering the corresponding number at prompt: 1. Add an Instance 2. Quit Response:
12 Enter 1 to add an instance; or enter 2 to quit. The installation script asks for the service name. The default service name is iipatrolem. Please specify or confirm the PATROL EM Service name. Current value (‘Enter’ to accept): iipatrolem Value (or < for back): Chapter 2
Installation
45
To install BMC II for PATROL EM
13 Press Enter to accept the default service name, iipatrolem; or specify a service name and press Enter. If you are installing multiple instances of BMC II for PATROL EM, use a different service name for each instance. See “Guidelines for integrating multiple BMC IM instances (cells) with a single PATROL EM” on page 38. The script asks whether you want to configure this service as a filter path. Do you want to configure this service as a Filter Path? Enter ‘y’ for yes or ‘n’ for no. Response (or < for back):
14 Configure the service using one of the following methods. ■
If you want to configure the service as a daemon, enter n. This is the same configuration as used in the release prior to 3.7.00.
■
If you want to configure the service as a filter path, enter y.
The script next asks for the location of the jServer. It defaults to the hostName of the local system. Enter jServer information Enter the jServer host name or ip address. Current value ('Enter' to accept): hostName Value (or < for back):
NOTE This portion of the installation defines the communications parameters associated with propagating data from the cell to the integration component. To the cell, the integration component appears as a specialized information gateway generically known as a “jServer.” The communications parameters entered here must match the information that is entered in the mcell.dir file on the cell. See “Configuring the gateway server” on page 83 for more information.
15 Press Enter to accept the current value of hostName or enter your own host name or IP address. The script next asks for the jServer port number. The default is 3793. Enter the jServer port number.
46
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
To install BMC II for PATROL EM
Current value ('Enter' to accept): 3793 Value (or < for back):
16 Press Enter to accept the current default value of 3793 or type a unique port number and press Enter.
NOTE If you are installing multiple instances of BMC II for PATROL EM, use a different port number for each instance. For more information, see “Guidelines for integrating multiple BMC IM instances (cells) with a single PATROL EM” on page 38.
The script asks for the encryption key. The default is mc. Enter the jServer encryption key. Current value ('Enter' to accept): mc Value (or < for back):
17 Press Enter to accept the current default value or enter your own encryption key. NOTE The jServer encryption key for BMC II for PATROL EM must match the gateway.jServer encryption key in the cell. See step 2 on page 67.
The script asks for the version of Impact Manager. If Impact Manager is already installed on the machine, the script displays the associated version. Enter Impact Manager Information Enter Impact Manager’s version (nn.nn.nn) Current value ('Enter' to accept): 5.1.01 Value (or < for back):
18 Press Enter to accept the current value or specify the version and press Enter.
Chapter 2
Installation
47
To install BMC II for PATROL EM
The script asks for the name of the cell. It defaults to the name of the local host. Enter the name of the Cell. Current value ('Enter' to accept): cellName Value (or < for back):
NOTE This portion of the installation defines the communications parameters associated with the integration component propagating data to the cell.
19 Press Enter to accept the current value or specify the cell name and press Enter. The script asks for the host name or IP address of the cell. Again, it defaults to the local host system. Enter the Cell's host name or ip address. Current value ('Enter' to accept): hostName or IpAddress Value (or < for back):
20 Press Enter to accept the current value, or specify the host name or IP address of the cell and press Enter. The script prompts for the cell’s port number. The default is 1828. Enter the Cell's port number. Current value ('Enter' to accept): 1828 Value (or < for back):
21 Press Enter to accept the current value, or specify another unique port number for the cell, and press Enter. The script then asks for the cell’s encryption key. The cell’s encryption key must match the cell’s encryption key in the mcell.dir file. in step 2 on page 67. Enter the Cell's encryption key. Current value ('Enter' to accept): mc Value (or < for back):
22 Press Enter to accept the current value, or specify a different value and then press Enter.
48
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
To install BMC II for PATROL EM
The script displays a summary parameter settings for the instance and asks whether you want to continue. Add Instance Settings for 'iipatrolem': Configure as Filter Path: N jServer host and port: agari1:3793 jServer encryption key: mc Impact Manager version: 5.1.01 Cell name: agari1 Cell host and port: agari1:1828 Cell encryption key: mc Estimated disk space required: 80 K Space available on target: 6,580,469 K Do you wish to continue with the installation? Enter ‘y’ for yes or ‘n’ for no. Response (or < for back):
23 Enter y to continue. The installation routine creates the directory structure for the integration component and displays the message: “BMC Integration for PATROL EM (3.7.00) filter installation complete.” Creating directory: iipatrolem/conf - Created directory /usr/nc/Solutions/iipem/iipatrolem/conf ................................................................ BMC EM Service iipatrolem successfully created.
The installation script prompts you to modify the mcell.dir directory. IMPORTANT: To complete this installation, you must modify the mcell.dir file in the etc subdirectory of the BMC Impact Manager you want to connect to. Add the following line to the mcell.dir file: gateway.jServer jServer mc agari1:3793 You can cut and paste the line from this sample mcell.dir file: /usr/nc/Solutions/iipem/mcell.dir
24 Cut and paste the /usr/nc/Solutions/iipem/mcell.dir line to the mcell.dir file. The installation script checks for currently installed instances.
Chapter 2
Installation
49
To install another BMC IM for PATROL EM instance
Current instances (1): 1. iipatrolem Select the operation you want to perform Select from the list below by entering the corresponding number at prompt: 1. 2. 3. 4. 5.
Add an Instance Remove an Instance Remove all Instances List Instances Quit
Response: (or < for back):
25 Do one of the following: ■
To add an instance, see “To install another BMC IM for PATROL EM instance” on page 50.
■
To remove a single instance, see “To remove a BMC IM for PATROL EM instance” on page 51.
■
To remove all instances, see “To remove all BMC IM for PATROL EM instances” on page 53.
■
To list all instances, see “To list all BMC IM for PATROL EM instances” on page 54.
■
To quit, enter 5.
To install another BMC IM for PATROL EM instance For each BMC IM cell you wish to connect to PATROL EM, you must install a separate BMC IM for PATROL EM instance.
Before you begin If necessary, rerun the installation script as described under “To install BMC II for PATROL EM.” Then, at step 12 on page 45, use the following procedure when the installation script asks you to select the operation you want to perform.
50
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
To remove a BMC IM for PATROL EM instance
NOTE You can rerun the installation script, IIPEMINST from the CD or from the /setup directory under the base directory, /usr/nc/Solutions/iipem.
1 Enter 1 to add another instance. The installation script asks for the service name. Please specify the PATROL EM Service name. Response (or < for back):
2 Complete the remaining steps.
To remove a BMC IM for PATROL EM instance Before you begin If necessary, rerun the installation script as described under “To install BMC II for PATROL EM.” Then, at step 13 on page 46, use the following procedure.
1 Enter 2 to remove an instance. The installation script asks you to select the instance to remove. Select the Instance you want to remove Select from the list below by entering the corresponding number at the prompt: 1. iipatrolem 2. instance2 3. instance3 Response (or < for back):
2 Type the corresponding number and press Enter. The installation script asks you to confirm the removal. OK to remove Instance ‘instanceName’?
Chapter 2
Installation
51
To remove a BMC IM for PATROL EM instance
Enter ‘y’ for yes or ‘n’ for no. Response:
If the instance that you want to remove is a filter path, the installation script prompts you to remove the filter path. Should the instanceName path definition be removed? Enter ‘y’ for yes or ‘n’ for no. Response:
The installation routine removes the specified filter path, lists the remaining instances, and prompts you to select an operation. Select the operation you want to perform Select from the list below by entering the corresponding number at prompt: 1. 2. 3. 4. 5.
Add an Instance Remove an Instance Remove all Instances List Instances Quit
Response: (or < for back):
3 Do one of the following:
52
■
To add an instance, see “To install another BMC IM for PATROL EM instance” on page 50.
■
To remove a single instance, see “To remove a BMC IM for PATROL EM instance” on page 51.
■
To remove all instances, see “To remove all BMC IM for PATROL EM instances” on page 53.
■
To list all instances, see “To list all BMC IM for PATROL EM instances” on page 54.
■
To quit, enter 5.
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
To remove all BMC IM for PATROL EM instances
To remove all BMC IM for PATROL EM instances 1 Enter 3 to remove all instances. The installation script asks you to confirm the removal of all instances. OK to remove all # Instances? Enter ‘y’ for yes or ‘n’ for no. Response:
2 Enter y to remove all instances. The installation routine removes the first instance and prompts you to confirm the removal of the path definition. Should the iipatrolem path definiton be removed? Enter ‘y’ for yes or ‘n’ for no. Response:
3 Enter y to remove the first instance. The installation routine uninstalls the path definition and asks you to confirm the removal of the next path definition. Removing Instance ‘PathName’ Should the PathName path definiton be removed? Enter ‘y’ for yes or ‘n’ for no. Response:
4 Enter y to confirm the removal the next instance. The installation routine uninstalls the next path definition, displays the message: “No Instances currently installed” and prompts you to select an operation. Select the operation you want to perform Select from the list below by entering the corresponding number at prompt: 1. Add an Instance 2. Re-install product files 3. Quit
Chapter 2
Installation
53
To list all BMC IM for PATROL EM instances
Response: (or < for back):
5 Do one of the following: ■
To add an instance, see “To install another BMC IM for PATROL EM instance” on page 50.
■
To re-install product files, see “To re-install product files” on page 54.
■
To quit, enter 5.
To list all BMC IM for PATROL EM instances Before you begin If necessary, rerun the installation script as described under “To install BMC II for PATROL EM.” Then, at step 13 on page 46, use the following procedure.
1 Enter 4 to list all instances. The installation routine lists all currently installed instances and prompts you to select and operation.
To re-install product files Before you begin If necessary, rerun the installation script as described under “To install BMC II for PATROL EM.” Then, at step 13 on page 46, use the following procedure.
NOTE You can rerun the installation script, IIPEMINST from the CD or from the ./setup directory under the base directory, /usr/nc/Solutions/iipem.
1 Enter 5 to re-install product files. The script displays a summary parameter settings and asks whether you want to continue.
54
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
To upgrade from version 3.5 or 3.6.x
Do you wish to continue with the installation? Enter ‘y’ for yes or ‘n’ for no. Response (or < for back):
2 Enter y to continue. The installation routine reloads the files from the distribution into the base directory and prompts you to select an operation. Select the operation you want to perform Select from the list below by entering the corresponding number at prompt: 1. 2. 3. 4. 5. 6.
Add an Instance Remove an Instance Remove all Instances List Instances Re-install product files Quit
Response: (or < for back):
3 Do one of the following: ■
To add an instance, see “To install another BMC IM for PATROL EM instance” on page 50.
■
To remove a single instance, see “To remove a BMC IM for PATROL EM instance” on page 51.
■
To remove all instances, see “To remove all BMC IM for PATROL EM instances” on page 53.
■
To re-install product files, see “To re-install product files” on page 54.
■
To list all instances, see “To list all BMC IM for PATROL EM instances” on page 54.
■
To quit, enter 5.
To upgrade from version 3.5 or 3.6.x You can use one of two ways to upgrade from version 3.5 or 3.6.x:
Chapter 2
Installation
55
To upgrade from version 3.5 or 3.6.x
■
the back-up method When using the back-up method to upgrade, you manually back up all the configuration files as specified in the “To upgrade from version 3.5 or 3.6.00 using the back-up method,”uninstall the old release, and install the new release.
■
the in-place method When using the in-place method to upgrade, the installation script will automatically create a backup directory, iipem_iipemVersion.bck, at the same level in the current installation directory and back up all the files from the current installation, except the IIPEMUNINST script. For more information about the inplace method, see “To upgrade using the in-place method” on page 61.
See “Upgrade considerations” on page 2-38 for a summary of the prerequisite actions.
Before you begin ■
Upgrade your BMC Impact Manager environment to the appropriate 5.x version.
■
BMC II for PATROL EM 3.7.00 manages event association differently from version 3.5. The LogicalIdMapping.cfg file is no longer valid and has been replaced by the McSmcMapping.cfg file. Refer to “How to associate PATROL EM alerts with service model components” on page 3-109 for more information.
To upgrade from version 3.5 or 3.6.00 using the back-up method 1 Copy and save the ./iipemInstallDirectoryPath/conf/ImpactIntegration.cfg file to a separate directory location.
2 Use Table 3 on page 56 to review the following configuration files in the ./iipemInstallDirectoryPath/conf path to decide whether you should save them to a
separate location. Table 3
Version 3.5 and 3.6.00 configuration files
File name
Copy and save this file only if . . .
PEMSelector.cfg
you have configured its properties to limit the alerts that PATROL EM forwards to BMC IM you have used this file to generate logical IDs from PATROL EM alert tokens
LogicalIdMapping.cfg
3 Uninstall the product. 4 Install version 3.7.00, following the steps under “To install BMC II for PATROL EM” on page 2-39.
56
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
To upgrade from version 3.5 or 3.6.x
TIP The 3.7.00 version uses a different default port number for the gateway.jServer entry: port number 3793 instead of 3783. If you accept the default value during installation, your gateway.jServer port number is changed.
5 After the installation is complete, save the newly installed ./iipemInstallDirectoryPath/instanceName/conf/ImpactIntegration.cfg file to a
temporary location. Save the newly installed PEMSelector.cfg file to a temporary location only if you modified the earlier 3.5 (or 3.6.00) version (see step 2 and Table 3 in this procedure).
6 Open your 3.5 (or 3.6.00) and 3.7.00 versions of the ImpactIntegration.cfg file in separate instances of a text editor.
A Compare the two versions. B Verify that the 3.7.00 version of the ImpactIntegration.cfg file contains the correct values for your cell, jServer, and PATROL EM server connections, as well as any customized values you might have entered in the 3.5 (or 3.6.00) version.
C Make any changes to the 3.7.00 version of ImpactIntegration.cfg, and save the file. 7 If you modified your 3.5 version of thePEMSelector.cfg file and want to preserve your changes, then you should copy your modifications to the respective 3.7.00 version. Otherwise, go to step 8
A Open your 3.5 (or 3.6.00) and 3.7.00 versions of the PEMSelector.cfg file in separate instances of a text editor.
B Copy the changes from the 3.5 (or 3.6.00) version to the 3.7.00 version, and save the file.
NOTE See “Specifying which PATROL EM alerts to send to BMC IM” on page 3-103 for specific procedures. You will need to run the ./iipemInstallDirectoryPath/bin/createSelector command to validate the criteria.
8 If you generated logical IDs using the previous LogicalIdMapping.cfg file (see step 2 in this procedure), then open your LogicalIdMapping.cfg file and the newly installed McSmcMapping.cfg.example file in separate instances of a text editor. Otherwise, go to step 9.
Chapter 2
Installation
57
To upgrade from version 3.5 or 3.6.x
A Compare the properties, structure, and format of the two files. See “How to associate PATROL EM alerts with service model components” on page 3-109 for more information.
B Modify your LogicalIdMapping.cfg file to conform to the McSmcMapping.cfg.example file. ■
If the PATROL EM alerts that are generated have not changed since the upgrade, then the toolType and alertType values should be the same as they were in the LogicalIdMapping.cfg file.
■
The mapValue property in the McSmcMapping.cfg.example file replaces the id property of the LogicalIdMapping.cfg file. Each property refers to different BMC IM slots: the mapValue refers to the mc_smc_alias slot, and the id refers to the now deprecated mc_smc_id slot. You may not be able to use the same format to define the alias value. This is because service modeling concepts have changed between IM 4.1 cells and IM 5.x cells. If the current string value of your service model component alias differs from your previous string value, then you must create a new mapValue format to match the new component alias.
C Save the file as McSmcMapping.cfg in the ./iipemInstallDirectoryPath/instanceName/conf directory.
NOTE See “How to associate PATROL EM alerts with service model components” on page 3-109 for specific procedures. You will have to run the /iipemInstallDirectoryPath/bin/ checkFormatMCSmcMap command to validate the criteria.
9 Go to “How to enable the BMC IM connection” on page 2-66. To upgrade from version 3.6.01, 3.6.02, or 3.6.03 1 Copy and save the ./iipemInstallDirectoryPath/conf/ImpactIntegration.cfg file to a separate directory location.
2 Use Table 4 to review the following configuration files in the ./iipemInstallDirectoryPath/conf path to decide whether you should save them to a
separate location. Table 4
Version 3.6.x configuration files (part 1 of 2)
File name
Copy and save this file only if . . .
IMToPEMMapping.cfg
you have modified the mapping schemes you have configured its properties to limit the alerts that PATROL EM forwards to BMC IM
PEMSelector.cfg
58
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
To upgrade from version 3.5 or 3.6.x
Table 4
Version 3.6.x configuration files (part 2 of 2)
File name
Copy and save this file only if . . .
McSmcAliasMapping.cfg BMC II for PATROL EM 3.6.01, 3.6.02,3.6.03
you have used this file to generate an mc_smc_alias slot for PATROL EM alert tokens
LogicalIdMapping.cfg 3.6.00
you have used this file to generate logical IDs from PATROL EM alert tokens
3 Uninstall the product. 4 Install version 3.7.00, following the steps under “To install BMC II for PATROL EM” on page 2-39.
TIP Versions 3.6.00, 3.6.01, 3.6.02 used port number 3783. From version 3.6.03, the default port number is 3793. If you accept the default value during installation, your gateway.jServer port number may change from your previous BMC II for PATROL EM.
5 After the installation is complete, save the newly installed ./iipemInstallDirectoryPath/conf/instanceName/ImpactIntegration.cfg file to a
temporary location. Save the following newly installed configuration files to a temporary location only if you modified the earlier 3.6.x versions (see step 2 and Table 4 in this procedure). ■ ■
IMToPEMMapping.cfg PEMSelector.cfg
6 Open your 3.6.x and 3.7.00 versions of the ImpactIntegration.cfg file in separate instances of a text editor.
A Compare the two versions. B Verify that the 3.7.00 version of the ImpactIntegration.cfg file contains the correct values for your cell, jServer, and PATROL EM server connections, as well as any customized values you might have entered in an earlier 3.6.x version.
C Make any changes, and save the file. 7 If you modified your 3.6.x version of the IMToPEMMapping.cfg or PEMSelector.cfg file and want to preserve your changes, then you should copy your modifications to the respective 3.7.00 version. Otherwise, go to step 8.
Chapter 2
Installation
59
To upgrade from version 3.5 or 3.6.x
A Open your 3.6.x and 3.7.00 versions of the IMToPEMMapping.cfg file in separate instances of a text editor.
B Copy the changes from the 3.6.x version to the 3.7.00 version, and save the file. NOTE See “Configuring the BMC IM events to PATROL EM alerts mapping scheme” on page 3-96 for specific procedures.
C Open your 3.6.x and 3.7.00 versions of the PEMSelector.cfg file in separate instances of a text editor.
D Copy the changes from the 3.6.x version to the 3.7.00 version, and save the file. NOTE See “Specifying which PATROL EM alerts to send to BMC IM” on page 3-103 for specific procedures. You will need to run the ./iipemInstallDirectoryPath/bin/createSelector command to validate the criteria.
8 If you are upgrading from IIPEM 3.5 or 3.6.00 and you configured mc_smc_id slots in LogicalIdMapping.cfg, then copy the properties in LogicalIdMapping.cfg to your new /iipemInstallDirectoryPath/instanceName/conf/McSmcMapping.cfg file. The id property found in LogicalIdMapping.cfg must be replaced with the mapValue property. If you are upgrading from IIPEM versions 3.6.01, 3.6.02, or 3.6.03, and you have configured mc_smc_alias slots in McSmcAliasMapping.cfg, then copy the properties in McSmcAliasMapping.cfg to your new /iipemInstallDirectoryPath/instanceName/conf/McSmcMapping.cfg file. The alias property found in McSmcAliasMapping.cfg must be replaced with the mapValue property.
NOTE See “How to associate PATROL EM alerts with service model components” on page 3-109 for specific procedures. If you generate mc_smc_alias slots with the McSmcMCSmcMapping.cfg file, then you will have to run the /iipemInstallDirectoryPath/bin/checkFormatMcSmcMap command to validate the criteria.
9 Go to “How to enable the BMC IM connection” on page 2-66.
60
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
To upgrade from version 3.5 or 3.6.x
To upgrade using the in-place method 1 Insert the BMC Impact Integration component CD, and run the installation script. ./IIPEMINST
NOTE The installation script verifies that it is running on a PATROL EM system. If the installation is not running on a PATROL EM system, then the script stops.
The installation script displays the following introductory text: Welcome to the BMC Impact Integration for PATROL Enterprise Manager This will install version 3.7.00. Note: A full BMC Impact Integration for PATROL Enterprise Manager installation requires about 6,954 K of space. Press 'Enter' to continue Response:
2 Press Enter. The End-User License Agreement is displayed, followed by this prompt: Enter 'accept' to accept the Agreement, 'q' to quit, 'p' for the previous page, 't' to go to top, or just Enter for the next page. Response (or < for back):
3 Enter accept to accept the agreement and continue. The script asks for the base location where you want to install the integration component. Where do you want to install the BMC Impact Integration for PATROL Enterprise Manager? Enter the directory name: Current value ('Enter' to accept): /usr/nc/Solutions/ImpactIntegration Value:
Chapter 2
Installation
61
To upgrade from version 3.5 or 3.6.x
NOTE In releases before 3.7.00, the default directory was /usr/nc/Solutions/ImpactIntegration.
4 Press Enter to accept the default directory path; or enter the path to the installation directory where the current IIPEM installation resides and press Enter. The script displays a summary of your installation directory, space requirements, and asks whether you want to continue. Installation directory is: /usr/nc/Solutions/iipem Available disk space: 6,586,804 K ..................................................... Do you wish to continue with the installation? Enter ‘y’ for yes or ‘n’ for no. Response:
5 Enter y to continue. The installation script performs a back-up of the current directory and creates new directories for laying down the new files. The script also searches for the Java Runtime Environment. If it finds the JRE, it displays the path next to Current Value. General configuration information Where is your Java Runtime Environment located? (This product requires Java version 1.4) Enter the directory name: Current value ('Enter' to accept):/ Value: /usr/local/j2sdk1.4.2_05
6 Press Enter to accept the current value, or specify a different value and then press Enter.
The script asks for the host name of the event handler daemon. It defaults to the local host. Please specify/confirm the EHD hostname.
62
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
To upgrade from version 3.5 or 3.6.x
Current value ('Enter' to accept): hostName Value (or < for back):
7 Press Enter to accept the value of the EHD hostName, or specify a different EHD host name and press Enter. The script asks for the local host name of the AGC (PATROL EM) database. The default is the local host system. Please specify/confirm the AGC hostname. Current value ('Enter' to accept): hostname Value (or < for back):
8 Press Enter to accept the value of the AGC hostName, or specify a different AGC host name and press Enter. The script asks for the Sybase System Administrator password. Please specify the Sybase System Administrator password (or < for back).
9 Type the Sybase System Administrator (sa) password, and press Enter. The string is not displayed. You are then asked to confirm the password. Retype the password, and press Enter again. The script asks for the NetCmmnd Sybase password. Please specify the NetCmmnd Sybase password (or < for back).
10 Type the NetCmmnd Sybase password, and press Enter. The string is not displayed.
WARNING If you supply an incorrect NetCmmnd Sybase password, multiple parts of the integration component’s installation fail. You will have to uninstall and then reinstall BMC II for PATROL EM.
You are then asked to confirm the password. Retype the password, and press Enter again. The installation routine starts to create the default filters.
Chapter 2
Installation
63
To upgrade from version 3.5 or 3.6.x
Calling installPathProto.sh... Create the Path Prototype iipemPath ........................................................ BMC Impact Integration for PATROL EM (3.7.00) filter installation... Filter Path “ImpactIntegration” currently exists. Enter 'y' for yes or 'n' for no. Response:
Do you want to remove “ImpactIntegration” and re-install?
11 Enter y to re-install the ImpactIntegration filter path. A system transcript window is opened to indicate that batch processing has started.
Results The installation script
64
■
creates the path prototype iipemPath
■
creates the PATROL EM operator BMC_BSM for use by PATROL EM operations that require a user ID
■
generates ImpactIntegration and iipemCEFv210 filters
■
creates the PEM alias definition ImpactIntegration
■
creates the path definition ImpactIntegration
■
generates the createSelector script, which converts the PATROL EM selection criteria in PEMSelector.cfg into a form usable by the integration component
■
generates the checkFormatMcSmcMap script, which verifies the formatting of the alias mapping data in the McSmcMapping.cfg file
■
generates the IIPEM runtime script iipatrolem
■
generates the baroc class generator runtime script runEventClassFactory
■
generates *.baroc files for non-CEF compliant PATROL EM alert tool types. The .baroc files are used to create additional event classes in the BMC IM cell’s KB directory.
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
To upgrade from version 3.5 or 3.6.x
■
generates the uninstallation script IIPEMUNIST in the base installation directory.
■
sets up the integration component as a new RMD path.
The installation script copies files to the directory specified in step 4 on page 40 and to the following subdirectories: Table 5
Installation location of integration component files
Subdirectory
Files
bin
executable files checkFormatMcSmcMap, createSelector, iipatrolem, and runEventClassFactory
conf
configuration files ■ ■ ■ ■ ■ ■ ■
DefaultImpactIntegration.cfg ImpactIntegration.cfg IMToCEFMapping.cfg IMToPEMMapping.cfg McSmcMapping.cfg.example PEMSelector.cfg PEMSelector.cfg.example
files
BMC II for PATROL EM filter files and the KB subdirectory where resides the PEM_NetCmmnd.baroc file containing the BMC IM event class definitions and other *.baroc files generated for non-CEF compliant PATROL EM tool types
inst lib
secondary installation scripts and uninstallation scripts software .jar files
log
run-time logs: ■ ■ ■ ■ ■ ■ ■
iipatrolem.log iipatrolem.err iipatrolem.out createSelector.log eventClassFactory.log filterGenerate.log installFilter.log
transformers
contains the transformer configuration and log files
setup
contains the IIPEMINST script used to install instances or to reinstall the product files. This subdirectory also contains the product files
When the filter installation is complete, the following message is displayed: BMC Impact Integration for PATROL EM filter installation complete.
Chapter 2
Installation
65
How to enable the BMC IM connection
NOTE The installation script itself does not perform any verification.
The installation script checks for currently installed instances. Select the operation you want to perform Select from the list below by entering the corresponding number at prompt: 1. Add an Instance 2. Quit Response:
12 Enter 1 to add an instance. The installation script asks for the service name. The default service name is iipatrolem. If this is the service name used in the previous installation, then accept the default. Otherwise, enter the service name. For more information about add an instance, see“To install another BMC IM for PATROL EM instance” on page 50.
How to enable the BMC IM connection Use the procedures in this section to ■ ■ ■ ■
establish a connection to the gateway create propagation policies enable the event classes created by the BAROC class generator enable SMC_STATE_CHANGE event generation
After you complete these tasks, go to Chapter 3, “Configuration,” for a description the configuration tasks.
66
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Establishing a connection to the gateway
Establishing a connection to the gateway Use the procedure in this section to establish a connection to the integration component gateway. When you connect the cell to the integration component gateway, you enable the propagation of data and events from the cell to the integration component.
Before you begin You must have write access to the cell’s files.
To Establish a Connection to the Gateway 1 Open the mcell.dir in a text editor. By default, the mcell.dir file is located in the $MCELL_HOME/etc or %MCELL_HOME%\etc directory path.
2 Edit the mcell.dir file to add the gateway.jServer entry that points to the BMC II for PATROL EM host and port. In the following syntax examples, iipem is a shorthand reference for BMC II for PATROL EM. gateway.jServer cell gateway.portal
jServer cellName bip.
mc mc mc
iipemhostName:3793 cellhostName:1828 PortalhostName:3783
■
The iipemhostName specifies the system where the jServer is installed. It can also be the IP address of the system.
■
The gateway.portal entry (bip.BMCPortalhostName) is the system on which the BMC Portal application server is installed, if you are connecting to the BMC Portal and the 5.1 cell. BMCPortalhostName is the fully qualified domain name of the system where the application server resides.
NOTE Earlier versions of BMC II for PATROL EM (3.6.00, 3.6.01, and 3.6.02) shared the same default port number (3783) as the BMC Portal application server. BMC II for PATROL EM 3.6.03 and the current version default to port number 3793.
3 Restart the cell. ■
To restart the cell under Unix:
Chapter 2
Installation
67
Configuring the propagation policy
1. Enter the mkill command with the -n option, as in the following example. mkill -n cellName
2. Next, enter the mcell command with the -n option to start the cell. mcell -n cellName ■
To restart the cell under Windows: 1. You can stop a cell by stopping the corresponding Windows service from the Control Panel or by entering the net stop mcell_cellName or mkill -n command from the Command Prompt window. 2. Restart the cell by starting the Windows service or by entering the net start mcell_cellName command from the Command Prompt window.
NOTE You do not need to restart the BMC Portal application server unless the cell has been down for 30 minutes or longer. If the cell has been down for 30 or more minutes, restart the BMC Portal and other Portal components as necessary.
See the BMC Impact Solutions System Configuration, Administration, and Maintenance Guide for a complete description of cell management commands.
Configuring the propagation policy To send BMC IM events to PATROL EM, you must define a propagation policy to select the events you want to send. To configure the propagation policy, you have two options. You can either ■
set up the propagation policy directly, using the Event Management Policies features of the Administration tab of the BMC IX If you want to use the Event Management Policies features, see the BMC Event Management Administrator Guide for more information on understanding event policies and defining event propagation policy instances.
■
68
use the provided sample .baroc files to set up a propagation policy without using the policy editor. One file propagates state change events only to PATROL EM; the other file propagates all events except state changes events to PATROL EM.
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Configuring the propagation policy
If you want to implement propagation policies using the provided files instead of using the Event Management Policies features of BMC IX, follow the information in “Propagation Policy File Names and Functions.”
Propagation Policy File Names and Functions Two sample propagation files are installed under $MCELL_HOME/etc/cellName/kb/data or %MCELL_HOME%\etc\cellName\kb\data on the cell host, as described in Table 6. Table 6
Sample propagation files
File name
Description
iipem_em_propagation.baroc
propagates all events to PATROL EM, with the exception of SMC_STATE_CHANGE events
iipem_sim_propagation.baroc propagates all SMC_STATE_CHANGE events to PATROL EM
To Load Propagation Policies Into A Cell 1 Change directory to $MCELL_HOME/etc/cellName/kb/data or %MCELL_HOME%\etc\cellName\kb\data on the cell’s host system.
2 Use the mposter command with the -n and -d options to load the specified propagation policy into the target cell. ■
mposter -n cellName -d iipem_em_propagation.baroc
■
mposter -n cellName -d iipem_sim_propagation.baroc
The policies are loaded into the cell and enabled.
TIP If you restart the cell using the -ia or -id option, you have to reload the propagation policies. To avoid having to repeat the loading process, you can add the entries iipem_em_propagation and iipem_sim_propagation directly to the .load file in the $MCELL_HOME/etc/cellName/kb/data or %MCELL_HOME%\etc\cellName\kb\data directory. Do not include the .baroc file name suffix in the .load file. After adding the entry, you can load the data instance by entering the mposter command, as in the following example for the Windows operating system: mposter -n cellName -d %MCELL_HOME%\etc\cellName\kb\data\ iipem_em_propagation.baroc
3 To edit these propagation policies, go to BMC IX and access the Event Management Policies feature on the Administration tab.
Chapter 2
Installation
69
Enabling the event classes created by the BAROC class generator
For information on configuring the propagation policy, see the information on the policy editor and propagation policy in the BMC Event Management Administrator Guide.
Enabling the event classes created by the BAROC class generator The BAROC class generator creates .baroc files automatically during installation. The files contain BMC IM event classes that BMC II for PATROL EM uses to forward PATROL EM alerts to the BMC IM cell as instances of BMC IM event classes for nonCEF tool types.
NOTE A tool type is considered non-CEF compliant if any of its alerts contains a token that is not in the set described in Table 11 on page 136.
To Enable the Event Classes Created by the BAROC class generator The BAROC files generated during installation were placed into the ./iipemInstallDirectoryPath/files/kb/classes/ directory of the BMC II for PATROL EM host system. The files end with the file name suffix .baroc.
1 Manually copy the .baroc files to the $MCELL_HOME/etc/cellName/kb/classes or %MCELL_HOME%\etc\cellName\kb\classes directory on the cell’s host system.
2 In a text editor, open the .load file in the $MCELL_HOME/etc/cellName/kb/classes or %MCELL_HOME%\etc\cellName\kb\classes subdirectory in which you copied the .baroc file.
3 Add the name of the .baroc file to the .load file. Do not include the file name suffix .baroc in the .load file. For example, you can make an entry such as the following: # Impact Integration for PATROL EM PEM_NetCmmnd
4 Save the .load file. You may need to change the read-only permission on the .load file before saving it.
5 In a terminal or Command Prompt window, go to the cell’s KB directory, and compile the KB using the mccomp command as follows: ■
70
mccomp $MCELL_HOME/etc/cellName/kb/manifest.kb
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Creating a SIM_NOTIFICATION_REGISTRY data instance
■
mccomp %MCELL_HOME%\etc\cellName\kb\manifest.kb
The classes defined in the .baroc files are parsed and then compiled.
6 Restart the cell using the appropriate commands for your operating system: Unix: ■ ■
Enter mkill -n cellName to stop the cell. Enter mcell -n cellName to start the cell.
Windows: ■
■
Stop the Windows service from the Control Panel, or from the Command Prompt window enter net stop mcell_cellName. Restart the Windows server from the Control Panel, or from the Command Prompt window enter net start mcell_cellName.
Creating a SIM_NOTIFICATION_REGISTRY data instance BMC Impact Manager versions 5.0.01 and 5.1 contain an update, which was only available to version 5.0.00 through a software patch, that now enables the BMC Impact Manager instance (cell) to forward SMC_STATE_CHANGE events to a client—in this case, BMC II for PATROL EM. By receiving SMC_STATE_CHANGE events, the client can monitor changes to the service model components and impact relationships. To enable this mechanism, however, you must create a SIM_NOTIFICATION_REGISTRY data instance for each BMC IM instance.
1 Change directories to ■
%MCELL_HOME%\etc\cellName\kb\data
■
$MCELL_HOME/etc/cellName/kb/data
2 Using a text editor, open the smc_notification_register.baroc file, which is depicted in the following figure: Filename: smc_notification_register.baroc Register to receive SMC_STATE_CHANGE events SIM_NOTIFICATION_REGISTRY; clients=[cellname]; requested_notifications=[COMPONENT_CHANGE, COMPONENT_DELETE]; notification_mode=FULL;
Chapter 2
Installation
71
Creating a SIM_NOTIFICATION_REGISTRY data instance
notifications_at_registration=YES; END
3 Replace the [cellname] variable with the name of the cell that you want to register to receive the SMC_STATE_CHANGE events, as in the following example: clients=[myCell];
4 Save and close the smc_notification_register.barocfile. 5 In a text editor, open the .load file in the data subdirectory: ■
%MCELL_HOME%\etc\cellName\kb\data\.load
■
$MCELL_HOME/etc/cellName/kb/data/.load
6 Add the smc_notification_register entry to the .load file, and save and close the file. 7 Enter the following command to load the data instance: ■
mposter -n cellName -d %MCELL_HOME%\etc\cellName\kb\data\ smc_notification_register.baroc
■
mposter -n cellName -d $MCELL_HOME/etc/cellName/kb/data/ smc_notification_register.baroc
SMC_STATE_CHANGE event generation is enabled in the specified cell.
NOTE After you add the smc_notification_register to the .load file, you can load the data instance by including the -id or -ia option with the mcell startup command.
Stopping SMC_STATE_CHANGE events If you want to stop receiving SMC_STATE_CHANGE events on the instance, delete the SIM_NOTIFICATION_REGISTRY instance.
72
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Configuration example: multiple BMC II for PATROL EM instances
Configuration example: multiple BMC II for PATROL EM instances Figure 2 depicts a configuration in which you are connecting two BMC IM cells to the same PATROL EM server through two BMC II for PATROL EM instances. The cells are installed on different systems, while the BMC II for PATROLEM instances are installed on the same host system. Figure 2
Configuration example: multiple BMC II for PATROL EM instances
NOTE This example assumes that the base installation directory path is /usr/nc/Solutions/iipem.
In this example, the jServer host system contains two instances of BMC II for PATROL EM: one for event management and the other for service impact management. Each instance has its own directory under the base directory: /usr/nc/Solutions/iipem/EventManager for event management and /usr/nc/Solutions/iipem/ServiceImpact for service impact management. Each has its unique service name: EventManager and ServiceImpact respectively. The service name and instance name will be the same.
Chapter 2
Installation
73
Uninstalling BMC II for PATROL EM
Both services communicate with unique cells that reside on separate host systems. The EventManager service communicates with its unique event management cell through the default jServer port number 3793, while the ServiceImpact service communicates with its cell through jServer port number 3796. The following table lists the sample configuration values of each BMC II for PATROL EM instance. Configuration Property
Event management instance
Service management instance
Installation directory
/usr/nc/Solutions/iipem/ EventManager
/usr/nc/Solutions/iipem/ ServiceImpact
PATROL EM service
EventManager
ServiceImpact
Host name of cell
A
B
Connection to PATROL EM Filter path
Daemon
Cell name
Event
serviceManagement
Port number
1828
1828
Encryption key
ab
cd
jServer host name
Zanzibar
Zanzibar
Port number
3793
3796
Encryption key
uv
wx
NOTE Each cell and each BMC II for PATROL EM instance can have its unique encryption key as long as there is a matching entry in the respective mcell.dir and ImpactIntegration.cfg files.
Uninstalling BMC II for PATROL EM Use the following procedure to uninstall BMC II for PATROL EM. This process will remove all BMC II for PATROL EM instances, instance definitions, path and filter definitions, and the entire installation directory.
Before you begin You must be logged on as NetCmmnd.
74
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Uninstalling BMC II for PATROL EM
To Uninstall BMC II for PATROL EM The working directory to uninstall BMC II for PATROL EM is one level above the installation directory. For example, if you installed the integration component in the path /usr/nc/Solutions/iipemInstallDirectory, the working directory for uninstallation would be /usr/nc/Solutions.
1 To uninstall the integration component, change directory to the top-level working directory: /usr/nc/Solutions in this example.
2 From the working directory, enter the following command to launch the uninstallation script: ./iipemInstallDirectory/IIPEMUNINST
The uninstallation script is launched: BMC Software, Inc. Uninstallation Script Copyright (c) 2006, BMC Software, Inc. All Rights Reserved This script will uninstall BMC Impact Integration for PATROL Enterprise Manager Continue with uninstall? Enter 'y' for 'yes' or 'n' for 'no'.
3 Enter y for yes. The uninstallation routine removes the BMC II for PATROL EM service. It then asks you whether it should remove the path definition. Uninstallation in progress... Should the ImpactIntegration path definition be removed? Enter 'y' for yes or 'n' for no.
The uninstallation script asks for confirmation on removing the path definition. The path definition is shared by all installed integration components so its removal is optional.
4 Enter y for yes to remove the path definition. The script removes the path definition. Uninstalling the ImpactIntegration path definition... ImpactIntegration path definition uninstall complete.
Chapter 2
Installation
75
Deleting the BMC_BSM user after uninstallation
The script asks you whether it should remove the path prototype, iipemPath. Remove the Path Prototype iipemPath Should the iipemPath Path Prototype be removed? Enter ‘y’ for yes or ‘n’ for no. Response:
5 Enter y for yes. The script completes the uninstallation. Uninstalling the iipemPath Path Prototype... iipemPath Path Prototype uninstall complete. Done!
6 Determine whether you should remove the BMC_BMS user. See “Deleting the BMC_BSM user after uninstallation” on page 76.
7 Perform any necessary cleanup tasks to remove the gateway.Jserver entry from the mcell.dir file of the connected cell. See “Cleaning up after uninstallation” on
page 76.
Deleting the BMC_BSM user after uninstallation To delete the BMC_BSM user, you must be logged in as NetCmmnd. You remove the BMC_BMS user through the Admin => User Mgmt menu command of the PATROL EM Console launcher. You should have the Sybase System Administrator password before you begin. For the specific procedure, see the PATROL Enterprise Manager Administrator Guide.
Cleaning up after uninstallation Use the procedures in this section to clean up the connected cells’ mcell.dir files and remove the BMC II for PATROL EM propagation policies after you uninstall BMC II for PATROL EM.
76
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Cleaning up after uninstallation
Before you begin On Unix platforms, you must be logged with the user account that owns the BMC IM instance. This can be the root account, an account with root privileges, or the user account that installed the instance. On Windows platforms, you must be logged on under the administrator account that has the rights to manage the cell.
To restore the cell’s mcell.dir file 1 Remove the following line from the $MCELL_HOME/etc/mcell.dir or %MCELL_HOME%/etc/mcell.dir file using a text editor.
gateway.jServer jServer host:port where: ■
host is the host name of the system where the BMC II for PATROL EM integration component was installed
■
port is the port you assigned to the jServer
2 Restart the cell using the appropriate commands for your operating system environment. See step 6 on page 71 for an example.
To remove propagation policies 1 In BMC IX, go to the Administration portion of the console, and click the Event Management Policies tab.
2 Click the cell icon in the navigation area and then open the By Selector folder. 3 Select the IIPEM Selector Group folder to display the IIPEM_EM_PROPAGATION and IIPEM_SIM_PROPAGATION policies in the main viewing area of the window.
4 Select the policy entries, and right-click to display the pop-up menu. 5 Choose Delete Policy. The policies are removed from the IIPEM Selector Group folder.
NOTE If you have added any policy files to the .load file, you should remove them and recompile the cell’s KB.
Chapter 2
Installation
77
Cleaning up after uninstallation
78
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Chapter
3
3
Configuration This chapter covers the minimum configuration tasks that you must perform in order for the integration component to pass events between PATROL Enterprise Manager and BMC IM. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . BMC Impact Integration configuration file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring the gateway server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring BMC IM communication settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring encryption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring the EHD host name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring the AGC host name property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring the PATROL EM supervisor name. . . . . . . . . . . . . . . . . . . . . . . . . . . . Enabling or disabling synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring reconnection interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring PATROL EM alert (PEMAlert) properties . . . . . . . . . . . . . . . . . . . . . Specifying filter delimiter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Enabling or disabling the leading delimiter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Enabling filter path specific logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring time-out interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Handling undefined tokens in CEF210 message . . . . . . . . . . . . . . . . . . . . . . . . . . . Logging key:value pairs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Specifying the Impact Manager slot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Mc Smc mapping configuration file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Modifying the configuration file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Mapping specification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Example 1: Basic mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Example 2: Specifying multiple values for an alertType . . . . . . . . . . . . . . . . . . . . . Example 3: Using reserved words . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Example 4: Using literal double quotes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Checking the format of McSmcMapping.cfg. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . How to update bidirectional communication settings . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring the BMC IM events to PATROL EM alerts mapping scheme. . . . . . . . . Editing the IMToPEMMapping.cfg file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Editing the IMToCEFMapping.cfg file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Mapping BMC IM MCEvent slots to PATROL EM CEF token names (daemon option) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Chapter 3 Configuration
80 81 83 84 85 86 86 86 87 88 88 89 90 90 91 91 92 92 93 93 93 94 94 94 95 95 95 96 97 97 98 79
Overview
Mapping BMC IM MCEvent slots to CEF210 token names (filter path option) . . 98 Changing the default toolId and toolType values . . . . . . . . . . . . . . . . . . . . . . . . . 100 Mapping BMC IM MCEvent severity to PATROL EM alert type . . . . . . . . . . . . 100 Mapping BMC IM SMCState severity to PATROL EM alert type . . . . . . . . . . . . 101 Controlling SMC status propagation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 Specifying which PATROL EM alerts to send to BMC IM . . . . . . . . . . . . . . . . . . . . . . 103 Selector criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 Adding alert selector criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 How to associate PATROL EM alerts with service model components. . . . . . . . . . . 109 Aliases and component IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 Default alias mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110 Service model component mapping criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110 Mapping PATROL EM alerts with component IDs . . . . . . . . . . . . . . . . . . . . . . . . 112 Other mapping criteria examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Overview The install script writes configuration files to the ./iipemInstallDirectoryPath/conf and the ./iipemInstallDirectoryPath/instanceName/conf directory. Table 7 lists and briefly describes these configuration files. Table 7
BMC II for PATROL EM Configuration Files
File Name
Purpose
DefaultImpactIntegration.cfg
This is a reference file that contains standard property settings. Do not modify the DefaultImpactIntegration.cfg file.
ImpactIntegration.cfg
This file contains the custom communications information that you entered during installation, information such as jServer and cell parameters, encryption setting, EHD host name and so forth. The BMC II for PATROL EM component reads the values that you enter in the ImpactIntegration.cfg file.
IMToCEFMapping.cfg
This file defines the mapping between BMC IM slots and CEF210 message. This file also contains user-configurable BMC IM event severity levels for mapping to PATROL EM alert types.
IMToPEMMapping.cfg
This file allows the user to change the default mappings between BMC IM event information and PATROL Enterprise Manager alert data. The file contains ■ ■
80
user-configurable toolID and toolType variables for alerts originating from BMC IM user-configurable BMC IM event severity levels for mapping PATROL EM alert types
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
BMC Impact Integration configuration file
Table 7
BMC II for PATROL EM Configuration Files
File Name
Purpose
McSmcMapping.cfg.example
A reference file, it contains example code that you can use as a model to map the token values of a PATROL EM alert to the mc_smc_alias slot of a BMC Impact Manager event. The file that you create is named the McSmcMapping.cfg file. Do not modify the McSmcMapping.cfg.example file.
PEMSelector.cfg
This file would contain alert selection criteria that you define. Alert selection criteria controls which PATROL EM alerts are forwarded to BMC IM.
PEMSelector.cfg.example
A reference file, it contains example code that you can use to specify your alert selection criteria in the PEMSelector.cfg file. Do not modify the PEMSelector.cfg.example file.
This chapter describes these files in depth.
BMC Impact Integration configuration file Use the BMC Impact Integration configuration file (./iipemInstallDirectoryPath/instanceName/conf/ImpactIntegration.cfg) to customize your system settings for BMC II for PATROL EM.
NOTE Do not modify the DefaultImpactIntegration.cfg file. It provides a reference for standard settings in BMC II for PATROL EM.
During installation, the script prompts you for most of the values contained in the ImpactIntegration.cfg file. You can also override the values after installation. Table 8 lists the ImpactIntegration.cfg properties, all of which you can update. The installation script specifically prompts you to enter values for the following properties: ■ ■ ■ ■
Gateway.jserver ImpactManager EHDHostName AGCHostName
The installation script uses default values for the remaining properties.
Chapter 3 Configuration
81
BMC Impact Integration configuration file
Table 8
Configurable properties in the ImpactIntegration.cfg file
Property
Description
Gateway.jserver
specifies the Gateway jserver communication information that is used by the integration component for receiving events from BMC IM
ImpactManager
specifies the BMC IM communication information that is used by the integration component for connecting to BMC IM
Encryption
enables or disables the encryption of communications between the integration component and BMC IM. It defaults to on, indicating that encryption is enabled.
EHDHostName
specifies the host name where the PATROL EM Event Handler Daemon (EHD) process is running
AGCHostName
specifies the host name where the PATROL EM AGC process is running
PEMUserName
specifies the PATROL EM supervisor name to be used in operations, such as Supervisor Close and Supervisor Acknowledge. The default is BMC_BSM.
PEMSynchronization
enables or disables synchronization between the integration component and BMC IM. The default is on, indicating that active and closed PATROL EM alerts, which are generated while the integration component is shut down, are retrieved and forwarded to the BMC IM cell after the integration component restarts.
NumSecsToTryReconnect
specifies the number of seconds for the integration component should attempt to reconnect after a connection failure between the integration component and either PATROL EM or the BMC IM cell. The default interval is 300 seconds.
PEMAlert
maps PATROL EM alert severity to BMC IM event severity. See “Configuring PATROL EM alert (PEMAlert) properties” on page 3-88 for the default mapping scheme.
PEMFilterDelimiter
specifies the delimiter used in the CEF210 message. The default is ‘ ~%~ .‘
PEMUseTransformer
specifies whether a leading delimiter is added to the CEF message. The default is false.
PEMLogCEF
specifies additional logging for tracing filter path message traffic. The default is false.
ImpactManagerWaitTime
defines the maximum time-out window for an acknowledgement to an event sent to the Impact Manager. The default value is 5000 milliseconds.
PEMShowNulls
specifies how undefined tokens are included in the CEF210 message sent to PEM via a filter path. The default is false.
PEMLogKeyValue
specifies whether key-value pairs of messages received from PEM when using are logged.The default is false.
ImpactManagerVersion
controls which Impact Manager slot to use for mapping of PEM token values
See Appendix B, “Configuration File Reference” for an example ImpactIntegration.cfg file.
82
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Configuring the gateway server
To update the ImpactIntegration.cfg file Perform this procedure each time you modify the ImpactIntegration.cfg file.
1 Open the ./iipemInstallDirectoryPath/instanceName/conf/ImpactIntegration.cfg in a text editor.
2 Enter the new values, and save the file. 3 If required, make any corresponding changes to the cell’s configuration file(s). 4 Restart the cell if you have updated its configuration. 5 Restart the service by entering the following commands: ■
stopPath -n serviceName
■
startPath -n serviceName
Configuring the gateway server The Gateway.jserver property specifies the name, encryption key, and port number of the jServer. The integration component uses the Gateway.jServer communication settings to receive events from the BMC IM instance. To update the Gateway.jserver property, you modify the value in the ImpactIntegration.cfg file, and you make a corresponding update in the $MCELL_HOME/etc/mcell.dir or %MCELL_HOME%\etc\mcell.dir file of the BMC IM cell. The format of the Gateway.jServer value in the ImpactIntegration.cfg file is shown in the following example. GatewayName:LocalPort#EncryptionKey GatewayName is jServer; LocalPort# is the port number used by the jServer on the host system; and EncryptionKey is the BMC IM encryption key, typically mc.
EXAMPLE Gateway.jserver=jServer:3793# mc
Chapter 3 Configuration
83
Configuring BMC IM communication settings
To extend this example to an mcell.dir file on the BMC IM server, you would make the following entry: Type gateway.jServer
Name jServer
EncryptionKey mc
IpAddress:Port iipemHostName:3793
For the integration component’s entry: ■
Type is always gateway.jServer.
■
Name must match the name in the propagation policy files iipem_em_propagation.baroc and iipem_sim_propagation.baroc.
■
EncryptionKey must match the EncryptionKey from the ImpactIntegration.cfg file.
■
IpAddress is either the IP address or host name (iipemHostName) where the
integration component is installed. ■
Port matches LocalPort# from the ImpactIntegration.cfg file.
After making the changes, follow the procedure for updating the ImpactIntegration.cfg file on page 83.
Configuring BMC IM communication settings The ImpactManager property specifies the following BMC IM communication settings: ■ ■ ■ ■
name or IP address of the cell encryption key used by the cell remote host name or IP address where BMC IM is running port number of the cell
The integration component uses this information to connect with the BMC IM server. To update the ImpactManager property, you modify the value in the ImpactIntegration.cfg file, and you make a corresponding update in the $MCELL_HOME/etc/mcell.dir or %MCELL_HOME%\etc\mcell.dir file of the BMC IM cell. The format of the ImpactManager value in the ImpactIntegration.cfg file is shown in the following example. Name@Host:Port#EncryptionKey
84
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Configuring encryption
Name is the name assigned to the cell; Host is the name or IP address of the system where BMC IM is running; Port# is the port number used by the cell; and EncryptionKey is the BMC IM encryption key, typically mc.
EXAMPLE ImpactManager=promethius@promethius:1828#mc
To extend this example to an mcell.dir file on the BMC IM server, you would make the following entry: Type gateway.jServer cell
Name EncryptionKey jServer mc promethius mc
IpAddress:Port iipemHostName:3793 promethius:1828
When entering the ImpactManager property values in the mcell.dir file, the Type value will always be cell. After making the changes, follow the procedure for updating the ImpactIntegration.cfg file on page 83.
Configuring encryption The Encryption property is an on|off switch that indicates an encrypted communication between the integration component and the cell. By default, the Encryption property is set to on, as in this format example: Encryption=on
When the Encryption property is set to on, you can specify an encryption key value in the ImpactManager property and a matching value in the mcell.dir of the connected cell. If you change the Encryption value to off, you need to verify or update a value in the connected cell’s $MCELL_HOME/etc/mcell.conf or %MCELL_HOME%\etc\mcell.conf file. Ensure that the ForceEncryption parameter in the mcell.conf file is set to NO, which is its default value. If the ForceEncryption parameter is set to YES, then all communication from the cell is encrypted. In this case, the value of the Encryption property in ImpactIntegration.cfg file must be set to ON. After making any changes, follow the procedure for updating the ImpactIntegration.cfg file on page 83.
Chapter 3 Configuration
85
Configuring the EHD host name
Configuring the EHD host name The EHDHostName property specifies the host name where the PATROL EM Event Handler Daemon (EHD) process is running. The format of the EHDHostName value in the ImpactIntegration.cfg file is shown in the following example. EHDHostName=hostName
EXAMPLE EHDHostName=abacus
Generally, you do not change this value after you have defined it during installation.
Configuring the AGC host name property The AGCHostName property specifies the host name where the PATROL EM database processes are running. You can specify this value during installation. It defaults to the local host name. The format of the AGCHostName value in the ImpactIntegration.cfg file is shown in the following example. AGCHostName=hostName
EXAMPLE AGCHostName=abacus
You can specify an existing PATROL EM server on another host system as the AGC without reinstalling PATROL Enterprise Manager or BMC II for PATROL EM.
Configuring the PATROL EM supervisor name The PEMUserName property specifies the PATROL EM supervisor name that should be used in operations such as Supervisor Close. The default name is BMC_BSM. This user name is automatically created during installation.
86
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Enabling or disabling synchronization
The value specified for PEMUserName corresponds to the PATROL EM type supervisors. This PEMUserName property is required to enable the BMC II for PATROL EM user to perform operations on PATROL EM that the PATROL EM supervisor can do. For example, when the Close Event operation is performed on an event in Impact Manager, BMC II for PATROL EM issues a SupervisorClose operation against the corresponding alert in PATROL EM under supervisor BMC_BSM.
TIP BMC Software urges that you use the default name BMC_BSM.
The format of the PEMUserName value in the ImpactIntegration.cfg file is shown in the following example. PEMUserName=userName
EXAMPLE PEMUserName=BMC_BSM
Enabling or disabling synchronization The PEMSynchronization property is an on|off switch, indicating whether to enable or disable the BMC II for PATROL EM component from synchronizing events between PATROL EM and BMC IM. This property is automatically defined during installation. When BMC II for PATROL EM starts up after a shutdown, it tries to synchronize the BMC Impact Manager instance with PATROL EM by retrieving all PATROL EM active and closed alerts that have occurred since shutdown. It can synchronize a maximum of 10,000 closed PATROL EM alerts with corresponding BMC Impact Manager events. After all active and closed alerts are processed after a restart, a DataSynchronized alert is created in PATROL EM. The format of the PEMSynchronization value in the ImpactIntegration.cfg file is shown in the following example. PEMSynchronization=on
If you do not want to receive the active and closed alerts, then change the PEMSynchronization value to off.
Chapter 3 Configuration
87
Configuring reconnection interval
See “Synchronization of event/alert states” on page 32 for additional information about this feature. After making any changes, follow the procedure for updating the ImpactIntegration.cfg file on page 83.
Configuring reconnection interval The NumSecsToTryReconnect property is used when the integration component drops its connection to either BMC IM or PATROL EM. The property specifies the number of seconds that the integration component waits before it tries to reconnect to either BMC IM or PATROL EM. The default value is 300 seconds. The format of the NumSecsToTryReconnect value in the ImpactIntegration.cfg file is shown in the following example. NumSecsToTryReconnect=300
See “Recovering after a connection failure” on page 130 for additional information. After making any changes, follow the procedure for updating the ImpactIntegration.cfg file on page 83.
Configuring PATROL EM alert (PEMAlert) properties The PEMAlert properties uses a mapping scheme to map PATROL EM alert severity to a corresponding BMC IM event severity. When the integration component receives a PATROL EM alert that will be sent to BMC IM, it first converts the alert into a BMC IM event. The integration component uses the PATROL EM alert severity mapping to assign a severity level to the BMC IM event. The format of the PEMAlert properties mapping statement in the ImpactIntegration.cfg file is shown in the following example. PEMAlert_=
88
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Specifying filter delimiter
The list of six default mappings that are defined at installation is shown in the following table: PEMAlert_ PEMAlert_CLEAR PEMAlert_INFORMATIONAL PEMAlert_WARNING PEMAlert_MINOR PEMAlert_MAJOR PEMAlert_CRITICAL
= = = = = = =
OK INFO WARNING MINOR MAJOR CRITICAL
If the PEMAlert property is empty, as in the following example where the PATROL EM alert of the severity type INFORMATIONAL is unassigned, PEMAlert_ PEMAlert_CLEAR PEMAlert_INFORMATIONAL PEMAlert_WARNING
= = = =
OK WARNING
then a BMC IM event is generated with the severity type WARNING. You can modify the mapping scheme. For example, you could choose to map the severity type PEMAlert_WARNING to the severity type CRITICAL on the BMC IM side, as shown in the following figure. PEMAlert_ PEMAlert_CLEAR PEMAlert_INFORMATIONAL PEMAlert_WARNING PEMAlert_MINOR PEMAlert_MAJOR PEMAlert_CRITICAL
= = = = = = =
OK INFO CRITICAL MINOR MAJOR CRITICAL
After making any changes, follow the procedure for updating the ImpactIntegration.cfg file on page 83.
Specifying filter delimiter The PEMFilterDelimiter property is used by the integration component to format all CEF210 messages that are sent to PEM when using a filter path. The property specifies the delimiter that is used in a CEF210 message. The default value is ‘ ~%~ ’
Chapter 3 Configuration
89
Enabling or disabling the leading delimiter
The format of the PEMFilterDelimiter property in the ImpactIntegration.cfg file is shown in the following example: PEMFilterDelimiter=’ ~%~ ‘
NOTE Do not change this field. This action will stop both the Transformer and the filter path from parsing the message sent by iiPEM.
Enabling or disabling the leading delimiter The PEMUseTransformer property is used by the integration component to format all CEF210 messages that are sent to PEM when using a filter path. The property specifies whether to include a leading delimiter in the CEF210 message. The default value is false. The format of the PEMUseTransformer property in the ImpactIntegration.cfg file is shown in the following example. PEMUseTransformer=false
When the PEMUseTransformer value is set to false, a leading delimiter is added to the CEF message. This property is used when a custom transformer has been installed that requires the CEF message not have a leading delimiter.
Enabling filter path specific logging The PEMLogCEF property is used by the integration component to specify tracing of all filter path message traffic. The default value is false. The format of the PEMLogCEF property in the ImpactIntegration.cfg file is shown in the following example. PEMLogCEF=false
90
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Configuring time-out interval
As a debugging tool, if you set the PEMLogCEF property value to true, you will be able to trace message traffic when using the filter path option.
WARNING If PEMLogCEF is set to true, the log files could become very large and fill up the file system.
Configuring time-out interval The ImpactManagerWaitTime property is used by the integration component to define the maximum time (in Milliseconds) to wait for an acknowledgement from Impact Manager after sending an Event. The default value is 5000 milliseconds. The format of the ImpactManagerWaitTime property in the ImpactIntegration.cfg file is shown in the following example. ImpactManagerWaitTime=5000
You can increase the wait-time if synchronization problems exist between PEM and Impact Manager that are due to a slow response from Impact Manager. It is recommended that you set the wait-time to a value that is equal to or greater than 5000 milliseconds.
Handling undefined tokens in CEF210 message The PEMShowNulls property is used by the integration component to format the CEF210 message sent to PEM when using a filter path. The property specifies whether field details of each undefined token are added to the CEF210 message. The default value is false. The format of the PEMShowNulls property in the ImpactIntegration.cfg file is shown in the following example. PEMShowNulls=false
Chapter 3 Configuration
91
Logging key:value pairs
By default, missing fields are represented as follows:
EXAMPLE ~%~ -- ~%~
It is difficult to determine which fields are missing when multiple fields are missing. When this property is set to true, the CEF210 message will include the field name in angled brackets:
EXAMPLE ~%~ ~%~
Logging key:value pairs The PEMLogKeyValue property is used by the integration component to log key:value pairs of all messages from PEM when running as a filter path. The default value is false. The format of the PEMLogKeyValue property in the ImpactIntegration.cfg file is shown in the following example. PEMLogKeyValue=false
Examples of key:value logging follows: Tok_cefVersion:[BMCCEFV2R1M0] Tok_eventType:[create_alert] Tok_originDateTime:[Feb 21, 2006 04:32:59 PM PST] Tok_originClass:[filterPath:filter1]
Specifying the Impact Manager slot The ImpactManagerVersion property is used by the integration component to specify which Impact Manger slot to use for mapping PEM token values. The default value is 5.1.00.
92
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Mc Smc mapping configuration file
The format of the PEMLogKeyValue property in the ImpactIntegration.cfg file is shown in the following example: ImpactManagerVersion=5.1.00
Mc Smc mapping configuration file The McSmcMapping.cfg.example file provides examples on how to create rules that map the token values of a PATROL EM alert into the mc_smc_id slot of a BMC IM event.
Modifying the configuration file Use the following step to create and customize a McSmcMapping.cfg file for your sitespecific needs: Copy the contents of the McSmcMapping.cfg.example file into a file named McSmcMapping.cfg, and then edit the new file. Be careful to remove the portions of the McSmcMapping.cfg.example file that do not apply to your environment.
Mapping specification The syntax of the mapping specification is as follows: BEGIN toolType = ; [alertType = [ , ] ; ]] mapValue = ; END For information about the rules of the mapping language, see “Service model component mapping criteria” on page 110.
Chapter 3 Configuration
93
Example 1: Basic mapping
Example 1: Basic mapping In this example, if the PATROL EM alert has a toolType = NetConnection and an alertType = Alarm, then the value of mc_smc_id slot is host__. For example, if the value of token originKey is 10 and the value of token origin is promethius, then the value of mc_smc_id is host_10_promethius. Begin ToolType = NetConnection; AlertType = Alarm; mapValue = host_[originKey]_[origin]; End
Example 2: Specifying multiple values for an alertType This example shows how to specify more than one value for alertType. In this example, the mc_smc_id will be mapped if toolType = TestToolType, AND alertype = Alarm OR NoAlarm. If, for example, the value of token ws2 is Oracle and value of token service is DB, then the value of mc_smc_id is Oracle%DB. Begin toolType = TestToolType; alertType = Alarm, NoAlarm; mapValue = [ws2]%[service]; End
Example 3: Using reserved words The following example shows how to use reserved words. If you have a toolType named toolType, the following usage is not correct: toolType = toolType. Instead, you must put double quotes around the value of toolType: toolType = "toolType".
94
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Example 4: Using literal double quotes
Begin toolType = “toolType”; alertType = Alarm; mapValue = BMC_[originKey]_[origin]; End
Example 4: Using literal double quotes The following example shows how to use literal double quotes. If a toolType is named "test", where double quotes are part of the name, and you use toolType = "test", the parser considers the name as test. Backslash tells the parser to treat the double quote as part of the name: toolType = \"test\". The following example uses backslashes to escape the quotes used in id. If the value for originKey = 10, and the value for origin = promethius, then the id = "10"_promethius. Begin toolType = \”test\”; alertType = Alarm; mapValue = \”[originKey]\”_[origin]; End
Checking the format of McSmcMapping.cfg Once you have completed editing your McSmcMapping.cfg file, you should validate its formatting before starting the integration component. You can validate the format of the McSmcMapping.cfg file by running the checkFormatMcSmcMap script. For example script, see “To validate the mapping criteria” on page 113.
How to update bidirectional communication settings This section describes ■
event mapping schemes for daemon connection to BMC Impact Manager
Chapter 3 Configuration
95
Configuring the BMC IM events to PATROL EM alerts mapping scheme
The ./iipemInstallDirectoryPath/instanceName/conf/IMToPEMMapping.cfg file contains a series of configurable event mapping schemes that define how BMC IM events are mapped to PATROL EM alerts. These mapping schemes include — BMC IM slots to PATROL EM tokens — BMC IM event severity to PATROL EM alert type for BMC IM events and state changes — the default PATROL EM toolId and toolType values ■
Event mapping schemes for a filter path connection to BMC IM The ./iipemInstallDirectoryPath/instanceName/conf/IMToCEFMapping.cfg file contains a series of configurable event mapping schemes that define how BMC Impact Manager events are mapped to PATROL EM alerts. These mapping schemes include — BMC IM slots to PATROL EM tokens — BMC IM event severity to PATROL EM alert type for BMC IM events and state changes
Configuring the BMC IM events to PATROL EM alerts mapping scheme With the ./iipemInstallDirectoryPath/instanceName/conf/IMToPEMMapping.cfg file or the ./iipemInstallDirectoryPath/instanceName/conf/IMToCEFMapping.cfg, you can edit the following mapping schemes: ■ ■ ■
BMC IM MCEvent slot names to PATROL EM CEF token names BMC IM MCEvent severity to PATROL EM alert type BMC IM state change (SMCState) severity to PATROL EM alert type
NOTE For mapping slot names to token names, use ./iipemInstallDirectoryPath/instanceName/conf/IMToPEMMapping.cfg to map BMC IM events to PATROL EM alerts over a daemon connection. Similarly, use ./iipemInstallDirectoryPath/instanceName/conf/IMToCEFMapping.cfg to Map BMC IM events to PATROL EM alerts over a filter path connection.
In the IMToPEMMapping.cfg file, you can also modify the toolId and toolType variables, both of which define the alert types that originate from PATROL EM as a result of events received from BMC IM.
96
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Editing the IMToPEMMapping.cfg file
Editing the IMToPEMMapping.cfg file This procedure describes the steps you must take after you edit the mapping schemes or modify the toolID or toolType definitions in the IMToPEMMapping.cfg file.
1 Edit the IMToPEMMapping.cfg file in a text editor. 2 Save the updated IMToPEMMapping.cfg file. 3 Generate the filter, if needed. 4 Define the filter path, if needed. See your PATROL EM documentation for information on generating the filter and defining the filter path.
5 Run the stopPath command to stop the integration component. stopPath -n serviceName (for example: stopPath -n iipatrolem)
6 Use the startPath command to restart the integration component. startPath -n serviceName (for example: startPath -n iipatrolem)
Editing the IMToCEFMapping.cfg file This procedure describes the steps you must take after you edit the mapping schemes or modify the toolID or toolType definitions in the IMToCEFMapping.cfg file.
1 Edit the IMToCEFMapping.cfg file in a text editor. 2 Save the updated IMToCEFMapping.cfg file. 3 Run the stopPath command to stop the integration component. stopPath -n serviceName (for example: stopPath -n iipatrolem)
4 Use the startPath command to restart the integration component. startPath -n serviceName (for example: startPath -n iipatrolem)
Chapter 3 Configuration
97
Mapping BMC IM MCEvent slots to PATROL EM CEF token names (daemon option)
Mapping BMC IM MCEvent slots to PATROL EM CEF token names (daemon option) Figure 3 contains the default BMC IM to PATROL EM CEF token mapping contained in the ./iipemInstallDirectoryPath/instanceName/conf/IMToPEMMapping.cfg. Figure 3
BMC IM slot name to PATROL EM CEF token name default mapping
BMC IM MCEvent slot name mc_host mc_host_class mc_smc_id mc_smc_type mc_location mc_ueid mc_incident_time mc_parameter_value msg
= = = = = = = = = = =
PATROL EM CEF token name domain domainClass object objectClass objectLocation origin originKey originDateTime parameterValue freeText
NOTE is the only allowed non-BMC IM slot name.
You can modify the mapping of BMC IM slot names to PATROL EM CEF token names. When modifying the BMC IM slot names to PATROL EM CEF token names, you do not have to use the CEF-compliant tokens. (See Appendix A, “Connection Mappings” for a listing of CEF-compliant tokens.) However, the names must match the tokens that exist in the filter definition. After you edit the BMC IM slot name to PATROL EM CEF token name map, follow the procedure “Editing the IMToPEMMapping.cfg file” on page 3-97.
Mapping BMC IM MCEvent slots to CEF210 token names (filter path option) Figure 4 contains the default BMC IM to CEF210 token mapping contained in the ./iipemInstallDirectoryPath/instanceName/conf/IMToCEFMapping.cfg.
98
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Mapping BMC IM MCEvent slots to CEF210 token names (filter path option)
Figure 4
BMC IM slot name to CEF210 token name default mapping
BMC IM MCEvent slot name _domain _domainClass _object _objectClass _objectLocation _orgin _originClass _originKey _originDateTime _freeText _originEventClass _originSeverity _eventType _itMgmtLayer _service _customer _itMgmtProcess _itMgmtProcessState _parameterName _ParameterValue
= = = = = = = = = = = = = = = = = = = =
PATROL EM CEF token name mc_host mc_host_class mc_object mc_object_class mc_location mc_ueid mc_local_reception_time msg CLASS severity ‘create_alert’ sub_origin mc_service ‘customer’ mc_it_mgmt_process ‘state’ mc_parameter mc_parameter_value
NOTE For the filter path to function correctly, the following mapping is required and cannot be changed: _origin = _originClass = _orginKey = mc_ueid Other slots can be customized as needed. and map to special settings, the cell name and “filterPath:instanceName,” respectively. Single quotes force the token to the quoted value; for example in the file above the eventType token will be forced to the value create_event.
You can modify the mapping of BMC IM slot names to PATROL EM CEF token names. The names should match the tokens that exist in the iipemCEFv210 filter definition. After you edit the BMC IM slot name to PATROL EM CEF token name map, follow the procedure “Editing the IMToCEFMapping.cfg file” on page 3-97.
Chapter 3 Configuration
99
Changing the default toolId and toolType values
Changing the default toolId and toolType values The toolId and toolType properties define the path and filter names for alerts which originate from PATROL EM as a result of events received from BMC IM. The default toolId (path name) and toolType (filter name) values are shown below in the following figure. toolId toolType
= =
ImpactIntegration ImpactIntegration
You can modify the toolId and toolType values if, for example, you have defined nonCEF tokens in your unique filter. Before you edit the toolId and toolType values, generate the filter and define the path. See your PATROL EM documentation for more information. After you edit the toolId or toolType value, follow the procedure “Editing the IMToPEMMapping.cfg file” on page 3-97.
Mapping BMC IM MCEvent severity to PATROL EM alert type When the integration component receives a BMC IM event, it converts the event into a PATROL EM alert. The integration component applies the defined tool type and tool ID values to the BMC IM message format that carries the BMC IM event. Using the tool type and tool ID, it converts the event message format to an alert message format that PATROL EM then uses to generate the alert that results from the BMC IM event. During the conversion process, the integration component uses the BMC IM event severity to determine the equivalent PATROL EM alert type and severity. The BMC IM MCEvent property maps the severity of BMC IM events—except for state change events—to the PATROL EM alert type and severity. The following figure depicts the syntax of the BMC IM event property mapping definition. MCEvent_ImpactManagerEventSeverity=PEMAlertType
ImpactManagerEventSeverity is the BMC IM severity level. PEMAlertType is the type of alert (an event) and its corresponding severity.
100
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Mapping BMC IM SMCState severity to PATROL EM alert type
Figure 5 shows the default mappings of BMC IM event severity levels with that of PATROL EM alerts. Figure 5
BMC IM MCEvent severity to PATROL EM alert type and severity
BMC IM MCEvent severity MCEvent_UNKNOWN MCEvent_OK MCEvent_INFO MCEvent_WARNING MCEvent_MINOR MCEvent_MAJOR MCEvent_CRITICAL
= = = = = = = =
PATROL EM alert type and severity EVENT_INFORMATIONAL EVENT_CLEAR EVENT_INFORMATIONAL EVENT_WARNING EVENT_MINOR EVENT_MAJOR EVENT_CRITICAL
If the BMC IM MCEvent property value is empty, as in the following example in which BMC IM MCEvent_INFO is empty, then no corresponding alert is generated in PATROL EM for the BMC IM MCEvent_INFO event severity. BMC IM event severity MCEvent_UNKNOWN MCEvent_OK MCEvent_INFO
= = = =
PATROL EM alert type and severity EVENT_INFORMATIONAL EVENT_CLEAR
You can modify these mappings to match a customized filter definition. After you edit an MCEvent property value, follow the procedures “Editing the IMToPEMMapping.cfg file” on page 97 and “Editing the IMToCEFMapping.cfg file” on page 97.
Mapping BMC IM SMCState severity to PATROL EM alert type The BMC IM SMCState property maps the severity of a BMC IM state change event to the PATROL EM state change alert type and severity. The SMCState property mappings determine which PATROL EM alerts are generated when a monitored service model component changes state. The following figure depicts the syntax of the SMCState property mapping definition. SMCState_ImpactManagerEventSeverity=PEMAlertType
ImpactManagerEventSeverity is the severity level of the BMC IM state change event. PEMAlertType is the type of alert (a state change) and its corresponding severity. Figure 6 shows the default mappings of SMCState severity levels with that of PATROL EM alerts.
Chapter 3
Configuration
101
Controlling SMC status propagation
Figure 6
BMC IM SMCState severity to PATROL EM alert type and severity
BMC IM SMCState severity SMCState_UNKNOWN SMCState_OK SMCState_INFO SMCState_WARNING SMCState_MINOR SMCState_MAJOR SMCState_CRITICAL
= = = = = = = =
PATROL EM alert type and severity SMC_INFORMATIONAL SMC_CLEAR SMC_INFORMATIONAL SMC_WARNING SMC_MINOR SMC_MAJOR SMC_CRITICAL
If the SMCState property value is empty, as in the following example in which SMCState_INFO is empty, then no corresponding SMC_severity level is generated in PATROL EM for the BMC IM SMCState_INFO state change. BMC IM SMCState severity SMCState_UNKNOWN SMCState_OK SMCState_INFO
= = = =
PATROL EM alert type and severity SMC_INFORMATIONAL SMC_CLEAR
You can modify these mappings to match a customized filter definition. After you edit an SMCState property value, follow the procedures “Editing the IMToPEMMapping.cfg file” on page 97 and “Editing the IMToCEFMapping.cfg file” on page 97.
Controlling SMC status propagation When a service model component changes its state, an SMC_STATE_CHANGE event is generated by the cell. Each SMC_STATE_CHANGE event is turned into an SMC_severity alert by the integration component. However, you might want to restrict the SMC_ alerts to only those SMC types that are most important to your site. You can configure SMC status propagation by modifying dynamic data instances residing on the cell. This data consists of a list of one or more SMC data class names to be propagated. The default is to propagate all SMC_STATE_CHANGE events. See the %MCELL_HOME%\etc\cellName\kb\data\iipem_sim_propagation.baroc or $MCELL_HOME/etc/cellName/kb/data/iipem_sim_propagation.baroc file. Other propagation files in the data subfolder include ■ ■
iipem_em_propagation.baroc smc_notification_register.baroc
For more information regarding propagation policies, see the BMC Event Management Administrator Guide. 102
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Specifying which PATROL EM alerts to send to BMC IM
Specifying which PATROL EM alerts to send to BMC IM You determine which PATROL EM alerts to send to BMC IM by defining special selector criteria in the ./iipemInstallDirectoryPath/instanceName/conf/PEMSelector.cfg file. The criteria consist of ■ ■ ■
a unique syntax variables language rules
NOTE The ./iipemInstallDirectoryPath/instanceName/conf/PEMSelector.cfg.example file shipped with BMC II for PATROL EM contains example code of an alert selector file. Keep it as a reference copy. The selector criteria that you define are matched against the properties of incoming PATROL EM alerts. The integration component forwards the PATROL EM alerts that match the selector criteria to the BMC IM instance. A default PEMSelector.cfg is generated at installation. If you elect not to specify any selector criteria, then by default all PATROL EM alerts are forwarded except for alert types that originate from PATROL EM as a result of received BMC IM events. These are the alert types that are specified by the toolType set equal to ImpactIntegration (toolType = ImpactIntegration) in the IMToPEMMapping.cfg file or the alert types created by the filter path service when using the filter path option..
Selector criteria To limit the alerts that PATROL EM forwards to BMC IM, you begin by entering values for the selector criteria. The selector criteria include one or more combinations of the following variables: ■ ■ ■ ■ ■ ■
toolType tool ID alertType severity category priority
Chapter 3
Configuration
103
Selector criteria
Selector criteria syntax The selector criteria are defined within BEGIN and END statements. The syntax of the selector criteria within the BEGIN and END statements is depicted in the figure below. BEGIN [ toolType (= [ toolId (= [ alertType(= [ severity (= [ category (= [ priority (= END [ BEGIN ... END ] ...
| | | | | |
!=) !=) !=) !=) !=) !=)
; ] ; ] [ , ] ; ] [ , ] ; ] [ , ] ; ] [ , ] ; ]
You can add multiple sets of BEGIN and END statements, with each set containing its distinct selector criteria.
Selector criteria variables Table 9 on page 104 lists and describes the variables for the selector criteria severity, category, and priority. Table 9
Syntax for alert selector variables
Variable
Value
severityName
must be one of the following: Clear, Informational, Warning, Minor, Major, and Critical
categoryName
must be one of the following: Circuit, Equipment, Facility, LAN, Multipoint_Circuit, Service, or Software
priorityNumber
must be an integer between 0 and 99
Selector language rules
104
■
Every block of selector criteria starts with BEGIN and ends with END. A PEMSelector.cfg file can contain one or multiple BEGIN/END blocks.
■
In a BEGIN/END block, six different variables can be used: toolType, toolId, alertType, severity, category, and priority.
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Selector criteria
■
BEGIN, END, toolType, toolId, alertType, severity, category, and priority are reserved words, and they are case sensitive.
■
Each variable has the format of "variable = value;" where value is case sensitive.
■
You can specify only one value each for toolType and toolId.
■
You can specify multiple values for alertType, severity, category, and priority, as long as the values are separated by commas. A comma specifies an OR relationship between the values.
■
If an alertType is defined, toolType must also be defined. However, the not-equals a operator "!=" cannot be used in this case for toolType.
■
An implied AND relationship exists between all lines of the selector criteria within a BEGIN/END block.
■
An implied OR relationship exists between BEGIN/END blocks.
■
Use double quotes to use a reserved word as a value. For example, if you have a toolType named toolType, you specify it in this way: toolType = "toolType".
■
If you use a double quote in your value name, put a backslash in front of each double quote to escape it. For example, if you have a toolType named "test", where double quotes are part of the toolType name, you specify it as follows: toolType=\”test\”.
Selector criteria example The example in the following figure specifies that PATROL EM alerts which meet either of the following conditions are sent to BMC IM: ■
alerts that have their toolType equal to NetCmmnd and their alertType equal to Alarm
or ■
alerts for which toolId does not equal NetCmmnd and the severity is equal to Major or Critical
BEGIN toolType = NetCmmnd; alertType = Alarm; END BEGIN
Chapter 3
Configuration
105
Adding alert selector criteria
toolId != NetCmmnd; severity = Major, Critical; END
In this example, the first BEGIN/END block contains selector criteria to match alerts that have toolType = NetCmmnd and alertType = Alarm. The second BEGIN/END block contains selector criteria to match alerts for which toolId does not equal 10 and the severity = Major or severity = Critical. By default, an OR relationship exists between the two BEGIN/END blocks. An alert that matches the criteria in either of the blocks is sent.
NOTE Because the alertType variable is defined, the toolType variable must also be defined, but not as "!=".
Adding alert selector criteria The process of adding alert selector criteria consists of two procedures: ■
entering the selector criteria by following the guidelines and saving the file as PEMSelector.cfg
■
running the ./iipemInstallDirectoryPath/bin/createSelector.cfg command line interface to validate the criteria and create the alert selector The validation process also involves restarting the path.
To enter the selector criteria If you are an experienced user, you can choose to enter your selector criteria directly into the ./iipemInstallDirectoryPath/instanceName/conf/PEMSelector.cfg file. Otherwise, BMC Software recommends that you do one of the following:
106
■
Copy the content of the ./iipemInstallDirectoryPath/instanceName/conf/PEMSelector.cfg.example file to the PEMSelector.cfg and then begin inserting your edits. Go to step 1.
■
Enter your edits in the PEMSelector.cfg.example file but do a save-as under the file name of PEMSelector.cfg and overwrite the existing one. Go to step 1.
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Adding alert selector criteria
NOTE If you choose not to enter selector criteria, then by default all PATROL EM alerts are forwarded to the BMC IM instance.
1 Open the PEMSelector.cfg or PEMSelector.cfg.example file in a text editor. 2 Enter the selector criteria in the BEGIN/END statements, following the guidelines described in this section.
3 Save the file as PEMSelector.cfg. WARNING Do not overwrite the PEMSelector.cfg.example file.
4 Go to “To create the alert selector” on page 107. To create the alert selector After you add selector criteria to and save the PEMSelector.cfg file, you must run the CLI command ./iipemInstallDirectoryPath/bin/createSelector to validate your PATROL EM information and create the file ./iipemInstallDirectoryPath/conf/extended/eCafe.xml.
1 Run the stopPath command to stop the integration component. stopPath -n serviceName (for example: stopPath -n iipatrolem)
2 Run the CLI command ./iipemInstallDirectoryPath/bin/createSelector .
In validating the selector criteria, the createSelector script parses the PEMSelector.cfg file and sends the output to the terminal. The output of a
successful validation would look similar to the example in the following figure: % cd /usr/nc/Solutions/iipem % bin/createSelector iipatrolem logConfig:[iipatrolem/conf/extended/Log.cfg] Parsing file: iipatrolem/conf/PEMSelector.cfg The following file has been parsed successfully: iipatrolem/conf/PEMSelector.cfg Connecting to PATROL EM for verification… EHD Host Name: zanzibar AGD Host Name: zanzibar
Chapter 3
Configuration
107
Adding alert selector criteria
PATROL EM verification succeeded!
If the createSelector script discovers an error in the PEMSelector.cfg file, it generates an error message, as shown in the following figure: % cat iipatrolem/conf/PEMSelector.cfg BEGIN toolType != ImpactIntegration; END BEGIN toolType = NetCmmnd; alertType = NoSuchAlert; END % bin/createSelector iipatrolem logConfig:[iipatrolem/conf/extended/Log.cfg] Parsing file: iipatrolem/conf/PEMSelector.cfg The following file has been parsed successfully: iipatrolem/conf/PEMSelector.cfg Connecting to PATROL EM for verification… EHD Host Name: zanzibar AGD Host Name: zanzibar PATROL EM verification failed due to the following errors: 1 issue ERROR: Selection criteria failed validation: Invalid alertType (NoSuchAlert) for toolType NetCmmnd
If an error is found in the PEMSelector.cfg file, you will have to correct it and rerun the ./iipemInstallDirectoryPath/bin/createSelector command before continuing to step 3.
3 Use the startPath command to restart the integration component. startPath -n serviceName (for example: startPath -n iipatrolem)
108
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
How to associate PATROL EM alerts with service model components
How to associate PATROL EM alerts with service model components The service model is depicted as a graphical map of an IT infrastructure. The service model references ■
■ ■ ■
data classes in the BMC Atrium Configuration Management Database that represent the physical and logical resources in an enterprise event classes associated with specific resources corresponding data classes in the SIM KB of 5.x cells propagation rules that govern the objects and their relationships
The graphical map consists of icons that represent components. A component refers to an object that has a class definition in the BMC Atrium Configuration Management Database and a corresponding class definition in the SIM KB of the target cell(s).
Aliases and component IDs An alias is a unique and descriptive string that can match an event with a particular component ID. The token values of a PATROL EM alert map to the mc_smc_alias slot of the BMC IM event. You associate PATROL EM alerts (or for that matter an event from any application) with service model components through the alias feature. You match a PATROL EM alert to a particular component ID through the alias that is associated with the component. You associate aliases with service components through the BMC Impact Service Model Editor. (The Service Model Editor also allows to you create alias computing formulas and associate them with specified event classes.) For each alias that you use in the Service Model Editor, you must enter a corresponding alias in the ./iipemInstallDirectoryPath/instanceName/conf/McSmcMapping.cfg file that you create.
NOTE The ./iipemInstallDirectoryPath/instanceName/conf/McSmcMapping.cfg.example file shipped with BMC II for PATROL EM contains example code of a mapping between PATROL EM alert token values and the mc_smc_alias slot of a BMC IM event. Keep it as a reference copy.
Chapter 3
Configuration
109
Default alias mapping
Default alias mapping If you choose not to specify any mapping between token values and the mc_smc_alias slot, then an McSmcMapping.cfg file is not created, and the default value of the mc_smc_alias slot is used. The default value of the mc_smc_alias slot is [domainClass].[domain]:[objectClass].[object] where each bracketed entry [domainClass], [domain], [objectClass], and [object] represents a CEF token. For example, a CEF alert with the following token values ■ ■ ■ ■
domainClass="SOLARIS" domain="sloop" objectClass="PDS_Test" object="DataStoreTest-001"
would produce, by default, an mc_smc_alias slot with the following values: SOLARIS.sloop:PDS_Test.DataStoreTest-001
If the CEF tokens do not contain values or if a non-CEF alert is referenced, then the mc_smc_alias slot is empty. See “Other mapping criteria examples” on page 115 for other examples that show how the mc_smc_alias slot is populated.
Service model component mapping criteria When you map a PATROL EM alert to a service model component, you must specify values for the following variables: ■ ■ ■
toolType alertType mapValue
Service model component mapping syntax The default mapping syntax in the McSmcMapping.cfg file for mapping PATROL EM token values to the mc_smc_alias slot is shown in the following figure:
110
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Service model component mapping criteria
BEGIN toolType = ; [alertType = [ , ] ; ]] mapValue = ; END [ BEGIN ... END ] ...
The mapping of an alert to a component is defined within BEGIN and END statements. You can add multiple BEGIN/END blocks to the McSmcMapping.cfg file, with each block containing a different association of alert and component.
Service model component mapping variables Table 10 on page 3-111 describes the mapping variables and their values: Table 10
McSmcMapping.cfg variables
Variable
Description
toolType
a string that describes the filter path
alertType
a string that specifies the PATROL EM alert to be associated with the service model component. You can specify multiple alert types.
mapValue
a value that specifies how the mc_smc_id or mc_smc_alias is composed with PEM tokens. For each PEM token, the token name must be surrounded brackets [ ]. The value should use at least one PEM token.
Service model component mapping rules ■
Every block starts with BEGIN and ends with END. You can use one or more BEGIN/END blocks within the McSmcMapping.cfg file.
■
You can use three variables in a single BEGIN/END block: toolType, alertType, and mapValue. You must define tooltype and alias. alertType is optional.
■
BEGIN, END, toolType, alertType and mapValue are reserved words and are case sensitive.
■
Each variable has the following format: "variable = value;" where value is case sensitive.
■
You can specify only one value each for the toolType and mapValue variables. Chapter 3
Configuration
111
Mapping PATROL EM alerts with component IDs
■
You can specify multiple values for alertType as long as the values are separated by comma. A comma specifies an OR relationship among values. In this case, the alias would link the component ID to a specific alert type.
■
There is an implied AND relationship between toolType and alertType.
■
For mapValue, the value specifies how the mc_smc_alias is mapped to PATROL EM tokens. For each PATROL EM token, the token name must be surrounded by opened and closed brackets. The alias value should use at least one PATROL EM token.
■
When a token is presented in the right side of mapValue, [token_name] means that the value of the token is inserted in the variable at run time. For example, BMC_[Origin] means that the value of token Origin is inserted after BMC_. So, if the value of Origin is test, then the mapValue is set equal to BMC_test. If the value of Origin is austin, then the mapValue is set equal to BMC_austin.
■
Use double quotes to use a reserved word as a value. For example, if you have a toolType named toolType, you would specify it in this way: toolType = "toolType"
■
If you want to use a literal double quote, you must put a backslash in front of each double quote. For example, if you have a toolType named "test", where double quotes are part of the toolType name, you specify it as follows: toolType = \"test\"
■
You can define one or multiple rules within McSmcMapping.cfg.
Mapping PATROL EM alerts with component IDs The process of mapping alerts with component IDs consists of three procedures: ■
entering the service model component mapping criteria by following the guidelines and saving the file as McSmcMapping.cfg
■
running the ./iipemInstallDirectoryPath/bin/checkFormatMcSmcMap command line interface to validate the mapping criteria The validation procedure also involves restarting the path.
■
112
assigning the alias to the service model component in the Service Model Editor
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Mapping PATROL EM alerts with component IDs
To enter the service model component mapping criteria NOTE If you choose not to enter mapping criteria, then the mc_smc_alias slot of the event is filled with the default token name values. See also “Default alias mapping” on page 110.
1 Create a text file named McSmcMapping.cfg in the /iipemInstallDirectoryPath/instanceName/conf path.
2 In the open file, enter your mapping specifications within the BEGIN/END statements, following the guidelines. The following figure contains an example: BEGIN toolType = NetCmmnd; alertType = AutoStartOK; mapValue = BMC_[service]_[ws2]; END # with the following values: # service = ‘iipatrolem’ # ws2 = ‘kappa’
In this example you have added a mapValue using the tokens [service] and [ws2], where [service] is ‘iipatrolem’ and [ws2] is ‘kappa’. This mapValue is associated with the alertType AutoStartOK and the toolType NetCmmnd.
3 Save the file as McSmcMapping.cfg, and close it. 4 Go to “To validate the mapping criteria” on page 113. To validate the mapping criteria 1 Run the stopPath command to stop the integration component. stopPath -n serviceName (for example: stopPath -n iipatrolem)
2 Run the CLI command /iipemInstallDirectory/bin/checkFormatMcSmcMap to validate your mapping criteria.
In validating the selector criteria, the checkFormatMcSmcMap script parses the McSmcMapping.cfg file and sends the output to the terminal. The output of a successful validation would look similar to the example in the following figure: % cd /usr/nc/Solutions/iipem % bin/checkFormatMcSmcMap SIMpath logConfig:[iipatrolem/conf/extended/Log.cfg]
Chapter 3
Configuration
113
Mapping PATROL EM alerts with component IDs
Parsing file: iipatrolem/conf/McSmcMapping.cfg The following file has been parsed successfully: iipatrolem/conf/McSmcMapping.cfg
If the checkFormatMcSmcMap script discovers an error in the McSmcMapping.cfg file, it generates an error message, as in the example in the following figure: % cat iipatrolem/conf/McSmcMapping.cfg BEGIN tool = NetConnection; mapValue = [ws2]; END BEGIN toolType = NetConnection; alertType = Failure, Down mapValue = [service]%[ws2]; END % bin/checkFormatMcSmcMap iipatrolem logConfig:[iipatrolem/conf/extended/Log.cfg] Parsing file: iipatrolem/conf/McSmcMapping.cfg The following file could not be parsed successfully: SIMpath/conf/McSmcMapping.cfg 2 issues ERROR: Line 2, column 3: For "BEGIN" from line 1, Found: "tool" Expected: one of "END", "toolType", "alertType", "mapValue". ERROR: Line 9, column 3: For "alertType" from line 8, Found: "mapValue" Expected: one of ";", ",". If an error is found in the McSmcMapping.cfg file, you will have to correct it and rerun the /iipemInstallDirectory/bin/checkFormatMcSmcMap command before continuing to step 3.
3 Use the startPath command to restart the integration component. startPath -n serviceName (for example: startPath -n iipatrolem)
4 Assign the newly created mapValue to the service model component in the Service Model Editor. See “To assign the mapValue in the Service Model Editor” on page 115.
114
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Other mapping criteria examples
To assign the mapValue in the Service Model Editor The mapValue that you assign in the Service Model Editor is the same as the mapValue that you have manually defined in the McSmcMapping.cfg file. The mapValue is used to match the component ID of an event coming from BMC II for PATROL EM (or from any application). Taking the mapValue and component ID that you have associated, the Service Model Editor creates a data instance in the BMC_SIM_ALIAS data class. For example, if the following mapping is defined in the McSmcMapping.cfg file: BEGIN toolType = NetCmmnd; alertType = AutoStartOK; mapValue = BMC_[service]_[ws2]; END # with the following values: # service = ‘iipatrolem’ # ws2 = ‘kappa’
then the corresponding data instance is created in the BMC_SIM_ALIAS data class: BMC_SIM_ALIAS; ComponentAlias=’BMC_iipatrolem_kappa’; ComponentID=’component123’; END
The component ID ‘component123’ is associated with the PATROL EM alert AutoStartOK.
Other mapping criteria examples This section briefly describes other mapping criteria examples to illustrate some of the different ways of specifying aliases and event associations in the McSmcMapping.cfg file.
Basic mapping Begin toolType = NetConnection; alertType = Alarm; mapValue = host_[originKey]_[origin]; End
Chapter 3
Configuration
115
Other mapping criteria examples
In this example, if the PATROL EM alert has a toolType = NetConnection and an alertType = Alarm, then the value of the mc_smc_alias slot is host_valueOf OriginKey_valueOfOrigin. So if the value of the token originKey is 10 and the value of the token origin is promethius, then the value of the mc_smc_alias slot is host_10_promethius.
Multiple values for an alertType Begin toolType = TestToolType; alertType = Alarm, NoAlarm; mapValue = [ws2]%[service]; End
This example shows how to specify more than one value for the alertType. In this example, the mc_smc_alias will be mapped if toolType = TestToolType AND alertype = Alarm OR NoAlarm. If, for example, the value of token ws2 is Oracle and value of the token service is DB, then the value of mc_smc_alias is Oracle%DB.
Reserved words Begin toolType = “toolType”; alertType = Alarm; mapValue = BMC_[originKey]_[origin]; End
You must put double quotes around the value of toolType: toolType = "toolType".
Literal double quotes Begin toolType = \”test\”; alertType = Alarm; mapValue = \”[originKey]\”_[origin]; End
If a toolType is named "test", where double quotes are part of the name, and you enter toolType = "test", the parser considers the name as test, without the quotation marks. The backslash tells the parser to treat the double quotes as part of the name: toolType = \"test\".
116
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Other mapping criteria examples
The example uses backslashes to escape the double quotes used in the mapValue definition. If the value for originKey = 10, and the value for origin = promethius, then the mapValue = "10"_promethius.
Chapter 3
Configuration
117
Other mapping criteria examples
118
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Chapter
4
4
Using the Integration This chapter describes how to use the integration component. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . How to launch BMC II for PATROL EM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Starting the BMC II for PATROL EM service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Verifying that the BMC IM instance (cell) is connected to PATROL EM . . . . . . Checking the log file for connection problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . Validating that BMC II for PATROL EM is running . . . . . . . . . . . . . . . . . . . . . . . Launching a BMC IX service view from PATROL Central Alerts . . . . . . . . . . . . Validating that BMC IM events are forwarded. . . . . . . . . . . . . . . . . . . . . . . . . . . . How to regenerate BAROC files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Troubleshooting tips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Cell encryption not set error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Incorrect NetCmmnd Sybase password specified during installation . . . . . . . . Incorrect Sybase System Administrator password specified during installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Recovering after a connection failure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Continually disrupted connectivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Severe errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Enabling IIPEM Debugging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Failure of events to close in Impact Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 4 Using the Integration
120 120 120 121 122 123 123 125 126 127 127 128 129 130 131 131 131 134
119
Overview
Overview This chapter discusses basic usage scenarios: ■ ■ ■
launching the integration component and validating connectivity launching BMC IX service views from PATROL Central Alerts AAD regenerating .baroc class files if you add or change a filter path
This chapter also contains troubleshooting information.
How to launch BMC II for PATROL EM This section describes tasks related to launching the BMC II for PATROL EM. These include ■ ■ ■ ■
starting and stopping the BMC II for PATROL EM service verifying that the BMC IM instance (cell) is connected to PATROL EM checking the log file iipatrolem for connection problems verifying that BMC II for PATROL EM is running
Starting the BMC II for PATROL EM service Use the startPath and stopPath commands to start and stop BMC II for PATROL EM service.
Before you begin You must be logged on as NetCmmnd.
To Start BMC II for PATROL EM To start BMC II for PATROL EM, enter the startPath command from a Unix prompt. startPath -n serviceName
The default serviceName is iipatrolem: for example startPath -n iipatrolem
120
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Verifying that the BMC IM instance (cell) is connected to PATROL EM
WARNING After you install BMC II for PATROL EM, the PATROL EM Filter Path Management UI displays ImpactIntegration in the Inactive Filter Paths column. This is correct. Do not attempt to start the ImpactIntegration filter path.
The filter path is populated directly by BMC II for PATROL EM. It does not require startup.
To Stop BMC II for PATROL EM You need to stop and restart the service whenever you make a change to one of the configuration files. To stop BMC II for PATROL EM, enter the stopPath command from a Unix prompt: stopPath -n serviceName (for example: stopPath -n iipatrolem)
Verifying that the BMC IM instance (cell) is connected to PATROL EM Follow these steps to verify that the cell is connected to PATROL EM.
1 Log in as NetCmmnd. 2 On the system where the PATROL EM console is installed, launch the PATROL EM AAD by entering the st command at the Unix prompt.
3 Open the AAD display window. 4 Launch (or restart) the BMC II for PATROL EM service: startPath serviceName. In the AAD display window, you should see three alerts within 60 seconds, similar to the example in the following figure. Path NetCmmnd ImpactIntegration ImpactIntegration
AlertType AutoStartOK ConnectionRestored DataSynchronized
Severity CLEAR CLEAR Informational
The AutoStartOK alert type generates a corresponding message on the BMC IM cell: Auto Start Path serviceName started on hostName
Chapter 4 Using the Integration
121
Checking the log file for connection problems
serviceName is the name assigned to the BMC II for PATROL EM service; hostName is the system on which the BMC II for PATROL EM component is installed. The AutoStartOK alert closes on the AAD after 30 seconds. The DataSynchronized alert on the AAD indicates that the connection is established. Its message text reads: Impact Integration hostName has synchronized PATROL Enterprise Manager data with Cell cellName
hostName is the system on which the integration component is installed.
NOTE The filter path connection is not installed with Autostart enabled. To enable Autostart, do the following: 1. From the P EM Desktop Menu, choose Customization=>Path Definition=>Get from DB…=>select your path (instance name). 2. Click OK. 3. In the Available Attributes box, choose Autostart. 4. In the Available Details box, click Autostart. 5. Click Add/Replace. The Defined Attributes box displays, “Autostart: true.” 6. Choose Path=>Save to DB. 7. At the Update Configuration NOW? prompt, click yes. 8. Choose Path=>Exit.
Checking the log file for connection problems You can open the ./iipemInstallDirectoryPath/instanceName/log/iipatrolem.log file to check for any connection problems. Enter the tail command to write the log file to standard output: tail -f /iipemInstallDirectoryPath/instanceName/log/iipatrolem.log
122
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Validating that BMC II for PATROL EM is running
Validating that BMC II for PATROL EM is running To validate that BMC II for PATROL EM is running, use the resUsage command to display a report of active paths for the PATROL EM system.
Before you begin You must be logged on as NetCmmnd.
To Validate that BMC II for PATROL EM is Running Type the following command: resUsage If BMC II for PATROL EM is running, the connection component’s name is displayed in the service column.
Launching a BMC IX service view from PATROL Central Alerts If a selected alert is coming from a BMC Impact Manager through the BMC II for PATROL EM integration, you can launch the corresponding BMC Impact Explorer (IX) service view using the PATROL Central Alerts Active Alerts Display (AAD).
NOTE If BMC IX is not currently running when you try to view the console from PATROL Central Alerts AAD, BMC IX will prompt you for a Username and Password for an existing account on the BMC Portal.
Before you begin 1 Verify that .econsole directory is installed in the home directory of the user who is logged on to the PATROL Central Alerts client computer. The .econsole directory is installed in a user's home directory as part of the BMC IX installation process. For example, if BMC IX is installed under user Alpha, then .econsole is installed in Alpha’s home directory. But when user Beta logs into this computer, Beta's home directory does not have the .econsole directory. Beta has to copy the .econsole directory from user Alpha's home to the Beta home directory before Beta can use this cross-launching feature.
2 Verify that JRE 1.3.1_04 is the default JRE for Microsoft Internet Explorer. To do this, choose Internet Explorer => Tools => Internet Options => Advanced to display the Advanced tab as shown in the following graphic.
Chapter 4 Using the Integration
123
Launching a BMC IX service view from PATROL Central Alerts
Figure 7
Default JRE for Microsoft Internet Explorer
If no JRE 1.3.1_04 is installed in the PATROL Central Alerts client machine, then JRE 1.3.1_04 is installed automatically when you use PATROL Central Alerts for the first time. The installed JRE becomes the plug-in for the Internet Explorer browser and you can launch from PATROL Central Alerts.
WARNING If you install a newer version of JRE after installing the PATROL Central Alerts client, then newer version becomes the plug-in for the Internet Explorer browser. If a new version becomes the plug-in and the PATROL Central Alerts does not work correctly, then you must use the JRE 1.3.1_04 plug-in control panel to reset the original JRE as the default JRE for the browser. See Figure 8 on page 125.
124
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Validating that BMC IM events are forwarded
Figure 8
Java Plug-in Control Panel
To Launch a BMC IX Service View from PATROL Central Alerts AAD 1 Right-click on an alert from BMC IM in the PATROL Central Alerts AAD. NOTE Alerts displayed in PATROL Central Alerts AAD do not contain the mc_smc_alias or cell_name slot. Instead, the mc_smc_alias slot corresponds to the object field, and the cell_name slot corresponds to the origin field. If the origin or object field of the alert is null, then the cross-launching to BMC IX is unavailable.
2 Choose one of the following views from the pop-up menu. ■
Service View => Impact View to see an impact view.
or ■
Service View => Cause View to see a cause view.
3 A BMC IX service view is displayed.
Validating that BMC IM events are forwarded Use the following procedure to validate that BMC IM events are being properly forwarded to PATROL EM.
Chapter 4 Using the Integration
125
How to regenerate BAROC files
Before you begin You must be logged on as NetCmmnd.
To Validate That BMC IM Events Are Forwarded 1 View the PATROL Central Alerts AAD or PEM Desktop AAD. 2 Verify that BMC IX Events are being forwarded to P EM by checking the alerts's originKey token. The originKey token contains the Event's ID (mc_ueid).
3 Check the originKey token from the AAD display. 4 Choose the alert and left-click Action=>About. 5 Look for originKey in the Stored Tokens box of the About Window.
How to regenerate BAROC files This procedure describes how to regenerate .baroc files if you have changed or added the filter and filter path after you have installed BMC II for PATROL EM. The BAROC class generator creates .baroc files automatically during installation. The files contain MC event classes that the integration component uses to forward PATROL EM alerts to the BMC IM cell as instances of MC event classes for non-CEF tool types. After installation, if you change a filter, you must manually invoke the BAROC class generator (runEventClassFactory) using the command line to regenerate the .baroc files. After the .baroc files are generated, you must add them to the cell knowledge base before using the filter path.
Before you begin You must be logged on as NetCmmnd. For this procedure, assume that the BMC II for PATROL EM installation path is /usr/nc/Solutions/ImpactIntegration.
126
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Troubleshooting tips
To Regenerate BAROC Files 1 Enter the following commands: $ cd /usr/nc/Solutions/ImpactIntegration/bin $ runEventClassFactory
The BAROC class generator produces the same type of information you see during the installation. Generating baroc files... ToolType CefTest - CEF compliant. CefTest alerts will be forwarded to the cell as PEM_EV events. ToolType NetCmmnd - Not CEF compliant. NetCmmnd alerts will be forwarded to the cell as PEM_NetCmmnd events. - Generating PEM_NetCmmnd.baroc in files/kb/classes - Creating event classes for the 66 alert types in NetCmmnd **************************************************************
2 After the .baroc class files are generated, you must load them into the cell in the same way you did during installation. See “How to enable the BMC IM connection” on page 66.
Troubleshooting tips This section describes known troubleshooting issues for BMC II for PATROL EM.
Cell encryption not set error This error can occur when the connection between BMC II for PATROL EM and the cell fails. The error message in the iipatrolem.log on BMC II for PATROL EM reports that the cell is not set up for encryption as follows: Connection to payroll_sim - chrissy:1828 failed.com.bmc.cellcomm.exception.CellConnectionException: Cell payroll_sim is not in encrypted mode.
Chapter 4 Using the Integration
127
Incorrect NetCmmnd Sybase password specified during installation
The error message is incorrect. The encryption is not enabled in the ImpactIntegration.cfg file.
NOTE Do not use an encryption key with an odd number of characters. If the length of the encryption key is odd, the cell will ignore the last character of the encryption key.
Incorrect NetCmmnd Sybase password specified during installation If you enter the NetCmmnd Sybase password incorrectly during installation, a message similar to the one in the following figure is displayed. Msg 4002, Level 14, State 1: Server 'SYBASE', Line 1: Login failed. CT-LIBRARY error: ct_connect(): protocol specific layer: external error: The attempt to connect to the server failed. . . . . . . Connecting to PATROL EM for verification... EHD Host Name: toro AGC Host Name: toro 2005-08-07 01:18:49,244: [main] ERROR com.bmc.pem.cafe - Error connecting to jdbc:sybase:Tds:toro:2043 - java.sql.SQLException: JZ00L: Login failed. Examine the SQLWarnings chained to this exception for the reason(s). PATROL EM verification failed due to following errors: 1 issue ERROR: A connection to the AGC could not be established. com.bmc.pem.cafe.JIPEMConnectionException: Could not connect to server: jdbc:sybase:Tds:toro:2043:java.sql.SQLException: JZ00L: Login failed. Examine the SQLWarnings chained to this exception for the reason(s). Error: java.lang.Exception: eCafe configuration file /usr/nc/Solutions/wrongNCpwd/conf/extended/eCafe.xml does not exist !! Error: Script '${tInstDir}/prepSMS.sh $TARGETDIR $JavaDir $PEMservice $EHDhost $AGChost $NCpasswd $OSport' Returned code: 1 !!
128
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Incorrect Sybase System Administrator password specified during installation
NOTE If you enter an incorrect NetCmmnd Sybase password, the BMC II for PATROL EM installation will fail. You must uninstall and then reinstall BMC II for PATROL EM.
Incorrect Sybase System Administrator password specified during installation If you enter the Sybase System Administrator password incorrectly during installation, a message similar to the one in the following figure is displayed. Data Server Error - Severity 14, Number 4002 State 1, Line 0, Server SYBASE: Login failed. Incorrect Sybase user name/password pair.
The BMC_BSM user, required for proper communication with PATROL EM, is not created. You have to manually create the BMC_BSM user.
Creating the BMC_BSM user Before you begin, you should have the correct Sybase system administrator password available.
1 From the PATROL EM console, choose Admin => User Mgmt to open the User Management window.
2 Choose one of the following actions: ■
If the PATROL EM supervisor user BMC_BSM does not exist, create the user role.
■
If the PATROL EM supervisor user BMC_BSM exists, but its associated PATROL EM user type is not supervisors, then delete the BMC_BSM user and recreate it. Your selections and entries in the User Management window should look similar to those in Figure 9 on page 130:
Chapter 4 Using the Integration
129
Recovering after a connection failure
Figure 9
User Management window (PATROL EM 4.3.01)
NOTE You can access the online Help to review the user management procedures.
3 After you have created the BMC_BSM user, restart the BMC II for PATROL EM service.
4 Restart the BMC Impact Manager cell.
Recovering after a connection failure BMC II for PATROL EM has a heartbeat feature. If BMC II for PATROL EM and BMC IM lose their connection, the following alert is displayed on PATROL EM. toolType=ImpactIntegration, alertType=ConnectionLost, sev=Major, Text="'Connection Lost: Impact Integration to cell '"
BMC II for PATROL EM automatically attempts to restore communications with the cell. If the attempt is successful, the ConnectionLost alert is closed and the following alert is displayed. toolType=ImpactIntegration, alertType=ConnectionRestored, sev=Clear, Text="'Connection Restored: Impact Integration to cell '"
130
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Continually disrupted connectivity
If BMC II for PATROL EM and PATROL EM lose their connection, a BMC IM PEM_EV event is created on the cell with the pem_filter slot=ImpactIntegration and pem_alert_type=ConnectionLost. BMC II for PATROL EM automatically attempts to restore communications with PATROL EM. When the PATROL EM connection is restored, the BMC IM PEM_EV ConnectionLost event is closed, but no new event is created.
NOTE Any time that BMC II for PATROL EM loses communications, it attempts to restore communications using the ImpactIntegration.cfg property NumSecsToTryReconnect (default=300). If the integration component is unable to restore communications in this time frame, the component stops running and is automatically restarted by RMD.
Continually disrupted connectivity If RMD restarts BMC II for PATROL EM and the ConnectionLost or cell event reappears, check your IP connectivity.
Severe errors Severe errors are recorded in the log file iipatrolem.log, which is located under the directory where you installed BMC II for PATROL EM, for example, ./iipemInstallDirectoryPath/instanceName/log/iipatrolem.log. Customer Support representatives use the information in the log to help determine the source of the error.
Enabling IIPEM Debugging To assist in debugging the integration component, additional logging is available to provide more detailed logging when needed.
WARNING If logging debug parameters are set to true, or if a logging level other than INFO is specified, the log files could become very large and fill up the file system.
Chapter 4 Using the Integration
131
Enabling IIPEM Debugging
Debugging the Integration component To debug the integration component, perform the following steps:
1 In the Log.cfg file, for the INFO value, enter a logging level that produces more detailed results. The default levels for the packaged code follows: # Default level for the packaged code. log4j.logger.com.bc=INFO#com.bmc.sms.util.LogPriority log4j.logger.com.itmasters=INFO#com.bmc.sms.util.LogPriority
For more information about logging levels, see the Log.cfg file.
Debugging filter path connectivity If you are using the filter path option, perform the following steps to debug the filter path:
1 In the iipemTransformer.cfg file, set the DEBUG flag to true. 2 In the ImpactIntegration.cfg file, set the PEMLogCEF parameter to true. When you set the PEMLogCEF parameter to true, you are able to trace the filter path message traffic.
Debugging message traffic between the integration component and PATROL EM 1 Change directory to /usr/nc/Solutions/iipem/instanceName/conf/extended. 2 Save a copy of eCafe.xml file. 3 Add the following line after the entry : ./log/iipatrolem_eCafe.log
as in the following context: ./log/iipatrolem_eCafe.log
132
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Enabling IIPEM Debugging
4 Add the following lines after the entry . ActorControl PassiveProviderConnector http://:24006
5 Save the file. 6 Stop and restart IM. 7 Stop and restart BMC II for PATROL EM service. 8 Turn on the eCafe debugging: A Log on as NetCmmnd user B Issue the telnet command to connect to the PATROL EM machine as below: NetCmmnd% telnet pemMachineName 24006
The following message is displayed: Trying 10.180.61.73… Connected to pemMachineName. Escape character is '^]'.
C Enter the following command. debug on
The following messages is displayed: Debugging turned on
9 To turn off the eCafe debugging, enter the following command: debug off
Chapter 4 Using the Integration
133
Failure of events to close in Impact Manager
The iipatrolem_eCafe.log is created in the ./iipemInstallDirectoryPath/instanceName/log directory.
WARNING Remember to turn off the eCafe debug, stop the integration component, and reverse the changes in the eCafe.log file after you are done.
Failure of events to close in Impact Manager Occasionally, alerts are closed in PEM, but not in Impact Manager. If an acknowledgement is not received within the specified time, the event synchronization will not function correctly. If the lock level is set to Fine, a message similar to the following appears in the iipatrolem.log file.
EXAMPLE 2005-10-05 16:15:40,188: [Thread-2_PEMToMCellAdapter] FINE com.bmc.sms.mpig.adapter.PEMToMCellAdapter - No acknowledgement message received for
If this problem occurs, increase the timeout interval. For more information about increasing the wait-time, see “Configuring time-out interval” on page 91.
134
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Appendix
A
A
Connection Mappings This appendix covers the internal, noneditable event connection mappings between BMC Impact Manager and PATROL Enterprise Manager. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Common event format tokens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Alert mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Mappings for CEF and non-CEF alerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Mappings for CEF alerts only . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Mappings for Non-CEF alerts only. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Example mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Data consistency mapping tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Appendix A Connection Mappings
136 136 137 137 138 139 139 141
135
Overview
Overview This appendix contains the mapping tables that show how tokens are used in PATROL EM alerts. The tables show how BMC II for PATROL EM maps PATROL EM alerts to BMC IM events. You cannot edit these maps.
Common event format tokens Table 11 lists and briefly describes the common event format (CEF) tokens that can be used in a PATROL EM alert that is CEF-compliant. A single alert can contain a maximum of 10 tokens. Table 11
Tokens used in CEF-compliant PATROL EM alerts (part 1 of 2)
Token Name
Description
cefVersion
the version of CEF being followed
eventType
the action the event triggers, for example, create alert or close alert
originDateTime
local date and time where the event occurred
originClass
the class of the mid-level manager or agent where the event occurred, for example, NNM or PATROL
origin
the component or process that is responsible for issuing the event
originKey
a unique identification of the event or alert within the origin token
originEventClass
event class as known by the origin token
originSeverity
the severity assigned at the origin. A numeric value 0 (Clear) 1 (Informational) 2 (Warning) 3 (Minor) 4 (Major) 5 (Critical)
domainClass
the class (platform type, network type) to which a domain belongs, for example, OS390 or TCPIP
domain
the residence of the managed object
objectClass
the class to which the managed object belongs
object
the affected component for which the event is generated
objectLocation
physical location of the managed object
objectStaff
staff responsible for the managed object
itMgmtLayer
technology layer to which the managed object belongs, for example, NETWORK or DATABASES
service
business services or applications served by this object
customer
customers impacted or potentially impacted by this event
136
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Alert mapping
Table 11
Tokens used in CEF-compliant PATROL EM alerts (part 2 of 2)
Token Name
Description
itMgmtProcess
the IT management discipline to which the event belongs. One of: CONFIGURATION AVAILABILITY CAPACITY SECURITY STORAGE SCHEDULING OUTPUT
itMgmtProcessState
state of the ITMgmtProcess of a managed object. Value is dependent on the ITMgmtProcess. For example, if ITMgmtProcess = "SECURITY", this token would have one of the following values: "SECURE" "UNSECURE" "VIOLATION"
parameterName
the parameter that triggered a state change of the object
parameterValue
the value of the parameter that triggered a state change of the object
freeText
free form text field to further describe the condition being reported, or to provide additional information
parameter
an alternative, legacy name for parameterName
Alert mapping This section contains tables of the mapping schemes that match PATROL EM alerts with BMC IM MCEvent slots.
Mappings for CEF and non-CEF alerts The integration component receives PATROL EM alert events and forwards them to one of the following: ■
slots of the BMC IM MCEvent class as originally defined by the BAROC class generator for a non-CEF tool type. The common mappings are shown in Table 12.
Table 12
Common mappings for CEF and non-CEF alerts - MCEvent slots (part 1 of 2)
PATROL EM alert data
BMC IM MCEVENT slot
Event time
mc_incident_time
State
status = "OPEN" Appendix A Connection Mappings
137
Mappings for CEF alerts only
Table 12
Common mappings for CEF and non-CEF alerts - MCEvent slots (part 2 of 2)
PATROL EM alert data
BMC IM MCEVENT slot
Severity
populates the following slots ■ ■
Alert ID
severity mc_tool_sev
populates the following slots ■ ■
mc_tool_key mc_ueid = pem.EHDhostName.alert ID
Display text
msg
Tokens
populates the following slots mc_smc_alias mc_tool_class = "PATROL EM" mc_tool = EHDhostName adapter_host = BMC II for PATROL EM hostName
■
the cell as an instance of a BMC IM PEM_EV event for a CEF tool type
Table 13
Common mappings for CEF and Non-CEF alerts - BMC IM PEM_EV slots
PATROL EM Alert Data
BMC IM PEM_EV Slot
Tool type name
pem_filter
Tool ID name
pem_path
Alert type name
pem_alert_type
OSI Category
pem_category
Priority
pem_priority
Mappings for CEF alerts only Table 14 lists mappings that are available between PATROL EM CEF alert tokens and BMC IM MCEvent slots. Table 14
138
Mappings for CEF alert tokens and BMC IM MCEvent slots (part 1 of 2)
PATROL EM alert tokens
BMC IM MCEvent slot
domain
mc_host
domainClass
mc_host_class
object
mc_object
objectClass
mc_object_class
objectLocation
mc_location
parameter
mc_parameter
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Mappings for Non-CEF alerts only
Table 14
Mappings for CEF alert tokens and BMC IM MCEvent slots (part 2 of 2)
PATROL EM alert tokens
BMC IM MCEvent slot
parameterValue
mc_parameter_value
origin
mc_origin
originClass
mc_origin_class
originKey
mc_origin_key
originSeverity
mc_origin_sev
Table 15 lists the mapping that is available between PATROL EM CEF alert tokens and the MC PEM EV slot. Table 15
Mappings for CEF alert tokens and MC PEM EV slot
PATROL EM alert token
MC PEM EV slot
service
pem_service
NOTE A single PATROL EM alert can contain a maximum of 10 tokens.
Mappings for Non-CEF alerts only Table 16 lists mappings only available to non-CEF alerts. Table 16
Mappings for Non-CEF Alerts
PATROL EM Alert Data
MC PEM__ Slot
tokenName
tokenName pem_t_tokenName Note: pem_t_tokenName is used only if the PATROL EM token name clashes with a reserved slot on the cell. Otherwise, the original PATROL EM token name is retained as the cell event’s slot name.
Example mappings To see an example of how an alert is mapped, consider the alert shown in Table 17. Assume that an integration component running on host nipper.bmc.com receives the following alert event.
Appendix A Connection Mappings
139
Example mappings
Table 17
Example Alert Event Mapping
Category
Example Mapping
EHD host
rcasun.bmc.com
Event ID
1415587
Event Time
2003-04-24 11:25:38.203
Event Type
alert
Alert ID
1415586
Tool Type / Tool Type Name 5 / NetCmmnd Alert Type / Alert Type Name
20 / AutostartFailure
Tool ID / Tool ID Name
6000999 / NetCmmnd
Severity
Major
Token service
MyService
Token ws2
SomeWS
The integration component would subsequently turn the alert into an MC event shown in Table 18. Table 18
Converted event
PEM_NetCmmnd_AutostartFailure; adapter_host='nipper.bmc.com'; mc_incident_time=1051201440; mc_tool=’rcasun.bmc.com’; mc_tool_class=’PATROL_EM’; mc_tool_key=’1415586’ mc_tool_sev=’MAJOR’; mc_ueid='pem.rcasun.1415586'; msg='Auto Start Path MyService failed to start on SomeWS'; pem_alert_type='AutostartFailure'; pem_category='Software'; pem_filter='NetCmmnd'; pem_path='NetCmmnd'; pem_priority=7; service='MyService'; ws2='SomeWS'; severity=MAJOR; END
NOTE The integration component does not attempt to create a BMC IM MCEvent for a Never Active alert.
140
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Data consistency mapping tables
Data consistency mapping tables The following tables indicate how BMC II for PATROL EM maintains data consistency between BMC IM events and PATROL EM alerts. Table 19 shows that a management action on a BMC IM event generates a consistent, reciprocal action on a PATROL EM alert. Table 19
Data Consistency Between Events and Alerts
If a BMC IM event has its
Then BMC II for PATROL EM
status modified from ACK to initiates a Supervisor Deacknowledge operation against the OPEN PATROL EM alert status modified from CLOSED to OPEN
performs no operation
status modified to ACK
initiates a Supervisor Acknowledge operation against the PATROL EM alert
status modified to ASSIGNED
performs no operation
status modified to CLOSED
initiates a Supervisor Close operation against the PATROL EM alert
Priority modified to a different Priority
performs no operation
Table 20 shows that a management action on a PATROL EM alert generates a consistent, reciprocal action on a BMC IM event. Table 20
Data Consistency Between Alerts and Events (part 1 of 2)
If a PATROL EM alert
BMC II for PATROL EM then
has a Supervisor Acknowledge operation performed against it
sets the status of the MC event to ACK and the value of the pem_supervisor slot equal to the PATROL EM supervisor name
has a Supervisor Deacknowledge operation performed against it
sets the status of the MC event to OPEN and the value of the pem_supervisor slot equal to the PATROL EM supervisor name
is closed (Alert Restored, Supervisor Close, Timeout Close, Operator Close)
sets the status of the MC event to CLOSED For a Supervisor Close, BMC II for PATROL EM sets the value of the pem_supervisor slot equal to the PATROL EM supervisor name
Appendix A Connection Mappings
141
Data consistency mapping tables
Table 20
Data Consistency Between Alerts and Events (part 2 of 2)
If a PATROL EM alert
BMC II for PATROL EM then
is assigned (Operator Assign, Supervisor Assign, Operator Accept/Assign)
sets the pem_operator slot of the MC event equal to the PATROL EM operator name For a Supervisor Assign operation, BMC II for PATROL EM sets the value of the pem_supervisor slot equal to the PATROL EM supervisor name.
is de-assigned (Operator Deassign, Supervisor Deassign)
sets the pem_operator slot of the MC event to an empty value For a Supervisor Deassign operation, BMC II for PATROL EM sets the value of the pem_supervisor slot equal to the PATROL EM supervisor name.
142
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Appendix
B
B
Configuration File Reference This appendix contains the text of the configuration files shipped with BMC II for PATROL EM. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ImpactIntegration.cfg file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . IMToCEFMapping.cfg file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . IMtoPEMMapping.cfg file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . McSmcMapping.cfg.example file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PEMSelector.cfg.example file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Appendix B
Configuration File Reference
144 144 148 150 151 154
143
Overview
Overview The integration component installs the following configuration files:
■
DefaultImpactintegration.cfg ImpactIntegration.cfg
■
IMToCEFMapping.cfg
■
IMToPEMMapping.cfg
■
McSmcMapping.cfg.example
■
PEMSelector.cfg
■
PEMSelector.cfg.example
■
Refer to Chapter 3, “Configuration,” for more information about these configuration files.
ImpactIntegration.cfg file This file contains the custom communications information that you entered during installation, information such as jServer and cell parameters, encryption setting, EHD host name and so forth. The BMC II for PATROL EM component reads the values that you enter in the ImpactIntegration.cfg file.
144
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
ImpactIntegration.cfg file
Figure 10
Example ImpactIntegration.cfg file (part 1 of 4)
#============================================================================== # The ImpactIntegration.cfg file is a customized version of the # DefaultImpactIntegration.cfg file. Changes made in the ImpactIntegration.cfg # file override the default values found in the DefaultImpactIntegration.cfg # file. Both files are located in the same directory, conf/. # # Terms used in this documentation: # PEM: PATROL Enterprise Manager # Impact Manager: BMC Impact Manager # Impact Integration: BMC Impact Integration for PATROL Enterprise Manager # MCELL_HOME: Home directory where the Impact Manager is installed # # NOTE: # (01) A Line that contains only whitespace or whose first non-whitespace # character is a "#" or "!" is treated as comment. # (02) If a line ends with "\", then the following line, if it exists, is # treated as a continuation line. # #============================================================================== #---------------------------------------------------------------------------# The Gateway.jserver property specifies the gateway jserver communication # information that is used by Impact Integration for receiving events from # a Impact Manager. # # The Gateway.jserver property specifies # # - the name of the jserver # - the encryption key used by jserver # - the local port number the jserver uses. # # The definition specified on Gateway.jserver property should match the # definition of the same gateway in the MCELL_HOME/etc/mcell.dir file on the # BMC Impact Manager server. # # Value Format: # GatewayName:LocalPort#EncryptionKey # # Example: # Gateway.jserver=jServer:1800#mc #---------------------------------------------------------------------------Gateway.jserver=jServer:3783#mc #---------------------------------------------------------------------------# The ImpactManager property specifies the Impact Manager communication # information that is used by Impact Integration for connecting to the Impact # Manager. # # The ImpactManager property specifies # # - the name of the BMC Impact Manager # - the encryption key used by the BMC Impact Manager # - the remote host name or IP address where the Impact Manager is running # - the port number used by the BMC Impact Manager # # The definition on the ImpactManager property should match the definition of # the same Impact Manager in the MCELL_HOME/etc/mcell.dir file on the BMC # Impact Manager server. # # Value Format: # Name@Host:Port#EncryptionKey # # Example: # ImpactManager=promethius@promethius:port#mc #---------------------------------------------------------------------------ImpactManager=sms-abc-6@sms-abc-6:1828#mc
Appendix B
Configuration File Reference
145
ImpactIntegration.cfg file
Figure 10
Example ImpactIntegration.cfg file (part 2 of 4)
#---------------------------------------------------------------------------# Use the Encryption property to enable or disable the encryption of # communications between Impact Integration and Impact Manager. # # If the "ForceEncryption" property is set to "yes" in the # MCELL_HOME/etc/mcell.conf file on the BMC Impact Manager server, the # Encryption property must be set to "on". Otherwise, the property can be # "on" or "off". # # Value Format: # on | off #---------------------------------------------------------------------------Encryption=on #---------------------------------------------------------------------------# The EHDHostName property specifies the host name where the PEM Event # Handler Daemon (EHD) process is running. #---------------------------------------------------------------------------EHDHostName=aguirre #---------------------------------------------------------------------------# The AGCHostName property specifies the host name where the PEM Avant-Garde # Computing (AGC) process is running. #---------------------------------------------------------------------------AGCHostName=aguirre #---------------------------------------------------------------------------# The PEMUserName property specifies the PEM supervisor name to be used in # operations such as Supervisor Close. # # The default name is BMC_BSM. BMC strongly advises using the default name. #---------------------------------------------------------------------------PEMUserName=BMC_BSM #---------------------------------------------------------------------------# Use the PEMSynchronization property to enable or disable the synchronization # function of Impact Integration. When the synchronization function is # enabled, upon startup, Impact Integration synchronizes the states of the # BMC Impact Manager and PATROL EM by insuring that # # => all BMC IM events previously created by the Impact Integration in response # to a PATROL EM alert are closed if the PATROL EM alert is now closed. # # => all active PATROL EM alerts that meet the Impact Integration's configured # selection criteria are represented as open BMC IM events. # # Value Format: #on | off #---------------------------------------------------------------------------PEMSynchronization=on #---------------------------------------------------------------------------# The NumSecsToTryReconnect property is used when Impact Integration loses its # connection with either PEM or Impact Manager. # # The NumSecsToTryReconnect property specifies the number of seconds that # the Impact Integration should wait before it tries to reconnect to either # PEM or Impact Manager. # # The default value is 300 seconds. #---------------------------------------------------------------------------NumSecsToTryReconnect=300
146
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
ImpactIntegration.cfg file
Figure 10
Example ImpactIntegration.cfg file (part 3 of 4)
#---------------------------------------------------------------------------# The PEMAlert properties map PEM alert severity to Impact Manager event # severity. # # When Impact Integration receives a PEM alert that will be sent to the # Impact Manager, it converts the alert into a Impact Manager event first. # Impact Integration uses the PEM alert severity to determine the severity # for the Impact Manager event. # # If a PEMAlert property is empty, then the PEM alert with that particular # severity is ignored. # # General Format: # PEMAlert_= #---------------------------------------------------------------------------PEMAlert_CLEAR=OK PEMAlert_INFORMATIONAL=INFO PEMAlert_WARNING=WARNING PEMAlert_MINOR=MINOR PEMAlert_MAJOR=MAJOR PEMAlert_CRITICAL=CRITICAL #---------------------------------------------------------------------------# New configuration parameter in IIPEM v3.7.00 #---------------------------------------------------------------------------#---------------------------------------------------------------------------# The PEMFilterDelimiter property is used by Impact Integration in formatting the # CEF210 message sent to PEM when using a filterPath. # # The PEMFilterDelimiter property specifies the delimiter used in the CEF210 message. # # The default value is ' ~%~ ' . #---------------------------------------------------------------------------PEMFilterDelimiter=' ~%~ ' #---------------------------------------------------------------------------# The PEMUseTransformer property is used by Impact Integration in formatting the # CEF210 message sent to PEM when using a filterPath. # # The PEMUseTransformer property specifies whether a leading delimiter is added # to the CEF message. # # The default value is false . #---------------------------------------------------------------------------PEMUseTransformer=false #---------------------------------------------------------------------------# The PEMLogCEF property is used by Impact Integration for specifying additional # logging specifically for tracing filterPath message traffic # # The default value is false . #---------------------------------------------------------------------------PEMLogCEF=false #---------------------------------------------------------------------------# The ImpactManagerWaitTime property is used by Impact Integration to define the # maximum timeout window for an acknowledgement to an Alert from PEM. # # If an acknowledgement is not received within the timeout event synchronization # will not function correctly. # # The default value is 5000 milliseconds . #---------------------------------------------------------------------------ImpactManagerWaitTime=5000
Appendix B
Configuration File Reference
147
IMToCEFMapping.cfg file
Figure 10
Example ImpactIntegration.cfg file (part 4 of 4)
#---------------------------------------------------------------------------# The PEMShowNulls property is used by Impact Integration in formatting the # CEF210 message sent to PEM when using a filterPath. # # The PEMShowNulls property specifies whether undefined tokens are added to the # CEF210 message sent to PEM. # # The default value is false . #---------------------------------------------------------------------------PEMShowNulls=false #---------------------------------------------------------------------------# The PEMLogKeyValue property is used by Impact Integration in logging detailed # key:value pairs of the CEF210 message sent to PEM when using a filterPath. # # The default value is false . #---------------------------------------------------------------------------PEMLogKeyValue=false #---------------------------------------------------------------------------# The IMVersion property is used by Impact Integration in controlling which # Impact Manager slot to use for mapping of PEM token values. #---------------------------------------------------------------------------ImpactManagerVersion=5.1.00 #-----------# END OF FILE #------------
IMToCEFMapping.cfg file This file defines the mapping between BMC IM slots and CEF210 message. Figure 11
Example IMToCEFMapping.cfg file (part 1 of 2)
#-------------------------------------------------------------------# The IMToCEFMapping.cfg file is a configuration file for Impact # Manager to PEM mapping which includes IM slot to PEM token mapping, # and IM event severity to PEM alert severity and alertType mapping. # # File: IMToCEFMapping.cfg # Revision: $Revision$, $Date$ #-------------------------------------------------------------------#-------------------------------------------------------------------# Impact Manager Slot Name Mapping to CEF Token Name. # For filter path option to function correctly, the following # mapping is required and can not be changed: # _origin = # _originClass = # _originKey = mc_ueid # Other slots can be customized as needed. #-------------------------------------------------------------------_domain = mc_host _domainClass = mc_host_class _object = mc_object _objectClass = mc_object_class _objectLocation = mc_location _origin = _originClass = _originKey = mc_ueid _originDateTime = mc_local_reception_time _freeText = msg
148
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
IMToCEFMapping.cfg file
Figure 11
Example IMToCEFMapping.cfg file (part 2 of 2)
_originEventClass _originSeverity _eventType _itMgmtLayer _service _customer _itMgmtProcess _itMgmtProcessState _parameterName _parameterValue
= = = = = = = = = =
CLASS severity 'create_alert' sub_origin mc_service customer mc_it_mgmt_process state mc_parameter mc_parameter_value
#-------------------------------------------------------------------# The SMCState_ and # MCEvent_ properties map the # Impact Manager event severity to the PEM alert severity and PEM # alert type. # # When Impact Integration receives an Impact Manager event, it # converts the event into a PEM alert from tool type that is defined by # the user in the above toolType property before sending it to PEM. # Impact Integration uses the Impact Manager event severity to # determine the equivalent PEM alert severity and PEM alert type. # # The default setting is that if the Impact Manager event is a # SMC_STATE_CHANGE event, the PEM alert type is "SMC_". # This is defined in the SMCState_ # properties. # If the Impact Manager event is other than SMC_STATE_CHANGE event, # the PEM alert type is "EVENT_". This is defined # in the MCEvent_ properties. # # If a MCEvent_ or # SMCState_ property is empty, then the # Impact Manager event with that particular severity is ignored. # # General Format: # SMCState_= # MCEvent_= # #-------------------------------------------------------------------MCEvent_UNKNOWN=EVENT_INFORMATIONAL MCEvent_OK=EVENT_CLEAR MCEvent_INFO=EVENT_INFORMATIONAL MCEvent_WARNING=EVENT_WARNING MCEvent_MINOR=EVENT_MINOR MCEvent_MAJOR=EVENT_MAJOR MCEvent_CRITICAL=EVENT_CRITICAL SMCState_UNKNOWN=SMC_INFORMATIONAL SMCState_OK=SMC_CLEAR SMCState_INFO=SMC_INFORMATIONAL SMCState_WARNING=SMC_WARNING SMCState_MINOR=SMC_MINOR SMCState_MAJOR=SMC_MAJOR SMCState_CRITICAL=SMC_CRITICAL
Appendix B
Configuration File Reference
149
IMtoPEMMapping.cfg file
IMtoPEMMapping.cfg file This file allows the user to change the default mappings between BMC IM event information and PATROL Enterprise Manager alert data. The file contains
Figure 12
■
user-configurable toolID and toolType variables for alerts originating from BMC IM
■
user-configurable BMC IM event severity levels for mapping PATROL EM alert types
Example IMToPEMMapping.cfg file (part 1 of 2)
#-------------------------------------------------------------------# The IMToPEMMapping.cfg file is a configuration file for Impact # Manager to PEM mapping which includes IM slot to PEM token mapping, # IM Event's toolId, toolType in PEM and IM event severity to PEM # alert severity and alertType mapping. # # File: IMToPEMMapping.cfg # Revision: $Revision$, $Date$ #-------------------------------------------------------------------#---------------------------------------------------# Impact Manager Slot Name Mapping to CEF Token Name # is the only allowed non-slotName #---------------------------------------------------mc_host = domain mc_host_class = domainClass mc_smc_id = object mc_smc_type = objectClass mc_location = objectLocation = origin mc_ueid = originKey mc_incident_time = originDateTime mc_parameter_value = parameterValue msg = freeText #-------------------------------------------------------------# tooId(path name) and toolType(filter name) for alerts created # in PEM as a result of events coming from Impact Manager #-------------------------------------------------------------toolId = ImpactIntegration toolType = ImpactIntegration
150
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
McSmcMapping.cfg.example file
Figure 12
Example IMToPEMMapping.cfg file (part 2 of 2)
#-------------------------------------------------------------------# The SMCState_ and # MCEvent_ properties map the # Impact Manager event severity to the PEM alert severity and PEM # alert type. # # When Impact Integration receives an Impact Manager event, it # converts the event into a PEM alert from tool type that is defined by # the user in the above toolType property before sending it to PEM. # Impact Integration uses the Impact Manager event severity to # determine the equivalent PEM alert severity and PEM alert type. # # The default setting is that if the Impact Manager event is a # SMC_STATE_CHANGE event, the PEM alert type is "SMC_". # This is defined in the SMCState_ # properties. # If the Impact Manager event is other than SMC_STATE_CHANGE event, # the PEM alert type is "EVENT_". This is defined # in the MCEvent_ properties. # # If a MCEvent_ or # SMC_ property is empty, then the # Impact Manager event with that particular severity is ignored. # # General Format: # SMCEvent_= # MCEvent_= # #-------------------------------------------------------------------MCEvent_UNKNOWN=EVENT_INFORMATIONAL MCEvent_OK=EVENT_CLEAR MCEvent_INFO=EVENT_INFORMATIONAL MCEvent_WARNING=EVENT_WARNING MCEvent_MINOR=EVENT_MINOR MCEvent_MAJOR=EVENT_MAJOR MCEvent_CRITICAL=EVENT_CRITICAL SMCState_UNKNOWN=SMC_INFORMATIONAL SMCState_OK=SMC_CLEAR SMCState_INFO=SMC_INFORMATIONAL SMCState_WARNING=SMC_WARNING SMCState_MINOR=SMC_MINOR SMCState_MAJOR=SMC_MAJOR SMCState_CRITICAL=SMC_CRITICAL
McSmcMapping.cfg.example file A reference file, it contains example code that you can use as a model to map the token values of a PATROL EM alert to the mc_smc_alias slot of a BMC Impact Manager event. The file that you create is named the McSmcMapping.cfg file. Do not modify the McSmcMapping.cfg.example file.
Appendix B
Configuration File Reference
151
McSmcMapping.cfg.example file
Figure 13
McSmcMapping.cfg.example file (part 1 of 3)
#============================================================================= # McSmcMapping.cfg.example # # Creating Specifications to Map Token Values of a PEM alert to mc_smc_id or # mc_smc_alias slot of an Impact Manager Event. Impact Manager version 5 # and above uses mc_smc_alias slot. # #============================================================================= # This file explains how to create a file that specifies how to map the # token values of a PEM alert into the mc_smc_id or mc_smc_alias slot of an # Impact Manager event. # # This file contains example code to do mapping. The actual mapping file # is typically named McSmcMapping.cfg. You can copy the contents of this # file into a file named McSmcMapping.cfg and then edit from there. # Or you can simply modify this file and rename it to McSmcMapping.cfg. # # If no mapping specification is defined, the default value for mc_smc_id or # mc_smc_alias slot is # # [domainClass].[domain]:[objectClass].[object] # # where [token-name] means the value of the token. If tokens of domainClass, # domain, objectClass, and object don't contain a value, then the mc_smc_id or # mc_smc_alias slot is empty. # # To define how to map PEM alert tokens to mc_smc_id or mc_smc_alias slot, # create a set of specifications within BEGIN and END statements. You can # include more than one set of statements in the file. # # The syntax of the contents of the mapping file is as below: # # BEGIN # toolType = ; # [alertType = [ , ] ; ]] # mapValue = ; # END # # [ # BEGIN # ... # END # ] # # The constraints of the mapping language are simple: # (01) Every block starts with "BEGIN", and ends with "END". # # (02) There can be one or multiple BEGIN/END blocks within the # mapping file. # # (03) In a BEGIN/END block, 3 variables can be used: toolType, alertType, # and mapValue. "toolType" and "mapValue" must be defined while "alertType" # is optional. # # (04) "BEGIN", "END", "toolType", "alertType" and "mapValue" are considered # reserved words and they are case-sensitive. # # (05) Each variable has the format of "variable = value;", where value is # case-sensitive. # # (06) You can only specify one value each for toolType and mapValue. # # (07) You can specify multiple values for alertType, as long as the values # are separated by comma. A comma specifies an OR relationship among # values. # # (08) There is implied AND relationship between toolType and alertType. # # (09) For mapValue, the value specifies how the mc_smc_id or mc_smc_alias is # composed with PEM tokens. For each PEM token, the token name must be # surrounded by opened and closed brackets "[" and "]". The value should # use at least one PEM token. #
152
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
McSmcMapping.cfg.example file
Figure 13
McSmcMapping.cfg.example file (part 2 of 3)
# (10) When a token is presented in the right side of mapValue, "[token_name]" # means that the value of the token is inserted in the variable at run # time. For example, "BMC_[Origin]" means that the value of token Origin # is inserted after "BMC_". So, if the value of Origin is "test", # then the mapValue = BMC_test. If the value of Origin is "austin", # then the mapValue = BMC_austin. # # (11) Double quotes are used if you want to use a reserved word as value. # For example, if you have a toolType named toolType, you would # specify it in this way: toolType = "toolType". # # (12) If you want to use a literal double quote, you must need to put a # backslash in front of each double quote (to escape it). For example, # if you have a toolType named "test", i.e. double quotes are part of # the toolType name, you would specify it in this way: # toolType = \"test\". # #============================================================================= #---------------------------------------------------------------------------# Example 1: Basic Mapping # # In the example below, if the PEM alert has a toolType = NetConnection and # an alertType = Alarm, then the value of mc_smc_id or mc_smc_alias slot is # "BMC__". # # If, for example, the value of token originKey is 10 and the value of token # origin is promethius, then the value of mc_smc_id or mc_smc_alias is # "BMC_10_promethius". #---------------------------------------------------------------------------BEGIN toolType = NetConnection; alertType = Alarm; mapValue = BMC_[originKey]_[origin]; END #---------------------------------------------------------------------------# Example 2: Specifying Multiple Values for an alertType # # The example below shows how to specify more than one value for alertType. In # this example, the mc_smc_id or mc_smc_alias slot will be mapped if # toolType = TestToolType, AND alertype = Alarm OR NoAlarm. # # If, for example, the value of token ws2 is Oracle and value of token service # is DB, then the value of mc_smc_id or mc_smc_alias is "Oracle%DB". #---------------------------------------------------------------------------BEGIN toolType = TestToolType; alertType = Alarm, NoAlarm; mapValue = [ws2]%[service]; END #---------------------------------------------------------------------------# Example 3: Using Reserved Words # # The example below shows how to use reserved words. # # If you happen to have a toolType just named toolType, the following # usage is NOT correct: toolType = toolType. Instead, you should put # double quotes around the value of toolType: toolType = "toolType". #---------------------------------------------------------------------------BEGIN toolType = "toolType"; alertType = Alarm; mapValue = BMC_[originKey]_[origin]; END
Appendix B
Configuration File Reference
153
PEMSelector.cfg.example file
Figure 13
McSmcMapping.cfg.example file (part 3 of 3)
#---------------------------------------------------------------------------# Example 4: Using Literal Double Quotes # # The example below shows how to use literal double quotes. # # If a toolType is named "test", where double quotes are part of the name, # if you continue using toolType = "test", the parser considers the name # as test. Backslash tells the parser to treat the double quote as it # is: toolType = \"test\". # # In this example, we also use backslash to escape the quotes used in mapValue. # If the value for originKey = 10, the value for origin = promethius, then # the mapValue = "10"_promethius. #---------------------------------------------------------------------------BEGIN toolType = \"test\"; alertType = Alarm; mapValue = \"[originKey]\"_[origin]; END
PEMSelector.cfg.example file A reference file, it contains example code that you can use to specify your alert selection criteria in the PEMSelector.cfg file. Do not modify the PEMSelector.cfg.example file.
154
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
PEMSelector.cfg.example file
Figure 14
PEMSelector.cfg.example file (part 1 of 3)
#============================================================================= # # BMC Impact Integration for PATROL EM - Alert Selection Criteria # #============================================================================= #---------------------------------------------------------------------------# START: BMC criteria # A BMC Impact Manager event is represented on PATROL EM as an # ImpactIntegration alert. Therefore, ImpactIntegration alerts do not # need to be transmitted to BMC Impact Integration for Patrol EM. # # Please do not remove the following criteria, as it reduces network traffic # and BMC Impact Integration for PATROL EM's workload. #---------------------------------------------------------------------------BEGIN toolType != ImpactIntegration; END #---------------------------------------------------------------------------# END: BMC criteria #---------------------------------------------------------------------------#============================================================================= # Creating An Alert Selector # #============================================================================= # This file explains how to create an alert selector file that specifies # which PATROL EM alerts are sent to the BMC Impact Manager. # # This file contains example code of an alert selector file. The actual # selector file is typically named PEMSelector.cfg. You can copy the contents # of this file into a file named PEMSelector.cfg and then edit from there. # Or you can simply modify this file and then rename it to PEMSelector.cfg. # # If no selector is defined, by default, every PATROL EM alert is sent to BMC # Impact Manager. # # To define which alerts are sent, you create a set of specifications within # BEGIN and END statements. You may include more than one set of statements # in the file. # # The syntax of the contents of the selector file is as following: # # BEGIN # [ toolType (= | !=) ; ] # [ toolId (= | !=) ; ] # [ alertType (= | !=) [ , ] ; ] # [ severity (= | !=) [ , ] ; ] # [ category (= | !=) [ , ] ; ] # [ priority (= | !=) [ , ] ; ] # END # # [ # BEGIN # ... # END # ]
Appendix B
Configuration File Reference
155
PEMSelector.cfg.example file
Figure 14
PEMSelector.cfg.example file (part 2 of 3)
# where # (01) severityName must be one of the following: "Clear", "Informational", # "Warning", "Minor", "Major", and "Critical". # # (02) categoryName must be one of the following: "Circuit", "Equipment", # "Facility", "LAN", "Multipoint_Circuit", "Service", and "Software". # # (03) priorityNumber must be an integer between 0 and 99. # # # The constraints of the selector are simple: # # (01) Every block starts with "BEGIN", and ends with "END". # # (02) There can be one or multiple BEGIN/END blocks within the # PEMSelector.cfg file. # # (03) In a BEGIN/END block, six different variables can be used: # toolType, toolId, alertType, severity, category, and priority. # # (04) "BEGIN", "END", "toolType", "toolId", "alertType", "severity", # "category", and "priority" are considered reserved words, and they # are case-sensitive. # # (05) Each variable has the format of "variable = value;", where value is # case sensitive. # # (06) You can only specify one value each for toolType and toolId. # # (07) You can specify multiple values for alertType, severity, category # and priority, as long as the values are separated by comma. A comma # specifies an OR relationship for the values. # # (08) If an alertType is defined, toolType must be defined as well. # Moreover, "!=" cannot be used in this case for toolType. # # (09) There is implied AND relationship for all lines within a BEGIN/END # block. # # (10) There is an implied OR relationship among BEGIN/END blocks. # # (11) Double quotes are used if you want to use a reserved word as value. # For example, if you have a toolType named toolType, you should # specify it in this way: toolType = "toolType". # # (12) If there is a double quote in your value name, you need to put a # backslash in front of each double quote (to escape it). For example, # you might have a toolType named "test", i.e. double quotes are part # of the toolType name. In this case, you can specify it in this way: # toolType = \"test\". # #=============================================================================
156
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
PEMSelector.cfg.example file
Figure 14
PEMSelector.cfg.example file (part 3 of 3)
#---------------------------------------------------------------------------# In this selector example, only the PATROL EM alerts that match the # following conditions are sent to BMC Impact Manager. #---------------------------------------------------------------------------BEGIN toolType = NetCmmnd; alertType = AGCDDown; END BEGIN toolId severity
!= =
NetCmmnd; Major, Critical;
END #---------------------------------------------------------------------------# In the above example, block one specifies to send all alerts that have # toolType = NetCmmnd AND alertType = Alarm. # # NOTE: it would be wrong if toolType is not defined here, or "!=" is used for # toolType, since alertType is defined. # # Block two specifies to send alerts if their toolIds do NOT equal 10 AND # their severity = Major OR severity = Critical. # # Since there is an OR relationship among blocks, an alert will be sent if it # satisfies either of the above statements. #----------------------------------------------------------------------------
Appendix B
Configuration File Reference
157
PEMSelector.cfg.example file
158
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Glossary $MCELL_HOME The Unix platform environment variable that defines the home directory in which product files reside. Use this environment variable to find all product executables and configuration files. %MCELL_ HOME% The Windows platform environment variable that defines the home directory in which product files reside. Use this environment variable to find all product executables and configuration files. .load file A file that specifies the order in which a directory’s files are to be loaded and read by a BMC Impact Manager instance. .map file See adapter map file. .mrl file A file that contains rule and collector definitions written in the Master Rule Language (MRL). Event and service management processing rules and collectors are stored in .mrl files and in compiled .wic files. /etc/mcell On Unix platforms, the directory that contains the setup_env.sh and setup_env.csh scripts, which set the environment variables used by the product software.
A Abstract phase The event-processing phase in which Abstract rules are evaluated and, if conditions are met, abstraction events are generated. See also abstraction event. Abstract rule An event-processing rule that creates an abstraction event from one or more raw events. See also abstraction event. abstracted event An event that contributes to the creation of an abstraction event. The abstracted event is the basis for inferring that some condition exists. For example, if a critical subprocess of an application is down, the application is down. See also abstraction event. Glossary
159
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z abstraction event A conceptual or summary event based on other events that are occurring. You cannot understand the context of an abstraction event by its details. To understand its context, you must view the relationships between the abstraction event and the events that triggered its creation in the BMC Impact Explorer Events Tab, Relationships window. See also abstracted event. Acknowledge The event operation action that acknowledges the existence of an event. See also local action. Acknowledged status The event status that results from an Acknowledge event operation action; it means that an operator has acknowledged the event's existence. action 1. Generally, a procedure that is invoked to produce a specific result. It can be a script or a call to an executable that is invoked automatically in response to an event, or it can be a manual intervention. Actions can be scheduled or immediately invoked locally or remotely. 2. In BMC Impact Manager, an executable that can be run by a cell. Actions are called in an Execute rule. Users can request the execution of actions in the BMC Impact Explorer. See also local action and non-local action. adapter A background process that audits data from various sources, evaluates it for specific conditions, and creates the corresponding events. Adapters also transform event data into the format understood by BMC Impact Manager. adapter instance An adapter that is defined in the adapter configuration file. The definition is given a name and specifies an adapter type, such as a log file adapter. adapter map file A text file that defines the translation of a message between one event format and another. It is also known as a .map file. Administrative View The BMC Impact Explorer user interface for cell administration. Administrative users can start, pause, stop, and reconfigure a cell using this interface. They can also make changes to a cell's dynamic data tables. You access this view by clicking the Administration tab in BMC Impact Explorer. administrator The person responsible for administrative tasks within the product. alias See service component alias.
160
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z annotated data point A specially marked point on a parameter graph that provides detailed information about a parameter at a particular moment. The associated data is accessed by double-clicking the data point, which is represented by a user-specified character. API See Application Program Interface (API). Application Program Interface (API) A set of externalized functions that allow interaction with an application. asset An object instance in the BMC Configuration Management Database (CMDB). There are two types of assets in the CMDB: non-service components, such as desks and other non-IT physical assets, and service components which are components that participate in the delivery of enterprise services. asset inventory The list all physical and logical assets that have an identifiable value to the organization or against which threats and vulnerabilities can be identified and quantified as part of risk assessment. Assign To The event operation action that assigns the responsibility for an event to an individual. Assigned status The event status that indicates that the specified operator is responsible for the event. It results from the Assign To or the Take Ownership event operation actions. attribute A characteristic or property of an object, such as a common data model service model component class. An attribute may contain a value. automated action An action that is automatically executed when an alert occurs whose values match the conditions established for the action. You use automated actions to perform an operation as soon as a problem or condition is detected. automation In BMC Impact Explorer, operator responses that have been programmed to occur automatically when an event is received.
Glossary
161
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
B BAROC language Basic Recorder of Objects in C. A structured language used to create and modify class definitions. A class definition is similar to a structure in the C programming language. The elements in a BAROC class are called slots. base class In programming, a root superclass, a class from which all other classes of its type are derived. BMC Configuration Management Database (BMC CMDB) The database application that is the common datastore for asset, configuration management, and service model data in BMC Business Service Management products. BMC IDG See BMC Impact Database Gateway (BMC IDG). BMC IEA See BMC Impact Event Adapters (BMC IEA). BMC IELA See BMC Impact Event Log Adapter for Windows (BMC IELA). BMC Impact Database Gateway (BMC IDG) The interface that enables BMC Impact Manager events to be exported to a relational database. BMC Impact Event Adapters (BMC IEA) The adapters that collect log file information, convert it to BMC Impact events, and send the events to a designated BMC Impact Manager instance or instances. BMC Impact Event Log Adapter for Windows (BMC IELA) The native Windows platform executable that audits Windows event logs. It runs as a Windows service and checks for new event log records. BMC Impact Explorer (BMC IX) The console with which you can connect to any number of BMC Impact Managers, examine the events stored in them, and perform event and service management activities. BMC Impact Explorer Server See BMC Impact Portal. BMC Impact Integration product (BMC II product) An interface that enables the synchronized flow of events and data between a BMC Impact Manager instance and another BMC Software product or a specific third-party product.
162
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z BMC Impact Manager (BMC IM) The BMC Impact product that provides automated event and service impact management. It runs as a service on supported Windows platforms and as a daemon on Unix platforms, and can be distributed throughout the networked enterprise and connected in various topologies to support IT goals. BMC Impact Portal The BMC Portal console module that you use to monitor the status of business services and their components. See also console module. BMC Impact Web Console (BMC IWC) Obsolete term. See BMC Impact Portal. BMC IWC See BMC Impact Portal. BMC IX See BMC Impact Explorer (BMC IX). BMC IXS See BMC Impact Portal. BMC Portal A BMC licensed product that consists of the BMC Portal Server (infrastructure) and console modules, each of which deliver specific Business Service Management (BSM) functionality. The BMC Impact Portal and PATROL Portal are examples of console modules. BMC Service Impact Manager (BMC SIM) A real-time service impact management solution that can identify related applications and underlying systems and databases of any software or infrastructure component. BMC Service Impact Manager ties systems-level monitoring to the supported business services and enables IT personnel to respond quickly to problems that threaten the delivery of business services. BMC SIM See BMC Service Impact Manager (BMC SIM). BMC_System class In the CMDB Common Data Model, the parent class for all system information. In this class tree, classes representing computer systems, mainframes, application systems, and virtual systems are defined. built-in action An automated, predefined action performed by a system. business function A group of business processes that make up a specific function such as customer support.
Glossary
163
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z business process A series of related business activities that operate to achieve one or more business objectives in a measurable way. Typical business processes include receiving orders, marketing services, delivering services, distributing products, invoicing for services, and accounting for money received. A business process rarely operates in isolation. It depends on other business processes and other business processes, in turn, rely on it. A business process usually relies on several business functions for support, such as IT and Personnel. business process decomposition The identification and cataloging of the business activities and IT resources that combine to make up a business process. The result of business decomposition is a business process model. business service A service that is identifiable by business representatives and supports explicit business processes that have a clear link to the business's value chain. Most business services have an easily identifiable senior business representative, are composed of a number of specific applications, and rely on the functioning of infrastructure services. For example, the provision of all logistic components underpinning the sale of consumer goods is a business service. See also service. Business Service Management (BSM) A dynamic method for connecting key business services to the IT systems that manage them. BSM enables users to understand and predict how technology changes will affect their business, and how changes in the business affect the IT infrastructure.
C cause event In a sequence of events, the event that is identified as the cause of the other events. See also effect event. CDM See CMDB Common Data Model (CMDB CDM). cell The event processing engine that collects, processes, and stores events within a BMC Impact Manager instance. Each cell uses the information in its associated Knowledge Base to identify the types of events to accept and how to process and distribute them. child collector A collector contained within another collector. See also event collector.
164
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z class 1. A data storage element. In database terms, it relates to a table in a database or a form in the Remedy AR System. 2. In BMC Impact Manager, a BAROC-language data structure that defines a type of object used in BMC Impact Manager. A BAROC class is made up of data fields, called slots, that define its properties. 3. In BMC Impact Portal: See object class. CLI command A command that is issued on the OS command line for automation or immediate execution. For a complete list of CLI commands, see the BMC Impact Solutions System Configuration, Maintenance, and Administration Guide. See also command line interface (CLI). Close The event operation action that closes an event. If the event was assigned to the current user, Close sets the status to Closed and shows an Operator Closed entry in the operation history. Otherwise, Close sets the status to Closed and shows an Override Closed entry in the operation history. Close status The event status that results from a Close event operation action. CMDB See BMC Configuration Management Database (BMC CMDB). CMDB Common Data Model (CMDB CDM) An extensible schema that provides a unified representation of configuration items and their relationships to each other. It is designed to store asset data (such as hardware information, service management information, and people information) and to provide a mechanism for linking that information to provide a complete view of how all elements of a company are connected and can affect each other. CMDB Reconciliation Engine The CMDB application used to merge data from multiple sources, such as topology or configuration discovery, into a consistent dataset. collector See event collector. collector rule See event collector rule. collector set See event collector set.
Glossary
165
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z command line interface (CLI) A user interface in which you issue commands one at a time on a command line for automation or immediate execution. In BMC Impact Manager, you use the CLI in conjunction with a graphical user interface (GUI) to operate the product. common data model (CDM) See CMDB Common Data Model (CMDB CDM). component A logical or physical asset that is stored in the BMC Configuration Management Database (CMDB). There are two types of assets in the CMDB: non-service components, such as desks and other non-IT physical assets, and service components, which are components that participate in the delivery of business services. See also service component (SC). component instance A named component that represents an actual IT resource. component pool The logical and physical assets which participate in the delivery of enterprise services and can be part of the service model. The component pool includes both assets that are part of the service model and assets that are not part of the service model. See also object and component. component relationship See service component relationship. component type An icon with an editable template that represents a specific Common Data Model component class in the Service Model Editor. A user can select a component type and edit its template to create a new instance of the component class. condition A prerequisite that must exist or a or qualification that must be met for selection or processing to take place, such as individual slot-value tests. configuration management database (CMDB) See BMC Configuration Management Database (BMC CMDB). console One of the BMC Impact Manager product GUIs. There are four commonly-used GUIs: BMC Impact Portal, BMC Impact Explorer, BMC Impact Reporting Console, and Service Model Editor. console local action An action taken from a console that is executed on the console host machine. console module A product that plugs into the BMC Portal.
166
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z consolidation node A BMC Impact Manager instance that can receive and process events originating from other systems on the network. consumer See service consumer. core competency Capabilities that collectively account for all business activities within a business enterprise, such as planning and developing products. CORE_DATA class The base class for all BMC Impact Manager BAROC data classes. It is the parent class for all customized data classes. CORE_EVENT class The base class for all BMC Impact Manager event classes. It is the parent class for all customized event classes. Correlate phase The event-processing phase in which the Correlate rules are evaluated to determine whether any events have a cause-and-effect relationship. See also Correlate rule. Correlate rule An event-processing rule that establishes the cause-and-effect relationship between two events. Correlate rules represent a one-to-one relationship. correlation 1. The process of identifying a cause-and-effect relationship between two events from one or more sources for the purpose of identifying a root cause. 2. The cause and effect relationship itself. 3. A type of policy.
D data class A BAROC class that is a child of the base data class, CORE_DATA, and that defines a type of data. Users can create their own data classes. datastore A central place in which an aggregation of data is kept and maintained in an organized way.
Glossary
167
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z Decline Ownership The event operation action that indicates that the assigned operator does not accept responsibility for an event. Decline Ownership clears the owner's name, sets the status back to Acknowledged, and shows a Declined entry in the operation history. default status view type In the BMC Impact Portal, one of the view types available under the Status tab. Delete phase The event-processing phase in which Delete rules are evaluated and actions are taken to ensure that data integrity is maintained when an event is deleted from the repository during the cleanup process. Delete rule An event-processing rule that is used to clean up obsolete information when an event is deleted from the repository. Delete rules are evaluated when an event is deleted and they take actions to insure that data integrity is maintained. draft service model A working version of the service model that contains both published and unpublished elements. duplicate event A subsequent occurrence of an event that has already been received, such as the second or later notification that a component is down. An event that has matching values for all the slots defined with the dup_detect=yes facet in the event class definition.You can use Regulate rules to detect and count duplicate events. See also facet. dynamic collector A special type of collector that, in response to events, can add or remove event collectors from the cell during runtime. dynamic data Contextual reference data that is stored in a table in the event repository (mcdb) and that is updated during runtime if the context has changed. Administrators can use and manipulate dynamic data in the BMC Impact Explorer Administration View.
E ECF See Event Condition Formula (ECF). effect event In a sequence of events, the event that is identified as an effect of a cause event. See also cause event.
168
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z elected event See impact event. encryption key The seed encryption key. If the destination product has a key value, all clients must encrypt their communications using the same key value. enrichment 1. The process of adding to or modifying the original event data to enhance it for problem management, service management, correlation, automation, notification, or reporting functions. 2. A type of policy. escalation 1. The process of referring a problem up the chain of command. 2. A type of policy. escalation procedure The particular steps defined for performing escalation. For example, you might specify that operations personnel would be notified within 5 minutes of a problem occurrence, a manager would learn of it after 15 minutes, and a director after 1 hour (if the problem still exists). event In a BMC Impact environment, a structured message passed to and from cells. Each event is an instance of an event class. Event Adapters See BMC Impact Event Adapters (BMC IEA). event class 1. A BAROC class that is a child of the base event class, CORE_EVENT, and that defines a type of event. 2. A category of events that you can create as a child of the base event class, CORE_EVENT, according to how you want the events to be handled by an event manager and what actions you want to be taken when the event occurs. Event classes may be inherited from parent objects, depending on the specific product. Event classes are inherited from parent objects in BMC Impact Manager. event collector An event grouping whose content is defined by its collector rule. Event collectors are displayed in the BMC Impact Explorer and are defined in the BMC Impact Manager Knowledge Base. See also event collector rule.
Glossary
169
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z event collector rule A type of rule in the Knowledge Base that defines how events from a cell are organized and presented in the BMC Impact Explorer. Collector rules are written in Master Rule Language (MRL). event collector set A group of event collectors, organized in a parent-child hierarchy, that results from progressive filtering of the incoming events that match the top-level (parent event collector) criteria. A collector set organizes the events for display in the BMC Impact Explorer. Event Condition Formula (ECF) The section of an MRL rule definition that specifies the conditions that an incoming event must meet to trigger evaluation of the rule during processing. For example: APP_MISSING_PROCESSES where [hostname: == ‘red1’,sub_origin: contains ‘System’] is an ECF. See Master Rule Language (MRL). event datastore An archive of generated event data. event group A grouping of collectors that depicts the relationship of events through the hierarchy of the navigation tree. Each level of the collector set is shown as a node under the event group. The parent level of an event group represents all of the events associated with the collectors. An event list is associated with the lowest level nodes of an event group. The parent level of an event group is associated with an image view. event list 1. A tabular listing of events. 2. In BMC Impact Explorer, you can access the event list from the Events tab. Event Log Adapter for Windows See BMC Impact Event Log Adapter for Windows (BMC IELA). event management The collection and correlation of events across an enterprise to enable IT operations to focus the proper resources on the most critical events. event management policy One of several generic rule types that perform actions against events that meet selection criteria specified in an associated event selector. Unlike manually written rules, event policies are defined interactively using the Event Management Policy Editor in the BMC Impact Explorer. event operation history The tabular display of the operation actions taken against an event in BMC Impact Explorer. You can access the event operation history from the Operations History tab of the Event Details pane on the Events tab in BMC Impact Explorer.
170
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z event operations Commands issued by operators to respond to events and correct the problems that the events represent. Operators perform these commands from an event list in BMC Impact Explorer. event processor See cell. event propagation The act of forwarding events and maintaining their synchronization among multiple BMC Impact Manager instances (cells). event repository 1. An archive of generated event data. 2. In BMC Impact Manager instances (cells), the storage facility (mcdb) in which event information is stored. event selection criteria The syntax of an event selector that specifies the conditions that an incoming event must meet to trigger selection of the event for rule evaluation during each phase of event processing. You can specify event selection criteria through the BMC Impact Explorer GUI. An MRL Event Condition Formula (ECF) also contains event selection criteria. An event selector contains one or more event selection criteria. event selector The filtering mechanism associated with an event policy that selects the events against which the event policy performs actions. An event selector contains one or more event selection criteria. Event selectors are defined interactively by using the BMC Impact Explorer. An event policy can use one or more event selectors. event source The monitored IT resource from which source event data is collected, such as an operating system or application log file. event timeout An event timeout policy changes an event status to closed after a specified period of time elapses. Events View The BMC Impact Explorer user interface for viewing and manipulating event data. See also Services View and Administration View. Execute phase The event-processing phase in which Execute rules are evaluated, and, if conditions are met, specified actions are performed.
Glossary
171
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z Execute rule An event-processing rule that performs actions when an attribute (slot) value changes in the event repository. Execute rules are evaluated during the Execute phase of event processing. Often, the resulting actions are internal actions, but you can use the execute primitive in a rule to call an external executable. expression A combination of operators, operands (constants, variables, functions, and primitives), and conditions that represents a value or a relationship between values.
F facet A specific attribute of a BAROC class slot (attribute) that either controls the values that the slot (attribute) can have or controls aspects of a class instance's processing. field See attribute. Filter phase The event-processing phase in which Filter rules are evaluated to determine which events need additional processing or are unneeded and are to be discarded. Filter rule An event-processing rule that determines whether a specific type of event should be passed as it is, subjected to further processing, or discarded as unwanted during the Filter phase. function Code that executes an operation in a cell and returns a value. A function can be used only in an expression within a rule. See also primitive.
G gateway See BMC Impact Integration product (BMC II product). gateway.export file A special file that controls the propagation and synchronization of events to a BMC Impact Manager Integration product. The file is in the $MCELL_HOME/etc/ directory on Unix platforms and in the %MCELL_HOME\etc\ directory on Windows platforms. global record A special BAROC class instance that defines a persistent global variable. When a cell starts, it creates one instance of each global record defined in the Knowledge Base and restores any existing values. Global record definitions are stored in the record subdirectory of the cell Knowledge Base. You can get and set global record values in MRL rules or by using the BMC Impact Manager CLI mgetrec and msetrec commands. 172
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z global slot order In BMC Impact Explorer, a set of slots (attributes), in a particular order, that is associated with a filter and is shared among users. group A logical or an arbitrary collection of user-defined objects that may or may not measurable relationships and may or may not have summary data associated with them.
H heartbeat 1. A periodic message sent between communicating objects to inform each object that the other is still active and accessible. 2. In BMC Impact Manager, a dynamic data object sent by a cell to monitor other cells to verify that they remain active and accessible. heartbeat interval The time between heartbeats; the period of the heartbeat.
I image view A graphical and hierarchical display that depicts a business view. You can create image view objects or elements to represent managed systems (tools), geographic locations, operators, time, severity levels, categories, and so forth. impact An assessed measure of the effect that an incident, fault, or other change will or may have on business operations or service levels. impact event An event whose status is used in computing the status of its associated service component. By default, the status of all events associated with a service component are used to compute its status. However, you can exclude events if you wish. impact propagation The effect of an impact to a providing service component (provider) on the service components that use its services (consumers) as defined by an impact relationship. See also impact relationship. impact relationship A relationship between two service components in a service infrastructure in which a consumer component depends on a provider component to deliver some needed resource to it. Changes in status of the provider affect (has an impact on) the status of the consumer component.
Glossary
173
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z impacted state The object state that indicates that an object's functioning is impaired. in-model service component A service component that is currently part of the service model and appears in the Service Model Editor (SME) component list. index A value that is used by an MRL rule to sort the slot information for an event or data object. informational alert An alert of relatively low importance, such as a routine state change. See also severity. infrastructure element An addressable object that can be monitored, such as a managed system in PATROL. instance 1. A specific object with specific attributes or characteristics that distinguish it from other items (members) of its class or type. 2. In BMC Impact Manager, an object that has specific attribute values and that was created using a class definition. integration product See BMC Impact Integration product (BMC II product). interface class A BAROC class that defines the programming interface used by an MRL rule primitive, such as get_external, to return data from an external program. At cell startup, an interface class is loaded into memory. The cell invokes the executable defined in an argument of the primitive. The executable's value is returned by the interface. internal base class A BAROC internal class that defines the required structure for the base class from which a group of BMC Impact Manager classes is derived. internal event An event that is created by the cell during event processing. An internal event is processed in the same way as an incoming event. All internal events are processed before any new, incoming external events are processed. Internet Protocol (IP) adapter An adapter that collects and translates events from a Telnet, UDP, or TCP data source. IP adapter See Internet Protocol (IP) adapter.
174
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z IT component See BMC_System class.
K kb directory The default directory in which a BMC Impact Manager Knowledge Base is located. The directory and basic product definitions are created during installation. key slot A slot whose value is compared during searches. Knowledge Base (KB) A collection of information that forms the intelligence of a BMC Impact Manager instance and enables it to process events and perform service-impact-management activities. This information includes event class definitions, service component definitions, record definitions, interface definitions, collector definitions, data associations, and processing rules.
L load file See .load file. local action An executable that you can run directly from the BMC Impact Manager. Local actions are written in XML and are stored in the OS-specific subdirectory of the bin directory of the BMC Impact Manager cell Knowledge Base. logical component A non-physical object, such as a service, geography, organization, or user group, that represents something that does not exist physically in the infrastructure. A logical component calculates state in a specific way based on a formula.
M macro An executable used in .map files to manipulate the fields used for event translation. manifest.kb A central locator file that specifies the locations of the directories that make up a Knowledge Base. The manifest.kb file is used by the compiler to load the Knowledge Base sources files for compilation. map See image view.
Glossary
175
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z Master Rule Language (MRL) A compact, declarative language used to define rules and collectors for processing and organizing events in BMC Impact Manager. Uncompiled rule and collector source files have a .mrl file extension. mccomp The BMC Impact Manager rules compiler. Rules are written in the Master Rule Language (MRL). The platform-independent compiler converts them to byte code that the cell can read and process. mcdb See event repository. mcell.conf file The configuration file that contains configuration options for a BMC Impact Manager instance (cell). It is in the $MCELL_HOME/etc/ directory on Unix platforms and in the %MCELL_HOME%\etc\ directory on supported Windows platforms. mcell.dir file The file that lists the cells to which a BMC Impact Solutions product or component can connect and communicate. The information in each cell includes its name, its encryption key, and its host name and port number. This file is in the $MCELL_HOME/etc/ directory on Unix platforms and in the %MCELL_HOME%\etc\ directory on supported Windows platforms. mcell.modify file The file that lists the slots that affect the mc_modification_date slot. When a specified slot is modified, the time stamp of the modification is reset in the mc_modification_date slot, so that slot is listed in mcell.modify. mcell.propagate file The configuration file that specifies the slot values that are synchronized during event propagation between BMC Impact Manager instances (cells). It is in the $MCELL_HOME/etc/ directory on Unix platforms and in the %MCELL_HOME%\etc\ directory on supported Windows platforms. mcell.trace file The configuration file that specifies the trace information about a BMC Impact Manager (cell) that should be recorded and the location to which it is written. It is in $MCELL_HOME/etc/ directory on Unix platforms and in the %MCELL_HOME%\etc\ directory on supported Windows platforms. MCELL_HOME See $MCELL_HOME for Unix or %MCELL_ HOME% for Windows.
176
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z mclient.conf file The configuration file that specifies the configurations for the BMC Impact Manager CLI commands. It is in the $MCELL_HOME/etc/ directory on Unix platforms and in the %MCELL_HOME%\etc\ directory on supported Windows platforms. mclient.trace file The configuration file that specifies the trace information that should be collected for the BMC Impact Manager CLI commands and the location to which it should be written. This file is in the $MCELL_HOME/etc/ directory on Unix platforms and in the %MCELL_HOME%\etc\ directory on supported Windows platforms. mcontrol command The CLI command that sends control commands to a BMC Impact Manager instance (cell). mc_udid See universal data identifier (mc_udid). mean time between failures (MTBF) The average elapsed time from the point at which an IT service object is made available until the next occurrence of failure in the same service object. mean time between system/service incidents (MTBSI) The average elapsed time between the occurrence of a system or service failure and the next failure in the same system or service. mean time to repair (MTTR) The average elapsed time from the occurrence of an incident to restoration of the service. metaclass See internal base class. MetaCollector A virtual collector that contains a group of event collectors from multiple BMC Impact Manager instances. It exists only in the BMC Impact Explorer. You can customize it to suit your organizational needs. MTBF See mean time between failures (MTBF). MTBSI See mean time between system/service incidents (MTBSI). MTTR See mean time to repair (MTTR).
Glossary
177
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
N navigation tree See navigation tree view. navigation tree view 1. A hierarchical display of the objects and user-defined groups and views. 2. In BMC Impact Explorer, a hierarchical view of defined objects and groups. An object can be a filter, rule, or event. The groups are arranged to show relationship and dependency between the managed systems. The navigation tree view appears in the left pane. 3. In the BMC Portal, a hierarchical display of groups defined in a view. New phase The event-processing phase in which New rules are evaluated to determine which events in the repository should be updated with new information from new incoming events. This is the last opportunity to prevent and event from entering the event repository (mcdb). New rule An event processing rule that is evaluated during the New event processing phase, and can update events stored in the repository (mcdb) with fresh information from new incoming events. node A BMC Impact Manager instance that can receive only events originating on the local host system. non-local action A user-initiated action that does not execute on the user console host machine. non-service component A logical or physical asset in the BMC Configuration Management Database (CMDB) that does not participate in the delivery of business services, such as a desk or other non-IT physical asset. A non-service component is not visible within the BMC Portal Service Model Editor. normalization The process of homogenizing event data into a common event format so that a standard set of event data is collected and reported regardless of the event source. not-in-model service component A service component that exists as logical or physical asset in the BMC Configuration Management Database (CMDB) but is not currently part of the service model. A not-in-model service component is visible within the BMC Portal Service Model Editor component pool.
178
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z notification 1. A message, either detailed or concise, that contain information about a condition that triggered an alert state on a monitored element. An email message or SNMP trap that is sent when the program detects a problem that triggers an alert. 2. A type of policy. null relationship A relationship between two components in a service infrastructure in which there is no impact to the consumer component. A null relationship only indicates that the two components are connected logically and are represented visually as “linked.” See also impact relationship.
O object 1. An item that can be inserted into a dashboard. For example, a chart, link, or Active-X control. 2. A generic term for anything that is displayed in the user interface. 3. See class. object class In BMC Impact Solutions, a data structure that defines a type of object. An object class can be a BAROC-language data structure in a BMC Impact Manager cell Knowledge Base or a Common Data Model (CDM) data structure in the BMC Configuration Management Database. A class is made up of data fields, called attributes (slots) that define its properties. See also event class, object, and object hierarchy. open event An event that may require action. An open event may have a status of Open, Acknowledged, Assigned, or Blackout. Open status The event status that indicates that the event has not been examined, or that neither an operator nor an automated process has been assigned responsibility for the event.
P parent event collector A event collector that contains child collectors to form an event collector set. permission A rule associated with an object to control which users, groups, and roles can access the object and in what manner. A permission gives the user a specific type of access to the object (for example, read permission or write permission). See right.
Glossary
179
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z phase, rule See rule phase. policy See event management policy. policy class A BAROC class that is a child of the base data class POLICY and that defines a type of policy. policy instance A specific implementation of any of the types of event management policies. For example, you could have an instance of a blackout policy that defined blackout periods for holidays and another instance of the same policy that defined blackout periods for monthly maintenance. port A number that designates a specific communication channel in TCP/IP networking. Ports are identified by numbers. BMC Impact Manager communicates using the ports specified during installation. portal The access point for web-based management tools. The portal houses applications installed by a user and communicates with remotely monitored systems. See also BMC Portal. primitive Similar to a function, code that executes an operation in a cell and returns a value; can be used as an instruction, or as a function if contained in Boolean expression. See the BMC Impact Manager Knowledge Base Reference Guide for information about the MRL primitives. priority An attribute indicating the precedence or scale of importance of an event. Propagate phase The event-processing rule phase in which Propagate rules are evaluated to determine the events to be forwarded to another cell or to a BMC Impact Integration product. Propagate rule An event-processing rule that is used to forward events to other cells in the managed domain. Propagate rules are evaluated during the Propagate phase of event processing. propagated event An event that is forwarded from one cell to another cell or to a BMC Impact Integration product during the Propagate phase of event processing. provider See service provider.
180
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z published-modified component A service component that has been modified since its service model was published (distributed) to BMC Impact Manager instances. published component A service component that is currently part of the published service model that has been distributed to BMC Impact Manager instances. published service model A service model that is currently distributed to BMC Impact Manager instances (cells). It contains only published elements.
R Reconciliation Engine See CMDB Reconciliation Engine. record See global record. recurrence 1. The characteristic of occurring more than once. 2. The type of policy that handles recurrent events. See also recurrent event. recurrent event An event that occurs more than one time. Both scheduled and unscheduled events can be recurrent events: a monitored hardware device could experience multiple voltage spikes within a single polling cycle, and a reminder notification could be scheduled to be sent periodically until acknowledgment is received. See also duplicate event. Refine phase The first phase of event processing, in which Refine rules are evaluated to validate incoming events and, if necessary, collect additional data needed before further event processing can occur. Refine rule A rule evaluated during the first phase of event processing to validate an incoming event and, if necessary, to collect any additional data needed before further processing can occur. regular expression Sometimes referred to as “regex,” regular expressions are used in pattern matching and substitution operators. A simple regular expression is a sequence or pattern of characters that is matched against a text string when performing search and replacement functions.
Glossary
181
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z Regulate phase The event-processing phase in which Regulate rules are evaluated and, if true, collect duplicate events for a time period and, if a specified threshold of duplicates is reached, passes an event to the next processing phase. Regulate rule An event-processing rule that processes duplicate events or events that occur with a specified frequency. With a Regulate rule, you can create a new event based on the detection of repetitive or frequent events. See also Regulate Phase. remote action A user-initiated action that does not execute on the user console host computer; an executable that can be run by a cell. Remote actions are written in the Master Rule Language (MRL) and are stored in the OS-specific subdirectory of the bin directory of the Knowledge Base. Reopen The event operation action that reopens an event that is in the Closed state. Reopen sets the status to Open and shows a Reopen entry in the operation history. repository See event repository. restricted object A dynamically created object that contributes to service status, but which the user does not have permission to view. right An authorization entitling a user to perform a certain action. Rights apply to a whole application or to specific objects of a certain type. root cause analysis The process of monitoring events and correlating event data to identify the true cause of a problem. rule A conditional statement written in MRL and that, if determined to be true, executes actions. Cell event processing occurs in phases with the cell comparing each event to the series of rules associated with that phase. Each phase’s rules are evaluated one by one before the event is passed to the next phase. The order in which rules are evaluated during a particular phase is based on the order in which the rules were loaded. rule engine See cell. rule phase A specific stage of event processing. A combination of sequential phases and nonsequential phases comprise event processing, each with a corresponding rule type.
182
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z rule type The designation that identifies a rule as being in a specific phase of event processing. The cell executes rules within the context of the associated event-processing phase and in the order in which the rules were loaded from the rule file.
S saved state The state of a BMC Impact Manager instance (cell) as determined by the StateBuilder utility, statbld.exe. The StateBuilder utility periodically consolidates the data in the transactions file (xact) to produce the “saved state”of the product instance. This information is stored in the event repository (mcdb) and the state is reloaded when BMC Impact Manager restarts. SCHEDULE class A BAROC class that is a child of the base data class SCHEDULE and that defines a type of schedule. SDK See Software Development Kit (SDK). selector See event selector. selector class A BAROC class that is a child of the base data class SELECTOR and that defines a type of event selector. service An integrated composite of several components, such as management processes, hardware, software, facilities, and people, that delivers something of value to satisfy a management need or objective. service catalog A list of IT services that identifies the physical and logical assets that help provide a service. The data collected in the service catalog can be used to form a configuration management database. service component (SC) A logical or physical resource that participates in the delivery of services. A service component is any class that is a subclass of the BMC_AssetBase class in the BMC Configuration Management Database (CMDB) or the cell Knowledge Base. service component alias A name that is assigned to a service component instance and used in associating an event type with the component instance. You add an alias to a service component instance’s definition in the Service Model Editor. A service component instance can have several different aliases to enable different event types to be associated easily with it.
Glossary
183
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z service component relationship In a service model, the association of two service components in which one component, the provider, delivers some resource or service to the consuming component or components. See also service provider and service consumer. service consumer In a service model component relationship, the component that uses a service provided by another component, the provider. See also service provider. Service Impact Management (SIM) A technique for managing the impact of IT events on the company’s core business services to ensure their delivery. See also BMC Service Impact Manager (BMC SIM). service model (SM) An extensible system for defining the various resources that combine to deliver business services, for modeling their behaviors and functional relationships, and for managing the delivery of the resulting services. In Service Impact Management, the map of how IT components relate to the business processes that they support. All IT events and service issues are analyzed against the service model to determine the root cause of problems and to report on service impacts. service provider A logical or physical asset that delivers services or provides resources that are used by other service components in the delivery of business services. Services View The BMC Impact Manager user interface for viewing service-model components and their relationships and for viewing and managing the events that affect service availability. Set Priority The event operation action that escalates or de-escalates an event. Set Priority sets the events priority to the specified values and shows a Priority Set entry in the operation history. severity An indication of the seriousness of an event. severity-to-status mapping table One of the two tables that relate event severity and service component status. It is used by the cell to map the severity of an impact event to a status value to be used in the computation of the associated service component's status. See also status-to-severity mapping table. slot An attribute in a BAROC class definition. A class definition consists of one or more slots. Each slot has a data type and can have specific attributes, called facets, that can control the values that the slot can have or other aspects of a class instance’s processing. A subclass inherits all the slots of the parent class. See also attribute.
184
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z slot facet See facet. SM See service model (SM). SNMP adapter An adapter that listens at a port for SNMP traps. It evaluates the traps and formats them based on the configured event mapping. If the event-mapping conditions are satisfied, it sends the event to the cell. Software Development Kit (SDK) A set of procedures and tools with which you can develop a type of application. source data The information that enters the BMC Impact Manager system from another entity and that will be transformed into an event in the system. statbld.conf file The configuration file for the StateBuilder utility. It is in the $MCELL_HOME/etc/ directory on Unix platforms and in the %MCELL_HOME%\etc\ directory on supported Windows platforms. statbld.trace file The configuration file that specifies the trace information to be collected for the StateBuilder utility and where it should be written. It is in the $MCELL_HOME/etc/ directory on Unix platforms and in the %MCELL_HOME%\etc\ directory on supported Windows platforms. state change event A generated event type that records changes in a component’s status. State change events never participate in component status computation. StateBuilder utility The utility, statbld.exe, that periodically consolidates the data in a cell’s transactions file (xact) and writes the “saved state” of the cell to the repository (mcdb). status 1. For events, an indication of the event’s management. Possible values are Open, Closed, Acknowledged, Assigned, and Blackout. 2. For service components, an indication of the relative availability of an IT resource. Possible values are OK, Unknown, Blackout, Information, Warning, Minor Impact, Impacted, and Unavailable. status-to-severity mapping table One of the two tables that relate event severity and component status. The status-to-severity map is used by the cell to map the main status of a component to the severity of a history event, logging a status change.
Glossary
185
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z status computation model A model that determines the status of a consumer service component when a change in the status of its provider service component occurs. status propagation The effect that a change in status of a provider component has on the status of its consumer components. STATUS_PROPAGATION table A dynamic data table that defines the different pairs of service component types whose instances can have a relationship and the status propagation model to be used for each relationship. store and forward A mechanism that ensures that if an event cannot reach its destination, it is saved in a file and sent when a viable connection to the destination becomes available. stored event An event that has been processed by the cell and stored in its event repository. Only stored events can be: returned by queries and displayed in BMC Impact Explorer, returned by the mquery CLI command, or referenced by the Using and Update clauses of an MRL rule. superclass A hierarchically superior event or data class. A class that is derived from another class inherits part of its attributes (slots) from its superclass. suppression 1. The intentional exclusion of an event or a type of event. 2. The type of policy that governs event suppression. syslog adapter An adapter that collects information from the log file generated by the Unix daemon syslogd. The syslog adapter reads syslogd events and formats and sends them to the cell.
T Take Ownership The event operation action that assigns the current user as the event’s owner, sets the event status as Assigned, and shows an entry of Taken in the operation history. target The entity designated to receive events from an adapter, an event generator, or a BMC Impact Manager instance. Also, a cell whose content currently is displayed in a BMC Impact Explorer dialog box.
186
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z threshold 1. In BMC Impact Manager, the point beyond which the value of a facet, slot, or other attribute can trigger an alert. 2. A type of policy. Threshold rule A rule the executes if the number of events exceeds the specified number within a particular timeframe. TIME_FRAME class A BAROC class that is a child of the base data class TIME_FRAME and that defines a type of timeframe. TIME_ZONE class A BAROC class that is a child of the base data class TIME_ZONE and that defines a type of time zone. timeframe The specification for the period during which an event management policy instance is in effect. Timer phase The event-processing phase in which Timer rules for the delayed execution of another rule type are evaluated. This phase spans the New, Abstract, Correlate, and Execute phases of event processing. Timer rule An event-processing rule that triggers the delayed execution of another type of rule. Timer trigger See Timer rule. tree See navigation tree view.
U unknown object An object whose status cannot be determined because of a connectivity failure. universal data identifier (mc_udid) A unique value used to identify a specific service component instance. Each service component must have a value for the mc_udid attribute (slot). One use of the universal data identifier is in associating aliases to a service component instance.
Glossary
187
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z unpublished component A service component that is currently part of the service model but that has not been published (distributed) to BMC Impact Manager instances. Update phase See New phase. Using clause An MRL rule clause that is used primarily to retrieve data instances for a dynamic rule, but can also be used to retrieve instances of past events. For details, see the BMC Impact Manager Knowledge Base Reference Guide.
W When clause A part of MRL rule syntax for Abstract, Correlate, Execute, Propagate, and Timer rules. Events must first meet the selection criteria in the rule before the When clause is evaluated. Changes to slot values cause When clauses to be re-evaluated. For details, see the BMC Impact Manager Knowledge Base Reference Guide. wildcard A type of pattern matching that uses the asterisk character (*) to represent any number of different characters, and the question mark character (?) to represent a single unknown character. See also regular expression.
188
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Index Symbols != 105 .baroc files 126 /usr/nc/Solutions, space needed 37
A AGCHostName property 41, 63, 86 AIX 37 alert selector category names Circuit 104 Equipment 104 Facility 104 LAN 104 Multipoint_Circuit 104 Service 104 Software 104 alert selector priority number 104 alert selector severity Clear 104 Critical 104 Informational 104 Major 104 Minor 104 Warning 104 alert severity mapping 88 alerts automatic recognition 31 DataSynchronized 33 regenerating .baroc files 126 selecting 31 selector syntax 104, 111 synchronization 32 alias mc_smc_alias slot 26 McSmcAliasMapping.cfg 26 Service Model Editor 29
B BAROC class generator 126 CEF and non-CEF compliant filters 24 description 24 enabling event classes 70
baroc files, generating 44, 64, 126 BEGIN/END blocks 104, 111 bidirectional event communication description 23, 31 BMC Atrium Configuration Management Database 23 BMC Impact Manager communication 84 encryption key 84 IP address 84 name 84 operating system 37 port number 84 remote host name 84 server 37 version 37 BMC Software, contacting 2 BMC_BSM default PATROL EM operator 43, 64 default PATROL EM supervisor name 87
C cause view, display 125 commands IIPEMINST 40, 61 IIPEMUNINST 75 mccomp 70 mcell 71 mkill 71 mposter 69, 71, 72 net stop 71 resUsage 123 set start 71 startPath 120 stopPath 121 compatibility matrix PATROL Enterprise Manager 36 configuration files ImpactIntegration.cfg 25 IMToPEMMapping.cfg 25 location 44, 65 LogicalIdMapping.cfg 93 McSmcAliasMapping.cfg 26 PEMSelector.cfg 26 configure
Index
189
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z systems settings 81 configuring multiple instances 73 connection disruption 131 failure, recovering 130 validating 123 creating SIM_NOTIFICATION_REGISTRY instance 71 customer support 3
D data consistency description 32 debug connection failure 130 continually disrupted connectivity 131 severe errors 131 default BMC_BSM 87 PATROL EM supervisor name 87 reconnection value 88 disable synchronization 87 display cause view 125 impact view 125 document, related 15 double quotes, in mapping 95
F failure, connection 130 filter paths changing after installation 126 format of LogicalIdMapping.cfg, checking 95
G gateway connection mcell.dir 67 procedure 67 Gateway.jserver property 25, 83, 84 generate .baroc files 126
H heartbeat feature 130 host name PATROL EM AGC process 86 PATROL EM Event Handler Daemon (EHD) 86 HP-UX, operating system requirements 37
I
E EHDHostName property 41, 62, 86 enable synchronization 87 encryption key BMC Impact Manager 84 ImpactIntegration.cfg 33 installation 47, 48 multiple instances 74 errors, log file 131 event association alias 32 mc_smc_alias slot 32 McSmcAliasMapping.cfg 32 service model components 32 event management description 22 with multiple instances 38, 73 events validate forwarding 125 examples basic mapping 94, 116 literal double quotes in mapping 95 reserved words in mapping 94 selecting alerts 105
190
specify multiple values for alertType 94, 116 executable files, location 44, 65
iipem.log 131 iipem_em_propagation.baroc 34, 69 iipem_sim_propagation.baroc 34, 69 impact view, display 125 ImpactIntegration.cfg encryption key 33 overview 25 ImpactIntegration.cfg properties PEMAlert 88 ImpactManager property 84 IMToPEMMapping.cfg overview 25 installation AGCHostName 41, 63 BMC_BSM 43, 64 default path 40 EHDHostName 41, 62 IIPEMINST script 40, 61 JRE 41, 62 multiple instances 38, 50 multiple instances, configuring 73 NetCmmnd 39 NetCmmnd Sybase password 42, 63 prerequisites 39 requirements 37 scripts, location 44, 65
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z steps 39 subdirectories 44, 65 Sybase System Administrator password 42, 63 system requirements 36 uninstalling 74 upgrade procedure 56 upgrading 38 verify successful 123 IP address BMC Impact Manager 84
J jServer default port number 46 defined 25 installation 46
L launching cause view 123 impact view 125 service view 123 location configuration files 44, 65 executable files 44, 65 installation scripts 44, 65 logs 45, 65 of subdirectories 44, 65 uninstallation scripts 44, 65 LogicalIdMapping.cfg file 93 LogicalIdMapping.cfg.example file 93 logs error 131 iipem.log 131 location 45, 65 severe errors 131
M mapping alert severity to event severity 88 example using literal double quotes 95 examples 94, 116 token values to mc_smc_id slots 93 mapping schemes BMC IM MCEvent severity to PATROL EM alert type and severity 27 BMC IM service model component state change event severity to PATROL EM alert type and severity 27 BMC IM slot names to PATROL EM CEF token names 27 editable 26 noneditable 28
PATROL EM alert severity to BMC IM MCEvent severity 27 PATROL EM CEF alerts to BMC IM PEM_EV slots 28 PATROL EM CEF tokens to BMC IM PEM_EV and and BMC IM MCEvent slots 28 PATROL EM non-CEF alerts to BMC IM MCEvent slots 28 MC event classes .baroc files 126 mc_smc_id slot mapping tokens to 93 mcell.conf 29 mcell.dir 29, 67, 77 McSmcAliasMapping.cfg event association 32 overview 26 replacement for LogicalIdMapping.cfg 56
N name, BMC Impact Manager 84 NetCmmnd 39, 76 NetCmmnd Sybase password 42, 63 troubleshooting 128 non-CEF tool types creating MC event classes for 126 NumSecsToTryReconnect property 88
O operating systems AIX 37 for BMC IM 37 for PATROL EM 37 HP-UX 37 Solaris 37
P PATROL Central Alerts AAD launching service view from 123 launching service views from 33 PATROL EM operating system 37 server 37 version 37 PATROL EM Active Alerts Display (AAD) window 23, 39 PATROL EM AGC, host name 86 PATROL EM supervisor name 86 PEMAlert properties 88 PEMSelector.cfg overview 26 PEMSelector.cfg file 106, 107, 108, 109 PEMSynchronization property 33, 87 PEMUserName property 86
Index
191
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z port number BMC Impact Manager 84 process description 29 product versions 37 product support 3 propagation default policies 34, 69 defining policy 68 description 23 event management policies 34 gateway connection 67 iipem_em_propagation.baroc 34, 69 iipem_sim_propagation.baroc 34, 69 loading policies 69 removing policies 76
Q quotes in mapping 95
R reconnection value, default 88 recover from failure 130 regenerate .baroc files 126 related documentation 15 remote host name, BMC Impact Manager 84 requirements /usr/nc/Solutions space 37 installation 36, 37 space 37 reserved words, in mapping 94 resUsage command 123 runEventClassFactory 127 run-time logs, location 45, 65
SMC_STATE_CHANGE events 71 smc_notification_register.baroc 71 software files, location 44, 65 Solaris 37 operating system requirements 37 space requirements 37 start, BMC II for PATROL EM 120 startPath command 120 stop, BMC II for PATROL EM 121 stopPath command 121 subdirectories bin 44, 65 conf 44, 65 files 44, 65 inst 44, 65 lib 44, 65 log 45, 65 setup 45, 65 transformer 45, 65 supervisor name PATROL EM 86 support, customer 3 Sybase System Administrator password 42, 63, 76 synchronization description 32 disable 87 enable 87 system architecture 29 system settings, configure 81
T technical support 3 token values mapping 93 toolID 25 toolType 25
S
U
selector syntax 104 selector syntax options categoryName 104 severityName 104 server BMC Impact Manager 37 PATROL EM 37 service impact management description 23 McSmcAliasMapping.cfg 26 with multiple instances 38, 73 service view, launching from PATROL Central Alerts 123 SIM_NOTIFICATION_REGISTRY creating 71 deleting 72 smc_notification_register.baroc 71
uninstalling BMC II for PATROL EM cleanup steps 76 IIPEMUNINST 75 multiple instances 75 procedure 75 shared path definition 75 upgrading to current version 56
192
V validate BMC II for PATROL EM is running 123 forwarding events 125
BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide
Notes
*60557* *60557* *60557* *60557* *60557*
