bmc impact

132
www.bmc.com BMC Impact Integration for PATROL Installation and Configuration Guide Supporting BMC Impact Integration version 7.3.60 for PATROL December 2010

Upload: push5

Post on 27-Nov-2015

116 views

Category:

Documents


0 download

DESCRIPTION

BMC

TRANSCRIPT

Page 1: BMC Impact

www.bmc.com

BMC Impact Integration for PATROLInstallation and Configuration Guide

Supporting

BMC Impact Integration version 7.3.60 for PATROL

December 2010

Page 2: BMC Impact

Contacting BMC Software

You can access the BMC Software website at http://www.bmc.com. From this website, you can obtain information about the company, its products, corporate offices, special events, and career opportunities.

United States and Canada

Address BMC SOFTWARE INC2101 CITYWEST BLVDHOUSTON TX 77042-2827 USA

Telephone 713 918 8800 or800 841 2031

Fax 713 918 8000

Outside United States and Canada

Telephone (01) 713 918 8800 Fax (01) 713 918 8000

© 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.

Restricted rights legendU.S. Government Restricted Rights to Computer Software. UNPUBLISHED -- RIGHTS RESERVED UNDER THE COPYRIGHT LAWS OF THE UNITED STATES. Use, duplication, or disclosure of any data and computer software by the U.S. Government is subject to restrictions, as applicable, set forth in FAR Section 52.227-14, DFARS 252.227-7013, DFARS 252.227-7014, DFARS 252.227-7015, and DFARS 252.227-7025, as amended from time to time. Contractor/Manufacturer is BMC SOFTWARE INC, 2101 CITYWEST BLVD, HOUSTON TX 77042-2827, USA. Any contract notices should be sent to this address.

Page 3: BMC Impact

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

■ 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

Support by telephone or e-mail

In the United States and Canada, if you need technical support and do not have access to the web, call 800 537 1813 or send an e-mail message to [email protected]. (In the subject line, enter SupID:<yourSupportContractID>, such as SupID:12345). Outside the United States and Canada, contact your local support center for assistance.

Before contacting BMC

Have the following information available so that Customer Support can begin working on your issue immediately:

■ product information

— product name— product version (release number)— license number and password (trial or permanent)

■ operating system and environment information

— machine type— operating system type, version, and service pack or other maintenance level such as PUT or PTF— system hardware configuration— serial numbers— related software (database, application, and communication) including type, version, and service pack or

maintenance level

■ sequence of events leading to the 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

3

Page 4: BMC Impact

License key and password information

If you have questions about your license key or password, use one of the following methods to get assistance:

■ Send an e-mail message to [email protected].

■ Use the Customer Support website at http://www.bmc.com/support.

4 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 5: BMC Impact

ContentsChapter 1 Introduction to BMC Impact Integration for PATROL 11

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12BMC II for PATROL architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Events and BMC II for PATROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Example environment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Components included with BMC II for PATROL . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Related documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Chapter 2 Planning 19

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Prerequisite products and components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Operating system requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Security requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Installation location variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Installation planning worksheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Chapter 3 Installation 25

Getting started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Overview of installing BMC II for PATROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Installing BMC II for PATROL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Installing BMC Impact Integration for PATROL on UNIX where Impact Manager is already installed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Launching the common installer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Post-installation instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Verifying the CC_HOME variable setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Completing the installation on UNIX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Files installed with BMC II for PATROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Uninstalling BMC II for PATROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Chapter 4 Configuration 39

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Configuring BMC II for PATROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Default configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Custom configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Defining a management profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43PATROL events that are suppressed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Modifying the client configuration file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Contents 5

Page 6: BMC Impact

Setting event filtering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Configuring and using startup options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Updating the mcell.dir file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Configuring the high-availability feature. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Instance name and configuration settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Updating Knowledge Base files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Configuration files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Chapter 5 Startup and validation 73

Command line arguments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Starting BMC II for PATROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Stopping BMC II for PATROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Validating correct functioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

Monitoring event load. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Monitoring PATROL collectors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

Chapter 6 Event handling 81

About PATROL 7 event mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82Additional information for the PATROL KM for event management. . . . . . . . . . 84Event class slots inherited from the BMC Impact Manager event class . . . . . . . . 85BMC II for PATROL events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Event files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Chapter 7 Troubleshooting 89

Console Server authentication fails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90imServer does not start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90BII4Patrol terminated at startup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91Console Server not started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91Cannot access the management profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Unable to start BMC II for PATROL as a service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Installation fails. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93Missing cell entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

Appendix A Configuration file parameters 95

Appendix B BMC Impact Manager rules for PATROL events 103

BMC Impact Manager rules for PATROL events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104PATROL state changes and BMC Impact Manager rules . . . . . . . . . . . . . . . . . . . 104PATROL recovery actions and BMC Impact Manager rules. . . . . . . . . . . . . . . . . 105PATROL Agent status and BMC Impact Manager rules . . . . . . . . . . . . . . . . . . . . 105PATROL duplicate events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106Event processing and the PATROL KM for event management . . . . . . . . . . . . . 106

Glossary 109

Index 125

6 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 7: BMC Impact

FiguresExample of event flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Configuration file relationships . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Event catalog definition format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47Example bii4p_start.opts file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Example mcell.dir scenario 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Example mcell.dir scenario 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64BMC Impact Manager definition format for a remote BMC II for PATROL instance .

66

Figures 7

Page 8: BMC Impact

8 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 9: BMC Impact

TablesRequired software and versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20BMC II for PATROL supported platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Common Connect configuration utility supported platforms . . . . . . . . . . . . . . . . . . . 21Installation steps by window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Essential files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Configuration tasks when BMC II for PATROL is installed with BMC Impact

Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Configuration tasks when BMC II for PATROL is separate from BMC Impact

Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Startup options defined in bii4p_start.opts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Slot values for the refreshAgentState event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60Post-installation variable locations and definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Command line arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74BMC Impact Manager event class slots for PATROL 7 managed systems . . . . . . . . 82Event status enumeration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Event severity mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83PATROL KM for event management slots in the PATROL_EV event class . . . . . . . 84BMC Impact Manager slots inherited by the BMC II for PATROL event class . . . . . 85Events generated by BMC II for PATROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87bii4p.conf file parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

Tables 9

Page 10: BMC Impact

10 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 11: BMC Impact

C h a p t e r 1

1 Introduction to BMC Impact Integration for PATROL

This chapter presents the following topics:

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12BMC II for PATROL architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Events and BMC II for PATROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Example environment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Components included with BMC II for PATROL . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Related documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Chapter 1 Introduction to BMC Impact Integration for PATROL 11

Page 12: BMC Impact

Overview

OverviewBMC 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:

■ BMC Impact Manager■ PATROL Agents running any PATROL Knowledge Module■ PATROL Console Server and RTserver■ Management Profile (through the Common Connect configuration utility)

BMC II for PATROL architectureThis section presents a view of the architectural model and an example of data flow in an environment.

Events and BMC II for PATROL

With persistent buffering, you can display event information from a PATROL product in the BMC Impact Explorer (BMC IX) without losing any information in the transfer process. BMC II for PATROL integrates the event monitoring and reporting features of PATROL with the flexible event processing technology of BMC IM.

PATROL Agents and their associated Knowledge Modules (KMs) store event information. The BMC II for PATROL component subscribes to the PATROL Agents for event information. BMC II for PATROL then filters the event information to determine what should be propagated to a BMC IM. BMC II for PATROL translates the event information to one event class, PATROL_EV, that contains slots to which the incoming event information is assigned. BMC II for PATROL adapts the filtered event information into the Basic Recorder of Objects in C (BAROC) language, the only language understood by the cell, before propagating it to the BMC IM cell to which it is connected.

12 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 13: BMC Impact

BMC II for PATROL architecture

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.

1 2 3 4

Chapter 1 Introduction to BMC Impact Integration for PATROL 13

Page 14: BMC Impact

BMC II for PATROL architecture

Components included with BMC II for PATROL

The following components are included with BMC II for PATROL.

■ BMC Impact Integration for PATROL executable■ Common Connect configuration utility■ Common Connect Back End■ Client Runtime■ Configuration and setup files

BMC II for PATROL executable

BMC II for PATROL contains the BMC Impact Integration for PATROL executable, BII4Patrol. The executable launches BMC II for PATROL.

BMC II for PATROL uses three files in the BMC IM cell’s default knowledge base: bii4p.mrl, bii4p_collectors.mrl, and bii4p.baroc.

The bii4p.mrl file is a BMC IM rule file. It contains a set of rules that are used to manage the flow of PATROL events. The primary purposes of these rules are to:

■ 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 cell’s 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.

Common Connect configuration utility

The term “Common Connect” refers to a BMC Software integration technology that is built on the PATROL 7 architecture. Common Connect relies on this configuration utility to define and update the different components of integration. It is an independent utility that is designed to configure, but not monitor, PATROL Integration and Common Connect Client Managed Systems.

14 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 15: BMC Impact

BMC II for PATROL architecture

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

■ 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.

Common Connect Back End

The Common Connect Back End component is added to the PATROL Console Server. Through this component, Common Connect allows managed PATROL Systems and Common Connect client systems to share and manage event information.

The Common Connect configuration utility must be connected to a PATROL Console Server. Common Connect Back End is installed automatically with the installation of PATROL Console Server version 7.5.x onwards.

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:

■ common■ Common_Connect■ Install■ itools■ Uninstall

Configuration and setup files

The following section describes about the various configuration and setup files.

Chapter 1 Introduction to BMC Impact Integration for PATROL 15

Page 16: BMC Impact

BMC II for PATROL architecture

Managed PATROL systems

In the PATROL environment, any system where version 3.6 or later of the PATROL Agent is installed is a managed PATROL system. A managed PATROL system is linked with an RTserver cloud. To monitor this system, use the Common Connect configuration utility to specify the systems, applications, and parameters that you want to monitor.

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.

Client Configuration file (optional)

The client configuration file informs the PATROL Console Server of keyword and event attribute values for BMC II for PATROL. If you want to use settings other than the default settings for event suppression, you can create a new configuration file using the Common Connect configuration utility.

For detailed information on how to configure management profiles and configuration files with appropriate screen shots, refer to the Common Connect Configuration online Help.

All Parameters managed system query

The managed system query of All Parameters is an out-of-the-box system query used by the PATROL Console Server to get the current status of parameters when the BMC II for PATROL sends a request for this information.

The query is automatically added for all new management profiles in version 7.8.00 of PATROL Console Server. To create the query for versions prior to 7.8.00, see the PATROL Console Server and RTserver Getting Started guide.

16 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 17: BMC Impact

Related documentation

Related documentationFor 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:

■ 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:

