Professional Documents
Culture Documents
Supporting
BMC Impact Integration version 7.3.60 for PATROL
December 2010
www.bmc.com
Copyright 2006, 2009-2010 BMC Software, Inc. BMC, BMC Software, and the BMC Software logo are the exclusive properties of BMC Software, Inc., are registered with the U.S. Patent and Trademark Office, and may be registered or pending registration in other countries. All other BMC trademarks, service marks, and logos may be registered or pending registration in the U.S. or in other countries. All other trademarks or registered trademarks are the property of their respective owners. AIX and IBM are the trademarks or registered trademarks of International Business Machines Corporation in the United States, other countries, or both. IT Infrastructure Library is a registered trademark of the Office of Government Commerce and is used here by BMC Software, Inc., under license from and with the permission of OGC. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners. UNIX is the registered trademark of The Open Group in the US and other countries. Linux is the registered trademark of Linus Torvalds. The information included in this documentation is the proprietary and confidential information of BMC Software, Inc., its affiliates, or licensors. Your use of this information is subject to the terms and conditions of the applicable End User License agreement for the product and to the proprietary and restricted rights notices included in the product documentation.
Customer support
You can obtain technical support by using the BMC Software Customer Support website or by contacting Customer Support by telephone or e-mail. To expedite your inquiry, see Before contacting BMC.
Support website
You can obtain technical support from BMC 24 hours a day, 7 days a week at http://www.bmc.com/support. From this website, you can
I I I I I I I I
read overviews about support services and programs that BMC offers find the most current information about BMC products search a database for issues similar to yours and possible solutions order or download product documentation download products and maintenance report an issue or ask a question subscribe to receive proactive e-mail alerts when new product notices are released find worldwide BMC support center locations and contact information, including e-mail addresses, fax numbers, and telephone numbers
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
I I I
sequence of events leading to the issue 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
Send an e-mail message to customer_support@bmc.com. Use the Customer Support website at http://www.bmc.com/support.
Contents
Chapter 1 Introduction to BMC Impact Integration for PATROL 11 12 12 12 13 14 17 19 20 20 20 21 21 22 25 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . BMC II for PATROL architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Events and BMC II for PATROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Example environment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Components included with BMC II for PATROL . . . . . . . . . . . . . . . . . . . . . . . . . . Related documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Chapter 2 Planning
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Prerequisite products and components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Operating system requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Security requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installation location variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installation planning worksheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Chapter 3 Installation
Getting started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Overview of installing BMC II for PATROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Installing BMC II for PATROL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Installing BMC Impact Integration for PATROL on UNIX where Impact Manager is already installed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Launching the common installer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Post-installation instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Verifying the CC_HOME variable setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Completing the installation on UNIX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 Files installed with BMC II for PATROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 Uninstalling BMC II for PATROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 Chapter 4 Configuration 39 40 40 41 42 43 46 46
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring BMC II for PATROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Default configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Custom configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Defining a management profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PATROL events that are suppressed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Modifying the client configuration file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents
Setting event filtering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 Configuring and using startup options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 Updating the mcell.dir file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 Configuring the high-availability feature. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 Instance name and configuration settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 Updating Knowledge Base files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 Configuration files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 Chapter 5 Startup and validation 73
Command line arguments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 Starting BMC II for PATROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 Stopping BMC II for PATROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 Validating correct functioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 Monitoring event load. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 Monitoring PATROL collectors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 Chapter 6 Event handling 81
About PATROL 7 event mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82 Additional information for the PATROL KM for event management. . . . . . . . . . 84 Event class slots inherited from the BMC Impact Manager event class . . . . . . . . 85 BMC II for PATROL events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 Event files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 Chapter 7 Troubleshooting 89
Console Server authentication fails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 imServer does not start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 BII4Patrol terminated at startup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 Console Server not started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 Cannot access the management profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 Unable to start BMC II for PATROL as a service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 Installation fails. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 Missing cell entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 Appendix A Configuration file parameters Appendix B BMC Impact Manager rules for PATROL events 95 103
BMC Impact Manager rules for PATROL events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 PATROL state changes and BMC Impact Manager rules . . . . . . . . . . . . . . . . . . . 104 PATROL recovery actions and BMC Impact Manager rules. . . . . . . . . . . . . . . . . 105 PATROL Agent status and BMC Impact Manager rules . . . . . . . . . . . . . . . . . . . . 105 PATROL duplicate events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 Event processing and the PATROL KM for event management . . . . . . . . . . . . . 106 Glossary Index 109 125
Figures
Example of event flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Configuration file relationships . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 Event catalog definition format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 Example bii4p_start.opts file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 Example mcell.dir scenario 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 Example mcell.dir scenario 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 BMC Impact Manager definition format for a remote BMC II for PATROL instance . 66
Figures
Tables
Required software and versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . BMC II for PATROL supported platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Common Connect configuration utility supported platforms . . . . . . . . . . . . . . . . . . . Installation steps by window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Essential files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuration tasks when BMC II for PATROL is installed with BMC Impact Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuration tasks when BMC II for PATROL is separate from BMC Impact Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Startup options defined in bii4p_start.opts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Slot values for the refreshAgentState event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Post-installation variable locations and definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . Command line arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . BMC Impact Manager event class slots for PATROL 7 managed systems . . . . . . . . Event status enumeration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Event severity mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PATROL KM for event management slots in the PATROL_EV event class . . . . . . . BMC Impact Manager slots inherited by the BMC II for PATROL event class . . . . . Events generated by BMC II for PATROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . bii4p.conf file parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 20 21 30 35 41 42 52 60 71 74 82 83 83 84 85 87 96
Tables
10
Chapter
1
12 12 12 13 14 17
This chapter presents the following topics: Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . BMC II for PATROL architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Events and BMC II for PATROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Example environment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Components included with BMC II for PATROL . . . . . . . . . . . . . . . . . . . . . . . . . . Related documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
11
Overview
Overview
BMC Impact Integration for PATROL (BMC II for PATROL) transfers event information generated from PATROL Agents to a BMC Impact Manager. The event information is processed by the event processing engine, called a cell, that resides within the BMC IM instance. BMC II for PATROL uses persistent buffering so that no information is lost, either in obtaining event information from PATROL Agents or in sending the filtered and adapted event information to a cell. BMC II for PATROL works with the following components:
I I I I
BMC Impact Manager PATROL Agents running any PATROL Knowledge Module PATROL Console Server and RTserver Management Profile (through the Common Connect configuration utility)
12
If you restart BMC II for PATROL, the current status of parameters across all PATROL Agents is fetched and the current status of all parameters is sent as PATROL events to the BMC Impact Manager. When integration is functional and the PATROL Agent is restarted, the BMC II for PATROL fetches the current status of all parameters for that particular PATROL Agent. The current status of parameters is then sent as PATROL event to BMC Impact Manager.
Example environment
Figure 1 illustrates how event information flows from PATROL Agents to BMC IX consoles in an environment using BMC II for PATROL. Figure 1 Example of event flow
1. Events are received by PATROL Agents through PATROL Knowledge Modules. 2. Events are communicated through the PATROL Console Server using Common Connect components. 3. Events are passed to the BMC Impact Manager through BMC II for PATROL. 4. Events can be viewed with BMC Impact Explorer.
13
BMC Impact Integration for PATROL executable Common Connect configuration utility Common Connect Back End Client Runtime Configuration and setup files
close alarm events when the alarm has been cancelled in PATROL update or create alarms with enhanced information from PATROL KM for Event Management sources automatically drop duplicate events
The bii4p_collectors.mrl is a rule file for creating collectors. Collectors are required for displaying the event information obtained from PATROL Agents, adapted and sent to a BMC IM, in a BMC IX console. All files with a .baroc extension are files that contain event class definitions and the slot definitions for each class. Such files also reside in the cells Knowledge Base (KB). The bii4p.baroc file contains the PATROL_EV event class and the slot definitions that are used in adapting event information obtained from a PATROL Agent source into the format that a cell can understand and process.
14
A Common Connect client managed system is any third-party vendor application or any non-PATROL BMC Software product that has been specially programmed to integrate with the PATROL 7 environment. A properly integrated Common Connect client is able to share event information with other Common Connect clients and with managed PATROL systems. Examples of Common Connect clients include
I I I
PATROL Integration for HP OpenView Network Node Manager 7.x PATROL Enterprise Manager Console Server Connection 7.x BMC Impact Integration for PATROL 7.x
You can install the Common Connect configuration utility on any supported Oracle Solaris or Microsoft Windows system.
Client Runtime
The Client Runtime component is required on systems that do not have the PATROL Console Server. After you install the Client Runtime component, the following subdirectories are created under the installation directory:
I I I I I
15
Management profile
The management profile is a user-defined view of PATROL and Common Connect objects and contains the managed systems, KM packages, and specified event filters that you are currently monitoring. BMC II for PATROL uses the information in the management profile to monitor the specified computer systems and to receive and send event data from them. You use the Common Connect configuration utility to create and edit the management profile that the BMC II for PATROL product requires. The utility allows you to create management profiles that include PATROL Agent managed systems, to load PATROL KMs, and to specify event filters. For more details, refer to Common Connect Configuration utility help menu.
16
Related documentation
Related documentation
For additional information about BMC II for PATROL, see the BMC Impact Integration for PATROL Release Notes. For additional information about PATROL, see the following documentation:
I I I I I I
PATROL Console Server and RTserver Getting Started Guide PATROL Security User Guide PATROL Knowledge Module for Event Management User Guide PATROL for Microsoft Windows Servers Release Notes PATROL KM for Event Management online Help PATROL Agent Reference Manual
For additional information about BMC Impact Solutions products, see the following documentation:
I I I I I
I I I I I I I I
BMC Impact Manager Installation Guide BMC Impact Manager System Configuration and Maintenance Guide BMC Impact Event Adapters Installation and Configuration Guide BMC Impact Integration for Remedy AR System Installation and Configuration Guide BMC Impact Integration for PATROL Enterprise Manager Installation and Configuration Guide BMC Impact Event Management Guide BMC Impact Manager Knowledge Base Reference Guide Building a Service Model BMC Impact Explorer User Guide BMC Impact Integration Developers Kit Web Services Developer Guide BMC Impact Integration Developers Kit Web Services API Reference Guide BMC Impact Integration Developers Kit Basic C APIs Developer Guide BMC Impact Integration Developers Kit C APIs Reference Guide
To view the complete BMC documentation library, visit the support page on the BMC Software Web site at http://www.bmc.com/support. Log on and select a product to access the related documentation. The complete BMC Impact Solutions documentation library is available on the BMC Impact Solutions Documentation CD that is included with major releases of BMC Impact Manager.
17
Related documentation
18
Chapter
2
20 20 20 21 21 22
Planning
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Prerequisite products and components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Operating system requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Security requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installation location variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installation planning worksheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 2
Planning
19
Overview
Overview
This chapter provides information about the requirements and computing environment conditions that you should consider as you plan to install BMC II for PATROL. In addition to the detailed information, this chapter includes a worksheet that you can use for planning the installation at your site.
PATROL Console Server on either a Microsoft version 7.6.x or later Windows or Solaris system SmartSockets RTserver on either a Microsoft Windows or Solaris system PATROL Agent version 6.8.x or later The RTserver can be installed under any account. all supported versions The PATROL Agent must be installed and running on each PATROL managed system that you want to monitor. web browser
I I
BMC II for PATROL is installed using the PATROL common installation utility, which requires a web browser.
Operating system
Oracle Solaris Red Hat Enterprise Linux Microsoft Windows 2003, 2008, 2008 R2
20
The Common Connect configuration utility supports the operating systems listed in Table 3. Table 3 Common Connect configuration utility supported platforms
Memory 0.5 GB 0.5 GB 0.5 GB 0.5 GB 0.5 GB
Operating system Microsoft Windows Servere 2003, x86 Microsoft Windows Server 2008, x86 Oracle Solaris 9, 32-bit, SPARC Oracle Solaris 9, 64-bit, SPARC Oracle Solaris 10, 64-bit, SPARC
Security requirements
BMC II for PATROL, the PATROL Agent, the PATROL Console Server, and the Client Runtime component must operate at the same security level to communicate with each other. Check the security level of previously installed components and be sure to install BMC II for PATROL components at the same level. Refer to the PATROL Security User Guide for information about checking security levels and for setting up security in a PATROL environment.
NOTE
If you do not specify a security level during the installation of BMC II for PATROL, the product components will use security level 0.
Chapter 2
Planning
21
22
Information item or requirement Do you plan to install BMC II for PATROL on a UNIX system? If so, you must provide the root account login and password for that system during installation. What is the name of the BMC IM that you want to connect to? What is the name of the host on which the BMC IM is running? About the PATROL Console Server What is the default PATROL Console Server ID? See Table 8 on page 52. Which operating system is running on that computer? See Table 2 on page 20. Is the Common Connect Back End installed on that computer (must reside on the same machine with the PATROL Console Server)? What account did you use when you installed the PATROL Console Server? If you are installing BMC II for PATROL on a UNIX computer, what is the root account and password? What security level are you using with the PATROL Console Server? If you used a security levels higher than 0, you must perform a custom installation in order to use the same security level. Reminder: BMC II for PATROL, the PATROL Agent, the PATROL Console Server, and the Client Runtime component must operate at the same security level. About the RTserver What is the host name of the computer on which the RTserver is installed and what is the port number through which it connects? See Table 8 on page 52.
Response
Notes
Chapter 2
Planning
23
Information item or requirement About PATROL Agents and Event Sources What are the names of the PATROL Agents from which you want to receive events? See Defining a management profile on page 43 of the Configuration chapter.
Response
Notes
24
Chapter
3
26 27 28 33 33 34 35 36
Installation
This chapter presents the following topics: Getting started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Overview of installing BMC II for PATROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installing BMC II for PATROL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Post-installation instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Verifying the CC_HOME variable setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Completing the installation on UNIX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Files installed with BMC II for PATROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Uninstalling BMC II for PATROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 3
Installation
25
Getting started
Getting started
This section contains high-level steps for installing and configuring BMC II for PATROL. Use these steps if all other elements (BMC Impact Manager and PATROL) are already installed, the BMC Impact Manager and BMC II for PATROL will be installed on the same server, and you are installing and configuring to a local cell. Detailed installation and configuration instructions are provided in the rest of this chapter and in Chapter 4, Configuration. 1. From the downloaded image, run the setup program. 2. In the Welcome to the Installation Utility, click Next. 3. Review the license agreement, select Accept, and click Next. 4. In the Select Installation Option window, accept the default selection and click Next. 5. In the Select Type of Installation window, select Typical and click Next. 6. In the Specify Installation Directory window, verify that the installation directory is correct and click Next. 7. In the Select System Roles window, verify that the selected roles are correct and click Next. 8. In the Select Products and Components to Install window, select the desired options and click Next. 9. If the Runtime Warning window is displayed, click Next.
NOTE
This warning is displayed if you have a Console Server already installed on the host. Do not install the Client Runtime component if you have the Console Server installed.
10. (UNIX only) If the Provide the System Root Account Properties window is displayed, enter the Root login name and password and click Next. 11. If the Enter the Default Client Login and Password window is displayed, enter the login name that is used for the PATROL Console Server. 12. Enter and confirm the password for the login name and click Next.
26
13. In the Impact Integration Configuration Properties window, enter values for the Enter MCELL_HOME directory, Impact Manager Name, PATROL Console Server ID, and RTServer identify fields and click Next. 14. If the RTSERVERS Variable Properties window is displayed, click Next. 15. In the Review Selections and Install window, verify the product and component selections and click Start Install. 16. When the status window reports that the installation is 100% complete, click Next. Then click Finish to close the installation utility, and click Yes in the two Close Window dialog boxes. 17. (Windows only) Restart the host. 18. Create the management profile. 19. Update the bii4p_start.opts file to add the -mprofile value. 20. Verify that the mcell.dir file is correct. Now you are ready to run BMC II for PATROL.
I I I
Specify the installation directory Choose the BMC II for PATROL components that you want to install Enter the default login and password used by BMC II for PATROL, which may be the same login and password used by the PATROL Console Server Specify the root password on UNIX machines Configure security settings Perform post-installation file configuration
Chapter 3
Installation
27
Review the installation checklist on page 22. Stop the PATROL Console Server.
NOTE
You must stop the PATROL Console Server before beginning the installation of Common Connect Backend or the installation will fail. Restart the PATROL Console Server when the installation is complete.
Close the Common Connect utility if it is open. (On UNIX) Set the MCELL_HOME variable before starting the installation process.
Installing BMC Impact Integration for PATROL on UNIX where Impact Manager is already installed
If you have not set the write permissions of the mcell.dir file of Impact Manager and you install BMC II for PATROL on a UNIX system that has Impact Manager installed, BMC II for PATROL installation can fail. The mcell.dir file has write permissions only for a root user. Impact Manager is installed with the root account. Therefore, the owner of the file is root. BMC II for PATROL uses the default PATROL account or non-root account (depending upon the account with which BMC II for PATROL has been installed) to access the mcell.dir file of Impact Manager. Because the PATROL default account (or non-root) is not the root account, BMC II for PATROL tries to change the owner of the mcell.dir file, however, it fails. To overcome this issue, you need to explicitly grant write permissions to $MCELL_HOME/etc/mcell.dir, and change the ownership of the mcell.dir file to your default PATROL account or non-root account (depending upon the installation). This ensures that the BMC II for PATROL installation is successful.
28
To launch the common installer 1 From the installation image that has been electronically downloaded and
extracted, or from the product CD, select one of the following options to start the installation utility:
I I I
(Windows) Run setup.exe. (UNIX) Run ./setup.sh. (UNIX without a browser) Perform the following steps to launch the installation utility: A. From a command line, change to the directory where the installation utility is located and enter the following command to start the installation Web server:
./setup.sh -serveronly
A message box is displayed that shows the URL to use to connect to the installation Web server. B. On another computer with a browser, start the browser. C. Connect to the installation Web server from the browser to start the installation utility by using the URL that is displayed in the message box on the computer on which you are installing the product.
2 In the Welcome to the Installation Utility window, click Next to begin your
installation.
3 Review the license agreement, select Accept and click Next to continue. 4 Use Table 4 to help you complete the installation of BMC II for PATROL and
Common Connect components. Depending on the installation type and options you select, you may not see all of the listed windows, and you may not see them in the same order listed here. Click Next when you complete your entries and selections on a window.
Chapter 3
Installation
29
Table 4
Window
Select Installation Option Select the I want to install products on this computer now option and click Next. Select Type of Installation Perform one of the following actions:
I I
Select Typical if you want to keep the default security settings. Select Custom if you want to configure the security settings when the Client Runtime option is selected.
Perform the action that is appropriate for the products or components that you are installing:
I
To install the Common Connect Back End, install on systems which contain the PATROL Console Server. Enter the directory under which the existing PATROL Console Server is installed, if it is not displayed. To install the Common Connect configuration utility, install on Windows or Solaris systems which contain the Console Server or the Client Runtime libraries. Enter the directory in which you want to install the utility or accept the default location. To install the BMC Impact Integration for PATROL, install on systems which contain Console Server or the Client Runtime libraries. Enter the directory in which you want to install the product or accept the default location. To install the Client Runtime (Common Files), install on systems which do not contain the PATROL Console Server. Enter the directory in which you want to install the product or accept the default location. Remember that if the target system is the PATROL Console Server, do not install the Client Runtime. Note: For first-time installations of the Client Runtime, the default installation directory is C:\Program Files\BMC Software on Microsoft Windows and /opt/bmc on UNIX.
The installation process adds new subdirectories below the specified installation directory. Select System Roles
I
Select Common Services if you are only installing Common Connect components on the same system where the PATROL Console Server is installed. Select Integration Clients if you are only installing BMC II for PATROL or the Client Runtime on a system which does not have the PATROL Console Server. Select both Common Services and Integration Clients if you want to install BMC II for PATROL and Common Connect components on a system that has the PATROL Console Server.
30
Table 4
Window
To install the Client Runtime (Common Files) on systems which do not contain the PATROL Console Server, expand Client Runtime Components and select Client Runtime (Common Files). A warning dialog box is displayed, describing when you should or should not install the Client Runtime component. Review the warning and then click Next to continue. To install the Common Connect Back End on systems which contain the PATROL Console Server, expand Common Connect and select Common Connect Back End. Expand Common Connect Back End and select BMC Impact Integration Client Definitions (MOF). Click Next to continue. To install the Configuration Utility on systems which contain either the PATROL Console Server or Client Runtime, expand Common Connect and select Configuration Utility - Java Edition. Click Next to continue. To install BMC II for PATROL on any supported platform, expand Integration Clients and select BMC Impact Integration for PATROL. Click Next to continue.
Verify that you want to install the Client Runtime component on the host. If you do not, click Back to return to the previous window and deselect this option. Select a level of security based on information in the PATROL Security User Guide. Indicate whether you are overwriting the current security configurations, and then click Next. Perform the following actions:
I I I
In the Root Login Name field, enter root. In the Root Login Password field, enter the root password. In the Re-enter the Root Login Password field, enter the root password again to confirm it.
Click Next to continue. Enter the Default Client Login and Password Enter the following logon and password information:
I
In the Default Client Login field, enter the login name that is used for the PATROL Console Server. Do not enter the domain name. In the Default Client Password and the Re-enter the Default Client Password fields, enter the password that corresponds with the login name for the PATROL Console Server.
Chapter 3
Installation
31
Table 4
Window
If Impact Manager is installed on the same machine, then enter the path to the Impact Manager Home directory. It should be value of environment variable %MCELL_HOME% on Windows or $MCELL_HOME on Unix. If the server where BII4Patrol7 is being installed, does not contain an Impact Manager, enter the path used for Common_Connect.
I
Microsoft Windows: %BMC_ROOT%\Common_Connect where %BMC_ROOT% is the root directory on Windows. For example, if the root directory is D:\Program Files\BMC Software, the path will be: D:\Program Files\BMC Software\Common_Connect.
Unix: $BMC_ROOT\Common_Connect where $BMC_ROOT is the root directory on Unix. For example, if the root directory is /opt/bmc, the path will be: /opt/bmc/Common_Connect.
In the Impact Manager Name field, enter the name of the Impact Manager to which you will connect. Note: If the Impact Manager name you enter does not exist, your installation will finish, but the Impact Manager knowledgebase file will not be updated.
I I
In the PATROL Console Server ID field, enter the ID of the Console Server. In the RTServer identify field, enter the RTServer name and port.
To complete the installation of the products and components 1 In the Review Selections and Install window, verify the product and component
selections.
32
Post-installation instructions
4 You can view the installation log file or click Finish to exit the installation utility. TIP
When the installation is finished, record the location of the log file that is displayed in case you need to troubleshoot an installation issue.
Post-installation instructions
After you install BMC II for PATROL, complete the following sections, if applicable for your environment.
I I
Verifying the CC_HOME variable setting on page 33 Completing the installation on UNIX on page 34
To check the CC_HOME setting on a UNIX system 1 At a command prompt, enter echo CC_HOME and press Enter. 2 Verify that the CC_HOME variable is defined as
Installation_directory/Common_Connect.
If the CC_HOME variable is not defined as Installation_directory/Common_Connect, continue to To set the CC_HOME variable on UNIX on page 34.
Chapter 3
Installation
33
Post-installation instructions
To set the CC_HOME variable on windows 1 Open the Control Panel and double-click the System icon. 2 On the System Properties dialog box, click the Advanced tab. 3 Click Environment Variables. 4 On the Environment Variables dialog box, click New in the System variables box. 5 On the New System Variable dialog box, enter CC_HOME as the variable name
and set its value.
6 Click OK. 7 Click OK to close the Environment Variables dialog box. 8 Click OK to close the System Properties dialog box.
installationDirectory/common/bmc installationDirectory/Common_Connect/bin/target/
From the installationDirectory/common/bmc directory, depending on the shell you are using, enter one of the following commands: C shell: run source ./patrol7rc.csh Bourne shell: run . ./patrol7rc.sh
34
Essential files
Function the BMC II for PATROL executable contains trace parameters, buffer management parameters, and the BMC IM directory contains the mapping information to translate PATROL LEM events to BMC Impact Manager events library files for the BMC II for PATROL API catalog files for BMC II for PATROL sets the level of trace messages and configures the trace level BMC Impact Manager Knowledge Base (KB) files
Common Connect Back End library files Common Connect Back End catalog files configuration file to set the startup options for BMC II for PATROL sets the environment variables for BMC II for PATROL configuration file to set up the connection between BMC II for PATROL and IM cell enables you to start a BMC II for PATROL instance (automatically sets the required environment variables) stops all the running BMC II for PATROL instances
Chapter 3
Installation
35
To uninstall from a Microsoft Windows system 1 Log on with an account that has administrative privileges or with the account that
was used to install BMC II for PATROL.
2 If you are running BMC II for PATROL as a service, enter BII4Patrol -remove at a
command line prompt.
3 From the Microsoft Windows desktop, choose Start => Settings => Control Panel to
open the Control Panel window.
5 From the list of available programs, select BMC Software Tools and click
Change/Remove.
6 Click Next to navigate the windows until you reach the Select Products and
Components to Uninstall window.
7 Choose the components to uninstall and click Next. 8 In the Review Selections and Uninstall window, click Start Uninstall. 9 When the uninstallation is complete, click Next. 10 You can view the log file or click Finish to exit the utility. TIP
Record the location of the log file in case you need to troubleshoot an uninstallation issue.
36
To uninstall from a UNIX system 1 Log in under the account that you used to install the components. 2 In a terminal window, change directory to the Uninstall subdirectory, which is
found under your installation directory.
4 Click Next to navigate the windows until you reach the Select Products and
Components to Uninstall window.
5 Choose the components to uninstall and click Next. 6 In the Review Selections and Uninstall window, click Start Uninstall. 7 When the uninstallation is complete, click Next. 8 You can view the log file or click Finish to exit the utility. TIP
Record the location of the log file in case you need to troubleshoot an uninstallation issue.
Chapter 3
Installation
37
38
Chapter
4
40 40 41 42 43 46 46 50 51 63 66 67 69 70
Configuration
This chapter presents the following topics: Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring BMC II for PATROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Default configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Custom configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Defining a management profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PATROL events that are suppressed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Modifying the client configuration file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting event filtering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring and using startup options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Updating the mcell.dir file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring the high-availability feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Instance name and configuration settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Updating Knowledge Base files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuration files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 4 Configuration
39
Overview
Overview
The following diagram shows the relationships among the management profile, the PATROL Console Server, and BMC II for PATROL. Figure 2 Configuration file relationships
1. The user defines PATROL managed systems, PATROL KMs, and event filters in the management profile through the Common Connect configuration utility. 2. This file may optionally be modified to allow or prevent the passage of certain events. 3. BMC II for PATROL connects to the PATROL Console Server. 4. The PATROL Console Server uses information from the management profile to connect to managed systems (PATROL Agents). 5. Events from the PATROL Agent are sent to the PATROL Console Server 6. The PATROL Console Server forwards events to BMC II for PATROL.
NOTE
The Common Connect configuration utility connects to an RTserver and a PATROL Console Server and lets you share information among the BMC Impact Manager, PATROL Agent managed systems, and third party (or non-PATROL) systems. You launch and use the Common Connect configuration utility independently of BMC II for PATROL.
40
Default configuration
Table 6 contains a checklist that summarizes the configuration procedures which you need to complete to configure BMC II for PATROL when it is installed on the same system as BMC Impact Manager. This type of configuration is referred to as a default configuration. During installation, you entered information that the auto-configuration process uses to set the default configuration for running BMC II for PATROL. The default configuration includes
I I I I
updating the bii4p.conf file updating the mcell.dir file updating the bii4p_start.opts file updating the knowledge base (KB) for the local default cell
If you use the default configuration, you need to complete the following tasks:
I I
create a management profile (see page 43). update the bii4p_start.opts file (see page 51).
Use this checklist to preview the tasks to complete and to verify their completion. Table 6
Setup
Configuration tasks when BMC II for PATROL is installed with BMC Impact Manager
Task See System A containing BMC II for PATROL and BMC Impact Manager(s)
I
Create a management profile Configure startup options in bii4p_start.opts. (optional) Update the bii4p.conf file. (optional) Update the mcell.dir files (optional) Update the BMC Impact Manager Knowledge Base files.
Defining a management profile on page 43 Configuring and using startup options on page 51 Configuration files on page 70 Updating the mcell.dir file on page 63 Updating Knowledge Base files on page 69
Chapter 4 Configuration
41
Custom configuration
Table 7 contains a checklist that summarizes the configuration procedures which you need to complete to configure BMC II for PATROL when it is installed on a different system from the BMC Impact Manager. This type of configuration is referred to as a custom configuration. In a custom configuration, you can overwrite the default configuration entries you made during installation by editing some settings to complete the installation. These changes include
I
creating a management profile and editing the bii4p_start.opts file to add the management profile name as the -mprofile value. updating the mcell.dir file on both the host IM is running and the host BMC II for PATROL is running (see Updating the mcell.dir file on page 63) updating the CC_HOME/etc/bii4p_start.opts file to define the following values: -cell -cserver -rtserver updating the knowledge base (KB) for the default cell copy the bii4p.baroc, bii4p_collectors.mrl, and bii4p.mrl files to the appropriate locations update the .load files under the classes, collectors, and rules directories to add an entry for bii4p and comment out mcxp recompile the KBs
Table 7
Setup
Configuration tasks when BMC II for PATROL is separate from BMC Impact Manager
Tasks System A containing BMC II for PATROL
I
See
Create a management profile Configure startup options in bii4p_start.opts. (optional) Update the bii4p.conf file. Update the mcell.dir file.
Defining a management profile on page 43 Configuring and using startup options on page 51 Configuration files on page 70 Updating the mcell.dir file on page 63
42
Table 7
Setup
Configuration tasks when BMC II for PATROL is separate from BMC Impact Manager
Tasks See System B containing one or more BMC Impact Manager(s)
I
Update the mcell.dir file. Update the BMC Impact Manager Knowledge Base files
Updating the mcell.dir file on page 63 Updating Knowledge Base files on page 69
In Microsoft Windows, you can launch the utility from Microsoft Windows Explorer or from the command line at an MS-DOS command prompt. In Microsoft Windows Explorer, go to the CC_HOME\bin\Windows-x86 directory, and double-click configstart.bat. At the MS-DOS command prompt window, change directory to CC_HOME\bin\Windows-x86, enter configstart.bat, and then press Enter.
For Solaris, change directory to CC_HOME/bin/platform_operating_system, and locate the configstart.sh file. From the specified path, enter ./configstart.sh and press Enter.
Chapter 4 Configuration
43
To define a management profile 1 In the configuration utility, choose the File => Connect menu command to open the
Configuration Wizard.
2 Click Next.
The Connect to RTservers window is displayed.
3 Select the appropriate RTserver from the list or enter a new one, and click Next.
The Select Common Connect Service window is displayed.
NOTE
The PATROL Console Server (with Common Connect Back End) is referred to as the Common Connect Service on this wizard window.
4 In Service Name, select the name of the PATROL Console Server and click Next.
The Provide User Credentials window is displayed.
5 Perform the following actions to specify the account under which you installed the
PATROL Console Server: A. In the User Name field, enter the user name for the PATROL Console Server. B. In the Password field, enter the password used by the PATROL Console Server. C. Click Next. The Select Configuration window is displayed.
WARNING
If you enter an incorrect user name or password, the configuration utility hangs, and you must restart it.
7 Enter a name for the new management profile or select one from the list, and click
Next.
44
8 Click Finish.
Continue to To add managed systems to the management profile.
To add managed systems to the management profile 1 In the Common Configuration utility, right-click Managed PATROL Systems. 2 Choose the Add New menu command.
The Managed PATROL System Discovery window is displayed, showing managed PATROL systems residing in the same RTserver cloud.
3 Select the managed PATROL systems you want to monitor and click Next.
The Add Managed Systems Wizard Complete window is displayed.
4 Click Finish.
Continue to To add PATROL Knowledge Modules to the management profile.
To add PATROL Knowledge Modules to the management profile 1 In the Common Connect configuration utility, right-click either Managed PATROL
Systems or the managed PATROL system you want to add PATROL KMs to.
3 Select the PATROL KMs and KM packages that you want to load and click Next.
The Load KM Packages Wizard Complete dialog box is displayed.
4 Click Finish.
Proceed to Setting event filtering on page 50. For additional instructions on defining a management profile, refer to the Common Connect configuration utility online Help. You can also use the Common Connect configuration utility online Help for additional instructions on adding PATROL managed systems and Knowledge Modules.
Chapter 4 Configuration
45
AS_EVENTSPRING:NOTIFY Notify events from the Event Management KM _EVENT 7 A successful connection to the PATROL Agent by a user
To activate these events, you must reconfigure the Common Connect client configuration file. See Modifying the client configuration file on page 46. For more information about PATROL standard event classes, see the PATROL Agent Reference Manual.
NOTE
The Alert event come first but it is immediately closed by the UpdParState event. This behavior is as expected with BMC II for PATROL architecture and the event can be suppressed. For more information about surpressed events, refer to Suppressing events on page 47.
46
This procedure is not required. Modify the client configuration file only if you want to activate or suppress events.
WARNING
You must use the Common Connect configuration utility to define, edit, and save a client configuration file. Do not attempt to edit a configuration file through a text editor.
Suppressing events
You can define any event catalog and class to suppress events using the format shown in Figure 3. Figure 3 Event catalog definition format
catalog;class
To define a client configuration file 1 Start the Common Connect configuration utility by using the instructions in
Starting the Common Connect configuration utility on page 43.
2 Choose the File => Connect menu command to open the Configuration Wizard.
Chapter 4 Configuration 47
3 Click Next.
The Connect to RTserver(s) dialog box is displayed.
4 Perform one of the following actions to specify the RTserver to which you want to
connect:
I
Click Next to accept the default RTserver name. In the RTserver Name(s) list, change the name of the system on which the RTserver is installed and the port number through which it connects, then click
Next.
NOTE
The PATROL Console Server (with Common Connect Back End) is referred to as the Common Connect Service on this wizard dialog box.
5 In the Service Name list, select the name of the PATROL Console Server and click
Next.
6 Perform the following actions to specify the account under which you installed the
PATROL Console Server: A. In the User Name field, enter the user name. B. In the Password field, enter the password. C. Click Next. The Select Configuration dialog box is displayed.
WARNING
If you enter an incorrect user name or password, the configuration utility hangs, and you must restart it.
7 Select the Modify client configuration file option and click Next.
The Select Common Connect Client dialog box is displayed.
8 In the Common Connect Client pane, select the BII4Patrol option and click Next.
48
NOTE
If BII4Patrol is not displayed, check to be sure that you restarted the PATROL Console Server after installing the Common Connect Back End.
9 Perform the following actions: A In Client Attribute Configuration File field, enter a new file name. B Click Next.
The Edit Client Attributes dialog box is displayed.
10 On the Edit Client Attributes dialog box, select Config_BII4Patrol from the list. 11 Double-click the slot under Value.
A list of suppressed events is displayed.
WARNING
After you make changes to this file, you must move the cursor to a different line or press Enter to save your changes.
Microsoft Windows:
%PATROL_ROOT%\log\cserver\cc_client_config\
NOTE
If you are using your own event suppress list, use the Client Configuration File name in the -cfgid parameter in the bii4p_start.opts file.
Chapter 4 Configuration
49
For more information about event filtering see the Common Connect configuration utility online Help.
50
Query filtering
The Query Filter button in the tool bar is not used with BMC II for PATROL.
NOTE
The bii4p_start.opts file is located at CC_HOME\etc.
Interdependencies across different components can be avoided Configuration of the file is simple
WARNING
Entries in the bii4p_start.opts file are case-sensitive for both Windows and UNIX. Ensure that entries (as well as default values) match names of your components in case.
Chapter 4 Configuration
51
Table 8
-mprofile
Startup option
Note: The management profile name you enter The BMC II for PATROL instance accesses this must exactly match the management profile and sends the events to name entered in the configuration utility (case the Impact Manager. For one BMC II for sensitive). PATROL instance, you can specify only one management profile name. -rtserver (required) name of the RTserver, to which the RTSERVERS environment variable BMC II for PATROL instance connects. The instance accesses the RTserver and authenticates the Console Server name and accesses its management profile. You can specify two RTserver names (that belong to a single RTserver cloud) for one BMC II for PATROL instance. If one RTserver goes down, the BMC II for PATROL instance connects to other RTserver and accesses the Console Server and its management profile. If the BMC II for PATROL instance is unable to access the RTserver, the log file displays an error message similar to the following: ERROR:11/20/2009 1:56:39 AM:RTE_CONNECT_SUBS:::connection.c pp(918):Exception occurred while connecting Error. Failed in initProcess. Please check your RT server ERROR:11/20/2009 1:56:39 AM::120.2005:Error in initializing bii4p service. Please check your RT server Note: If RTSERVERS is not defined, bii4p_start.opts will use tcp:localhost:2059
52
Table 8
-cserver
Startup option
-cell
(required) BMC Impact Manager to connect to local hostname in lowercase After reading the Impact Manager cell information from the bii4p_start.opts file, the BMC II for PATROL instance looks up the mcell.dir file for the cell entry and connects to the cell and passes the events to it. Note: Because the -cell option defaults to the host name in lowercase, if this option is left blank, you must ensure that your BMC Impact Manager cell name in your mcell.dir file is in lowercase as well.
Chapter 4 Configuration
53
Table 8
-instance
Startup option
(Windows) %CC_HOME%\etc\ (UNIX) $CC_HOME/etc/ bii4p.conf, located at CC_HOME/etc Note: Even if you change the name of the file, bii4p.conf must be located in the default directory.
-imConfFile
(required) BMC II for PATROL configuration file, which a BMC II for PATROL instance reads before startup. The default location of the file is as follows:
I
The default file name is bii4p.conf. If you have configured a file with a different name, enter the same name in this option. -debug (optional) turns debug on or off You can use this option to see the debug information of BMC II for PATROL and its connectivity with Impact Manager. The debug information also contains the event details. Values can be 0 (off) or 1 (on). 0 (off)
54
Table 8
-cfgid
Startup option
0:UpdMachineState 0:UpdAppState 0:UpdInstState 0:WorstApp 0:7 0:RegApp 0:Diag 0:Disconnect 0:Unload AS_EVENTSPRING:NOT IFY_EVENT
Note: If you are using your own event suppress list, use the Client Configuration File name in the -cfgid parameter in the bii4p_start.opts file. -virtualName (optional) whether to display the virtual name 0 (no virtual name) or fully-qualified domain name with the managed system name of PATROL Agent in the Impact Explorer Values can be 0 or 1. You can use this option when a PATROL Agent on the managed system has been started with either the -ID option or by setting the PATROL_VIRTUALNAME_PORT environment variable. For example, a PATROL Agent has been started with an ID called Test on a managed system as follows: PatrolAgent -p 3181 -id Test If you want to view the host name as Test in the Impact Explorer, set the virtualName option to 1. By default, this option is not enabled and the Host Name field shows the fully-qualified domain name with the managed system.
Chapter 4 Configuration
55
Table 8
-client
Startup option
56
Table 8
Default 0
PATROL_EV event type: mc_ueid=BII4Patrol_instanceName/IPAdd ress/port/ LayuotEventManagerTime/LayuotEventMa nagerId MC_ADAPTER_* event type: mc_ueid=BII4Patrol_instanceName.msgid. msgid
Chapter 4 Configuration
57
Table 8
-FQDNConfigured
whether to display fully-qualified domain name or only host name for the PATROL Agent. Values can be 0 or 1. By default, value of this option is set to 1 and DNS is configured. A fully-qualified domain name is displayed for the PATROL Agent. If you set the value of this option to 0, the following slots values are changed:
I
1 Note: If virtualName is set to 1, FQDNConfigured is applicable only for the Notification Server REMOTE_NOTIFY_EVENT event types. Note: If you have set the FQDNConfigured to 1, the virtualName option is overridden in the NOTIFY_EVENT and REMOTE_NOTIFY_EVENT event types.
PATROL Agent events: Message, Host, Tool, Origin, Agent, PATROL Origin Events from other KMs: Host, Tool, Origin, Agent Events from the Event Management KM: Host, Tool, Origin, Agent History Events: Host, Tool, Origin, Agent
If DNS is not configured, you can set this option to 0. Event originating from PATROL Agent uses this FQDN.
58
Table 8
Default 0
0: None. 1: Displays the current status of all parameters for all PATROL Agents in the management profile when BMC Impact Integration for PATROL is started or restarted. 2: Displays the current status of all parameters when only the PATROL Agent is restarted if the integration is functional. 3: Displays the current status of all parameters in the management profile in the Impact Explorer when either PATROL Agent is restarted or BMC Impact Integration for PATROL is started or restarted.
For information about slot values for the refreshAgentState events, see Table 9 on page 60.
Chapter 4 Configuration
59
Table 8
-cserverConnectionTimeOut
(optional) to increase the timeout value when 30 seconds BMC II for PATROL cannot connect to Console Server and fails to open Management profile with default time. This is applicable in case of heavy network traffic or number of clients associated to Console Server are more. This timeout option is used while opening the Management profile on Console Server. BII4Patrol7 will try to connect Console Server using the timeout value mentioned in bii4p_start.opts file for a maximum of five times. Minimum value: 30 seconds Maximum value: 300 seconds
Table 9 describes the slot values for the refreshAgentState event in BMC Impact Integration for PATROL: Table 9
Slot name msg
mc_origin_key Agent_IPAddress/AgentPort/applicationInstanceName/parameterName/ BII4Patrol_currentTimestamp/uniqueId mc_ueid Agent_IPAddress/AgentPort/parameterName/BII4Patrol_currentTimeStamp /BEventId B is added before the event ID to distinguish that it is a BMC II for PATROL generated event. The BMC II for PATROL process resets the event number after the maximum limit of 4,294,967,295 is reached.
60
Table 9
Slot name p_catalog
p_class_group p_class
NOTE
I
The PATROL Knowledge Modules should be preloaded on the PATROL Agents to fetch refreshAgentState events for BMC II for PATROL. The feature is not available if you are using the PATROL Knowledge Module for Event Management Notification and Remote Agent scenario. The number of refreshAgentState events fetched by BMC Impact Integration for PATROL by executing the All Parameters query is purely based on the loaded KM and their parameters on the PATROL Agent. The larger the number of parameters, the more refreshAgentState events will be fetched and the time taken to complete the fetch also increases accordingly. When the integration of BMC II for PATROL with PATROL Agent is functional with the refreshAgentState set to 2 or 3 and the PATROL Agent is down and if the management profile gets committed, then the refreshAgentState events are not fetched for that particular agent when it is started.
1 Update the alias and impersonation table for that particular PATROL Agent in the
Console Server.
2 Stop the PATROL Agent. 3 Change the password and ensure that the entries are correct. 4 Restart the PATROL Agent.
Chapter 4 Configuration
61
Figure 4
-mprofile eastcoast3 -rtserver tcp:localhost:2059 -cserver prod001 -cell payroll6 -instance bii4p2 -imConfFile bii4p.conf -debug 0 -cfgid -virtualName 0 -client BII4Patrol -updmcueid -FQDNConfigured -refreshAgentState 1 -agentRestartDelayTime 400
NOTE
The event suppression rule is not applicable for the refreshAgentState events. If the events need to be suppressed, then you need to set the value of -refreshAgentState to 0 in the bii4p_start.opts file.
To start BMC II for PATROL as a Windows service 1 Modify the bii4p_start.opts file to define startup options. The -mprofile, -rtserver,
-cserver, and mcell are the required options.
2 Run BII4Patrol -install 3 Start the BMC II for PATROL process from either the Services applet or by using
the net start command.
NOTE
For additional startup arguments, see Chapter 5, Startup and validation.
62
NOTE
The location of mcell.dir is configured in bii4p.conf.
The mcell.dir file accessed by BMC II for PATROL must contain definitions for itself and the BMC Impact Manager cell(s) to which it connects. The mcell.dir file accessed by a BMC Impact Manager cell must contain definitions for itself and the instance of BMC II for PATROL which connects to it.
WARNING
If you point to a cell being used by a previous version of BMC Impact Integration for PATROL, the information in the cell will be overwritten and will no longer function with the previous integration.
Review the example configurations shown in Figure 5, Figure 6, and to determine how to modify the mcell.dir file in each system. Then follow the steps in To edit the mcell.dir file for a remote cell on page 66 or To edit the mcell.dir file for multiple instances on page 66.
NOTE
By default, the entry for the local BMC II for PATROL instance is set to cell BII4Patrol_hostname mc hostname:4097
Chapter 4 Configuration
63
Use the example information in Figure 5 to configure your mcell.dir file if BMC II for PATROL will connect to a BMC Impact Manager cell installed on the same system. Entries in the mcell.dir file are case-sensitive for both Windows and UNIX. Figure 5 Example mcell.dir scenario 1
Points to
mc systema:4097 mc systema:1828 BMC II for PATROL on same system BMC Impact Manager cell on same system
Use the example information in Figure 6 to configure your mcell.dir file if BMC II for PATROL will connect to a BMC Impact Manager cell installed on a different system. Entries in the mcell.dir file are case-sensitive for both Windows and UNIX. Figure 6 Example mcell.dir scenario 2
Points to
BMC II for PATROL on same system BMC Impact Manager cell on System B BMC II for PATROL on System A BMC Impact Manager cell on same system
System B
cell cell BII4Patrol_systema mc systema:4097 bmc_im_cellname_b mc systemb:1828
64
shows mcell.dir file entries for two instances of an integration running on System A where:
I I I I I
the integrations are called a1 and a2 and reside on System A each instance has its own port number a BMC Impact Manager cell, bmc_im_cell1, resides on System B a second BMC Impact Manager cell, bmc_im_cell2, resides on SystemC each instance of BMC II for PATROL has its own bii4p_start.opts file
System B cell BII4Patrol_a1 mc systema:4097 cell bmc_im_cell1 mc systemb:1828 System C cell BII4Patrol_a2 mc systema:4098 cell bmc_im_cell2 mc systemc:1829
BMC II for PATROL on System A BMC Impact Manager cell on same system BMC II for PATROL on System A BMC Impact Manager cell on same system
A large number of PATROL agents may be taking part in impact management and sending numerous events. In such a case, you can have multiple instances of BII4Patrol on the same system or a different system to increase the throughput of whole application, each one sharing the burden of transferring the events information to BMC Impact Manager.
Chapter 4 Configuration
65
2 Add the BMC Impact Manager instance that you want the integration to
communicate with to the file, defining them as cells.
3 Save and close the mcell.dir file. To edit the mcell.dir file for multiple instances 1 In a text editor, open mcell.dir. 2 Use the format described in when creating entries for multiple instances of an
integration that are running on a single computer.
3 Add the BMC Impact Manager instances that you want the integration to
communicate with to the file, defining them as cells.
66
To configure BMC II for PATROL to support high-availability 1 Navigate to the CC_HOME/etc directory. 2 Open the mcell.dir file in a text editor and register the high-availability cell by
creating an entry in the following format: Cell Cell_name key primary_host:port secondary_host:port
EXAMPLE
If the primary server is server1 and the secondary server is server2, the entry in the mcell.dir file is: cell server1 mc server1:1828 server2:1828
To create separate bii4p_start.opts files for individual instances and point the instance to use that file on UNIX 1 Copy the $CC_HOME/etc/bii4p_start.opts file to the same location as the first
instance.
3 In the copied bii4p_start.opts file, make any necessary instance-specific changes you
want to.
Chapter 4 Configuration
67
You must specify a new instance name for -instance. For example, if BII4P_ABC is the name of the second instance, specify ABC as the value in bii4p_secondInstance_start.opts file. Thus, the instance entry in bii4p_secondInstance_start.opts file be as follows: -instance ABC
4 Copy the following entry to the mcell.dir file. You must specify an available port
and the new instance name in the instance variable, as specified in the bii4p_secondInstance_start.opts file.
cell BII4Patrol_instance mc host:port
For example:
cell BII4Patrol_ABC mc HostName:4098
5 To start the second instance, perform the following steps: A Change the directory to: $CC_HOME/bin/target B Enter the following command: ./start_bii4p.sh -f bii4p_secondInst_start.opts To create separate bii4p_start.opts files for individual instances and point the instance to use that file on Windows 1 Copy the %CC_HOME%\etc\bii4p_start.opts file to the same location. 2 Rename the copy for the second instance. For example, you can name it as
bii4p_secondInstance_start.opts.
4 You must specify a new instance name for -instance, For example, if BII4P_ABC is
the second instance, specify ABC as an instance value in bii4p_secondInstance_start.opts file. Thus, the instance entry in bii4p_secondInstance_start.opts file be as follows: -instance ABC
5 Copy the following entry to the mcell.dir file. You must specify an available port
and the new instance name in the <instance> variable as specified in the bii4p_secondInstance_start.opts file.
cell BII4Patrol_<instance> mc <host>:<port>
68
For example,
cell BII4Patrol_ABC mc HostName:4098
6 To start the second instance, execute the following command from a command
prompt:
%CC_HOME%\bin\target\BII4Patrol.exe -f bii4p_secondInst_start.opts
Each instance can run using unique parameters. Some instances can run using a default configuration while others run using unique configurations.
For information about setting bii4p_start.opts, see Using startup options on page 62.
Comment out the mcxp entry Add bii4p to the bottom of the file
Windows: MCELL_HOME\etc\cellname\kb\rules
Chapter 4 Configuration 69
UNIX: MCELL_HOME/etc/cellname/kb/rules
Comment out the mcxp entry Add bii4p to the bottom of the file
Comment out the mcxpcoll entry Add bii4p_collectors to the bottom of the file
10 Access the MCELL_HOME\etc\cellname\kb directory. 11 Enter the one of the following commands:
I
Configuration files
The bii4p.conf file contains parameters for tracing, the BMC Impact Manager directory file, and buffer management as described in Appendix A, Configuration file parameters.
70
You can optionally configure TraceConfigFileName and the variables in bii4p.trace to specify how you want to handle trace messages. Table 10
File bii4p.conf
I I
bii4p.trace
I I
(optional) the level of the trace messages on a module/level basis Example: ALL ALL stderr SERVICE ALL NONE SYNCH ALL NONE MESSAGES ALL NONE
Chapter 4 Configuration
71
72
Chapter
5
74 75 77 77 79 79
73
NOTE
If you do not specify the PATROL Console Server and RTserver through command line arguments, BMC II for PATROL will default to the PATROL Console Server or RTserver residing on the local machine.
-cell
-cfgid
-cserver
74
Table 11
-debug -f
-mcueidHostName -refreshAgentState
-remove -rtserver
-updmcueid
differentiates events coming from different BMC II for PATROL instances if these multiple instances are running on the same machine specifies whether to display virtual name or fully-qualified domain name with the managed system name of PATROL Agent in the Impact Explorer displays the version number of BMC II for PATROL
-virtualName
-version
-cserverConnectionTimeOut increases the timeout value when BMC II for PATROL cannot connect to Console Server and fails to open Management profile with default time.
RTserver name and port number PATROL Console Server management profile BMC II for PATROL port number configuration file BMC Impact Manager (cell) name, cell host name, and cell port number
To start BMC II for PATROL from the command line on Windows 1 Open an MS-DOS command prompt window and change the directory to the path
where the client executable file resides.
EXAMPLE
Enter cd CC_HOME\bin\Windows-x86 and press Enter.
3 To start the second instance of BMC II for PATROL from the command line, see
To create separate bii4p_start.opts files for individual instances and point the instance to use that file on Windows on page 68. For information on other BMC II for PATROL command line arguments, refer to Table 11.
To start BMC II for PATROL as a Windows service 1 Ensure that you have used the -install command line argument to set BMC II for
PATROL to run as a service (see Table 11 on page 74).
2 From the Windows task bar, choose Start => Settings => Control Panel => Services =>
BII4Patrol.
3 In the Services window tool bar, click Start. 4 To start the second instance of BMC II for PATROL as a service, see To create
separate bii4p_start.opts files for individual instances and point the instance to use that file on Windows on page 68.
76
To start BMC II for PATROL from the command line in UNIX 1 Change directory to $CC_HOME/bin/platform. 2 To start BMC II for PATROL, type ./start_bii4p.sh and press Enter. 3 To start a second instance of BMC II for PATROL, see To create separate
bii4p_start.opts files for individual instances and point the instance to use that file on UNIX on page 67.
To stop BMC II for PATROL on Windows 1 From the Windows task bar, choose Start => Settings => Control Panel => Services =>
BMC Impact Integration for Patrol.
2 In the Services window tool bar, click Stop. To stop BMC II for PATROL on UNIX 1 Change directory to $CC_HOME/bin/platform. 2 Type ./stop_bii4p.sh and press Enter. NOTE
The stop_bii4p.sh script stops all the running instances of the BMC II for PATROL process.
77
To validate that services are running correctly 1 Verify that the BMC II for PATROL process is running:
I
On Windows, use one of the following methods: From the Windows task bar, choose Start => Settings => Control Panel => Administrative Tools => Services. Verify that the status of the BMC Impact Integration for Patrol service is Started. In the Windows task bar, right-click and choose the Task Manager menu command; click the Processes tab. The BMC II for PATROL process is running if BII4Patrol.exe is listed on this tab of the Task Manager.
2 Verify that the following events are being received and displayed by the BMC
Impact Explorer (BMC IX) to which the BMC II for PATROL is sending event information:
I
an MC_ADAPTER_START event whose mc_tool_class slot value contains the BII4PATROL 7.1 string an MC_ADAPTER_START event is generated an MC_ADAPTER_CONTROL event whose mc_tool slot value contains the P_AGENT_UP string PATROL_EV events are generated
3 Compare PATROL_EV events in the BMC IX with the PATROL events from the
PATROL console to determine whether they contain the same event information. BMC IX usually contains fewer events than the PATROL Event Manager because the BMC II for PATROL component filters out events and the BMC IM contains rules to update, not create, new events. For information about event filtering in BMC II for PATROL, see Chapter 4, Configuration.
78
To modify the collector file 1 Access the MCELL_HOME/etc/cell-name/kb/collectors directory. 2 Open the bii4p_collectors.mrl file for editing. 3 Locate the following paragraph:
## ## ## ## collector PATROL.*.*.* : PATROL_EV where [p_instance: not_equals ] create $THIS.p_instance END
4 Activate the rule by deleting the comment symbols # # from the beginning of each
line.
5 Save the file. 6 Recompile the KB using mccomp. See Updating Knowledge Base files on
page 69.
79
80
Chapter
6
82 84 85 87
Event handling
This chapter presents the following topics: About PATROL 7 event mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Additional information for the PATROL KM for event management . . . . . . . . . Event class slots inherited from the BMC Impact Manager event class . . . . . . . . BMC II for PATROL events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 6
Event handling
81
translated to a format that can be understood by BMC Impact Manager using BMC II for PATROL. mapped to the PATROL_EV event class in the BMC Impact Manager cells Knowledge Base (KB).
The PATROL_EV event class is defined in the bii4p.baroc file in the KB. The PATROL_EV event class is subordinate to the base event class for BMC Impact Manager, called EVENT. In the BMC Impact Manager environment, an event class can have many slots, each one of which is a field in the event class definition. The slot content determines how the incoming event is processed by the BMC Impact Manager cell, according to the rules contained in its KB. Table 12 lists the slots for the PATROL_EV event class. Table 12
Slot name p_agent p_agent_address p_agent_port p_agent_version p_application
BMC Impact Manager event class slots for PATROL 7 managed systems (Part 1 of 2)
Description the hostname of the PATROL Agent that has reported the event the Internet Protocol (IP) address of p_agent the port number the PATROL Agent is using for communications the version of the PATROL Agent the name of the PATROL KM This slot can be empty when no KM is associated with the event.
a list of strings containing the event attributes the name of the PATROL Standard Event Catalog or a customized event catalog as displayed in the PATROL Event Manager the name of the PATROL class as displayed in the PATROL Event Manager The value for this slot is usually a string, although the string often consists of an integer.
the PATROL diary the array of diary text the array of lem management operator the array of lem diary time obsolete the IP address of mc_host the name of the PATROL instance This slot can be empty when no instance is associated with the event.
82
Table 12
Slot name p_origin
BMC Impact Manager event class slots for PATROL 7 managed systems (Part 2 of 2)
Description the PATROL Origin as displayed in the PATROL Event Manager the value of the Agent Object Identifier needed by event action the PATROL Event Manager event status, displayed as an integer See the definition of status slots for the list of p_status values in Table 13 on page 83.
p_source_id p_status
p_type
the PATROL Type Identifier, displayed as an integer See the definition of severity slot for the list of p_type values in Table 14 on page 83.
Table 13 and Table 14 compare PATROL and BMC Impact Manager event statuses and severities. Table 13
Value 0 1 2 3 4
Table 14
Value 0 1 2 3 4 5
Chapter 6
Event handling
83
PATROL KM for event management slots in the PATROL_EV event class (Part 1 of 2)
Description the value of the PATROL PATROL KM for event management parameter at the time of alert a Boolean flag to indicate the PATROL PATROL KM for event management source a custom identifier assigned to an object a custom identifier assigned to an object the TCP port on which the affected PATROL Agent is listening the UDP port on which the affected PATROL Agent is listening the name of the instance as displayed on the PATROL console, such as oracle_db1 the instance name that is the parent container of instance, such as CPU/CPU the value of the PATROL PATROL KM for event management parameter status at the time of the alert the date the alert occurred This is the date on the local mc_host.
pes_alert_time
the time the alert occurred This is the time on the local mc_host.
pes_tz pes_last10
the time zone to which the affected PATROL PATROL KM for event management system is set the last ten (10) PATROL PATROL KM for event management parameter values preceding and including the current value Values are space delimited, as in 98.11 97.14 95.87.
pes_ave10
the average of the last ten (10) PATROL PATROL KM for event management parameter values
84
Table 15
Slot Name
PATROL KM for event management slots in the PATROL_EV event class (Part 2 of 2)
Description the times at which the last ten (10) PATROL PATROL KM for event management parameter values were collected These map directly with the pes_last10 values. The time value is expressed in seconds since epoch.
pes_last10_ts
pes_last10_tp pes_user_defined
the length of time, in minutes, between the first PATROL PATROL KM for event management parameter value and the last the user defined variable This variable contains the information stored in the variable /_my_APPCLASS_APPINSTANCE_PARAMETER at the time of the alert condition.
the lowest threshold value of the current alarm range the highest threshold value of the current alarm range %PATROL_HOME% of the PATROL Agent
Event class slots inherited from the BMC Impact Manager event class
The BMC II for PATROL event class slots that are inherited from the BMC Impact Manager base class EVENT are listed in Table 16. Table 16
Slot name adapter_host status severity mc_host
BMC Impact Manager slots inherited by the BMC II for PATROL event class (Part 1 of 2)
Description the fully qualified host name of the computer on which BMC II for PATROL is running the event status, corresponds to the PATROL status according to Table 13 on page 83 the severity slot value is based on the PATROL Type according to Table 14 on page 83 the fully qualified domain name (FQDN) of the host on which the event occurred Generally, it can be different from the PATROL Agent host name, as in the case of an event reported on a remote Agent by the PATROL KM for event management. PATROL does not provide the FQDN. BMC II for PATROL attempts to retrieve the fully qualified name for the event, but if your DNS is not configured correctly, the attempt to retrieve the FQDN may not be successful. In this case, the cell sets the event's mc_location slot to UNKNOWN.
mc_host_class
Chapter 6
Event handling
85
Table 16
Slot name
BMC Impact Manager slots inherited by the BMC II for PATROL event class (Part 2 of 2)
Description the IP address of mc_host the name of the PATROL instance the name of the PATROL KM (application) the name of the PATROL parameter that generated the event This slot can be empty when no BMC Impact Manager attribute is associated with the event.
mc_tool
the host name of the PATROL Agent that created the original event Its syntax is the host name of the PATROL Agent that created the original event, followed by the colon character (:), followed by the port number of the PATROL Agent.
the string BII4PATROL7.1 the PATROL event identifier the PATROL event severity, as displayed in the PATROL Event Manager The severity level is expressed as an integer, with a value ranging from 1 to 5; 5 is the highest severity.
mc_origin_class mc_origin
the string Vagent-major-version.agent-minor-version the hostname of the PATROL Agent that created the original event Its syntax is the hostname of the PATROL Agent that created the original event, followed by the colon character (:), followed by the port number of the PATROL Agent.
mc_origin_key mc_origin_sev
the PATROL event identifier the PATROL severity level, as displayed in the PATROL Event Manager The severity level is expressed as an integer, with a value ranging from 1 to 5; 5 is the highest severity.
mc_ueid
mc_incident_time msg
Time stamp the LEM event occurred the text description of the event
86
Event files
For a list of the event files included in BMC II for PATROL, see Appendix B, BMC Impact Manager rules for PATROL events.
Chapter 6
Event handling
87
88
Chapter
7
90 90 91 91 92 92 93 93
Troubleshooting
Use the information in this chapter to help you diagnose and correct problems. Console Server authentication fails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . imServer does not start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . BII4Patrol terminated at startup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Console Server not started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Cannot access the management profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Unable to start BMC II for PATROL as a service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installation fails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Missing cell entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 7 Troubleshooting
89
Reason
The user ID or password in the cconnect.conf file does not match the Console Server user ID or password.
Action
Use the ccPassword utility under BMCsoftware\common\bmc to update the cconnect.conf file.
Reason
The socket used by BMC II for PATROL is not available.
Action
Use a different port number. Edit the mcell.dir file to change the port number.
90
Reason
The cell entry referenced in the bii4p_start.opts file does not exist in the mcell.dir file.
Action
Add the cell entry. Edit the mcell.dir file to add the cell.
Reason
The Console Server is not started on the RTServer cloud.
Action
Start the Console Server. If the Console Server is already running, check the bii4p_start.opts file for errors.
Chapter 7 Troubleshooting
91
Reason
The management profile either does not exist or is in use by another application.
Action
Check the Common Connect configuration utility, PATROL console, or any other application that might use the management profile. Close the management profile and restart BMC II for PATROL.
Reason
Windows is looking for the vul9_t.dll file in C:\Program Files\BMC Software\Common_Connect\bin\Windows-x86, but the file is located in C:\Program Files\BMC Software\common\bmc\bin\Windows-x86 and that is what is set in PATH.
Action
Reboot the server.
92
Installation fails
Installation fails
The installation terminates abnormally.
Reason
The Console Server was not stopped.
Action
Stop the Console Server and retry installing.
Reason
The cell entry is missing from the mcell.dir file.
Action
Edit the mcell.dir file.
Chapter 7 Troubleshooting
93
94
Appendix
95
Table 18
Group
The mcell.dir file contains a list of all BMC IM instances to which the integration can connect. The integration can use the mcell.dir file supplied with the integration, or it can use the mcell.dir file of a BMC IM instance that is already installed on the same host.
Connection Management
ConnectionSetupTimeOut
maximum time, in seconds, that a CLI command attempts to establish a connection to a cell If the connection with the cell cannot be completely established within this time frame, the command aborts. Default: 10 seconds If the cell is busy with a database cleanup, it may be impossible to connect the CLI with the default values. A database cleanup has a duration limit defined by the EventDBCleanupDurationLimit option, with a default value of 30 seconds. With a default ConnectionSetupTimeOut of 10 seconds, the connection cannot be established within the first 20 seconds of a cleanup.
96
Table 18
Group
No Yes (default)
97
Table 18
Group
Message Propagation
The value of this parameter cannot be less than 60 seconds. When a connection is established, the integration sends buffered messages that are designated for the BMC IM instance with which the connection is established.
MessageBufferResendCount
98
Table 18
Group
No Yes (default)
PersistencyLevel
buffer mode used when the Default buffering mode is specified. This parameter is enabled only when the PersistencyEnabled parameter value is Yes. Optional. Valid values:
I I I
Note: These values are case-sensitive and should be entered as shown here. PersistencyFileName name of the file in which the buffered messages are stored Default: log_directory\imgw-bii4p.dat PersistencyCleanupSize Threshold PersistencyCleanupGarbage Threshold Buffered Message PersistencyDisconnectRemove Messages Retention, continued threshold size, in bytes, of the persistency file that activates garbage collection threshold size, as a percentage of file size, of the persistency file that activates garbage collection indicates whether messages written to the persistency file are deleted when the integration disconnects intentionally from a BMC IM instance Valid values:
I I
No Yes (Default)
Notes:
I
The contents of the file are not deleted when the integration crashes. BMC Software recommends that you add this parameter to the bii4p.conf file and set the value to No.
99
Table 18
Group
Trace Parameters
TraceSrc
when displaying a trace message, specifies whether to display the source code file name and line number where trace message originated. Optional. Valid values:
I I
YES or ON display file name and line number NO or OFF no display of file name and line number (default)
Note: Depending on the location of the trace message, the source may be in the integration or the BMC II for PATROL code. TraceConfigFileName TraceDefaultFileName path and file name for the bii4p.trace file. Required if Trace=YES. default destination file to which trace messages are redirected from stderr, when the integration runs as a daemon or a service. Required if Trace=YES. maximum size, in KB, of the trace messages file. Optional. Valid values:
I I
TraceFileSize
Note: BMC Software recommends that the value of this parameter be no less than 500 KB.
100
Table 18
Group
TraceFileAppend
when the integration is restarted, specifies whether to append new trace messages to the existing message trace file. Optional. Valid values:
I I
YES or ON appends new messages to the existing trace message file (default) NO or OFF - empties the current trace message file
Miscellaneous
UseLocks
flag that indicates whether synchronization locks are used. Optional. Valid values:
I I
Notes:
I
In a single-threaded environment, disabling locks may result in more efficient API operation. You must enable locks in an multithreaded environment. If you include the UseLocks parameter in the bii4p.conf file, set the parameter to YES or ON for threading to work. If UseLocks is not already included in the file, there is no need to add it. The default value for the parameter is ON.
Appendix A
101
102
Appendix
B
103 104 105 105 106 106
This appendix presents the following topics: BBMC Impact Manager rules for PATROL events . . . . . . . . . . . . . . . . . . . . . . . . . . . . PATROL state changes and BMC Impact Manager rules . . . . . . . . . . . . . . . . . . . PATROL recovery actions and BMC Impact Manager rules . . . . . . . . . . . . . . . . PATROL Agent status and BMC Impact Manager rules. . . . . . . . . . . . . . . . . . . . PATROL duplicate events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Event processing and the PATROL KM for event management . . . . . . . . . . . . .
Appendix B
103
I I
rule alarm_and_ra (for recovery actions) agent_up_closes_down (for the PATROL Agent)
Event B is a state change event containing information that the state described by Event A has changed. Accordingly, Event A can be closed, and Event B replaces Event A.
You can see how BMC II for PATROL implements these rules by performing the following procedure for a PATROL console on which there are no alarms. 1. Set an alarm on a logical disk that can reflect the alarm quickly. When the alarm is triggered, you can see the following ALARM events in the PATROL console:
I
Event A of class UpdMachineState reports that the state of your computer is changed. Event B reports a PATROL alarm on the parameter. Event C of the UpdInstState class reports that the state of the corresponding instance is changed. Event D of the WorstApp class reports that the state of the corresponding application is changed.
104
Event A2 of the UpdMachineState class reports the state of your computer is changed. It can update Event A. Event B2 from PATROL reports that the alarm on the parameter is cancelled. This event updates Event B. Event C2 of the UpdInstState class reports that the state of the corresponding instance is changed. It can update Event C. Event D2 of the UpdAppState class reports that the state of the corresponding application is changed. It can update Event D.
The UpdInstState, UpdAppState, WorstApp, and UpdMachineState events are filtered by default. In this case, only Event B is observed when the alarm is triggered, and Event B2 cancels Event B. The rules adap_instance_status, adap_application_status and adap_host_status are not used. If you want to see all the events discussed, you must set MCXPDropClass to the empty string. Event B can be an instance of PATROL standard event catalog classes 9, 11, 39 or UpdParState (in some cases). Event D also can be an instance of the PATROL classes WorstApp or UpdAppState. Event B2 can be an instance of PATROL standard event catalog classes 9, 16, or UpdParState.
Appendix B
105
Event A is a PATROL event that you can see in a BMC IX console with a message of the form 'Alarm # 1 of global parameter
LDldFreeSpacePercent' triggered on . . . '
Event B is a NOTIFY_EVENT or REMOTE_NOTIFY_EVENT. The second argument of the argument list p_args is a long string that contains 32 comma-separated values. Only by using this single long string is it possible to reconstruct Event A completely. This string provides additional information that will populate the pes_xxx slots.
When BMC II for PATROL receives Event A, it generates an instance of the class with the information available about the alarm. The pes_xxx slots remain empty because that information is not available. The PATROL_EV is sent to the BMC Impact Manager as Event PA.
106
When BMC II for PATROL receives Event B, all the information about the NOTIFY_EVENT or REMOTE_NOTIFY_EVENT, except the second argument of the argument list, is dropped. BMC II for PATROL extracts the information from the argument list and creates a new instance of PATROL_EV. This PATROL_EV is actually the same PATROL_EV as created from Event A, except that the pes_xxx slots are populated. The PATROL_EV is sent to the BMC Impact Manager as Event PB. Since Events PA and PB are the same except for the pes_xxx slots, PA is updated with the value of these slots from PB and PB is dropped according to the rule es_priority.
Appendix B
107
108
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
A
alarm An indication that a parameter for an object has returned a value within the alarm range or that application discovery has discovered that a file or process is missing since the last application check. An alarm state for an object can be indicated by a flashing icon, depending on the configuration of a console preference. See also warning. API See Application Program Interface (API). Application Program Interface (API) A set of externalized functions that allow interaction with an applications. attribute A characteristic that is assigned to a PATROL object (computer class, computer instance, application class, application instance, or parameter) and that you can use to monitor and manage that object. Computers and applications can have attributes such as command type, parameter, menu command, InfoBox command, PATROL setup command, state change action, or environment variable. Parameters can have attributes such as scheduling, command type, and thresholds. An attribute can be defined globally for all instances of a class or locally for a particular computer or application instance. An instance inherits attributes from a class; however, an attribute defined at the instance level overrides inherited attributes.
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 structure are called slots. BMC II See BMC Impact Integration product. BMC Impact Manager See BMC Impact Manager.
Glossary
109
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 IWC See BMC Impact Web Console. BMC Impact Database Gateway (BMC IDG) The interface that enables BMC Impact Manager events to be exported to a relational database. BMC Impact Explorer (BMC IX) A 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 (BMC IXS) The configuration server that administrators use to manage user access to BMC Impact Managers resources. The BMC Impact Explorer Server runs as a daemon on UNIX platforms and as a service on the supported Windows platforms. Synonym: MCCS. BMC Impact Integration (BMC II) product An interface that enables the synchronized, bidirectional flow of events and data between a BMC Impact Manager instance and another BMC Software product or a specific third-party product. BMC Impact Manager 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 a networked enterprise and connected in various topologies to support IT goals. BMC Impact Web Console (BMC IWC) The HTML GUI for service-model component monitoring and reporting that allows access to business views of the environment. BMC IX See BMC Impact Explorer. BMC IXS See BMC Impact Explorer Server.
C
cell The event processing engine that collects, processes, and stores events within a BMC Impact Manager instance. Each cell uses the information in the associated Knowledge Base to identify the type of events to accept and how to process and distribute them. child collector A collector contained within another collector.
110
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 A BAROC-language data structure that defines a type of object used in BMC Impact Manager. A class is made up of data fields, called slots, that define its properties. collector An event grouping whose content is defined by its collector rule. Collectors are displayed in the BMC Impact Explorer and are defined in the BMC Impact Manager Knowledge Base. See also collector rule. collector rule A type of rule defined in the Knowledge Base that defines how events from a cell are organized and presented in the BMC Impact Explorer. Collector definitions are written in Master Rule Language (MRL). collector set A group of collectors, organized in a parent-child hierarchy, that performs progressive filtering of those incoming events that match the top-level (parent collector) criteria. A collector set selects a set of events and organizes them for display in the BMC Impact Explorer. Common Connect Back End A core component that resides on the console server. It manages the consumer and provider nodes that are created to handle events on behalf of Common Connect clients. It implements event handlers, object and event filters, and scheduling activities. Common Connect client A PATROL Console, PATROL Integration product, or third-party vendor application that exchanges events and integrates with a PATROL Console Server that has the Common Connect Back End component installed. Common Connect configuration utility A standalone, platform-independent, Java-based client with a graphical user interface. The Common Connect configuration utility is essential to the configuration of Common Connect clients. The configuration utility enables you to
I I
define configuration files that are unique to each Common Connect client define management profiles that specify the PATROL Agent, and Common Connect clients that you want to monitor; apply event filters to PATROL Common Connect client events; and set scheduling intervals in which to receive or block events originating from PATROL and Common Connect clients
Common Connect server The Common Connect program that awaits and fulfills requests from Common Connect clients in the same or other computers. The Common Connect server and the Common Connect Back End reside on the PATROL Console Server.
Glossary
111
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
common service A computer that processes data from managed systems and facilitates communications between managed systems and console systems. See also console system and managed system. configuration file The configuration file defines the keywords that determine how the PATROL Integration server communicates with the PATROL Integration client. console See BMC Impact Explorer. console server A server through which PATROL Central communicates with managed systems. A console server handles requests, events, data, communications, views, customizations, and security. console system A computer that hosts user desktop applications, such as consoles, viewers, and Web browsers. See also common service and managed system.
D
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 ensure that data integrity is maintained. distribution CD or tape A CD or tape that contains a copy of one or more BMC Software products and includes software and documentation (user guides and online help systems). dynamic collector A special type of collector that, in response to events, can add or remove event collectors from the cell during runtime.
E
environment variable A variable used to specify settings, such as the program search path for the environment in which PATROL runs. You can set environment variables for computer classes, computer instances, application classes, application instances, and parameters.
112
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 1) An occurrence or change in a monitored object or application. An event can be a user action or a system occurrence. 2) BMC II for PATROL captures events by collecting messages from the managed systems. 3) In PATROL, the occurrence of a change, such as the appearance of a task icon, the launch of a recovery action, the connection of a console to an agent, or a state change in a monitored object (computer class, computer instance, application class, application instance, or parameter). Events are captured by the PATROL Agent, stored in an event repository file, and forwarded to BMC II for PATROL. event class A BAROC class that is a child of the base event class, EVENT, and that defines a type of event. Event Diary The part of an event manager (PEM) where you can store or change comments about any event in the event log. You can enter commands at any time from the PATROL Event Manager Details window. event manager A graphical user interface for monitoring and managing events. The event manager can be used with or without the PATROL Console. event message A text message related to a PATROL event, such as PATROL Integration Warning: Host node disconnected - [host name]. event propagation The act of forwarding events and maintaining their synchronization among multiple BMC Impact Managers. event repository See repository. event type The PATROL-provided category for an event according to a filtering mechanism in an event manager. Event types include information, state change, error, warning, alarm, and response. Events View The BMC Impact Explorer user interface for viewing and manipulating event data. Execute phase The event-processing phase in which Execute rules are evaluated and, if conditions are met, specified actions are performed.
Glossary
113
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 a 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.
F
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 is, subjected to further processing, or discarded as unwanted during the Filter phase.
I
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 executables 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 product 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.
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 The seed encryption key. If the destination BMC Impact Manager or BMC Impact Integration product has a key value, all clients must encrypt their communications using the same key value. 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
114 BMC Impact Integration for PATROL 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
information includes event class definitions, Service-Model component definitions, record definitions, interface definitions, collector definitions, data associations, and processing rules. Knowledge Module (KM) A set of files from which a PATROL Agent receives information about resources running on a monitored computer. A KM file can contain the actual instructions for monitoring objects or simply a list of KMs to load. KMs are loaded by a PATROL Agent and a PATROL Console. KMs provide information for the way monitored computers are represented in the PATROL interface, for the discovery of application instances and the way they are represented, for parameters that are run under those applications, and for the options available on object pop-up menus. A PATROL Console in the developer mode can change KM knowledge for its current session, save knowledge for all of its future sessions, and commit KM changes to specified PATROL Agent computers.
L
.load file A file that specifies the order in which a directorys files are to be loaded and read by a BMC Impact Manager instance.
M
managed object Any object that PATROL manages. See parameter. managed object file (MOF) A file that contains keyword and event attribute values for a PATROL Integration module. These values define how the integration module interacts with a Common Connect client and the Common Connect environment. managed system A systemusually a computer on which a PATROL Agent is runningthat is added (connected) to a PATROL Console to be monitored and managed by PATROL and that is represented by an icon on the PATROL interface. A system with resources that are managed or monitored by a BMC Software product, such as a computer on which a PATROL Agent is running. See also console system and common service. management event Events which are not displayed but which change the status of a current event (such as changing from open to acknowledge). management profile A user profile for PATROL Central that is stored by the console server. A management profile is similar to a session file and contains information about custom views, your current view of the PATROL environment, information about systems that you are currently managing,
Glossary 115
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
Knowledge Module information, and console layout information for PATROL Central. Management profiles replace desktop files and session files that were used in PATROL 3.x and earlier. 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 source files for compilation. MAP file A text file that defines the translation of a message between one event format and another. Master Rule Language (MRL) A compact, declarative language used to define rules and collectors for processing and organizing events. Uncompiled rule and collector source files have a .mrl file extension. mccomp The rules compiler. Rules are written in the Master Rule Language (MRL). The platformindependent compiler converts them to byte code that the cell can read and process. mcell.conf file The configuration file that contains configuration options for a BMC Impact Manager instance. 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 product component can connect and communicate. The information for 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. mcell.propagate file The configuration file that specifies the slot values that are synchronized during event propagation between 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 BMC Impact Manager trace information 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. metaclass See internal base class.
116
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
MetaCollector A virtual collector that contains a group of collectors from multiple BMC Impact Manager instances. It exists only in the BMC Impact Explorer, and you can customize it. .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.
N
New phase The event-processing phase in which the 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 an event from entering the repository. 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.
O
open event An event that may require action. An OPEN status indicates that an event has not yet been examined, or that neither an operator nor an automated process has been assigned responsibility for the event.
P
parameter The monitoring element of PATROL. Parameters are run by the PATROL Agent; they periodically use data collection commands to obtain data on a system resource and then parse, process, and store that data on the computer that is running the PATROL Agent. Parameters can display data in various formats, such as numeric, text, stoplight, and Boolean. Parameter data can be accessed from a PATROL Console, PATROLVIEW, or an SNMP console. Parameters have thresholds and can trigger warnings and alarms. If the value returned by the parameter triggers a warning or an alarm, the PATROL Agent notifies the PATROL Console and runs any recovery actions associated with the parameter. parent collector A collector that contains child collectors to form a collector set.
Glossary
117
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
PATROL Agent The core component of PATROL architecture. The agent is used to monitor and manage host computers and can communicate with the PATROL Console, a stand-alone event manager (PEM), PATROLVIEW, and SNMP consoles. From the command line, the PATROL Agent is configured by the pconfig utility; from a graphical user interface, it is configured by the xpconfig utility for UNIX or the wpconfig utility for Windows. PATROL application The object classfor example, CPU, printer, or diskto which an instance and related parameters belong. In the object hierarchy, an application belongs to a specific computer or node. PATROL Console The graphical user interface from which you launch commands and manage the environment monitored by PATROL. The PATROL Console displays all of the monitored computer instances and application instances as icons. It also interacts with the PATROL Agent and runs commands and tasks on each monitored computer. The dialog is event-driven so that messages reach the PATROL Console only when a specific event causes a state change on the monitored computer. A PATROL Console with developer functionality can monitor and manage computer instances, application instances, and parameters; customize, create, and delete locally loaded Knowledge Modules and commit these changes to selected PATROL Agent computers; add, modify, or delete event classes and commands in the Standard Event Catalog; and define expert advice. A PATROL Console with operator functionality can monitor and manage computer instances, application instances, and parameters and can view expert advice but not customize or create KMs, commands, and parameters. PATROL event class A category of events that you can create 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 are stored in event catalogs and can be added, modified, or deleted only from a PATROL Console in the developer mode. PATROL provides a number of event classes in the Standard Event Catalog, such as worst application and registered application. PATROL instance A computer or discovered application that is running in an environment managed by PATROL. An instance has all the attributes of the class that it belongs to. A computer instance is a monitored computer that has been added to the PATROL Console. An application instance is discovered by PATROL. phase (rule) A specific stage of event processing. There are eight sequential phases to event processing and two nonsequential phases, each with a corresponding rule type.
118
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 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. 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 an Integration product. Propagate rule An event-processing rule that is used to forward events to other BMC Impact Managers 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 an Integration product during the Propagate phase of event processing. propagation The transmission of status values from underlying objects up to their parent objects for example, the transmission of an alert from the parameter level up to the node level.
R
recovery action A procedure that attempts to fix a problem that caused a warning or alarm condition. A recovery action is defined within a parameter by a user or by PATROL and triggered when the returned parameter value falls within a defined alarm range. 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. 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 repetitive (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. repository The storage facility in which event information is stored.
Glossary
119
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
RTserver cloud Linking of multiple RTservers in your PATROL environment to provide flexibility and load balancing. If an RTserver in your environment fails, another RTserver in the RTserver cloud picks up the load and the PATROL components continue to communicate. rule A conditional statement that, if determined to be true, executes actions. The cell evaluates events by comparing each event to a series of rules during event processing. Rules are grouped in phases that are processed one by one. The order in which rules are evaluated during a particular phase is based on the order in which they were loaded. When all the rules in one phase are evaluated, the cell moves to the next phase. rule engine See cell. rule type A designation of a rule that applies to a specific phase of event processing. The cell processes 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
server The computer program that provides services to other computer programs on the same or different computers. It fulfills the requests made by the client programs. Also, server refers to the computer on which the server program runs. See also client. Service Level Agreement (SLA) An agreement that defines the required availability of a business service to its consumers. service-level- agreement component A type of Service Model component that represents service-level agreements and metrics. service level metric (SLM) A measurement of some aspect of service delivery. 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. Service-Model component (SMC) A logical or physical resource that participates in the delivery of services. There are four types of Service-Model components: connectivity components, IT components, logical components, and service level agreement components. An SMC can provide services to or consume services from another component. In technical terms, a Service-Model component is any data class that is a subclass of the MC_SM_COMPONENT base class.
120
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-Model-component relationship The association of two Service-Model components. There are two types of component relationships: impact and null. See also impact relationship, null relationship. Services View The BMC Impact Explorer user interface for viewing Service-Model components and their relationships and for viewing and managing the events that affect service availability. shadow component A component that is a copy of a component existing on another cell. Shadow components are used when setting up distributed Service Models. 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 control aspects of a class instances processing. A class that is a subclass to another class inherits all the slots of the parent class. slot change The process of updating the slot value of a class instance. slot propagation The process by which slot changes are synchronized among cells. slot value The value associated with a particular slot (attribute) of a class instance. slot value pair A slot name and its associated slot value. SM See Service Model. SMC See Service Model component. 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.
Glossary
121
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
state The condition of an object (computer instance, application instance, or parameter) monitored by PATROL. The most common states are OK, warning, and alarm. Object icons can show additional conditions. See also state change action. StateBuilder utility The utility, statbld, that periodically consolidates the data in a cells transactions file (xact) and writes the saved state of the cell to a repository (mcdb). state change action An action that is stored, maintained, and initiated by the PATROL Console when the console is notified by the PATROL Agent that a monitored object has changed state. The action, or command, executes on the computer on which the console is running, not the computer on which the agent is running. status
I
For events, an indication of the events management. Possible values are: Open, Acknowledged, Closed. For Service-Model components, an indication of the relative availability of an IT resource. Possible values are: Unavailable, Impacted, At Risk, Maintenance, Available, Unknown, None.
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 the event repository. Only stored events are returned by queries and are: displayed in BMC Impact Explorer, returned by the mquery CLI command, or referenced by the Using and Update clauses of an MRL rule.
T
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.
U
Update phase See New phase.
122 BMC Impact Integration for PATROL 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
Using clause An MRL rule clause used to access dynamic data and to query events.
W
warning An indication that a parameter has returned a value that falls within the warning range. See also alarm. 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.
Glossary
123
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
124
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
$CC_HOME 21 $MCELL_HOME 21 %CC_HOME% 21 %MCELL_HOME% 21 BMC Software Common Installation utility Review Selections and Install page 32 BMC Software, contacting 2 buffering buffer, maximum size 98 MessageBufferReconnectInterval parameter 98 MessageBufferSize parameter 98 reconnect interval 98
A
ACK BMC Impact Manager event status 83 action PATROL recovery 105 adapter_host slot, event class 85 agentRestartDelayTime 74 alarm events PATROL KM for Event Management 106
C
CC_HOME 21 -cell 74 cell BMC Impact Manager instance 12 -cfgid 74 -client 74 client configuration file 49 client executable 76 Client Runtime 15 CLOSED BMC Impact Manager event status 83 commands ./uninstall.sh 37 echo $CC_HOME 33 Common Connect Back End and configuration 15 configstart.bat 43 configuration files multiple files, using 69 parameters 96 TraceConfigFileName parameter 100 Configuration Wizard closing 49 Configuration Change Complete page 49 Connect to RT Server(s) page 44, 48 defining client configuration files 44, 47 Edit Client Attributes page 49 Open/Create Configuration page 49 Provide User Credentials page 44, 48 Select Common Connect Client page 48 Select Configuration page 44, 48 starting 44, 47 configuring configuration file parameters 96
B
Basic C APIs multiple integration instances 69 batch files configstart.bat 43 BMC II for PATROL events, duplicate 106 MC_ADAPTER_CONTROL event 87 MC_ADAPTER_ERROR event 87 MC_ADAPTER_START event 87 monitor event load 79 recovery action, PATROL 105 starting, second instance on UNIX 68 starting, second instance on Windows 69 validate operations on Unix 78 validate operations on Windows 78 BMC Impact Manager definition formats 66 BMC Impact Manager event status 83 ACK 83 CLOSED 83 OPEN 83 BMC Impact Manager instance, cell 12 BMC Impact Manager severity status CRITICAL 83 OK 83
Index
125
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
multiple integration instances 69 Trace parameter 100 TraceConfigFileName parameter 100 TraceDefaultFileName parameter 100 TraceFileAppend parameter 101 TraceFileHistory parameter 101 TraceFileSize parameter 100 TraceSrc parameter 100 connecting maximum reconnect interval 98 to Impact Managers 66 ConnectionPortRange configuration parameter description 97 ConnectionPortReuse configuration parameter 97 ConnectionSetupTimeOut configuration parameter 96 CRITICAL BMC Impact Manager severity status 83 -cserver 74 -cserverConnectionTimeOut 75 customer support 3
F
-f 75 FQDNConfigured 75
H
-help 75
I
-imConfFile 75 initializing multiple integration instances 69 -install 75 -instance 75 integrations multiple instances, running 69
D
-debug 75 defining BMC Impact Manager instances 66 deploying procedures for multiple integration instances 69 directories $PATROL_ROOT/log/cserver/cc_client_config/ 49 /opt/bmc 30 \Program Files\BMC Software 30 duplicate events BMC II for PATROL 106
K
KM. See Knowledge Module Knowledge Module. See KM
M
management profile creating a duplicate 45 defining 45 MC_ADAPTER_CONTROL BMC II for PATROL event 87 MC_ADAPTER_ERROR BMC II for PATROL event 87 MC_ADAPTER_START BMC II for PATROL event 87 MC_ADAPTER_STOP 87 mc_host slot, event class 85 mc_host_address slot, event class 82, 86 mc_host_class event class slot 85 slot, event class 85 mc_object slot, event class 86 mc_object_class slot, event class 86 mc_origin slot, event class 86 mc_origin_class slot, event class 86 mc_origin_key slot, event class 86 mc_origin_sev
E
editing mcell.dir file 66 encryption Encryption parameter 97 Encryption configuration parameter 97 event state change, PATROL 104 event class, BMC II for PATROL slot 85 event load monitor, BMC II for PATROL 79 event status BMC Impact Manager 83 PATROL 83 events PATROL KM for Event Management alarm 106 events, duplicate BMC II for PATROL 106
126
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, event class 86 mc_parameter slot, event class 86 mc_parameter_value PATROL KM for Event Management slot 84 mc_tool slot, event class 86 mc_tool_class slot, event class 86 mc_tool_key slot, event class 86 mc_tool_sev slot, event class 86 mcell.dir file defining BMC Impact Manager instances 66 editing 66 MCELL_HOME 21 -mcueidHostName 75 MessageBufferKeepSent configuration parameter 98 MessageBufferKeepWait configuration parameter 98 MessageBufferReconnectInterval configuration parameter description 98 MessageBufferResendCount configuration parameter 98 MessageBufferSize configuration parameter description 98 messages buffer, capacity 98 Microsoft Internet Explorer 20 -mprofile 75 multithreading UseLocks parameter requirement 101 PATROL_EV event class slot 82 p_args PATROL_EV event class slot 82 p_catalog PATROL_EV event class slot 82 p_class PATROL_EV event class slot 82 p_expectancy PATROL_EV event class slot 82 p_instance PATROL_EV event class slot 82 p_origin PATROL_EV event class slot 83 p_source_id PATROL_EV event class slot 83 p_status PATROL_EV event class slot 83 p_type PATROL_EV event class slot 83 parameters configuration file 96 ConnectionPortRange 97 ConnectionPortReuse 97 ConnectionSetupTimeOut 96 Encryption 97 MessageBufferKeepSent 98 MessageBufferKeepWait 98 MessageBufferReconnectInterval 98 MessageBufferResendCount 98 MessageBufferSize 98 PersistencyCleanupGarbageThreshold 99 PersistencyCleanupSizeThreshold 99 PersistencyDisconnectRemoveMessages 99 PersistencyEnabled 99 PersistencyFileName 99 PersistencyLevel 99 ServerDirectoryName 96 TraceConfigFileName 100 TraceDefaultFileName 100 TraceFileAppend 101 TraceFileHistory 101 TraceFileSize 100 TraceSrc 100 UseLocks 101 PATROL event class PATROL_EV 12 recovery action 105 recovery action in BMC II for PATROL 105 state change event 104 PATROL Agent 20 up, down events 105 PATROL Console Server 20 and installation 15 specifying a server for connection 44, 48 PATROL event status 83 PATROL KM for Event Management alarm events 106
N
Netscape Navigator 20
O
OK BMC Impact Manager severity status 83 OPEN BMC Impact Manager event status 83 operations, validate BMC II for PATROL on Unix 78 BMC II for PATROL on Windows 78
P
p_agent PATROL_EV event class slot 82 p_agent_address PATROL_EV event class slot 82 p_agent_port PATROL_EV event class slot 82 p_application
Index
127
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
PATROL_EV event class PATROL, 12 persistency parameters 99 PersistencyCleanupGarbageThreshold configuration parameter 99 PersistencyCleanupSizeThreshold configuration parameter 99 PersistencyDisconnectRemoveMessages configuration parameter 99 PersistencyEnabled configuration parameter 99 PersistencyFileName configuration parameters 99 PersistencyLevel configuration parameter description 99 pes PATROL KM for Event Management slot 84 pes_alarm_max PATROL KM for Event Management slot 85 pes_alarm_min PATROL KM for Event Management slot 85 pes_alert_date PATROL KM for Event Management slot 84 pes_alert_time PATROL KM for Event Management slot 84 pes_ave10 PATROL KM for Event Management slot 84 pes_icon_name PATROL KM for Event Management slot 84 pes_last10 PATROL KM for Event Management slot 84 pes_last10_tp PATROL KM for Event Management slot 85 pes_last10_ts PATROL KM for Event Management slot 85 pes_param_status PATROL KM for Event Management slot 84 pes_parent_instance PATROL KM for Event Management slot 84 pes_patrol_home PATROL KM for Event Management slot 85 pes_tcp_port PATROL KM for Event Management slot 84 pes_tz PATROL KM for Event Management slot 84 pes_udp_port PATROL KM for Event Management slot 84 pes_user_defined PATROL KM for Event Management slot 85 procedure verifying the setting of the CC_HOME environment variable 33 procedures deploying multiple integration instances 69 editing mcell.dir file 66 product support 3 propagation MessageBufferKeepSent parameter 98 MessageBufferKeepWait parameter 98 MessageBufferReconnectInterval parameter 98 MessageBufferResendCount parameter 98 MessageBufferSize parameter 98 parameters list 98
R
receive thread UseLocks parameter requirement 101 recovery action, PATROL 105 recovery action PATROL, in BMC II for PATROL 105 refreshAgentState 75 -remove 75 RTserver 20, 75 specifying a server for connection 48 -rtserver 75
S
security level 21 ServerDirectoryName configuration parameter 96 severity slot, event class 85 slot adapter_host, event class 85 BMC II for PATROL event class 85 event class mc_host_class 85 mc_host, event class 85 mc_host_address, event class 82, 86 mc_object, event class 86 mc_object_class, event class 86 mc_origin, event class 86 mc_origin_class, event class 86 mc_origin_key, event class 86 mc_origin_sev, event class 86 mc_parameter, event class 86 mc_tool, event class 86 mc_tool_class, event class 86 mc_tool_key, event class 86 mc_tool_sev, event class 86 severity, event class 85 status, event class 85 slots PATROL KM for Event Management mc_parameter_value 84 pes 84 pes_alarm_max 85 pes_alarm_min 85 pes_alert_date 84 pes_alert_time 84 pes_ave10 84 pes_icon_name 84
128
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
pes_last10 84 pes_last10_tp 85 pes_last10_ts 85 pes_param_status 84 pes_parent_instance 84 pes_patrol_home 85 pes_tcp_port 84 pes_tz 84 pes_udp_port 84 pes_user_defined 85 PATROL_EV event class p_agent 82 p_agent_address 82 p_agent_port 82 p_application 82 p_args 82 p_catalog 82 p_class 82 p_expectancy 82 p_instance 82 p_origin 83 p_source_id 83 p_status 83 p_type 83 specifying default trace message destination file 100 integration_name.trace file, path and alternate name 100 locks, when to use 101 trace files, number to save 101 trace files, size 100 trace messages, appending new 101 trace messages, origin 100 trace, enabling 100 state change PATROL event 104 status slot, event class 85 support, customer 3 TraceFileAppend parameter 101 TraceFileHistory parameter 101 TraceFileSize parameter 100 TraceSrc parameter 100
U
Uninstall pages Review Selections and Uninstall 36 Select Products and Components to Uninstall 36 up, down events PATROL Agent 105 updmcueid 75 UseLocks configuration parameter description 101
V
validate operations BMC II for PATROL on Unix 78 BMC II for PATROL on Windows 78 verifying $CC_HOME environment variable 33 %CC_HOME% environment variable setting 33 -version 75 virtualName 75
T
technical support 3 Trace parameter 100 TraceConfigFileName configuration parameter 100 TraceConfigFileName parameter 100 TraceDefaultFileName configuration parameter 100 TraceFileAppend configuration parameter 101 TraceFileHistory configuration parameter 101 TraceFileSize configuration parameter 100 TraceSrc configuration parameter 100 TraceSrc parameter 100 tracing parameters in Basic C APIs configuration files 100 TraceConfigFileName parameter 100 TraceDefaultFileName parameter 100
Index
129
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
130
Notes