■ 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 Developer’s Kit Web Services Developer Guide■ BMC Impact Integration Developer’s Kit Web Services API Reference Guide■ BMC Impact Integration Developer’s Kit Basic C APIs Developer Guide■ BMC Impact Integration Developer’s 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.

Chapter 1 Introduction to BMC Impact Integration for PATROL 17

Page 18: BMC Impact

Related documentation

18 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 19: BMC Impact

C h a p t e r 2

2 Planning

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Prerequisite products and components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Operating system requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Security requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Installation location variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Installation planning worksheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Chapter 2 Planning 19

Page 20: BMC Impact

Overview

OverviewThis 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.

Prerequisite products and components

Table 1 lists the products and components that must be installed, configured, and running in the computing environment before you install BMC II for PATROL.

Table 1 Required software and versions

Operating system requirements

BMC II for PATROL supports the operating systems listed in Table 2.

Software Version

BMC Impact Manager version 7.1.x or later

PATROL Console Server on either a Microsoft Windows or Solaris system

version 7.6.x or later

SmartSockets RTserver on either a Microsoft Windows or Solaris system

version 6.8.x or later

The RTserver can be installed under any account.

PATROL Agent all supported versions

The PATROL Agent must be installed and running on each PATROL managed system that you want to monitor.

web browser ■ Microsoft Internet Explorer 6.0, 7.0, or 8.0■ Mozilla Firefox 3.0

BMC II for PATROL is installed using the PATROL common installation utility, which requires a web browser.

Table 2 BMC II for PATROL supported platforms

Operating system Version Memory

IBM® AIX® 5.2, 5.3, 6.1 0.5 GB

Oracle Solaris 9, 10 0.5 GB

Red Hat Enterprise Linux® 4, 5.0, 5.1, 5.2, 5.3 0.5 GB

Microsoft Windows 2003, 2008, 2008 R2 Server 0.5 GB

20 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 21: BMC Impact

Installation location variables

The Common Connect configuration utility supports the operating systems listed in Table 3.

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.

Installation location variablesDuring the installation process, the Installation Utility records where it installs the PATROL and BMC IM components in environment variables. Various components of BMC II for PATROL require the information stored in these variables to function properly. Two important variables are MCELL_HOME and CC_HOME.

Throughout this book, all references to MCELL_HOME are represented as %MCELL_HOME% in a Windows environment and $MCELL_HOME in a UNIX® environment. All references to CC_HOME are represented as %CC_HOME% in a Windows environment and $CC_HOME in a UNIX environment.

Table 3 Common Connect configuration utility supported platforms

Operating system Memory

Microsoft Windows Servere 2003, x86 0.5 GB

Microsoft Windows Server 2008, x86 0.5 GB

Oracle Solaris 9, 32-bit, SPARC 0.5 GB

Oracle Solaris 9, 64-bit, SPARC 0.5 GB

Oracle Solaris 10, 64-bit, SPARC 0.5 GB

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

Page 22: BMC Impact

Installation planning worksheet

Installation planning worksheetUse the worksheet in this section to record information that you will need to provide during installation and configuration processes.

Information item or requirement Response Notes

About the BMC II for PATROL component

Where is the mcell.dir file saved?

The default location of the mcell.dir file is the MCELL_HOME/etc directory. The directory is usually found in one of the following locations:

Microsoft Windowsc:\Program Files\BMC Software\Impact\server

UNIX/opt/mcell

Does your computer have Common Connect components installed?

If you have previously installed Common Connect components, the CC_HOME variable is set to Installation Directory/Common_Connect.

If you are installing Common Connect components for the first time, the CC_HOME variable will be set to Installation Directory/Common_Connect during the installation.

Ensure that you install the Common Connect components that are appropriate for any other BMC Software products and components on that computer.

See “Verifying the CC_HOME variable setting” on page 33.

Which operating system is running on that computer?

See “Operating system requirements” on page 20.

22 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 23: BMC Impact

Installation planning worksheet

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.

Information item or requirement Response Notes

Chapter 2 Planning 23

Page 24: BMC Impact

Installation planning worksheet

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.

Information item or requirement Response Notes

24 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 25: BMC Impact

C h a p t e r 3

3 Installation

This chapter presents the following topics:

Getting started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Overview of installing BMC II for PATROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Installing BMC II for PATROL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Post-installation instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Verifying the CC_HOME variable setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Completing the installation on UNIX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Files installed with BMC II for PATROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Uninstalling BMC II for PATROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Chapter 3 Installation 25

Page 26: BMC Impact

Getting started

Getting startedThis 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.

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.

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.

26 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 27: BMC Impact

Overview of installing BMC II for PATROL

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.

Overview of installing BMC II for PATROLBMC II for PATROL is installed by the common installation utility on Windows platforms and UNIX platforms.

The installation requires you to

■ 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

Page 28: BMC Impact

Installing BMC II for PATROL

Installing BMC II for PATROL

You can install BMC II for PATROL using either the Typical or Custom installation type. Regardless of the type of installation you choose, you must repeat this installation process for each computer or virtual server on which you want to install BMC II for PATROL.

Before you begin

■ Review the installation checklist on page 22.

■ Stop the PATROL Console Server.

■ 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.

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.

28 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 29: BMC Impact

Installing BMC II for PATROL

Launching the common installer

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:

■ (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.

NOTE Stop the PATROL Console Server if you are installing the BMC II for PATROL on the same machine where Console Server is already installed and running. After installing BMC II for PATROL, start the PATROL Console Server.

Chapter 3 Installation 29

Page 30: BMC Impact

Installing BMC II for PATROL

Table 4 Installation steps by window (Part 1 of 3)

Window Enter or Select

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:

■ 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.

Specify Installation Directory

Perform the action that is appropriate for the products or components that you are installing:

■ 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 ■ 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 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 31: BMC Impact

Installing BMC II for PATROL

Select Products and Components to Install

Perform the action that is appropriate for the products or components that you are installing:

■ 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.

Runtime Warning Box 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 Level of Security 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.

Provide the System Root Account Properties

Perform the following actions:

■ 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:

■ 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.

Click Next to continue.

Table 4 Installation steps by window (Part 2 of 3)

Window Enter or Select

Chapter 3 Installation 31

Page 32: BMC Impact

Installing BMC II for PATROL

To complete the installation of the products and components

1 In the Review Selections and Install window, verify the product and component selections.

2 Click Start Install.

3 When the installation is complete, click Next.

Impact Integration Configuration Properties

Either accept the default information, or enter the following Impact Manager information:

■ 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.

■ 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.

■ 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.

Click Next to continue.

RTSERVERS Variable Properties window

Click Next.

Table 4 Installation steps by window (Part 3 of 3)

Window Enter or Select

32 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 33: BMC Impact

Post-installation instructions

4 You can view the installation log file or click Finish to exit the installation utility.

Post-installation instructionsAfter you install BMC II for PATROL, complete the following sections, if applicable for your environment.

■ “Verifying the CC_HOME variable setting” on page 33■ “Completing the installation on UNIX” on page 34

Verifying the CC_HOME variable setting

The Common Connect home environment variable (CC_HOME) must be set on any UNIX system on which a Common Connect client, such as BMC II for PATROL, or the configuration utility, is installed to ensure that Common Connect clients can communicate with other components in the environment.

CC_HOME environment variable setting

In this task, you verify that the setting of the CC_HOME environment variable points to the Common_Connect subdirectory under the installation directory.

The CC_HOME variable should be defined as a system variable, and it must be set to Installation_directory\Common_Connect.

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.

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.

Chapter 3 Installation 33

Page 34: BMC Impact

Post-installation instructions

To set the CC_HOME variable on UNIX

Based on your shell script, enter one of the following commands and press Enter.

■ CC_HOME = Installation_directory/Common_Connect; export CC_HOME

■ setenv CC_HOME = Installation_directory/Common_Connect

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.

Completing the installation on UNIX

If you are installing BMC II for PATROL on UNIX, use the instructions in this section.

To complete the installation on UNIX

1 Navigate to one of the following directories:

■ installationDirectory/common/bmc■ installationDirectory/Common_Connect/bin/target/

2 Depending on the navigated directory, perform one of the following:

■ 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 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 35: BMC Impact

Files installed with BMC II for PATROL

■ From the installationDirectory/Common_Connect/bin/target/ directory, enter the following command:

. ./ bii4p7rc.sh

The applicable variable is reset:

■ (AIX) LIBPATH ■ (Solaris and Linux) LD_LIBRARY_PATH ■ (HP-UX) SHLIB_PATH

Files installed with BMC II for PATROLTable 5 contains the names and functions of essential BMC II for PATROL files.

Table 5 Essential files

File name Function

BII4Patrol the BMC II for PATROL executable

bii4p.conf contains trace parameters, buffer management parameters, and the BMC IM directory

bii4p.map contains the mapping information to translate PATROL LEM events to BMC Impact Manager events

bmciiapi (Windows)libiiapi (UNIX)

library files for the BMC II for PATROL API

bii4p_strings.cat catalog files for BMC II for PATROL

bii4p.trace sets the level of trace messages and configures the trace level

bii4p.mrl, bii4p_collectors.mrl, bii4p.baroc

BMC Impact Manager Knowledge Base (KB) files

cc_be library Common Connect Back End library files

cc_be catalog (cc_strings.cat, cc_be_t.dll.sgn)

Common Connect Back End catalog files

bii4p_start.opts configuration file to set the startup options for BMC II for PATROL

bii4p7rc (UNIX) sets the environment variables for BMC II for PATROL

mcell.dir configuration file to set up the connection between BMC II for PATROL and IM cell

start_bii4p.sh enables you to start a BMC II for PATROL instance (automatically sets the required environment variables)

stop_bii4p.sh stops all the running BMC II for PATROL instances

Chapter 3 Installation 35

Page 36: BMC Impact

Uninstalling BMC II for PATROL

Uninstalling BMC II for PATROLThe uninstallation process uses the installation utility in uninstall mode. The utility lists the BMC Software products and components in a tree view that allows you to select the ones that you want to uninstall.

You may have to manually remove folders, directories, and files that remain after the automated uninstallation is complete.

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.

4 Double-click the Add/Remove Programs icon to open the Add/Remove Programs window.

5 From the list of available programs, select BMC Software Tools and click Change/Remove.

The web browser is launched.

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 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 37: BMC Impact

Uninstalling BMC II for PATROL

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.

3 Enter ./uninstall.sh and press Enter.

The Common Install installation program is launched.

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

Page 38: BMC Impact

Uninstalling BMC II for PATROL

38 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 39: BMC Impact

C h a p t e r 4

4 Configuration

This chapter presents the following topics:

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Configuring BMC II for PATROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Default configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Custom configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Defining a management profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43PATROL events that are suppressed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Modifying the client configuration file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Setting event filtering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Configuring and using startup options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Updating the mcell.dir file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Configuring the high-availability feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Instance name and configuration settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Updating Knowledge Base files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Configuration files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Chapter 4 Configuration 39

Page 40: BMC Impact

Overview

OverviewThe 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 Server6. The PATROL Console Server forwards events to BMC II for PATROL.

Configuring BMC II for PATROLThis section contains information about the auto-configuration process, a configuration checklist, information about starting the Common Connect configuration utility, and procedures to configure the client configuration file and management profile.

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 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 41: BMC Impact

Configuring BMC II for PATROL

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

■ 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:

■ 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 Configuration tasks when BMC II for PATROL is installed with BMC Impact Manager

Setup Task See

System Acontaining BMC II for PATROL and BMC Impact Manager(s)

■ Create a management profile ■ “Defining a management profile” on page 43

■ Configure startup options in bii4p_start.opts.

■ “Configuring and using startup options” on page 51

■ (optional) Update the bii4p.conf file.

■ “Configuration files” on page 70

■ (optional)Update the mcell.dir files

■ “Updating the mcell.dir file” on page 63

■ (optional)Update the BMC Impact Manager Knowledge Base files.

■ “Updating Knowledge Base files” on page 69

Chapter 4 Configuration 41

Page 42: BMC Impact

Configuring BMC II for PATROL

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

■ 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 Configuration tasks when BMC II for PATROL is separate from BMC Impact Manager

Setup Tasks See

System Acontaining BMC II for PATROL

■ Create a management profile

■ “Defining a management profile” on page 43

■ Configure startup options in bii4p_start.opts.

■ “Configuring and using startup options” on page 51

■ (optional) Update the bii4p.conf file.

■ “Configuration files” on page 70

■ Update the mcell.dir file. ■ “Updating the mcell.dir file” on page 63

42 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 43: BMC Impact

Configuring BMC II for PATROL

Defining a management profile

This section contains information about how to define a management profile. For additional details about defining a management profile, see the Common Connect configuration utility online Help.

Starting the Common Connect configuration utility

To define a management profile, you must use the Common Connect configuration utility.

To start the Common Connect configuration utility

■ 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.

System Bcontaining one or more BMC Impact Manager(s)

■ Update the mcell.dir file. ■ “Updating the mcell.dir file” on page 63

■ Update the BMC Impact Manager Knowledge Base files

■ “Updating Knowledge Base files” on page 69

Table 7 Configuration tasks when BMC II for PATROL is separate from BMC Impact Manager

Setup Tasks See

Chapter 4 Configuration 43

Page 44: BMC Impact

Configuring BMC II for PATROL

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.

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.

6 Select Open/Create Management Profile and click Next.

The Open/Create Management Profile window is displayed.

7 Enter a name for the new management profile or select one from the list, and click Next.

The Configuration Change Complete 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.

WARNING If you enter an incorrect user name or password, the configuration utility hangs, and you must restart it.

44 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 45: BMC Impact

Configuring BMC II for PATROL

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.

2 Choose the Load KMs menu command.

The KM Packages dialog box is displayed.

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

Page 46: BMC Impact

Configuring BMC II for PATROL

PATROL events that are suppressed

The following PATROL events are filtered by default and are not forwarded to the BMC Impact Manager (cell):

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.

Modifying the client configuration file

This section contains the procedure to modify the client configuration file using the Common Connect configuration utility.

PATROL event Description

Diag Backward compatibility with v2.0 and v3.0 diagnosis

Disconnect Event is triggered when the console disconnects

RegApp Application is registered and managed by the agent

Unload Event is triggered when the application is unloaded from the agent

UpdAppState New or updated application state

UpdInstState New or updated instance state

UpdMachineState New or updated state for the entire agent

WorstApp Application has the worst state of all applications in the agent

AS_EVENTSPRING:NOTIFY_EVENT

Notify events from the Event Management KM

7 A successful connection to the PATROL Agent by a user

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 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 47: BMC Impact

Configuring BMC II for PATROL

This procedure is not required. Modify the client configuration file only if you want to activate or suppress events.

Activating suppressed events

By default, the following events are suppressed, but may be activated in the Edit Client Attributes tab in the Common Connect configuration utility:

■ Diag■ Disconnect■ RegApp■ Unload■ UpdMachineState■ UpdAppState■ UpdInstState■ WorstApp■ AS_EVENTSPRING:NOTIFY_EVENT■ 7

Suppressing events

You can define any event catalog and class to suppress events using the format shown in Figure 3.

Defining the client configuration file

This section contains information about how to define the client configuration file using the Common Connect configuration utility.

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.

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.

Figure 3 Event catalog definition format

catalog;class

Chapter 4 Configuration 47

Page 48: BMC Impact

Configuring BMC II for PATROL

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:

■ 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.

The Select Common Connect Service dialog box is displayed.

5 In the Service Name list, select the name of the PATROL Console Server and click Next.

The Provide User Credentials dialog box is displayed.

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.

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.

NOTE The PATROL Console Server (with Common Connect Back End) is referred to as the Common Connect Service on this wizard dialog box.

WARNING If you enter an incorrect user name or password, the configuration utility hangs, and you must restart it.

48 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 49: BMC Impact

Configuring BMC II for PATROL

The Open/Create Configuration File dialog box is displayed.

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.

12 Either change the values in Event_Suppress_List to receive suppressed event types, or add event types to suppress. When you are finished, click Next.

The Configuration Change Complete dialog box is displayed.

13 Review the information and click Finish.

The client configuration file is saved in

■ Microsoft Windows:%PATROL_ROOT%\log\cserver\cc_client_config\

■ UNIX or Linux:$PATROL_ROOT/log/cserver/cc_client_config/

NOTE If BII4Patrol is not displayed, check to be sure that you restarted the PATROL Console Server after installing the Common Connect Back End.

WARNING After you make changes to this file, you must move the cursor to a different line or press Enter to save your changes.

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

Page 50: BMC Impact

Configuring BMC II for PATROL

Setting event filtering

After setting up the client configuration file as well as BMC II for PATROL, the PATROL managed systems and the PATROL KMs in the management profile, you can customize filters to show only the PATROL 7.1 events that you want to see in a BMC Impact Manager console.

The Common Connect configuration utility contains the following filter categories:

■ Date/Time■ Event Properties■ Common Attributes■ Custom Attributes

For more information about event filtering see the Common Connect configuration utility online Help.

Date and time filtering

Use the Date and Time filtering category to set up times for BMC II for PATROL to disconnect and reconnect to PATROL Agents. This type of filtering is useful when you want to disconnect BMC II for PATROL for periods of scheduled maintenance.

Event properties filtering

The Event Properties category allows you to specify the class, type, and severity level of the events that you want to receive.

You must select All Types and set the Event Severity to 2 if you want BMC II for PATROL to automatically close an event when the parameter returns to a normal state.

The Event Properties selection adjusts filtering for the entire managed system, including the PATROL KM for Event Management and the notification server, if they have been defined as part of the managed system in the management profile.

Common attributes filtering

The Common Attributes category allows you to filter based on the event origin for managed PATROL systems and to view only events with specific event descriptions. The filtering applies to individual PATROL Agents, not to PATROL KMs or the entire managed system.

50 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 51: BMC Impact

Configuring BMC II for PATROL

Custom attributes filtering

The Custom Attributes category allows you to pass specific events from the PATROL standard event catalog or a KM-specific custom catalog.

Query filtering

The Query Filter button in the tool bar is not used with BMC II for PATROL.

Configuring and using startup options

BMC II for PATROL uses the bii4p_start.opts file to configure certain startup options without user intervention.

Use of the bii4p_start.opts file has the following advantages:

■ Interdependencies across different components can be avoided■ Configuration of the file is simple

Available startup options

Table 8 on page 52 contains available startup options and descriptions.

NOTE The bii4p_start.opts file is located at CC_HOME\etc.

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

Page 52: BMC Impact

Configuring BMC II for PATROL

Table 8 Startup options defined in bii4p_start.opts (Part 1 of 9)

Startup option Description Default

-mprofile (required) name of the Console Server management profile, to which you have added the managed systems.

The BMC II for PATROL instance accesses this management profile and sends the events to the Impact Manager. For one BMC II for PATROL instance, you can specify only one management profile name.

no default

Note: The management profile name you enter must exactly match the name entered in the configuration utility (case sensitive).

-rtserver (required) name of the RTserver, to which the 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.cpp(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

RTSERVERS environment variable

Note: If RTSERVERS is not defined, bii4p_start.opts will use tcp:localhost:2059

52 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 53: BMC Impact

Configuring BMC II for PATROL

-cserver (required) name of the PATROL Console Server

The PATROL Console Server must be active and should be connected to the RTserver to which the BMC II for PATROL instance connects. You can specify only one Console Server for one instance.

If the BMC II for PATROL instance is unable to connect to the Console Server, the log file displays an error message similar to the following:

INFORM:11/20/2009 1:59:42 AM::120.6:BMC Impact Integration for PATROL 7 started on rtserver: <tcp:172.19.228.74:2059>.

ERROR:11/20/2009 1:59:42 AM::120.2012:Error! Object </services/PATROL_CCSERVER_HOUPERFMS6981> does not exist

ERROR:11/20/2009 1:59:42 AM::120.2005:Error in initializing bii4p service. Please check your RT server

INFORM:11/20/2009 1:59:42 AM::120.5:BII4Patrol exiting...

hostname in uppercase characters

Note: This value is always converted to uppercase.

-cell (required) BMC Impact Manager to connect to

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.

local hostname in lowercase

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.

Table 8 Startup options defined in bii4p_start.opts (Part 2 of 9)

Startup option Description Default

Chapter 4 Configuration 53

Page 54: BMC Impact

Configuring BMC II for PATROL

-instance (optional) instance name of the BMC II for PATROL process to run

Use this option whenever you need to run the second instance on the same computer where the first instance is running. You can also specify a customized instance name in this option. You need to mention this name in the mcell.dir file in the following format:

cell BII4Patrol_instanceName mchostName:portNumber

Default port number is 4097.

The mcell.dir file is located as follows:

■ (Windows) %CC_HOME%\etc\■ (UNIX) $CC_HOME/etc/

hostname in lowercase

-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:

■ (Windows) %CC_HOME%\etc\bii4p.conf

■ (UNIX) $CC_HOME/etc/bii4p.conf

The default file name is bii4p.conf. If you have configured a file with a different name, enter the same name in this option.

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.

-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)

Table 8 Startup options defined in bii4p_start.opts (Part 3 of 9)

Startup option Description Default

54 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 55: BMC Impact

Configuring BMC II for PATROL

-cfgid (optional) user configuration file ID

The BMC II for PATROL instance reads the configuration file and suppresses the events types specified in this file. You can create a configuration file by using the Common Connect Configuration Utility. The configuration file is generated on the computer where PATROL Console Server is running.

It contains the following values as default in the suppress list:

■ 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 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.

0 (no virtual name)

Table 8 Startup options defined in bii4p_start.opts (Part 4 of 9)

Startup option Description Default

Chapter 4 Configuration 55

Page 56: BMC Impact

Configuring BMC II for PATROL

-client (optional) name of the section to be searched in the cconnect.conf file for PATROL Console Server user name and password. The cconnect.conf file is located in the following directory:

%BMC_ROOT%/common/patrol.d

By default, the BII4Patrol section is searched in the cconnect.conf file that contains the PATROL Console Server user name and encrypted password.

You can use the client option when you need to configure multiple instances of BMC II for PATROL and the instances point to different Console Servers that have different user names and passwords. In this case, you need to create a separate section (for example, BII4Patrol_Test) in the cconnect.conf file and then specify the user name and encrypted password for the second PATROL Console Server in that section.

Then, you need to include the section name BII4Patrol_Test in the client option.

BII4Patrol

Note:

Use the sec_encript_p3x utility to generate the encrypted password. This utility is located as follows:

■ (Windows): %BMC_ROOT%\common\bmc\bin\opSystemDir

■ (UNIX): $BMC_ROOT/common/bmc/bin/opSystemDir

Table 8 Startup options defined in bii4p_start.opts (Part 5 of 9)

Startup option Description Default

56 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 57: BMC Impact

Configuring BMC II for PATROL

-updmcueid enables you to differentiate events coming from different BMC II for PATROL instances if these multiple instances are running on the same computer.

Values can be 0 or 1.

The default value is 0, and events coming from multiple instances are not differentiated. In this case, the mc_ueid slot does not contain adapter information.The mc_ueid slot in the default event that is sent to BMC Impact Manager has the following format: BII4Patrol/ipAddress/port/LayuotEventManagerTime/LayuotEventManagerId

If you set the value of this option to 1, events coming from multiple instances are differentiated. In this case, the mc_ueid slot contains adapter information.The mc_ueid slot in the event that is sent to BMC Impact Manager has the following format: BII4Patrol_instance/ipAddress/port/LayuotEventManagerTime/LayuotEventManagerId

The mc_ueid slot is updated with BMC II for PATROL adapter information in the following format:

■ PATROL_EV event type: mc_ueid=BII4Patrol_instanceName/IPAddress/port/ LayuotEventManagerTime/LayuotEventManagerId

■ MC_ADAPTER_* event type: mc_ueid=BII4Patrol_instanceName.msgid.msgid

0

Table 8 Startup options defined in bii4p_start.opts (Part 6 of 9)

Startup option Description Default

Chapter 4 Configuration 57

Page 58: BMC Impact

Configuring BMC II for PATROL

-mcueidHostName for PATROL events, whether to display the IP address or host name for the PATROL Agent in mc_ueid slot

Values can be 0 or 1. By default, the value of this option is set to 0.

If you set the value of this option to 1, the mc_ueid slot has the following format: BII4Patrol/hostname/port/LayuotEventManagerTime/LayuotEventManagerId

By default, the mc_ueid slot has the following format:

BII4Patrol/IP-address/port/LayuotEventManagerTime/LayuotEventManagerId

0

-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:

■ 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.

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.

Table 8 Startup options defined in bii4p_start.opts (Part 7 of 9)

Startup option Description Default

58 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 59: BMC Impact

Configuring BMC II for PATROL

-refreshAgentState Displays the current status of all parameters in the management profile in the Impact Explorer in case PATROL Agent is restarted or BMC Impact Integration for PATROL is started or restarted.

Valid values are:

■ 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.

0

Table 8 Startup options defined in bii4p_start.opts (Part 8 of 9)

Startup option Description Default

Chapter 4 Configuration 59

Page 60: BMC Impact

Configuring BMC II for PATROL

Table 9 describes the slot values for the refreshAgentState event in BMC Impact Integration for PATROL:

-agentRestartDelayTime Displays the time (in seconds) after which the All Parameters managed system query should be executed to fetch the status of all parameters after you start or restart a PATROL Agent or BMC II for PATROL. BMC recommends to configure this option as it takes some time for the parameters to be instantiated on PATROL Agent.

This option is available only when the value of the refreshAgentState is 2 or 3. If you specify a value greater than 1800 seconds, default is considered.

300 seconds

-cserverConnectionTimeOut (optional) to increase the timeout value when 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 secondsMaximum value: 300 seconds

30 seconds

Table 9 Slot values for the refreshAgentState event

Slot name Slot value assigned

msg BII4P7 RefreshAgentState ON: parameterNameParameter is in Severity state, Parameter value:parameterValueIf the parameter does not have a value, it is defined as NIL_VAL.

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.

Table 8 Startup options defined in bii4p_start.opts (Part 9 of 9)

Startup option Description Default

60 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 61: BMC Impact

Configuring BMC II for PATROL

To change the PATROL Agent password

To change the PATROL Agent password while the integration is functional with the refreshAgentState input as 2 or 3, perform the following tasks:

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.

Configuring the startup options

Configure the bii4p_start.opts file in a text editor, save it, then close it. Figure 4 contains an example bii4p_start.opts file. In this example, not all fields are defined and BMC II for PATROL will use default values.

p_catalog STD

p_class_group param_group

p_class Event class 39: Warning and Critical event states

Event class 16: Information event states

NOTE ■ 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.

Table 9 Slot values for the refreshAgentState event

Slot name Slot value assigned

Chapter 4 Configuration 61

Page 62: BMC Impact

Configuring BMC II for PATROL

Using startup options

After configuring the bii4p_start.opts file, you can start BMC II for PATROL in two ways:

■ as a service■ from the command line

This section contains information on starting BMC II for PATROL.

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.

Figure 4 Example bii4p_start.opts file

-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.

NOTE For additional startup arguments, see Chapter 5, “Startup and validation.”

62 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 63: BMC Impact

Configuring BMC II for PATROL

Updating the mcell.dir file

Use the tasks in this section to edit the mcell.dir file in BMC II for PATROL installations where you have installed onto a remote cell or where you are running multiple cells on one server.

The mcell.dir file lists the identifying information for all BMC Impact Manager instances (cells) and integration servers to which your implementation can connect and communicate.

■ 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.

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 The location of mcell.dir is configured in bii4p.conf.

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.

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

Page 64: BMC Impact

Configuring BMC II for PATROL

Example configurations of mcell.dir

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.

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.

WARNING When editing the mcell.dir file, pay special attention to case for both Windows and UNIX. mcell.dir entries must match bii4p_start.opts entries in case.

Figure 5 Example mcell.dir scenario 1

Example mcell.dir file

cell BII4Patrol_systema mc systema:4097 cell bmc_im_cellname_a mc systema:1828

Points to

BMC II for PATROL on same systemBMC Impact Manager cell on same system

Figure 6 Example mcell.dir scenario 2

Example mcell.dir files:System Acell BII4Patrol_systema mc systema:4097 cell bmc_im_cellname_b mc systemb:1828

System Bcell BII4Patrol_systema mc systema:4097 cell bmc_im_cellname_b mc systemb:1828

Points to

BMC II for PATROL on same systemBMC Impact Manager cell on System B

BMC II for PATROL on System ABMC Impact Manager cell on same system

64 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 65: BMC Impact

Configuring BMC II for PATROL

shows mcell.dir file entries for two instances of an integration running on System A where:

■ 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

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.

Editing the mcell.dir file

An integration can connect to the BMC Impact Manager instances that are defined in its mcell.dir file.

Other BMC Impact Manager instances (cells) in the network can connect with the BI integration only if the integration is defined in their mcell.dir files. The instance name is used to identify the specific integration instance BMC II for PATROL in the mcell.dir files of BMC Impact Manager instances that are enabled to connect to the integration instance.

You may need multiple instances of IM to achieve modularity in architecture. It can also reduce the burden on a single machine, thereby reducing network traffic on a particular node.

Example mcell.dir scenario 3

Example mcell.dir file:System Acell BII4Patrol_a1 mc systema:4097cell BII4Patrol_a2 mc systema:4098cell bmc_im_cell1 mc systemb:1828cell bmc_im_cell2 mc systemc:1829

System Bcell BII4Patrol_a1 mc systema:4097cell bmc_im_cell1 mc systemb:1828

System Ccell BII4Patrol_a2 mc systema:4098cell bmc_im_cell2 mc systemc:1829

Points to

BMC II for PATROL on same system BMC II for PATROL on same systemBMC Impact Manager cell on System BBMC Impact Manager cell on System C

BMC II for PATROL on System ABMC Impact Manager cell on same system

BMC II for PATROL on System ABMC Impact Manager cell on same system

Chapter 4 Configuration 65

Page 66: BMC Impact

Configuring BMC II for PATROL

To edit the mcell.dir file for a remote cell

When Impact manager is not installed on the same system as that of BII4Patrol (where cells are remotely situated), make configuration changes in the mcell.dir file present at the system where BII4Patrol is installed.

1 In a text editor, open mcell.dir.

Entries in mcell.dir are case-sensitive for both Windows and UNIX. Use the format described in Figure 7 to configure the integration instance.

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.

4 Save and close the mcell.dir file.

Configuring the high-availability feature

BMC II for PATROL supports the high-availability feature of BMC Impact Manager. In a high-availability scenario, when a server on which a BMC Impact Manager cell resides becomes unavailable, the events are routed to another cell on a server configured to be a secondary server or a failover server.

If the BMC Impact Manager cell on which BMC II for PATROL is configured resides on a server in a failover server pair, BMC II for PATROL supports the high-availability feature of BMC Impact Manager.

For information about the high-availability configuration in BMC Impact Manager, see the BMC Impact Solutions: General Administration Guide.

Figure 7 BMC Impact Manager definition format for a remote BMC II for PATROL instance

cell <integrationhostname> <encryption_code> <integrationhostname>:<port>

66 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 67: BMC Impact

Configuring BMC II for PATROL

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

Instance name and configuration settings

You can configure different instance names and configuration settings in the bii4p_start.opts file.

Generally, an integration uses only one bii4p.conf file, which is stored in the integration configuration directory. However, if you want to run multiple instances and you want each instance to have a different configuration, each instance will requires its own configuration file. Assigning a configuration file to an instance is done in bii4p_start.opts.

You can also create separate bii4p_start.opts files for each of the multiple instances and run these instances simultaneously at the same computer. Each instance has its own configuration file and bii4p_start.opts file.

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.

2 Rename the copy for the second instance (for example, bii4p_secondInstance_start.opts)

3 In the copied bii4p_start.opts file, make any necessary instance-specific changes you want to.

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

Chapter 4 Configuration 67

Page 68: BMC Impact

Configuring BMC II for PATROL

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.

3 In the bii4p_secondInstance_start.opts file, make any instance-specific changes you want to.

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 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 69: BMC Impact

Configuring BMC II for PATROL

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

Options for configuring the instances

Following are options for configuring the instances:

■ 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.

Updating Knowledge Base files

If you connect to a remote cell or a cell that is not the cell you specified when you installed BMC II for PATROL, you need to copy the BMC II for PATROL Knowledge Base (KB) files to the other cell and then rebuild the KB.

To update KB files

1 Access one of the following directories:

■ Windows: MCELL_HOME\etc\cellname\kb\classes

■ UNIX: MCELL_HOME/etc/cellname/kb/classes

2 Copy the bii4p.baroc file from the CC_HOME\etc (Windows) or CC_HOME/etc (UNIX) directory into the directory you specified in Step 1.

3 Edit the *.load file:

■ Comment out the mcxp entry

■ Add bii4p to the bottom of the file

4 Access one of the following directories:

■ Windows: MCELL_HOME\etc\cellname\kb\rules

Chapter 4 Configuration 69

Page 70: BMC Impact

Configuring BMC II for PATROL

■ UNIX: MCELL_HOME/etc/cellname/kb/rules

5 Copy the bii4p.mrl file from the CC_HOME\etc (Windows) or CC_HOME/etc (UNIX) directory into the directory you specified in Step 4.

6 Edit the *.load file:

■ Comment out the mcxp entry

■ Add bii4p to the bottom of the file

7 Access one of the following directories:

■ Windows: MCELL_HOME\etc\cellname\kb\collectors

■ UNIX: MCELL_HOME/etc/cellname/kb/collectors

8 Copy the bii4p_collectors.mrl file from the CC_HOME\etc (Windows) or CC_HOME/etc (UNIX) directory into the directory you specified in Step 7.

9 Edit the *.load 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:

■ (Windows) MCELL_HOME\bin\mccomp manifest.kb

■ (UNIX) MCELL_HOME/bin/mccomp manifest.kb

12 Restart the cell if it is already running.

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 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 71: BMC Impact

Configuring BMC II for PATROL

You can optionally configure TraceConfigFileName and the variables in bii4p.trace to specify how you want to handle trace messages.

For a complete list of parameters, see Appendix A, “Configuration file parameters.”

Table 10 Post-installation variable locations and definitions

File Variables Specifies

bii4p.conf

■ Windows:CC_HOME\etc

■ UNIX:CC_HOME/etc

ServerDirectoryName

(required) the path to the target BMC Impact Manager (cell) directory (mcell.dir)

Example:(Local) ServerDirectoryName=MCELL_HOME/etc/mcell.dir(Remote) ServerDirectoryName=CC_HOME/etc/mcell.dir

TraceConfigFileName

(optional) the path to the trace configuration file

Example:

TraceConfigFileName=$CC_HOME/etc/bii4p.trace

bii4p.trace

■ Windows:CC_HOME\etc

■ UNIX:CC_HOME/etc

ALLSERVICESYNCHMESSAGES

(optional) the level of the trace messages on a module/level basis

Example:

ALL ALL stderrSERVICE ALL NONESYNCH ALL NONEMESSAGES ALL NONE

Chapter 4 Configuration 71

Page 72: BMC Impact

Configuring BMC II for PATROL

72 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 73: BMC Impact

C h a p t e r 5

5 Startup and validation

This chapter presents the following topics:

Command line arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Starting BMC II for PATROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Stopping BMC II for PATROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Validating correct functioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

Monitoring event load . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Monitoring PATROL collectors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

Chapter 5 Startup and validation 73

Page 74: BMC Impact

Command line arguments

Command line argumentsYou can start BMC II for PATROL using command line arguments and use startup arguments to specify special conditions that you want to apply to the application.

To use command line arguments to start BMC II for PATROL, see “Command line arguments” on page 74.

For ease of use in Microsoft Windows, you can run the BMC II for PATROL client as a Windows service (see “To start BMC II for PATROL as a Windows service” on page 76).

Command line arguments table

Review the BMC II for PATROL client command line arguments (including startup arguments) for the BII4Patrol.exe file in Table 11.

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.

Table 11 Command line arguments (Part 1 of 2)

Command line argument Definition

-agentRestartDelayTime displays the time (in seconds) after which the All Parameters managed system query should be executed to fetch the status of all parameters after you start or restart a PATROL Agent or BMC Impact Integration for PATROL

-cell specifies the BMC IM (cell) name to which BMC II for PATROL will connect. The default value is the local host name in lowercase letters. This value can be a local cell or a remote cell. The -cell entry must be defined in the mcell.dir file.

-cfgid specifies the name of the configuration file as you defined it (see “Defining a management profile” on page 43).

The configuration file name is case sensitive.

Example: -cfgid solar

-client specifies the name of the section to be searched in the cconnect.conf file for PATROL Console Server user name and password

-cserver specifies the host name of PATROL Console Server to which you are connecting

Example: -cserver prod001

74 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 75: BMC Impact

Starting BMC II for PATROL

Starting BMC II for PATROLThis section contains information about startup arguments and instructions on starting BMC II for PATROL.

-debug sets the debug flag. Log information useful for debugging is displayed.

-f displays the batch input file; overrides other input options

-FQDNConfigured specifies whether to display fully-qualified domain name or only host name for the PATROL Agent.

-help displays command line arguments for BMC II for PATROL

-imConfFile specifies the BMC II for PATROL configuration file, which a BMC II for PATROL instance reads before startup. Default is bii4p.conf.

-install installs BMC II for PATROL as a service

-instance specifies the instance name. Enter the default local host in lowercase letters.

-mprofile specifies the name of the PATROL Console Server management profile to which you have added the managed systems

-mcueidHostName specifies whether to display the IP address or host name for the PATROL Agent in mc_ueid slot

-refreshAgentState displays the current status of all parameters in the management profile in the Impact Explorer in case PATROL Agent is restarted or BMC II for PATROL is started or restarted

-remove removes BMC II for PATROL from the service database

-rtserver specifies the protocol to be used for connecting, the host name of the real-time server to which you want to connect, and the port number to use for the connection

Example: -rtserver tcp:prod002:2059

-updmcueid differentiates events coming from different BMC II for PATROL instances if these multiple instances are running on the same machine

-virtualName specifies whether to display virtual name or fully-qualified domain name with the managed system name of PATROL Agent in the Impact Explorer

-version displays the version number of BMC II for PATROL

-cserverConnectionTimeOut increases the timeout value when BMC II for PATROL cannot connect to Console Server and fails to open Management profile with default time.

Table 11 Command line arguments (Part 2 of 2)

Command line argument Definition

Chapter 5 Startup and validation 75

Page 76: BMC Impact

Starting BMC II for PATROL

Before you begin

Make sure that you know the names of the following components that you want to connect to:

■ 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.

2 Type BII4Patrol and press Enter.

The startup script is launched.

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.

EXAMPLE Enter cd CC_HOME\bin\Windows-x86 and press Enter.

76 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 77: BMC Impact

Stopping BMC II for PATROL

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.

Stopping BMC II for PATROLThis section contains procedures to stop BMC II for PATROL.

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.

Validating correct functioningYou can validate whether BMC II for PATROL is running correctly on either UNIX or Windows platforms by performing the next task.

NOTE The stop_bii4p.sh script stops all the running instances of the BMC II for PATROL process.

Chapter 5 Startup and validation 77

Page 78: BMC Impact

Validating correct functioning

To validate that services are running correctly

1 Verify that the BMC II for PATROL process is running:

■ On UNIX, enter the following command:

ps -ef | grep BII4Patrol

■ 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:

■ 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 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 79: BMC Impact

Validating correct functioning

Monitoring event load

When BMC II for PATROL has been started, you can estimate the event load by looking at the activity on the cell which BMC II for PATROL is sending event information. Monitor the event load by using the mgetinfo command. This command is available in the BMC Impact Manager and its correct use is detailed in the BMC Impact Manager Administrator Guide.

Monitoring PATROL collectors

You can monitor the PATROL objects from PATROL collectors in the BMC Impact Explorer. By default, you can see objects on the Computer and Application Class level. You can also expand the object collector to the PATROL Instance level. To do so, you need to modify the collector file.

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:

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.

7 Restart the cell.

## collector PATROL.*.*.* :## PATROL_EV where [p_instance: not_equals ‘ ‘]## create $THIS.p_instance## END

Chapter 5 Startup and validation 79

Page 80: BMC Impact

Validating correct functioning

80 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 81: BMC Impact

C h a p t e r 6

6 Event handling

This chapter presents the following topics:

About PATROL 7 event mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82Additional information for the PATROL KM for event management . . . . . . . . . 84Event class slots inherited from the BMC Impact Manager event class . . . . . . . . 85BMC II for PATROL events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Chapter 6 Event handling 81

Page 82: BMC Impact

About PATROL 7 event mapping

About PATROL 7 event mappingEvents from PATROL 7 managed systems, including systems with the PATROL Knowledge Module (KM) for Event Management, are

■ 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 cell’s 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 BMC Impact Manager event class slots for PATROL 7 managed systems (Part 1 of 2)

Slot name Description

p_agent the hostname of the PATROL Agent that has reported the event

p_agent_address the Internet Protocol (IP) address of p_agent

p_agent_port the port number the PATROL Agent is using for communications

p_agent_version the version of the PATROL Agent

p_application the name of the PATROL KM

This slot can be empty when no KM is associated with the event.

p_args a list of strings containing the event attributes

p_catalog the name of the PATROL Standard Event Catalog or a customized event catalog as displayed in the PATROL Event Manager

p_class 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.

p_diary the PATROL diary

p_diary_text the array of diary text

p_diary_operator the array of lem management operator

p_diary_time the array of lem diary time

p_expectancy obsolete

mc_host_address the IP address of mc_host

p_instance the name of the PATROL instance

This slot can be empty when no instance is associated with the event.

82 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 83: BMC Impact

About PATROL 7 event mapping

Table 13 and Table 14 compare PATROL and BMC Impact Manager event statuses and severities.

p_origin the PATROL Origin as displayed in the PATROL Event Manager

p_source_id the value of the Agent Object Identifier needed by event action

p_status 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_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.

p_handler obsolete

p_node obsolete

p_owner obsolete

Table 13 Event status enumeration

Value PATROL status BMC Impact Manager status

0 OPEN OPEN

1 CLOSED CLOSED

2 ACKNOWLEDGED ACKNOWLEDGED

3 ESCALATED OPEN

4 DELETED N/A

Table 14 Event severity mapping

Value PATROL type BMC Impact Manager severity

0 OK OK

1 INFO INFO

2 WARNING WARNING

3 MINOR MINOR

4 MAJOR MAJOR

5 CRITICAL CRITICAL

Table 12 BMC Impact Manager event class slots for PATROL 7 managed systems (Part 2 of 2)

Slot name Description

Chapter 6 Event handling 83

Page 84: BMC Impact

About PATROL 7 event mapping

Additional information for the PATROL KM for event management

The PATROL_EV event class also contains slots for additional information provided by events from a PATROL KM for event management notification server that you identified in the management profile. The PATROL KM for event management events called NOTIFY_EVENT and REMOTE_NOTIFY_EVENT that are generated with the notification server name are translated to contain the origin name of the event. The events undergo this translation process as they are forwarded by BMC II for PATROL.

The additional slots in the PATROL_EV event class that enable the remapping are listed in Table 15.

Table 15 PATROL KM for event management slots in the PATROL_EV event class (Part 1 of 2)

Slot Name Description

mc_parameter_value the value of the PATROL PATROL KM for event management parameter at the time of alert

pes a Boolean flag to indicate the PATROL PATROL KM for event management source

pes_custom_id1 a custom identifier assigned to an object

pes_custom_id2 a custom identifier assigned to an object

pes_tcp_port the TCP port on which the affected PATROL Agent is listening

pes_udp_port the UDP port on which the affected PATROL Agent is listening

pes_icon_name the name of the instance as displayed on the PATROL console, such as oracle_db1

pes_parent_instance the instance name that is the parent container of instance, such as CPU/CPU

pes_param_status the value of the PATROL PATROL KM for event management parameter status at the time of the alert

pes_alert_date 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 the time zone to which the affected PATROL PATROL KM for event management system is set

pes_last10 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 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 85: BMC Impact

About PATROL 7 event mapping

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.

pes_last10_ts 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_tp the length of time, in minutes, between the first PATROL PATROL KM for event management parameter value and the last

pes_user_defined the user defined variable

This variable contains the information stored in the variable /_my_APPCLASS_APPINSTANCE_PARAMETER at the time of the alert condition.

pes_alarm_min the lowest threshold value of the current alarm range

pes_alarm_max the highest threshold value of the current alarm range

pes_patrol_home %PATROL_HOME% of the PATROL Agent

Table 16 BMC Impact Manager slots inherited by the BMC II for PATROL event class (Part 1 of 2)

Slot name Description

adapter_host the fully qualified host name of the computer on which BMC II for PATROL is running

status the event status, corresponds to the PATROL status according to Table 13 on page 83

severity the severity slot value is based on the PATROL Type according to Table 14 on page 83

mc_host 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 the operating system (OS) version of mc_host

Table 15 PATROL KM for event management slots in the PATROL_EV event class (Part 2 of 2)

Slot Name Description

Chapter 6 Event handling 85

Page 86: BMC Impact

About PATROL 7 event mapping

mc_host_address the IP address of mc_host

mc_object the name of the PATROL instance

mc_object_class the name of the PATROL KM (application)

mc_parameter 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.

mc_tool_class the string BII4PATROL7.1

mc_tool_key the PATROL event identifier

mc_tool_sev 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 the string Vagent-major-version.agent-minor-version

mc_origin 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 the PATROL event identifier

mc_origin_sev 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 A string formed as follows:

BII4Patrol/Agent IP Address/port/lem time/lem ID

mc_incident_time Time stamp the LEM event occurred

msg the text description of the event

Table 16 BMC Impact Manager slots inherited by the BMC II for PATROL event class (Part 2 of 2)

Slot name Description

86 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 87: BMC Impact

About PATROL 7 event mapping

BMC II for PATROL events

Table 17 lists the events that are generated by BMC II for PATROL. Each of these events comes from the mc_tool_class slot in BMC Impact Manager.

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.”

Table 17 Events generated by BMC II for PATROL

Event name Description

MC_ADAPTER_START indicates the integration component has started

MC_ADAPTER_STOP indicates the integration component has stopped

MC_ADAPTER_CONTROL indicates when the PATROL Agent connects or disconnects

MC_ADAPTER_ERROR indicates when the event buffer has overflowed or when events have been discarded

Chapter 6 Event handling 87

Page 88: BMC Impact

About PATROL 7 event mapping

88 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 89: BMC Impact

C h a p t e r 7

7 Troubleshooting

Use the information in this chapter to help you diagnose and correct problems.

Console Server authentication fails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90imServer does not start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90BII4Patrol terminated at startup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91Console Server not started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91Cannot access the management profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Unable to start BMC II for PATROL as a service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Installation fails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93Missing cell entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

Chapter 7 Troubleshooting 89

Page 90: BMC Impact

Console Server authentication fails

Console Server authentication failsAn error message resembling the following is displayed:

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.

imServer does not startAn error message resembling the following is displayed:

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.

ERROR:6/11/04 9:30:46 AM:::Error registering batch authentication providerERROR:6/11/04 9:30:46 AM::120.2003:to Console Server authentication failedERROR:6/11/04 9:30:46 AM::120.2008:BII4Patrol failed to connect to cserver <SWEDEN>.Reason:<aughentication rejected>INFORM:6/11/04 9:30:46 AM::120.5:BII4Patrol exiting...

INFORM:6/9/04 12:58:57 PM::120.86:Regesting BMCII trace successERROR:6/9/04 12:58:57 PM::120.2095:Error in starting imServer <>. Reason:<Service endpoint could not be bound>

90 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 91: BMC Impact

BII4Patrol terminated at startup

BII4Patrol terminated at startupAn error message resembling the following is displayed:

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.

Console Server not startedAn error message resembling the following is displayed:

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.

ERROR:6/5/04 11:10:03 AM::120.2096:Unable to retrieve directory information for server <qasunpv11>. Reason:<The requested item (such as a slot) does not exist.>ERROR:6/5/04 11:10:03 AM::120.2081:Failed to create imClient objectINFORM:6/5/04 11:10:03 AM::120.1:BMC Impact Integration for PATROL 7 stopped.INFORM:6/5/04 11:10:03 AM::120.3:BII4Patrol: Main loop interrupted...

ERROR:6/5/04 11:07:59 AM::120.2012:Error! Object </services/PATROL_CCSERVER_PVSUN1> does not existERROR:6/5/04 11:07:59 AM::120.2005:Error in initializing bii4p service. Please checkyour RT serverINFORM:6/5/04 11:07:59 AM::120.5:BII4Patrol exiting...

Chapter 7 Troubleshooting 91

Page 92: BMC Impact

Cannot access the management profile

Cannot access the management profileAn error message resembling the following message is displayed:

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.

Unable to start BMC II for PATROL as a serviceWhen you attempt to start the service, the following message is displayed:

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.

ERROR:6/5/04 11:20:38 AM::120.2011:Opening CC consumer node failed. Please check the status of Management Profile. Reason:<access denied>

BII4Patrol.exe - Unable to Locate DLL

92 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 93: BMC Impact

Installation fails

Installation failsThe installation terminates abnormally.

Reason

The Console Server was not stopped.

Action

Stop the Console Server and retry installing.

Missing cell entryAn error message resembling the following is displayed after starting BMC II for PATROL:

Reason

The cell entry is missing from the mcell.dir file.

Action

Edit the mcell.dir file.

Unable to retrieve directory information for server <romania> requested item doesn't exist / Failed to create imClient object

Chapter 7 Troubleshooting 93

Page 94: BMC Impact

Missing cell entry

94 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 95: BMC Impact

A p p e n d i x A

A Configuration file parameters

The parameters listed in Table 18 on page 96 can be used in the bii4p.conf configuration file. You can modify the bii4p.conf file before you use your integration or at any time after it is in use. After modifying the bii4p.conf file, you must restart your integration, which is described in Chapter 5, “Startup and validation.”

To activate non-default parameters, remove the hash preceding the parameter in the bii4p.conf file. To suppress parameters, add a hash before the parameter line.

Appendix A Configuration file parameters 95

Page 96: BMC Impact

Table 18 bii4p.conf file parameters (Part 1 of 6)

Group Parameter Description

Connected Impact Manager Instances

ServerDirectoryName path and name of the directory file (default file name: mcell.dir).

Default path: MCELL_HOME\etc\mcell.dir (Windows)MCELL_HOME/etc/mcell.dir (UNIX)

BMC Software recommends that you store the mcell.dir file in the integration working directory or in the MCELL_HOME/etc directory.

Notes:

■ 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 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 97: BMC Impact

Connection Management, continued

ConnectionPortRange specifies the range of ports to use for outgoing connections

For a cell, this applies to forward propagation. It is the port used on the client side (or on the propagating cell side). This is useful only to pass the event through firewalls with high restrictions. Most firewall configurations ignore source port information but require destination port information.

However, firewall configuration usually can restrict the source ports as well.

The default is (empty).

ConnectionPortReuse indicates whether or not the ports specified in ConnectionPortRange should be reused as much as possible

By default, the cell or CLI tries to reuse ports from the specified range, in the given order. When ConnectionPortReuse=No, for every new connection within the same session, the next free port from the specified range is used. Only when it reaches the end of the range will it restart at the beginning of the range.

Default=Yes

Encryption indicates whether communications are encrypted

Valid values:

■ No■ Yes (default)

Table 18 bii4p.conf file parameters (Part 2 of 6)

Group Parameter Description

Appendix A Configuration file parameters 97

Page 98: BMC Impact

Message Propagation

MessageBufferKeepSent time, in seconds, to keep sent messages buffered while waiting for an answer

Default: 300 seconds

MessageBufferKeepWait time, in seconds, that messages are retained in the buffer while waiting for the connection to be established

Default: 3600 seconds (one hour)

MessageBufferSize maximum number of messages that can be stored in the message buffer. Optional.

Default: 2000 messages

MessageBufferReconnectInterval period of time, in seconds, between attempts to connect to a BMC IM instance. Optional.

Default: 60 seconds

Notes:

■ 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 number of times to resend unanswered messages

Default: 1

Table 18 bii4p.conf file parameters (Part 3 of 6)

Group Parameter Description

98 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 99: BMC Impact

Buffered Message Retention

PersistencyEnabled enables persistency, which specifies additional buffering parameters when the buffer mode is Default

Valid values:

■ 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:

■ None ■ Low (default)■ High

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

PersistencyCleanupSizeThreshold

threshold size, in bytes, of the persistency file that activates garbage collection

PersistencyCleanupGarbageThreshold

threshold size, as a percentage of file size, of the persistency file that activates garbage collection

Buffered Message Retention, continued

PersistencyDisconnectRemoveMessages

indicates whether messages written to the persistency file are deleted when the integration disconnects intentionally from a BMC IM instance

Valid values:

■ No ■ Yes (Default)

Notes:

■ 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.

Table 18 bii4p.conf file parameters (Part 4 of 6)

Group Parameter Description

Appendix A Configuration file parameters 99

Page 100: BMC Impact

Trace Parameters Trace flag that indicates whether tracing is enabled. Optional.

Valid values:

■ YES or ON– enable tracing (default)■ NO or OFF – disable tracing

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:

■ 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 path and file name for the bii4p.trace file. Required if Trace=YES.

TraceDefaultFileName 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.

TraceFileSize maximum size, in KB, of the trace messages file. Optional.

Valid values:

■ 0 - No limit■ n - size of file in KB

Note: BMC Software recommends that the value of this parameter be no less than 500 KB.

Table 18 bii4p.conf file parameters (Part 5 of 6)

Group Parameter Description

100 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 101: BMC Impact

Trace Parameters, continued

TraceFileHistory number of trace files to be kept in history. Each file is numbered sequentially. Optional. The default value is 5 (which generates up to five shuffled trace files).

Valid values:

■ 0 – No files kept. (default)■ n - number of files to keep

TraceFileAppend when the integration is restarted, specifies whether to append new trace messages to the existing message trace file. Optional.

Valid values:

■ 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:

■ YES or ON – use locks (default)■ NO or OFF – do not use locks

Notes:

■ 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.

Table 18 bii4p.conf file parameters (Part 6 of 6)

Group Parameter Description

Appendix A Configuration file parameters 101

Page 102: BMC Impact

102 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 103: BMC Impact

A p p e n d i x B

B BMC Impact Manager rules for PATROL events

This appendix presents the following topics:

BBMC Impact Manager rules for PATROL events . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103PATROL state changes and BMC Impact Manager rules . . . . . . . . . . . . . . . . . . . 104PATROL recovery actions and BMC Impact Manager rules . . . . . . . . . . . . . . . . 105PATROL Agent status and BMC Impact Manager rules. . . . . . . . . . . . . . . . . . . . 105PATROL duplicate events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106Event processing and the PATROL KM for event management . . . . . . . . . . . . . 106

Appendix B BMC Impact Manager rules for PATROL events 103

Page 104: BMC Impact

BMC Impact Manager rules for PATROL events

BMC Impact Manager rules for PATROL eventsBMC Impact Manager processes PATROL events with the following rules:

■ adapt_param_status, adap_instance_status, adap_application_status and adap_host_status (for state changes)

■ rule alarm_and_ra (for recovery actions)■ agent_up_closes_down (for the PATROL Agent)

PATROL state changes and BMC Impact Manager rules

Often state change events correspond to other older events. These state change events can be used to close the older ones. The event information is evaluated by the rules adapt_param_status, adap_instance_status, adap_application_status and adap_host_status.

These rules evaluate event information according to the following criteria:

■ 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:

■ 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.

2. Stop the alarm and observe:

104 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 105: BMC Impact

BMC Impact Manager rules for PATROL events

■ 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.

PATROL recovery actions and BMC Impact Manager rules

When an alarm is triggered, a recovery action can run in the PATROL environment. When you execute a recovery action, a PATROL event is generated that belongs to the PATROL standard event catalog class 10, 12, or 40. In this case, BMC II for PATROL generates two PATROL_EV events, one for the alarm, Event A, and one for the recovery action, Event B.

If Event A is closed, then Event B, for the recovery action, can be closed also according to the rule alarm_and_ra.

PATROL Agent status and BMC Impact Manager rules

When a PATROL Agent is down, an MC_ADAPTER_CONTROL event is generated with the mc_tool slot set to AGENT_DOWN. When this PATROL Agent is up, an MC_ADAPTER_CONTROL event is generated with the mc_tools slot set to AGENT_UP. This event can close the previous one according to the rule agent_up_closes_down.

Appendix B BMC Impact Manager rules for PATROL events 105

Page 106: BMC Impact

BMC Impact Manager rules for PATROL events

PATROL duplicate events

Duplicate events that occur when BMC II for PATROL is started are closed according to the rule patrol_duplicates.

Event processing and the PATROL KM for event management

If the PATROL KM for Event Management is loaded and the notification server is identified in the management profile, NOTIFY_EVENT and REMOTE_NOTIFY_EVENT events are sent to BMC II for PATROL. In addition to the instance of the PATROL_EV class for all PATROL events, additional processing is performed for PATROL KM for Event Management events. The value of the second item of the string value of the p_args slot contains a list of 32 values that populate slots with the prefix pes. The mc_parameter_value slot is also populated for the PATROL KM for Event Management events; its value is set at the time of the alert.

The rule es_priority handles the PATROL KM for Event Management events, NOTIFY_EVENT and REMOTE_NOTIFY_EVENT.

For example, an alarm is generated for a disk when its available space is below a defined value, as in LDldFreeSpacePercent < 5. The PATROL KM for Event Management component is loaded on the PATROL console. This alarm generates two events, Event A and Event B.

■ 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 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 107: BMC Impact

BMC Impact Manager rules for PATROL events

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 BMC Impact Manager rules for PATROL events 107

Page 108: BMC Impact

BMC Impact Manager rules for PATROL events

108 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 109: BMC Impact

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

Aalarm

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.

APISee Application Program Interface (API).

Application Program Interface (API)A set of externalized functions that allow interaction with an applications.

attributeA 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.

BBAROC 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 IISee BMC Impact Integration product.

BMC Impact ManagerSee BMC Impact Manager.

Glossary 109

Page 110: BMC Impact

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 IWCSee 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 Manager’s 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) productAn 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 ManagerThe 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 IXSee BMC Impact Explorer.

BMC IXSSee BMC Impact Explorer Server.

Ccell

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 collectorA collector contained within another collector.

110 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 111: BMC Impact

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

classA 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.

collectorAn 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 ruleA 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 setA 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 EndA 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 clientA 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 utilityA 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

■ 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 serverThe 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

Page 112: BMC Impact

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 serviceA computer that processes data from managed systems and facilitates communications between managed systems and console systems. See also console system and managed system.

configuration fileThe configuration file defines the keywords that determine how the PATROL Integration server communicates with the PATROL Integration client.

consoleSee BMC Impact Explorer.

console serverA server through which PATROL Central communicates with managed systems. A console server handles requests, events, data, communications, views, customizations, and security.

console systemA computer that hosts user desktop applications, such as consoles, viewers, and Web browsers. See also common service and managed system.

DDelete 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 ruleAn 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 tapeA 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 collectorA special type of collector that, in response to events, can add or remove event collectors from the cell during runtime.

Eenvironment 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 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 113: BMC Impact

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

event1) 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 DiaryThe 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 managerA graphical user interface for monitoring and managing events. The event manager can be used with or without the PATROL Console.

event messageA text message related to a PATROL event, such as PATROL Integration Warning: Host node disconnected - [host name].

event propagationThe act of forwarding events and maintaining their synchronization among multiple BMC Impact Managers.

event repositorySee repository.

event typeThe 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 ViewThe BMC Impact Explorer user interface for viewing and manipulating event data.

Execute phaseThe event-processing phase in which Execute rules are evaluated and, if conditions are met, specified actions are performed.

Glossary 113

Page 114: BMC Impact

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 ruleAn 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.

FFilter 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 ruleAn 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.

Iinterface class

A BAROC class that defines the programming interface used by an MRL rule primitive, such as get_external, to return data from an external program. At cell startup, an interface class is loaded into memory. The cell invokes the executable defined in an argument of the primitive. The executable’s value is returned by the interface.

internal base classA BAROC internal class that defines the required structure for the base class from which a group of product classes is derived.

internal eventAn 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.

Kkb directory

The default directory in which a BMC Impact Manager Knowledge Base is located. The directory and basic product definitions are created during installation.

keyThe 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

Page 115: BMC Impact

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 directory’s files are to be loaded and read by a BMC Impact Manager instance.

Mmanaged 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 systemA system—usually a computer on which a PATROL Agent is running—that 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 eventEvents which are not displayed but which change the status of a current event (such as changing from open to acknowledge).

management profileA 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

Page 116: BMC Impact

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.kbA 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 fileA 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.

mccompThe rules compiler. Rules are written in the Master Rule Language (MRL). The platform-independent compiler converts them to byte code that the cell can read and process.

mcell.conf fileThe 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 fileThe 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 fileThe 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 fileThe 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 fileThe 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.

metaclassSee internal base class.

116 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 117: BMC Impact

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

MetaCollectorA 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 fileA 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.

NNew 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 ruleAn 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.

nodeA BMC Impact Manager instance that can receive only events originating on the local host system.

Oopen 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.

Pparameter

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 collectorA collector that contains child collectors to form a collector set.

Glossary 117

Page 118: BMC Impact

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 AgentThe 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 applicationThe object class—for example, CPU, printer, or disk—to which an instance and related parameters belong. In the object hierarchy, an application belongs to a specific computer or node.

PATROL ConsoleThe 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 instanceA 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 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 119: BMC Impact

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

portA 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 phaseThe event-processing rule phase in which Propagate rules are evaluated to determine the eventsto be forwarded to another cell or to an Integration product.

Propagate ruleAn 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 eventAn event that is forwarded from one cell to another cell or to an Integration product during the Propagate phase of event processing.

propagationThe 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.

Rrecovery 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 ruleA 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 phaseThe 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 ruleAn 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.

repositoryThe storage facility in which event information is stored.

Glossary 119

Page 120: BMC Impact

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 cloudLinking 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.

ruleA 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 engineSee cell.

rule typeA 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.

Sserver

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 componentA 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 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 121: BMC Impact

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 relationshipThe association of two Service-Model components. There are two types of component relationships: impact and null. See also impact relationship, null relationship.

Services ViewThe 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 componentA component that is a copy of a component existing on another cell. Shadow components are used when setting up distributed Service Models.

slotAn 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 instance’s processing. A class that is a subclass to another class inherits all the slots of the parent class.

slot changeThe process of updating the slot value of a class instance.

slot propagationThe process by which slot changes are synchronized among cells.

slot valueThe value associated with a particular slot (attribute) of a class instance.

slot value pairA slot name and its associated slot value.

SMSee Service Model.

SMCSee Service Model component.

statbld.conf fileThe 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 fileThe 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

Page 122: BMC Impact

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

stateThe 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 utilityThe utility, statbld, that periodically consolidates the data in a cell’s transactions file (xact) and writes the “saved state” of the cell to a repository (mcdb).

state change actionAn 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

■ For events, an indication of the event’s 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 forwardA 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 eventAn 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.

TTimer 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 ruleAn event-processing rule that triggers the delayed execution of another type of rule.

UUpdate phase

See New phase.

122 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 123: BMC Impact

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 clauseAn MRL rule clause used to access dynamic data and to query events.

Wwarning

An indication that a parameter has returned a value that falls within the warning range. See also alarm.

wildcardA 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

Page 124: BMC Impact

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 BMC Impact Integration for PATROL Installation and Configuration Guide

Page 125: BMC Impact

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

AACK

BMC Impact Manager event status 83action

PATROL recovery 105adapter_host

slot, event class 85agentRestartDelayTime 74alarm events

PATROL KM for Event Management 106

BBasic C APIs

multiple integration instances 69batch files

configstart.bat 43BMC II for PATROL

events, duplicate 106MC_ADAPTER_CONTROL event 87MC_ADAPTER_ERROR event 87MC_ADAPTER_START event 87monitor event load 79recovery action, PATROL 105starting, second instance on UNIX 68starting, second instance on Windows 69validate operations on Unix 78validate operations on Windows 78

BMC Impact Managerdefinition formats 66

BMC Impact Manager event status 83ACK 83CLOSED 83OPEN 83

BMC Impact Manager instance, cell 12BMC Impact Manager severity status

CRITICAL 83OK 83

BMC Software Common Installation utilityReview Selections and Install page 32

BMC Software, contacting 2buffering

buffer, maximum size 98MessageBufferReconnectInterval parameter 98MessageBufferSize parameter 98reconnect interval 98

CCC_HOME 21-cell 74cell

BMC Impact Manager instance 12-cfgid 74-client 74client configuration file 49client executable 76Client Runtime 15CLOSED

BMC Impact Manager event status 83commands

./uninstall.sh 37echo $CC_HOME 33

Common Connect Back Endand configuration 15

configstart.bat 43configuration files

multiple files, using 69parameters 96TraceConfigFileName parameter 100

Configuration Wizardclosing 49Configuration Change Complete page 49Connect to RT Server(s) page 44, 48defining client configuration files 44, 47Edit Client Attributes page 49Open/Create Configuration page 49Provide User Credentials page 44, 48Select Common Connect Client page 48Select Configuration page 44, 48starting 44, 47

configuringconfiguration file parameters 96

Index 125

Page 126: BMC Impact

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 69Trace parameter 100TraceConfigFileName parameter 100TraceDefaultFileName parameter 100TraceFileAppend parameter 101TraceFileHistory parameter 101TraceFileSize parameter 100TraceSrc parameter 100

connectingmaximum reconnect interval 98to Impact Managers 66

ConnectionPortRange configuration parameterdescription 97

ConnectionPortReuse configuration parameter 97ConnectionSetupTimeOut configuration parameter 96CRITICAL

BMC Impact Manager severity status 83-cserver 74-cserverConnectionTimeOut 75customer support 3

D-debug 75defining

BMC Impact Manager instances 66deploying

procedures for multiple integration instances 69directories

$PATROL_ROOT/log/cserver/cc_client_config/ 49/opt/bmc 30\Program Files\BMC Software 30

duplicate eventsBMC II for PATROL 106

Eediting

mcell.dir file 66encryption

Encryption parameter 97Encryption configuration parameter 97event

state change, PATROL 104event class, BMC II for PATROL

slot 85event load

monitor, BMC II for PATROL 79event status

BMC Impact Manager 83PATROL 83

eventsPATROL KM for Event Management alarm 106

events, duplicateBMC II for PATROL 106

126 BMC Impact Integration for PATROL Installation a

F-f 75FQDNConfigured 75

H-help 75

I-imConfFile 75initializing

multiple integration instances 69-install 75-instance 75integrations

multiple instances, running 69

KKM. See Knowledge ModuleKnowledge Module. See KM

Mmanagement profile

creating a duplicate 45defining 45

MC_ADAPTER_CONTROLBMC II for PATROL event 87

MC_ADAPTER_ERRORBMC II for PATROL event 87

MC_ADAPTER_STARTBMC II for PATROL event 87

MC_ADAPTER_STOP 87mc_host

slot, event class 85mc_host_address

slot, event class 82, 86mc_host_class

event class slot 85slot, event class 85

mc_objectslot, event class 86

mc_object_classslot, event class 86

mc_originslot, event class 86

mc_origin_classslot, event class 86

mc_origin_keyslot, event class 86

mc_origin_sev

nd Configuration Guide

Page 127: BMC Impact

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 86mc_parameter

slot, event class 86mc_parameter_value

PATROL KM for Event Management slot 84mc_tool

slot, event class 86mc_tool_class

slot, event class 86mc_tool_key

slot, event class 86mc_tool_sev

slot, event class 86mcell.dir file

defining BMC Impact Manager instances 66editing 66

MCELL_HOME 21-mcueidHostName 75MessageBufferKeepSent configuration parameter 98MessageBufferKeepWait configuration parameter 98MessageBufferReconnectInterval configuration parameter

description 98MessageBufferResendCount configuration parameter 98MessageBufferSize configuration parameter

description 98messages

buffer, capacity 98Microsoft Internet Explorer 20-mprofile 75multithreading

UseLocks parameter requirement 101

NNetscape Navigator 20

OOK

BMC Impact Manager severity status 83OPEN

BMC Impact Manager event status 83operations, validate

BMC II for PATROL on Unix 78BMC II for PATROL on Windows 78

Pp_agent

PATROL_EV event class slot 82p_agent_address

PATROL_EV event class slot 82p_agent_port

PATROL_EV event class slot 82p_application

PATROL_EV event class slot 82p_args

PATROL_EV event class slot 82p_catalog

PATROL_EV event class slot 82p_class

PATROL_EV event class slot 82p_expectancy

PATROL_EV event class slot 82p_instance

PATROL_EV event class slot 82p_origin

PATROL_EV event class slot 83p_source_id

PATROL_EV event class slot 83p_status

PATROL_EV event class slot 83p_type

PATROL_EV event class slot 83parameters

configuration file 96ConnectionPortRange 97ConnectionPortReuse 97ConnectionSetupTimeOut 96Encryption 97MessageBufferKeepSent 98MessageBufferKeepWait 98MessageBufferReconnectInterval 98MessageBufferResendCount 98MessageBufferSize 98PersistencyCleanupGarbageThreshold 99PersistencyCleanupSizeThreshold 99PersistencyDisconnectRemoveMessages 99PersistencyEnabled 99PersistencyFileName 99PersistencyLevel 99ServerDirectoryName 96TraceConfigFileName 100TraceDefaultFileName 100TraceFileAppend 101TraceFileHistory 101TraceFileSize 100TraceSrc 100UseLocks 101

PATROLevent class PATROL_EV 12recovery action 105recovery action in BMC II for PATROL 105state change event 104

PATROL Agent 20up, down events 105

PATROL Console Server 20and installation 15specifying a server for connection 44, 48

PATROL event status 83PATROL KM for Event Management

alarm events 106

Index 127

Page 128: BMC Impact

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_EVevent class PATROL, 12

persistency parameters 99PersistencyCleanupGarbageThreshold configuration

parameter 99PersistencyCleanupSizeThreshold configuration

parameter 99PersistencyDisconnectRemoveMessages configuration

parameter 99PersistencyEnabled configuration parameter 99PersistencyFileName configuration parameters 99PersistencyLevel configuration parameter

description 99pes

PATROL KM for Event Management slot 84pes_alarm_max

PATROL KM for Event Management slot 85pes_alarm_min

PATROL KM for Event Management slot 85pes_alert_date

PATROL KM for Event Management slot 84pes_alert_time

PATROL KM for Event Management slot 84pes_ave10

PATROL KM for Event Management slot 84pes_icon_name

PATROL KM for Event Management slot 84pes_last10

PATROL KM for Event Management slot 84pes_last10_tp

PATROL KM for Event Management slot 85pes_last10_ts

PATROL KM for Event Management slot 85pes_param_status

PATROL KM for Event Management slot 84pes_parent_instance

PATROL KM for Event Management slot 84pes_patrol_home

PATROL KM for Event Management slot 85pes_tcp_port

PATROL KM for Event Management slot 84pes_tz

PATROL KM for Event Management slot 84pes_udp_port

PATROL KM for Event Management slot 84pes_user_defined

PATROL KM for Event Management slot 85procedure

verifying the setting of the CC_HOME environment variable 33

proceduresdeploying multiple integration instances 69editing mcell.dir file 66

product support 3propagation

MessageBufferKeepSent parameter 98MessageBufferKeepWait parameter 98

128 BMC Impact Integration for PATROL Installation a

MessageBufferReconnectInterval parameter 98MessageBufferResendCount parameter 98MessageBufferSize parameter 98parameters list 98

Rreceive thread

UseLocks parameter requirement 101recovery

action, PATROL 105recovery action

PATROL, in BMC II for PATROL 105refreshAgentState 75-remove 75RTserver 20, 75

specifying a server for connection 48-rtserver 75

Ssecurity level 21ServerDirectoryName configuration parameter 96severity

slot, event class 85slot

adapter_host, event class 85BMC II for PATROL event class 85event class

mc_host_class 85mc_host, event class 85mc_host_address, event class 82, 86mc_object, event class 86mc_object_class, event class 86mc_origin, event class 86mc_origin_class, event class 86mc_origin_key, event class 86mc_origin_sev, event class 86mc_parameter, event class 86mc_tool, event class 86mc_tool_class, event class 86mc_tool_key, event class 86mc_tool_sev, event class 86severity, event class 85status, event class 85

slotsPATROL KM for Event Management

mc_parameter_value 84pes 84pes_alarm_max 85pes_alarm_min 85pes_alert_date 84pes_alert_time 84pes_ave10 84pes_icon_name 84

nd Configuration Guide

Page 129: BMC Impact

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 84pes_last10_tp 85pes_last10_ts 85pes_param_status 84pes_parent_instance 84pes_patrol_home 85pes_tcp_port 84pes_tz 84pes_udp_port 84pes_user_defined 85

PATROL_EV event classp_agent 82p_agent_address 82p_agent_port 82p_application 82p_args 82p_catalog 82p_class 82p_expectancy 82p_instance 82p_origin 83p_source_id 83p_status 83p_type 83

specifyingdefault trace message destination file 100integration_name.trace file, path and alternate name

100locks, when to use 101trace files, number to save 101trace files, size 100trace messages, appending new 101trace messages, origin 100trace, enabling 100

state changePATROL event 104

statusslot, event class 85

support, customer 3

Ttechnical support 3Trace parameter 100TraceConfigFileName configuration parameter 100TraceConfigFileName parameter 100TraceDefaultFileName configuration parameter 100TraceFileAppend configuration parameter 101TraceFileHistory configuration parameter 101TraceFileSize configuration parameter 100TraceSrc configuration parameter 100TraceSrc parameter 100tracing

parameters in Basic C APIs configuration files 100TraceConfigFileName parameter 100TraceDefaultFileName parameter 100

TraceFileAppend parameter 101TraceFileHistory parameter 101TraceFileSize parameter 100TraceSrc parameter 100

UUninstall pages

Review Selections and Uninstall 36Select Products and Components to Uninstall 36

up, down eventsPATROL Agent 105

updmcueid 75UseLocks configuration parameter

description 101

Vvalidate operations

BMC II for PATROL on Unix 78BMC II for PATROL on Windows 78

verifying$CC_HOME environment variable 33%CC_HOME% environment variable setting 33

-version 75virtualName 75

Index 129

Page 130: BMC Impact

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 BMC Impact Integration for PATROL Installation a

nd Configuration Guide
Page 131: BMC Impact

Notes

Page 132: BMC Impact

*183672**183672**183672**183672*

*183672*