bmc impact solutions 7.1- general administration

7/31/2019 BMC Impact Solutions 7.1- General Administration

http://slidepdf.com/reader/full/bmc-impact-solutions-71-general-administration 1/569

www.bmc.com

BMC Impact Solutions:General Administration

Supporting

BMC Impact Manager version 7.1

BMC Impact Explorer version 7.1

BMC Impact Portal version 7.1

October 2007



Contacting BMC Software

You can access the BMC Softwa re w ebsite at http:/ / www.bmc.com. From this website, you can obtain informationabout the company, its products, corporate offices, special events, and career opportunities.

United States and Canada

Address BMC SOFTWARE INC

2101 CITYWEST BLVD

HOUSTON TX 77042-2827

USA

Telephone 713 918 8800 or

800 841 2031

Fax 713 918 8000

Outside United States and Canada

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

© Copy righ t 2006–2007 BMC Softwa re, Inc.

BMC, BMC Software, and the BMC Softwar e logo are the exclusive p roperties of BMC Softw are, Inc., are registered with the U .S. Patent

and Tradema rk Office, and may be registered or p end ing registration in other countr ies. All other BMC tradem arks, service marks, and

logos may be registered or pend ing registration in the U.S. or in other coun tries. All other tradema rks or registered trad emarks are the

property of their respective owners.

IBM is a registered trad emark of International Business Machines Corporation.

ITIL is a registered tradem ark, and a registered comm un ity tradem ark of the Office of Government Com merce, and is registered in the

U.S. Patent an d Trademar k Office.

Linux is the registered tradem ark of Linus Torvald s in the U.S. and other coun tries.

Oracle is a registered trad emark of Oracle Corporation.

Sun , Java, and Solaris are trad emarks or registered trad emarks of Sun M icrosystems, Inc., in the U.S. and several other coun tries.

UNIX is a registered trad emark of The Open Grou p.

BMC Softwar e considers information included in this docum entation to be prop rietary and confiden tial. Your u se of this information is

subject to the terms an d cond itions of the app licable End User License Agreement for the prod uct and th e prop rietary and r estricted

rights notices included in this d ocumentation.

Restricted rights legend

U.S. Government Restricted Rights to Computer Software. UNPUBLISHED -- RIGHTS RESERVED UNDER THE COPYRIGHT LAWS OF

THE UNITED STATES. Use, dup lication, or disclosure of any d ata and compu ter software by the U.S. Governm ent is sub ject 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 amen ded from tim e to time. Con tractor / Man ufactu rer is BMC SOFTWARE INC, 2101 CITYWEST BLVD,

HOU STON TX 77042-2827, USA. Any contract notices shou ld be sent to th is add ress.

http://www.bmc.com/

http://www.bmc.com/

http://www.bmc.com/



3

Customer support

You can obtain technical supp ort by u sing the BMC Software Cu stomer Support website or by contacting Cu stomerSupp ort by teleph one or e-ma il. To expedite you r inqu iry, see “Before contacting BMC.”

Support website

You can obtain technical supp ort from BMC 24 hours a day, 7 d ays a w eek at http:/ / www .bmc.com/ support_home.

From this w ebsite, you can

s read overviews abou t sup port services and program s that BMC offers

s find the most current information about BMC produ cts

s search a database for issues similar to you rs and possible solutions

s order or d ownload p roduct documentation

s download p roducts and maintenance

s report an issue or ask a qu estion

s subscribe to receive proactive e-mail alerts when new product notices are releaseds find worldw ide BMC supp ort center locations and contact information, includ ing e-mail addresses, fax nu mbers, and

telephone numbers

Support by telephone or e-mail

In the United States and Canad a, if you need technical sup port and do n ot have access to the w eb, call 800 537 1813 or

send a n e-mail message to custom er_sup port @bmc.com. (In th e su bject line, enter SupID :< yourSupport Cont ract ID> ,

such as Sup ID:12345). Outside the United States and Ca nad a, contact you r local sup por t center for assistance.

Before contacting BMC

Have the following information available so that Customer Sup port can begin w orking on you r issue immed iately:

s prod uct information

— p rod uct nam e

— product version (release number)

— license number and password (trial or permanent)

s operating system and environment information

— m ach in e typ e

— operating system type, version, and service pack or other maintenance level such as PUT or PTF

— system hardware configuration

— ser ial number s

— related software (database, app lication, and commu nication) includ ing type, version, and service pack or

maintenance level

s sequence of events leading to the issue

s command s and options that you u sed

s 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

http://www.bmc.com/support_home


mailto:[email protected]






4 BMC Impact Solutions: General Administration



Contents 5

Contents

Part 1 General configuration and administration 29

Chapter 1 General configuration information 31

General configurat ion ov erview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Enabling integra tion between BMC Imp act Solutions compon ents and other BMC

components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Chapter 2 Managing BMC Impact Manager cells 35

BMC Im pact Manager overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

BMC Impact Manager cells . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

BMC Im pa ct Manager Know ledge Base (KB) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39BMC Imp act Manager event r epository an d State Builder . . . . . . . . . . . . . . . . . . . 40

BMC Impact Man ager comm and line inter face (CLI) . . . . . . . . . . . . . . . . . . . . . . . 40

Star ting or stopping the cell - mcell and mkill. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Stop ping or star ting a cell on UNIX comp uters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Starting or stopp ing a cell on Windows compu ters . . . . . . . . . . . . . . . . . . . . . . . . . 41

Cell configura tion tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43Configur ing m cell.conf param eters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Creating cell-specific configu ra tion files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Configur ing cells to comm unicate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Configur ing h igh a vailability cells . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Configur ing event slot prop agat ion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Configur ing p assive connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

Configur ing slots for time stam pin g. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Con figurin g en cryp tion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Reload ing cell configu ration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Mon itoring even t perform ance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Mon itoring client to cell interactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Con figurin g cell tracing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

Con figurin g m cell.trace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

Configur ing a d estinat ion for cell trace ou tput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

Send ing t race ou tput to another cell. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

Event pr ocessing er ror s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

Au tom atic notification of trace configuration changes . . . . . . . . . . . . . . . . . . . . . . 78

Interpr eting cell execution failure codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

Using the BMC IX Ad ministration view to man age cells . . . . . . . . . . . . . . . . . . . . . . . 80

Connecting or d isconnecting a cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

Viewing cell information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81



Contents 6

Con trolling cells . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Reload ing cell configura tion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

Forcing event prop agat ion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Registering for SIM not ification events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Collecting m etr ics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Chapter 3 Managing the BMC Impact Administration server 89

Over view to BMC Impact Ad ministra tion server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

Master or Stand ard BMC Imp act Adm inistration server . . . . . . . . . . . . . . . . . . . . 90

Starting and stopping th e BMC Imp act Ad ministration server . . . . . . . . . . . . . . . 91

Con figuration files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

Com man d line in terface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

Imp act Ad ministra tion cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93How to configur e BMC Imp act Adm inistration server files . . . . . . . . . . . . . . . . . . . . . 94

Guidelines for m anual ed its. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

How grou ps, roles, and permissions are related . . . . . . . . . . . . . . . . . . . . . . . . . . . 95Defin ing grou p roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Defin ing permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

Receiving synchronized data from the BMC Portal . . . . . . . . . . . . . . . . . . . . . . . . 102File-based au then tication: upda ting u ser information. . . . . . . . . . . . . . . . . . . . . . 103

Synchronizing cell inform ation w ith BMC Atr ium CMDB. . . . . . . . . . . . . . . . . . 105Up dating cell information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

Editing logging prop erties for IAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

Defining client logging for the iadmin scrip t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108Custom izing colors for sever ities, statuses, and pr iorities . . . . . . . . . . . . . . . . . . 109

Defining standalone, primary, and second ary BMC Imp act Adm inistration

servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109Defining an HA configuration for the Impact Administration cell . . . . . . . . . . . 112

Transaction and trace logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

Ad vanced tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

Configuring th e BMC Impact Adm inistration server to sup port r emote

actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

Configuring Lightw eight Directory Access Protocol for BMC Imp act

Ad minist ra tion server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

Chapter 4 Managing the BMC Impact Portal 125

Accessing th e BMC Imp act Portal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

Star ting and stop ping th e BMC Porta l . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126Starting and stopp ing the BMC Por tal on Wind ows . . . . . . . . . . . . . . . . . . . . . . . 127

Starting and stopp ing the BMC Por tal on UN IX . . . . . . . . . . . . . . . . . . . . . . . . . . 127Configuration tasks for BMC Im pact Portal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

Registering p rod uction and test cells in th e BMC Imp act Portal . . . . . . . . . . . . . 128

Custom izing BMC Imp act Portal configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . 128Configur ing Dashboard Table View colum ns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

Configur ing Events Table colum ns. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129Changing the Console Navigation Tree icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

Configur ing Statu s Table colum ns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

Configur ing ob ject link syn chron ization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131



Contents 7

Con figurin g reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

Configuring the n um ber of events disp layed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

Changing the m aximu m nu mber of recent items displayed . . . . . . . . . . . . . . . . 134Configuring the general p rop erties displayed . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135

Setting up Image Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

Mod ifying connection settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136Configura tion file and pa ram eter definitions for BMC Imp act Portal. . . . . . . . . . . . 137

smsIw c/ app lication.prop erties file and par ameters . . . . . . . . . . . . . . . . . . . . . . . 137

smsCon soleServer/ application.properties file and par ameters. . . . . . . . . . . . . . 138

ixs.prop erties file and parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

Chapter 5 Managing the BMC Impact Explorer (BMC IX) console 143

Con necting BMC IX to a BMC Impact Portal. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144Specific configura tion tasks in BMC IX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

Defining a u ser’s hom e d irectory on Wind ows . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

Defin ing property files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146Defin ing console-w ide policy files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

Configur ing d isplay and connection settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

Defining global event severity an d pr iority color valu es . . . . . . . . . . . . . . . . . . . 151Event group configuration files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

XML files that d efine user in terface elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

Chapter 6 Working with Infrastructure Management 155

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156

Default Infrastru cture Man agement service mod el . . . . . . . . . . . . . . . . . . . . . . . . 156

Roles an d perm issions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

Walkth rough . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157Displaying th e ou t-of-the-box real-time service mod el . . . . . . . . . . . . . . . . . . . . . 158

Sam pling context-sensitive information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160Man aging files on remote systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

Packaging su pport files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

Lau nch ing rem ote actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164Comm on Infrastructure Managemen t tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

Navigat ing the GUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166Displaying and un derstand ing the Details and Ad minister tab da ta . . . . . . . . . 169

Editing infrast ru cture relation ship s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

Crea ting logical componen ts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

Delet ing components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175Execut ing rem ote action s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

Execut ing oth er action s. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179Con figurin g th e au d it log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

Crea ting the supp ort package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

Background to Infrastructure Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185Imp act Ad ministra tion cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

Imp act Ad ministra tion server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186Unidirection al event flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

Remote actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187




Chapter 7 Configuring BMC Impact Event Adapters 191

Con figuration overv iew . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

Ad ap ter definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

Con figuration tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192About th e mcxa.conf file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196

Con figuration file stru cture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196

Con figura tion file definition s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

msend comm and configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

Param eter typ es . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

Globa l param eter s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200

Com mon param eters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202

Specific parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204

App lying configu ration chan ges d ur ing ru n-time . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211

BMC Imp act Event Log Adap ter for Wind ows configur ation. . . . . . . . . . . . . . . . . . . 211

Chapter 8 Defining presentation names 213

Presen tat ion n am es overv iew . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214Presen tation name resource file locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214

Defau lt pr esentation name definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

Creating a new presen tation name resou rce file . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

Presen tation name resou rce files search order . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217

Defining presentat ion names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218

Creating or m od ifying p resen tation name keys . . . . . . . . . . . . . . . . . . . . . . . . . . . 218

Digitally signin g a .jar file with a d igital test certificate . . . . . . . . . . . . . . . . . . . . . 220

Enabling or disabling presentation names in

BMC Impact Exp lorer tool tip s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

Chapter 9 Configuring StateBuilder and gateways 223

Understanding the StateBuilder and gatew ays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224

StateBuild er con figu ration file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225statbld retu rn codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225

Gatew ay configu ration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226

Export ing events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231Mod ifying a s tatbld .conf file to export even ts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

Mod ifying a gatew ay.export file to expor t even ts . . . . . . . . . . . . . . . . . . . . . . . . . 232Con figuring tr acing for StateBuilder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233

Part 2 Event management administration 235

Chapter 10 Event management overview 237

Even t m anagem ent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237Even t collection sou rces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238

Event m anagem ent in BMC Impact Explorer console . . . . . . . . . . . . . . . . . . . . . . 239

Event flow for service impact mana gement and event man agement . . . . . . . . . 241

BMC Im pact Explorer Ad ministra tion View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242

Event managem ent policy d efinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243



Contents 9

Dynamic data definition using the Dyn amic Data Ed itor . . . . . . . . . . . . . . . . . . . 243

BMC Im pa ct Manager cell managem ent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243

Chapter 11 Working with the Dynamic Data Editor 245

Abou t d ata classes and dynam ic data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246

Dynamic data definition using the Dyn amic Data Ed itor . . . . . . . . . . . . . . . . . . . 246

Naviga ting the Dynam ic Data Ed itor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246

Navigat ion pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

Toolbar fu nctions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248

Filtering and sort ing the Data List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248

Filtering slots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248

Sorting d ata fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

Working with d ata instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252Extended Deta ils tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

Intern als tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

Data instan ce context m enu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253Ad ding a n ew data instance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

Editing slots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255

Export ing data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256

Chapter 12 Implementing event management policies 259

What is an even t managem ent policy? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260

How an event m anagemen t policy differs from a ru le . . . . . . . . . . . . . . . . . . . . . 261

When to u se an event m anagement p olicy rather than a ru le . . . . . . . . . . . . . . . 261

Event managem ent policy types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261

How standar d event m anagement p olicies differ from dyna mic data enrichment

policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263Ou t-of-the-box even t m anagem ent policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264

How even t m anagem ent policies work . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265Event m anagemen t policy workflow overv iew . . . . . . . . . . . . . . . . . . . . . . . . . . . 265

Even t selectors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266

Even t selector g roups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266Even t selection criter ia . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267

Timeframes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268Evaluation ord er of event p olicy types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269

Com piling even t p olicies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270

How dyn amic data enrichm ent event man agement p olicies work . . . . . . . . . . . . . . 270

How to create a n ew local timefram e . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274How to ad d a not ification service (notification p olicies only). . . . . . . . . . . . . . . . . . . 276

How to create an d ed it a dyn amic data enrichment sou rce file . . . . . . . . . . . . . . . . . 277Using the samp le PATROL messaging text translation d ynam ic data enrichment

sou rce file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279

How to create an even t selector an d specify event selection criteria . . . . . . . . . . . . . 281Creating n ew stand ard event m anagemen t policies. . . . . . . . . . . . . . . . . . . . . . . . . . . 285

Crea ting a new stan dard blackou t policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285Crea ting a new closure policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288

Crea ting a new correlat ion p olicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291

Crea ting a new enr ichment policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294




Creating a new escalation policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297

Creating a new notification policy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

Creating a new prop agation p olicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306Creating a n ew recurrence p olicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308

Creating a new supp ression policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311

Creating a n ew thr eshold policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313Creating a new timeou t policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317

Enabling and d isabling ou t-of-the-box stand ard event managemen t policies . . . . . 320

Creating a new dyn amic data enrichment event m anagement policy . . . . . . . . . . . . 321

Enabling out-of-the-box dynam ic data enrichm ent event m anagement policies . . . 332

Enabling a d ynam ic data en richmen t blackout p olicy . . . . . . . . . . . . . . . . . . . . . . 333

Enabling a d ynam ic data en richmen t location p olicy . . . . . . . . . . . . . . . . . . . . . . 336

Enabling a d ynam ic data en richmen t service contact policy . . . . . . . . . . . . . . . . 340

Enabling a dynamic enrichm ent PATROL message text translation policy . . . . 343

Imp orting d ynam ic data en richm ent source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347

Verifying th at the policy is ru nn ing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348

Editing event selection criter ia . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348Delet ing an event selector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349

Chapter 13 Creating and implementing user-defined policies 351

Understanding u ser-d efined even t policy typ es . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352

Und erstanding event processing ru les (MRL) for policy types . . . . . . . . . . . . . . . . . . 352

Format of even t p rocessing ru les for policy typ es . . . . . . . . . . . . . . . . . . . . . . . . . 352How a ru le for a p olicy type is processed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353

Sources of inform ation abou t ru les . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353User-defined even t p olicy typ e creation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354

Creating user-d efined policy typ es . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354

Defining the p olicy d ata class for a n ew policy typ e . . . . . . . . . . . . . . . . . . . . . . . 354Defining presentation n ames for a new policy type . . . . . . . . . . . . . . . . . . . . . . . . 356

Creating th e event p rocessing rule(s) for a new policy type . . . . . . . . . . . . . . . . . 357

Chapter 14 Building event groups and image views 359

Understa nd ing event groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360

Types of event grou pings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360

Even t grou p configu ration files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361

Even t tree h iera rchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362

Event tr ee objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362

Understa nd ing image v iews . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363Plann ing event groups and image view s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364

Working with event groups and image view s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365

Creating an event grou p (event tr ee top -level) nod e . . . . . . . . . . . . . . . . . . . . . . . 365

Creating an event group subn ode (event tree nod e) . . . . . . . . . . . . . . . . . . . . . . . 366

Deleting an event group subn ode (event tree top -level nod e) . . . . . . . . . . . . . . . 367

Hiding a collector in an even t group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367

Show ing a hid den collector in an even t group . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368Putting an even t grou p into p rod uction or d evelopment . . . . . . . . . . . . . . . . . . . 368

Adding a custom image view to an event group . . . . . . . . . . . . . . . . . . . . . . . . . . 369

Granting u ser access to event groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371



Contents 11

Part 3 Appendixes 373

Appendix A Trouble-shooting 375

Trou ble-shooting BMC Imp act Man ager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375

Problem : The cell will not st ar t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375Problem: The p rimary and secondary servers for my h igh availability cell are in

active mode simultan eously or a re u nsyn chronized . . . . . . . . . . . . . . . . . . . . . 376

Problem: There are two notification objects from the Imp act Portal in the cell. 377

Trou ble-shootin g even t m anagem ent policies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377

Prob lem: The policy is not ru nn ing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377

Problem: The notification p olicy is configured to generate a n otification em ail,

bu t no em ail is being sen t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378

Problem: I receive an invalid d ata error w hen ru nning a d ynam ic dataenrichment p olicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378

Problem: I receive an error message when run ning a d ynam ic data enr ichm ent

blackout p olicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379Trouble-shooting tools for dyn am ic data enr ichm ent p olicies . . . . . . . . . . . . . . . 380

Appendix B BMC SIM and EM CLI Reference 381

BMC Im pact Man ager CLI commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382

BMC Imp act Manager CLI common comm and options . . . . . . . . . . . . . . . . . . . . 383

BMC Impa ct Manager CLI common r etu rn codes . . . . . . . . . . . . . . . . . . . . . . . . . 384

mccomp—Comp iling ru les in the Know ledge Base. . . . . . . . . . . . . . . . . . . . . . . . 385

mcell—Start ing a cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386

mcfgtrace—Configuring tracing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389

mclassinfo—Requ esting class in formation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390

mcollinfo—Getting in formation abou t a specific collector . . . . . . . . . . . . . . . . . . 396

mcontrol—Perform ing cell cont rol opera tions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398

mcrtcell—Creating a n ew cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401mcstat—Returning cell statu s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405

mdelcell—Deleting a cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406

mgetinfo—Retrieving information abou t a cell . . . . . . . . . . . . . . . . . . . . . . . . . . . 408mgetrec—Obtaining a g lobal record valu e . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412

mkb—Up dating the Know ledge Base . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414

mkill—Stop ping a cell. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417mlogchk—Performing con sistency checks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418

mp kill—Stopp ing mp oster and msen d server p rocesses . . . . . . . . . . . . . . . . . . . 420mp oster and msend —Managing d ata, global records, and events . . . . . . . . . . . 422

mqu ery—Retrieving objects from a cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427

mrecover—Recover ing from a catast rop hic da ta loss . . . . . . . . . . . . . . . . . . . . . . 432mrextract—Extracting cell state files to create new state files . . . . . . . . . . . . . . . 434

mrm erge—Mer ging even t objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436

msetmsg—Mod ifying an even t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437msetrec—Setting the valu e of a global record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439

BMC Im pa ct Manager CLI configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440Configuring tracing for BMC Imp act Manager CLI command s . . . . . . . . . . . . . 442

BMC Im pa ct Manager CLI trace configu rat ion . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442




Appendix C mcell.conf file parameters 443

Action resu lt event param eters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444

Cell configuration param eter s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444

Cell failover configurat ion p arameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446Client communication pa rameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447

Encryp tion param eter s. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449

Event r epository cleanu p parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450

Hear tbea t p aram eter s. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452

Internal cell monitor pa ram eters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455

KB param eters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455

Prop agation param eter s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456

Repor ting client connection p arameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459

Service m od el param eter s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460

StateBuild er p aram eter s. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460

Trace param eter s. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461

Appendix D Environment variables 465

Microsoft Window s env ironment var iables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466

Recreating env ironment var iables on Wind ow s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466

UN IX environment var iables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467

Recreating env ironment var iables on UN IX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467

Appendix E BMC Microsoft Windows services and UNIX processes 469

BMC Microsoft Wind ow s services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470

BMC UN IX processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470

Appendix F BMC Impact Event Adapters MAP files 473

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473

Defau lt MAP files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474

Custom map s an d map-related files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474

Cu stom MAP files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474

Custom ized Perl MAP-fun ctions file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475

MAP file structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475

Section s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475

Directives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486

Appendix G IP Adapters 489

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489

IP Ad ap ter architectu re . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490

IP Ad ap ters configu ration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490IP Ad ap ter typ es . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491

TCP Clien t Adap ter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491

TCP Server Ad ap ter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494Telnet Ad ap ter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496

UDP client Adap ter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500UDP server Ad ap ter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503



Contents 13

Appendix H BMC Impact Event Adapters parsers 505

Wh at a parser does . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505

LogFile, Perl EventLog for Wind ows, and SNM P Ad ap ter p arsers . . . . . . . . . . . . . . 505

IP Ad ap ter parsers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507Specifying a CSV parser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507

Specifying a Fixed-width (colum n) p arser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509

Specifying Record and Field separated pa rser . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514

Appendix I Backend processes for publishing and unpublishing MIB files 517

The p ub lish MIB files back-end process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517

The u np ublish MIB files back-end process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518

Glossary 521

Index 555



Figures 15

Figures

Attribu te Precedence information for enabling integrat ion . . . . . . . . . . . . . . . . . . . . . 33

Con nectionPor tRan ge syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Format of an ent ry in the mcell.dir file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Examp le of the m cell.dir file and its entr ies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Distributed event ma nagem ent using event p rop agation . . . . . . . . . . . . . . . . . . . . . . 61Passive con nection form at . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

Data object specificat ion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

mcell.mod ify file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Maskin g syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Format of configuration line in mcell.trace file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Excerp t from ldap_configuration .xml file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117defau lt.econ.config file conten ts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

Op erator.econ .config file conten ts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146Defau lt policy file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

Defau lt Infrastr ucture Man agem ent service mod el . . . . . . . . . . . . . . . . . . . . . . . . . . . 156

Infrast ru cture Man agem ent navigation pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159Default service model BMC Imp act Solutions (with active services) . . . . . . . . . . . . 160

Edit Relationships d ialog w ith Edit This Relationsh ip subd ialog . . . . . . . . . . . . . . . 174

Action s right -click menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177High av ailability (HA) view : tw o cell servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

mcxa.conf file structu re . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

Param eter and valu e examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

Listing of the contents of a keystore file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

Param eters u sed to p rint even t in BAROC form at . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230

Example of prin ted even ts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230

Com mand to configu re th e export file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

gatew ay.exp ort file form at . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232

gatew ay.explore file outp u t for new even ts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232

gatew ay.explore file outp u t for mod ified even ts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233

Service imp act and event m anagemen t p rocess flow . . . . . . . . . . . . . . . . . . . . . . . . . 242Dyn amic Data Ed itor N aviga tion Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

Dyn am ic Data Editor toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248Slot Quick Filter d ialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249

Unfiltered data list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250

Typ e field list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254Message bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254

New data instance created w ith the N ew Cop y option . . . . . . . . . . . . . . . . . . . . . . . 255

Typ e field List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255Export Data d ialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256

Export Data d ialog box—Selecting the d ata form at . . . . . . . . . . . . . . . . . . . . . . . . . . 256




Con ten ts of mcda ta.csv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257

Export file containin g four d ata instan ces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257

Event m anagem ent p olicy d efinition w orkflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265Even t selector grou p name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267

Flow of data requ ired to implem ent a dyn amic data enrichmen t policy . . . . . . . . . 270

Defau lt PMEP ev ent classes and slots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273Timefram es . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274

Timefram e Ed it . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275

Example ed ited location.csv file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278

Samp le row s in the TextTranslation .csv file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280

Variable syntax example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281

Selector Deta ils tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282

Class Chooser d ialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283

Selection Definition section of the Ad d Event Criteria ed itor . . . . . . . . . . . . . . . . . . . 284

Examp le event selection criteria expression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284

Com pleted even t selection criter ia in Selector Details tab . . . . . . . . . . . . . . . . . . . . . . 284

Blackou t Policy Deta ils tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287Closu re Policy Deta ils tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289

Correla tion Policy Details tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292Enr ichm ent Policy Deta ils tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295

Escalation Policy Details tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299

Time Escalation Con trols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301Rate of Event Ar rival Con trols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

Notification Policy De tails tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304

Propagation Policy Details tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307Prop agation cell list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308

Recurrence Policy Details tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310

Sup pression Policy Details tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312Threshold Policy Details tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315

Hold Even ts option s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316Pass Even ts Through op tions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317

Timeout Policy Details tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318

List of event management p olicies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320Dyn am ic Enrichment Policy Deta ils tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323

Imp ort confirm ation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326

Dyn am ic Blackou t Policy Deta ils tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328


Dyn am ic Blackou t Policy Deta ils tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334

Imp ort Data Confirmation d ialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336List of ou t-of-the-box dynam ic data enr ichmen t policies . . . . . . . . . . . . . . . . . . . . . . 337

Dyn am ic Enrichment Policy Deta ils tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338


List of ou t-of-the-box dynam ic data enr ichmen t policies . . . . . . . . . . . . . . . . . . . . . . 340



List of ou t-of-the-box dynam ic data enr ichmen t policies . . . . . . . . . . . . . . . . . . . . . . 344



Import tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347



Figures 17

History tab showing executed d ynam ic data enrichment policy . . . . . . . . . . . . . . . 348

Even t tree h iera rchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362

Image v iew widgets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363Cu stom image view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364

Even t Grou p ed itor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365

Even t tree nod e ad d ition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366Image View ed itor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370

Invalid d ata er ror : dynam ic enr ichment p olicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379

Invalid timefram e error: dynamic blackou t policy . . . . . . . . . . . . . . . . . . . . . . . . . . . 379

mccomp syn tax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385

mccomp exam ple . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386

Example ou tp ut for mccomp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386

mcell syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386

Star ting a cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387

Star ting a cell as a service on w ind ows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388

Starting th e BMC Imp act Manager service on Microsoft Wind ows . . . . . . . . . . . . . 388

mcfgtrace syn tax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389mcfgtrace exam ple . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390

mclassinfo syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391Raw ou tput form at for mclassinfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391

Class tree for mclassinfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392

Examp le of mclassinfo comm and for a list of classes . . . . . . . . . . . . . . . . . . . . . . . . . 393Example ou tpu t of mclassinfo comm and for a list of classes . . . . . . . . . . . . . . . . . . . 393

Examp le of mclassinfo command for list of classes . . . . . . . . . . . . . . . . . . . . . . . . . . . 394Examp le of mclassinfo comm and ou tput for list of classes . . . . . . . . . . . . . . . . . . . . 394

Example of mclassinfo command for add ing slot nam es . . . . . . . . . . . . . . . . . . . . . . 394

Example of mclassinfo command ou tpu t for ad d ing slot nam es . . . . . . . . . . . . . . . 395

Examp le of mclassinfo comm and for a dd ing slot flags . . . . . . . . . . . . . . . . . . . . . . . 395Example of mclassinfo command ou tpu t for add ing slot flags . . . . . . . . . . . . . . . . . 395

mcollinfo syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396Raw ou tp ut format for mcollinfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397

mcollinfo example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397

mcollinfo comm and for verbose m od e . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398mcollinfo comman d for nu mber of events for severity/ status . . . . . . . . . . . . . . . . . 398

mcontrol syn tax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398

Retrying Pend ing p ropagations w ith mcontrol comm and . . . . . . . . . . . . . . . . . . . . . 400

Examp le of mcontrol comm and outp ut for retrying pen ding p ropagations . . . . . . 400

Terminating a cell u sing th e mcon trol command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400

Example of mcontrol comm and outp ut for terminating a cell . . . . . . . . . . . . . . . . . . 401Reconfigurin g a cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401

Example of mcontrol command outpu t for reconfigu ring a cell . . . . . . . . . . . . . . . . 401

mcrtcell syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403

Example of mcrtcell command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404

Example of ou tpu t of mcrtcell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404

Example of mcrtcell command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404

Example ou tp ut of mcrtcell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404

mcstat syn tax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405

mcstat exam ple . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406

Message for cell not runn ing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406




Message for cell runn ing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406

mdelcell syn tax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407

Delet ing a cell using m delcell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407Ou tput for m delcell if cell is not runn ing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407

Ou tp ut for mdelcell if cell is ru nn ing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407

mgetin fo syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408Example of mgetinfo config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410

mgetinfo config comm and ou tput on UN IX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410

mgetinfo config comman d outp ut on Microsoft Wind ows . . . . . . . . . . . . . . . . . . . . . 411

Example of mgetinfo p aram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411

mgetinfo p aram comm and ou tput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411

Example of mgetinfo serv ices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411

mgetinfo p aram comm and ou tput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412

Example of mgetinfo serv ices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412

Ou tp ut of m getinfo conn ect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412

mgetrec syn tax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413

Example of m getrec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413Ou tp ut of m getrec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413

mkb syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414mkb com mand on UN IX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416

mkb outp ut on UN IX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416

mkb com mand on Microsoft Window s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417mkb command ou tpu t on Microsoft Wind ows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417

mkill syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417Exam ple of m kill . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418

Ou tp ut of m kill . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418

mlogchk syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419

Example of mlogchk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419Ou tp ut of m logchk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419

mlogchk m essage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420mpkill syn tax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420

Example of m pkill . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421

Ou tp ut of m pkill . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421mposter syn tax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422

msend syn tax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423

Example of m poster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424

mposter BAROC-style input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424

mposter BAROC-style ou tp ut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424

mposter BAROC-style input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424mposter BAROC-style ou tp ut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425

Definition changes u sing mposter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425

Enabling persisten t bu ffering u sing m poster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425

Sup plying a list of cells for mposter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426

Error message if buffers files are n ot w ritable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426

mqu ery syn tax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427

Example of raw ou tp ut specification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429

Verbose m od e op tions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429

End of form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429

Special BAROC format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429



Figures 19

Examp le of mqu ery—Select events with sever ity statu s . . . . . . . . . . . . . . . . . . . . . . 431

Examp le of mqu ery—Select events from collector . . . . . . . . . . . . . . . . . . . . . . . . . . . 432

Delet ing even ts u sing mqu ery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432mrecover syn tax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433

Fixing a broken cell using m recover . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434

mrext ract syn tax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435Example of mrext ract . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435

mrm erge syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436

Example of mrm erge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436

msetm sg syn tax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437

Usin g m setm sg to close an even t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438

msetrec syn tax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439

Example of msetr ec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439

comm and to send tracing ou tput to text file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442

Example of H ear tbeat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453

Com ments cod e exam ple . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477

Slot assign ment formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478INIT structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483

DEFAULT stru ctu re . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483CLASS leaf stru cture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484

Nested class mapping Stru cture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484

Class na me exam ple . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485mcsyslogd .map file excerp t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486

Map call . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487Sam ple TCP Client Ad ap ter configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493

Sam ple TCP server ad ap ter Configu rat ion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495

Sam ple Telnet Ad ap ter configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499

Sam ple UDP client Ad ap ter configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502Sam ple UDP Server Adap ter configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504

Sam ple CSV parser specification exam ple . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509Fixed-wid th parser sp ecification exam ple . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512

Record and Field Separated Parser Specification Examp le . . . . . . . . . . . . . . . . . . . . 516



Figures 21



Tables 23

Tables

BMC Impact Solut ions configu ration process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Cell configura tion tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Substitution p aram eters for %X in path value p aram eters . . . . . . . . . . . . . . . . . . . . . . 45

Defau lt mcell.propagate op tions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

IP Ad dress param eter s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Files for cell recon figuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

MC_CELL_METRIC slots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Defau lt valu es for client p arameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72MC_CELL_CLIENT slots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

MC_CELL_MODIFIED_EVENT slots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

Trace configurat ion file param eters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74MC_CELL_PROCESS_ERROR slots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

BMC Im pact Manager exit codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79SIM_N OTIFICATION _REGISTRY d ialog box fields . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

iad min options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

Grou ps an d roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95BMC Impact Explorer u ser grou p m apping to fun ctionality . . . . . . . . . . . . . . . . . . . 98

Cell en try format in cell_info.list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

Server logging propert ies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108IAS synch ronization p ropert ies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

mcell.dir entr ies for H A pa ir of Imp act Adm inistration cells . . . . . . . . . . . . . . . . . . 112

IAS log files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

LDAP configu ration param eter s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

Even t op erations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

Event Table colum n d efault valu es . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

Statu s table colum n d efault valu es . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

Report p aram eter s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

ap plication.propert ies file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

ap plication.propert ies file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

aggregator.prop ert ies file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140ixs.pr operties file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

default.console_policy.prop parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147Prop erty description s from ix.prop erties file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

Even t severity levels an d colors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

Even t priority levels and colors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152Even t grou p configu ration files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

xml files that d efine user interface elemen ts in BMC IX . . . . . . . . . . . . . . . . . . . . . . . 153

Supported ap plication group s in ver sion 7.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157Icon listing for in frastructure managem ent m od el . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

Slot valu es: Details: General su btab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169




Slot valu es: Details: Other subtab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

Edit Relationship d ialog: field description s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

Edit This Relation ship subd ialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175Au dit log p aram eters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

Au dit log IAS prop ert ies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

Slots for specifying support files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183ru n_state valu es for com ponents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

Comp onent state and m enu options: norm al or primary cell in an HA configuration

188

Comp onent state and m enu options: second ary cell in an H A configuration . . . . . 188

Com ponents and action s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

Ad ap ter configu ration tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

Param eter typ es . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200

Globa l pa rameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200

Com mon param eters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

Perl EventLog Ad ap ter for Win dow s pa ram eters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

LogFile Ad ap ter param eter s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206SNMP Ad ap ter param eter s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

Wind ow s Event Log Ad ap ter p arameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212Presen tation names for BMC Impact Solu tion interfaces . . . . . . . . . . . . . . . . . . . . . . 214

Presen tat ion n am e key form ats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218

StateBuild er file nam e conven tion s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224statbld .conf Parameter s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225

statbld retu rn codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225Gateway configuration pa ram eter p red efined variables . . . . . . . . . . . . . . . . . . . . . . . 227

Gatew ay Configu rat ion Parameter Text Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227

gatew ay.exp ort file pa rameter s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228

BMC Impact Exp lorer Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239Ad ministra tion ta b navigation pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

Standard even t m anagem ent po licy typ es . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262Ou t-of-the-box p olicies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264

Ou t-of-the-box ev ent selectors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266

Timefram e typ es an d description s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268Evaluation ord er of event policy types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269

Dynam ic data enr ichmen t sou rce files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272

Enr ichm ent configu ration files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272

Timefram e Edit d ialog options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275

Stand ard event m anagemen t policy types and procedures . . . . . . . . . . . . . . . . . . . . 285

Cau se Even t tab controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293Out-of-the-box d ynam ic data en richm ent event policy types and p rocedu res . . . . 332

Imp ort tab u ned itable fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347

Policy Typ e Creat ion process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354

Even t grou p configu ration files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361

Even t tree objects and definit ions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

BMC Impact Man ager CLI command descript ions . . . . . . . . . . . . . . . . . . . . . . . . . . . 382

Com mon options for CLI command s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383

Com mon r etu rn codes for CLI commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384

mccomp op tions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385

mcell op tions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387



Tables 25

mcell retu rn codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388

mcfgtrace op tion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389

mcfgtrace param eter s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390mclassinfo op tions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391

Type of slot v alu e for m classinfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392

Reported facets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392Class flags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393

Inform ation amount limitation op tions for m classinfo . . . . . . . . . . . . . . . . . . . . . . . . 393

mclassinfo retu rn codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395

mcollinfo op tions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396

Inform ation amou nt limitation options for mcollinfo . . . . . . . . . . . . . . . . . . . . . . . . . 397

mcollinfo retu rn codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398

mcontrol op tion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399

mcontrol cont rols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399

Files for UN IX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403

mcrtcell op tions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403

mcrtcell retu rn codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405mcstat op tion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405

mdelcell option s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407mdelcell return codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408

mgetin fo op tion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408

mgetin fo information options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409Inform ation from connect requ est . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409

mgetin fo retu rn codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412mgetr ec op tion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413

mkb option s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414

mkb n ew file option s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415

mkill op tion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418mlogchk retu rn codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420

mpkill op tion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421mposter and msend op tions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423

mposter and msend retu rn codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427

mqu ery op tion s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428mqu ery qu ery op tions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430

mqu ery return codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432

mrecover option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433

mrecov er r etu rn codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434

mrext ract op tion s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435

mrext ract return codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435mrm erge op tions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436

mrm erge return codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437

msetm sg options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437

msetm sg r etu rn codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438

msetrec op tion s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439

msetrec retu rn codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440

BMC Impact Manager CLI configu ration p arameters . . . . . . . . . . . . . . . . . . . . . . . . . 440

Action result event p aram eter s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444

Cell configu ration param eter s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444

Cell failover configuration pa ram eters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446




Client commun ication param eters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447

Date and time forma t para meters for Solaris . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448

Encryp tion param eter s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449Event Rep ository cleanup parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450

Hear tbea t p aram eter s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452

Hear tbea t slots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454Interna l cell mon itors param eters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455

KB param eters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455


Deprecated MessageBuffer propagation p arameters . . . . . . . . . . . . . . . . . . . . . . . . . . 458

Repor ting client connection p arameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459

Service m od el param eters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460

StateBuild er p aram eter s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460

Cell tracing param eter s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461

Microsoft Window s environment v ariables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466

UN IX environment var iables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467

BMC M icrosoft Window s services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470BMC UN IX processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470

Defau lt MAP files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474Defau lt map functions Perl files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475

Slot Function s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479

Op erators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481TCP Client Ad ap ter configuration pa ram eters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491

TCP server Ad apter configu ration p aram eters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494Telnet ad ap ter configuration p arameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497

UDP client Ad ap ter configuration p arameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500

UDP Server Adap ter configu rat ion param eters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503

CSV par ser param eter s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508Fixed-Width parser param eter s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510

Record and field separated parser param eters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515



Tables 27



Part 1 General configuration and administration 29

1Part

Part 1General configuration andadministration

This part p resents the following topics:

Chapter 1

Genera l configu ration information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Chapter 2

Managing BMC Impact Manager cells . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Chapter 3

Man aging th e BMC Im pa ct Admin istration server . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Chapter 4

Managing th e BMC Imp act Portal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

Chapter 5Man aging th e BMC Imp act Explorer (BMC IX) console . . . . . . . . . . . . . . . . . . . . . 143

Chapter 6

Working with Infrastructure Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

Chapter 7

Configuring BMC Imp act Event Ad ap ters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

Chapter 8

Defining presentat ion names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213

Chapter 9

Configuring StateBuilder and gatew ays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223




C h a p t e r 11General configuration information

This chap ter contains general information about configuring the BMC Imp act

Solutions and conta ins the following top ics:

Genera l configu ration overv iew . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Enabling integra tion between BMC Imp act Solutions compon ents and other BMC

compon ents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

General configuration overview

To configure th e BMC Imp act Solutions environ men t, you configure the following

components after installation:

s BMC Imp act Manager cell

s BMC Impact Explorer

s BMC Imp act Portal

Table 1 outlines the tasks that configure these comp onents.

Table 1 BMC Impact Solutions configuration process (part 1 of 2)

Task Description Component For more information, see

1 Configure the BMC Impact Portal. BMC Impact Portal BMC Portal Getting Started 2 Configu re BMC Im pact Man ager cells. BMC Im pact Manager Chapter 2, “Managing BMC

Impact Manager cells”

3 Define user groups for access to the console

functions and objects.

BMC Por tal BMC Portal Getting Started



General configuration overview


After you configure BMC Imp act Manager , BMC Imp act Portal, and BMC Imp act

Explorer, you are read y to implement event m anagement and service impact

man agement. For informat ion, consult the following resou rces:

s Event management

— For information about setting up adap ters to collect events, see the BMC Impact

Solutions: Event Monitoring O perator’s Guide.

— For information about setting u p d ynam ic data, policies, event grou ps, and

image views, see Part 2, “Event man agement adm inistration”on page 235.

— For information abou t defining event data, wr iting event managem ent rules,

defining collectors, or creating actions, see BMC Impact Solutions: Knowledge Base Development Reference Guide.

s Service imp act man agement

— For information about m onitoring service impact m anagement, see BMC Impact

Solutions: Service Monitoring User Guide.

— For information abou t d efining service mod els, see the BMC Impact Solut ions:

Service Model A dministrator’s Guide.

4 Dist ribu te the BMC Por ta l URL address so

users can get an accoun t and install

consoles.

BMC Imp act Explorer can be d eployed as a

Java Web Start ap plication from BMC

Impact Portal or installed stan dalone.


s BMC Imp act Explorer

s BMC Im pact Service

Mod el Editor

BMC Portal Getting Started

BMC Impact Solutions:

Installation

5 (optional) Customize BMC Impact Portal. BMC Impact Portal Chapter 4, “Managing the

BMC Impact Portal”

6 (optional) Custom ize BMC Imp act Explorer. BMC Imp act Explorer Chapter 5, “Managing the

BMC Im pact Explor er (BMC

IX) console”

7 (optional) Configu re the StateBuilder, which

man ages the persistent storage of events.

BMC Imp act Manager Chapter 9, “Configuring

StateBuilder an d gateways”

8 (optional) Custom ize the labels used in the

console interfaces.


s BMC Imp act Manager

s BMC Im pact Service

Mod el Editor

Chapter 5, “Managing the

BMC Im pact Explor er (BMC

IX) console”

Table 1 BMC Impact Solutions configuration process (part 2 of 2)

Task Description Component For more information, see



Enabling integration between BMC Impact Solutions components and other BMC components


Enabling integration between BMC ImpactSolutions components and other BMC

componentsIf you w ant to merge and reconcile data between BMC Imp act Solutions applications

and the BMC Asset Managem ent, BMC Topology Discovery, or BMC Configuration

Discovery prod ucts, you m ust add the ComponentAliases attribu te to the existing

precedence groups for these produ cts.

To add the ComponentAliases attribu te, follow the p rocedu re for creating a

precedence group in the BMC Atrium CMDB Installation and Configuration Guide foreach p rodu ct that you wan t to u se with BMC Imp act Solutions ap plications. The

precedence group s for the BMC Asset Managemen t, BMC Topology Discovery and

BMC Configuration Discovery prod ucts are

s BMC Asset Management – Sand box Precedence

s BMC Topology Imp ort - Precedence Group

s Configura tion Discovery Precedence

Comp lete the Attribute Precedence dialog box for each precedence group as show n in

Figure 1:

Figure 1 Attribute Precedence information for enabling integration



Enabling integration between BMC Impact Solutions components and other BMC components





C h a p t e r 22Managing BMC Impact Managercells

This chapter d escribes how to manage and configure BMC Impact Man ager cells.

BMC Im pact Manager overv iew . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

BMC Impact Manager cells . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

BMC Im pact Manager Know ledge Base (KB) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

BMC Imp act Manager even t rep ository and State Builder . . . . . . . . . . . . . . . . . . . 40

BMC Im pact Man ager comm and line inter face (CLI) . . . . . . . . . . . . . . . . . . . . . . . 40

Start ing or stopping the cell - mcell and mkill. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Stop ping or star ting a cell on UN IX comp uters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Star ting or stop ping a cell on Win dow s comp uters . . . . . . . . . . . . . . . . . . . . . . . . . 41

Cell configura tion tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Creating cell-specific configu ra tion files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Con figurin g m cell.conf parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Con figurin g cells to com municate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Con figuring h igh availability cells . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Configur ing event slot prop agat ion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Con figurin g p assive con nections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

Con figuring slots for t ime stamping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Con figurin g en cryp tion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Reload ing cell configu ration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Mon itor ing even t p erform ance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Mon itor ing client to cell interaction s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Con figurin g cell tracing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73Con figurin g m cell.trace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

Configur ing a destinat ion for cell trace outpu t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

Send ing trace ou tp ut to anoth er cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76Even t p rocessing er rors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

Au tom atic notification of trace configur ation chan ges . . . . . . . . . . . . . . . . . . . . . . 78Interpreting cell execu tion failure codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

Using the BMC IX Adm inistra tion v iew to m anage cells . . . . . . . . . . . . . . . . . . . . . . . 80

Con necting or d isconnecting a cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Viewing cell information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Controlling cells . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81



BMC Impact Manager overview


Reload ing cell configu ration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

Forcing event p ropagation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Registering for SIM n otification even ts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84Collectin g m etr ics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

BMC Impact Manager overview

BMC Imp act Manager p rovides the core functionality for event man agement an dservice imp act ma nagem ent. Its fun ctional elements are the

s event processor and service mod el manager (also known as a cell)

s Knowledge Base (KB) and compiler

s event rep ository and State Builder

s Comman d Line Interface (CLI)

BMC Impact Manager cells

A cell is the event-processing engine that collects, processes, and stores events w ithin

a single BMC Imp act Manager installation instance. If service impact managem ent(SIM) is imp lemented , the cell associates the even ts w ith the serv ice mod el

comp onents and calculates a comp onent’s status.

An ind ividual cell can provide local event man agement or function as part of a larger

distribu ted network of cells using even t prop agation. Netw orks of cells can be

organ ized to serve any bu siness hierarchy (such as geograp hical, functional, ororgan izational) or configu red to meet technical issues (such as network or system

limitations).

Event management cell functions

A basic event m anagem ent (EM) cell perform s the following functions:

s receives source event d ata from an adapter , integration, another cell, API, or the

BMC Imp act Manager CLI

s analyzes and p rocesses events according to the event mana gement ru les and

policies d efined in its Knowled ge Base

s respond s to events by executing actions, as defined in scripts or pr ogram s in its

Knowledge Base





s propagates selected ev ents to sp ecified destinations (typically, other cells) and

maintains the cur rency of propagated events w hen those events are upd ated or

changed at the event sou rce or event destination

s records the event op erations performed on an event

Service impact management cell functions

A service imp act management (SIM) cell per forms the following fun ctions in ad dition

to the event man agement functions:

s relates an event to the ap propriate service mod el comp onent

s comp utes the status of service mod el comp onents and prop agates their status to

the related comp onents using the d esignated status comp utation mod els

Production cells and test cells

A production cell is an EM or SIM cell that service operators an d service ma nagers

use to monitor the events an d serv ices associated w ith your IT resou rces in real time.

A test EM or SIM cell provid es senior service man agers and service ad ministrator s

with a test environm ent in the following ways:

s SIM cell

Enables pu blishing of service mod els from a d evelopm ent sand box to a test

environment before promoting them to a prod uction environm ent. Each BMCImp act Service Mod el Editor user has one ded icated test environ men t, which

consists of a pair of test CMDB data sets and an alias to a test cell. Promoted service

mod el comp onents includ e those in a u ser’s sand box and in prod uction. For d etailsabout test environm ents and prom otion, see Part 3, “Service mod el

administration”.

s EM cell

For event m anagemen t, a test cell provides KB developers with a test environm entfor defining event classes, event m anagemen t ru les, policies, actions, and collectors

and testing their behavior w ith test event d ata.

BMC Imp act Portal does not collect events from test cells for rep orting.





Production and test cell naming and creation

The only way to d istingu ish a test cell from a p rod uction cell is by the cell name.

Adopt a n aming convention for test and p rod uction cells that clearly identifies its

purpose.

You nam e a cell wh en it is created . One cell is created w ith each BMC Imp actManager instance that you install. You u se the mcrtcell comm and to create

ad ditional produ ction or test cells. The mcrtcell command can only be run on the

local comp uter w here the cell is being created . For more information abou t syntaxand options available with mcrtcell, see “mcrtcell—Creating a n ew cell” on

page 401.

Production and test cell configuration

You register test and production cells in BMC Imp act Portal. For instru ctions, see

“Registering p rod uction and test cells in the BMC Impact Portal” on page 128.

In BMC Impact Service Model Ed itor, each u ser associates a test cell to a test

environment. For furth er information, see Part 3, “Service mod el admin istration”.

In BMC Imp act Explorer, assign the production and test cells to a group . The d efaultgroups are MyTest an d MyProduction . For fur ther inform ation, see “Conn ecting BMC

IX to a BMC Impact Portal” on page 144.

Viewing test cell data

You v iew test da ta in BMC Imp act Explorer.

s To view test event d ata, collectors, and actions, select a test cell in the Events view.

s To view and create test event m anagemen t policies, select a test cell in the

Adm inistration view.

s To view test service mod el comp onen ts, use the Find tool in the Services view an d

select a test cell.

NOTE

The navigation tree in the Services view, w hich is pu blished from BMC Impact Service Model

Editor, can contain p rod uction service mod el comp onents only.



BMC Impact Manager Knowledge Base (KB)


BMC Impact Manager Knowledge Base (KB)

A Know ledge Base is a collection of inform ation that enab les a cell to perform eventman agement and service impact man agement. An event man agement KB includes

the follow ing:

s Event class definitions define the types of events to accept and classify sour ce eventdata for processing

s Data class definitions define the classes and slots of dynam ic data instances and

service model component instances

s Dynamic data function as contextual variables that can p rovide d ata values to rules

and policies d uring event p rocessing

s global records are p ersistent structured global variables that m aintain data valuesacross all ph ases of event processing

s event management rules are event p rocessing statements that u se the BAROC data

associated with an event, data instances or records to d etermine if, when, and how

to respond to new events or event mod ifications

s event collectors are filters that qu ery the event rep ository and display the results in a

BMC Impact Manager event list in an organized man ner

s actions are executable program s or scripts that perform an autom ated task on a

particular event

In ad dition, a service imp act man agement (SIM) KB also includ es

s a reference copy of a cell’s service model published by a BMC Imp act Publishing

Server

s a reference copy of the BMC Atriu m CMDB Comm on Data Mod el (CDM) classdefinitions, which are u sed in a cell’s service mod el

The KB files are loaded by a cell at start tim e. Although many KBs can exist w ithin a

d istributed BMC Imp act Manager en vironm ent, each cell can be associated w ith onlyone KB at a tim e.

For comp lete information abou t the BMC Imp act Manager Know ledge Base, see the

BMC Impact Solutions: Knowledge Base Development Reference Guide.



BMC Impact Manager event repository and State Builder


BMC Impact Manager event repository and State Builder

After a cell receives and processes an even t, it stores the even t in the event r epositoryas an instance of a pa rticular event class. All events are held in mem ory and can be

viewed in BMC Impact Explorer . The event repository p rovides persistent storage ondisk for events and data instances, includ ing service mod el comp onents andrelationships. The State Builder manages the persistent storage of events.

BMC Impact Manager command line interface (CLI)

The BMC Imp act Manager Comm and Line Interface (CLI) enables users to executeBMC Imp act Manager fun ctions imm ediately from the OS command line or execute

produ ct fun ctions from a script . For more information, see App endix B, “BMC SIM

and EM CLI Reference.”

Starting or stopping the cell - mcell and mkill

The installation p rocess autom atically starts a cell’s service. How ever, as changes are

mad e to a cell’s configu ration files or KB, you m ust stop and start the cell to accept th echanges.

Stopping or starting a cell on UNIX computers

By default, a cell ru ns as a UN IX daemon . You override this behavior w ith a

comm and line op tion, not a configuration file pa rameter.

Before you begin

A cell can be installed as own ed by any u ser. Only users w ith execute p ermission on

th e mcell binary can star t the cell. All users w ith execute p ermission on the mkill ormcontrol CLIs can stop th e cell. However, if a user w ithou t root perm issions attempts

to start the p rocess, the follow ing issues mu st be considered .

s Externa l actions run as the user ID that started the process. Those actions are

defined in %MCELL_HOME%\ etc\ CellName \ kb\ bin on Window s platforms and in$MCELL_HOME/etc/ CellName /kb /bi n on UN IX platforms.

Actions are defined in .mrl files located in the kb/bin d irectory and listed in .load in

that d irectory. The action p rograms or scripts can be located in th e kb/bin/A or

kb/bin/ Arch d irectory. They can also be located anywhere else on the system.



Starting or stopping a cell on Windows computers


s The user w ho starts the cell must be able to write to log and trace files in th e

directories specified through configuration param eters SystemLogDirName an d

SystemTmpDirName. Defau lt values for these are the log an d tmp subdirectories of

MCELL_HOME.

To stop a cell on UNIX computers

To stop a cell, use the mkill command located in the MCELL_HOME/bin directory

with the n ame of the cell you w ant to stop. If no cell name is provided , mkill attempts

to stop a local cell whose name is the sam e as the local host nam e. For mor e

information about the mkill comm and , see “m kill—Stopp ing a cell” on page 417.

To start a cell on UNIX computers

To start a cell, u se the following comm and :

mcell -n cellName

It is possible to start a cell withou t specifying a cell nam e. If you star t a cell w ithou t

any op tions, the comm and attempts to start a cell with the sam e name as the host.

You m ust set the MCELL_HOME environment variable to p oint to the d irectory in

which the cell is installed. The hom e directory also can be indicated u sing the op tion

-l followed by the p ath to th e hom e, instead of d efining it in the env ironment. To

learn m ore about using the mcell command , see “mcell—Starting a cell” on p age 386.


On Wind ows comp uters, you can stop a cell by using one of the following op tions:

s Window s Services

s th e net stop command

s th e mkill command

On Wind ows comp uters, you can start a cell by u sing on e of the following op tions:

s Window s Services

s th e net start comm and from a command promp t window

NOTE You can change all configur able cell parameters by making changes in th e configuration file,

mcell.conf. When you start th e cell, the cell looks for the configuration file in the d efault

location, MCELL_HOME\ e tc\ cellName \ mcell .conf . Use the -c option with the mcell

comm and to hav e the cell look for the configuration file in a sp ecified location.





To stop a cell on Windows platforms by using services

1 Open the Services wind ow by choosing Start => Setting s => Control

Panel => Administrative Tools => Services.

2 Select mcell_ cellName.

3 Click Stop Service.

To stop a cell on Windows platforms by using the net stop command

1 Select Start => Programs => Command Prompt.

2 Enter net stop mcell_ cellName.

To stop a cell on Windows platforms by using the mkill command


2 Enter mkill -n cellName.

To start a cell on Windows platforms by using services

1 Open the Services wind ow by choosing Start => Settings => Control Panel =>

Administrative Tools => Services.

2 Select mcell_ cellName.

3 Click Start Services.

To start a cell on Windows platforms by using the net start command


2 Enter the follow ing comm and :

net start mcell_ cellName.

NOTE

If you d o not use the -n option w hen stop ping a cell, the d efault cell, nam ed hostName, is

stopped.



Cell configuration tasks


Cell configuration tasks

The more you custom ize your cell to fit your need s, the more efficiently the cell w orksfor you. All configuration tasks are op tional. Table 2 describes the cell configu ration

tasks.

NOTE

When started from the comm and p rompt w ithout the -d option, mcell contacts the Service

Contr ol Manag er to start itself as a service. It uses mcell_%N as a service nam e, where %N is the

cell name as specified w ith the -n option. Withou t the -n option, the hostname is used as the

cell name.

Table 2 Cell configuration tasksTask Description For more information, see

1 (optional) Create additional cells.

When you install BMC Imp act Manager on a system, one cell is

installed. You can create add itional cells by ru nning the

mcrtcell command.

“mcrtcell—Creating a new cell” on

page 401

2 (optional) If you created mu ltiple cells for an env ironment, you

can create sepa rate configuration files for each cell.

“Creating cell-specific

configuration files” on page 46

3 (optional) If you created m ultiple cells for an en vironmen t,

configure th e cells so that th ey can comm un icate w ith other cells

in the network.

“Configuring cells to

commu nicate” on page 47

4 (optional) If you created m ultiple cells for an en vironmen t,

configure a high availability cell or cells.

“Configu ring h igh av ailability

cells” on p age 50

5 (optional) Events can be processed locally or selectively

prop agated to other cells. To configu re the event slots that m ust

be propagated w hen they are changed, and in w hich d irection

(forward / backward ), configur e the propag ation configuration

file.

“Configu ring event slot

propagation” on p age 59

6 (optional) If inbound connections to the cell are disallowed in a

protected environm ent, the connection h as to be established

within the p rotected zon e to allow a connection between an

external client an d a cell in the p rotected zone.

“Configu ring p assive connections”

on page 62

7 (optional) To add a t ime stamp to a slot so tha t the date and t ime

is recorded wh en the slot is chang ed, configure the mcell.modify

file.

“Configu ring slots for time

stamping” on page 63

8 (optional) If desired, you can encrypt communication among the

various BMC Imp act Solutions compon ents.

“Configu ring encryption” on

page 64

9 (optional) Set the default client parameters executing CLI

commands.

“BMC Impact Manager CLI

configuration” on page 440



Configuring mcell.conf parameters



The cell is installed with a configu ration file, mcell.conf , that allows it to ru n w ithoutany ad d itiona l configura tion. By using a text editor, you can chan ge the configu ration

param eters in themcell.conf

file to custom ize the cell for you r p articular ITinfrastructure and environment. You can override some p arameters using comman dline argu men ts when you star t the cell. For more information, see “mcell—Starting a

cell” on p age 386.

To configure the mcell.conf file using a text editor

1 Open the mcell.conf file in a text ed itor.

The d efault location is MCELL_HO ME \ etc.

2 Create line entr ies using the form at Parameter=Value based on the syntax ru lesdescribed in “Rules for cell configuration pa ram eter syntax”.

3 Save the chan ges.

4 Either r eload th e cell configurat ion or restart the cell for the changes to go intoeffect. For more inform ation, see “Reloading cell configuration” on page 68.

Rules for cell configuration parameter syntax

The following ru les apply:

s One p arameter p er line, in the form: Parameter=Value

where the Value extends to the end of the line

s Typically, the valu e for a parameter is a Boolean value, a string, or a p ath. Thesupp orted Boolean values are Yes/ No and On/ Off.

s The Boolean values are not case sensitive, so, for example, On, ON , on, and even

oN are equally valid.

s Do not enclose the value in quotation marks unless you wan t the quotation marks

to be part of the value.

s Times are stated in seconds u nless otherw ise specified.

s By defau lt, all pa ram eter settings are d isabled , that is, commented ou t with a # sign at the beginning of the line of code. Enable a parameter setting by removing

th e # sign that p recedes it.





For more information on cell configurat ion parameters, see App endix C, “mcell.conf

file param eters.”

Specification of path values

Parameters that ha ve path values contain the string fileName or dirName, forexample TraceConfigFileName or SystemLogDirName.

Path values can be stated as:

s absolute path—starts with slash (/ ) or backslash (\ ), or on Window s, with a d rivedesigna tor (for examp le, D:)

s run time relative path—starts w ith ./ or ../ . The p ath is relative from the cell’s

working d irectory. The working directory is the root directory (/ ) when it run s as a

daem on or a service. When run ning in foreground , it is the directory w here mcellis started.

s configu ration relative pa th—all other p ath values are relative from th e cell’s

configuration directory, or, for p rogram paths, from the kb\ bin directory.

Path values can contain th e substitution p arameters $VAR or %X. Any $VAR parameter

is substituted by the value of the environm ent variable VAR. Table 3 lists the possible

%X substitution parameters.

Modifying SystemLogDirName, SystemTmpDirName, andKBDirName

With the cell configur ation param eters SystemLogDirName and SystemTmpDirName,

users can sp ecify alterna tive path locations for the system d efined log an d tmp d irectories. Their default valu es are %H/log an d %H/tmp. To enable file na me

specifications that refer to these alternative locations, use the substitu tion par ameters

%L for the log and %T for the tmp d irectory. They are substituted by the specified pathto the log an d tmp d irectory, resp ectively.

Table 3 Substitution parameters for %X in path value parameters

Parameter Description

%H cell home directory

%C cell configuration directory

%B Knowledge Base binary d irectory, kb\ bin

%L log file directory

%T temp orary file d irectory

%P program name

%N cell name



Creating cell-specific configuration files


If you chan ge the defau lt value for the SystemLogDirName parameter or the

KBDirName param eter in the mcell.conf file, you m ust also change the valu e in the

statbld.conf file. If you fail to d o th is, the cell loses persistency and the mcdb file is notcreated, because the StateBuilder is configured from statbld.conf file and has no inpu t

from the mcell.conf file. As a result, StateBuilder d oes not know w here to find th e log

files or the KB directory it requ ires.

ConnectionPortRange syntax

Figure 2 shows the syntax of ConnectionPortRange.

A ran ge is a num ber of sequences, each of which is a consecutive ran ge of ports. Thecell attemp ts to access all por ts in the specified ord er. The default is to use any of the

ephemeral ports.

For example,

s 1828—1840 specifies a ran ge of p orts 1828 throu gh 1840

s 1828, 1829, 1840 specifies the sequ ence of p orts 1828, 1829, and 1840

Creating cell-specific configuration files

By d efault, one set of configu ration files is installed d ur ing installation of the BMC

Imp act Manager . These files are located in the MCELL_HOME \ e tc directory an dmu ltiple cells on a host can use th em. You can also create u nique configu ration files

for individu al instances (cells) as need ed.

To create cell-specific configuration files

1 Copy the configuration file that you w ant to be u nique to the MCELL_HO ME \ e tc\ cellName directory. cellName rep resents the name of the cell.

2 Using a text ed itor, edit the configuration file and customize it for that cell and

save it.

You can copy and ed it any configu ration file located in th e MCELL_HO ME \ etc

directory.

3 Either reload the cell configura tion or stop an d star t the cell so that the chan ges

take affect.

Figure 2 ConnectionPortRange syntax

PortRange = PortSequence{, PortSequence}

PortSequence = Port[-Port]



Configuring cells to communicate


When a cell starts, it searches for configu ration files in the

MCELL_HO ME \ etc\ cellName directory. If no configu ration file is foun d, the cell

uses th e configu ration file in th e MCELL_HOME \ e tc d irectory. For example, if youcopy th e mcell.conf file into th e MCELL_HO ME \ etc\ cellName directory and mod ify

it, the cell read s that mcell.conf file and all other files in the MCELL_HO ME \ e tc

directory.


Each cell can fun ction as either a complete event m anagem ent system or as par t of a

larger d istributed n etwork of cells. After you install a cell, it can run w ith no

ad ditional configu ration; however, it cann ot comm un icate with other cells, the BMC

Imp act Portal, or gatew ays in a distributed BMC Imp act Solutions netw ork. To enablecomm un ication betw een cells and some clients, you m ust m odify the mcell.dir file,

which is also known as the cell d irectory file.

About mcell.dir, the cell directory file

The mcell.dir file is created dur ing p rod uct installation. It acts as the cell directory file,contains the list of cells, the BMC Imp act Portal, and gatew ays known on a specific

comp uter. Upon startup, the cell reads the mcell.dir file and associates itself w ith the

app ropriate nam e, encryption key (if encryption is enabled), add ress information,and port nu mber. In ad dition, it read s this information for the other cells to w hich it

connects and for the BMC Imp act Portal.

The mcell.dir file for a cell has an entry for each cell and the BMC Impact Portal towhich the cell conn ect. Figure 3 shows the format of an entry.

Figure 3 Format of an entry in the mcell.dir file

#

## One line per component :

# <Type> <Name> <EncryptionKey> <IpAddress:Port>

# <Type> = cell | gateway.type

#

# cell ComponentName EncryptionKey Host:1828

# gateway.portal bip.fullyqualifiedHostName EncryptionKey Host:3783





Each p aram eter in the file is defined as follows:

Example of the mcell.dir file

Figure 4 shows an example of the mcell.dir file w ith typical comp onent en tries.

Rules for mcell.dir file entries

The following ru les apply when creating entries for the mcell.dir file:

s Cells may be grou ped into separate cell files readable only by certain users or

group s (dom ains).

s A cell must know , at a minimum, the cells to which it propagates events. A cell

does not need to kn ow th e cell from w hich it receives events, even for backw ard

propagation.

s The mcell.dir file may d efine any nu mber of entries, but each entry mu st be on a

separate line.

Attribute Description

Type type of comp onent. It can be

s cell— BMC Imp act Manag er cell nam e

s gateway.type—Gateway of type type

s gateway.jServer - predefined jServer gateway type

s gateway.portal - BMC Imp act Portal

Name Name is an abstract nam e for the comp onent. Compon ent nam es are not

case-sensitive and may be an y alphan um eric string, includ ing un derscores

(_).

A Portal nam e is, by convention, the fully qualified host n ame of the Por tal

host, prefixed with bip.

EncryptionKey String to be u sed as p art of the key for the encryption of the

commu nication betw een a cell and the compon ent. Default value is 0

(zero).

IPAddress:Port Host name or IP address and p ort num ber on which the component is

listening. Default port number for a cell is 1828 and for a Portal is 3783.

Figure 4 Example of the mcell.dir file and its entries

### One line per component :

# <Type> <Name> <EncryptionKey> <IpAddress:Port>

# <Type> = cell | gateway.type

#

cell anwar-bos-71 mc anwar-bos-71:1828

cell local mc 127.0.0.1:1828

gateway.portal bip.anwar-bos-71.amc.com mc anwar-bos-71:3783





s You can p lace mcell.dir files on rem ote mou ntable partitions or distribute them

using rd ist, tftp, or an y other d istribution m echanism.

Ways to update an mcell.dir file

Update the mcell.dir file in on e of the following w ays.

s If ad ding a n ew cell on the sam e compu ter as the existing cell, run th e mcrtcell

command.

The comm and up dates a master mcell.dir file foun d in the MCELL_HOME \ e tc byadd ing the information for the new cell to the mcell.dir file. For more information,

see “mcrtcell—Creating a n ew cell” on page 401.

s If you are ad ding a n ew cell that is not on the same comp uter, add the new cell

information to the mcell.dir file us ing a text ed itor. See “To configure the mcell.dirfile using a text editor” on page 49.

Also, dep ending u pon h ow you r service model is set up, you may n eed to modify

th e mcell.dir file on the comp uter that contains the cell.

For example, you h ave tw o compu ters, comp uter A and compu ter B. Cell A is on

compu ter A an d cell B is on comp uter B. For cells A an d B to comm un icate, you

wou ld h ave to enter the information for cell A in the mcell.dir file on comp uter B

and the inform ation for cell B in the mcell.dir file on comp uter A .

s If you ar e setting comm un ications up w ith a BMC Imp act Portal after itsinstallation, you m ust d efine the p ortal connection in the mcell.dir file.

To configure the mcell.dir file using a text editor

You shou ld m aintain a m aster mcell.dir file that contains d irectory entries for a ll cellson a comp uter. The file mu st be read able by all cells. As an a lternative, make copies of

this file available to all cells. This enables a cell to contact any other cell based on its

cell nam e.

1 Open the mcell.dir file in a text ed itor.

The default location is MCELL_HOME \ e tc.

WARNING You m ust m aintain each cell’s mcell.dir file to ensu re event prop agation between cells and the

ability to connect to the BMC Impact Portal. Ensu re that each d irectory entry is correct and

that every cell has an u p-to-date directory file. An error in the mcell.dir file p reven ts cells

from connecting to each other or to the BMC Imp act Portal.



Configuring high availability cells


2 Create line entries using the format shown in Figure 3 on page 47.


4 To ensure that th e chan ges take affect, do one of the following:

s Stop and start the cell; for more information, see “Starting or stopp ing the cell -mcell and m kill” on page 40.

s Run the mcontrol CLI comm and to reload only the mcell.dir file:

For m ore information on th e mcontrol comm and , see “mcontrol—Performing

cell control operations” on page 398.

5 Register the cell with the BMC Impact Portal by d oing one of the following:

s Use the BMC Imp act Portal Adm inistrator p age to register the cell.

For more inform ation, see the BMC Imp act Portal online H elp.

s With the BMC Portal ru nn ing, run the ad min u tility to register the specified cell.


What is high availability?

Configuring a cell for h igh av ailability increases the availability of the cell in d isaster

cases. When a high availability cell server fails, anoth er server can take over on

another h ost, with m inimal loss of data a nd state, and with m inimal d elay.

High availability only avoids cell failure. It w ill not improve the cell’s ava ilability in

other cases, such as w hen the load on th e cell increases. In this case, the cell w ill

become less responsive w hether it is a high availability cell or not.

If the cell becomes un available on the pr imary h ost, it can be restarted in the sam e, or

almost the sam e state on another machine. Clients w ill reconnect transp arently to thealternate cell server. After the or iginal cell server h as been rep aired, it can be

reinstated and clients will switch back to it.

mcontrol -n cell_Name reload dir

admin.bat -ac name=cellname:key=key :host=hostname:port= port:usergroups=* (Windows)

admin.sh ac name=cellname:key=key :host=hostname:port= port:

usergroups=* (UNIX)





High availability implementation

A high ava ilability cell is implemented as two server processes. One of the tw o server

processes is designated as the p rimary server, and the other server p rocess is the

second ary server. These two roles are not sym metr ic. The roles can be switched , bu t

this requires a shutd own of both servers and a minor configuration m odification.

The highest p ossible availability for a cell occur s wh en tw o server m achines are closeto each other w ith a highly reliable netw ork connection. When th e two server

machines a re on remote sites, the h igh availability cell functions more like a Disaster

Recovery system .

Only one of the tw o servers should be active at any time.

How high availability functions during normal operation

When the environment is operating norm ally, the primary server is active, wh ile thesecond ary server op erates in standby mod e. All clients commu nicate with th e

primary server.

The primary server sends all its transactions imm ediately to th e second ary server. As

a result, the second ary server is a synchronized du plicate of the primary.

How high availability functions during failover

When the p rimary server becomes u navailable, the second ary server becomes active.

This process is called failover . This process can be either m anu al or autom atic,

depend ing on how the high availability cell is configured . By d efault, failover is

automatic.

WARNING

The primary an d secondar y servers of a high availability pair mu st run on tw o different

logical OS images of the same typ e. Primary and second ary servers of a h igh availability pa ir

runn ing on the same system or ru nning on different operating systems is not sup ported.

WARNING

Although it is techn ically possible to activate both servers, this is not su pp orted. If both

servers are activated, incompatible server states can occur. If the server states are

incompatible, man ual intervention is required to resynchron ize the primar y and second ary

servers. If this situation occurs, see “Problem: The primary an d secondar y servers for my high

availability cell are in active mode simu ltaneously or are u nsynchron ized.” on page 376.





When th e primary server becomes unavailable, all d isconnected BMC Imp act

Explorer and BMC Imp act Portal clients au tomatically reconn ect to the second ary

server. At that time, if the second ary server is in stand by mod e, reconnected users cansee the information that was replicated from the p rimary server before it became

un available, but they cann ot take any action.

CLI clients and other cells do not conn ect to the secondary server u ntil it is active. In

the interval between w hen the primary server goes down an d w hen the second ary

server becomes active, the cells and adapters buffer their events.

If the p rimary server is only temp orarily u navailable, and the second ary is notactivated , all the clients w ill reconnect to the p rimary server as soon as it is available

again. Alternatively, if the secondar y server becomes active, the BMC Imp act

Explorer and BMC Imp act Portal clients gain Read-Write access to the second aryserver an d the CLI clients an d the oth er cells will conn ect to it.

How high availability functions when primary serverbecomes available after failover

The primary server m ust be activated again after it has been repaired an d th esecond ary server mu st be reset to stand by mod e. Switchback is the process of the

primary server becoming active and the second ary server reverting to standby m ode.

This process can be man ual or a utom atic, depend ing on h ow the high av ailability cell

is configured . By d efault, switchback is au tomatic.

When th e second ary server sw itches back to stand by mod e, its clients are

disconnected and they au tomatically reconnect to the p rimary server.

If the seconda ry server becomes temporar ily u navailable and the p rimary server isalso un available, clients conn ect to the first server that becomes active.

WARNING It is highly recommen ded that you disable autom atic failover and enable manu al failover

wh en the conn ection between the primar y and second ary server is un reliable. Otherw ise,

there is a risk that both primary an d secondary servers would be active at the same time wh en

they cannot comm un icate with each other. This situation is not sup ported . If this situation

occur s, see “Problem: The p rimary and second ary servers for m y high availability cell are in

active mode simultaneously or are unsynchronized.” on page 376.





Installation and configuration considerations for highavailability cells

To get the same behavior for the p rimary an d for the second ary cells, both should be

installed and configured similarly. It is highly recomm ended that the KnowledgeBases for both servers are ident ical. Configuration par ameters also shou ld be set to

the same values for both servers, except for the CellDuplicateMode parameter that

indicates whether the server is a p rimary or a second ary server. For d etails about the

high availability cell configu ration p aram eters, see “Cell failover configu ration

parameters” on page 446.

To install and configu re a h igh availability cell, you mu st

1. Install BMC Impact Manager on the tw o machines that will host the two cell

servers. For instru ctions, see BMC Impact Solutions: Installation.

2. Create an identical cell for each server. For instru ctions on creating cells, see BMC

Impact Solutions: Installation.

For example a cell on :

mcrtcell -is -p port1 CellName

And an id entical cell on :

mcrtcell -is -p port2 CellName

3. Specify the primary and seconda ry server locations for the cell. For instructions,

see “To specify the primary and second ary server locations for the cell” on p age 53.

4. Configure high availability op tions. For instru ctions, see “To configure high

availability options” on page 54.

5. Configure the prim ary server. For instructions, see “To configure the p rimaryserver” on page 54.

6. Configure the secondary server. For instructions, see “To configure the secondary

server” on page 55.

To specify the primary and secondary server locations for the cell

1 On both servers, open the mcell.dir file in a text ed itor.

2 Replace the line for with:

cell CellName mc host1: port1 host2: port2





CellName is the nam e of the cell created on both servers. host1: port1 is the host

nam e and port nu mber of the primary server, and host2: port2 is the host nam e

and port nu mber of the seconda ry server.

This ind icates two locations (host name and p ort nu mber) for the same cell.

3 Save an d close mcell.dir.

To configure high availability options

1 On both servers, open the mcell.conf file in a t ext editor.

2 Assign ident ical values to the following h igh availability configura tion parameters

for both servers:

s CellDuplicateAutoFailOver—To enable au tomatic failover, set the va lue to Yes.

To fail over to the secondary cell manu ally, set the value to No. By d efault, the

value is Yes.

s CellDuplicateAutoSwitchBack—To enable autom atic switchback from the

secondary cell to the pr imary cell, set the value to Yes. To switch back to the

pr imary cell manu ally, set the value to No. By d efault, the value is Yes.

3 If you h ave op ted for au tomatic failover, failover timeou t values can also beconfigu red . For mor e inform ation, see “Automa tic failover p rocess” on p age 58.

4 Save an d close mcell.conf .

To configure the primary server

1 On th e machine hosting the p rimary cell server, open the mcell.conf file in a text

editor.

2 Set the valu e of the CellDuplicateMode parameter to 1.

The prim ary server is read y to be started. See “Starting a high availability cell.”

NOTE

Modifying mcell.conf globally mod ifies all cells. To mod ify a single cell, ensu re tha t you

modify the configuration file specific to the individual cell.

NOTE

Failover an d switchback can be configured indepen dently. It is not required toconfigure both as m anu al or both as au tomatic. For examp le, you could configurehigh availability so that failover is manu al, but switchback is autom atic.





To configure the secondary server

1 On th e machine hosting the secondary cell server, open the mcell.conf file in a text

editor.

2 Set the valu e of the CellDuplicateMode parameter to 2.

3 Save an d close mcell.conf .

The second ary server is ready to be started . See “Starting a high availability cell.”

Starting a high availability cell

Both p rimary an d second ary servers should be started almost at the same time. The

preferred ord er is to start the second ary server first, and th en imm ediately start the

primary.

To re-initialize a high availability cell

1 Shu t dow n the p rimary and second ary servers for the cell.

2 Erase the cell's entire log directory entirely on both servers.

3 Restart both cell servers without u sing any of the -i options. (Preferably, start th esecond ary server first.)

High availability operation mode

Cell-specific directories

All cells use th e following cell-specific d irectories:

WARNING

s If the p rimary server is started an d terminates before the secondary server is started, the

state of primary an d second ary servers ma y become un synchronized. If this occurs, you

mu st man ually synchronize the servers before restarting either of them.

s Do no t start a high availability cell us ing any of the -i initialization op tions (for examp le, -

ia, -id or other var iants). This could cause the p rimary an d second ary servers to become

unsynchronized.

If the servers become un synchronized for either of th ese reasons, see “Problem: The primar y

and second ary servers for my h igh availability cell are in active mod e simultaneously or are

unsynchronized.” on page 376 for instru ctions on h ow to m anu ally synchronize the servers.





s $ MCELL_HOME /etc/ CellName contains cell-specific configurations (includ ing the

Knowledge Base)

s $ MCELL_HOME /log / CellName contains the cell transaction logs and persistent state

of the cell

s $ MCELL_HOME /tmp/ CellName contains th e cell’s tem porary files

High availability cells use the cell-specific directories, but th e names of the log an d

tmp directories are suffixed with # followed by the server nu mber, 1 for the prim aryserver and 2 for the second ary server. The names become:

s $MCELL_HOME/log/ CellName#1

s $MCELL_HOME/log/ CellName#2

s $MCELL_HOME/tmp/ CellName#1

s $MCELL_HOME/tmp/ CellName#2

High availability related events

A high ava ilability cell operates the same way th at a stand ard cell operates.

To keep the p rimary an d second ary cell servers synchron ized, the p rimary cell servertransmits all its tran sactions to the second ary server . This happen s transp aren tly. For

instance, it is not visible in BMC Impact Explorer. Also, the Knowled ge Base ru les do

not h ave to be m odified for syn chronization an d there are no sp ecific eventsgenera ted for it.

When the p rimary server loses contact with the second ary server and cannot transmit

its transactions, it generates an int ernal even t of class MC_CELL_DUPLICATE_FAILURE

with severity=MAJOR. All transactions are buffered for transmission to the

second ary server . As soon as the primary server has re-established a connection with

the secondary, it generates an internal event of class MC_CELL_DUPLICATE_ON with

severity=OK and w ith the down_time slot ind icating (in second s) how long the

connection between primary an d second ary servers was down .

Each time a cell changes its opera tion mod e, it genera tes anMC_CELL_ACTIVITY_CHANGED class even t.

The active_server slot indicates wh ich of the cell's servers became th e active one. Avalue of 1 indicates the pr imary server is active and a value of 2 ind icates the

second ary server is active. If the cell is not a h igh av ailability cell, th is slot is 0.

MC_EV_CLASS: MC_CELL_ACTIVITY_CHANGED ISA MC_CELL_CONTROLDEFINES {active_server : INTEGER; -- 0 = Regular cell / 1 = Primary node / 2 = Secondary node of HA cellduplicate_connected : MC_YESNO;paused : MC_YESNO; };

END





When the p rimary server is active for the high availability cell, the

duplicate_connected slot indicates wh ether or n ot the second ary server is

connected. If the primary server is not active and / or the second ary server is notconnected, the value of the duplicate_connected slot is NO.

If the valu e of the paused slot is YES, the cell is pau sed (or has limited activity). If thevalue is NO, the cell is fully active.

This event is generated by a failover or sw itchback. It is also generated when th e

active server sw itches betw een limited activity and full activity. On a high availability

cell, the even t is generated only by th e active server . In case of a switch betw eenprimary and second ary servers, the event is generated just after the sw itch.

Manually failing over to the secondary cell

If there is a problem with th e pr imary server, a failover to th e second ary server isrequ ired. If the cell is configured w ith CellDuplicateAutoFailOver=No, thisfailover mu st be perform ed m anu ally.

To manually fail over from a primary server to a secondary server

1 Terminate the p rimary server (if it is still running) by entering:

mkill -n CellName#1

2 Activate the second ary cell server by en tering:

mcontrol -n CellName#2 start

Manually switching back to the secondary cell

After a p rimary cell server has been r epaired, a sw itchback op eration is required tore-activate it. If the cell is configured with CellDuplicateAutoSwitchBack=No,

switchback must be performed m anu ally.

To manually switch back from a secondary server to a primary server

1 Clear the p rimary server log directory by entering:

rm -f $MCELL_HOME/log/CellName#1/*

2 Switch the second ary server to stand by mod e by entering:

WARNING

You mu st explicitly includ e the #1 suffix after the cell nam e or the mkill command w illterminate the secondary cell if there is a problem w ith the comm and connecting to th e

prim ary cell.





mcontrol -n CellName#2 standby

3 Transfer the state file from th e second ary to the pr imary server:

copy host2:$MCELL_HOME/log/CellName#2/mcdbto host1:$MCELL_HOME/log/CellName#1/mcdb

4 Start the prim ary cell.

Automatic failover process

If a high availability cell is configu red with CellDuplicateAutoFailOver=Yes, it

will automatically p erform a failover w hen n eeded.

Failover occurs w hen th e second ary server loses its connection w ith the p rimary. If itcannot connect to the p rimary server w ithin th e time period specified in the

CellDuplicateFailOverTimeOut param eter, the second ary server assumes that thepr imary serv er is no longer available and becomes active.

The CellDuplicateFailOverStartTimeOut param eter specifies the per iod after

startup after w hich th e second ary server w ill become active when it has no

connection w ith the primary server. This param eter should be set high enou gh toallow p rimary an d secondary servers to be started at more or less the same time.

Although you can start the second ary server before the pr imary server, if the

second ary server is started first, it cannot connect to the prim ary server . Therefore,

the value of the CellDuplicateFailOverStartTimeOut para meter should be set so

that there is enough time for the p rimary server to start.

Automatic switchback process

If a high availability cell is configu red with CellDuplicateAutoSwitchBack=Yes, it

autom atically performs a switchback wh en the p rimary server starts.

When th e pr imary server is started, it connects to the second ary server an d

determines its activity level. If the second ary is active, the sw itchback p rocedu re isstarted. The second ary server sw itches to standby mod e and transmits its state to the

primary server. Once the primary server has determined that the second ary server is

in standby m ode, the primary server restarts itself and r eloads the state that it

received from the seconda ry server.

Explicitly connecting a CLI to a selected server

A CLI will au tomatically conn ect to the pr imary cell server. If the p rimary cell serveris not active, the CLI connects to the second ary server.



Configuring event slot propagation


It is possible to conn ect a CLI explicitly to either the p rimary or the secondary server,

using the common CLI -n option.

One m ethod is to indicate the host and por t of the d esired server exp licitly. For

example:

mgetinfo -n host2/port2 -v activity

This example retrieves the activity level of the second ary cell server.

Another m ethod is to enter the cell name, followed by # and the server nu mber (1 for

primary and 2 for second ary). For examp le:

mgetinfo -n CellName#2 -v activity


Events can be p rocessed locally or selectively prop agated to other cells. To configure

the event slots that must be prop agated w hen they are changed, and in w hich

direction (forward / backward), you configure the p ropagation configuration file

mcell.propagate. The mcell.propagate file lists all of the slots wh ose mod ifications w ill

be propagated.

In ad dition, using the BMC Imp act Solutions gateways, events can be p ropagated to athird-party program in a sp ecific format that is d escribed in a gateway configura tion

file, gateway.GWType.

The d efault location for these files is MCELL_HOME \ e tc.

When an event has been prop agated to a d estination and that event is later mod ified,

the m odifications are then prop agated to th e same d estination. The event can be

prop agated through a Propagate ru le. If the destination is a gateway, gatewayconfiguration rules also apply.

For the mcell.propagate file to be effective, one or m ore Prop agate ru les must be

run ning. For information about Prop agate rules, see the BMC Impact Solutions:Knowledge Base Development Reference Guide.

The format is Slotname = Value, where:

Slotname = slot name or CLASS for class-specific slots

Value = sequen ce of {b = backw ard f = forward }





You can specify a slot in the base CORE_EVENT class. How ever, if you w ant to sp ecify

a slot outside those in the base CORE_EVENT class you mu st use the CLASS specifier,

which mean s that all class-specific slots are propagated in the d irection given.

Table 4 on page 60 lists the parameters in the mcell.propagate file and th e defaults.

If you h ave mu ltiple instances of BMC Impact Manager installed , you m ight want to

use event p ropagation to d istribute the event p rocessing load among the cells or to

back up events on anoth er cell for failover.

Figure 5 on page 61 illustrates a cell network th at is collecting and processing

nu merou s events in a distributed environment.

Table 4 Default mcell.propagate options

Parameter Action PerformedDefaultValues

administrator prop agates adm inistrator value changes up (forward ) within the cell hierarchy f

CLASS prop agates changes to the class-specific slots up (forward ) within th e cell

hierarchy

f

mc_modhist prop agates changes to the mc_modhist up (forward ) within the cell hierarchy

This is a system d efined slot that requires such p ropag ation.

f

mc_notes prop agates changes to notes attached to an event u p (forward ) within the cell

hierarchy

f

repeat_count propagates changes to repeat_count up (forw ard) w ithin the cell hierarchy f

severity prop agates severity value changes up (forward ) within the cell hierarchy f

status prop agates status value chan ges in both d irections, backward and forward , in the

cell hierarchy

bf





Figure 5 Distributed event management using event propagation

In this illu stration, the lower-level cells process the source events and then p rop agate(or forw ard ) the events on to higher-level cells according to a Prop agate ru le or an

Event Prop agation p olicy. As events p ass through a ser ies of cells, the cells discard

un needed events, identify and leave behind u nimp ortant events, and resolve some of

the problems reported by other events.

To enable event propagation, perform the following tasks:

s enable cell-to-cell communication in mcell.dir

s configure p ropagation p arameters in mcell.conf

s specify the slots whose m od ification has to p rop agate in mcell.propagate

s either w rite a Propagate ru le or define an Event Propagation policy

event

sources

event

sources

event

sources

event

sources

Some events are propagated

for management by other cells

in the cell network.

cell

cellcell

cell

cell

cell

cell



Configuring passive connections


Configuring passive connections

If inbound connections to the cell are d isallowed in a protected environ men t, theconnection has to be established w ithin the p rotected zone to allow a connection

between an extern al client and a cell in the p rotected zon e. To connect to the cell, theclient issues a p assive connection; that is, it wa its un til the cell establishes th econnection to th e client.

Configuring the client for passive connections

On th e client side, the mcell.dir file has to ind icate that the d estination cell is located in

an isolated protected zone.

To configure the client for passive connections

1 Open the mcell.dir file in a text ed itor.


2 For the destination cell, rep lace Host:Port w ith 0 as shown in Figure 6.


4 Either r eload the cell configu ration or stop and start the cell.

When a cell or gatew ay client n eeds to conn ect to an isolated d estination cell, it

cannot establish a connection because it d oes not have th e IP add ress and portnu mber of the cell. Instead , the cell or gatew ay client registers the d estination and

waits for a connection from it.

Configuring a cell for passive connections

On th e cell side, an ind ication is needed that a client could be wa iting on a connection.

NOTE

A p assive connection is only p ossible w ith the “server” type clients, such as the cell and

gateway clients.

Figure 6 Passive connection format

cell cellName EncryptionKey 0



Configuring slots for time stamping


To configure a cell for passive connections

To configure a cell for p assive conn ection, you mu st create a data object and specify

how to control it, as show n in Figure 7.

The cell slot, as d efined in the MC_CELL_HEARTBEAT sup erclass, gives the nam e of the

passive client. The enable slot in the su perclass specifies wheth er or n ot mon itoringand reconnection is enabled . The cell attemp ts to connect to passive client targets as

configured with th e standard connection p arameters. As soon as a connection is

established , the conn ection is reversed . At that m omen t, the client takes up the

connection an d behaves as an ordinary client.

Monitoring passive targets

The cell may n ot be aw are that a connection h as been terminated wh en a connection

from a passive client to a cell is term inated . The p assive client cann ot try to

reestablish the conn ection, nor can it signal the cell to reestablish th e connection. To

avoid su ch situations, the cell mon itors the passive client, based on the stand ardhear tbeat mon itor mechanism. Then, when a d isconn ect is detected, the cell attempts

to connect to the p assive client target.

Configuring slots for time stamping

Each even t has an mc_modification_date slot that contains the time stamp of the

last mod ification of the even t. Only select slot mod ifications set this time stam p. To

add a time stamp to a slot so that the d ate and time is record ed w hen the slot is

changed, you mu st configure the mcell.modify file. The mcell.modify file contains th e

nam es of the slots that affect the mc_modification_date slot. When one of the slotslisted in th e mcell.modify file is mod ified, the mc_modification_date slot is set w ith

the time stamp of this change.

To configure slots for time stamping

1 Open the mcell.modify file in a text editor.

The default location is MCELL_HOME \ e tc.

2 Create a line entry containing the name of the slot wh ose mod ification is to be time

stamped. Figure 8 shows an example of the mcell.modify file.

Figure 7 Data object specification

MC_CELL_PASSIVE_CLIENT ISA MC_CELL_HEARTBEAT ; END



Configuring encryption


When CLASS is used as a slot nam e, all class-specific slots or those slots not defined

in the base class CORE_EVENT upd ate the mc_modification_date slot w ith a time

stamp.


4 Either r eload the cell configu ration or stop and start the cell.


You can encryp t comm un ication among the var ious BMC Impact Solutions

components. To enable encryption, make the appropriate settings in the following

locations:

s the cell’s configurat ion file mcell.conf

s the BMC Impact Explorer configu ration files mclient.conf

s the BMC Imp act Portal used by BMC Imp act Explorer

s the cell directory file, which is MCELL_HOME \ e tc\ mce ll .dir by d efault

mcell.conf file settings that control encryption

The pr imary settings controlling encryption are in the cell configura tion file

mcell.conf . The following settings control encryp tion:

s Encryption

s ForceEncryption

s EncryptionKey

If Encryption is set to Yes, encrypted comm un ication to an d from the cell is enabled,

bu t not requ ired. For example, if a BMC Imp act Explorer d oes not have encryp tionenabled, then the communication with that particular BMC Impact Explorer console

is not encrypted .

Figure 8 mcell.modify file

# Configuration of slots affecting mc_modification_date when modified

# Format :

# SlotName

# Special name : CLASS : specifies all class-specific slots

status

severity

mc_priority

repeat_count

CLASS





ForceEncryption requ ires encryption for all comm un ications. If the BMC Imp act

Explorer attempts an un encryp ted conn ection to the cell, the connection is rejected.

The encryption process uses the EncryptionKey value as part of the encoding key. If

there is no en cryption, the EncryptionKey value h as no effect.

mclient.conf file settings that control encryption

All CLIs can use an mclient.conf file to determ ine encryption fu nctionality. The

parameters are

s Encryption

s EncryptionKey

For more information abou t the CLI configura tion parameters, see “BMC Imp act

Manager CLI configuration” on p age 440.

mcell.dir file settings that control encryption

The mcell.dir file conta ins a field for an EncryptionKey. At installation, the d efault

EncryptionKey value is set to mc. BMC Softw are recommend s that you mod ify the

value for security.

Encryption behavior between cells and components

This section describes the encryption behavior of cells and componen ts du ring

commun ication. The following actions occur w hen a BMC Imp act Solutions

componen t initiates comm unication w ith a cell:

1. The comp onent scans the cell configuration file, mcell.dir, for tha t cell’s connectioninformation.

2. BMC Imp act Explorer retr ieves the cell’s connection information from the BMC

Portal.

3. The comp onent opens a connection to the cell.

If the cell has Encryption=yes, the comp onent can use encrypted or n on-encrypted

comm un ication. The comp onent m ust u se encrypted comm un ication if the cell has

ForceEncryption=yes an d Encryption=yes.

If the commu nication is encrypted, both the cell and the component mu st use the

same EncryptionKey values to establish communication.





Information Retrieval

A component mu st have the ad dress and port of a cell to establish comm un ications

with it. To establish en crypted comm un ications, the component mu st also have th e

encryp tion key of the cell. BMC Imp act Explorer and th e CLI comm and s determ ine

the information in d ifferent w ays:

s BMC Imp act Explorer acqu ires the inform ation from the BMC Imp act Portal

(cell_info.list).

s BMC Imp act CLI comm and s obtain the information by determining th e serverlocation using one of the follow ing meth ods:

— directly from the CLI command

— from CLI configuration p arameters in mclient.conf

—from mcell.dir if you u se the-n

cellName option

Default values

The default value for cellName is the name of the host (hostName). The defau lt value

for the port is 1828.

When the mcell.dir file is present, the d efault value is EncryptionKey=mc at

installation. BMC Software recommend s that you m odify this value for secur ity.

If the mcell.dir file is absent on the host and you d o not sp ecify an encryption key, the

CLI command uses 0 (zero) as the default value for EncryptionKey. This valueenables encrypted comm un ications.

Mandatory key specification conditions

You m ust sp ecify the encryption key if the following conditions apply:

s you execute the CLI comm and on a host w ithout an mcell.dir file

s the cell has an encryption key other than 0 (zero)

These cond itions apply w ith the defau lt installation. How ever, if the mcell.dir file ispresent on the host, and the file specifies the encryp tion key, you ar e only required to

specify th e cellName.

NOTE

You can d isable encryption by setting the configu ration para meter to Encryption=No. You

might w ant to u se this setting to disable encryp tion wh ile tracing.





Limiting cell access

A client is allowed to connect to the cell if its IP add ress matches the general

AllowConnectionFrom as w ell as the client t ype-specific Allow*From.

Figure 9 shows an example of masking syntax.

The following conventions apply:

s An abbreviated Addr or Mask is expand ed w ith zeros.

s A num eric Mask (num ber w ithout trailing d ot) gives the nu mber of 1 bit.

s An om itted Mask defaults to all bits set to 1.

s A connection is allowed if the source ad dress AN Ded w ith the Mask matches Addr ANDed w ith the Mask .

When the Mask is all zeros, any ad dress matches regard less of the value of Addr . For

all Mask bits w hose value is one (1), the equivalent bits in Addr must m atch the

equivalent bits in the source address.

Table 5 lists the IP address param eters.

Figure 9 Masking syntax

AddrMaskList = AddrMask {':' AddrMask}

AddrMask = Addr ['/' Mask]

Addr = Nr '.' [Nr '.' [Nr '.' [Nr ]]]

Mask = Addr | Nr

Nr = 0..255

Table 5 IP Address parameters (part 1 of 2)


AllowConnectionFrom=0./0 all systems allowed

(same as 0.0.0.0/0)

AllowConnectionFrom=0./32 no system allowed

(00.00.00.00 is not a valid IP add ress)

AllowConnectionFrom=198.12./255.255. any system from the 198.12.xx.xx

netw ork can connect



Reloading cell configuration


The defau lt is 0./0, indicating that th e server shou ld accept connections from any

source. Usually this is useful only for testing or debugg ing, or for u se with a system

that is isolated from the n etwork.

To specify one single add ress, specify the addr ess withou t a mask, or use a 32-bitmask . The following examp les are equ ivalent ways of specifying a single add ress:

s 127.0.0.1

s 127.0.0.1/32

s 127.0.0.1/255.255.255.255

When you specify more than one ad dr ess per mask pa ir, a system th at matches at

least one of the pairs can accept a connection.

Connection attempt using invalid encryption keyAn attemp t to connect to a cell using an invalid encryption key or from an d isallowedadd ress generates an internal event MC_CELL_UNALLOWED_CONNECT. This event

contains a slot, reason, that includ es the reason for the refused connection.


The cell does not au tomatically reconfigure itself, but you can customize an d r eloadthe configuration after you have m ade configuration changes.

To reload cell configuration

To trigger the reconfiguration, perform on e of the following actions:

s Send a han g-up signal on UNIX.

AllowConnectionFrom=127.0.0.1/1 allows any ho st with an IP add ress lower than

128.0.0.0, becau se it indicates ther e is only 1 bit in th e

mask

Only the highest-order bit is considered an d m ust be the

same as 127, wh ich is a 0 bit.

AllowConnectionFrom=198.12.33./

255.255.255.:198.12.92./255.255.255.

systems on the 198.12.33.xx an d 198.12.92.xx

networks may connect

Table 5 IP Address parameters (part 2 of 2)






s Run the mcontrol comm and on UN IX or Wind ows. For information abou t the

mcontrol comm and , see “m control—Perform ing cell control operations” on

page 398.

Table 6 lists the specific instan ces in w hich the reconfigure feature can be used and

the effect that resu lts from its use.

Table 6 Files for cell reconfiguration

Type Name/Directory Result of reconfiguration

cell d irectory mcell.dira

a For mcell.dir an d mcell.trace , a hang-up signal on a UN IX platform p erforms maximu m reconfigu ration

withou t a cell restart. For inform ation abou t restarting a cell, see “Interpreting cell execution failure codes”

on page 79.”

This internal d irectory is replaced w ith new contents from the

mcell.dir file. Associated da ta objects are rep laced as well.

Conn ected clients and destinations rema in connected, even if the

correspond ing directory entries are mod ified.

cell tracing mcell.tracea Tracing is adapted and has the same effect as throu gh the mcfgtrace

CLI.

cellconfiguration

mcell.conf The cell restarts automatically.

mcell.propagate

mcell.modify

KB collector kb\ collectors The cell restarts automatically.

KB program kb\ classes The cell restarts automatically.

\ kb\ rules

\ kb\ l ib

\ kb\ b in

KB data kb\ data The cell restarts automatically.

\ k b\ records



Monitoring event performance


Monitoring event performance

Event processing metrics are intern al coun ts maintained on cell performance

categories in connection with even t processing. These metrics count th e following

items:

s nu mber of events received, includ ing erroneous on es

s nu mber of events containing errors

s nu mber of events d ropp ed by ru les (Filter, Regulate)

s nu mber of events removed from the event repository dur ing cleanup

s nu mber of events prop agated, includ ing sendto

s nu mber of events added to the event repository, that is, entering the perm anentcontext

Calculation is perform ed on a 60-second basis, so every minu te the counters arerestarted. Counts from th e last five minutes are retained. Runn ing coun ters are reset

only on demand .

The resulting metr ics are:

s short term —total count of the last comp lete one-minu te interval

s med ium term—sum of the five last, comp leted on e-minu te intervals

s long term—running total

Metrics are stored in MC_CELL_METRIC data objects, one object instance for eachmetr ic. Each metr ic men tions the subject. For each of the shor t-, med ium -, and long-term r esults, it contains the length of the interval, in second s, and th e total coun t. An

average per second is also provided , round ed to an integer. Other averages per

second , minu te, or hou r can be calculated by the app lication from th is inform ation, if

needed.

Metrics are stored in the Saved State, to ensure persistency. They can be reset

explicitly w hen the cell is restarted , using the -i option with parameter m (-im),

wh ich resets the metric coun ters.

A configuration param eter, CellMetricsEnabled, determ ines whether m etrics arecollected or n ot.

The mcontrol CLI is used to sw itch m etric collection on and off, and to reset the

coun ters. Short- and med ium-term m etrics are reset w henever m etrics are d isabled.

Metrics can be retrieved throu gh rules by d ata object access, or through a comman d.The BMC Impact Explorer console and th e mgetinfo CLI can u se that comm and .



Monitoring client to cell interactions


The received event counter d oes not include incoming m essages that cannot be

parsed as events. It does include even ts of nonexistent classes or events with

erroneous slots. These are ad ded to the erroneous event coun ter. Internally generatedevents are coun ted as received events. Dropp ed events includ e those that are

dropp ed w hen an event w ith the same u niversal ID exists.

Table 7 lists the m etrics data objects MC_CELL_METRIC slots.

Sub ject nam es ava ilable are:

ReceivedEvents

ErrorEvents

DroppedEvents

StoredEvents

RemovedEvents

PropagatedEvents

CLI comm and s for collecting m etrics are:

mcontrol metrics on|off|reset

mgetinfo [-v] metrics


When ever a client connects, disconnects, or mod ifies an event, the cell generates an

interna l event to represent this operation. Such even ts are only generated for certain

clients configured by means of the ReportConnectClients an d

ReportModifyClients settings.

Table 7 MC_CELL_METRIC slots

Slot Description

description metric d escription

long_average long-term average, per second

long_interval long-term interval lengths, in seconds

long_total long-term total coun t

medium_average med ium -term average, per secondmedium_interval med ium -term interval lengths, in second s

medium_total medium -term total count

short_average short-term average, per second

short_interval short-term interval lengths, in second s

short_total short-term total coun t

subject metric subject nam e





The parameter value is interpr eted from left to right. Settings that conflict with

previous settings override th e previous ones. Table 8 lists the defaults for these two

parameters.

Every p aram eter correspond s to a rep orting clients set. Such a set has a p ositive and a

negative list. Clients tha t belong to the p ositive list will have their op eration rep ortedwh ile operations p erformed by clients on the n egative list w ill not be reported.

Clients that are not nam ed in th e param eter are considered to be on the default list.

The defau lt list initially is the negative list. The default list can be m odified through aspecial setting of the pa ram eter.

A value for a r eporting configuration parameter consists of a comm a separatedsequen ce of client nam es. Every client nam e can be prefixed with a minus sign (-) or

a plus sign (+). The client nam e prefixed with th e minu s sign (-) is add ed to the

negative list. When not p refixed, or pr efixed w ith a plus sign (+), it is add ed to thepositive list.

The special value ALL in place of a client nam e refers to the defau lt. Includ ing ALL or

+ALL mod ifies the d efault list so it becomes the positive list. With -ALL, the d efault list

is the negative list. Both p aram eters could includ e -ALL, as this is the defau lt settingfor clients that ar e not explicitly men tioned .

The sup erclass for client op eration related events is MC_CELL_CLIENT. Table 9 lists the

slots.

Table 8 Default values for client parameters

Parameter Value

ReportConnectClients browser, Console, mcontrol, mkill, mposter, msetmsg,

msetrec

ReportModifyClients mposter, msetmsg, msetrec

Table 9 MC_CELL_CLIENT slots

Slot Data

client_location the location of the client as IPAddress:Port

client_name the client's nam e, as annou nced by the client, or noname

client_type typ e of client, such as ad ap ter, CLI, console, cell



Configuring cell tracing


There are thr ee subclasses of this class:

s MC_CELL_ALLOWED_CONNECT to rep resent successful client connection

s MC_CELL_UNALLOWED_CONNECT to represent a refused connection

An attemp t to connect using an invalid encryption key generates an internal event,MC_CELL_UNALLOWED_CONNECT, that contains the slot reason, which details wh y

the connection is refused .

s MC_CELL_DISCONNECT to rep resent a d isconnect.

Anoth er class, MC_CELL_MODIFIED_EVENT, represent s the opera tion of mod ification

of an event. Table 10 lists the slots.

Configuring cell tracing

To set up cell tracing, configure

s the tr ace configu ration file, mcell.trace

s tracing p arameters in the mcell.conf configu ration file

You can also configure cell tracing u sing the mcfgtrace comman d. For furtherinformation , see “mcfgtrace—Configuring tracing” on page 389.

Configuring mcell.trace

The trace configu ration file, mcell.trace , configu res the tracing of the cell’s op eration.Tracing m essages are d ivided in several levels. Every m odu le of the cell can be

configured differently. An ou tpu t d estination can be d etermined p er m essage level

and per m odu le. Messages also can be disabled a t the same gran ularity.


The configuration comm and s in mcell.trace are incremental. Every new comm and

add s to the configuration, possibly overriding p revious command s either comp letelyor par tly.

Table 10 MC_CELL_MODIFIED_EVENT slots

Slot Data

event un iversal event ID of the event being m odified

requestor identification of the u ser that p erformed the m odification



Configuring mcell.trace


Figure 10 show s the format of a configura tion line in the mcell.trace file.

.

Table 11 lists the parameters that mu st be defined in a configuration line.

Figure 10 Format of configuration line in mcell.trace file

<Module> <Level> <Destination>

SWITCH <Switch> <Destination>

Table 11 Trace configuration file parameters


Destination destination file nam e or p redefined valu e for the selected trace messages or

switch

predefined values:

no—disables these tracing messagesconsole—send s to the console device

stderr—sends to standard error stream

Levela

a You can also sp ecify ALL or * (wildcard) for these p arameters.

message severity value level

predefined values:

s FATAL

s ERROR

s WARNING

s INFORM

s VERBOSE

Modulea nam e of modu le, each of wh ich correspond s to a par ticular category of

information, such a s filtering or configuration; values are as follows:

s ACTIONs COLLECT

s COLLMAP

s CONFIG

s CONTROL

s DATAPROC

s DBDATAID

s DBEVTID

s DBEVTTM

s EVTLOG

s EVTPROC

s EXPORT

s FILTER

s HEARTBEATs INTEVT

s MC2TEC

s MCBAROC

s MESSAGES

s METRIC

s PROPAGATE

s QUERY

s RECOVERY

s RECTRL

s REGEX

s REGULATE

s RESULTs ROLES

s RULES

s SERVICE

s SRVMGT

s STATBLD

s SVCMGT

s SVRCOMM

s SVRDIR

s SYNCH

s SYSPROC

s TRACE

SWITCH keywo rd that enab les access to a sublevel or category of messages for a

module

Switch switch n ame



Configuring a destination for cell trace output


Configuring a destination for cell trace output

You can use the tr acing p aram eters to configure the cell to outp ut information to aspecified destination. The d estination for cell trace outp ut is determ ined by the value

of theDESTINATION

param eter in themcell.trace

file.

Possible destinations for cell trace outpu t are:

s the console

s the stand ard error stream

s an external file or files

s no trace outpu t

In ad dition to sending trace outp ut to one of these destinations, you also can sendtrace outp ut to anoth er cell. For inform ation, see “Sending tra ce outp ut to an other

cell” on page 76.

Sending trace output to a console

To send trace outp ut to a console, open the mcell.trace file and set the DESTINATION param eter to the value console.

Sending trace output to the standard error stream

To send trace output to the standard error stream of the command window wh ere thecell is run ning , open the mcell.trace file and set the DESTINATION param eter to thevalue stderr.

If the cell ru ns as a service or daem on, all trace outp ut th at is configured to go to

stderr will be red irected to the file specified in the TraceDefaultFileName

param eter in the mcell.conf file.

If you specify for the trace outp ut to go to stderr, the trace file is tru ncated every

time the cell restarts, and a new trace file is wr itten.

Sending trace output to an external file

To send trace output to an external file or files, open the mcell.trace file and set th e

DESTINATION parameter to the path and file name of the d estination file.

The cell keeps th e trace file open on both UNIX and Wind ow s systems. On UN IX, anyattemp t to remov e the file w ill succeed. How ever, all trace outp ut goes to an inv isible

file that becomes visible when the cell is restarted .



Sending trace output to another cell


A trace destination file can be located a nyw here, but th e BMC Imp act Solutions

process mu st have w rite access to that location.

Disabling trace output

To disable trace outpu t, open the mcell.trace file and set the DESTINATION parameter

to the value no.


Send ing trace outp ut to a cell allows you to captu re the traces of one or more cells in a

centralized location. To send the trace of one cell to anoth er cell, the trace of the

originating cell should be p rod uced as even ts. Those events can be sent to thedestination cell using a prop agate ru le.

To enable sending cell trace information to an other cell, you must

s configure wh ich m odu le/ level combinations of trace messages will be prod uced as

events

s add a p ropagate ru le to the Knowledge Base to specify which trace log events have

to be prop agated to w hich d estination(s)

Once configu red , the cell trace mod ule will generate an in terna l event for each tra celog message.

Definition of the class of trace log events

Each trace message is represented thr ough a single MC_CELL_LOG_MSG event, asshown:

WARNING

The MCELL_HOME \ tmp\ cellName directory is for temp orary files only. A trace file placed

in that directory w ill be d eleted by the cell when it restarts. To m aintain you r trace file across

cell sessions, place it in a d ifferent d irectory.

ENUMERATION MC_LOG_LEVEL

10 VERBOSE

20 INFORM

30 WARNING

40 ERROR

50 FATAL

END





The log_time date and time slot is an integer in timestamp format.

The textual represen tation of the log message log_text uses th e originating cell'slocal m essage catalog.

Configuring trace messages to be produced as log events

By d efault, a cell will not p rod uce log events for its trace. This has to be enabled

explicitly u sing th e TraceEvents configuration p arameter in th e mcell.conf file. The

value of this param eter is a comm a-separated sequence of module:level

combinations. Each one is optionally prefixed with a + or a - sign to ind icate add ition

or remova l, respectively, from the list. The sp ecial value ALL for module and for

level indicate all mod ules and all levels.

For example

This setting specifies that even ts mu st be generated for messages from all mod u les, of

all but th e VERBOSE level.

For m ore inform ation abou t the trace configuration p arameters in mcell.conf , see

“Trace parameters” on page 461.

MC_EV_CLASS: MC_CELL_LOG_MSG ISA MC_CELL_CONTROL

DEFINES {

log_time: INTEGER; -- Timestamp

log_program: STRING; -- Name of the program generating the message

log_module: STRING; -- Name of the module producing the message

log_level: MC_LOG_LEVEL; -- Message levellog_src_file: STRING; -- Source file name

log_src_line: INTEGER; -- Source file line number

log_msg_id: STRING; -- Unique message identifier (form BMC-IMCxxxxxxC)

log_args: LIST_OF STRING; -- Message argument list

log_text: STRING; -- Message text in origin's locale

};

END

TraceEvents=ALL:ALL,-ALL:VERBOSE

WARNING

Event tracing shou ld be configured with care, as it may pro du ce an excessive nu mber of

events. In particular, VERBOSE level messages shou ld not b e configured a s events.



Event processing errors


Adding a propagate rule to the Knowledge Base to specify which trace logevents have to be propagated to which destination(s)

The prop agate ru le syntax is d escribed in the BMC Impact Solutions: Knowledge Base

Development reference guide.

The following is an exam ple of a prop agate ru le for trace log events:

Event processing errors

When an error occur s du ring the processing of an even t, the cell’s trace displays anerror m essage. It also generates an intern al event of class MC_CELL_PROCESS_ERROR,

w ith the slots listed in Table 12.

Automatic notification of trace configuration changes

The cell autom atically genera tes the following MC_CELL_LOG_CHANGED event when

trace configu ration is mod ified for a cell:

If the m od ification ap plies to all mod ules, then log_module=ALL.

propagate PropTraceEvents: MC_CELL_LOG_MSG

to CentralAdminCell

END

Table 12 MC_CELL_PROCESS_ERROR slots

Slot Data

error_code the error number

error_goal the part of the processing comman d th at has the error

error_message an error description message

error_source the p osition in th e rule source wh ere the error occur red

event th e mc_ueid of the event that w as being processed

MC_EV_CLASS: MC_CELL_LOG_CHANGED ISA MC_CELL_CONTROL

DEFINES {

log_module: STRING; -- Name of the module

log_level: MC_LOG_LEVEL; -- Message level

log_destination: STRING; -- Destination file name

};

END



Interpreting cell execution failure codes


If the mod ification ap plies to all message levels, then log_level=ALL.

The log_destination slot contains th e full pa th to the destina tion file, in normalized

(UNIX) form . Other p ossible values are:

s no—ind icates d isablings stderr—ind icates redirection to the stand ard error stream

s console—ind icates red irection to the console term inal

Interpreting cell execution failure codes

When the cell runs as a d aemon or a service, it has no stand ard ou tpu t or error

stream. Tracing that is configu red to go to stderr will be red irected to a file in th is

case. The pa th for that file can be configu red in mcell.conf . The defau lt is MCELL_HO ME \ tmp\ cellName \ trace.

If the cell service setup fails, an er ror file, mcell.err, is genera ted. Ad d itional service

setup failures can be ap pen ded to th e original file, resu lting in a file content of mu ltiple lines. Norm ally, each line correspond s to one failed service setup . This error

file contains exit codes sp ecific to BMC Imp act Manager.

Table 13 lists the exit codes for BMC Impact Manager .

Table 13 BMC Impact Manager exit codes (part 1 of 2)Code Description

1 invalid comm and line options used

2 bad h ome d irectory specification throu gh op tion -l

3 no hom e directory could be determ ined

4 specified home directory is invalid

5 internal initialization failure

16 tracing configuration failed

17 system p rocess han dling m odu le initialization failure

19 logging facility initialization failur e

27 service control module initialization failure

29 Knowledge Base load failed

37 message han dling m od ule initialization failure

39 intern al object initialization failure

47 event p rocessing m odu le initialization failure

49 saved state reload failed

57 query h and ling m od ule initialization failure

59 service activation failed



Using the BMC IX Administration view to manage cells


Using the BMC IX Administration view tomanage cells

You can also manage cells by using a pop -up m enu in the navigation p ane of theAdmin istration view of BMC Imp act Explorer to perform the following tasks:

s connect and d isconn ect a cell

s view cell information

s stop and start a cell

s pau se a cell

s reload cell configuration

s propagate events

s

register for state chan ge eventss collect m etrics

For more informa tion on using BMC Imp act Explorer, see Part 2, “Event managemen t

adm inistration” and the BMC Impact Solut ions: Event M onitoring Operator’s Guide user

guide.

Connecting or disconnecting a cell

Use the Disconnect and Connect men u comm and s to connect or d isconn ect a cell from

BMC Imp act Explorer .

To connect or disconnect a cell

1 Right-click the cell icon or name.

2 Select Connect or Disconnect from the pop-up m enu.

67 internal object module initialization failure

69 metr ics initialization failed

77 data processing mod ule initialization failure79 metr ics activation failed

97 service setup failed

Table 13 BMC Impact Manager exit codes (part 2 of 2)

Code Description



Viewing cell information


This men u item toggles between Connect an d Disconnect, depend ing on the state of

the cell when you right-click it. The result of your action in the Adm inistration

view is reflected in the Events and Services views.

Viewing cell information

Use the View Manager Info menu command to view information about and the

metr ics associated with the cell selected.

To view cell information

1 Right-click a cell.

2 Choose View Manager Info.

The Impact Manager Info d ialog box app ears w ith cell property information

presented on the Info tab.

3 To refresh the information in the Metrics tab of this d ialog box, click Refresh in the

top right corner of the tab.

Controlling cells

Use the Cell Control menu comm and to pau se and resum e, restart, and stop cells.

To pause and resume a cell


2 Choose Cell Control => Pause .

When a cell is pau sed, tw o black vertical bars ap pear on th e cell icon.

3 To resum e cell operation a fter a pause, right-click the cell and choose

Cell Control => Resume.

To restart a cell


2 To stop a cell briefly and then restart th e operation, select Cell Control => Restart.





To stop a cell


2 Select Cell Control => Stop .

3 In th e Stop Confirm ation d ialog box, click Yes to stop the cell’s serv ice.

If a cell has been stopp ed with th is comm and , you m ust m anu ally start the cell’s

service for the cell to resum e opera tions. For m ore information, see “Interpretingcell execu tion failure codes” on page 79.

To perform a StateBuild


2 To force a cell to p erform a StateBu ild immediately, select Cell Control => Build

State.

The cell per forms a StateBuild immed iately, rather th an w aiting for the next

schedu led StateBuild.


Use the Reload menu comm and to access the comm and s for reloading a cell’sconfiguration.

To reload all of the cell configuration


2 Select Reload => All.

All configuration files and the KB are reload ed.

To reload the knowledge base


2 Select Reload => Know ledge Base.

The KB is reloaded .



Forcing event propagation


To reload the directory


2 Select Reload => D irectory.

The mcell.dir file is reloaded .

To reload cell configuration


2 Select Reload => Configuration.

The configuration files mcell.conf , mcell.propagate, and mcell.modify are reloaded .

To reload trace configuration


2 Select Reload => Trace.

The mcell.trace file is reloaded .

Forcing event propagation

You can u se the Propagate command to force the selected cell to send the contents of the d estination buffers to one or all its destinat ion cells imm ediately.

To force propagation to all target cells


2 Select Propagate => Retry All to force propagation of the buffer conten ts to all target

cells.

To force propagation to a single target cell


2 Select Propagate => Retry

3 In the Prop agate d ialog box, specify the target cell to wh ich you w ant to p ropagate

the bu ffer contents.



Registering for SIM notification events


4 Click OK.


BMC Imp act Manager can generate events that n otify you of changes to comp onents

in the SIM service mod el. These even ts are called SIM notification even ts. The four

types of SIM notification even ts are

s SIM_COMPONENT_CHANGE

s SIM_COMPONENT_DELETE

s SIM_RELATIONSHIP_CHANGE

s SIM_RELATIONSHIP_DELETE

The SIM_COMPON ENT_DELETE and SIM_RELATIONSHIP_DELETE even ts are

generated w hen you remove a configuration item or an impact relationship from thepublished service model. The SIM_COMPONENT_CHANGE and

SIM_RELATIONSHIP_CHAN GE events are generated when a configuration item or

an imp act relationsh ip is altered by the cell because of a change in status or p riority.

BMC Imp act Manager gen erates these notification event s up on requ est by a client.

For examp le, the BMC Impact Portal can register to receive not ification even ts just as

a gateway client can. Anoth er BMC Impact Manager or even the BMC Imp actMana ger containing the SIM mod el can register to receive the notification events.

NOTE In the mc_sm_notify.baroc file und er mcell_home/etc/cellName/kb/classes, you can view the

definitions of the SIM_NOTIFICATION_EVENT base class and the even t classes

SIM_COMPONENT_CHANGE, SIM_COMPON ENT_DELETE,

SIM_RELATION SHIP_CHANGE, and SIM_RELATION SHIP_DELETE.





The following slots are reported :

s Slots for configu ration item :

—status

—manual_status

—computed_status

— self_status

—impact_status

—manual_status_comment

—manual_status_requestor

— consolidate_fun ction

— root_causes

— schedu le_status

—cost

— self_priority

— impact_priority

—computed_priority

—maintenance_mode

s Slot for relationship s:

—true_impact

To register for n otification events, you crea te a SIM_NO TIFICATION_REGISTRYinstance in the cell, telling it w hich notification even ts to look for and which clients to

forw ard th e events to.

You perform th is procedu re throu gh th e BMC IX GUI or throu gh th e mp oster CLI.

To register for notification events in the BMC IX

1 In the Adm instration tab, expan d the cell for w hich you w ant to create a

SIM_NOTIFICATION_REGISTRY data instance.

2 Expan d the DATA folder.

3 Expan d the MC_CELL_DATA folder.

NOTE

Refer to th e BMC Impact Solut ions: Knowledge Base Development Reference for mposter examples

that sh ow how to register for notification events.





4 Right-click SIM_NOTIFICATION_REGISTRY.

5 Select New .

6 Fill in the ed itable fields in th e SIM_NOTIFICATION_REGISTRYdialog box.

Table 14 SIM_NOTIFICATION_REGISTRY dialog box fields (part 1 of 2)

Field Description

mc_udid populated automatically

client_data allows you to define a ru le set for the SIM notification even ts that you rclient has registered for. For example, the ru le could look for the text

john in the client_data to determine if it is a state chan ge requ ested by john.

The content of this slot is copied to the client_data slot of the correspond ing

SIM n otification event. Each SIM_NOTIFICATION_REGISTRY da ta instancemu st hav e a different value for this slot. This slot is available only in BMCImpact Manager versions 7.0.x and later.

clients comm a-separated list of clients w here the notification mu st be sent. The clients

in the list mu st be defined in mcell.dir.

By d efault, the cell nam e is listed as the client in mcell.dir, so you d o notneed to change mcell.dir if you ar e sending even ts intern ally.

requested_notifications comm a-separated list of SIM notification even ts for wh ich notification is

requested

s SIM_COMPONENT_CHANGE

s SIM_COMPONENT_DELETE

s SIM_RELATIONSHIP_CHANGE

s SIM_RELATIONSHIP_DELETE

notification_mode specifies how slot values th at have n ot changed are reported in the SIM

notification event

s DELTA — the slots wh ose values do not change are rep orted w ith their

default values, not their current values. The default value is an emp ty

string for sym bolic valu es and -1 for nu mer ic values. See the .baroc class

definition of the SIM notification even t for the defau lt slot values.

s FULL — the current va lues of all slots are reported, includ ing those th at

have not changed



Collecting metrics


7 Click OK.

In the Ad ministration tab, the new SIM_NOTIFICATION_REGISTRY instance is

displayed un der SIM_NOTIFICATION_REGISTRY.

To delete a SIM_NOTIFICATION_REGISTRY data instance

1 Right-click the SIM_NOTIFICATION_REGISTRYdata instance.

2 Select Delete.

To modify a SIM_NOTIFICATION_REGISTRY data instance

1 Right-click the SIM_NOTIFICATION_REGISTRYdata instance.

2 Select Edit.

3 Make the n ecessary changes to the fields in the SIM_NOTIFICATION_REGISTRY dialog box.

4 Click OK to accept th e changes.

Collecting metrics

Use the Metrics menu command to access the comm and s for w orking with metrics.

notifications_at_registration instructs the cell wh ether or not to send the current comp onent states at the

mom ent of registration

s YES — instructs the cell to send th e current comp onent state at themom ent of registration

s NO — instru cts the cell not to send the current comp onent state at the

mom ent of registration

asset_filter filter contains on e class nam e. When you specify a class nam e, only state

chang e notifications for configuration items of this class or a sub-class are

generated.

Table 14 SIM_NOTIFICATION_REGISTRY dialog box fields (part 2 of 2)

Field Description



Collecting metrics


To turn metrics collection off


2 Select Metrics => D isable.

To reset collection counters


2 Select Metrics => Reset.

The collection coun ts are r eset to 0.




C h a p t e r 33Managing the BMC ImpactAdministration server

This chap ter pr esents the following top ics:

Over view to BMC Imp act Ad ministra tion server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

Master or Stand ard BMC Imp act Adm inistration server . . . . . . . . . . . . . . . . . . . . 90

Starting and stopp ing the BMC Impact Adm inistration server . . . . . . . . . . . . . . . 91

Com man d line in terface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

Impact Administ ra tion cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

How to configu re BMC Imp act Ad min istration server files . . . . . . . . . . . . . . . . . . . . . 94

Defin ing grou p roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Defin ing permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

Receiving synchronized data from the BMC Por tal . . . . . . . . . . . . . . . . . . . . . . . . 102

File-based au thentication: updating user information . . . . . . . . . . . . . . . . . . . . . . 103Synchronizing cell information with BMC Atr ium CMDB. . . . . . . . . . . . . . . . . . 105

Up dating cell information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

Editing logging properties for IAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108Defining client logging for the iadmin scrip t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

Custom izing colors for sever ities, statu ses, and priorities . . . . . . . . . . . . . . . . . . 109

Defining standalone, primary, and second ary BMC Imp act Adm inistrationservers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

Defining an HA configu ration for th e Imp act Adm inistration cell . . . . . . . . . . . 112Transaction and trace logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

Ad vanced tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

Configuring the BMC Impa ct Administration server to su pp ort rem ote actions . .114

Configuring Lightw eight Directory Access Protocol for BMC Imp act

Ad minist ra tion server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115



Overview to BMC Impact Administration server


Overview to BMC Impact Administrationserver

The BMC Imp act Adm inistration server (IAS)

s au then ticates logins to BMC IX

s defines user group s and roles and their p ermissions to view and edit the BMC IX

tab view s and functions

s receives the synchron ization actions of the BMC Portal for users and grou ps

s up dates cell-related information as cells are add ed to or rem oved from the IAS

and/ or BMC Atrium CMDB

s sup ports high availability (HA)

s controls log files

s determines the BMC IX color schem e for severities, statuses, and pr iorities

s provides CLIs that manage its configuration files

In this 7.1 release, the IAS determines mu ch of the functionality that the BMC Impact

Portal had controlled in p revious 5.x and 7.0.x releases.

Master or Standard BMC Impact Administration server

You can select a Master or Stand ard IAS at installation. A Master IAS enables theInfrastructure Man agement feature in BMC Impact Explorer an d installs anaccomp anying Impact Administration cell (IAC) on the sam e host as the Master IAS.

(The Imp act Adm inistration cell is designated by d efault as Admin in the BMC ImpactExplorer GUI.)

A Stand ard IAS pr ovides all the featur es of the IAS, except sup por t for Infrastru cture

Managemen t and the IAC.

NOTE

To switch from a Master IAS to a Stand ard IAS or vice versa after installation, you m ustun install the existing server and then install the new server.



Starting and stopping the BMC Impact Administration server


Starting and stopping the BMC Impact Administration server

On MS Wind ows, restart the IAS service through the Services window.

On UN IX, execute the ru n_IAS script from th e app rop riate path . The default path is /opt/bmc/Impact/server/bin. You m ust be logged on as root or as the user w ith the

app ropriate perm issions to start and stop the script.

You n eed to restart the IAS anyt ime you manually edit one or m ore of its

configu ration files to initialize the configuration chan ges.

If you use th e provided CLIs to man age the files, the IAS is autom atically refreshed

and does not requ ire a restart. BMC recomm ends th at you u se the CLIs whenever

possible.

Configuration files

End u sers can configu re the following IAS files, located un der the

IMPACT_SOLUTION S_H OM E / server/conf directory:

s ias.properties

s user_definitions.xml

s ldap_configuration.xml

s role_permission.xmls group_roles.xml

s cell_info.list

s cmdb.properties

s server_logging.properties

s client_logging.properties

s color.properties

Command line interface

The IAS uses an iadm in script or comman d to launch the file management options.

The iadm in script or comman d is located u nd er the

IMPACT_SOLUTIO NS_HO ME/server /bin directory.

NOTE

The full path to the server d irectory un der IMPACT_SOLUTIONS_HOM E is

/opt/Impact/server on UN IX and dri ve let ter: \ Program Files\ BMC So ftw are\ Impact\ server on MS Window s.



Command line interface


You can use the iad min script or comman d to man age the follow ing configuration

files:


s group_roles.xml

s cell_info.list

s role_permission.xml

Remember that you do not h ave to restart IAS to initialize your changes if you u se the

iadmin script or comm and .

The iadm in options are summ arized below in Table 15 on p age 92. You can d isplay

these options from the comman d line by entering iadm in -h.

Table 15 iadmin options

Option Description

-ac add a cell to the cell_info.list file

-mc modify a cell

-dc delete a cell

-lc list connected cells

-aru add a new user

-mru modify the user group or groups to which an existing user

belongs

-dru delete an existing user

-lru list all the users

-ar ad d a new mapping between a role and permissions

-dr delete an existing role/ permissions mapping

-lr list all the roles

-mr modify the mapping between a role and a list of permissions

-ag ad d a new mapping between a group and a list of roles

-dg delete a group/ role mapping for a specified group

-lg list all the groups

-mg modify the mapping between a group and a list of roles

-cp change the password for an existing user

-reinit [fullsync] in an HA setup, -reinit restarts the primary or second aryserver w ith the latest configuration d ata. Use the[fullsync] option on the secondary server to copy th epr imary server’s configura tion to it and r estart it withthe n ew configuration

-sync in an HA setup, synchronizes the secondary server before the

expected syn chronization interval



Impact Administration cell


When u sing iadm in to man age files, remember to

s enclose values within quotation marks if they contain spaces

s omit sp aces in lists

s execute the iadm in comm and or script from the /bin subd irectory of your

IMPACT_SOLUTIO NS_HO ME/ server directory


The essential comp onen t of the Master IAS is the Imp act Adm inistration cell (IAC).

Its default cell instance nam e is Adm in. The IAC is a custom SIM cell that contains a

specialized Knowled ge Base. This cell accepts registration, configuration, an d otherevents from BMC p rodu ct comp onents and app lications. It then creates the

comp onent d efinitions based on the event information.

The d efault mcell.d ir file of the IAC is as follows:

Admin is the default nam e of the Imp act Adm inistration cell. The defau lt name is

provided at installation. It is the same name as the IAS instance nam e. Its defau lt port

nu mber is 1827.

You can chan ge the defau lt name of the IAC and the IAS instance nam e

simultaneously du ring installation as an installation option. After installation, you

can change the name of the IAC ind ependent of the IAS instance nam e. You canchange the default port nu mber as long as the port n um ber that you assign d oes not

conflict w ith any oth er.

IAC is the alias name tha t other cells use to propagate events to the Imp actAd ministration cell.

Each SIM or BEM cell that registers with an Imp act Adm inistration cell and a Master

IAS shou ld have an IAC entry in its mcell.d ir file along with its own cell name, as inthe following examp le:

cell Admin mc hostName:1827

cell IAC mc hostName:1827

cell cellName mc hostName:1828

cell IAC mc hostName:1827



How to configure BMC Impact Administration server files


How to configure BMC Impact Administrationserver files

This section d escribes the following configuration tasks:

s Defining group roles and perm issions

s Ad ding Imp act Manager cells to the cell_info list

s Defining standalone, primary, an d second ary BMC Imp act Adm inistration servers

s Defining HA configuration for Imp act Adm inistration cells

s Synchron izing cell information w ith BMC Atrium CMDB

s Receiving synchron ized d ata from the BMC Portal

s Defining server-side logging levels

s Defining client-side logging levels

s Custom izing the GUI color scheme for statu s, priority, and sever ity levels

s Setting LDAP au then tication

s Configuring IAS to support remote actions

Depend ing on th e goal of the task, you m ay need to edit mu ltiple files.

Guidelines for manual edits

Use the iadmin script or command wh enever possible. If you have to m anua lly edit afile, follow these basic guidelines:

1 Op en the file in a text editor.

2 Make the changes in the p roper format.

3 Save the file withou t changing its extension or file path.

4 Restart IAS.

NOTE

When man ually editing files to enable a h igh availability (HA) configuration, you mu st follow

the sp ecial guidelines outlined in the top ic“Defining an HA configu ration for the Impact

Adm inistration cell” on page 112.



How groups, roles, and permissions are related


How groups, roles, and permissions are related

In the IAS configuration, users are assigned to one or m ore grou ps. Each grou pincludes on e or m ore roles. The role determ ines the pred efined p ermissions that the

user h as. Permissions d etermine w hich

s BMC IX tab view s

s cells

s events

s collectors

s service mod el comp onent ob jects

that th e user can access, view , or edit.

Defining group roles

The ias.proper ties file specifies the default grou p roles, which are iden tified in the

grou p_roles.xml file:

Group roles

IAS provides the following defau lt group s and user roles, both of wh ich are listed in

Table 16. You can view these roles in th e grou p_roles.xml file. Refer to Table 17 on

page 98 for a comp lete listing of access permissions for group and role combination.

com.bmc.sms.ixs.group.role.mapping=group_roles.xml

Table 16 Groups and roles

Group Role

Full Access Full Access. Has write access to all features

Read Only Read Only. Has read-only access

Service Administrators Service Administrators. Has write access to a ll fea tures

Service Managers Service Managers

Service Managers - Senior Service Managers - Senior

Service Operators Service Operators

Service Operators - Senior Senior Service Operator

Admins Full Access, Service Administrators

Operators Service Operators, Senior Service Operators

Supervisors Service Manager, Senior Service Managers

You can up date user grou ps and roles and create new ones by editing the

grou p_roles.xml file, shown below:

To add a new group with mapping roles

From the / bin subd irectory of your IMPACT_SOLUTION S_HOME / server directory,

execute the iadmin command using the -ag option, as in th e following example:

To modify an existing group and/or mapping roles


execute the iadmin command using the -mg option, as in the following example:

NOTE

If you a re using Lightw eight Directory Access Protocol (LDAP) au then tication, youmu st map your LDAP user group s to the IAS roles defined in the grou p_roles.xmlfile. See “Configuring Lightweight Directory Access Protocol for BMC Impact

Adm inistration server” on p age 115 for m ore information.

<!DOCTYPE properties SYSTEM"http://java.sun.com/dtd/properties.dtd">



<properties>

<entry key="Full Access">Full Access</entry>

<entry key="Read Only">Read Only</entry>

<entry key="Service Administrators">Service Administrators</entry><entry key="Service Managers">Service Managers</entry>

<entry key="Service Managers - Senior">Service Managers -Senior</entry>

<entry key="Service Operators">Service Operators</entry>

<entry key="Service Operators - Senior">Service Operators -Senior</entry>

<entry key="Admins">Full Access,Service Administrators</entry>

<entry key="Operators">Service Operators,Service Operators -Senior</entry>

<entry key="Supervisors">Service Managers - Senior,ServiceOperators - Senior</entry>

</properties>

NOTE

If you’re adding a n ew role to the group , you mu st first create the role and ad d p ermissions to

it using the iadm in -ar option before you create the group . See “To add a new role/ mapping

permission” on page 101.

iadmin -ag group=”NewGroup” :roles=”Role”

iadmin -mg group=”Service Administrators”:roles=”ServiceAdministrators”,“Service Operators”





Any roles that you ad d to a group mu st have already been d efined in the

grou p_roles.xml file.

To delete an existing group

From the / bin subd irectory of your IMPACT_SOLUTIONS_HOME / server directory,execute the iadmin command using the -dg option, as in the following examp le:

You do not sp ecify a role.

To list groups in the group_roles.xml file

From the / bin subd irectory of your IMPACT_SOLUTIONS_HOME / server directory,execute the iadm in command using the -lg option, as in the following examp le:

To update user groups and roles (file editor)

1 Open the grou p_roles.xml file in an ed itor.

2 Upd ate or delete the existing entries, or add a new entry w here

s key is the name of the group

s the values inside the <entry></entry> element are the roles

3 Save an d close the g rou p_roles.xml file.

4 Restart the IAS to initialize the chan ges.

iadmin -dg group=”Service Operators”

iadmin -lg



Defining permissions



The defau lt_role_permissions.xml file defines the view an d ed it perm issions for eachtab view a nd men u op tion in BMC IX. For each role, it lists the permissions in a

comma -separated string as show n in the following extract for the Full Access role:

Any perm ission that you ad d or m odify must be taken from the pred efined

defau lt_role_perm issions.xml file.

Table 17 on page 98 matches the default mapp ing of roles/ perm issions to BMC IX

functionality.

....

<properties>

<entry key="Full Access">administration_tab_view_and_access,

events_tab_view_and_access,services_tab_view_and_access,

services_tab_access_component_event_list,

events_tab_edit_drill_down,events_tab_edit_user_event_filter,

events_tab_edit_user_slot_order, .....

</entry>

....

</properties>

WARNING

Do not modify the default_role_permissions.xml file. Use the role_permissions.xml file

instead.

Table 17 BMC Impact Explorer user group mapping to functionality (part 1 of 3)

P e r m

i s s i o n ( P ) o r R i g h t ( R )

Function C h o i c e s

F u l l A c c e s s

S e r v

i c e A d m i n i s t r a t o r

S e r v

i c e M a n a g e r , S e n i o r

S e r v

i c e M a n a g e r

S e r v

i c e O p e r a t o r , S e n i o r

S e r v

i c e O p e r a t o r

R e a d

O n l y

BMC Impact Explorer

R Events tab View X X X X X X X

R Con figu ration–Ed it

Relationship View

Edit X X X X X X

R Con figu ra tion –Ed it Per son al

Filters

Edit X X X X X X


Attribute (Slot) Ord ers

Edit X X X X X X






MetaCollectors

Edit X X X X X

R Con figu ration –Ed it Glob al

Event Filters

Edit X X X X

R Con figu ration –Ed it Glob al

Attribute (Slot) Ord ers

Edit X X X X

R Con figu ra tion –Ed it Im p act

Manager Group on Impact

Manager Configuration

window

Edit X X X X X X X

R Even ts tab–Ju mp from an

Event to Its Services

Impacted View

Edit X X X X

R Events tab–Reopen Events Edit X X X

R Ev en ts tab–Ev en t Oper ation

Supervisor Privileges (for

example, close events ownedby som eone else)

Edit X X X

R Events tab–Assign Events Edit X X X

R Events tab–Add Image View Edit X X X X

R Even ts tab–Delete Im age

View

Edit X X X X

R Services tab View X X X X X

R Ser vices tab–Sear ch for

Service Comp onents

Edit X X X X

R Services tab–Event List View

of a Service Comp onent

View X X X X X

R Services tab–Ed it My

Services Navigation Tree

Edit X X X X

R Services tab-Crea te, Ed it ,

Delete Relationship between

components

Edit X X X X

R Ser vices tab –Set or Rem ov e

Manu al Status (of a

compon ent) Action

Edit X X X X


P e r m i s s i o n ( P ) o r R i g h t ( R )


F u l l A c c e s s

S e r v i c e A d m i n i s t r a t o r

S e r v i c e M a n a g e r , S e n i o r

S e r v i c e M a n a g e r

S e r v i c e O p e r a t o r , S e n i o r

S e r v i c e O p e r a t o r

R e a d O n l y





Full Access role permissions

Members of the Full Access user grou p can view, edit, and create all componen ts and

relationships, includ ing the objects and relationships tha t were created by other

users. Service Adm inistrators, Service Managers - Senior, and Service Managers u ser

group s can edit components an d their associated relationships only if they already

have write permission on the objects.

If the user group mem ber wh o creates a comp onent d oes not specify otherwise, thenthe Read Users and Write Users slots of the componen t are pop ulated by th e user

grou p of the BMC IX login accoun t. To illustr ate, if a u ser account belonging to th e

Service Ad ministrators group creates a compon ent, then by default its Read Usersand Write Users slots are pop ulated by th e user grou p Service Adm inistrators.

Adding customized role/permission mappings

Use the role_perm issions.xml file to add customized role/ perm ission map pings. Thecom.bmc.sms.ixs.role.perm ission.map ping proper ty of the ias.prop erties file specifies

this default file for containing customized role/ perm ission m app ings, as shown in

the follow ing excerp t:

R Ser vices tab –Set or Clear

Maintenance Mode (of a

Comp onent) Action

Edit X X X X

R Administration tab View X X X X

R Timeframes Edit X X X X

R A dm in istration tab: allactions

Edit X X

R In frastru ctu re Man agem en t

subtab

Edit X X

R In frastru ctu re Man agem en t

sub tab: all actions

Edit X X

com.bmc.sms.ixs.role.permission.mapping=role_permissions.xml


P e r m i s s i o n ( P ) o r R i g h t ( R )


F u l l A c c e s s

S e r v i c e A d m i n i s t r a t o r

S e r v i c e M a n a g e r , S e n i o r

S e r v i c e M a n a g e r

S e r v i c e O p e r a t o r , S e n i o r

S e r v i c e O p e r a t o r

R e a d O n l y





If you create a separate .xml file to contain your customized role/ perm ission

map pings, you mu st specify its nam e in the

com.bmc.sms.ixs.role.perm ission.map ping proper ty of the ias.proper ties file. Thenyou mu st restart IAS to initialize the change.

The user-d efined .xml file does not overrid e the d efault file. Its ind ividu al entriesoverrid e matching on es in the default file. Any en tries in the d efault file that are not

overridden by m atching ones in th e user-defined file remain valid.

When you u se the iadm in script to add , modify, or d elete a role/ perm ission

map ping, the change is saved to the role/ perm issions file specified by th ecom.bmc.sms.ixs.role.permission.mapping property.

To add a new role/mapping permission

From the / bin subd irectory of your IMPACT_SOLUTIONS_HOME / server directory,

execute the iadmin command using the -ar option, as in th e following example:

To modify an existing role/mapping permission

You can m odify the permissions associated w ith a role in a u ser-defined

roles/ perm issions file. The m odified en try is saved to the u ser-defined

roles/ perm issions file, which overrides any correspond ing role entry in the d efaultfile.


execute the iadmin comm and using the -mr op tion, as in th e following example:

To delete an existing role/mapping permission

You can d elete an existing role in a user-d efined roles/ permissions file.


execute the iadmin command using the -dr op tion, as in th e following example:

iadmin -ar role=”Test”:permissions=”services_tab_delete_component”

iadmin -mr role=Test:permissions=”services_tab_view_and_access”

NOTE

If the role to be d eleted on ly exists in the d efault file, then an en try is ad ded to the u ser-

defined file. The entry contains the role nam e only, withou t any perm issions associated w ith

it. Because the user-defined entry overrides the default one, the role is effectively deleted.

iadmin -dr role=Test



Receiving synchronized data from the BMC Portal


The entry role=Test is written to the u ser-defined file and effectively overrid es any

identical role in th e d efault file.

To list roles defined in roles/permissions mapping files

You can list all roles defined in both th e default and in the user-definedroles/ perm issions map ping files.

From the / bin subd irectory of your IMPACT_SOLUTIO NS_HO ME/ server directory,

execute the iadmin command using the -lr option, as in the following example:

Receiving synchronized data from the BMC PortalBMC Portal 2.5 has a task nam ed Synchron ize Users with IAS. This a manu al

synchronization feature that pu shes data one w ay from th e BMC Portal to IAS. The

synchron ization is available in Stand ard and BMC Atrium installations.

The BMC Portal connects w ith IAS through IAS’s ad ministrative account. The defaultpassword is IAS$Admin$. (There is no user name associated with administrativeaccess.) During syn chronization, only BMC Portal user grou ps th at have defined

permissions in BMC IX are expor ted. You can check for the p ermissions in th e UserGrou ps task off of the Configu re tab in the BMC Portal. Look for p erm issions that

begin Impact Explorer.

BMC Portal group s are map ped to IAS roles w ith th e same nam e. When a BMC Portalgrou p is exported to IAS, a new role is created in IAS with th e same name. To

illustrate, if the BMC Portal grou p abc is exported to IAS, a role/ perm ission map ping

is created in IAS for abc and all the perm issions that abc maps to in the BMC Portal.

Then IAS creates a group/ role map ping abc/abc.

User password s are not exported, but are set to the d efault value user.

Any cells that are ad ded to the BMC Portal are registered w ith IAS.

For the Atrium installation scenario, BMC Atrium CMDB param eters are not

synchronized w ith either the BMC Portal or IAS. They need to be add ed man ually.

iadmin -lr



File-based authentication: updating user information


In LDAP au thent ication, the IAS and BMC Porta l conn ect separately to an LDAP

server. The map pings of BMC Portal groups to LDAP group map pings are sent to IAS

as grou p to role map pings. The BMC Portal uses the fully qualified d istingu ishednam e for an LDAP grou p (for example, ldap G1.bmc.com) while the IAS uses the

common name (ldapG1). For examp le, if the BMC Portal grou p abc map s to several

LDAP group s—for examp le, ldap G1.bmc.com an d lda pG2.bmc.com—then IAScreates the following group / role map pings: abc/abc, ldapG1/abc, and ldapG2/abc.

To set up LDAP auth entication in IAS, see “Configuring Lightweight Directory

Access Protocol for BMC Impact Ad ministration server” on page 115.


You choose file-based au then tication in test environm ents or in sma ll pr odu ction

environ men ts. Using file-based au then tication, you can manage users of the BMC EMand SIM produ cts independ ent of your corporate environment.

To enable file-based authentication

1 In the IAS.prop erties file, ensu re that the com.bmc.sms.ixs.enable.file.login

param eter is set equal to true.

2 In the u ser_definitions.xml file, define the u ser’s attribu tes. These includ e user id,

password, group nam es and their descriptions, and so forth.

You can use the iadmin comman d to up date user information in the

user_definitions.xml if you h ave enabled file-based au then tication (see “File-basedauthen tication: upd ating user information” on pa ge 103). You can ad d , mod ify, or

delete users, and you can m odify the p assword of an existing user.

The user_definitions.xml file defines a userid, passw ord , and gr oup of a specifieduser, as in the d efault example below:

<?xml version="1.0" encoding="UTF-8"?>

<userList xmlns="urn:bmc:schemas:impact"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="urn:bmc:schemas:impact user_definitions.xsd ">

<user userid="user">

<password encrypted="false">user</password>

<groupList>Full Access</groupList>

<description>This is optional</description>

</user>

</userList>





To add a user entry

When ad ding a u ser entry, enter a plain-text password with the <passw ord

encryp ted> elemen t set equal to false. When the file is initialized , the passw ord

becomes encrypted and the <password encrypted> element is changed to true.

From the / bin subd irectory of your IMPACT_SOLUTION S_HOME / server directory,execute the iadmin command using the -aru op tion, as in the following examp le:

To modify a user group of an existing user


execute the iadmin comman d using the -mru option, as in the following examp le:

To delete an existing user

From the / bin subd irectory of your IMPACT_SOLUTION S_HOME / server directory,execute the iadmin comman d using the -dru op tion, as in the following example:

To modify a password of an existing user

From the / bin subd irectory of your IMPACT_SOLUTION S_HOME / server directory,execute the iadmin comm and using the -cp option, as in the follow ing example:

To list all users in the user_definitions file


execute the iadmin command using the -lru option, as in the following example:

iadmin -aru loginId=qa:password=qa:usergroups:”FullAccess”:description:”Full Access User Group”

iadmin -mru loginId=qa:usergroups:”Read Only”

iadmin -dru loginId=qa

iadmin -cp loginId=qa:oldPassword=qa:newPassword=bsm

iadmin -lru



Synchronizing cell information with BMC Atrium CMDB


Synchronizing cell information with BMC Atrium CMDB

You can syn chronize you r cell information w ith the BMC Atrium CMDB bymod ifying the cmd b.properties, an excerpt of w hich is show n below:

To synchronize with the BMC Atrium CMDB

1 Change the com.bmc.sms.ixs.cmdb.enable.sync property to true.

2 Enter the fully qualified d omain nam e or the IP add ress of the host system w herethe AR Server r esides.

3 Enter the port nu mber of the AR Server. If the AR Server is using p ortmap per, then

enter 0.

4 Enter the u ser Id of the AR Server.

5 Enter the passw ord in plain text. When IAS restarts, it encrypts th e passw ord and

disp lays the encryption in th e file.

6 Restart the IAS.

......

# "true" if this IAS will synchronize with the CMDB server.

com.bmc.sms.ixs.cmdb.enable.sync=false

# host name for AR server

com.bmc.sms.ixs.cmdb.host.name=localhost

# port number for AR server

com.bmc.sms.ixs.cmdb.port.number=0

# user id for AR server

com.bmc.sms.ixs.cmdb.user.id=Demo

# password for AR server.

......

com.bmc.sms.ixs.cmdb.password=



Updating cell information



You can ad d cells to the IAS, mod ify cells, delete cells from th e IAS, and list the cellsthat are curren tly registered w ith the IAS. This cell inform ation is stored in th e

cell_info.list, an example of which is show n below :

Each cell entry contains the following inform ation:

To add a cell


execute the iadm in command using the -ac option, as in th e following example:

cell test mc test.company.com:1828 Production *

cell.Admin IAC mc localhost:1828 Production *

cell.SIM qa mc qa.company.com:1828 qa.company.com:1888 Test "Full Access, ReadOnly"

Table 18 Cell entry format in cell_info.list

Entry Descriptioncell requ ired . Each entry mu st begin with “cell.” The cell typ e is

app end ed after cell, w ith a period separ ating cell and the

typ e. The av ailable cell types are SIM, BEM, and Ad min. IAS

retrieves the type from th e cell and app end s to the entry.

name matches the name in the mcell.d ir file of the cell server

key The default value is mc.

primaryH ost system where the cell resides. It can be an unqualified or

fully qu alified h ost nam e, or an IP add ress.

primaryPort port number of the cell

failoverHost optional. If this is an HA pair, then enter the system namewhere the secondar y cell resides.

failoverPort optional. If this is an HA pair, then enter the port number

that th e second ary cell uses.

environment Production or Test

usergroups user group or group s who can access this cell. If all groups

can access the cell, enter an asterisk. Otherw ise enter the u ser

group nam e, separating mu ltiple group s with commas. If the

group nam e contains a space, use dou ble quotation marks to

enclose the entire nam e.

iadmin -ac name=testCell:key=mc:primaryHost=moondog:primaryPort=1828:failoverHost=suncat:failoverPort=1828:environment=Production:usergroups=*





The cell information is ad ded to the cell_info.list. It is also added to the BMC Atr ium

CMDB if the cell is synchronized w ith BMC Atriu m CMDB as d efined in the

cmdb.properties.

To modify a cell


execu te the iadmin comm and using the -mc option. After you specify the cell name,

you only to need to include the options that you ar e changing, as in th e following

example:

In this examp le, the secondary cell is removed and thu s failoverHost is defined by

nu ll. The environm ent is changed from Produ ction to Test. If you w ere to change the

pr imaryHost or p rimaryPort value, then IAS connects to the cell to retrieve its type.

All updates are saved into the cell_info.list and to the BMC Atr ium CMDB, if the cell

is synchronized w ith the BMC Atrium CMDB.

To delete a cell


execute the iadm in command using the -dc option to delete a cell from the

cell_info.list, as in the following example:

If the cell is synchronized w ith the BMC Atriu m CMDB, it is removed from theCMDB.

To list cells


execu te the iadmin comm and using the -lc option, as in the following example:

iadmin -mc name=testCell:failoverHost=null:environment=Test

iadmin -dc name=testCell

iadmin -lc



Editing logging properties for IAS


Editing logging properties for IAS

IAS generates a default log file, ias<numeral>.log, un der the

IMPACT_SOLUTIO NS_HO ME /server/tmp/ias d irectory. This log file captu res

diagn ostic trace messages generated by the server ’s activity. You can m anu ally editth e

s logging level

s file nam e and p ath

s maximu m size of each file

s nu mber of log files in a cycle

This inform ation is defined in the server_logging.proper ties file. describes theprop erties that you wou ld typ ically mod ify:

After you m ake changes, save the server_logging.proper ties file, and r estart IAS.

Defining client logging for the iadmin script

You can d efine the log message level that is directed to the comm and console when

you execu te the iad min script . The defau lt level is SEVERE, meaning that notices of only the most crucial changes are tran smitted to the comm and console. All other

notices are omitted .

The client log inform ation is d efined in the client_logging.p rop erties file. You can

man ua lly edit the log level by chan ging the valu e of the

java.u til.logg ing.ConsoleH an dler .level p rop erty . All levels below th e one you

specified are om itted from th e client log.

Table 19 Server logging properties

Property Description

.level message levels that the log captures. The default is INFO. The log

ignores all levels lower tha n th e specified one. The values ran ge

from SEVERE to FINEST.

java .util.logg ing.FileH an dler .pat ter n sp ecifies the file nam e, file p ath, an d th e generated numeral th at

d istingu ishes the log file cycle. The defau lt pattern

/ tm p/ ias/ ias%g.log .

java .util.logg ing.FileH an dler .limit th e m aximum size of each log file in bytes. The d efault is 5 million

bytes (about 5 MB).

java.u til.logg ing.FileH an dler .cou nt maximum number of log files in each cycle. The d efault is 10. After

the maximu m of files is reached, a new cycle starts and th e new log

files override the existing ones in sequence.



Customizing colors for severities, statuses, and priorities


After you make changes, save the client_logging.proper ties file.

Customizing colors for severities, statuses, and priorities

You can modify the d efault colors that BMC IX uses fill in row backgrou nd s in tables

to ind icate event severities, service comp onent statu ses, and pr iority comp uta tion by

changing the hexadecimal nu mbers that represent the amount of red, green, and blue

(RGB) in the color. The d efault colors are d efined in the color.proper ties file.

You should be consistent wh en changing th e color values of the same p arameter. For

examp le, if you chan ge the color for DOWN to indicate event severity, you sh ould

make the same change to the DOWN param eter for service comp onent status.

Otherwise, if you specific d ifferent colors, one color change over rides th e other.

After you m ake changes, save the color.properties file, and r estart IAS.

Defining standalone, primary, and secondary BMC ImpactAdministration servers

By defau lt the IAS is configured to work in stand alone mod e. However, after

installation, you can choose to implemen t an HA configu ration, in wh ich d efine an

HA pair of primary and second ary servers to hand le failover situations.

You mu st first install another BMC Imp act Adm inistration server on a second system.Rerun the installation, and m ake the app rop riate Stand ard or Master IAS selection for

the second system . Assign a u niqu e nam e to each instance of IAS that you install.

NOTE

These changes to the color properties do not affect the icon colors.

NOTE

At installation, you can choose to install and imp lement a high availability (HA) configuration

for the IAS. If you select to d efine an HA setup for the Master IAS, the accompan ying IAC is

also defined as HA autom atically.

NOTE

If you d efine a stand alone Master IAS as an HA pair, you m ust also d efine its accompan ying

IAC as an H A pair.



Defining standalone, primary, and secondary BMC Impact Administration servers


When you define p rimary an d second ary servers, you also define the synchronization

proper ties for both. The synchronization p rocess upd ates IAS records an d files, such

as th e following files:


s group_roles.xmls role_permissions.xml

s cmdb.properties

s cell_info.list

During synchronization of H A pairs, data is carried from the p rimary to thesecond ary IAS and from the second ary to the pr imary. Each server of an H A pair has

its own ias.proper ties and logging configu ration files. These files are not

synchronized.

IAS synchronization properties

You can d efine you r IAS synchron ization prop erties by mod ifying the following

proper ties in its correspon ding ias.proper ties file.

NOTE

To enable synchronization between servers, they m ust be installed on the sam e platform:

either a ll on MS Window s or a ll on the sam e UN IX operating system (for example, Solaris to

Solaris, Linux to Linu x).

Table 20 IAS synchronization properties (part 1 of 2)


com.bmc.sms.ixs .t ransact ion.his tory for HA definit ions. The number of days tha t entr ies in the

transaction log are kept before they are rem oved by

synchronization. The d efault is 5 days.

com.bmc.sms.configService.keepBackup File for stand alone and HA definitions. Indicates wh ether the IAS

maintains a backup copy (.bak extension) when it w rites a file.

The default is false.

com .bm c.sm s.ixs.syn c.in terval for HA defin ition s. In terval in min utes betw een

synchronization requests from a secondary server to aprim ary server. The default is 15 minu tes.

com .bm c.sm s.ixs.p rim ary.server for H A d efin ition s. Th e h ost nam e or IP ad d ress of th e

primary server along w ith its default port num ber in the

following format: host:port.

You define the pr imary server in the ias.prop erties file of the

paired secondary server.



Defining standalone, primary, and secondary BMC Impact Administration servers


iadmin reinit/sync optionsYou can u se the following iadm in reinit/ sync options to restart a server, copy th e

pr imary server’s configura tion to its second ary server , or start a synchron ization

between the tw o servers immed iately.

From the / bin subd irectory of your IMPACT_SOLUTIONS_HOME / server directory,you can

s execute the iadm in -reinit comm and on the p rimary or second ary server to restart

the server w ith the latest configuration data

You usu ally execute th e iadmin -reinit comman d on the p rimary server after youhave manua lly ed ited any of its files.

s execu te the iadmin -reinit fullsync comm and on the second ary server on ly to copy

the p rimary server’s configuration to it and to restart it with the n ew configuration

You should execute the iadm in -reinit fullsync comm and on th e second ary server

the first time you start it after you have installed it.

s execute the iadmin -sync comm and on the secondary server to start thesynchronization process immediately instead of waiting until the next

synchronization interval

Use the iadm in -reinit and iadmin -reinit fullsync comm and s to restart the respectiveserver anytime you have m anu ally edited one or m ore of the pr imary server’s

configu ration files.

com .bm c.sm s.ixs.backu p .server for H A d efin ition s. Th e h ost n am e or IP ad d ress of th e

second ary server along with its default port nu mber in the

following format: host:port.

You define the secondary server in th e ias.prop erties file of

the p rimary IAS server.

com .bm c.sm s.ixs.serv er .m od e th e serv er role. O ption s are stan dalon e (d efau lt), p rim ary, an d

backup.

If you specify primary or backup , then of course youmu st comp lete the primary an d backup server entries inthe resp ective ias.proper ties files of the two servers.

Table 20 IAS synchronization properties (part 2 of 2)




Defining an HA configuration for the Impact Administration cell


Your typ ical use case wou ld look as follows:

1. Manu ally edit the configuration files on the primary server.

2. Execute the iadmin -reinit command on the p rimary server.

3. Execute the iadmin -reinit fullsync comm and on the seconda ry server.

(BMC recomm end s that you u se the iadmin CLI to edit files whenever possible,

thereby eliminating the need to restart the server.)

Defining an HA configuration for the Impact Administrationcell

As a general p ractice, you configure the IAC as an H A p air wh enever you configurethe Master IAS as an HA pair. Use this table as a guideline for changing the resp ective

mcell.dir files of the primary IAC on one host system and the secondary IAC on the

second host system:

Remember th at the primary IAC resides on the same host as the primary Master IAS

and the second ary IAC resides on the same host as the secondary M aster IAS.

After you d efine the entries in the mcell.d ir files, you mu st mod ify the respective

mcell.conf files as you w ould any n orm al cell that you are configuring for h ighavailability. Refer to “Configur ing high availability cells” on page 50 for more

information.

Transaction and trace logs

The IAS autom atically generates the log files listed in Table 22 on page 113.

Table 21 mcell.dir entries for HA pair of Impact Administration cells

Primary IAC on Host 1 Secondary IAC on Host 2

cell Ad min mc host1:1827 host2:1827

cell IAC mc host1:1827 host2:1827

cell Ad min mc host2:1827 host1:1827

cell IAC mc host2:1827 host1:1827



Transaction and trace logs


You can edit th e proper ties of the d iagnostic trace log ias0.log in theserver_logging.prop erties file.

Example trace output

An example trace excerpt, show ing INFO level messages, is show n below:

Table 22 IAS log files

File name Description

transaction.log stored under IMPACT_SOLUTIO NS_HO ME /server/log /ias .

Records transactions for file synchronization

record _transaction.log stored under IMPACT_SOLUTIO NS_HO ME /server/log /ias .Records transactions for record syn chronization

ias0.log stored under

IMPACT_SOLUTIO NS_HO ME /server/tmp/ias . This is th e

diagnostic trace log. They are nu mbered incrementally. A

new log file is created w henever IAS restarts or w hen th e

current log file reaches its specified m aximum size.

When th e maximum log file coun t is reached, then the

pr ocess repea ts itself because on ly one cycle of logs is

maintained.

The new log file is always named ias0.log. The logger

renames the existing log files in ascending chronological

ord er. So the ear liest log file is ias1. log and the old est log file

in the cycle has the greatest num ber.

INFO: Sending to primary server: <SyncReqRecordLog> <ETX>

Jul 4, 2007 2:20:42 AM com.bmc.sms.ixscomm.server.CommandParser setTokenizer

INFO: successfully retrieved file

C:\work\SIM\dev\sms\main\java\ixs\server2\data\cell_info.list

Jul 4, 2007 2:20:42 AM

com.bmc.sms.ixscomm.configservice.manager.PlainFileManager setFile

INFO: successfully saved file

C:\work\SIM\dev\sms\main\java\ixs\server2\data\cell_info.list

Jul 4, 2007 2:20:42 AM com.bmc.sms.ixscomm.configservice.manager.IMInfoManager

addCell



Configuring Lightweight Directory Access Protocol for BMC Impact Administration server


However, you can enable Telnet and ftp. You w ill need to start th e Telnet service on

the Wind ows system. You also need to mod ify the centraladm in-strings.properties

file located u nd er the IMPACT_SOLUTIO NS_HO ME/ server/conf/resources path.

The relevant section of the centraladmin-strings.prop erties file is depicted below:

To enable Telnet and ftp, mod ify the p rop erties as follow s:

Restart the BMC Imp act Adm inistration server to initialize your changes.

Configuring Lightweight Directory Access Protocol for BMCImpact Administration server

Use Lightw eight Directory Access Protocol (LDAP) authen tication in a p rod uction

environ men t. In this way, you can link you r BMC Impact Adm inistration server (IAS)authen tication w ith your corporate infrastructure for user authen tication an d

author ization m anagement. Using LDAP auth entication allows you to u se the sameuser d efinitions across multiple BMC product lines. After you d efine you r LDAP user

and user group s, you can map your LDAP user groups to IAS user group s. Any u sers

you ad d to a LDAP user group share the perm issions of the IAS user grou p to w hich

you have mapp ed.

You can u se a single sign-on to access multiple produ cts. You d o not have to create a

separate user definition an d sign-on information for each p rodu ct.

To enable LDAP au thent ication for the IAS on a Wind ows system, your login account

mu st have ad ministrator privileges on the target system. On a UN IX system, you

mu st be logged in as root or un der a u ser accoun t with w rite and execute permissionon the IMPACT_SOLUTION S_HOM E / server directory.

unix.execute.command=com.bmc.sms.marimba_cas_tools.SSHTask

unix.putfile=com.bmc.sms.marimba_cas_tools.SCPTask

unix.getfile=com.bmc.sms.marimba_cas_tools.SCPTask

NOTE

Make sure th at you are familiar w ith security p rotocols before modifying these settings.

unix.execute.command=com.bmc.sms.marimba_cas_tools.SSHTask,com.bmc.sms.marimba_cas_tools.TelnetTaskunix.putfile=com.bmc.sms.marimba_cas_tools.SCPTask,com.bmc.sms.marimba_cas_tools.FTPTaskunix.getfile=com.bmc.sms.marimba_cas_tools.SCPTask,com.bmc.sms.marimba_cas_tools.FTPTask





Set up your LDAP server according to your LDAP server p rocedu res. Next, enable

the LDAP login en try in the ias.proper ties file. Then you can your LDAP

configu ration information for each LDAP server that you ’re enabling.

To enable the LDAP login entry in the ias.properties file

1 In an editor, open the IMPACT_SOLUTIONS_HOME/ server/conf/ias.properties

file, where IMPACT_SOLU TIONS_HOM E/ server is the installation d irectory of your server . Locate the com.bmc.sms.ixs.enable.ldap .login param eter, and set it

equal to “true”:

2 Save an d close the ias.proper ties file.

3 Restart IAS.

4 In an editor, open the IMPACT_SOLUTIONS_HOME / server/conf/jaas.conf file. Do

not m odify this file. Verify tha t it contains an en try su ch as the following:

5 Close the file.

To add LDAP configuration information

You are now ready to ad d your LDAP configuration information to the

IMPACT_SOLUTION S_HOM E / server/conf/ldap_configuration.xml file. Figure 11

on page 117 depicts a sample ldap_configura tion.xml file with a sing le LDAP serverconfiguration:

NOTE

If you ar e using a solution that requires the BMC Portal and/ or BMC Atrium CMDB, you m ay

need to set u p LDAP au thentication on the BMC Portal server and on the AR System server.

Refer to the BMC Portal Getting S tarted guid e for information on setting up LDAP

auth entication on the BMC Portal server. Refer to th e BMC Remedy A ction Request Sy stem 7.1

Integration with Plug-ins and Third-Party Products for information on setting u p LDAP

auth entication on the AR System server.

#-----------------------------------------------------------------

# Enable/disable LDAP login module.

# When it is enabled, "ldap_definition.xml" file has to be filled.

#-----------------------------------------------------------------

com.bmc.sms.ixs.enable.ldap.login=true

com.bmc.sms.ixscomm.authentication.ldap.LdapLoginModule Sufficient;





Figure 11 Excerpt from ldap_configuration.xml file

1 Make only one <ldap ></ ldap> entry for each LDAP server you are using. You can

specify an alias for the LDAP nam e.

2 Using Table 23 on page 117 as a guid e, comp lete the LDAP configura tion

parameters.

<?xml version="1.0" encoding="UTF-8"?><ldapList xmlns="urn:bmc:schemas:impact"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="urn:bmc:schemas:impact ldap_definitions.xsd">

<ldap alias="test">

<host>majestix.bmc.com</host>

<port>389</port>

<version>3</version>

<baseDN>DC=pinfrastruct,DC=rd,DC=bmc,DC=com</baseDN>

<connectionUserName>[email protected]</connectionUserName>

<useridAttribute>sAMAccountName</useridAttribute>

<useSSL>false</useSSL>

<memberOfAttribute>memberOf</memberOfAttribute>

<userSearchFilter>(objectClass=organizationalPerson)</userSearchFilter>

<groupSearchFilter/>

<connectionPassword encrypted="true">fisSCap4ZhOLOUENWPLe==</connectionPassword>

</ldap>

......

</ldapList>

Table 23 LDAP configuration parameters (part 1 of 2)

LDAP parameter Description

host the fully qualified host name where LDAP is installed . You

shou ld be able to verify the connection betw een the LDAP

server and the IAS using the ping comman d.

port port number by which to connect to the LDAP server.

Normally the n onsecure p ort n um ber is 389. The secure (SSL)

port n um ber is 636.

version LDAP version number. The most recent version is version 3.

baseDN top-level d irectory of the LDAP structure. This is the base

Fully Qu alified Distinguished Nam e (FQDN ) from w hich all

user and group queries occur. The Distinguished Nam e

represents an object and th e path to the object in the directoryhierarchical nam espace. Objects are ord ered from most to

least specific.

connect ionUserName log in Id that the p rograms use to connect to the LDAP server

u serId Attribu te attribu te in the u ser entry that contains the login Id

useSSL ind icates whether LDAP authentication is using OpenSSL

m em ber OfAttr ibu te attr ibu te in th e u ser en try th at sp ecifies wh eth er th e u ser

belongs to certain u ser group s





3 After comp leting you r changes, restart the IAS.

s On MS Wind ows, restart the IAS service throu gh the Services window.

s On UN IX, execute the ru n_IAS script from the ap propr iate path. (The defau lt

path is / opt/bmc/Impact/server/bin .) You m ust be logged on as root or as theuser w ith the app ropr iate perm issions to start and stop the script.

The IAS connects to the LDAP servers one at a time in su ccession. When it find s a

user ’s matching login creden tials, the IAS retu rns th e match. It does not attemp t to

connect to other LDAP servers that might be defined in the ldap _configuration.xml

file.

Next, after you ad d you r LDAP server or servers, you can add a user group andassign it a user role.

To add a new user group with mapping roles

u serSearch Filter search filter that th e LDAP serv er u ses to look u p a u ser

entry. If left blank, this p arameter d efaults to the following

filter:

“(|(objectClass=person)(objectClass=user)

(objectClass=inetOrgPerson)(objectClass=

organizationalPerson))”

grou p Search Filter search filter th at th e LDAP serv er u ses to look u p a u ser

grou p en try. If left blank, this param eter defaults to the

following filter:

“(|(objectClass=group)(objectClass=

groupOfUniqueNames)(objectClass=groupOfNames)

(objectClass=groupOfUrls))”

con nectio nPasswor d au th en tication p asswor d (en cr yp ted ) th at is u sed t o co nn ectto the LDAP server

Note: Set the encrypted attribu te equal to false and th en

enter the passw ord in plain text. When IAS restarts, it

encrypts the password an d changes the encryptedattribu te value from false to tru e.

NOTE

If you’re adding a n ew role to the group , you mu st first create the role and ad d p ermissions to

it using the iadm in -ar option before you create the group . See “To add a new role/ mapping

permission” on page 101.

Table 23 LDAP configuration parameters (part 2 of 2)

LDAP parameter Description





From the/ bin subd irectory of your IMPACT_SOLU TIONS_HOME / server directory,

execute the iadmin comm and using the -ag option, as in th e following example:

The new en try w ould look similar to the following in the grou p_roles.xml file:

To add the user group name to the cell’s KB definition files

You add the u ser group nam e to the collector d efinition an d operation d efinition files

in the connected cell or cells.

1 Add the u ser grou p n ame to each of the following collector d efinition files. Whereind icated , associate the read , write, and execute perm issions (r, w, x) w ith the

group nam e entry:

s biip4p_collectors.mrl

s catchall_collector.mrl

s mc_bylocation_collectors.mrl

s mc_bystatus_collectors.mrl

s mc_evr_collectors.mrl

s mc_sm_collectors.mrl

s mcxpcoll.mrl

s self_collector.mrl

You m ay need to change th e file perm issions on these files before editing them .

Code examples follow that show sample mod ifications to each file:

biip4p_collectors.mrl

iadmin -ag group=”NewGroup” :roles=”Role”

<entry key="nameofUserGroup">IAS_defaultRoleName</entry>

collector PATROL :

{

r['Service Administrators','Service Operators -Senior','Service Operators','Service Managers - Senior','ServiceManagers',’nameofUserGroup’]

w['Service Administrators','Service Operators -Senior','Service Operators','Service Managers - Senior','ServiceManagers',’nameofUserGroup’]

x['Service Administrators','Service Operators -Senior','Service Operators','Service Managers - Senior','ServiceManagers',’nameofUserGroup’]

}

END





catchall_collector.mrl

mc_bylocation_collectors.mrl

mc_bystatus_collectors.mrl

collector 'All Events' :

{

r['Service Administrators',’nameofUserGroup’]

w['Service Administrators',’nameofUserGroup’]x['Service Administrators',’nameofUserGroup’]

}

collector 'By Location':

{


w['Service Administrators',’nameofUserGroup’]

x['Service Administrators',’nameofUserGroup’]

}END

...............

collector 'By Location'.*:

{

r['Service Administrators','Service Operators -Senior','Service Operators','Service Managers - Senior','ServiceManagers',’nameofUserGroup’]

w['Service Administrators','Service Operators -Senior','Service Operators','Service Managers - Senior','ServiceManagers',’nameofUserGroup’]

x['Service Administrators','Service Operators -

Senior','Service Operators','Service Managers - Senior','ServiceManagers',’nameofUserGroup’]

}:

collector 'By Status':

{

r['Service Administrators','Service Operators -Senior',’nameofUserGroup’]

w['Service Administrators','Service Operators -

Senior',’nameofUserGroup’]x['Service Administrators','Service Operators -Senior',’nameofUserGroup’]

}

END





mc_evr_collectors.mrl

You can ad d a user grou p to this .mrl file, but be sure not to edit any other p arameter

or value.

mc_sm_collectors.mrl

You can ad d a user grou p to this .mrl file, but be sure not to edit any other p arameter

or value.

collector MC_Related_Events:

{


w['Service Administrators',’nameofUserGroup’]x['Service Administrators',’nameofUserGroup’]

}

END

collector MC_Related_Events.*:

{


w['Service Administrators',’nameofUserGroup’]

x['Service Administrators',’nameofUserGroup’]

}:

EVENT

where [mc_relation_source: != '']

create $THIS.CLASSEND

collector MC_SMC_Events:

{

r['Full Access', 'Service Administrators'’nameofUserGroup’]w['Full Access', 'Service Administrators'’nameofUserGroup’]

x['Full Access', 'Service Administrators'’nameofUserGroup’]

}

END

collector MC_SMC_Events.*:

EVENT

where [$THIS.mc_smc_id != ""]

create cond($THIS.mc_smc_type == '', "Unknown", $THIS.mc_smc_type)

END

collector MC_SMC_Events.*.Impacts:

EVENTwhere [$THIS.mc_smc_impact == 1]

END

collector MC_SMC_Events.*.History:

SMC_STATE_CHANGE

END





mcxpcoll.mrl

self_collector.mrl

2 Next, assign the group nam e to the app ropriate event management op erations inthe im_opera tions.mrl file. Each event operation can be perform ed by a pr edefined

set of group s, as show n in Table 24.

collector 'By Location'.*.*.*.*.*:

PATROL_EV where [p_application: not_equals '']

create $THIS.p_application

END

{

r[‘nameofUserGroup’]

w[‘nameofUserGroup’]

x[‘nameofUserGroup’]

}

collector self :

{ r['Full Access', 'Read Only',‘nameofUserGroup’]

w['Full Access', ‘nameofUserGroup’]

x['Full Access', ‘nameofUserGroup’]

}

END

Table 24 Event operationsEvent operation Group names

Acknow led ge Service Ad ministrators, Service Op erators - Senior, Service

Operators

Take Ow nersh ip Service Ad m in istrators, Service O perators - Sen ior, Service

Operators

Decline Ownersh ip Service Administ rator s, Service Operators - Sen ior , Service

Operators

Close Service Administrators, Service Operators - Senior, Service

Operators

Assig n to Op er ation Ser vice Ad m in istr ator s, Ser vice Op erator s - Sen iorSet Priority Service Administrators, Service Operators - Senior

Reopen Service Administrators, Service Operators - Senior




C h a p t e r 44Managing the BMC Impact Portal

This chap ter describes how to configure the BMC Imp act Portal and contains the

following topics:

Accessing th e BMC Impact Portal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

Start ing and stopping the BMC Por tal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

Star ting and stop ping th e BMC Porta l on Windows . . . . . . . . . . . . . . . . . . . . . . . 127Star ting and stop ping th e BMC Porta l on UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . 127

Configuration tasks for BMC Im pact Portal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128Registering p rod uction an d test cells in the BMC Impact Portal . . . . . . . . . . . . . 128

Custom izing BMC Impact Portal configu rat ion . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

Configur ing Dashboard Table View column s. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128Con figuring Events Table colu mns. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

Changing the Console Navigation Tree icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

Con figurin g Status Table columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130Configur ing object link synchron ization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

Con figurin g reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

Configur ing th e nu mber of even ts d isplayed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134Chan ging the m aximum n um ber of recent items d isplayed . . . . . . . . . . . . . . . . 134

Configur ing th e general p rop erties d isplayed . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135

Setting up Image Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

Mod ifying connection set tings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

Configura tion file and pa ram eter d efinitions for BMC Imp act Portal . . . . . . . . . . . . 137

smsIw c/ app lication.prop erties file and par ameters . . . . . . . . . . . . . . . . . . . . . . . 137

smsCon soleServer/ application.properties file and pa ram eters . . . . . . . . . . . . . . 138

ixs.pr operties file and param eters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141



Accessing the BMC Impact Portal


Accessing the BMC Impact Portal

Commu nication betw een the Web brow ser and the BMC Portal is encrypted an d

requires the use of the https:// communication protocol.

To access the BMC Portal

1 In the brow ser’s ad dress box, type the BMC Portal URL add ress using the

following syn tax:

https:// computerName: portNumber

s computerName—represen ts the host nam e of the BMC Portal server

s

portNumber —represents the port n um ber assigned to the BMC Portal; thedefault port n um ber is 443

2 In the security alert w indow, click Yes to accept the security certificate.

3 In the logon screen, type your logon u ser name an d you r p assword , and then click

Log O n.

If you receive the m essage user name and password invalid after entering a

valid u ser name and passw ord, the BMC Portal server might not be run ning. Start

the BMC Portal and log on to it again.

Starting and stopping the BMC Portal

The installation p rocess does not au tomatically start the BMC Portal service. The

following top ics describe how to start an d stop the BMC Portal service on both

Window s and UN IX.

NOTE

The Transport Layer Secur ity (TLS) protocol is u sed to secure commu nication betw een the

BMC Porta l App lication Server and th e Web browser.

WARNING

If you leave your BMC Portal session by selecting a d ifferent URL and then r eturn to the

session before the expiration of the timeout period, the BMC Portal fails to promp t you for

your u ser name an d p assword . To ensure the integrity of the session, log out of the session

every time you leave your BMC Portal session.



Starting and stopping the BMC Portal on Windows


Starting and stopping the BMC Portal on Windows

You can star t and stop the BMC Portal by using either of the following m ethod s:

s

using the Services windows using the net start an d net stop commands

To start or stop the BMC Portal from the Services window

1 Open the Services wind ow.

2 From the scroll list, select BMC Por tal.

3 To start the service, click Start Service.

4 To stop the serv ice, click Stop Service.

To start or stop the BMC Portal from the command line

From a comm and prom pt, use the following method s to start and stop th e BMC

Portal:

s To start the BMC Portal, enter the following comm and :

net s tart “BMC Por tal”

s To stop th e BMC Portal, enter the following comm and :

net stop “BMC Por tal”

Starting and stopping the BMC Portal on UNIX

The BMC Portal starts and stops as a d aemon on UN IX platforms.

To start or stop the BMC Portal daemon on UNIX

To start or stop the BMC Portal on Solaris, use the BMCPortalAppserver script in th e

/etc/in it.d directory and enter one of the following comm and s:

s ./BMCPortalAppserver stop

s ./BMCPortalAppserver start



Configuring Events Table columns


3 Save th e application.properties file.

4 Restart the BMC Portal serv ice.

Configuring Events Table columns

You can edit the colum ns that app ear in the table in the Events tab by ed iting the

..\ smsIwc\ application.properties file. All colum ns in the even ts table are configura ble.

To configure Events Table columns

1 Open the application.properties file in a text ed itor. This file is located a t

installationDirectory \ to ol s\ jboss \ s erver\ all \ conf\ properties\ smsIw c\ .

2 Edit the appr opriate events table colum n as show n in Table 25 on page 129.


4 Restart the BMC Portal serv ice.

WARNING

To preserve the .properties suffix, save as typ e All Files. Do not save the

application.properties file as a .txt file. The configuration chan ges may not b e recognized.

Table 25 Event Table column default values

Column heading Descriptionstatus event status of the selected component

mc_priority value of the possible priorities of the event (values 5, 4, 3, 2, or 1)

sever ity value of the possib le sever it ies of the even t (unknown, ok, in fo, warn ing,

minor, major, or critical)

date_reception date and time the event was received

owner_name name of the owner of the component

msg relevant information related to the event

mc_smc_id the ident ifier for this service model component

WARNING

To preserve the .properties suffix, save as typ e All Files. Do not save the

application.properties file as a .txt file. The configuration chan ges may not b e recognized.



Changing the Console Navigation Tree icons


For more information on this file, see “smsIwc/ app lication.prop erties file and

parameters” on page 137.

Changing the Console Navigation Tree iconsYou can change the d efault icons d isplayed in th e navigation tree for Recent Items by

editing th e ..\ smsIwc\ application.properties file.

To Change the Navigation Tree Icons

1 Open the application.properties file in a text ed itor. This file is located at

installationDirectory \ too ls \ jboss\ server\ all \ co nf\ properties \ smsIwc\ .

2 To chan ge the navigation tree icons, add th e relative pa th to the new icon tocom.bmc.sms.iwc.domain.recentitem.RecentItemsFolderIcon .

3 Save the application.properties file.

4 Restart the BMC Por tal service.

For more information on this file, see “smsIwc/ app lication.prop erties file and

parameters” on page 137

Configuring Status Table columns

You can ed it some of the colum ns in the tab les in the Status tab by editing the

..\ smsIwc\ application.properties file. How ever, not all colum ns ar e configu rable. The

first three columns (status, type, and name) cann ot be chan ged . A smaller version of

each p rimary status table is displayed in the d ashboard view , if the Status window is

selected for one or more of the d ashboard pan es. By d efault, no colum ns beside the

status, type, and name are configu red for these smaller tables, but colum ns can be

added in the application.properties file.

WARNING

To preserve the .properties suffix, save as ty pe “All Files.” Do not save th e

application.properties file as a .txt file. The configuration chan ges m ay n ot be recognized.



Configuring reports


To configure object link synchronization


installationDirectory \ too ls \ jboss\ server\ all \ co nf\ properties \ smsIwc\ .

2 To chan ge the object link type, mod ify the com.bmc.sms.iwc.objectlinksync.types entry.

3 To chan ge the reconciliation link typ e, mod ify the

com.bmc.sms.iwc.reconciliation.type entry.



For more information, see “smsIwc/ app lication.properties file and p aram eters” on

page 137.

Configuring reports

You can configure the follow ing items for repor ts by editing th e

..\ smsConsoleServer\ application.properties file:

s scheduling

s value of report goal lines

s length of time rep ort data is retained

s length of time event da ta is retained

To configure reports


installationDirectory \ too ls \ jboss \ server\ all \ co nf\ properties \ smsConsoleServer\ .

2 Edit the appropriate status table column a s shown in Table 27 on page 133.

WARNING





Configuring reports



Table 27 Report parameters

Parameter type Parameter Description

Report Schedule com.bmc.sms.reportSum marizer.schedu ler.

frequencyHours

The frequen cy, in hou rs, that the report

information is sum marized. Default value

is 1.com.bmc.sms.reportSummarizer.scheduler.

delaySeconds

The num ber of second s that will be add ed

to the starting hou r for every sched uled

sum mar ization time. Default value is 30.

com.bmc.sms.reportSummarizer.scheduler.is

StartingNextHour

Determines wheth er or not the setting of

startingHou r w ill be ignored . If set to true,

startingHou r w ill be ignored . Default value

is true.

com.bmc.sms.reportSummarizer.scheduler.

startingHour

Determines the desired starting hou r. No

sum mar ization is made u ntil this value is

reached. If the startingHou r has passed o n

that da y, the sum marization will start atthat hou r the next d ay. Default value is 0.

Report Goals com.bmc.sms.reportSummarizer.goal.default

.SMS_CS_RT_AVAIL

Availability repor t goal line, expressed as a

percentage. Default value is 90.0%.

com.bmc.sms.reportSummarizer.goal.default

.SMS_CS_RT_MTTR

Mean Time to Repair goal line, expressed in

millisecond s. Default v alue is 300000 (5

minutes).


.SMS_CS_RT_MTBF

Mean Time Between Service Failur es goal

line, expressed in milliseconds. Default

value is 172800000 (2 days).


.SMS_CS_RT_MTBSI

Mean Time Between Service Incidents goal

line, expressed in milliseconds. Defaultvalue is 172800000 (2 days).

Retention Age com.bmc.sms.consoleserver.retention.policy.

age.SMS_CS_STATUS_EVENT

The num ber of days Status tab d ata will be

retained . Defau lt value is 395.

com.bmc.sms.consoleserver.retention.policy.

age.SMS_CS_RT_AVAIL

The num ber of days Ava ilability data w ill

be retained . Defau lt value is 395.


age.SMS_CS_RT_MTTR

The num ber of days Ava ilability data w ill

be retained . Defau lt value is 395.


age.SMS_CS_RT_MTBF

The num ber of days Mean Time Between

Failure d ata w ill be retained. Default value

is 395.


age.SMS_CS_RT_MTBSI

The num ber of days Mean Time Between

Service Inciden ts d ata w ill be retained .

Default value is 395.


age.EG_EVENT

The num ber of day s event data will be

retained in the BMC Datastore. Default

value is 395.



Configuring the number of events displayed



For more information, see “smsIwc/ app lication.properties file and p aram eters” on

page 137.

Configuring the number of events displayed

You can set the maximu m an d m inimu m n um ber of events displayed in the Events

tab by editing the ..\ smsIwc\ application.properties file.

To configure the number of events displayed


installationDirectory \ to ols\ jboss \ s erver\ all \ conf\ properties\ smsIw c\ .

2 To change the m inimum nu mber of events shown on the Events table, edit the

value for com.bmc.sms.iwc.event.table.minimumevents. The d efault value is 5.

3 To change th e maximum nu mber of events shown on the Events table, edit thevalue for com.bmc.sms.iwc.event.table.maximumevents. The d efault value is 50.



For more information, see “smsIwc/ app lication.properties file and p aram eters” onpage 137.

Changing the maximum number of recent items displayed

You can change the m aximu m nu mber of objects d isplayed in the Recent Items grou p

in the navigation tree by editing the ..\ smsIwc\ application.properties file.

WARNING



WARNING





Configuration file and parameter definitions for BMC Impact Portal


3 Modify the connection properties.


5 Restart the BMC Portal serv ice (or d aemon) to initialize the file.

The BMC Imp act Portal settings are reset.

Configuration file and parameter definitionsfor BMC Impact Portal

Norm ally, you make changes to BMC Imp act Portal comp onent configurations

through the user interface. However, you can m anu ally edit three sets of configu ration files that contain configuration inform ation for the BMC Imp act Portalmod ule. These files per tain to these comp onents:


s BMC Im pact Service Model Editor

s BMC Impact Publishing Server

smsIwc/application.properties file and parametersTable 28 describes the application.properties file in the smsIwc folder and its

parameters.

Table 28 application.properties file

Filename application.properties in the ..smsIwc folder

File path BMC_PORTA L_KIT_HOM E /appserver/w ebskd/tool s/jboss /server/all/co nf/properties/smsIw c

Descriptioncontains the general BMC Imp act Portal configurations for comp onent p roperties and user

interface presentation

Parameter name Description Default value

com.bmc.sms.iwc.ui.

recentitems.maxsize

sets the maximum nu mber of objects that can display

in the Recent Items group folder in th e navigation tree

of the BMC Imp act Portal

Refer to “Changing the maximum num ber of recent

items displayed” on p age 134 for more information.

5



smsConsoleServer/application.properties file and parameters



Table 29 describes the application.properties file in th e smsConsoleServerfolder and its

parameters.

com.bmc.sms.iwc.status.

table

sets the column s that w ill display in the status and

dashboard table views

Refer to “Configuring Dash board Table View

columns” on page 128 for more information.

See the

application.

properties file.

com.bmc.sms.iwc.component.

properties.generalProperties.

properties

determ ines which general properties are displayed in

th e Configure tab for selected compon ents

Refer to “Configuring the general prop erties

displayed” on page 135 for more information.

See the

application.

properties file for

more information.

com.bmc.sms.iwc.event.table determ ines which colum ns in the events table are

visible in th e BMC Imp act Portal modu le

Refer to “Configuring Events Table column s” on

page 129 for more information.

See the

application.

properties file.

com.bmc.sms.iwc.domain.notification.impact.type

sets the imp act definitions includ ed in a comp onentnotification e-mail

You can d esignate m ultiple types of imp act

definitions, separating each by a comm a. If no im pact

typ e is set exp licitly, the d efault is BMC_BaseElement.

BMC_BaseElement

com.bmc.sms.iwc.domain.

recentitem.RecentItemsFolderIcon

specifies the default icon for the Recent Items folder ServiceComponent

.gif


table.providers


table.consumerscom.bmc.sms.iwc.status.

table.causes


table.existinggroup


table.causal.components


table.components.small

determines which colum ns that you can add to the

tables and dashboards u nder the Status tab in the

BMC Impact Portal mod ule

Refer to “Configuring Status Table column s” on


See the

application.

properties file.

com.bmc.sms.iwc.event.

table.minimumevents

com.bmc.sms.iwc.event.

table.maximumevents

sets the maximu m and minimum nu mber of events

retrieved per comp onent instan ce; this information is

displayed on the Events tab

minimum : 5

maximu m: 50







Filename application.properties in the ..smsConsoleServer folder

File path BMC_PORTA L_KIT_HOM E /appse rver/webskd/to ol s/jboss /server/all/conf/properties/sms

ConsoleServer

Description contains the configurations for report schedu ling, report go als, and report d ata retentionParameter name Description Default value

com.bmc.sms.configService.

dataLocation

defines where the user configura tion data is stored no value; the

location

BOSS_HOME /s

erver/all/data/s

msConsoleServ

er is used

com.bmc.sms.configService.

keepBackupFile

if configuration d ata is chang ed, defines whether a

backu p file is saved

false; no backup

file is sav ed

com.bmc.sms.reportSummarizer.goa

l.default.

SMS_CS_RT_AVAIL

sets the value of the goal line for the Availability report

as a percentage

90.000%


l.default.

SMS_CS_RT_MTTR

sets the valu e of the goal line for the Mean Time to

Repair (MTTR) repor t

300000

milliseconds

(5 minu tes)


l.default.

SMS_CS_RT_MTBF

sets the value of the goal line for the Mean Time Before

Failure (MTBF) report

172800000

milliseconds

(2 da ys)


l.default.

SMS_CS_RT_MTBSI=172800000

sets the value of the goal line for the Mean Time Before

Service Imp act (MTBSI) repor t. Goal line valu e is

expressed in millisecond s.

172800000

milliseconds

(2 da ys)

cellName.timeout sets the timeout valu e for data qu eries by the BMC

Imp act Portal to the sp ecified cell

The timeou t value is measured in second s.

30 second s

cellName.reconnect_attempts sets the nu mb er of times for the BMC Imp act Portal to

try to reconnect to the specified cell wh en it is

un available cell (such a s the cell or host is d own )

60 tries

cellName.reconnect_frequency sets the polling cycle, measured in seconds , for the BMC

Impa ct Portal reconnection attemp t to the sp ecified cell

30 second s

cellName.polling_frequency sets the polling cycle, measured in seconds , for the BMC

Impa ct Portal data q uery attem pt to th e specified cell

1800 second s

<cellname>.encryption sets wh ether is encryption is enabled (off or on) for the

connection with the specified cell

on

com.bmc.sms.icon.webdir defines the path in w hich the icon images for service

model components are maintained

/smsConso leSer

ver/images/obje

cts/

com.bmc.sms.event.

maxDelayedHours

defines the maximum num ber of hours an event can be

delayed and will still be processed.

24 hou rs





Table 30 describes the aggregator.properties file and its param eters.

com.bmc.sms.consoleserver.

retention.policy.age.

SMS_CS_STATUS_EVENT

com.bmc.sms.consoleserver.retention.policy.age.

SMS_CS_RT_AVAIL



SMS_CS_RT_MTTR



SMS_CS_RT_MTBF

com.bmc.sms.consoleserver.retention.policy.age.

SMS_CS_RT_MTBSI



EG_EVENT

sets the length of time, in days, that rep ort d ata is

retained for each repor t and that event d ata is retained

in the BMC Datastore.

395 days

com.bmc.sms.service.os.

unrestricted

sets whether the O bject Store commu nication service

should ru n in u nrestricted m ode w hen connecting to

the Remed y server

true


restrict.read.access


filters are read -only objects

true


filtersim


filters classes and attributes tha t are marked SIM=false

true

com.bmc.sms.remedy.

serverHostName

identifies the host compu ter on w hich the BMC Portal

host resides

BMC Porta l host

comp uter name

com.bmc.sms.remedy.

serverPortNumber

lists the port nu mber by which the BMC Portal connects

to the Remedy server

0

Table 30 aggregator.properties fileFilename aggregator.properties

File path BMC_PORTA L_KIT_HOM E /appserver/w ebskd/to ol s/jboss /server/all/conf/properties/sms

ConsoleServer

Descriptioncontains the configu rations for BMC Imp act Portal comm un ications w ith cells, includ ing p ort

nu mber u sed for cell commu nications, encrypt ion key, and encryption enablement


com.bmc.sms.

eventaggregator.

jserv erPortNumber

sets the port n um ber through w hich the BMC Imp act

Portal communicates with the BMC IM cell

3783




ixs.properties file and parameters


ixs.properties file and parameters

Table 31 describes the ixs.properties file and its param eters.

com.bmc.sms.eventaggregator.

jserverEn cryptionKey

sets the encryption key used to comm un icate with the

BMC IM cell

mc

com.bmc.sms.eventaggregator.

jserverEn cryptionEnabled

communicat ion encryp tion ind ica to r (t rue or false) true

Table 31 ixs.properties file

Filename ixs.properties

File path BMC_PORTA L_KIT_HOM E /appserver/w ebskd/tool s/jboss /server/all/conf/properties /smsConsoleServer

Description

contains the configurations for BMC Imp act Portal comm un ications w ith the BMC Impact

Explorer console, includ ing the p ort nu mber u sed for BMC Imp act Explorer commu nications

and parameters for building an IP add ress in a mu lti-homed environment.


com.bmc.sms.ixs.port.number sets the port n um ber through wh ich the BMC

Impact Portal comm un icates with th e BMC Impact

Explorer console

3084

com.bmc.sms.ixs.enable.bind.ip sets whether th e BMC Impa ct Portal can bind an IP

add ress on a multi-hom ed (mu lti NIC card) system

false

com.bmc.sms.ixs.bind.ip.address specifies the IP add ress on a mu lti-homed system to

wh ich th e BMC Impact Portal is bound

0.0.0.0

Table 30 aggregator.properties file




C h a p t e r 55Managing the BMC Impact Explorer(BMC IX) console

This chapter describes how to configure BMC Imp act Explorer (BMC IX) console andcontains the following top ics:

Con necting BMC IX to a BMC Impact Portal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

Specific configura tion tasks in BMC IX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

Defining a u ser’s hom e directory on Wind ow s . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

Defin ing property files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

Defin ing console-w ide p olicy files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

Configur ing d isplay and connection settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

Defining global even t sever ity and pr iority color values . . . . . . . . . . . . . . . . . . . 151

Even t grou p configu ration files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

XML files that define u ser in terface elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153



Connecting BMC IX to a BMC Impact Portal


Connecting BMC IX to a BMC Impact Portal

If you h ave mu ltiple BMC Imp act Portals in you r environm ent, you can set u p BMC

IX to connect to each of them .

The following p rocedu re d escribes how to ad d one or m ore BMC Imp act Portals to

the BMC IX console configura tion. You can then select the BMC Impact Portal thatyou w ant to connect to from the Logon d ialog box when you start the console. This

task ap plies to BMC IX as a stan d-alone console or as a Java Web Start ap plication.

To connect to a BMC Impact Portal and make cells available to BMC IX

1 Start th e BMC Imp act Explorer.

2 Define the name and por t of each BMC Imp act Portal to which you w ant BMC IXto connect by following these steps:

A Choose Edit => Configuration.

The Edit Configuration dialog box appears.

B Click the Impact Portals tab.

C In the Host box, enter the nam e of the comp uter h osting th e BMC Imp act Portal.

D In the Port box, enter the p ort nu mber for the BMC Imp act Portal.

E Click Add to includ e the BMC Imp act Portal in the list of servers to w hich you

wan t connect.

F Repeat steps 2C through 2E for each BMC Imp act Portal to w hich you wan t to

connect.

3 Conn ect to the BMC Imp act Explorer as a u ser.

4 Iden tify the cells to make available to BMC Imp act Explorer by following these steps:

A From BMC Impact Explorer , choose Edit => Configuration.

B In the Ed it Configu ration d ialog box, click the Impact Managers tab.

NOTE

Each portal u ses a d ifferent BMC Atrium Configuration Man agement Database (CMDB), so if

you connect to a d ifferent p ortal, you w ill be accessing a d ifferent service mod el and all its

related data. Using a d ifferent BMC Imp act Portal as a backup requires that th e adm inistrator

replicate the entire environm ent and maintain it as a backu p.



Specific configuration tasks in BMC IX


The Available Cells list box lists all cells associated w ith th e BMC Impact Portal

to wh ich you are connected.

C Select a cell from the Available Impact Managers list, and select a group (the

defaults are MyTest or MyProduction).

D Click the arrow to move the cell.

E Click OK. The cell you ad ded app ears in the n avigation p ane of the console.

For complete information abou t configuring BMC IX, see the BMC Impact Solutions:

Event Monitoring user guide.

Specific configuration tasks in BMC IXThis section describes sp ecific configuration tasks for BMC IX.

Defining a user’s home directory on Windows

The first time a u ser open s the BMC Imp act Explorer console interface, a p references

file called mccs.prop is created an d stored in th e user’s hom e directory (represented

here as %HOME%):

%HOME%\ .econsole\ etc\ mccscommunication\ mccs.prop

On compu ters runn ing Window s, ensure the p ath to the user’s home d irectory is in

the user’s profile. You can create a user’s hom e directory anyw here an d it can have

any n ame, as shown in the following examp le.

NOTE

You can select multip le cells at one time. To select ad jacent cells, select the first cell, hold

down the Shift key, an d select th e last cell. To select non ad jacent cells, select a cell, hold

down the Ctrl key, and select each of the oth er cells.

TIP You can also click and dr ag a cell from th e Available Cells list box to the Selected Cells list

box.



Defining property files


Steps for d efining a u ser’s hom e directory d iffer for each Windows version. Forinstructions, consult th e d ocumentation for you r version.

Defining property filesThe BMC Imp act Portal creates a u nique proper ties file username.econ.config in the

jboss \ s erver\ all \ data\ smsCo nsoleServer\ eco nsole directory of the BMC Imp act Portal.

This file is based on th e default.econ.config proper ties file that is created at installation.

Figure 12 illustrates the username.econ.config file.

Figure 13 illustrates a file Operator.econ.config created for a u ser named Operator.

EXAMPLE C:\ username

C:\ Docum ents and Settings\ username

WARNING

If mu ltiple users are working on a single Wind ows comp uter and a separate hom e directory

for each u ser is not defined, each su bsequent u ser overwr ites the p revious u ser’s profile.

Figure 12 default.econ.config file contents

#Mon Jan 20 17:51:13 CDT 2003

toolbar_orientation=0toolbar_layout=North

framework_bounds=444,256,512,384

user.region=US

Figure 13 Operator.econ.config file contents

#Wed Feb 05 11:52:22 CST 2003

user.region=US

toolbar_orientation=0config_dialog_position_y=191

config_dialog_height=520

toolbar_layout=North

config_dialog_position_x=288

config_dialog_width=394

framework_bounds=229,259,512,384



Defining console-wide policy files



Anoth er asp ect of control vested in the BMC Impact Porta l is the p olicy file that BMCImp act Explorer retrieves each time a u ser connects to the BMC Imp act Portal. This

file contains p aram eters that d efine BMC Imp act Explorer console-wide policies forall users. At installation, the default p olicy file, default.console_policy.prop, is created ;it is located in the jboss \ s erver\ all \ data\ smsConsoleServer\ po licy directory.

The policy file is never saved from the BMC Impact Explorer console, only retrieved .

If a specific user has a p articular need , it is possible to create an ind ividual user p olicyfile, username.console_policy.prop, based on th e default and located in the same

jboss \ s erver\ all \ data\ smsConsoleServer\ po licy d irectory. This ind ividual user policy

file will be retu rned to the BMC Impact Explorer console, rath er than the d efault file,

default.console_policy.prop, when the u ser logs on. For ease of maintenance, BMC

Software recomm end s that the d efault be used for most users.

Table 32 sum mar izes the param eters in the d efault p olicy file.

Table 32 default.console_policy.prop parameters (part 1 of 2)


local_action_event_operations controls the tracking of local actions p erformed against events

default_filter_name specifies the default filter used to display th e event list when no v iew

is selected

default_slotorder_name specifies the default slot order u sed for the event list when no view is

selected

eventlist_icon_slots controls the slots show n as icons in the even t list (values of hidd enslots can be v iewed o nly as icons)

filter_hidden_slots controls the h idd en slots that are available for creating filters

Note: Filters that rely on hid den slots may be broken in futu re releases

because they rely on und ocumen ted contents.

administration_editor_classes controls the classes (with their subclasses) that are available to the

Dynam ic Data Editor

administration_editor_acls specifies the ACLs that con trol access to the Dyn am ic Data Editor

no_import_slots controls exclusion of slots w hen exporting

config.save.freq controls the time interval between saves of configur ation information(such as wind ow sizes and locations)

ix.servicetree.save.timer controls the time interval between saves of Services View n avigation

tree information

local_action_event_notes (deprecated)a controls creation of notes for events tha t have local actions

performed against them; replaced with

local_action_event_operations





Figure 14 lists its contents, includ ing the default values for each p aram eter.

remote_action_event_notes (deprecated)a controls creation of notes for events that h ave remote

actions p erformed against them

status_mod_event_note (deprecated)

a

controls creation of notes for events th at change statu s bymeans of user-initiated action

a Deprecated pa rameters rem ain in version 4.1 and earlier cells. However, the param eters do n ot exist in newer

releases.

Figure 14 Default policy file (part 1 of 2)

# This document keeps default Policies for different BMC Impact Explorer wide functions.

# Format:

# <policy_name>=<polcy specific value>

# Policy which controls the creation of an event operation track for events which

# have local actions performed against them.

# value: on=operation track created when local action performed, off=operation track not

created.

local_action_event_operations=on

# Policy which controls the creation of an event note for events which

# have local actions performed against them.

# deprecated: On im's 4.1 and further mc_notes is no longer used to track history,

mc_operations is dedicated to this purpose.

# replaced with local_action_event_operations

# value: on=note created when local action performed, off=note not created.local_action_event_notes=on


# have remote actions performed against them.

# deprecated: On im's 4.1 and further mc_notes is no longer used to track history,

mc_operations is dedicated to this purpose.

# The registering of history in mc_operations is configured at the im.

# value: on=note created when remote action performed, off=note not created.

remote_action_event_notes=on


# change status via user initiated action (e.g.: OPEN -> CLOSED).

# deprecated: On im's 4.1 and further mc_notes is no longer used to track history,mc_operations is dedicated to this purpose.

# The registering of history in mc_operations is configured at the im.

# value: on=note created when event status changes, off=note not created.

status_mod_event_note=on

# default filter and slot order when no view is ever selected.

# value: the name of a defined filter and slotorder.

default_filter_name=All Events

default_slotorder_name=Basic Information

# controls if ClassDetailProvider detail tabs show hidden slots

#ClassDetailProvider_shows_hidden_slots=false

Table 32 default.console_policy.prop parameters (part 2 of 2)




Configuring display and connection settings


When you execute a local action, a rem ote action, or modify the statu s of an event, a

note is written to the event as a value to the mc_notes slot and ap pears in the Notes

tab of the details pane of BMC Impact Explorer Events View. The initial filter is set tod isplay all events an d th e initial slot ord er is to display as basic inform ation, as

ind icated on the even t source tab in the event list display. The last entry in th e policy

file identifies those slots that shou ld not be impor ted because of their specificsemantics.

The policy file’s console-w ide ap plication can be u sed to p rotect the ind ividual user’s

cell group ings from being accessed and mod ified by other users on a m ulti-user BMC

Imp act Explorer console. This enables a business to assign mu ltiple users w ith

limited u se requirem ents to one BMC Imp act Explorer console, fully u tilizing on eresource, rath er than investing in several BMC Impact Explorer consoles that w ill be

under utilized.

Anoth er beneficial aspect of the global natu re of the policy file is that you can use it to

create a custom ized d efault event filter and slot order for a BMC Impact Explorer console for new users and as the d efault filter and slot order wh en a u ser selects an

improp er filter.

Configuring display and connection settings

You can u se the ix.properties file to configure the d isplay and connection settings for

BMC IX. Table 33 lists the property settings includ ed in the ix.properties file.

Table 33 Property descriptions from ix.properties file (part 1 of 2)

Console property Description

framework_debug wh en set to true, enables debugging for the console

help_url sets the directory location and URL address for the BMC Imp act

Explorer Help file

java _plaf specifies the look and feel for BMC Imp act Explorer accord ing to

the Java GUI settings

macro_connect_timeout sets the amou nt of time, in seconds, a m acro waits to connect to

a cell

remote_server_port sets the port num ber used by the Remote Method Invocation(RMI) service in BMC Im pact Explorer

remote_server_enabled enables th e RMI service for BMC Imp act Explorer for rem ote

access to event d ata

all_connection_allowed enables an y connection to th e RMI service for a BMC Imp act

Explorer

If set to false, the RMI service can only accept connections from

the local comp uter w here the console is runn ing.



Event group configuration files


Table 35 lists the d efault priority level colors and their values, as defined in

color.properties.

To globally chan ge the d efault severity or pr iority colors, mod ify the color.properties file and stop and start the BMC Imp act Portal.


The event grou p configuration file structure is listed in Table 36:

Major orange FF9900,000000

Minor light orange FFCC33,000000

Warning yellow FFFF00,000000

Information blue 3366CC,FFFFFF

OK green 33CC00,000000

Unknown gray CCCCCC,000000

WARNING

s The entries are the d efault color prop erties. Do not delete these prop erties.

s If you customize the severities by increasing the n um ber of levels to be greater than the

nu mber of default severity levels, the severity list on the Event an d Services Views

becomes tr un cated and part ially illegible. Restrict you r custom izations to the sam e

nu mber or fewer severity levels.

Table 35 Event priority levels and colors

Priority level Color Hexadecimal RGB values in color.properties

Priority_1 red FF0000,FFFFFF

Priority_2 orange FF9900,FFFFFF

Priority_3 light orange FFCC33,000000

Priority_4 yellow FFFF00,000000

Priority_5 green 33CC00,000000

NOTE

Modifications m ade to th e color.properties file do n ot imm ediately app ear in the BMC Imp actPortal. By default, the BMC Imp act Portal configuration.update.interval parameter

checks for changes every 300 second s.

Table 34 Event severity levels and colors (part 2 of 2)

Severity level Color Hexadecimal RGB values in color.properties



XML files that define user interface elements



Table 37 lists XML files that control some user interface characteristics in BMC Im pactExplorer that cannot be ed ited in th e BMC IX user interface.

Use care w hen you edit these files to avoid u nexpected an d un desirable results.

These files are located in

s Windows: %BMC_PORTAL_KIT_HOME%

\ appserver\ websdk\ too ls \ jboss\ server\ all \ data\ smsConso leServer\ extdetail s

s UNIX: $BMC_PO RTAL_KIT_HOME

/appserver/websdk/tools/jboss/server/all /data/smsConsoleServer/extdetails

Table 36 Event group configuration files

Folder Contains

\ Imag es Backgrounds an d Icons directories

\ Imag es \ Backgrounds background image files that are sha red b y all Map d efinitions

\ Imag es \ Icons image files wh ich are shared by all Map d efinitions

\ M ap event group tree nod e template MapObjectTemplate.xml

\ M ap event group default image view configuration

DefaultMapPage.xsl

\ M ap Map tree definition Maps.xml

\ M ap\ Map_ xxx Map.xml for Map_ xxx as well as its MapPages directory

\ M ap\ Map_ xxx \ M apPages all map p age d efinitions for Map Map_ xxx

Table 37 xml files that define user interface elements in BMC IX

File name Description

default.DataEditor.extdetails.xml defines the d efault tabs if the

global.DataEditor.extdetails.xml file is not present or

does not contain values

global.DataEditor.extdetails.xml defines the tabs that app ear in the data editor

global.extdetails.xml defines the tabs that app ear for events and comp onents

global.PolicyEditor.extdetails.xml defines the policy typ e to policy editor m app ing

global.SmcToolTips.extdetails.xml defines the tooltips that ap pear on a comp onent

instance



Overview

156 BMC Impact Solutions:General Administration

Overview

Infrastru cture Man agemen t makes it easier for ad ministrato rs with a Full Access or

Service Ad ministrator role to mon itor and manage BMC SIEM infrastru cture

components in a real-time service model. These infrastructure components includeImpact Manager cells, servers, and integrations. In the Infrastructure Managemen t

GUI, you n ot only can mon itor the d ifferent states of the comp onents based on their

color codes, but you a lso can p erform actions on them , such as

s stop, start, and other operations

s ed it configura tion and log files

s package sup port files for troubleshooting p urposes

Default Infrastructure Management service model

The default Infrastru cture Man agem ent model consists of logical group ings of BMC

infrastructure app lications and comp onents. Upon installation certain compon ents

send registration events and become au tomatically registered with the InfrastructureManagement model.

Figure 15 Default Infrastructure Management service model

In the color schem e, green ind icates that th e object has registered w ith the Imp actAdmin istration cell. Grey ind icates that t he object is a logical group ing, the

comp onents of w hich are not registered w ith the Imp act Adm inistration cell. The

bold lines that connect the comp onen ts represent the active impact relationships. Thearrow s indicate the d irection (provider to consumer) of the event feed. A dotted line

ind icates that the relationship is inactive.



Roles and permissions


In this cur ren t 7.1 release, the following version 7.1 BMC comp onen ts register w ith

this service mod el. They can be added as componen ts instan ces to the respective

logical group.

Roles and permissions

The following group roles have full wr ite permission to th e components an d featuresof the Infrastructure Managem ent subtab:

s Service Ad ministrator s

s Full Access

Only members of either grou p can view the Infrastructure Man agement subtab.

Refer to “Defining group roles” on page 95 for inform ation on assigning roles.

Walkthrough

This section provides a w alkthrough of Infrastructure Man agement, highlighting its

main features. You can u se this walkthrough to learn about an d become familiar w ith

Infrastructure Man agement.

Table 38 Supported application groups in version 7.1

Group Id Name

100 EM_CELL

101 EM_SERVER_1

102 EM_SERVER_2

103 SIM_CELL

104 SIM_SERVER_1

105 SIM_SERVER_2

106 IAC (Impact Administration Cell)

111 IAS (Impact Administration Server)

112 PS (BMC Impact Publishing Server)

142 Integration for BMC Remedy Service Desk

160 EM_Server_Standby

161 SIM_Server_Standby



Sampling context-sensitive information


Figure 17 Default service model BMC Impact Solutions (with active services)

The services and app lications are color-coded to reflect their r eal-time statu s. You cancheck the m ulti-colored Status legend to see the status a ssociated with each color.

(The grey-colored icons rep resent logical grou pings.)

Sampling context-sensitive information

The Infrastructure Man agement GUI offers a ran ge of context-sensitive information

that you can access from right-click p op-up menu s and mu ltilayered notebook tabs.

For examp le, you can expan d the m odel and select a comp onent u nd er the SIM Cells

heading.

s Click on th e leaf comp onent un der SIM Cells to select it.

s Click on th e Details tab. Click on the su btabs su ch as General, Status, Related

Comp onents an d Schedule. These tabs provide comp onent sp ecific information.



Managing files on remote systems


s Click on the Ad minister tab. Click on the subtabs. Note that you can access the

Workload and Compon ents tabs. These tabs are not visible if you h ad selected an

EM cell instead.

s Click on Edit Component in the Details=>General tab and change a p roperty of

the comp onent.

Managing files on remote systems

From the Infrastructure Managem ent GUI, you can edit and save the configuration

and log files of other SIEM ap plications and services, both of which are ru nn ing on

remote systems.

To edit and save configuration files

1 Click on the leaf comp onen t un der a service or an ap plication, such as SIM Cells, toselect it.

2 From the notebook tabs, choose Administer=>Configuration .

The drop down list reveals the configu ration files of the selected comp onen t.

3 To mod ify a file, select it from the list, and click Ed it. The Creden tials dialog boxdisplays.



Packaging support files


The Add itional command credent ials check box app lies mainly to UNIX systems,

wh ere you may n eed to log into the system u nd er one user accoun t, but then

switch to an other u ser accoun t (for examp le, root) to execute the action.

4 In the d ialog box, enter th e credentials of the remote system , and click OK.

The configu ration file is displayed in the ed itor.

5 Edit th e file.

6 When you’re d one, you can click either of the following:

s File=>Save a Copy to save a copy of the file to your local system

s File=>U pdate Original to up date the file on the rem ote system

To edit and save log files

1 Click on the leaf comp onen t un der a service or an ap plication, such as SIM Cells, toselect it.

2 From the notebook tabs, choose Administer=>Logs .

The dropd own list reveals the log files of the selected comp onen t.

3 To mod ify a file, select it from the list, and click Edit.

4 In the d ialog box, enter th e credentials of the remote system , and click OK.

The log file is disp layed in the ed itor.

5 Edit th e file.

6 When you’re d one, click File=>Save a Copy to save a copy of the file to your localsystem.

You cann ot up date a log file on a rem ote system. You can sav e it only to the local

system.


You can p ackage selected debug files to help troub leshoot customer cases.

Infrastru cture Man agement au tomatically packages the selected files into a zipp edfile.





To package support files

1 Click on the leaf component under SIM Cells, for example, to select it.

2 From the notebook tabs, choose Administer=>Support Package.

3 In the Destination field, enter the file path where the package should be saved on

the local system. You can use the Browse button to navigate to the directory.

The file nam e of the supp ort package is created au tomatically.

4 Optional. Enter a tracking n um ber in the Issue Nu mber field.

5 Optional. Enter a d escription of the issue in the Description field .

6 Click Create Package.



Launching remote actions


7 Enter the creden tials of the remote system from w hich you ar e retrieving the files.

A pop -up p rogress ind icator show s the status of the retrieval. If it comp letes

successfully, go to the specified d irectory and r eview the contents of the zipped

package. The file conten ts vary based on the typ e of componen t. Here are typ ical

files for a SIM server componen t.

8 Repeat steps 1 throu gh 7 for an Imp act Administration Server comp onent,

verifying th at the file contents of its zipp ed p ackage are d ifferent from those of theSIM Cell.


From the Infrastructure Man agement GUI, you can execute actions through the right-click pop -up m enus on compon ents and ap plications that are run ning on remote

systems.





To launch remote actions

For this exercise, you m ust h ave a registered cell compon ent installed on a rem ote

system.

1 Right-click th e leaf comp onen t u nd er SIM Cells or EM Cells to select a cell resid ingon a remote system.

2 Choose Actions to d isplay a list of all possible actions for th at comp onen t.

3 Choose Stop Cell Server Process, and enter th e logon creden tials for the remote

system.

If the selected comp onen t resides on an M S Wind ows system, your login

credentials should h ave ad ministrative rights to the system. The Add itional

Comman d Cred entials are needed check box is disabled.

When the compon ent on the rem ote system has stopp ed, its status changes to

Unavailable.

4 Return to the Infrastru cture Man agement GUI, right-click on the SIM Cellscomp onent to display the pop-up menu , and choose Actions=>Start Cell ServerProcess.

5 Verify that th e cell has star ted—for examp le, you can execu te an m cstat comm andto check the cell’s status. Then you can verify that the statu s of the selected

comp onent is changed to OK.

6 Repeat steps 1 throu gh 5 for a BMC Imp act Adm inistration Server (IAS)comp onent. The actions p ermitted on this comp onent ar e different from those of

the EM or SIM Cell comp onen t. They a re limited to Stop Process and Start Process.

You can also launch remote actions for selected compon ents by clicking on e of the

Action toolbar icons of the Infrastru cture Management view.



Navigating the GUI


Select the grou ping BMC Impact Solutions, wh ich contains the defau lt infrastru cturemod el, and d rag-and-drop it on the grap h viewing area. You m ay need to select the

Orientation icon to d isplay it along a ver tical axis.

Table 39 Icon listing for infrastructure management model

Icon Definition

logical services grouping

IAS (Impact Ad ministration Server)

SIM cell

SIM cell server 1

SIM cell server 2 (high a vailability implem entation )

SIM cell server stan dby (high av ailability im plementation)

EM Cell

EM cell server 1

EM cell server 2 (high availability implementation)

BEM cell server standby (high availability implementation)

BMC Pu blishing Server

Integra tion for BMC Remed y Service Desk



Navigating the GUI


Multiple graphs

You can d isplay mu ltiple grap h views. For example, you can select registered

comp onents from the Results list in the navigation pa ne, and d rag-and-drop them on

the grap h viewing area, creating new graph views. You can sw itch from on e view to

the other by selecting the tabs at the top of the graph viewing area.

Navigation tree

To help organize your mod el, you can d isplay and man ipulate the grouping and

comp onent hierarchy in the n avigation tree view un der th e Infrastructure

Management heading.

You can select objects in the nav igation tree and d isplay them in th e graph viewingarea.

You can d rag objects from the grap h viewing area an d drop into the n avigation tree,creating a navigation link betw een the tw o.

You can create customized subgrou ps u nd er the Infrastructure Mana gement

heading. After selecting th e head ing, right-click to open th e Ad d a sub group menuitem.

After you d efine your grou p, you can drag and drop comp onent objects into it.

TIP You can click both CTRL and the ob ject in th e nav igation tree to d isplay th e object in the grap h

viewing area w ithout closing an y d isplayed objects.



Displaying and understanding the Details and Administer tab data


Displaying and understanding the Details and Administer tabdata

The Details subtabs disp lay information th at iden tifies the characteristics of the

selected comp onent an d return s its status. They let you perform comm on BMC IXactions, such as changing p rovider\ consum er relationships between components.

The Adm inister subtabs d isplay specific infrastructure information and let you

perform un ique infrastructure actions, such as editing configuration and log files and

collecting d ebug files for troub leshooting.

To view d ata abou t an object in th e GUI, first select it. Then you can scan the

correspond ing subtabs un der Details and Adm inister. To view information on one of

the Ad minister tabs, the selected object mu st be a registered infrastru cture

compon ent, not a greyed -out logical services group icon.

Details tab data

General

In the General subtab, you can view the nam e, class, and subtype of the selectedobject. Depen ding on the subtyp e, you can also view other slot values, as described in

Table 40.

Table 40 Slot values: Details: General subtab (part 1 of 2)

Slot Description

Ed itable H ere contains a Boolean Yes/ N o indicator that says w hether the

selected comp onen t object can be ed ited in BMC IX.

Infrastructure Managem ent only contains objects that are not

pu blished . Therefore, Editable Here is always set to Yes in

Infrastructure Management.

Master Rep ository sp ecifies th e d ata sou rce of th e com p on en t object. For

example, componen t objects that originate from a d irect feed

source, such as BMC IX, mposter, or an M RL, are design ated

in th is format: Cell-cellName. The d efault nam e for

Infrastructure Managem ent is Cell_Adm in.

Run State the current state of the object, which helps to determine its

statu s, its icon shap e, the icon’s color, as well as w hich

actions can be per formed agains t the object. This slot value is

up dated w henever the compon ent changes its state, from

start to stop, from start to p aused , from stop to start, and so

forth.

Role ind icates whether a component, such as a cell server or IAS,

is stand alone or, in an H A pair, either pr imary or secondary



Displaying and understanding the Details and Administer tab data


Schedules

In the Schedu les subtab, you can view the times wh en the comp onent is in service

together w ith its priority costs when it is in service and when it is out of service. This

subtab view is not available for the Ad min cell (IAC).

Administer tab data

Configuration

The Configuration su btab lists the ed itable configura tion files of the selected

compon ent. You can retr ieve these files, even those associated w ith compon ents on

remote systems. Click Edit... . Then enter th e logon credent ials for the system w here

the componen t resides. (On UN IX, your login accoun t mu st have permission to accessthe target system. On MS Window s, you mu st have ad ministrative pr ivileges on the

system.) The file open s in a d efault text editor.

You can edit any sup ported configuration file of an infrastructure comp onent. Thetype of file varies with the comp onen t, but the files includ e:

s mcell.dir

s .conf files

s filter files

s selector files

s map ping files

s trace.conf files

s cell_info.list

You sh ould know the p aram eters of the file before trying to edit it. Refer to the

comp onent’s respective docum entation.

You can save the edited configu ration file to a local or rem ote system. If saving to a

local system, you can specify a differen t file path . If saving to a remote system , you

up da te the configu ration file in its curren t directory path. You cann ot save it to ad ifferent file pa th.

Logs

Similar to configuration files, you can open and ann otate log files of comp onents on

local systems in the Log subtab. You cannot save an ed ited or u pd ate an viewed log

file to a remote system, however. You m ust save it to the local system.



Editing infrastructure relationships


Support Package

In the Sup port Package subtab, you can prepare a zipp ed p ackage of predefined

support files for troubleshooting purposes. See “Creating the su pp ort package” on


Workload

The Workload subtab dynam ically tracks the even t activity of the cell server

compon ent. It presen ts coun ts, averages, and percentages of different even t actions,such as sent, received , drop ped , and removed . You can refresh th e table by clicking

the Refresh bu tton. This subtab view is available for SIM cell servers, bu t not for BEM

cell servers.

Components

The Compon ents subtab d ynam ically tracks the component instances that aresend ing event s to the selected object. You refresh th e table by clicking the Refresh

bu tton. This sub tab view is available for SIM cell servers, but not for BEM cell servers.

Editing infrastructure relationships

To open th e Edit Relationships dialog box, select an infrastru cture object in the graph

area. Then d o one of the following:

s Select the Related Com pon ents su btab from the Detail notebook tab. Click the EditRelationship... button.

s Choose Edit=>Edit Relationship... .

s Click the Ed it Relationship toolbar icon.

The Edit Relationships d ialog box is opened . Figure 18 on page 174 shows an open

Edit Relationships d ialog box with a selected SIM cell open ed for ed iting in the Edit

This Relationsh ip subd ialog.



Deleting components


To organize your service mod el around its real-time components, you can delete

logical group ings that d o not h ave registered comp onents associated with th em.

Generally, you sh ould delete the leaf objects, not objects tha t lie between o ther

objects. If you delete objects that lie between oth er objects, some objects that sh ould

be deleted because of relationship associations w ith the other objects will non ethelessremain.

BMC recommend s that you do n ot delete comp onents that h ave been registered

automatically with the Infrastructure Management service model. However, if you

delete a live, registered object, it is removed from the Infrastru cture Man agem entservice mod el, and an even t of the class Service Model Comp onen t Delete is sent to

the IAC.

TIP You can r ecover a deleted r egistered object by mod ifying theDATA/ ADMIN_DATA/ ADMIN_REGISTRATIONS table of the IAC in the

Adm inistration tab view.

You change the enable parameter for the specific compon ent from N O to YES in the

Edit tab. Then you restart the comp onent to reregister it.



Executing remote actions



You can m anage th e infrastru cture objects from the GUI. Select th e object, right-click to open the p op-up menu , and choose Actions to d isplay a list of the available actions.

Figure 19 Actions right-click menu

Depen d ing on the curr ent state of the comp onen t, not all actions are available.

You can a lso launch rem ote actions from the toolbar icons.

Depend ing on the typ e of comp onent and its curr ent state, a ran ge of actions are

available to you. See “Remote actions” on p age 187 for an explanation.

(You can connect to rem ote systems from the Configuration and Sup port Package

subtabs of the Ad minister n otebook tab.)

Considerations when working with high availability cells

Your r emote actions are restricted w hen w orking w ith a high availability (H A)

configuration in w hich th e pr imary cell server is down and the second ary cell serveris in a passive state.

s When th e Impact Ad ministration cell (IAC) is in an HA configuration, do not

launch a rem ote action against any comp onents in the Infrastru cture M anagement

view wh en the IAC primary server is dow n and its second ary server is in a p assivestate. In th is case, the IAC rejects the actions .

s When BEM or SIM cell servers are in standby mod e, you can perform only the

perm itted actions on them .

NOTE

An IAC cell that is in stand by mod e is show n in yellow .





When the secondary cell server is an active state wh ile the p rimary cell server is

down , wh ich is the situation d epicted by SIM Cell Server 1 and SIM Cell Server 2 in

Figure 20 on page 178, the range of perm itted actions increases.

Figure 20 High availability (HA) view: two cell servers

Special considerations for UNIX systems

If the Imp act Administration Server resides on a UN IX or Linux system and the target

app lication resides on W indow s system, then you mu st configure the SSH or Telnetprotocols on the Wind ows system to enable remote action. See “Configur ing the BMC

Impact Adm inistration server to supp ort remote actions” on page 114 for m oreinformation.

When launching remote actions against comp onents that reside on UN IX systems,

you m ay need to log in un der on e account to access the system and then log in u nd era separate account to launch the comm and . For examp le, you m ay not be able to log

into the UN IX system as root. Instead, you log in u nd er a separate user accoun t.

How ever, to execute the comm and , you may have to log in as root or as an other userwith the p ermission to execute the comm and .

When you select the Add itional command creden tials check box in the Cred entials

Information d ialog box, the d ialog box expand s to provide you w ith two sets of login

creden tials to hand le this situation.



Executing other actions


Executing other actions

Where ap prop riate for the compon ent, you can perform the actions that ar e availablein the Services tab v iew. These actions includ e

s viewing the grap h of a selected comp onent an d its relationships

s viewing events associated with th e selected comp onent

s setting manu al status and m aintenance mod e

s add ing links to comp onents from container folders

s refreshing the grap h view after making an edit to a comp onent or relationship

Configuring the audit log

By d efault, Infrastructure Managemen t au tomatically m aintains an aud it log of all

remote actions that an adm inistrator performs on remote hosts. The au dit log uses the

following format:

Table 44 on page 179 describes the aud it log p arameters:

TIME_STAMP LOG_LEVEL IAS_USER OS_USER SUB_TYPE:OBJECT ACTION_IDEXPLANATION

Table 44 Audit log parameters (part 1 of 2)

Audit log parameter Description

TIME_STAMP m onth, d ay, year, hou r, m inu te, and second that the log entry

was created. Uses the format mm/ dd / yyyy hh:mm:ss

LOG_LEVEL the severity level of the logged action. Valid valu es inclu de

s INFO: informational m essage

s SEVERE: error message

A typical SEVERE message documents the error exceptions

that occur du ring the execution of a remote action, such as

Unable to save file on remote machine.

IAS_USER current BMC IX user name that has logged on and connected

with the Imp act Ad ministration server

OS_USER user name that logs into the remote host’s operating system.

This is the user nam e und er wh ich the action is executed on

the remote host.



Configuring the audit log


Supported component or application types

Infrastructure Man agement su pp orts the follow ing types in this prod uct version:

Sample logs

A sample au dit log for a remote star tup action on a SIM cell might look as follows:

Similarly an aud it log for a remote startu p action on an IAS server m ight look like

this:

SUB_TYPE the component or app lication type on the BMC IX

adm inistrator is performing the r emote action. In version 7.1,

Infrastructure Management sup por ts the subtyp es listed

under “Supported component or application types” onpage 180.

OBJECT user-specified value in the Object slot of the component or

app lication on the w hich remote action is being executed

ACTION_ID unique Id associated with the remote action. This unique Id is

defined in th e correspond ing actions.xml file stored on the

compu ter wh ere the BMC Impact Adm inistration Server

resides. For example, the ImpactManager.xml file is an

actions file that app lies to BEM and SIM cells. It is stored

und er the

IMPACT_SOLUTIO NS_HO ME/ server/data/admin/actions

folder on the IAS compu ter.

EXPLAN ATION short text description of the logged action

s EM_CELL s SIM_SERVER_1 s IBRSD

s EM_SERVER_1 s SIM_SERVER_2 s BEM_SERVER_STANDBY

s EM_SERVER_2 s IAC s SIM_SERVER_STANDBY

s SIM_CELL s IAS s PS

Mon 07/23/2007 16:50:15 INFO iasuser superuser SIM_CELL:PUNE_CELLstart_im_windows Executing action

Mon 07/23/2007 16:52:10 INFO iasuser superuser IAS_Server:PUNE_IAS_Serverstart_IASserver_window Executing action

Table 44 Audit log parameters (part 2 of 2)

Audit log parameter Description



Creating the support package


After you mod ify any of the prop erties in the ias.prop erties file, you m ust restart the

Impact Ad ministration server.


You can create a sup por t package for troubleshooting pu rp oses by collecting files

from remote systems and saving them to a specified file path on the local or a rem ote

system.

The sup por t package contains the following files:

s .dir files

s

.conf filess filter files

s selector files

s map ping files

s trace files

s trace.conf files

In add ition, it contains

s default sup port files

These are interna l files of the infrastru cture ap plication. They are not includ ed inthe other categories. They vary amon g the ap plications, but they includ e .baroc,

.mrl, .wic, and .cmd files. Genera lly, for a cell server, this p ackage contains th e filesof its KB directory an d its log directory. You can choose w hich files to includ e.

They also includ e a sysinfo.text file that captu res active por t connections, OS and

hard ware configurations, and n etwork card details. The absolute file path to eachfile is includ ed.

com.bmc.sms.ixscomm.util.auditLogLimit size in bytes of the au d it log file. The d efault is 5000 bytes

(app roximately 4.88 kilobytes). While there is no p red efined

maximu m size, BMC recommend s that each log file not

exceed 5 MB.

com.bmc.sms.ixscomm.util.auditLogFileCount indicates the num ber of aud it log files that are cycled throu gh

du ring a rotation. After the sp ecified nu mber is reached, the

cycle repea ts itself, overwriting in sequen ce the log files of the

pr evious cycle. The d efault is 1.

Table 45 Audit log IAS properties (part 2 of 2)






s add itional sup port files

This is a custom izable list of files that the u ser can ed it by adding or d eleting files

to or from the su pp ort package. It is designed to enable the user to ad d other files

to the sup port p ackage.

Specifying your support files

You can sp ecify which sup por t files you w ant to receive by the ed iting the

correspon d ing slot in the Edit Service Comp onen t dialog for the selected comp onen t.

To specify wh ich supp ort files to include, select the comp onen t and choose

Edit=>Edit Component... or choose Edit Component... from the right-click pop-u p

men u. The Edit Service Compon ent d ialog is disp layed. Scroll down the list of slots.You can sp ecify values in the slots specified in Table 46.

Your sup port files should be on the system on w hich th e comp onent is run ning. Enter

the full path to the file you w ant to include. If you ar e add ing mu ltiple files, separatethe comp lete file path s with comm as. There is no limit to the nu mber of files that you

can add .

To comp ile your sup port p ackage, choose the Adminis ter=>Support Package tab.

Browse to the d estination folder wh ere you wan t to save the list of configuration an d

log files, and select it. You can enter the issue n um ber (maximum of 16 characters) if one has been assigned.

Table 46 Slots for specifying support files

Slot Description

Addit ional Support Files full path to other support files that you w ant to include

Con figu ration files fu ll p ath to con fig uration files (.con f)

Dir files fu ll path to *.dir files, such as mcell.d ir or admin.d ir

Filter files full path to *.filter files

Map files full path to *.map files

Selector files full path to *.selector files

Trace conf files full path to the *.trace file

Trace files full path to the trace logs

WARNING

MS Window s does n ot sup port th e creation of files that have an y of the following sp ecial

characters in th eir file names: , \ , / , ?, *, ", | , <, >. If the BMC IX is installed on MS Wind ows,

do n ot enter any of the special characters in the Issue Nu mber slot. Otherw ise, the supp ort

package creation fails.





If you d o enter the issue num ber, assign it as a p refix to the supp ort package nam e.

You can typ e a short, but inform ative, description of the package (maximum of 256

characters). Then click Create Package.

The file name of the supp ort p ackage file follows this format:

The OBJECT_NAME value is taken from the object slot of the selected comp onen t.

The time stam p is in the form at: MMDDYY_HH MMSS.

UNIX processing note

Und er UN IX, it m ay take several minutes to create a sup port package. Two causes

can contribute to the delay in p rocessing:

s wh ether the component for w hich you are creating the supp ort package resides in

a different dom ain from the system on w hich you are run ning BMC IX. If it does lie

in a different d omain, expect a delay.

s the size of the zipp ed or ta rred file. The greater the size, the longer the delay,

especially as the file app roaches 500 kb or larger.

Reviewing the audit log of the support package

Interna lly, the process of building a su pp ort package consists of these actions:

1. saving the OS-based comp ression u tility (zip or zip.exe) to the r emote system

2. creating the supp ort package

3. removing the OS-based compression utility from th e remote system

4. executing th e get-file action to retrieve the su pp ort p ackage from the remote

system an d p utting on the system w here IAS resides

5. getting the binary file from the IAS system to the local system w here BMC IX

resides

OBJECT_NAME _support_package_TIMESTAMP.zip



Background to Infrastructure Management


Because this is a remote action, the aud it log captu res the process. If the supp ort

package creation is a success, you receive an aud it log message that looks similar to

the following MS Wind ows examp le:

In a successful sup port p ackage creation, the aud it log d oes return an error m essage:

Fri Aug 17 12:49:31 IST 2007 SEVERE user ADPROD\slondhe SIM_SERVER_1

:slondhe-pun-01 remove_zip_WINDOWS Stderr returned with some error. You can ignore this error because u sers can still retrieve the zipp ed sup port p ackage

autom atically from the r emote system w ithout any man ual intervention.

If you receive a SEVERE error message on an y of the other su pp ort p ackage actions,

such as saveRemoteFile, create_sup por t_package, get_file, and getBinaryFile, it

ind icates that the sup por t package creation failed. Discard it, and try again.

Background to Infrastructure ManagementThe information in th is section describes some of the internal workings of

Infrastructure Man agement.


The essential comp onent of Infrastructure Managemen t is the Impact Ad ministrationcell (IAC). Its nam e is displayed as Ad min in the GUI.

The IAC is a custom SIM cell that contains a specialized Knowledge Base. This cell

accepts registration, configuration, and other events from BMC product componentsand app lications and then creates the compon ent d efinitions based on the event

information.

Fri Aug 17 12:49:25 IST 2007 INFO user ADPROD\slondhe SIM_SERVER_1 :slondhe-

pun-01 saveRemoteFile : zip.exe Executing action.Fri Aug 17 12:49:28 IST 2007 INFO user ADPROD\slondhe SIM_SERVER_1 :slondhe-pun-01 create_support_package_WINDOWS Executing action.Fri Aug 17 12:49:30 IST 2007 INFO user ADPROD\slondhe SIM_SERVER_1 :slondhe-pun-01 remove_zip_WINDOWS Executing action.Fri Aug 17 12:49:31 IST 2007 SEVERE user ADPROD\slondhe SIM_SERVER_1:slondhe-pun-01 remove_zip_WINDOWS Stderr returned with some error.Fri Aug 17 12:49:32 IST 2007 INFO user ADPROD\slondhe SIM_SERVER_1 :slondhe-pun-01 get_file : Test1_support_package.zip Executing action.Fri Aug 17 12:49:33 IST 2007 INFO user ADPROD\slondhe SIM_SERVER_1 :slondhe-pun-01 getBinaryFile : Test1_support_package.zip Executing action.



Impact Administration server


How a product component registers and communicateswith the IAC

To register with the IAC, the componen t or app lication send s a configura tion

information even t. This configura tion event contains certain requ ired slots such asmc_event_mod el_version, m c_object and mc_tool, os_class, and so forth. The

comp onent or app lication sends the configuration information event u pon each

startup or change in its configuration.

After it registers with the IAC, the ap plication or comp onent send s status information

such as startup , shutd own , and error events.

Unregistering with the IAC

In the current 7.1 release, you cannot formally un register a compon ent. To remove a

comp onent from the Intrastructure Managem ent mod el, you m ust m anu ally delete it.It is removed from the Infrastructure Man agement GUI, but n ot from th e mod el

contained in the IAC. For example, its .log and .conf files persist in the IAC. The

application or service, how ever, is no longer op erational.

Impact Administration server

The IAC is a comp onen t of the Master version of the Imp act Adm inistration Server

(IAS). The IAS determ ines several p rop erties of BMC Imp act Explorer, includ ing rolesand permissions, cell-related inform ation for connected cells, high availability, and

other p rop erties. The IAS provides a series of CLIs that enable you to mod ify its

property files.

Unidirectional event flow

All registered comp onents p ass events and statuses to the Infrastructure

Mana gemen t GUI via the Imp act Adm inistration cell. This event flow is one way :

from the comp onents to Infrastructure Managemen t. How ever, you can p erform

actions on comp onents that reside on rem ote systems from the InfrastructureManagement GUI.

NOTE

All event inform ation shou ld be comp liant w ith the event format strictures of version 1.1.00 of

the Comm on Event Mod el (CEM). See the Comm on Event Mod el append ix in the BMC Impact

Solut ions:Knowledge Base Development guid e for more information.



Remote actions


Table 49 on page 188 ind icates wh ich menu options ar e enabled (Yes) or d isabled

(blank) for each ru n_state of a second ary cell in an H A configu ration.

Table 48 Component state and menu options: normal or primary cell in an HA configuration

Menu options

run_state

StartCell

ServerProcess

StopCell

ServerProcess

RestartCell

ServerProcess Pause EventsAdmittance Resume EventsAdmittance Set toStandby Set toActive

state_unknown Yes

state_active Yes Yes Yes

state_unavailable Yes

state_started Yes Yes Yes

state_stopped Yes

state_paused Yes Yes Yes

state_passive None

NOTE

If a component in an unkn own state is already started and you choose Actions=>Start, you

receive a status m essage notifying you th at the compon ent is started alread y.

Table 49 Component state and menu options: secondary cell in an HA configuration

Menu options

run_state

StartCell

ServerProcess

StopCell

ServerProcess

RestartCell

ServerProcess

Pause EventsAdmittance

Resume EventsAdmittance

Set toStandby

Set toActive

state_unknown Yes

state_active Yes Yes Yes Yes

state_unavailable Yes

state_started Yes Yes Yes

state_stopped Yesstate_paused Yes Yes Yes

state_passive Yes Yes Yes



Remote actions


Exceptions

Generally, most compon ent ob jects receive the actions Start, Stop, Restart, Pau se, and

Resume.

For cell servers, the Start, Stop, and Restart menu options in the Actions su bmen u ar e

described as

s Star t Cell Server Process

s Stop Cell Server Process

s Restart Cell Server Process

For other objects apart from cell servers, the Start, Stop, an d Restart m enu options in

the Actions subm enu are described as

s Start Processs Stop Process

s Restart Process

Different actions are available to d ifferent types of comp onen ts. Table 50 lists the

main exceptions:

Logical comp onents that you add to the Infrastructure Man agement service mod el

receive n o actions.

Table 50 Components and actions

Component Exception

HA cell all actions. The HA cell is the only component that allows theSet to Stand by and Set to Active menu options.

Impact Adm inistration server

(IAS)

receives the Restart action only

Pu blish ing Server receives the Start, Stop , and Restart actions

IBRSD receives the Stop, Start, and Restart options

normal cells receives the Stop, Start, Restart, Pau se Events Ad mittance,

and Resum e Events Adm ittance options



Remote actions





C h a p t e r 77Configuring BMC Impact EventAdapters

This chap ter describes the function and contents of the mcxa.conf file, emph asizingthe stru cture and contents of the configura tion specifications for the various

Adapters.

Con figuration overv iew . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

Ad ap ter definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192Con figuration tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

About th e mcxa.conf file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196Con figuration file stru cture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196

Con figura tion file definition s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

msend comm and configurat ion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199Param eter typ es . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

Globa l param eter s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200Com mon param eter s. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202

Specific parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204

Ap plyin g configu ration chan ges d uring ru n-time . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211

BMC Imp act Event Log Adap ter for Wind ows configu ration . . . . . . . . . . . . . . . . . . 211

NOTE

The BMC Impact Event Log Ad apter for Window s run s indep enden tly of the mcxa process

and the mcxa.conf file.



Configuration overview


Configuration overview

You configure the BMC Imp act Event Ad apters by m odifying th e parameters that

control their behavior. All param eters are recorded in the mcxa.conf file.

s Global param eters control certain behavioral aspects of all Adap ters run ning on the

engine m anager (mcxa process). Global param eters are listed in the GlobalParam eters section of the mcxa.conf file.

s Common param eters behave like global param eters. Comm on p aram eters are listed

in the Com mon Parameters section of the mcxa.conf file.

s Specific parameters d ictate selected asp ects of the behavior on an individualAdap ter instance. These param eters are recorded in the mcxa.conf file in a

definition that is specific to an Ad ap ter instance.

Adapter definitions

The mcxa.conf file contains d efinitions for all of the Ad ap ters ru nn ing on the

compu ter, as follows:

s All types of BMC Impact Event Adap ters are listed in and are ru n from th e

mcxa.conf file. For examp le, IP Adap ters do n ot use a separate mcxa.conf file from

LogFile Ada pters.

s Mu ltiple Adap ter instances can be d efined in the file. For examp le, you can h avethree d ifferent TCP Client Ad apters ru nning, each with a un ique configuration.

For m ore information about the structure of the mcxa.conf file, see “About the

mcxa.conf file” on page 196.

Configuration tasks

To configure th e global aspects of the Ad apters environm ent and the parameters

specific to each Adapter instan ce, per form the tasks in the order d escribed in

Table 51.



Configuration tasks


NOTE

You can ad d, remove, or mod ify global or comm on p arameters, Adap ter instance definitions,

or pa rser definitions in the mcxa.conf file at any time.

If you m ake a chan ge when th e engine manager (the mcxa process) is stopped , your changes

will be app lied w hen you r estart the engine man ager. You can also make chang es du ring run -time. To ensu re that th ese chang es are recognized, see “Ap plying configuration changes

du ring run-time” on page 211.

Table 51 Adapter configuration tasks (part 1 of 4)

Phase Action Details Where to go

Accessing the

configuration

file

Open the mcxa.conf

file.

The file is located at

MCELL_HOME \ e tc\ mcxa.conf

“About the m cxa.conf

file” on page 196

Configuring the

Adapter

environment

Specify valu es for

global param eters.

Some p arameters are required and some

are optional.

“Global par ameters” on

page 200

Specify valu es for

comm on p arameters.

Some p arameters are required and some

are optional.

“Common p arameters”

on page 202

Configuring

Adapters

Decide which

Adap ters you want

to use.

Determine wh at you wan t to accomp lish

with the Ad apters and select the Ad apters

app rop riate to the task.

s BMC Impact

Solutions: Event

Monitoring

Operator’s Guide

s “IP Adapter types”

on page 491



Configuration tasks


Configuring

Adapters,

continued

Gather the

information required

to define the

Adapter instances.

Review the specific pa ram eters associated

with each Ad apter that you want to u se.

Make a list of values that you wa nt to ad d

or mod ify for each Ad apter instance (suchas port nu mbers).

You m ust sp ecify which parser each of

your IP Ad apter instances will use.

Review the typ es of parsers av ailable.

BMC Softwar e recommend s that you

create a brief planning sheet for each

Ad apter, listing the information that you

want to include in the Ad apter d efinition.

s “Perl EventLog

Adap ter for

Windows

parameters” onpage 204

s “LogFile Adap ter

parameters” on

page 205

s “SNMP Ad apter

parameters” on

page 209

s “IP Ad apter types”

on page 491

s “IP Ad apter

parsers” on

page 507

Modify or add

Adap ter definitions.

The mcxa.conf file contains sample

Ad apter d efinitions for all sup ported

parameters.

1. Copy these definitions below the

Write your configuration below

heading at the end of the mcxa.conf file.

Make a copy for each Adap ter

instance that you requ ire.

2. Add or modify Adapter parameters as

required for each Adap ter instance.

not ap plicable





Configuration tasks


Configuring

Adapters,

continued

Define any required

IP Adapter p arsers.

The mcxa.conf file contains sam ple p arser

definitions for all supp orted p arameters.

1. Copy these definitions below theWrite your configuration below

heading at the end of the mcxa.conf

file.

Make a copy for each p arser instance

that you require.

2. Add or modify parser parameters as

required for each un ique parser

instance.

“IP Adapter p arsers” on

page 507

(optional) EnableAdapters. You can enable Ad apters at an y time afterthey have been configured. How ever,

some Adap ters may require additional

prep aratory work before they are enabled:

s If you intend to use a custom

mapping, review Append ix F, “BMC

Impa ct Event A dap ters MAP files,”

on page 473 and d o any required

prep aratory work before enabling any

Adap ters using custom mapp ings.

s

Before enabling an SNMP Ad apter,perform an y required configur ation

involving the mib2map utility.

Note: When en abling an IP Adap ter, you

mu st also enable the pa rser that it uses (if

that p arser is not already enabled).

s

“Custom maps andmap -related files”

on page 474

s BMC Impact

Solut ions: Installation

Guide

Save an d close the

mcxa.conf file.

not applicable not applicable





About the mcxa.conf file


About the mcxa.conf file

The Adap ters are configu red in a single configu ration file,

MCELL_HO ME \ etc\ mcxa.conf , by defau lt. You can use oth er configuration files by

starting the Perl pr ocess with th e CLI -c option.

Configuration file structure

Figure 21 on page 197 shows the stru cture of the d efault Ad apters configuration file,

mcxa.conf .

Configuring the

SNMP mib2map

utility

Configur e the

mib2map utility

(SNMP Adapter

only).

The mib2map utility specifies how SNMP

data is converted to BMC Imp act

Manager events. You m ust p erform some

configuration of this u tility to ensure th atSNMP da ta is presented correctly in the

events.

Note: Perform th is task before you enable

any SNMP Adap ter instances.

BMC Impact Solut ions:

Installation Guide

Enabling

Adapters

Remove or commen t

ou t DISABLE in the

Adap ter definitions.

Removing or commenting out DISABLE

in an Ad apter d efinition enables it

imm ediately. Do this only when you are

ready to collect d ata.

Notes :

s If you d id not enable the Adapters

when you first defined th em, then you

mu st re-open the mcxa.conf file,

remove DISABLE from the required

definition, and save and close the file.

s When enabling an IP Adap ter, you

mu st also enable the parser that it

uses (if that p arser is not already

enabled).

BMC Impact Solut ions:

Event Monitoring

Operator’s Guide





Configuration file definitions


The name of the d estination cell is provided in the common p aram eter, ServerName.

It can be identified in th e specific section, so that tw o differen t Adapters can send

events to d ifferent cells. In ad d ition, ServerName can contain the name of severalcells, separated by colons. In th is case the Ad ap ter tries to send events to on e the cells

in the list, always trying the first cell (the pr imary cell) in the list wh en an y other cell

goes down .

Other information about th e configuration, the param eters list, and examples are

located in the head er of the mcxa.conf file.

Configuration file definitions

The mcxa.conf file contains comm ents, sections, and p aram eter definitions.

Comments

Anything that follows the # character on a line is ignored , includ ing the # character,

un less it is includ ed inside single or d oub le qu otes.

Sections

The configu ration file is divided into sections beginning w ith the d efault section at

the beginn ing of the file. Each subsequen t section represents an in stance of a specificAdap ter. An adap ter section begins with a section name in squ are brackets “[]” and

end s at the beginning of another section or at the end of the file.

Configuration file parameters

The configura tion file pr imar ily contains parameter definitions in the form of

<param> = <value>

WARNING

BMC Software recomm ends th at you d o not pu t comm ents on lines that contain quoted

values. In am biguou s cases, qu otes take precedence, wh ich m ay cause unintend ed resu lts.



msend command configuration


The <param> an d <value> variables are defined as follows:

Figure 22 shows examples of parameters and values. Section h eaders that indicate the

type of entity being d escribed w ith the par ameters that follow are d isplayed in

magenta text. Parameter nam es are d isplayed in red text. Parameter values are

displayed in blue text.

msend command configuration

Events prod uced by the Ad apters are sent to the cell with the BMC Impact Managermsend comm and . To set up non-default param eters, configure msend with

MCELL_HO ME \ etc\ msend.conf or MCELL_HO ME \ etc\ mcl ient.conf . I DON ’T KNOW

WH AT THIS MEAN S.

Parameter types

Table 52 on page 200 describes the parameters types available for use with the BMC

Impact Event Ada pters.

Variable Description

<param> The param eter name. It cann ot contain blank sp aces.

<value> The param eter value. The first character of <value> is the first character of theline that is not blank and not a pou nd sign (#). <value> can be enclosed within

dou ble or single quotes.

Figure 22 Parameter and value examples

[TcpClient] Engine = MA::Adapter::TCPClient

Parser = MySeparatorParser

MapFile = mctcpclt.map

RemoteHost = localhost

RemotePort = 13 # date/time service

[MyTcpServer]

Engine = MA::Adapter::TcpServer

MaxClients = 10

RestartInterval = 30

MapFile = mctcpsrv.map

LocalHost = 127.0.0.5

LocalPort = 1999Parser = MyFixedWidthParser



Global parameters


TraceFile File name none mcxa.trace nam e of the trace file

If the n ame d oes not contain a path , the trace file issaved to the d efault trace file directory,

MCELL_HOME \ tmp\ Adapters.

TraceFileCount Integer > 0 none 10 maximum number of renamed trace files that are

kep t in the tra ce file directory

When the n um ber of files exceeds th e specified

limit, the oldest tr ace file is deleted .

To expand the amou nt of saved trace information,

increase the v alue of one of the following

parameters:

s TraceSizeMax (defau lt = 1,000,000)

s TraceFileCount (defau lt = 10)

TraceLevel Integer (0–6) none 3 trace level

Valid values:

s 0 – disables all traces

s 1 – header messages

s 2 – fatal messag es

s 3 – major errors

s 4 – minor errorss 5 – normal outpu t

s 6 – verbose outpu t

Note: TraceLevel = 6 pro du ces very large trace

files and is recomm end ed only for debugging.

Table 53 Global parameters (part 2 of 3)

Parameter Type UnitDefaultvalue Description



Common parameters


Common parameters

Table 54 on page 203 describes the comm on p arameters that can be used w ith the

Adapters.

TraceSizeMax In teger >= 0 byte 1,000,000 maximum t race file size

When the Ad apter detects that the maximum sizeis reached, the trace file is closed and renam ed

mcxa0.trace.

Notes:

s Old t race files rotate as 0–>1, ..., n–

>n+1.

s The num ber of trace files to keep is m anaged

with the TraceFileCount parameter.

TraceSizePeriod Integer > 0 none 10 frequency, in number of messages logged , atwh ich th e Ad apter checks the size of the trace file

A trace file is archived when it exceeds the size

specified w ith the TraceSizeMax parameter.

Table 53 Global parameters (part 3 of 3)




Common parameters


Table 54 Common parameters (part 1 of 2)

Parameter Type Description

Engine Perl module

name

name of the Adapter

This param eter is required. Default valu es are as follows:

s Engine = MA::ELogfile for any log file managem ent, including

UN IX syslog

s Engine = MA::ESnmpTrap for SNMP trap m anagement

s Engine = MA::EEventLog for Perl EventLog for Window s

management

The IP Adap ter definitions v ary slightly, w ith the inclusion of

Adapter:: in the path:

s Engine = MA::Adapter::TcpClient

s Engine = MA::Adapter::TcpServer

s Engine = MA::Adapter::Telnet

s Engine = MA::Adapter::UdpClient

s Engine = MA::Adapter::UdpServer

MapFile File n am e m ap file nam e

The map file must be located in the MCELL_HOME\ e tc directory.

Full path s are not accepted.

Default map name values depend on the Ad apter type. Default map

nam es are listed in “Default MAP files” on page 474.

MapFunctionsName File name name of a Perl script or Perl module that contains user-defined

functions to be used inside the .map file

The use of this param eter is now dep recated. Use the REQUIRE

directive, described in “REQUIRE directive” on page 486, from

inside the .map file.



Specific parameters


Specific parameters

Each Ad apter definition includes specific pa ram eters that are used to configure on lythe Ad apter instance in w hich th ey are listed.

Each typ e of Adap ter has a different set of specific pa ram eters.

s For Perl EventLog Ad apter for Wind ows p arameters, see “Perl EventLog Adap terfor Windows p arameters” on page 204.

s For EventLog Ad apter param eters, see “LogFile Adap ter param eters” on page 205.

s For SNMP Trap Ad apter p aram eters, see “SNMP Ad apter param eters” on

page 209.

s For IP Adap ter param eters, see Append ix G, “IP Adapters,” on page 489.

Perl EventLog Adapter for Windows parameters

This section describes the specific param eters used by the Perl EventLog Adapter for

Windows. For details about configur ing the BMC Impact Event Log Ada pter for

Window s, see “BMC Imp act Event Log Ad apter for Window s configuration” on

page 211.

MapUseDefaultClass Bool (0–1) indicates whether incoming events that do not match a CLASS

described in the m ap file are map ped to the DEFAULT class

Valid values:

s 0 – events are drop ped (this is the default).

s 1 – events are map ped to the DEFAULT class.

ServerName Cell name name of the cell to which events processed by the Adapter are sent

The cell param eters must be foun d in

MCELL_HOME\ etc\ mcell.dir.

ServerName can contain the n ames of several cells, separated by

colons, such as Cell1:Cell2:Cell3:.... Events are sent to these

cells accord ing to th eir nu merical order. For more information, seeth e mposter/msend documentation in the BMC Impact Manager

System Configuration and M aintenance Guide.

If ServerName is not defined, events are formatted in BAROC and

sent to the standard outpu t.

Table 54 Common parameters (part 2 of 2)




Specific parameters


To use the Perl EventLog Adap ter for Window s, set the Engine param eter in the

mcxa.conf file as follows:

Engine = MA::EEventLog

The defau lt map file is mceventlog.map.

Table 55 describes the Perl EventLog Ad apter param eters.

LogFile Adapter parameters

To use the LogFile Adapter for Wind ows, set the Engine param eter in the mcxa.conf

file as follows:

Engine = MA::ELogfile

The defau lt map file is mclogfile.map .

Table 56 on page 206 describes the LogFile Adapter parameters.

Table 55 Perl EventLog Adapter for Windows parameters


ELResendAll enables restarting th e reading of the EventLog

If this pa rameter is set to 1 , all the events in th e eventlog are resent one tim e.

Default: 0

WARNING : The BMC Imp act Event Log Ad apter for Wind ows EResendAll

param eter is equivalent to the Perl ELResendAll parameter. The parameter

nam es are similar bu t the v alues are d ifferent. For this reason, BMC Softwar e

recomm ends th at you exercise caution w hen u sing them. Be sure to u se a value

of 0 or 1 for the Perl EventLog Ad apter ELResendAll parameter and a value of

Yes or No for the BMC Imp act Event Log Ad apter EResendAll para meter. For

details about configu ration the p arameters for the BMC Imp act Event Log

Adap ter for Window s, see “BMC Impact Event Log Adap ter for Wind ows

configuration” on p age 211.

ELRecoveryIntervalMin recovery tim e interval, specified in m inutes

Unless ELResendAll is set to 1 , an Adap ter processes events that arrived in

the log since it was stop ped . ELRecoveryIntervalMin preven ts processing

of old events if the Ad apter h as been stopp ed for some time. That is, the

Adap ter will process the events that are youn ger than

ELRecoveryIntervalMin.

Default: 1440 minutes (1 day)

ELLogNotRead a string that contains the nam es, separated by a colons, of the event logs the

user does not w ant to read, such as System, Application, or Security



Specific parameters


LogProcessName Strin g none em pty (UN IX on ly) nam e of the p rocess receiving th e kill

HUP command

LogProcessName isnotusedif LogSupportKillHUP=0.

See LogSupportKillHUP on page 209.

LogReadAll Bool (0–1) none 0 ind icates w hether the w hole log file is read the first

time the Adapter starts

Valid values:

s 0 – is not r ead

s 1 – is read

LogReadAllReopen Bool (0–1) none 1 ind icates w hether an Ad apter that d etects that a log

file has changed op ens a new log file from thebeginning or the end

Valid values:

0 – opens from the end

1 – opens from the beginning

LogRecordSeparator Regex none \ n regular expression, often a simple character or

string, that delimits two events

Note: If LogRecordSeparator is empty

(LogRecordSeparator=“”),aneventisfoundassoon

as the regu lar expression encoun ters a match. The

matching regular expression is consu med an d the

remaind er of the file is used to detect the next event.

LogRegExpr Regex n on e em pty con tain s a regu lar exp ression , in Perl 5 style, u sed to

match an event

The pattern variables $1, $2, ... are saved in

$<logVarPrefix>1,$<logvarPrefix>2,...,an dar e

declared in theINPUT_VARIABLESsection of the .map

file.

$<logVarPrefix>0 contains the wh ole pattern .

$complete contains the whole string between two

LogRecordSeparator parameters.

If the regular expression m atches the wh ole string

betweentw oLogRecordSeparator parameters,both

$complete an d$<logVarprefix>0,containth ewhole

event.

If LogRegExpr is emp ty (logRegExpr=""),

LogFieldSeparator is used instead.

Table 56 LogFile Adapter parameters (part 2 of 4)




Specific parameters


LogRegExprGlobal Bool (0–1) none 1 ind icates whether matching with the LogRegExpr

param eter is performed globally

Matching is global when you use the /g mod ifier of

a Perl regu lar expression. In this case, the pattern is

app lied as man y times as po ssible to the string. Each

time the p attern m atches, it is stored in

$<logvarPrefix><n> variables, as explained in

LogRegExpr on page 207. For examp le, if

LogRegExpr=“\w+” an d LogRegExprGlobal=1,

every word of the event is stored in

$<logvarPrefix><n> variables (n>=1).

LogRememberPos Bool (0–1) none 0 ind icates w hether the Adapter persistently

remem bers the position of the last log entry

Valid values:

s 0 – does not remem ber position

s 1 – remembers p osition

Note: This information is stored in

MCELL_HOME\ log\ Adapters\ perl\ elogfile.pos .

LogRotate Bool (0–1) none 0 ind icates w hether a new logfile is created when the

size of the logfile becomes greater than the valu e of

th e LogMaxSize parameter

If a new logfile is created , the old logfile is renam ed

or deleted, depend ing on the value of LogMaxCount.

If the o ld log file is kept , it becom es

<logfile>0[.<ext>],<logfile>0[.<ext>] becomes

<logfile>1[.<ext>], ... an d

<logfile><logMaxCount>[.<ext>] isdeletedif th e

value of LogMaxCount is different from –1.

LogSmartOpen Bool (0–1) none 1 ind icates w hether the p art of the log file th at has not

been consumed is considered as being app ended to

the beginning of the new er log file, when the log file

is replaced

Valid values:

s 0 – not append ed

s 1 – append ed

LogStatPeriod Integer > 5 sec 15 ind icates w hether the Ad ap ter regu larly p erform s

th e stat comman d to check w hether the logfile

exists, to check its i-node on UN IX platforms, or to

check w hether its size has not d ecreased on

Windows platforms





Specific parameters


SNMP Adapter parameters

To use the SNMP A dap ter, set the Engine param eter in the mcxa.conf file as follow s:

Engine = MA::ESnmpTrap

The defau lt map file is mcsnmptrapd.map .

Table 57 on page 210 describes the SNM P Adap ter param eters.

LogSupportKillHUP Bool (0—1) none 0 (UNIX only) If LogSupportKillHUP=1, akill -HUP

comm and is launched on LogProcessName at each

rotation of the log file. Note tha t if LogSupportKillHUP=0 an d LogRotate=1, it is

impor tant to ensure that the p rocess that generates

the events can d etect the rotation.

LogVarPrefix Str in g n on e “ var log” p refix of th e in p ut v ar iables th at cor resp on d s to th e

matching of the event variables$<logVarPrefix>0

to$<logVarPrevix><n>,where<n> isth emaximum

number of matches.

The prefix mu st be defined in theINPUT_VARIABLES

section o f the .map file. Alternatively, the notation

$<logVarPrefix>0-i can be u sed to match anyarbitrarily long list of p atterns.





Specific parameters


Table 57 SNMP Adapter parameters


SnmpDatFile File name name of the .dat file that contains inform ation used to translate incoming

traps

If the p aram eter value is a relative path, the file mu st be located in the

MCELL_HOME \ etc directory. The .dat file is an enhan ced version of the

old .oid file. It can contain ad ditional information to m ap enu merations an d

to extract indexes.

This file contains the resu lts of the outp ut of the BMC Imp act Manager

mib2map tool. Do not attemp t to create this file manu ally.

Default: mcsnmptrapd.dat

SnmpGetIndexes Bool (0—1) starts and stops index extraction, mainly for performance purp oses

By d efault, the ind exes, such as the su ffixed dotted nu mbers of the objectidentifiers (OIDs), are extracted and stored in th e sp ecial $idx input

variable. $idx is a reference on a list of lists.

Valid v alues:

s 0 – starts

s 1 – stops

SnmpLocalAddr IP address specifies which interface to use on a computer w ith tw o or more interface

cards

SnmpOIDFile File name name of the file containing translations from SNMP OIDs to strings

If the p aram eter value is a relative path, the file mu st be located in the

MCELL_HOME \ etc d irectory. The use of SnmpOIDFile is now obsolete. Use

the complete SnmpDatFile parameter instead.

Default: mcsnmptrapd.oid

SnmpPort Integer > 0 port of the UDP SNMP server

Default: 162

SnmpTrapLength Integer > 0 initial value of the buffer that receives SNMP traps

Default: 8192

Use theSnmpTrapLengthpar ameter d efault setting. If you mu st mod ify it, be

aw are that an MC_ADAPTER_ERROR will occur if the SnmpTrapLength

value is smaller than the actual size of the trap .

NOTE

The BMC Impact Manager SNMP Ad apter d oes not respond to INFORM messages that it may

receive, but it d oes parse the SNMP message and generate an event.



Applying configuration changes during run-time


Applying configuration changes during run-time

You can m odify the mcxa.conf configuration file d uring run -time. When the engineman ager detects that the configuration file has chan ged , it stops the cur rently

run ning affected Ad apters, and th en restarts them according to the new values in the

configu ration file.

BMC Impact Event Log Adapter for Windowsconfiguration

The configuration p arameters for the BMC Imp act Event Log Adap ter for Window s

are stored in the follow ing Window s registry key:

You can configure the BMC Imp act Event Log Adap ter for Window s Ad apter by

mod ifying the specified param eter values in the Wind ows r egistry. Table 55 describesthe configuration p aram eters.

"HKEY_LOCAL_MACHINE\SOFTWARE\BMC Software\Eventlog Adapter"

NOTE

For Microsoft Windo ws 2003 Server X64 (32-bit compatibility m od e) only, the correct path to

the registry key for the sp ecific param eters for the BMC Imp act Event Log Ad apter for

Wind ows is “HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\BMC

Software\Eventlog Adapter”.




C h a p t e r 88Defining presentation names

This chapter describes how to ad d or mod ify user-friendly presentation names in the

following BMC Im pact Solutions inter faces: BMC Im pact Explorer , BMC Imp act

Service Model Editor, and BMC Imp act Portal.

This chap ter pr esents the following top ics:

Presen tat ion n am es overv iew . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214Presen tation name resource file locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214

Defau lt presen tation name d efinitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

Crea ting a new presen tation name resource file. . . . . . . . . . . . . . . . . . . . . . . . . . . 216Presen tation name resource files search order . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217

Defin ing presentat ion names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218

Crea ting or mod ifying p resen tation name keys . . . . . . . . . . . . . . . . . . . . . . . . . . . 218Digitally signin g a .jar file with a d igital test certificate . . . . . . . . . . . . . . . . . . . . 220

Enabling or disabling presentation names in BMC Imp act Explorer tool tips . . . . . 221



Presentation names overview


Presentation names overview

By default, BMC Imp act Solution p rod ucts use user-friendly d ata labels ( presentation

names) in th e user interface instead of the internal object names. For examp le, the

presentation nam e Occurred is used in th e BMC Imp act Explorer even t list colum ntitle and th e Sum mary tab instead of the internal slot nam e date_reception.

Table 59 describes the objects for wh ich p resentation names are defined .

Presentation name resource file locations

Presentation n ames are defined within a presentation nam e resource file. The defaultpr esentation nam e resource file is the kb_core_resource.properties file. The location of

th e kb_core_resource.properties file depen ds on which BMC Impact Solutions

app lication you are u sing.

s For BMC Impact Explorer, the d efault p resentation n ames ar e d efined in the

following tw o files:

s InstallDir \ BMC Sof tware\ MasterCell\ conso le \ l ib \ l ang\ kbinfo\

kb_core_resource.properties

Table 59 Presentation names for BMC Impact Solution interfaces

Interface Objects with presentation names

BMC Imp act Explorer -

Events View

s event class nam es

s slot nam es

s enumeration class names and values

s collector nam ess action nam es


Services View

s service mod el class names (comp onent typ es) and slot nam es

s service mod el managem ent class and slot names

s service mod el enu meration class nam es and va lues


Ad ministration View

s policy type n ames

s event class nam es

s slot names - In the Event Selection Criteria column, the internal

slot names are sh own because th is is the actual text of the ECF.

BMC Imp act Portal s event class nam es

s slot nam es

s enumeration class names and valuess service mod el class names (comp onent typ es) and slot nam es



BMC Im pact Service

Model Editor

s service mod el class names (comp onent typ es) and slot nam es





Default presentation name definitions


s InstallDir \ BMC Software\ M asterCell \ console\ lib\ lang\ kbinfo \

kb_deprecated_resource.properties. (contains nam es for slots that app ear on the

Deprecated tab of the BMC Imp act Explorer Events View)

s For BMC Imp act Portal, the kb_core_resource.properties file is located in the

BMC_PORTAL_KIT_HOME/appserver/websdk/tools/jboss/server/all/conf/resources /en_US/smsConso leServer directory.

s For BMC Impact Service Model Ed itor, the kb_core_resource.properties file is

located in th e BMC_PORTAL_KIT_HOME/appserver/websdk/tools/jboss/server/all

/conf/resources /en_US/smsConso leServer directory.

Extracting the presentation name resource files for BMCImpact Explorer (Java Web Start)

The p resentation nam e resou rce file for BMC Impact Explorer (Java Web Start) isprovided in a .jar file and is digitally signed by BMC Software, Inc. with its d igitalcertificate. To edit the pr esentation n ame resou rce file for BMC Impact Explorer (Java

Web Start), you m ust u ncompress the BMC_Portal_Kit_Home/appserver/websdk/tools

/jboss /server/all/modules/smsIX.sar /smsIX.war/kbresource.jar into a temporary directoryusing the following comm and :

jar xvf kbresource.jar

This comman d extracts the kb_core_resource.properties an d

kb_deprecated_resource.properties files.

Default presentation name definitions

The kb_core_resource.properties file map s the interna l nam es of all classes, slots,enu merations, and enu meration values to presentation nam es for the KB BAROC files

that ar e loaded by d efault. The d efault BAROC files load ed ar e located in one of the

following directories:

s On UNIX: $MCELL_HOME/etc/default/SIM/kb/classes/.load or$MCELL_HOME/etc/default/EM/kb/classes/.load

s On Windows: %MCELL_HOME%\ etc\ defaul t\ SIM\ kb\ classes\ .load or

%MCELL_HOME%\ etc\ default\ EM\ kb\ classes\ .load

NOTE

The event slot nam es shown on the Deprecated tab in the BMC Imp act Explorer Events View

do not have presentation nam es by default. This tab shows in parenthesis the recomm end ed

internal slot to use in p lace of the dep recated internal slot.



Creating a new presentation name resource file


If you load a sup plied BAROC file that is not loaded by defau lt, you sh ould define

presentation nam es for the interna l nam es. For instru ctions, see “Defining

presentation nam es” on page 218.

Collector names and action p resentation names are also defined in

kb_core_resource.properties by d efault. How ever, these entries are used by BMCImp act Explorer only and are used pr imarily for localization.

Creating a new presentation name resource file

If you w ant to m odify the exiting p resentation n ames or create new ones, you can

create a new p resentation nam e resource file for any BMC Imp act Solutions

application by follow ing these steps:

1 Create a file with a .properties extension.

2 Save the file.

3 (BMC Impact Explorer only.) Place the r esource file in the

Inst al lDir \ BMC Software\ M asterCell \ console\ lib\ lang\ kbinfo \ directory.

4 (BMC Impact Explorer only.) Add the base nam e of the resource file to the value of

kb_info_resources param eter in the Inst al lDir \ BMC Software\ M asterCell \ console\ etc\ ix.properties file using the

following format:

5 Follow the p rocedu re, “Creating or mod ifying presentation name keys” on

page 218, to add presentation name en tries for your classes and slots to the new

.properties file that you h ave created.

NOTE

When you change or rep lace the original presentation n ame r esource file for BMC Imp act

Explorer (Java Web Start app lication), you mu st prov ide one that is signed w ith your

organization’s digital certificate. For instructions on digitally signing a new presentationname resource .jar file, see “Digitally signing a .jar file with a d igital test certificate” on

page 220.

WARNING

To preserve the .properties suffix, save as typ e All Files. Do not save the .properties file as

a .txt file. The configura tion changes m ay not be recognized.

kb_info_resources=ResourceFileName,kb_core_resource, kb_deprecated_resource



Defining presentation names


Presentation name resource file search order for BMCImpact Service Model Editor

The BMC Imp act Service Model Editor looks for p resentation n ame keys in the

BMC_PORTAL_KIT_HOME/appserver/websdk/tools/jboss/server/all/conf/resources/ en_US/smsConsoleServer/kb_core_resource.properties file.

If you w ant to ad d custom classes or extend existing classes to add new attributes,

you can ad d them to the kb_core_resource.properties file. For more inform ation abou t

mod ifying pr esentation nam e keys, see “Defining presentation nam es” on page 218.

Defining presentation names

Perform these procedu res to define user-friendly presentation n ames for new event

classes, comp onen t types, slots, enu merations, or policy typ es.

Creating or modifying presentation name keys

The entr ies in kb_core_resource.properties have the form

where value is the p resentation na me. The value can contain space characters.

Table 59 lists the formats for the p resentation n ame key.

NOTE

If you custom ize presentation na mes in the default kb_core_resource.properties file, you w ill

need to m erge your customizations into a newer file wh en you up grade.

key=value

Table 60 Presentation name key formats

Object Key format

Class CLASS.InternalClassName

Slot SLOT.InternalClassName.InternalSlotName

Note: Use the class nam e where the slot is originally defined (the su perclass).

Enumeration ENUM. InternalEnumerationN ame

Enumeration Value ENUMVAL. InternalEnumerationN ame. InternalValueName



Creating or modifying presentation name keys


To create or modify presentation name keys

1 In a text editor, open either th e kb_core_resource.properties file or the new

.properties file that you h ave created. For instructions on creating a new .properties

file, see “Creating a n ew p resentation nam e resource file” on page 216.

2 To define the p resentation n ame for an even t class, add a line w ith the followingformat to the resou rce file:

3 To define the p resentation n ame for an event slot, add a line w ith the following

format to the resou rce file:

4 To define the presentation name for a n ew p olicy type, add a line w ith the

following form at to the r esource file:

5 To define the p resentation name for a policy slot, add a line with the following

format to the resou rce file:

6 To define the presentation nam e for a service mod el comp onent typ e, add a line

with the follow ing format to th e resour ce file:

7 To define the presentation nam e for a service mod el comp onen t slot (attribute),

add a line with th e following form at to the resource file:

8 When you h ave finished ad ding or mod ifying the presentation nam es in the

.properties file, save and close the file.

CLASS.eventClassName=eventPresentationName Event

SLOT.eventClassName.slotName=slotPresentationName

CLASS. policyTypeName= policyTypePresentationName Policy

SLOT. policyTypeName.slotName=slotPresentationName

CLASS.BMC_ClassName=ComponentTypeName

SLOT.BMC_ClassName.slotName=slotPresentationName

WARNING

To preserve the .properties suffix, save as typ e All Files. Do not save the .properties file as

a .txt file. The configura tion changes m ay n ot be recognized.



Digitally signing a .jar file with a digital test certificate


9 (BMC Impact Explorer only.) Deploy th e revised files to all machines on w hich BMC

Imp act Explorer is installed .

10 (BMC Impact Explorer only.) If you are u sing BMC Imp act Explorer (Java Web Start

application), digitally sign the .jar file using the instructions in “Digitally signing a .jar file

with a d igital test certificate” on p age 220.

11 Stop an d star t the BMC Imp act Solutions ap plication.

Digitally signing a .jar file with a digital test certificate

If you chan ge or rep lace the original presentation name resource file for BMC Imp act

Explorer (Java Web Start ap p lication), you mu st prov ide one that is signed with you rorgan ization’s d igital certificate. To accomp lish this task, you mu st have a JDK 1.2 or

JDK 1.3 keytool and jarsigner (located in the J2SE SDK bin d irectory) in your

environment path.

1 Create a new key in a new keystore:

A Enter the following command .

keytool -genke y -keystore keystore_filename -alias my_alias

B Enter the requ ested information for each op tion.

For examp le: keytool -genkey -keystore myKeystore -alias myself . This comman dcreates a new key in the keystore file named myKeystore on disk.

2 Create a self-signed test certificate by follow ing these steps:

A Enter the following command .

keytool -selfcert -alias <my_alias> -keystore <keystore_filename>

B Enter the password at the p rompt.

Generating the certificate takes a few m inu tes.

3 Verify tha t the key and certificate creation w ere successful by following these

steps:

A List the contents of the keystore by entering the following command :

keytool -lis t -keystore <keys tore_filename>



Enabling or disabling presentation names in BMC Impact Explorer tool tips


The resulting listing shou ld appear a s follow s:

4 Sign th e .jar file with the test certificate by following th ese steps:

A Enter the follow ing comm and .

jarsig ner -keystore key st ore_filename jar_fil ename al ias

B Repeat this step for all the .jar files that you have created or changed.

After you have d efined p resentation n ames, they are available for automa tic

dow nload by users w ho are using the BMC Impact Explorer consoles that are Java

Web Start app lications.

Enabling or disabling presentation names inBMC Impact Explorer tool tips

A BMC Imp act Explorer u ser can view the intern al object nam es as tool tips w hen th e

mou se pointer is over

s a presentation name in a colum n head er

s a presentation name that labels a slot value (for examp le, in an Event Details tab)

s the label of a drop -down list or field that show s a pr esentation n ame,

s a slot presentation n ame in a list box (as in the Edit Slot Order w indow )

s a class presentation nam e in the Class Chooser wind ow

s a class presentation nam e in either of the Ad ministration tab navigation trees

Figure 23 Listing of the contents of a keystore file

Keystore type: jks

Keystore provider: SUN

Your keystore contains 1 entry:myself, Tue Jan 23 19:29:32 PST 2001, keyEntry,

Certificate fingerprint (MD5):

C2:E9:BF:F9:D3:DF:4C:8F:3C:5F:22:9E:AF:0B:42:9D

NOTE

A self-signed test certificate shou ld on ly be u sed for intern al testing, because it does n ot

prov ide any gu arantees about th e identity of the user an d, therefore, cannot be trusted. You

can obtain a tr ust -wor thy certificate from a certificate auth ority, such as VeriSign, use it to sign

th e .jar file when th e app lication is pu t into prod uction.



Enabling or disabling presentation names in BMC Impact Explorer tool tips


Tool tips are not show n for

s classes in the Services tab Of type list

s classes or enu meration values in lists such as event an d d ata lists or event selection

criteria lists

To enable the d isplay of internal nam es in tool tips, select the Show Internal Names in

Tool Tips on the Global tab of the Edit Configuration d ialog.

To always display internal names instead of the presentation nam es in BMC Impa ct

Explorer , set the value of the kb_disable_resources param eter in

Inst al lDir \ BMC Sof tware\ MasterCell \ console\ etc\ ix.properties to true. There is no w ay

to display pr esentation n ames in some BMC Imp act Explorer views and internal

nam es in others.



Understanding the StateBuilder and gateways


Understanding the StateBuilder and gateways

The StateBuilder is an executable, statbld.exe, located in th e MCELL_HOME \ b in

directory. It records saved states of the cell at regu lar intervals. When it starts, the cell

loads its last saved state (mcdb). All transactions it perform s are stored in atransaction file (xact). As soon as the transaction file reaches a certain size, or after a

certain period, the StateBuilder is started. It produ ces a n ew saved state from the

previous file and from the tran saction file. When the cell terminates and restarts, any

trailing transaction file is first processed by th e StateBuilder to produce a new saved

state. A history of saved states and correspon d ing transaction files can be kep t. The

mcdb an d xact files of that h istory have their timestam p in the file nam e.

All mcdb an d xact files are located in th e MCELL_HOME \ l og \ cellName directory. TheStateBuilder ru ns as configu red in the cell’s mcell.conf file, which is d etailed in

“StateBuilder configuration file” on page 225. The configu ration of how the

StateBuilder itself operates is in the statbld.conf file.

Table 61 on page 224 lists the file naming conven tions for the StateBuilder.

There is also a statbld.trace file for the configuration of StateBuilder tracing. For

further information, see “Configur ing tracing for StateBuilder” on page 233.

The StateBuilder uses th e gateway.export file in conjun ction with its statbld.conf file to

export event d ata. For more inform ation, see the “StateBuilder configuration file”and

“Exporting events” on page 231.

Table 61 StateBuilder file name conventions

File Description

mcdb state file the cell uses at startup

mcdb.0 new state file being generated

mcdb.t saved state history files, where t = timestam p

Timestamp t in the mcdb.t file correspon ds to the time w hen the state is

created.

mcdb.lock lock file ind icating StateBuild er activity

xact transaction file generated by th e cell

xact.n terminated transaction file, wh ere n=1 is the oldest transaction file

xact.t.n terminated transaction history file correspond ing to mcdb.t

Timestamp t in the xact.t.n file refers to th e mcdb.t file to wh ich th e

transactions lead .



StateBuilder configuration file


StateBuilder configuration file

The state configu ration file, statbld.conf , is located in th e MCELL_HOME \ etc directory.Table 62 lists the statbld.conf param eters, which use the sam e syntax as all BMC

Imp act Solutions configu ration files.

statbld return codes

Table 63 lists the retu rn cod es for statbld.

Table 62 statbld.conf Parameters

Parameter Description Default value

Export uses Boolean values to specify w hether to export d ata No

ExportConfigFileName sets path to the gateway.export file %H/ etc/ %N/ gateway.

export

ExportDiscarded indicates wh ether discarded events are includ ed in the

export file

Discarded events are those that were drop ped in thefirst four rule p hases: Refine, Filter, Regu late, and

New (Update).

No

ExportTriggerArguments sets the argum ents to be passed to the executable

serving as the export trigger program

Value is interp reted as a sequ ence of space-separated

argu ments, so spaces within each argum ent are not

allowed.

blank; no argu ments

ExportTriggerProgram sets the program to execute after exporting d ata

The value is interp reted as a p ath. See the mcell.conf

file for special syntax for a p ath.

blank

StateHistoryCount sets the nu mber o f state files to retain in th e history

Each time a new saved state is prod uced, the oldest

state is removed .

3

Table 63 statbld return codes (part 1 of 2)

Return code Description

1 failed to build new mcdb

2 failed to update history files

10 early initialization failu re

37 process handling module initialization failure

47 StateBu ild er sp ecific file access in itialization failu re



Gateway configuration


Gateway text parameters

Text pa ram eter values consist of literal text, possibly mixed w ith references tovariables and with escape sequences, as show n in Table 65.

Table 64 Gateway configuration parameter predefined variables

Variable Description

$CLASS class nam e

$CONTEXT context nam e:

s Permanent—event perm anently in DB (un til out of d ate)s Processed—discard ed by ru le processing

s Regulated—discard ed by regu lation

s Filtered—discard ed by filter

s Refined—discard ed by r efine

s Received—discarded immediately

$DATE date stamp

$TIME time stamp

$MODNMS nam es of mod ified slots (empty for “new”)

$GHANDLE event ID in gatewa y

$CNAME cell nam e of cell connecting to gatew ay$CHANDLE event ID in cell

$VALUE slot value of slot slot

$NAME selected slot n ame (only for body parameter)

$VALUE selected slot value (only for body parameter)

$MODS all mod ified slots (emp ty for “new”)

$ALL all slots (only for slots parameter)

$ALL cls all slots, but limited to class cls

(only for slots parameter)

$MAP.map val mapp ed value of val using map

val can be a literal or a va riable reference

Table 65 Gateway Configuration Parameter Text Values

Character Name

\\ backslash

\s space

\n new line

\r carriage retur n

\t tab

\0ddd character cod e in octal (0, 1, 2, or 3 d igits d )





References to variables that are not followed by pu nctua tion or space characters must

be enclosed in curly brackets ( { } ). For exam ple, $NAMEabc is invalid ;

${NAME}abc is correct. Non-printable characters and hard spaces must be expressedwith an escape sequence. String values for p arameters are considered from the first

non-white space character up to the first (non-escaped) wh ite space character.

Table 66 on page 228 lists the gateway.export file parameters.

Table 66 gateway.export file parameters (part 1 of 2)


Communication

parameters

protocol sets the comm un ication p rotocol. Both categories, new event an d

modification, use the same protocol. The last one specified is used. The

default value is MCELL.

Contents

parameters

cond sets the cond ition for a slot to be included in the $ALL variable. Use

always to always includ e the slot. Use propagate to includ e the slot if its

value is different from th e default value for th e slot and it is able to beparsed . The d efault value is propagate for new, and always for mod.

drop lists slots that mu st be dropp ed from th e $ALL an d $MODS variab le. List of

comma sep arated slot nam es. Only real slot names can be used . The

default value is [], so no slot is dropp ed.

add lists ad ditional new slot definitions. List of comm a separ ated settings in

the format slotname=slotvalue. slotname represents the nam e for

the new d efined slot and slotvalue defines the value of the n ew slot. The

default value is [], so no slot is add ed.

slots sets and or ders th e slot nam es to be included . Non-base class slots mu st be

prefixed w ith ClassName: . The list can also contain variable references to

includ e those values among regu lar slots.

The default value is [], so no slots are exported.

modify lists slots whose m od ifications resu lt in a message. Mod ifications of slots

that are n ot includ ed in th is list are ignored. The default value is [], which

means th at every slot modification is included .

map.name Defines the map table with the nam e name

List of comm a separated settings in the format

original_value=converted_value

original_value represents a value that h as to be replaced andconverted_value is the replacement value. Both valu es mu st be literal

values.





Gateway configuration value mapping

For some destinations, it is necessary to map values from a cell domain to a gateway

dom ain. You can implement value map ping by defining a m ap table and u sing thevalue map ping function.

You d efine a value map table using the p arameter map suffixed with th e nam e of the

map table.

map.name=[original_value=converted value,original_value=converted value, etc.]

name represents the name you give the map table; original_value is the value to be

replaced an d converted_value is the replacement value.

You convert a value ap plying a m ap table, by using the variable $MAP.

$MAP.name(value)

If the specified va lue cannot be found in the map table, it is not rep laced.

Format

parameters

init text or value to be printed at the beginning of each expor t message. The

default value is blank. At least one of the init, body, or term parameters

mu st be specified to p opu late the export file.

body text or value to be printed for every slot to be includ ed; can u se the

variable, $NAME (name of the slot) and $VALUE (value of th e slot). The

default value is blank. At least one of the init, body, or term parameters

mu st be specified to p opu late the export file.

term text or value to be printed at the end of each event. The default value is

blank. At least one of the init, body, or term parameters must be

specified to p opu late the export file.

separator sets the separator character or string to u se between slot values. The

default value is nothing.

quotable sets the characters lead ing to qu otation wh en ap pearing in a slot value. If

the param eter value is emp ty, slot values are never quoted . The defaultvalue is stand ard MRL qu otation rules.

openquote sets the opening qu otation character to use for values that m ust be qu oted.

The default value is a single quote (‘).

closequote sets the closing qu otation character to u se for values that m ust be qu oted.

The default value is a single quote (‘).

escapequote determ ines how to escape a quotation m ark inside a quoted valu e. The

default value is a single qu ote (‘).

Table 66 gateway.export file parameters (part 2 of 2)




Exporting events


In the examp le show n in Figure 26, the first two lines configu re the expor t file so that

it expor ts new events an d mod ified even ts differently. Specifically,

slots.new=[$ALL] exports all slots of new events to the d atabase andslots.mod=[event_handle,$NAME,$VALUE] exports event_handle, slot nam e, and

value of events that are m od ified to the export file.

Exporting events

Events received in the cell can be expor ted to a flat file that r esides on th e same

comp uter as th e cell. The exported events then can be used in third -party pr odu cts forarchiving and data m ining. Also, they can be exported to a p rogram on another

compu ter by using the BMC Impact Solutions Gateway.

To expor t events, you configu re the statbld.conf an d gateway.export files.

Modifying a statbld.conf file to export events

To modify the statbld.conf file to generate an export file, set Export=Yes and removeth e # sign that p recedes it. If you r etain the default value ExportDiscarded=No,

events that were d iscard ed in th e first four r ule phases—Refine, Filter, Regulate, and

New / Upd ate—are not included in the export file. Set ExportDiscarded=Yes toinclud e these events in the export file.

Use the ExportConfigFileName parameter in the statbld.conf file to set th e location

of the export configuration file. By d efault, the location is the gateway.export file in thecell-specific subdirectory of MCELL_HO ME \ e tc.

When the data files are generated , the cell can trigger a program , which can be used

to import th e d ata autom atically into another prod uct, such as a d atabase. This can becontrolled using th e ExportTriggerArguments and the ExportTriggerProgram

param eters, wh ich ar e set also in the statbld.conf file. The argu men ts specified in

ExportTriggerArguments are passed as argu ments to the p rogram , if any. These are

always followed by the p aths to the n ew event and mod ification export files, in th at

order.

Figure 26 Command to configure the export file

slots.new=[$ALL]

slots.mod=[event_handle, $NAME, $VALUE]



Modifying a gateway.export file to export events


The export process produ ces two separate files that ar e located in th e

MCELL_HO ME \ log\ cellName d irectory. These tw o files are exp.TimeStamp.new,

wh ich contains all new events since the p revious export, and exp.TimeStamp.mod,which contains all mod ifications of events after they have first passed th rou gh all rule

phases. The TimeStamp part of the file name correspond s to the timestamp part u sed

in the mcdb an d xact file names an d en ables archiving of multiple export files.

Because th e primary goal of exporting events is to import the d ata into another

format for other u se, BMC Software recommend s that you r emove the export files as

soon as their contents hav e been archived. The easiest way to d o this is to have them

removed by the program that is triggered at the end of the export.

Modifying a gateway.export file to export events

In a gateway.export file, you can configure w hat d ata goes into the export file and h owthat d ata is formatted. A d efault gateway.export file exists in th e MCELL_HOME \ e tc

directory. Copy th e gateway.export file to the MCELL_HOME \ etc\ cellName directoryand edit the copy.

By d efault, the gateway.export file has the format show n in Figure 27.

Using th e default values in the gateway.export file for new events prod uces outpu t inthe format sh own in Figure 28.

Figure 27 gateway.export file format

# Export Gateway Configuration

#

cond=alwaysslots.new=[$ALL]

slots.mod=[$MODS]

body=$VALUE

term=\n

separator=,

quotable=,"

openquote="

closequote="

escapequote="

Figure 28 gateway.explore file output for new events

0,1010183001,1,,,,,,,,OPEN,,[admin],1,OK,,,0,0,0,0,

mc.exp.000000001,0,['exp:1'],[],[],[],[],[],0,[],exp,

10.0.9.10:1981,28698

0,1010183001,2,,,,,,,,OPEN,,[admin],1,OK,,,0,0,0,0,

mc.exp.000000002,0,['exp:2'],[],[],[],[],[],0,[],exp,

10.0.9.10:1981,600



Configuring tracing for StateBuilder


Using th e default values in the gateway.export file for mod ified events produces

outp ut in the format show n in Figure 29.


You configu re StateBu ilder tracing in th e MCELL_HO ME \ etc\ statb ld .trace file. The

statbld.trace file uses the same p arameters as the mcell.trace configuration file. For

details on the cell tracing configuration, see the BMC Impact Solutions: Event

Monitoring Operator’s Guide.

Figure 29 gateway.explore file output for modified events

mc.exp.000000001

exp

10.0.9.10:1981

28698

mc.exp.000000002

exp

10.0.9.10:1981

600

ACK

1010183062

mc.exp.000000003

exp

10.0.9.10:198128698



Part 2 Event management administration 235

2Part

Part 2Event managementadministration


Chapter 10

Even t m anagem ent overv iew . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237

Chapter 11

Working with th e Dyn am ic Data Ed itor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245

Chapter 12

Imp lemen ting even t m anagem ent policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

Chapter 13

Creating and imp lemen ting u ser-d efined policies . . . . . . . . . . . . . . . . . . . . . . . . . . 351

Chapter 14Building even t groups and image view s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359




C h a p t e r 1010Event management overview

BMC Event Manager allows you to d etect IT-related problems and to plan the fastest

resolution before th ere is an imp act on critical IT services.

This chap ter pr esents the follow ing topics:

Even t man agement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237

Even t collection sou rces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238Event m anagem ent in BMC Impact Explorer console . . . . . . . . . . . . . . . . . . . . . . 239

Event flow for service impact management an d even t managem ent . . . . . . . . . 241

BMC Im pact Explorer Ad min istration View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242Event managem ent policy d efinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243

Dynamic da ta d efinition u sing the Dynamic Data Ed itor . . . . . . . . . . . . . . . . . . . 243

BMC Im pact Manager cell man agement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243

Event management

Event man agem ent is the collection, correlation, enr ichm ent, and m anipu lation of

events across the enterp rise to enable IT operations staff to focus th e prop er resourceson the most critical events. Event man agement is requ ired to imp lement service

impact man agement because events are associated with service mod el comp onents

and contribute to the compu tation of status of those comp onents.

The BMC Event Manager solution formu late

s collects events from IT comp onents and other event m anagemen t systems through

its event ada pters and other BMC Software app lication-specific integration

products

s processes events to enable faster problem detection and resolution in BMC Impact

Manager cells



Event collection sources


s au tomates managemen t and corrective actions in the BMC Impact Explorer

console

s displays events in logical group s and graph ical image views in th e BMC Imp act

Explorer console

s integrates with help desk and notification applications

Event collection sources

BMC Impact Manager collects source event data through event adapters or collectsexisting events from other event m anagement p rodu cts through various integration

prod ucts. Event ad apters and integrations prep are the source event data and convertthe events into Basic Recorder of Objects in C (BAROC) language form at for

processing by the BMC Impact Manager event p rocessor.

Using BMC Imp act Event Ad apters or BMC Imp act Event Log Adap ter for Window s,

source event d ata can be collected from

s operating system and ap plication log files

s SNMP typ e 1 and type 2 traps

s a Telnet, UDP, or TCP data sou rce

For m ore information on event adap ters, see the BMC Impact Solutions: Event Adapters

Installation and Configuration.

Using the ou t-of-the-box integrations w ith PATROL or PATROL Enterp rise Manager,BMC Imp act Manager can accept events (or alerts) that h ave already been processed

by those systems.

With the BMC Imp act Integration Developer’s Kit, you can develop a custom solution

to obtain sou rce event d ata from an IT app lication or infrastructure mon itoring

solution.



Event management in BMC Impact Explorer console


Administration view in BMC Impact Explorer

The Adm inistration view provides interfaces for editing

s event m anagemen t p olicies

In the Event Managemen t Policies tab, service ad ministrato rs and serviceman agers can d efine how an event shou ld be p rocessed by the cell after it has been

received.

s dyn amic data (in the Dyn amic Data Editor)

A service ad ministrator or service m anager u ses the Dynam ic Data Editor to d efinedata classes for u se in even t man agemen t ru les or service models. To define the

data instances, the service ad ministrator or service manager m ust first define a

data class. A service admin istrator or service manager can also use the Dynam icData Editor to define alias formu las and grant access to comp onents and

relationships.

In add ition, a service ad ministrator or service ma nager can also perform comm and s

to stop, pau se, restart, or reconfigure a cell from th e Adm inistration view.

Services view in BMC Impact Explorer

Service manager s can view serv ice mod els that rep resent a company’s businessservices in the BMC Impact Explorer Services view. The service model comp onen ts

are organized into hierarchical relationships th at can then be navigated by operators

and service manager s from th e Services view.

In the Services view, the service manager or IT operations staff can d etermine

wh ether a service model comp onent consum es the services of another service mod el

comp onent (consum er) or wh ether it provides service to another comp onent(provider). The status of the p rovider component has an impact on the status of the

consum er component by m eans of its impact relationship.

Service manager s and IT operations staff can d etermine the root cause of a problem or

the imp act that a service mod el comp onent ha s on a business service in the RelatedComponents tab of the Services view.

For more information, see BMC Impact Solut ions: Event Monitoring an d BMC Impact

Solutions: Service Monitoring.



Event flow for service impact management and event management


Event flow for service impact management and eventmanagement

Service impact m anagement begins with the organ ization an alyzing h ow various IT

assets form th e infrastru cture th at d elivers a critical business serv ice. First, theorgan ization decomp oses its key business p rocesses and iden tifies the IT services that

sup por t those processes. Next, the service man ager catalogs the IT assets or obtains

the information from a configuration or asset managem ent system. With this

information gathered , the service manager can d esign a service model and the servicemodel components, or d ata classes, that rep resent a bu siness process, its users, and th e

related IT services.

Service model development in BSM

In the BMC Impact Service Model Editor comp onent of the BMC Imp act Portal, aservice manager d efines the service mod el componen ts that symbolize the real IT

assets that u nd erlie the delivery of services, such as ap plications, servers, and

databases; and the logical assets, such as u ser grou ps, business p rocesses, and

geograp hic locations. The default BMC Atrium CMDB Comm on Data Mod el (CDM)

provides th e d efault compon ent types u sed by the BMC Imp act Service Model Editor.

The service manager d efines the interdep enden cies of these comp onents and map s

the event flow to the compon ents into the mod el. A service mod el comp onent canconsum e the services of another component (consumer relationship), provide services

to another comp onent ( provider relationship), or both .

If an ap propr iate subclass does not exist or is too generic, a service manager or serv iceadm inistrator can extend the CMDB class hierarchy by ad ding a new subclass

definition. Or, you can extend an existing class definition by add ing one or more

attribu tes to store comp onen t-specific inform ation. You m ust m ake these changes to

the CMDB Common Data Model (CDM) by using th e BMC CMDB Class Manager

console. For more information, see the BMC Atrium CMDB Installation and

Configuration Guide.

All service m odel comp onent instances and related data in the service m odel are

stored and man aged in the BMC Atrium CMDB. The service man ager pu blishes the

service model to the associated BMC Imp act Manager cells, wh ich u se it in serv iceimp act management.

Service impact management in BSM

Each BMC Imp act Manager cell runn ing a SIM Know ledge Base processes the events

from the va rious contribu ting IT assets, associates the events with the service mod el

comp onents that rep resent those assets, and an alyzes the relationships amon g the

componen ts to determine the consolidated status of services to prov ide real-time,

adap tive service ma nagement information.



BMC Impact Manager cell management





C h a p t e r 1111Working with the Dynamic DataEditor

This chap ter d escribes the Dynamic Data Editor. It contains th e following top ics:

Abou t d ata classes and dynam ic data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246

Naviga ting the Dyn am ic Data Ed itor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246

Navigat ion pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

Toolbar functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248

Filtering and sor ting th e Da ta List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248

Filter ing slots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248

Sorting d ata fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

Wor king w ith data instan ces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252

Extended Deta ils tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

Intern als tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253Data in stance context m enu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

Ad ding a n ew data instan ce. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

Editing slots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255Exporting data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256



About data classes and dynamic data


About data classes and dynamic data

A data class is the type of class used to d efine dyn amic data. Dynamic data fun ction as

contextual variables that can p rovide d ata values to ru les and policies du ring event

processing. By u sing d ynam ic data, you can create generic event m anagement rulesand policies that app ly broadly. Using dyn amic data greatly simplifies the creation

and maintenance of the event managem ent rules.

For example, without u sing d ynamic data, if you w ant to create a rule that changes

the severity of an event based on the host nam e of a device, you mu st create a ru le foreach h ost name. Using d ynam ic data, you can d efine the host nam es and

correspond ing severity as data instances and reference them from one generic rule,

rather th an w riting on e ru le for each possible host nam e. To d efine a d ata instance,the service adm inistrator or service man ager m ust first define a new data class.

As new hosts are add ed to the en vironment, the service adm inistrator or serviceman ager add s new data instances dynam ically throu gh the BMC Imp act ExplorerAdmin istration View, using the CLI or an API, or by mean s the rules themselves.

Event m anagement rules do not need to be recomp iled to u se new d ata instances.

Dynamic data definition using the Dynamic Data Editor

Dynamic data is contextual reference data th at is stored in the event r epository and

up dated w henever the context changes wh ile the cell is run ning. Its function is

similar to a global variable. An ad min istrator uses the Dynam ic Data Editor to d efine

da ta class instances for u se in event man agement ru les or service mod els. To define

the d ata instances, the adm inistrator must first define a data class. See Chapter 11,

“Working with the Dynamic Data Editor” an d BMC Impact Solutions: Knowledge Base

Development Reference Guide for information about d ynam ic data.

Navigating the Dynamic Data Editor

You can u se the Dynam ic Data Editor to add a d ynamic data instance to use as acontextual variable in MRL rules and policies (“Add ing a new d ata instance” on

page 253).

This section discusses the basics of how to nav igate the Dynamic Data Editor.



Navigation pane


Navigation pane

In the Dynamic D ata Editor tab on the Administration view you can view th e dataclasses for a cell in a h ierarchical tree, as illustrated in Figure 31.

Figure 31 Dynamic Data Editor Navigation Pane

Table 68 lists the par ts on th e Adm inistration Tab N avigation p ane.

Table 68 Administration tab navigation pane (part 1 of 2)

# Name Description

1 Dynamic D ata Editor tab id en tifies th e d y nam ic d ata ed itor

2 cell group icon identifies a cell group

3 cell icon identifies a cell

4 DATA class root class to which all data classes belong

1

23

45

6



Filtering slots


1 Click on the Slot Qui ck Filter button or the dow n arrow to its right to display

the Slot Qu ick Filter d ialog box, show n in Figure 33, in wh ich you set the filter

criteria.

Figure 33 Slot Quick Filter dialog box

2 From the Slot list, select the slot n ame.

3 From the Operator list, select the sp ecific operator w ith w hich the filter acts.

4 In the Value box, enter the value with w hich you wan t to filter the Data List.

5 Click OK.

The filter you sp ecified app ears in p lace of the Slot Quick Filter bu tton an d th e da ta

instances that meet the criteria are displayed in the Data List, as show n inFigure 34.

For illustration pu rp oses, the Data List is filtered by Slot nam e equals Bru ssels.



Sorting data fields


Sorting data fields

You can sort fields in the Data List using two meth ods: a mu ltiple colum n sort ord eror single-click on a column to sort imm ediately by that column .

To sort using multiple column sorting

Designating m ultiple colum ns for a sorting order is useful in r esolving sort ord er

conflicts in the d ata list. Mu ltiple column sorting fun ctions as th e following

illustrates. Set a m ultiple column sort order for a maximum of three columns withthese steps.

1 Right-click on a colum n head to disp lay the Slot Order Ind icator.

2 Select the ord er position desired for that column .

The Slot Order Indicator perm its you to select a colum n as having no influence onthe sort order, or as first, second or third in the ord er.

3 Right-click next on the colum n you want to includ e in the sort order.

4 Select the ord er position desired for that column .

5 Repeat if you wan t to establish a third column in the sort order.

An alternative method of multiple-column sorting is to press the Ctrl key and single-

click on a header to add that colum n as th e next column in the sort ord er. That is,

pressing Ctrl and single-clicking on a colum n sets it as the first in the sort order,

pressing Ctrl and single-clicking on th e next column sets it as the second in the sort

order, and the third colum n is set as the third in the sort order by again p ressing the

Ctrl key and single-clicking on the column head er.

Currently only three colum ns can be includ ed in the sort ord er. Pressing the Ctrl key

and single-clicking on a four th column will designate it as third in the sort ord er inplace of the colum n p reviously d esignated as third. Also, pressing the Ctrl key and

single-clicking on a colum n that is part of a sort ord er w ill remove it from th e sort

order. The remaining colum ns in th e designated sort order will reposition in the sort

NOTE

When you select the first column to includ e in your sort ord er the only op tions available in

the Slot Ord er Indicator are None an d First. After you designate a column as first in the sort

order, the op tion Second is available in th e Slot Ord er Ind icator w hen y ou right-click on the

second colum n. The Third option is available when you h ave designated a colum n as

Second in the sort ord er.



Working with data instances


order to replace the one that has been rem oved. For example, if you p ress the Ctrl key

and single-click on the column p reviously designated as first in the sort ord er, it will

be removed from th e order an d the two rem aining w ill move from second to first andfrom third to second in the new sort ord er.

Remember the following facts about sorting:

s Only if there is a sorting conflict in the First sort column w ill the sorting beresolved by u se of the Second sort colum n.

s The sorting w ill extend to the Third sort column only if there is a sorting conflict in

the Second sort colum n.

s Establishing a m ultiple column sort simp ly ensures tha t any sorting conflicts thatmay arise can be r esolved to the third column level.

If you h ave established a m ultiple sort ord er in the Data List, clicking on on e of thesort order column s toggles that colum n’s d isplay between ascend ing and descending

order, as indicated by the sm all arrow next to the sort order n um ber in the colum n

head.

To sort using single-click sorting

Sorting also can be done by single-clicking on the colum n you want to u se as the basis

of your Data List sort. Even if a mu ltiple sort ord er has been established , as in thepreced ing section, you can click on any colum n that is not p art of the designated

mu ltiple sort ord er to reset sorting. This action establishes single colum n sorting an dthe colum n on wh ich you clicked is d esignated as the First, and only, column in thenew sort order.

Working with data instances

From the Ad ministration view, you can ed it and m anipu late a cell’s dyn amic datainstances. All classes that a re visible in th e Ad ministration View are su bclasses of the

base data class DATA and MC_SM_DATA. Subclasses of MC_SM_DATA are shown in thenav igation pan e, bu t data instances are not sh own for these classes. Each cell’s da ta

class d efinitions reside in its Knowledge Base.

To define d ata instances in the Ad ministration view for a custom data class, you mu stfirst d efine th at d ata class in the KB of the cell. For further inform ation, see the BMC

Impact Solut ions: Knowledge Base Development Reference Guide.



Extended Details tab


Extended Details tab

The Extend ed Details tab displays extended d etails of a selected d ata instance.

Internals tab

The Internals tab disp lays the internal da ta as defined on the base DATA class.

Data instance context menu

The Data List of the Ad ministration view in BMC Imp act Explorer p rovides GUIelements to assist you in w orking w ith a cell’s dyn amic data . Right-click on a da ta

instance in this p ane to d isplay the pop -up context menu . Discussion here focuses on

th e New , New Copy, Edit, and D elete pop -up context menu op tions.

Adding a new data instance

This section d escribes how to create a new d ata instance.

To create a new data instance

1 Right-click on a d ata instan ce.

2 Select the New pop -up m enu op tion to display the New tab in the Details pan e of the Ad ministration View.

The fields on th e New tab are the slots for w hich data inform ation can be entered

for this new d ata instance. The fields with a wh ite backgrou nd can be edited; fields

with an asterisk are required.

The un ique data iden tifier slot (mc_udid) has a white background and is emp ty.

NOTE

The mc_udid slot information is assigned by the cell and BMC Software recommend s that

you allow th e cell to assign this value rather than entering one of your ow n.



Adding a new data instance


The cell assigns a valid va lue for this slot. The slot fields th at are d imm ed w ill be

completed au tomatically by the cell. The on ly exception to this is the list associated

with the Type field tha t permits you to select from sp ecified op tions, as shown inFigure 35.

Figure 35 Type field list

3 Click OK to comp lete the new data instance and close the New tab.

The success or failure of your at temp t to create a new da ta instance will be

reflected in the message bar at the bottom of BMC Imp act Explorer w indow.

Figure 36 illustrates a n otification of a failed a ttemp t to create a new d ata instance.

Figure 36 Message bar

To create a new data instance with the New Copy option

Unlike the New menu option, the New Copy option r equ ires you to righ t-click on a

selected d ata instance in the Data List of the Ad min istration View to d isplay a Newtab in the Details pane of the Ad ministration View in BMC Impact Explorer wind ow,

as shown in Figure 37. Note th at certain of the ed itable fields contain slot information

that is copied from the selected d ata instance in the Data List.



Editing slots


Figure 37 New data instance created with the New Copy option

The New Copy m enu option provides the same selection in the typ e field list as the

New menu option, as shown in Figure 38.

Figure 38 Type field List

When you have entered or edited th e app ropr iate slot information, click OK to create

the new data instance and close the New tab. The su ccess or failure of your attem pt to

create a new data instance is reflected in the m essage bar of BMC Imp act Explorer

window.

Editing slots

A class definition consists of one or more slots. Each slot has a d ata typ e and can havespecific attribu tes called facets that can control the values that the slot can h ave or

control aspects of a class instance’s p rocessing. A class that is a subclass to an otherclass inher its all the slots of the p arent class.

The Edit pop -up m enu op tion allows you to up date the selected d ata instance of the

current d ata list in the Data List display pane.



Exporting data


1 Select and right-click on th e da ta instance to d isplay the Edit tab in the Details pane

of BMC Imp act Explorer wind ow.

The Edit tab contains the slot value information of the selected data instance. Fields

that can be changed hav e a white backgroun d.

2 To save the edited information and close the Edit tab, click OK.

Exporting data

From the Data List in the Adm inistration view, you can expor t a data instance as a filewith a specified file name, in a form at selected from a list, and containing all or only

the visible slot information available for the d ata instance. Multiple d ata instances canbe exported to the sam e file at the same time. Do this by selecting all the data

instances your wan t includ ed to begin th e export process.

1 Select a d ata instan ce and select the File => Export menu option or click on th e

Export toolbar but ton to d isplay the Export Policies dialog box, as show n in

Figure 39.

Figure 39 Export Data dialog box

2 In the Format list, select the format for the export file, as show n in Figure 40.

Figure 40 Export Data dialog box—Selecting the data format

3 With the Visible Slots and All Slots option buttons, select w hether you wa nt to

includ e only the v isible slots or all slots in the file.

If you select All Slots, the Filter fo r Importing check box is available.



Exporting data


4 In the To File box, accept the d efault or specify the file nam e and location for the

export file.

5 Click OK to create the export file and close the Export Data dialog box.

For illustration purposes, in Figure 41, the export file mcdata.csv containinginformation on all the slots for the selected data instance is created in

C:\ D ocuments and Settings \ zane\ My D ocuments.

Figure 41 Contents of mcdata.csv

Figure 42 illustra tes an export file containing four d ata instances.

Figure 42 Export file containing four data instances



Exporting data




What is an event management policy?


Creating a n ew notification policy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

Creating a n ew prop agation p olicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306

Creating a new recur ren ce policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308Creating a new supp ression policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311

Creating a new threshold policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313

Creating a n ew timeou t p olicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317Enabling and disabling out-of-the-box stand ard event m anagemen t policies . . . . . 320

Creating a new dynam ic da ta enrichmen t event managem ent p olicy . . . . . . . . . . . . 321

Enabling out-of-the-box dyn amic data en richm ent event man agement p olicies . . . 332

Enabling a d ynam ic data en richm ent blackou t policy . . . . . . . . . . . . . . . . . . . . . . 333

Enabling a d ynam ic data en richm ent location p olicy . . . . . . . . . . . . . . . . . . . . . . 336

Enabling a d ynam ic data en richmen t service contact p olicy . . . . . . . . . . . . . . . . 340

Enabling a dyn amic enr ichm ent PATROL message text translation policy . . . . 343

Imp orting d ynam ic data enr ichmen t sou rce . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347

Verifying tha t th e p olicy is runnin g . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348

Editing event selection criter ia . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348

Delet ing an event selector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349

What is an event management policy?

An event management policy is one of several generic ru le types that per form actions

against even ts tha t meet selection criteria specified in an associated event selector. An

event man agement p olicy selects the events that you w ant to p rocess, defines the

processes needed to m anage those events, and schedu les wh en the events areprocessed.

Event man agement policies can be created from a pre-defined policy type in the

Adm inistration View or th e Event Man agement Policy Editor.

A p olicy consists of

s an event selector

In the Event Selection Cr iteria Editor, the ad ministrator defines the filtering criteria

used in selecting the events to be processed.

s a scheduleUsing the Time Frame Editor, the adm inistrator d efines the p rocessing schedu le

for the selected even ts.

s an event man agement policy type

For a list of pr edefined even t man agemen t policy types, see Table 69 on page 262.

You can also create new u ser-defined p olicy types to add new event processing

actions. See Chapter 13, “Creating and implement ing user-defined policies,” for

information about creating u ser-defined policy typ es.



How an event management policy differs from a rule


How an event management policy differs from a rule

Like a ru le, an event man agement p olicy processes events and performs eventmanagement.

How ever, unlike ru les, an event managem ent policy

s is easily defined interactively throu gh the BMC Imp act Explorer Ad ministrator

interface of the BMC Imp act Explorer console rather than being m anu ally writtenin MRL.

s uses an event selector by w hich you sp ecify the criteria used to select events for

processing by the p olicy. The event selector allows you to specify a nu mber of

events th at m eet selection criteria. This gives th e event policy greater flexibility

than a ru le.

s does not requ ire comp ilation because it is implemented using p redefined dataclasses and precomp iled r ules.

When to use an event management policy rather than a rule

Use a policy if there is a fairly simp le, rou tine action that you would like to app ly tomany events.

If some comp lex event m anipulation is requ ired that is specific to a small subset of

events, a ru le written in MRL may be more ap prop riate

In some cases, a rule can p rovide better performance than its event managem ent

policy equivalent. If an event m anagemen t policy gives problematic performa nce,

substituting an equivalent rule might rectify the performan ce issue.

Event management policy types

Event m anagement policy typ es provide a base p olicy d efinition that allows you to

qu ickly create certain types of policies. Policy types a llow you to qu ickly set uproutine event m anagement p rocesses.

Table 69 describes the stand ard event mana gement policy types.



Event management policy types


Table 69 Standard event management policy types

Policy name Definition

Blackout specifies w hich events th e receiving cell shou ld classify as u nimp ortant

and process no further but log for reporting purp oses

A blackout event m anagem ent p olicy might sp ecify that the cell ignore

events generated from a successful logon to an internal system.

Closure closes a specified event in response to receipt of a sep arate event

Correlation relates one or m ore cause events to an effect even t, and can close the effect

event

The cell maintains the association between these cause-and-effect events.

Enrichment adds values for specific event slots if those slots are empty as received

from the event source

An enr ichm ent event m anagem ent policy can also reforma t slots ornorm alize slot values.

Escalation raises or lowers th e priority level of an event a fter a specified period of

time

A sp ecified n um ber of event recurren ces can also trigger escalation of an

event. For examp le, if the abnor mally high tem peratu re of a storage

dev ice goes u nchecked for 10 minu tes or if a cell receives more than five

high-temperatu re war ning events in 25 minutes, an escalation event

man agemen t policy m ight increase the priority level of the event to

critical.

Notification sends a request to an external service to notify a user or grou p of users of

the event

A notification event man agement policy m ight notify a system

adm inistrator by mean s of a pager abou t the imminent u navailability of

mission-critical piece of storage hardware.

Propagation forward s events to other cells or to integrations to other p rod ucts

Recurrence combines du plicate events into one event that m aintains a counter of the

num ber of du plicates

Suppression specifies w hich events th at the receiving cell shou ld delete

Unlike a blackout event man agement p olicy, the sup pression event

man agemen t policy maintains n o record of the d eleted event.

Threshold specifies a minimu m nu mber of du plicate events that must occur w ithin a

specific period of time before the cell accepts th e event

For events allowed to p ass throu gh to the cell, the event severity can be

escalated or d e-escalated a r elative number of levels or set to a specific

level. If the even t occurren ce rate falls below a specified level, the cell can

take action against the event, such as chang ing the event to closed or

acknowledged status.

Timeout changes an even t status to closed after a specified p eriod of time elapses



How standard event management policies differ from dynamic data enrichment policies


It is also possible to define custom policy types that allow you to do sp ecialized event

processing not supported by the out-of-the-box policy types.

For more information abou t creating user-defined policy types, see Chapter 13,

“Creating and implementing u ser-defined policies” on page 351.

How standard event management policies differ fromdynamic data enrichment policies

A standard event management policy requ ires you to use the BMC Imp act Explorer to

inpu t d ata into a p olicy. This type of p olicy works w ell if you on ly wan t to app ly thepolicy to a small num ber of events or hosts. Examples of stand ard event man agement

policies that are p rovided out-of-the-box with the p rodu ct includ e:

s PATROL_Portal_Closure

s Apache_Login_Failed_Repeats

s Blackout_Suppression

A dynamic data enrichment policy provides ad d itional context to an event by extracting

data from an extern al source and a pp end ing it to the event so it is accessible to IToperations. For examp le, it may be u seful for IT operators to kn ow the location of a

pa rticular piece of equipm ent. This type of information is not normally includ ed in a

standard technical event; how ever, you can u se dynam ic data enr ichm ent to ad d th isinformation to the event by accessing data stored external to the prod uct (for

examp le, an asset store). If you w ant to ap ply a policy to a large nu mber of hosts orevents, you shou ld u se a dynam ic data enr ichm ent policy.

Examp les d ynam ic data enrichment policies that are p rovided out-of-the-box with

the prod uct includ e:

s Location_Enrichment

s Service_Contact_Enrichment

s PATROL_Message_Translation

s Dynamic_Blackout

To use these ou t-of-the-box dynam ic da ta enrichmen t policies, you m ust enable the

policy, imp ort u seful d ata into the samp le .csv files and then imp ort the data into the

cell using the policy mechanism. For instru ctions on creating d ynam ic da taenrichment p olicies, see “Creating a new dyn amic data enrichm ent event

management policy” on page 321.



Out-of-the-box event management policies


Out-of-the-box event management policies

Several event m anagement p olicies are included with the p rodu ct that enable you to

interactively set up rou tine event processing qu ickly. Table 70 lists th e ou t-of-the-box

policies and ind icates wh ether or n ot each out-of-the-box policy is enabled by d efault.

For instru ctions on using these ou t-of-the-box policies, see “Creating new stand ard

event managem ent policies” on page 285 an d “Creating a new d ynam ic dataenrichm ent event management p olicy” on page 321.

Table 70 Out-of-the-box policies

Policy type Policy name Description Enabled?

Closure PATROL_Portal_Closure closes previous Po rtal events for the

same m anaged object

Yes

Adapter_Start_Stop_Closure closes previous even ts for the same

adapter instance

Yes

Client_Stop_Closes_Start Client Stop even ts close Client Start

events and then close themselves

Yes

Dynamic Blackout Dynamic_Blackout sup presses events that m eet a specified

criteria du ring a sp ecified time p eriod.

No

Dynam ic Enrichm ent Location_Enrichment app ends th e location of a server to an

event

No

Service_Contact_Enrichment app end s contact information for a

server adm inistrator to an event. For

example, contact information m ay

includ e the name of the adm inistrator

for that server and his or her teleph one

number.

No

PATROL_Message_Translation rep laces the text of existing PATROL

event messages with m essages that can

be more easily und erstood by operators

in your enterprise.

No

Recurrence Apache_Login_Failed_Repeats hand les repeating Apa che Login Failed

events

No

Suppression Blackout_Suppression suppresses Blackout events No

Timeout PATROL_Portal_Timeout times ou t OK Portal events Yes



How event management policies work


How event management policies work

All event m anagement policies m ust include th e following componen ts:

s event selectors process(es)

s timeframe(s)

s evaluation ord er

Each even t man agement p olicy defines selection criteria that is app lied to incom ing

events to determine w hich events are p rocessed. A timeframe d etermines when the

policy is active or inactive. The evaluation ord er d etermines wh ich p olicies are

imp lemented first if there is a conflict.

In ad dition to these comp onents, dynam ic data enrichm ent p olicies also require adyn amic data enrichment source file, for m ore information on how dyn amic data

enrichment policies interact with dynam ic da ta enrichment source files, see “Howdyn amic data enrichment event management p olicies work” on page 270.

Event management policy workflow overview

Figure 43 illustrates the workflow for creating and implementing an eventman agement p olicy.

Figure 43 Event management policy definition workflow



Event selectors


Event selectors

An event selector is the comp onen t of an even t man agem ent policy that selects one ormore events to w hich an event man agement p olicy app lies. Rather than specifying a

particular event to p rocess, as a rule d oes, a selector specifies a list of event selectioncriteria (also called an Event Cond ition Form ula (ECF)). When an incoming eventmeets an y of the sp ecified event selection criteria, the cell app lies the associated event

man agement policy to the event. See “Event selection criteria” on page 267 for moreinformation.

Table 71 lists th e ou t-of-the-box event selectors.

You can create custom event selectors. For inform ation abou t creating event selectors,

see “How to create an event selector and specify event selection criteria” on p age 281.

Event selector groups

An event selector grou p, created w hen an event selector is d efined, allows you toorgan ize event selectors. For example, you could create event selector grou ps th at

classify event selectors by the sever ity of events. You could create on e event selectorgroup for major severity events and one for minor severity events.

Event selector grou ps ap pear as folders in the By Selector subtree in the Event

Management Policies nav igation pan e. The nam es of event selectors which belong to a

group are displayed as group.event_selector_name in the selectors lists in the list paneand in the By Event Class subtree. The n ame also is displayed in a separate field in the

Selector Details tab.

Table 71 Out-of-the-box event selectors

Event selectorGroup Event selector Events selected

Default Adapter_Start_Stop Adapter starting and stopping events

Default Apache_Login_Failed Apache w eb server login failed events

Default Client Stop client stop events

Defau lt PATROL_Por ta l_OK_Events OK sever ity even ts coming from PATROL

Portal

Defau lt PATROL_Portal_Events events com ing from PATRO L Portal

None All_Events all events

None Blackout_Events all blacked-out events

None PATROL_Events events coming from PATROL agents



Event selection criteria


Figure 44 shows an event selector grou p called Default that has the Adapter Start Stop

event selector highlighted . Notice that d etails abou t the highlighted event selector

appear in the Selector list in the right p ane of the Administration view.

Figure 44 Event selector group name

Event selectors do not have to belong to a grou p. Event selectors that do n ot belong to

a group ar e displayed d irectly un der the By Selector subtree.

Event selection criteriaEvent selection criteria tells a cell to wh ich incom ing events to ap ply th e associated

event p olicies. By u sing selection criteria to choose events r ather than creating a

single event man agem ent policy for each event typ e, event selection criteria perform

the event m anagement policy equivalent of dynam ic data for rules. One eventman agement p olicy using event selection criteria that spans a ran ge of event types

can be easier to m aintain th an a separate ru le for each of many event types.

The BMC Imp act Explorer interface allows you to interactively create syntactically

accurate event selection criteria expressions without th e need for sp ecific syntaxknow ledge because the ed itor verifies that th e expression has the correct syntax.

For more information see, “How to create an event selector and specify event

selection criteria” on page 281.

event selector group name



Timeframes


Timeframes

Timefram es allow you to specify wh en the even t man agement policy is active. Forexample, du ring schedu led d atabase maintenance periods, you might wan t to

activate an event sup pression p olicy for m aintenance-related events to red uceun necessary event accumu lation.

For events to be imp acted by a timeframe setting, the timeframe m ust be active for the

entire time th at is specified in the p olicy.

Table 72 describes the types of timeframes you can use in an event man agement

policy.

The following timeframe definitions are p rovided ou t-of-the-box:

s US_Holidays_2004

s US_Holidays_2005

s Weekdays

s Weekend

EXAMPLE An escalation p olicy is defined to escalate an event to p riority level 1 (escalated one level) after

10 minutes. Events ar e generated. N o event will be escalated for at least 10 minutes. Five

minu tes after the p olicy is enabled, the p olicy is disabled. Even thou gh the p olicy was active at

the beginning of the 10 minu te period, no event is impacted by the p olicy because it is not

active at the en d of the 10 minu tes.

An escalation policy is d efined to escalate an event p riority after 30 minu tes with an active

timefram e from 4:00 P.M. to 5:00 P.M. At 4:45 P.M. events a re gen erated . The active time

per iod exp ires at 5:00 P.M. Events gen erated at 4:45 P.M. are not im pacted by th e policy

because th e timefram e is not active at 5:15 P.M.

Table 72 Timeframe types and descriptions

Type Icon Description

local timeframe Local timeframes are used for event policies only. They are

maintained in the cell and are on ly visible to a single cell.

You create local timeframes from the Administration view of the

BMC Imp act Explorer, as described in “Ho w to create a new local

timeframe” on page 274.

global timeframe Global timeframes are u sed for event p olicies and service mod el

compon ents. They are m aintained in th e CMDB and are visible to

all cells in a n env ironmen t.

You create global timefram es in the Service Model Editor. For

instructions, see the BMC Impact Solutions: Service Model

Administrator’s Guide.



Evaluation order of event policy types


Evaluation order of event policy types

BMC Impact Managers evalu ate event p olicies of different typ es based on th e orderof the rule phase in w hich th e event managem ent policy executes. The stand ard ru le

ph ases and their associated event policy typ es are show n in Table 73.

1Unlike other event policies, cells evaluate th reshold event p olicies in tw o d istinct ph ases—the

first ph ase for the hold threshold an d the second phase for the pass through threshold.

Table 73 Evaluation order of event policy types

Evaluation order Rule phase Event policy type

1 refine blackout

enrichment

dynamic blackout

dynam ic enrichment

timeout (initialization)

2 filter NOPASS suppression

3 regulate threshold1

4 threshold threshold1

escalation

5 new closure

recurrence

6 abstract no related event management policy

7 correlate correlation

8 execu te timeout (arm)

notification

9 propagate propagation

10 delete no related event management policy

11 timer timeout (execu te)

escalation

WARNING

Although event p olicies of different types are evaluated accord ing to their associated ru le

ph ase, event p olicies of the same type d o not h ave an evaluation ord er. For example, if event

selectors for tw o event policies of the same typ e select the same event, the cell evaluates the

event accord ing to one event managem ent policy and ignores the other event managem entpolicy.

To prevent omission of event man agement p olicy evaluation, you m ust create mutu ally

exclusive event selection criteria for tw o event p olicies of the sam e type. With th e except ion of

dyn amic blackout, d ynam ic enrichment, notification an d prop agation event p olicies, two or

more p olicies of the same typ e shou ld n ot execute against th e same event. In the case of

except ional even t po licies, the cell evaluates all event p olicies of those four types, even if their

selectors reference the same event.



Compiling event policies


Compiling event policies

Event policies are validated dur ing compilation. Event p olicies are comp iled w hen aBMC Impact Manager (cell) starts. As soon as comp ilation su ccessfully comp letes,

event p rocessing begins. If, du ring cell startup , the comp ilation of any policy fails, theBMC Imp act Manager issues an er ror m essage that lists the causes of the failure andstops. If, while the BMC Impact Manager is runn ing, an event managemen t policy is

defined or is chan ged , it compiles dynamically.

How dynamic data enrichment eventmanagement policies work

Dynamic data enrichment p olicies require the same comp onents as standard eventman agement p olicies. However, d ynam ic enrichm ent p olicies allow you to import

external enrichm ent d ata into the p olicy, rather th an h aving to enter it man ually.

First, you m ust either export d ata from a data source (such as an asset database) orman ua lly enter information into the enrichm ent file (.csv).

Once the data enrichm ent source file contains the data required, you can use the

policy to imp ort the d ata into BMC Event Manager for u se in the enrichment p rocess.

Figure 45 illustrates the d ynam ic data enrichment flow.

Figure 45 Flow of data required to implement a dynamic data enrichment policy

External enrichment data sources

An external enrichm ent d ata source can p rovide ad ditional information about an

event tha t is not ava ilable from the technology from w hich the event originates. An

example of an external enrichm ent d ata source is a database su ch as an asset d ata

store. Information from the d atabase mu st be man ually exported into a flat delimited

file, so that BMC Event Manager can access the information. The recomm end ed

format to export the data to is a .csv file.

BMC provides some samp le policies and associated enr ichm ent data sources in the

%HOME%\ Mastercell\ console\ etc\ samples directory.





Dynamic data enr ichm ent policies can also use d ata includ ed in BMC PATROL

Enterp rise Manager (PMEP) files if you are m igrating from BMC PATROL Enterp rise

Manager to the BMC Event Manager solu tion.

Dynamic data enrichment source files

A d ynam ic data enrichm ent source file must contain at least one match field an d at

least one ou tpu t field.

A match field is the lookup or key field w hich th e d ynam ic data enrichm ent p olicy

uses to ident ify the incoming even t. You m ay use m ultiple match fields to iden tify an

incoming event.

An output field identifies the type of enrichm ent information th at is to be add ed to theevent.

Once the policy has matched the event d ata of the match field(s) with th e d ata in the

enrichment file, it will ad d th e associated enr ichm ent da ta from the en richmen t fileinto the ou tpu t field iden tified in the policy.

Wildcards are sup ported for pattern m atching w hich allows for m ore generic policy

rules to be w ritten.

Sample dynamic data enrichment source files

Table 74 lists the produ ct-sup plied dyn amic data enr ichm ent source files that are

located in th e %HOME%\ Mastercell\ console\ etc\ samples d irectory. These samp le

files p rovide common ly needed enrichm ent information.

WARNING

It is critical that the policy definition and the data enrichment source file contain the exact

same nu mber of match fields and outp ut fields in the sam e order. If the match fields and

outp ut fields in th e enrichm ent file and the policy do not m atch, the p olicy will not ru n.

For examp le, if you are using th e contact.csv file that is included with the prod uct, you m ust

select the Host Class, Host, Object Class, and Object slots as the Match Fields and theService an d Owner slots as the Output Fields to correspond to the slots in the contact.csv file.





You can u se these files as a guide to create your ow n d ynamic data enr ichm ent source

files or you can mod ify and use these samp le files.

For information on creating and using d ynam ic data enrichment sou rce files, see

“How to create and ed it a dynam ic data enr ichm ent source file” on page 277.

PMEP files

PMEP files are BMC PATROL Enterp rise Manager (PATROL Message Enh ancemen t

Processor) enrichmen t configuration files. In BMC PATROL Enterpr ise Manager ,

PMEP provided a similar d ynam ic data enrichm ent capability. If you are m igratingfrom BMC PATROL Enterp rise Manager to BMC Event Manager (BEM), you can

continue to u se the PMEP files in the BEM environm ent.

Depend ing on you r requ irements, you can u se one or m ore of the following

configu ration files show n in Table 75.

Table 74 Dynamic data enrichment source files

Data source file Policy name Description

location.csv Location_Enrichment ap pend s the location of a server to an event

contact.csv Service_Contact_Enrichment ap pend s contact information for a server

adm inistrator to an event. For example, contact

information may includ e the name of the

adm inistrator for that server and h is or her

telephone nu mber.

TextTranslation.csv PATROL_Message_Translation rep laces the text of existing PATROL event

messages with messages that can be m ore easily

un derstood by op erators in your enterp rise. This

file includ es pred efined message tran slations

that w ill be imm ediately useful in your

enterprise. For more information, see “Using thesamp le PATROL m essaging text translation

dy nam ic data en richm ent sour ce file” on

page 279.

blackout.csv Dynamic_Blackout sup presses events th at meet a specified criteria

du ring a specified time period.

Table 75 Enrichment configuration files (part 1 of 2)

File Description

Blackout.cfg Provides event sup pression for specified time periods when m atching

criteria are met

Location.cfg Provides a n ame th at identifies the location (or server) from w hich the

PATROL Agent events are being sent to Agen t Connection. The nam e

is add ed to the ObjectLocation field w hen matching criteria is met





In d ata event policies, your PM EP file selection w ill pop ulate th e event class and

match fields w ith p redefined values.

Figure 46 lists the default PMEP event classes and slot values.

Figure 46 Default PMEP event classes and slots

ServiceContact.cfg Provides th e Business Service Views or App lication Grou ps to w hich

the events belong. The sup port staff that are resp onsible for correcting

the pr oblem are identified by an event an d an y troub le ticket

information w ill be included in an event w hen m atching criteria ismet . Service inform ation is ad ded to th e Service field; contact

information is added to the ObjectStaff field and concatenated into

th e ObjectLocation field an d trouble ticket information is

concatenated into th e ObjectLocation field

TextTranslation.cfg Provides m odifications to text in the FreeText field w hen matching

criteria is met

# PMEP Text Transaclationpmep.text.eventclass=PATROL_EVpmep.text.match_fields=mc_object_class,mc_parameter,p_classpmep.text.output_fields=msg

# PMEP Service Contactpmep.service.eventclass=EVENTpmep.service.match_fields=mc_host_class,mc_host,mc_object_class,mc_objectpmep.service.output_fields=mc_service,administrator,mc_notes

# PMEP Locationpmep.location.eventclass=EVENTpmep.location.match_fields=mc_hostpmep.location.output_fields=mc_location

# PMEP Blackoutpmep.blackout.eventclass=EVENTpmep.blackout.match_fields=mc_host_class,mc_host,mc_object_class,mc_object,mc_paramemter

Table 75 Enrichment configuration files (part 2 of 2)

File Description



How to create a new local timeframe



Local timeframes allow you to specify periods of time th at determ ine wh en an event

man agement policy will or w ill not ru n. You can set up a single timefram e that can

apply to mu ltiple policies.

For example, if you have several policies that you d o not w ant to ru n on weekend s,

you can set u p a timeframe from 12:00AM to 12:00 AM on both Saturd ay and Sund ayand call that timeframe Weekend. You can then ap ply the timeframe Weekend to all

policies that you do not w ant to run on weekend s.

If you do n ot specify a timefram e for a policy, the policy will ru n continu ously. For alist of timefram es that ar e includ ed ou t-of-the-box, see “Timeframes” on page 268.

To define an event management policy timeframe

1 From the toolbar of the Administration view, click the View /Update Timeframes

button .

The Timeframes wind ow is displayed, as shown in Figure 47.

Figure 47 Timeframes

2 From the Timeframes toolbar, click the New Timeframe button.

The Timeframe Edit dialog is d isplayed, as show n in Figure 48 on page 275.

NOTE

Global timeframes are created in the Service Model Editor. For instructions, see the BMC

Impact Solut ions: Service Model Administrator's Guide.

NOTE

Timeframes ar e requ ired for blackout policies.





Figure 48 Timeframe Edit

3 Enter or mod ify the app rop riate inform ation in the fields available in the

Timeframe Edit d ialog as described in Table 76.

Table 76 Timeframe Edit dialog options (part 1 of 2)

Field Description

Name Nam e of the timeframe

Description Description of the timeframe

Start, End, and

Duration

Period w hen the timeframe begins and end s, and the du ration of the

timeframe. Chang ing the du ration w ill chan ge the value in the End

field, and vice-versa.

The individu al time zon e of cell will be used in timeframe

calculations.



How to add a notification service (notification policies only)


4 To create ad ditional timefram es, click Save and repeat this procedu re starting w ith

step 2.

5 To close the ed itor, click Close.

How to add a notification service (notificationpolicies only)

Before you can create or enable a standa rd notification event man agement policy (as

described in “Creating a new notification p olicy” on p age 302), you mu st add a

notification service.

To add a notification service

1 On the Administration view, choose the Dy namic Data Editor tab.

2 In the Dy namic Data Editor tree, expand the server for wh ich you wan t to add

notification.

3 Expand the Data section, and then expand the Cell Data section.

4 Select No tification Service.

The ava ilable notification serv ices are listed in the Notification Service tab in the

right pan e of the Adm inistration view.

5 In the Notification Service tab, right-click one of the available notification services

and choose New .

Recurrence pattern Schedu les how often the timeframe will recur. Ch anging the selection

in the left side list w ill change the op tions available on the right side.

Besides th e Daily, Weekly , Monthly, and Yearly timeframe options,you can select individu al dates that ar e part of the timeframe by

selecting Date List and choosing dates from the displayed calend ar.

Range of recurrence When you have selected a Daily, Weekly , Monthly, or Yearly

timeframe option, you can choose the starting and end ing date range

for the recurren ce.

Op tionally, instead of choosing an end date, you can enter the

nu mber of recurrences for the timeframe.

Table 76 Timeframe Edit dialog options (part 2 of 2)

Field Description



How to create and edit a dynamic data enrichment source file


6 On the New tab, in the Name field, enter a un ique name for the service.

7 In the Type field, choose on e of the notification service types.

8 In the Service field, enter th e command to initiate not ification.

9 In the available_targets field, enter the ind ividual or group recipients of thenotification.

10 Click OK.

How to create and edit a dynamic data

enrichment source file

Before you en able a dynam ic enrichm ent policy, you m ust imp ort or enter the d ata

that you wa nt to u se for enrichm ent into a da ta file. You can imp ort the enrichment

data into any d elimited flat file; how ever, BMC Software recommen ds impor ting the

data into a .csv

file and using Microsoft Excel to view an d m anipulate the contents of the file. The sp read sheet format of Microsoft Excel makes it easier to view and

man ipu late the inform ation in the file.

You can u se the sample data enrichment files provided with the p rodu ct as a guide to

set up your own d ata enr ichm ent source files. The samp le files are located in th e

%HOME%\ Mastercell\ console\ etc\ samples directory. For a list of sam ple filesprovided with the prod uct, see “Sample dynam ic data enrichmen t source files” on

page 271.

Before you begin

If you w ill be referencing a timefram e in you r dynam ic data enrichment source file,

you mu st ensure th at the timeframe that you will be referencing already exists. If thetimefram e you wan t to reference does n ot exist, you mu st define it as d escribed in

“How to create a new local timeframe” on page 274.

NOTE

Dynam ic data enr ichm ent source files are not requ ired for stand ard even t manag ement

policies. You only need a d ynam ic data enrichm ent sou rce file if you are creating a d ynam ic

data enr ichm ent policy.



How to create and edit a dynamic data enrichment source file


To create a dynamic data enrichment source file

1 In Microsoft Excel, create a new file and save it as typ e .csv .

2 In each column of the spread sheet, enter informa tion th at corresponds to each

match value and ou tpu t value that will be included in your d ynam ic dataenrichment policy.

3 Save and close the file.

To edit a sample dynamic data enrichment source file

1 Open one of the sample data source files includ ed w ith the produ ct located in the

%HOME%\ Mastercell\ console\ etc\ samples directory.

2 Imp ort or enter information specific to your enterpr ise.

Figure 49 shows an example of an ed ited location.csv file.

The location for h osts Texan1 and Texan2 is listed as Houston. The location for allhosts beginning with Cowboy (for example, Cowboy1, CowboySmith,

CowboyAikman) is listed as Dallas .

3 Save and close the file.

4 The data enrichment sou rce must be imp orted into the p olicy each time youmod ify the .csv file. For instru ctions on imp orting d ynam ic data enrichm ent d ata

source, see

WARNING



outp ut fields in th e enrichm ent file and the p olicy do not m atch, the policy will not ru n.

For examp le, if you ar e using th e location.csv file that is included as a samp le with the

prod uct, this file has two colum ns—mc_host an d mc_location. If you ar e creating a

dy nam ic data en richm ent location policy that u ses the location.csv file as the d ata

enrichment source file, you mu st select the Host slot as the Match Field and the Location

slot as the Output Field to correspond to the column s in the location.csv file.

Figure 49 Example edited location.csv file

# This enrichment file is used to add an extra field "mc_location" to an event.

# This can be useful to group together or understand the physical location of ITcomponents to help with event assignment and resolution.

# mc_host, mc_location

Texan1, Houston

Texan2, Houston

Cowboy*, Dallas



Using the sample PATROL messaging text translation dynamic data enrichment source file


Using the sample PATROL messaging text translation dynamicdata enrichment source file

The samp le PATROL messaging text translation data en richmen t source file,

TextTranslation.csv, provided in the %HOME%\ Mastercell\ console\ etc\ samples directory is prep opu lated w ith over two h un dred translations for messages from the

following Knowledge Mod ules:

s BMC SQL-BackTrack N etWorker OBSI Module

s PATROL KM for CONTROL-M

s PATROL KM for UN IX and Linu x

s PATROL KM for Microsoft Window s Servers

s PATROL KM for Netwa re

s PATROL KM for Sybase

s PATROL KM for Internet Server Man ager

s PATROL KM for Oracle

s BMC Perform ance Manager for Microsoft Window s Terminal Services

If you a re integrated with PATROL, you can ga in instant value by enabling thispolicy and importing the d ata from TextTranslation.csv into the cell as d escribed in

“Enabling a dyn amic enrichment PATROL message text translation policy” on

page 343. This policy allows you to reword ambiguou s event m essages into messagesmore easily u nd erstood by the IT operators ha nd ling th e events in Impact Explorer.

The samp le policy, TextTranslation.csv, will tran slate PATROL event m essagescoming from either BMC Imp act Integration for PA TROL 3.0 or BMC Imp actIntegration for PATROL 7.0.

Overview of the PATROL messaging text translationdynamic data enrichment source file

Figure 50 shows some samp le row s includ ed in the TextTranslation.csv file.



Using the sample PATROL messaging text translation dynamic data enrichment source file


Figure 50 Sample rows in the TextTranslation.csv file

The first th ree colum ns are match fields for incoming events. The first colum ncontains the object class or ap plication class of the KM. The second colum n contains

the par ameter . The third colum n contains the origin class.

The last column is the outp ut field or the m essage that should be displayed wh en an

event m atching the criteria in the first thr ee colum ns is received .

For example, in the first row , the cell will look for an even t coming from the

CPUCpuUtil par ameter of the CPU app lication class. When the cell receives that

event, it w ill display the message:

CPU Utilisation is at 97%

or w hatever nu mber th e CPU utilization p ercentage is at that time.

Many of the messages in the samp le file contain slots that w ill be pop ulated with

values from th e parameter. For informat ion on the synta x for using slots in a textmessage see, “Editing the PATROL messaging text translation dyn amic data

enrichment sou rce file.”

Editing the PATROL messaging text translationdynamic data enrichment source file

You can also add to and edit the TextTranslation.csv file, if requ ired. For exam ple, youmight w ant to tran slate the m essages included in the file into you r n ative langu age.

Or, you m ight wan t to include m essages related to a KM that is not already includedin the file.

One of the m ost pow erful features of the text translation file is the ability to includ e

CORE_EVENT base event class slots tha t will allow you to dynam ically populate the

message with information from param eters or other BMC Impact Manager

comp onents. This feature allows you to create messages that are very meaningful.



How to create an event selector and specify event selection criteria


Figure 50 shows some actual messages in the TranslationText.csv file that include

variables. For example,

This message includ es the %mc_object% and %mc_parameter_value%variables. Thissyntax in the en richmen t source file allows you to substitu te the value of the slot you

have referenced into the event m essage.

To insert a slot value into a message, use the following syn tax:

Message text %<slot_name>% message text

If you need to include a % sign in the actual message text, you m ust p recede th e %

character w ith a back slash (\ ). For example, in Figure 51 the d esired text messageinclud es a % character. The syn tax for the m essage is %mc_parameter_value%\%

full.

If the va lue of mc_object is D: and the value of mc_parameter is 97 the reworded

message would be:

Filesystem D: is 97% full.

For a list of CORE_EVENT base even t class slots that you can u se in text messages,see BMC Impact Solut ions: Knowledge Base Development .

How to create an event selector and specifyevent selection criteria

An even t selector is the component of an event m anagemen t policy that selects one or

more events to wh ich an event man agement p olicy ap plies using sp ecified event

selection criteria. When an incoming event m atches any of the specified event

selection criteria, the cell applies the associated event m anagemen t policy to theevent.

Before you begin

s Unless you w ant the event man agement p olicy to ru n continu ously, you m ust

define a timeframe as d escribed in “How to create a new local timeframe” on

page 274.

Figure 51 Variable syntax example

FILESYSTEM FSCapacity Filesystem %mc_object% is %mc_parameter_value%\% full





s [For dynamic data enrichment policies only.] Create a data enrichm ent sou rce file as

described in “How to create and edit a d ynamic data enrichment sour ce file” on

page 277.

To create an event selector and specify event selection criteria

1 From the Administration view, select the Event Management Polices tab.

2 Select a valid nod e (non -cell grou p) from the navigation p ane.

Valid n odes for event selector creation are a ll visible nod es except the top -level cell

group node. When the Add Event Selector button in the toolbar becomes active, this is an

indication th at valid n ode is selected.

3 On the Administration view toolbar, click th e Add Event Selector button .

The Selector Details tab, shown in Figure 52, is displayed .

Figure 52 Selector Details tab

4 In the Selector Name field, type the even t selector name.

5 In the Group field, type an event selector grou p nam e.

The event selector tha t you create in the next step w ill belong to th e event selector

group that you enter. If you enter a na me of an event selector group that does not

exist, that grou p w ill be created.

6 To the right of the Base Event Class field, click the button to d isplay an eventclass chooser d ialog box (show n in Figure 53) from which to choose the event class.





Figure 53 Class Chooser dialog box

7 Select an event class from th e tree an d click OK to accept the class.

For more information abou t event classes, see the BMC Impact Solut ions: Knowledge

Base Development Reference Guide.

8 In the Description field, type an optional description for the even t selector.

9 Click Add to ad d event selection criteria to this event selector.

The Add Event Criteria editor is displayed.

10 From the Add Event Criteria editor, typ e a d escription for th e event selection criteria

in the Description slot.

11 In the Event Class field, use one of the following m ethod s to select an event class on

wh ich to base the even t selection criteria:

s Accept th e defau lt event class in the Event Class field.

s Chan ge the class by clicking th e brow se button . The Class Chooser dialog box isd isplayed, select a class and click OK.

NOTE

You cannot change th e event class specified in an ECF to any class that is not at the sam e

level or below th e event class alread y sp ecified in the ECF. If the ECF contains slots in the

current class that are not in the new class, you cannot change to the n ew class, even w hen it

occurs in the h ierarchy rooted in the base event class.





12 In the Selection D efinition section, show n in Figure 54, create an expression that is

used to determine w hether an even t of the selected class is processed by the policy

by choosing a Slot, Operation, and Value.

Figure 54 Selection Definition section of the Add Event Criteria editor

The examp le expression in Figure 55 tests events for W indow s security messages

containing logon and logoff messages. You m ight use this expr ession as part of an

event selector for implementation in an event blackout policy that hides these

security events from d isplay bu t maintains their history.

Figure 55 Example event selection criteria expression

For a list and definitions of EVENT slots available for selection, see th e even t an d

data classes append ix of the BMC Impact Solutions: Knowledge Base Development

Reference Guide. For a list and definitions of the op erators available for each slot, seethe section on op erators in the Master Rule Langu age (MRL) append ix of the BMC

Impact Solutions: Knowledge Base Development Reference Guide.

13 Click OK to save the expression and close the Add Event Criteria editor.

The event selection criteria is displayed in the Event Selection Criteria section of the

Selector Details tab, as show n in Figure 56.

Figure 56 Completed event selection criteria in Selector Details tab

14 To ad d more even t selection criteria, click Add and repeat step 10 through step 13.

15 Click OK to save the event selector and its event selector grou p.



Creating a new standard blackout policy


An examp le of a blackout event m anagement policy m ight have the cell ignore events

genera ted from a successful log on to an externa l system.

To create new a standard blackout policy

1 From the Event Management Policies tab of the Administration view , expand th e

Policy Type folder.

2 Under the Policy Type folder , select Blackout Policy.

3 Click the Add Policy button .

A Selector Chooser d ialog box is disp layed.

4 From the Selector Choose r d ialog box, choose the event selector tha t you w ant to

use for this p olicy and click OK.

The Blackout Policy D etails tab is displayed in the d etails pane of the Administration view as shown in Figure 57.



Creating a new standard blackout policy


Figure 57 Blackout Policy Details tab

5 In the Policy Name field, type a un ique alphanu meric name for the eventmanagem ent p olicy. The name m ust contain no spaces.

6 In the Description field, type a description of the event managemen t policy.

7 To enable the event man agem ent policy, select the Enabled check box. If you d o not

wan t to enable the policy at this time, you can retur n to th is dialog box and enable

the p olicy later.

8 In the Policy Activation Timeframes section, define the per iods of time th e eventman agement p olicy should be a ctive (wh en enabled) by p erforming th e following

actions:

A Select one of the following choices:

s

To make the event m anagemen t policy active continuou sly, select AlwaysActive .

s To specify when the policy is active or inactive, select Define Activation

Timeframes .

The Active Timeframes an d No t Active Timeframes check boxes are enabled .

B If you selected Define Activation Timeframes, depending on how you want to

define the timefram e for your p olicy do one or both of the following:



Creating a new closure policy


s To specify the periods of time wh en the p olicy shou ld be active, select th e

Active Timeframes check box and one or m ore timefram es from its scrollable

list.

s To specify the periods of time wh en the p olicy shou ld be inactive, select the

Not Active Timeframes check box and one or m ore timefram es from itsscrollable list.

9 Click OK.

BMC Imp act Explorer saves the d efined event managemen t policy, and it isd isplayed in the list of event policies for the selected event selector.


An closure p olicy closes a specified event w hen a separate specified event is received.

To create a new closure policy


Policy Type folder.

2 Under the Policy Type folder , select Closure Policy.


NOTE

You can select both check boxes to create active and inactive time p eriods. How ever, the

inactive time p eriod takes p recedence over th e active time period .





A Selector Chooser d ialog box is displayed .

4 From the Selector Chooser dialog box, choose the event selector that you wa nt touse for th is policy and click OK.

The Closure Policy D etails tab is displayed in the details pane of the Administration

view a s shown in Figure 58.

Figure 58 Closure Policy Details tab

5 In the Policy Name field, type a un ique alphanu meric name for the event

managem ent p olicy. The name m ust contain no spaces.





6 In the Description field, type a description of the event m anagemen t policy.

7 To enable the event man agem ent policy, select the Enabled check box. If you do not


the p olicy later.

8 In the Policy Activation Timeframes section, define the p eriods of time the event

man agement p olicy should be active (wh en enabled) by p erforming the followingactions:

A Select one of the follow ing cho ices:

s To make the event m anagemen t policy active continu ously, select Always

Active.


Timeframes .

The Active Timeframes an d Not Active Timeframes check boxes are enabled .

B If you selected Define Activation Timeframes, depend ing on how you want todefine the timefram e for you r policy do one or both of the following:

s To specify the periods of time wh en the p olicy shou ld be active, select the

Active Timeframes check box and one or m ore timefram es from its scrollablelist.


Not Active Timeframes check box and one or m ore timefram es from its

scrollable list.

9 Click Edit Event Criteria.

The Add Event Criteria window is displayed.

10 In the Add Event Criteria window , specify event selection criteria for the event typ e

that you want to close and click OK.

11 To close only matching event s that occur w ithin a certain timeframe, check the

Close Events wi th Age Less Than check box and specify an am ount of time. If the

Close Events wi th Age Less Than check box is not checked, there is no limit on th etime between the closed event and the closing event.

NOTE





Creating a new correlation policy


12 To suppress the closing event, check the Suppress the Closing Event check box.

13 To save the completed event closure policy, click OK.

BMC Imp act Explorer saves the d efined event m anagemen t policy, and it is

disp layed in the list of event p olicies for the specified even t selector.


A correlation policy relates one or m ore cause even ts to an effect event. If desired , this

policy can close the effect event. The cell maintains the association betw een th esecause-and -effect events.

To create a new correlation policy


Policy Type folder.

2 Under the Policy Type folder, select Correlation Policy.



4 From the Selector Chooser dialog box, choose the event selector that you wa nt to

use for th is policy and click OK.

The Correlation Policy Details tab is displayed in the d etails pane of the

Administration view , as shown in Figure 59.





Figure 59 Correlation Policy Details tab


man agement p olicy. The name m ust contain no spaces.

6 To enable the event management p olicy imm ediately, select the Enabled check box.

If you do not w ant to en able the policy at this time, you can r eturn to this dialog

box and en able the policy later.






8 In the Policy Activation Timeframes section, define the per iods of time th e event

man agement p olicy should be a ctive (wh en enabled) by p erforming th e following

actions:


s To make the event m anagemen t policy active continuou sly, select Always

Active .


Timeframes .

The Active Timeframes an d No t Active Timeframes lists are enabled .



s To specify the period s of time wh en the p olicy shou ld be active, select the


s To specify the period s of time wh en the p olicy shou ld be inactive, select th e


9 Comp lete a separate Cause Event tab as app ropr iate for each cause event that youwan t to define.

Table 78 describes each of the controls in the Cause Event tabs.

NOTE


inactive time p eriod takes p recedence over th e active time p eriod.

Table 78 Cause Event tab controls

Field name Description

Enable ch eck box Select th is ch eck box to relate th e cau se ev en ts to th e effect

events; this information is stored in the cell.

Edit Event Criteria button Click this button to specify the selection criteria for the

cause event.

Correlation Timespan check

box

Select this check box an d enter a tim e limit within w hich

the cause event m ust occur to pr odu ce the effect event.



Creating a new enrichment policy


10 To save the completed even t correlation p olicy, click OK.

BMC Imp act Explorer saves the d efined event managemen t policy, and it is

d isplayed in the list of event policies for the selected event selector.


An enrichmen t policy add s values for specific event slots if those slots are emp ty

when th e event is received from the even t source. An enr ichm ent policy can also

reformat slots or normalize slot values.

To create an enrichment policy


Policy Type folder.

2 Under the Policy Type folder , select Enrichment Pol icy.





Close Effect Event radio

buttonsChoose one of the following r ad io buttons to sp ecifythe circum stances und er wh ich the effect event w ill

be closed :

s Upon Correlation—as soon as events are associated

(cau se and effect), the effect event is closed

s On Cause Event Closure—when th e cause event

closes, the effect event is closed also

s On Its Ow n—closing th e cause event has no

consequence to the effect event

Escalate Cause Event check

boxselect this check box to escalate the cause even t to the

specified p riority level

De-escalate Effect Eventcheck box

select th is check box to d e-escalate the effect event

Table 78 Cause Event tab controls

Field name Description





The Enrichment Policy Details tab is displayed in th e details pane of the


Figure 60 Enrichment Policy Details tab




the p olicy later.





7 In the Policy Activation Timef rames section, define the periods of time th at the event

man agement p olicy should be active (wh en enabled) by p erforming the following

actions:



Active.


Timeframes .

The Active Timeframes an d Not Active Timeframes lists are enabled .

B If you selected Define Activation Timeframes, depend ing on how you want to

define the timefram e for you r policy do one or both of the following:





8 Enable the following check boxes as necessary to assign ap propr iate settings:

s Event Priority—the relative pr iority to assign to the event (1 is a high p riority)

s Event Category—the classification to assign to the event; categories includ e

— availability

— capacity

— configuration

— operational

— performance

— recovery

— security

— SLM (service level managem ent)

— message text format

s Object Type—the object type against w hich the event app lies, such as a server

s Location to Set—the p hysical location of the object, such as a city

s Services to Set—the service that the event is associated with

NOTE





Creating a new escalation policy


9 In the Message Text Format box, define the m essage slot enrichmen t for the event:

A From th e list of available event slots in th e Event Slot box, select an event slot to

wh ich to ad d enrichm ent information an d click Insert.

B To insert a a slot value into the m essage, either type the slot name su rrou nd edby % characters or select the slot name from th e Event Slo t list and click Insert.

The box is a stand ard text box. You can p osition the cur sor and type or insert

text and slot refeences in any order. The Event Slot list and Insert button areprovided as a convenience so you d o not have to remem ber the valid slot

nam es. The resulting string of characters in the Message Text Format box, %<slot name>%, w hether typ ed or inserted, is used as a template to create the message

(msg slot) for the even t.

Repeat steps A an d B to ad d more enr ichm ent information to the event slot, if

necessary.

10 To save the comp leted event enrichment p olicy, click OK.

BMC Imp act Explorer saves the d efined event m anagemen t policy, and it isdisp layed in the list of event p olicies for the selected event selector.


An escalation policy raises or low ers the p riority level of an event a fter a specifiedper iod of time. A specified n um ber of event recurr ences can also trigger escalation of

an event.

For examp le, if the abnorm ally high temp eratu re of a storage d evice goes unchecked

for 10 minutes or if a cell receives more than five high-temperatu re warn ing events in

25 minutes, an escalation event m anagemen t policy could increase the pr iority level

of the event to critical.

NOTE

The hidden an d list of slots are not av ailable for m essage enrichm ent.

To avoid u np redictable results wh en add ing a text message, use no m ore than one set of

quotation marks.





To create an escalation policy


Policy Type folder.

2 Under the Policy Type folder , select Escalation Pol icy and click OK.



4 From the Selector Choose r d ialog box, choose the event selector tha t you w ant touse for this p olicy and click OK.

The Escalation Policy D etails tab is displayed in the d etails pane of the

Administration view, as show n in Figure 61.





Figure 61 Escalation Policy Details tab




7 To enable the event man agem ent policy, select the Enabled check box. If you d o notwan t to enable the policy at this time, you can retur n to th is dialog box and enable

the p olicy later.







actions:



Active.


Timeframes .

The Active Timeframes an d Not Active Timeframes lists are enabled .







9 In the Time Escalation section, show n in Figure 62, use the Timespan Before Priority

is Escalated selectors to enter the n um ber of a specified period of time th at m ust

elapse before an event is escalated . The d efault time per iod is seconds, but this timeperiod can be changed to minutes , hours, or days by selecting one of these time

periods from the d rop list.

NOTE



NOTE

You can set Time Escalation or Rate of Event Arrival (step 13 through step 15 onpage 302), or both. To set only one, leave the fields of the oth er set to zero.





Figure 62 Time Escalation Controls

10 Choose one of the following r adio buttons to determ ine how the p riority of the

event w ill be escalated after the sp ecified time has elapsed :

s Leve ls to Escalate/De-escalate Priority By—Choose this radio bu tton to escalate orde-escalate the event by a specified nu mber of levels after the time period

specified by th e Timespan Before Priority is Escalated selector has elapsed . Enterthe nu mber of levels that th e event is to be escalated.

s Set Priority to This Value—Choose this rad io button to set the even t to a specified

pr iority level after the time period specified by the Timespan Before Priority is

Escalated selector has elapsed. Choose the p riority level from the d rop list.

11 (optional) To preven t the event from being escalated after it has been

acknow ledged , select the Do not Escalate if Acknowledged check box.

12 (optional) To preven t the event from being escalated after it has been assigned ,select the Do not Escalate if Assigned check box.

13 In the Rate of Event Arrival section, show n in Figure 62, in th e Number of Events

Needed for Escalation selector, enter the nu mber of events that mu st occur beforethe event is escalated .

NOTE

You can set Time Escalation (step 9 through step 12) or Rate of Event Arrival, or both . To

set only one, leave the fields of the other set to zero.



Creating a new notification policy


Figure 63 Rate of Event Arrival Controls

14 In the Timespan in which Events Must Arrive selector, enter the time in wh ich th eevents mu st arrive before the event is escalated or the event p riority is changed.

15 Choose one of the following rad io buttons to determine how the pr iority of the

event w ill be escalated a fter the number of events have arr ived w ithin the specified

timespan:

s Leve ls to Escalate Causal Event Priority—Choose this radio but ton to escalate the

causal event by a specified n um ber of levels after the num ber of events specified

Number of Events Ne eded for Escalation selector have occurred within the time

per iod specified by the Timespan in which Events Must Arrive selector. Enter thenu mber of levels that the even t is to be escalated .

s Set Priority to This Value—Choose this rad io button to set the even t to a specified

pr iority level after the n um ber of events specified Number of Events Needed for

Escalation selector ha ve occurr ed within th e time p eriod specified by the

Timespan in which Events M ust Arrive selector. Choose the p riority level from th e

drop list.

16 To save th e comp leted even t escalation policy, click OK.




A notification p olicy sends a request to an external service to notify a user or group of

users that the event has occurr ed.

For example, a notification even t managem ent p olicy might notify a systemadm inistrator by m eans of a pager about the imminent u navailability of a mission-

critical piece of storage hard w are.





Before you begin

You m ust ad d a notification service as described in “How to ad d a n otification service

(notification policies only)” on page 276.

To create a new notification policy


Policy Type folder.

2 Under the Policy Type folder, select Notification Policy and click OK.





The Notification Policy Details tab is displayed in the details pan e of the

Administration view , as show in Figure 64.





Figure 64 Notification Policy Details tab

5 In the Policy Name field, type a un ique alphanu meric name for the eventman agement p olicy. The name m ust contain no spaces.




the p olicy later.







actions:



Active .


Timeframes .








9 From the Notification Service drop list, select the service to use as the notificationmechan ism. The defau lt service is email.

10 In the Add field, type the n ame of a person or group to notify. Click Add to add the

nam e to the Notify slot. Add more n ames or grou ps if necessary.

11 From the Event Status that will N otify Users list, choose the even t status th at you

want to trigger the notification.

12 In the No tification Text field, enter th e notification m essage. If desired , you can u seth e Event Slot dr op list to choose event slots to add to the notification message.

Click the Insert bu tton to insert the slots into the message. Enter a sp ace before and

after each slot that you ad d.

13 (optional) Select the Auto Acknowledg e check box to autom atically acknow ledge the

event.

NOTE





Creating a new propagation policy


14 (optional) Select the Auto Assign check box to autom atically assign th e event to the

user you select from the list.

15 To save th e comp leted even t notification p olicy, click OK.

BMC Imp act Explorer saves the d efined event managemen t policy, and it isd isplayed in the list of event policies for the selected event selector.


A p ropagation p olicy forwards events to other cells or to integrations to oth erproducts.

To create a new propagation policy


Policy Type folder.

2 Under the Policy Type folder , select Propagation Policy and click OK.




The Propagation Policy Details tab is displayed in the details pan e of the






Figure 65 Propagation Policy Details tab



6 In the Description box, type a description of the event man agement p olicy.



the p olicy later.



actions:



Active .


Timeframes .


B If you selected Define Activation Timeframes, depending on how you want todefine the timefram e for your p olicy do one or both of the following:



Creating a new recurrence policy




list.



9 In the Propagate to all of list, choose one or m ore cells (Imp act Managers).

Figure 66 Propagation cell list

10 In the Propagate to one of list, select one or more cells (Impact Managers).

11 To save the completed event p rop agation p olicy, click OK.




A recurrence p olicy combines du plicate events into one event that m aintains a

coun ter of the num ber of dup licates.

NOTE



NOTE

All of the dup_detect slots on the incoming event m ust be the sam e for all events that match

the selector or the recurren ce policy w ill not function.

Because PATROL integration h as dup_detect set on the mc_origin_key and these keys

are u nique, recurrence policies will not operate a s expected for PATROL integration events.





To create a new recurrence policy


Policy Type folder.

2 Under the Policy Type folder, select Recurrence Policy and click OK.



4 From theSelector Chooser

dialog box, choose the event selector that you wa nt touse for th is policy and click OK.

The Recurrence Policy Details tab is displayed in the details pan e of the






Figure 67 Recurrence Policy Details tab

5 In the Policy Name box, type a u nique alphan um eric nam e (with no spaces) for the

event man agement p olicy.


7 To enable the event man agem ent policy, select the Enabled check box. If you do notwan t to enable the policy at this time, you can retur n to th is dialog box and enable

the p olicy later.



actions:



Active.


Timeframes .

The Active Timeframes an d Not Active Timeframes check boxes are enabled .





Creating a new suppression policy




list.



9 If you w ant to define a time w indow for events that are considered to be recurr ing,check the Recurring Events Must Arrive Within this Timespan check box and set the

maximum time after the initial event within wh ich an event mu st arrive to coun t

toward recurr ence. If the box is not checked , there is no limit on th e time betweendu plicate events that are counted as recurring.

10 In the Slot Updates section, select any original event values that you wan t up dated

by the latest recur rent event values.

11 To save the comp leted event recurr ence policy, click OK.


disp layed in the list of event p olicies for the selected event selector.


A sup pression policy specifies the events that th e receiving cell shou ld d elete. Unlike

a blackout event m anagemen t policy, the sup pression event man agement p olicy

maintains no record of the d eleted event.

To create a new suppression policy


Policy Type folder.

2 Under the Policy Type folder, select Suppression Policy.


NOTE







The Selector Chooser d ialog box is displayed .



The Suppression Policy Details tab is displayed in the d etails pane of the


Figure 68 Suppression Policy Details tab

5 In the Policy Name field, type a un ique alphanu meric name for the eventman agement p olicy. The name m ust contain no spaces.



wan t to enable the policy at this time, you can retur n to th is dialog box and enablethe p olicy later.



Creating a new threshold policy




actions:



Active .


Timeframes .








9 Click OK.



Creating a new threshold policyA threshold policy specifies a m inimu m nu mber of du plicate events that m ust occur

within a sp ecific period of time before th e cell accepts th e event. For events allowed to

pass throu gh to th e cell, the event severity can be escalated or de-escalated a relative

nu mber of levels or set to a sp ecified level. If the even t occurrence rate falls below a

specified level, the cell can take action against th e event, such as changing the even t to

closed or acknowledged status.

NOTE







To create a new threshold policy


Policy Type folder.

2 Under the Policy Type folder , select Threshold Policy.





The Threshold Policy Details tab is displayed in the details pan e of the

Administration view as shown in Figure 69.





Figure 69 Threshold Policy Details tab

5 In the Policy Name field, type a un ique alphanu meric name for the eventmanagem ent p olicy. The name m ust contain no spaces.




the p olicy later.


man agement p olicy should be a ctive (wh en enabled) by p erforming th e followingactions:



Active .


Timeframes .










list.



scrollable list.

9 For the Number of Dupl icate Events Received slot, sup ply a nu meric value and an

associated time measurement to sp ecify the th reshold above w hich an event isaccepted.

10 Select one of the following rad io buttons (The th reshold -specific options d isplayed

on the tab change d epend ing on w hich bu tton you select.):

s Hold Events Until Threshold is Me t—Select this op tion to p revent creation of anyspecified event un til the nu mber of events exceeds the th reshold w ithin th e

specified time period .

If you select Hold Events Until Threshold is Met, the options shown in Figure 70

are d isplayed. Specify whether to includ e allowing the last, first, highest, or

lowest severity event to pass an d w hether to acknow ledge or close the passed

event w hen incoming (new ) events fall below a specified low threshold ra te.

Figure 70 Hold Events options

s Pass Events through—select this option to create all events wh en they m eet the

required threshold rate.

If you select Pass Events through, the options shown in Figure 71 are displayed.

NOTE





Creating a new timeout policy


Figure 71 Pass Events Through options

Choose one of the following rad io buttons to d etermine how the severity of theevent w ill be escalated or d e-escalated:

s Levels to Escalate/De-Escalate Event Severity By—Choose this radio button to

escalate or de-escalate the severity of the event by a sp ecified n um ber of

levels after the num ber of events sp ecified Number of Duplicated Events

Received selector have occurr ed within th e time p eriod sp ecified by the

Timespan in which Events the Must Arrive selector. Enter the nu mber of

severity levels that the even t is to be escalated.

s Set Severity to This Value—Choose this radio button to set the event to a

specified severity level after the nu mber of events sp ecified Number of

Duplicated Events Received selector have occur red w ithin the time period

specified by th e Timespan in which Events the Must Arrive selector. Choose th eseverity level from th e drop list.

11 To save the comp leted event threshold p olicy, click OK.

BMC Imp act Explorer saves the d efined event m anagemen t policy, and it isdisp layed in the list of event p olicies for the selected event selector.


A timeou t policy changes an even t status to closed after a specified per iod of time

elapses.

To create a new timeout policy


Policy Type folder.

2 Under the Policy Type folder, select Timeout Policy.

NOTE

From the Set Severity to This Value dr op list, choose Critical, Non-critical, Minor,

Warning , or OK. Do not choose Unknown, as it is considered a status rath er than a

severity.








The Timeout Policy Details tab is displayed in the d etails pane of the Administration

view as shown in Figure 72.

Figure 72 Timeout Policy Details tab










the p olicy later.


man agement p olicy should be a ctive (wh en enabled) by p erforming th e followingactions:



Active .


Timeframes .







scrollable list.

9 In the Timeout Event After field, enter a n um ber of time p eriods that mu st elapsebefore an event w ill time ou t. The defau lt time p eriod is seconds, bu t this time

period can be changed to minutes , hours, or days by selecting one of these time

periods from the d rop list.

10 To save the comp leted event timeou t policy, click OK.



NOTE





Enabling and disabling out-of-the-box standard event management policies


Enabling and disabling out-of-the-boxstandard event management policies

This section pr ovides instru ctions for enabling and d isabling ou t-of-the-box stand ardevent m anagement policies.

For a list of out-of-the-box event managemen t policies, see “Ou t-of-the-box event

man agement policies” on page 264.

For instru ctions on en abling out-of-the-box dyn amic data enr ichm ent policies, see“Enabling out-of-the-box dynamic data enrichment event management policies” on

page 332.

To enable or disable a standard event management policy


Policy Type folder.

1 From the Event Management Policies tab of the Administration view , expand th e By

Policy Type folder.

2 Under the By Policy Type folder, select th e policy type for th e ou t-of-the-box

standard event p olicy that you wan t to enable.

Ou t-of-the-box stand ard event po licies are includ ed u nd er the following policytypes:

s Closure Policy

s Recurrence Policy

s Suppression Policy

s Timeout Policy

A list of out-of-the-box standard event m anagem ent policies of that p olicy type aredisplayed in the right pan e of the Administration view as shown in Figure 80.

Figure 73 List of event management policies

3 From the list of event man agement p olicies, select the p olicy that you w ant toenable.

The Details tab for that policy is displayed in th e details pane of the Administration

view.



Creating a new dynamic data enrichment event management policy


4 On th e BMC Imp act Manager toolbar, click the Update Policy button to enable

th e Details tab to be edited.

5 Enable or d isable the policy by selecting o r d eselecting the Enabled check box.

6 Click OK.



Creating a new dynamic data enrichmentevent management policy

This section provides instructions for creating a n ew dyn amic data en richm ent eventman agement p olicy (page 321) and for creating a n ew d ynam ic enrichm ent blackout

policy (page 327).

Before you begin

s Ensure that th e timeframe r eferenced in your dyn amic data enrichment source file

exists. If it does n ot exist, you must d efine the timeframe as d escribed in “How tocreate a new local timeframe” on page 274.

s Determine w hich event selector you w ant to app ly to your d ynam ic data

enrichment p olicy. If none of the out-of-the-box event selectors are ap propr iate for

your p olicy, define an event selector and specify event selection criteria as

described in “H ow to create an event selector and specify event selection criteria”

on page 281.

s Create a da ta enrichment sou rce file as described in “How to create and ed it a

dyn amic data enrichm ent source file” on page 277.

To create a new dynamic data enrichment policy


Policy Type folder.

2 Under the By Policy Type folder , select Dynamic Enrichment Policy.








The Dy namic Enrichment Policy D etails tab, show n in Figure 74, is d isplayed in the

details pan e of the Administration view.





Figure 74 Dynamic Enrichment Policy Details tab



6 In the Description field, type a description of the event management policy.

7 To enable the p olicy immed iately, select the Enabled check box. If you d o not w antto enable the policy at this time, you can return to this dialog box and en able the

policy later.





8 In the Execution O rder field, if more than one p olicy exists, specify the ord er of

execution.

9 In the Policy Activation Timeframes section, define the p eriods of time the eventman agement p olicy should be active (wh en enabled) by p erforming the following

actions:


s

To make the event m anagemen t policy active continu ously, select AlwaysActive.


Timeframes .

The Active Timeframes an d Not Active Timeframes lists are displayed.



s To specify the periods of time wh en the p olicy shou ld be active, select theActive Timeframes check box and one or m ore timefram es from its scrollable

list.



scrollable list.

10 If you do n ot want to accept the d efault event class, you can select an even t class byclicking in the Event Class field of the Match Fields section, selecting a new event

class, and clicking OK.

The Event Class determines w hat slots are available in the Available Event Fields column.

11 In the Class Chooser d ialog box, select an event class an d click OK.

NOTE

When a new policy is created, the num ber shown in the Execution Order field shou ld be

one greater the largest current execution ord er.

If two p olicies have the sam e execution order, they w ill run in indeterm inate order.

NOTE







12 In Available Event Fields colum n, select the slots that correspon d to th e match fields

in your d ynam ic data enr ichm ent source file. Use the left arrow button to m ove

those slots into the Match Fields colum n. You m ay select and mov e mu ltiple slots atthe same time.

13 In Available Event Fields colum n, select the slots that correspond to the ou tpu tfields in your dyn amic data enr ichm ent source file. Use the right arrow button to

move those slots into the Output Fields colum n. You may select and move m ultiple

slots at the sam e time.

14 (optional) In the Match Fields section, activate th e Match Tracing check box to ad ddiagn ostic notes to th e event, if necessary.

15 In the Match Table section, in the Type field, accept the d efault.

16 In the Match Table section, in the Tag field, accept the d efault.

17 In the Match Table section, in the Data File field, do one of the following actions:

s Type the path to the enrichment d ata source.

s To brow se for the enrichm ent da ta source, click, .

WARNING



outp ut fields in the enrichment file and the policy d o not m atch, the policy will not ru n.

For examp le, if you were creating a file similar to the location.csv file that is includ ed w ith

the prod uct, you m ust select the Host slot as the Match Field and the Location slot as the

Output Field to correspon d to th e slots in the location.csv file.

NOTE

Typically, you d o not n eed to the change th e value of the Type field. You can overrid e the

default; how ever, you m ust u se a unique tag w ithin the given match table.

NOTE

The Tag field u niquely identifies the m atch table that w ill be used by the p olicy instance.

You do n ot need to th e change the value of this field. You can overr ide the d efault;

however, you mu st use a u nique tag w ithin the given match table.





1. In the File Choose r d ialog box, select the d ynam ic data enr ichm ent sou rce file

app rop riate for your policy. For more information , see “External enrichment

data sources” on page 270.

2. Click OK.

18 In the Match Table section, in th e File Format field, select one of the following rad io

bu ttons to specify the type of da ta enrichmen t file to imp ort:

s Data file w ith this se parator—Choose this rad io button to imp ort a flat, delimitedfile, such as a .csv file. Enter a separator to d elimit the data colum n in the file.

For example, if you are using a .csv file, enter a comma (,) as the separator.

s PMEP file—Choose this radio bu tton to imp ort a PMEP table and select the

app ropriate PMEP format for your policy from the d rop list:

— Blackout

— Blackout CSV

— Location

— Location CSV

— Service

— Service CSV

— Text

— Text CSV

19 Click OK.

If this is the first time a policy is saved, the following confirmation d ialog box is

displayed:

Figure 75 Import confirmation

20 Click Yes.

NOTE

If you select the PMEP file button, the Event Class, Match Fields , and Output Fields are autopopu lated w ith predefined values and become read-only.





A green check mark should be displayed in the Enable colum n n ext to the policy in

the event m anagement policies list. (You may need to scroll the w indow to the

right to see the Enable colum n.) The p olicy also should show up in the tree in theleft pan e of the BMC Imp act Explorer w indow.

21 Import th e data from the d ynam ic data enr ichm ent source enrichm ent file asdescribed in “Importing dyn amic data enrichment source” on page 347.

To create a new dynamic data enrichment blackout policy


Policy Type folder.

2 Under the By Policy Type folder , select Dynamic Blackout Policy.





The Dy namic Blackout Policy Details tab is disp layed in the details pane of theAdministration view , as shown in Figure 76.





Figure 76 Dynamic Blackout Policy Details tab



6 In the Description field, type a description of the event mana gemen t policy.





7 To enable the p olicy immed iately, select the Enabled check box. If you d o not w ant

to enable the policy at this time, you can return to this dialog box and en able the

policy later.

8 In the Execution O rder field, if more th an one p olicy exists, specify the order of

execution.


actions:



Active .


Timeframes .

The Active Timeframes an d No t Active Timeframes lists are displayed.





list.



scrollable list.

NOTE



If two policies have the same execution ord er, they will run in ind eterminate ord er.

NOTE







10 If you do n ot want to accept the d efault event class, you can select an even t class by

clicking in the Event Class field of the Match Fields section, selecting a new event

class, and clicking OK.

The event class determ ines what slots are available in the Available Event Fields

column.

11 In the Class Chooser d ialog box, select an event class an d click OK.

12 In Available Event Fields colum n, select the slots that correspon d to th e match fieldsin your dyn amic data enrichment source file. Use the left arrow button to m ove

those slots into the Match Fields colum n. You m ay select and mov e mu ltiple slots atthe same time.

13 In Available Event Fields colum n, select the slots that correspond to the ou tpu t

fields in your dyn amic data enr ichm ent source file. Use the right ar row button to

move those slots into the Output Fields colum n. You may select and move m ultipleslots at the same time.

14 (optional) In the Match Fields section, activate th e Match Tracing check box to ad d

d iagnostic notes to the event, if necessary.

15 In the Match Table section, in th e Type field, accept the d efault.

16 In the Match Table section, in th e Tag field, accept the d efault.

WARNING



outp ut fields in th e enrichm ent file and the p olicy do not m atch, the policy will not ru n.

For examp le, if you were creating a file similar to the location.csv file that is includ ed w ith

the prod uct, you m ust select the Host slot as the Match Field and the Location slot as the

Output Field to correspon d to the slots in the location.csv file.

NOTE

Typically, you d o not n eed to the chan ge the value of the Type field. You can overrid e the

default; how ever, you m ust u se a unique tag w ithin the given match table.

NOTE

The Tag field u niqu ely iden tifies the match table that w ill be used by the p olicy instance.

You do n ot need to th e change the value of this field. You can overrid e the default;

however, you mu st use a u nique tag within the given match table.





17 In the Match Table section, in the Data File field, do one of the following actions:

s Type the path to the enrichment d ata source.

s To brow se for the enrichm ent da ta source, click, .

1. In the File Chooser d ialog box, select the d ynam ic data enr ichm ent sou rce fileappropr iate for your policy. For more information , see “External enrichmentdata sources” on page 270.

2. Click OK.

18 In the Match Table section, in the File Format field, select one of the following rad io

button s to specify the type of data enr ichm ent file to imp ort:

s Data file w ith this separator—Choose this radio button to impor t a flat, delimited

file, such as a .csv file. Enter a separator to delimit the d ata column in the file.

For example, if you are u sing a .csv file, enter a comma (,) as the separator.

s PMEP file—Choose this radio button to import a PMEP table and select the

app ropriate PMEP format for your policy from the d rop list:

— Blackout

— Blackout CSV

— Location

— Location CSV

— Service

— Service CSV

— Text

— Text CSV

19 Click OK.

If this is the first time a p olicy is saved , the following confirmation dialog box is

displayed:


NOTE

If you select the PMEP file button, the Event Class, Match Fields , and Output Fields

are autopopu lated with p redefined values and become read-only.



Enabling out-of-the-box dynamic data enrichment event management policies


20 Click Yes.



right to see the Enable column .) The policy also should show up in the tree in the

left pan e of the BMC Impact Explorer w indow.

21 Import th e data from the d ynam ic data enr ichm ent source enrichm ent file asdescribed in “Importing dyna mic data enrichm ent source” on page 347.

Enabling out-of-the-box dynamic dataenrichment event management policies

This section p rovides instru ctions for enabling out-of-the-box dynamic data

enrichm ent event man agement policies.

Before you begin

You m ust export d ata from an external enrichment d ata source into the d ynam ic dataenrichm ent source files provided with the p rod uct before you can enable any of the

out-of-the-box dynam ic da ta enrichment policies. For more inform ation see, “How to

create and edit a dyn amic data enrichm ent source file” on page 277.

The dynam ic data enr ichm ent sou rce file for the PATROL Message Text Tran slationpolicy (TextTrans.csv) is the only ou t-of-the-box dynam ic data enr ichm ent sou rce file

that includ es valid d ata. You can enable PATROL Message Text Translation policy

without exporting data into TextTrans.csv. For m ore inform ation abou t TextTrans.csv,

see “Using the samp le PATROL messaging text translation d ynam ic data enrichm ent

source file” on p age 279.

Table 79 lists each out-of-the-box dynamic data enrichment event managemen t policy

type and the page nu mber of the procedu re for each type.

Table 79 Out-of-the-box dynamic data enrichment event policy types andprocedures

To enable this event policy... See...

Dynam ic blackout “Enabling a d ynam ic data en richm ent blackout p olicy”

on page 333

Dynam ic location en richm ent “Enabling a dyn amic data en richm ent location p olicy”

on page 336



Enabling a dynamic data enrichment blackout policy



A dynam ic data enrichm ent blackout po licy specifies externa l sched ules that initiate

event blackout.

Before you begin

For the dynamic blackou t policy to work, you mu st define the timefram es referencedin the enr ichm ent sou rce file (blackout.csv). If any of the timeframes referenced in th e

enrichment source file have n ot been created in BEM, then th e policy will not ru n.

For instructions on defining timefram es, see “How to create a new local timeframe”

on page 274.

To enable a dynamic data enrichment blackout policy


Policy Type folder.

2 Under the By Policy Type folder , select Dynamic Blackout Policy.

The Dy namic Blackout Policy Details tab is disp layed in the details pane of the


Dynamic service contact

enrichment

“Enabling a dy nam ic data enrichm ent service contact

policy” on p age 340

Dynam ic PATROL message

translation

“Enabling a dy nam ic enrichment PATROL message text

translation policy” on page 343

Table 79 Out-of-the-box dynamic data enrichment event policy types andprocedures

To enable this event policy... See...





Figure 78 Dynamic Blackout Policy Details tab

3 On the BMC Impact Explorer toolbar, click the Update Policy button to make

th e Dynamic Blackout Policy Details tab editable.

4 On the Dynamic Blackout Policy Details tab, select the Enabled check box.





5 In the Execution O rder field, if more th an one p olicy of this type exists, specify the

ord er of execution.

6 In the Policy Activation Timeframes section, define the per iods of time th e eventman agement policy should be active and/ or inactive (when enabled) by

per forming the following actions:


s



Timeframes .

The Active Timeframes an d No t Active Timeframes timeframe lists are

displayed.






scrollable list.


diagn ostic notes to the event to assist with trou ble-shooting an even t.

8 Click OK.

A confirmation dialog box is displayed, asking if you wan t to imp ort d ata now , asshown in Figure 79.

NOTE




NOTE





Enabling a dynamic data enrichment location policy


Figure 79 Import Data Confirmation dialog box

9 Click Yes.



right to see the Enable column .) The policy also should show up in the tree in theleft pan e of the BMC Impact Explorer w indow.

10 Import th e data from the d ynam ic data enr ichm ent source enrichm ent file asdescribed in “Importing dyna mic data enrichm ent source” on page 347.


The dyn amic enrichment location policy add s location information to an event.

Some examples of uses for a dyn amic enrichmen t location p olicy includ e:

s Provides information to IT Operations so that they know w hich area/ datacenterthe p roblematic techn ology is located in an d can d irect engineers m ore qu ickly to

the problem.

s Allows IT Operations to build views in Impact Explorer of specific areas/ data

centers and un derstand at a glance where the pr oblems are.

s Allows IT Operations to view rep orts in BMC Imp act Repor ting based on location.

For examp le, they can iden tify wh ich locations w hich are generating the mostevents.

s If you a re integrating with a service desk the location identifier can be passed

along with th e rest of event, providing more u seful information to the engineerthat w ill be assigned to hand le the incident.

To enable a dynamic data enrichment location policy


Policy Type folder.






A list of out-of-the-box dynam ic data enrichm ent policies are displayed in the right

pan e of the Administration view as shown in Figure 80.

Figure 80 List of out-of-the-box dynamic data enrichment policies

3 From the list of out-of-the-box dynam ic enrichm ent policies, select

Location_Enrichment.

The Dy namic Enrichment Policy D etails tab, show n in Figure 81, is displayed in thedetails pan e of the Administration view.







th e Dynamic Enrichment Policy D etails tab ed itable.

5 To enable the p olicy, select the Enabled check box.





6 In the Execution O rder field, if more than one of th is type of policy exists, specify

the ord er of execution.


actions:


s



Timeframes .

The Active Timeframes an d No t Active Timeframes lists are displayed.



s To specify the period s of time wh en the p olicy shou ld be active, select theActive Timeframes check box and one or m ore timefram es from its scrollable

list.



scrollable list.

8 (optional) In the Match Fields section, activate th e Match Tracing check box to ad ddiagn ostic notes to th e event, if necessary.

9 Click OK.


displayed:

NOTE




NOTE





Enabling a dynamic data enrichment service contact policy



10 Click Yes.


the event m anagement policies list. (You may need to scroll the w indow to theright to see the Enable column .) The policy also should show up in the tree in the


11 Import th e data from the d ynam ic data enr ichm ent source enrichm ent file as

described in “Importing dyna mic data enrichm ent source” on page 347.


The dyn amic enrichment location policy add s contact information related to the

originating technology to an even t.

For example, you can add a server adm inistrator’s nam e and telephon e num ber to all

events originating from a p articular server

To enable a dynamic data enrichment service contact policy


Policy Type folder.


A list of out-of-the-box dyn amic data enrichm ent policies are displayed in the right

pan e of the Administration view as shown in Figure 83.


3 From the list of ou t-of-the-box dyn amic enr ichm ent policies, select

Service_Contact_Enrichment.





The Dy namic Enrichment Policy D etails tab, show n in Figure 84, is displayed in the




th e Dynamic Enrichment Policy D etails tab ed itable.





5 To enable the p olicy, select the Enabled check box.

6 In the Execution O rder field, if more th an one typ e of this policy exists, specify the

ord er of execution .



actions:



Active.


Timeframes .






list.



8 (optional) In the Match Fields section, activate th e Match Tracing check box to ad dd iagnostic notes to the event, if necessary.

9 Click OK.

NOTE When a new policy is created, the num ber shown in the Execution Order field shou ld be


If two p olicies have the sam e execution order, they w ill run in indeterm inate order.

NOTE

You can select both check boxes to create active and inactive time p eriods. How ever, theinactive time p eriod takes p recedence over th e active time period .



Enabling a dynamic enrichment PATROL message text translation policy



displayed:


10 Click Yes.



right to see the Enable colum n.) The p olicy also should show up in the tree in the

left pan e of the BMC Imp act Explorer w indow.


described in “Importing dyn amic data enrichment source” on page 347.

Enabling a dynamic enrichment PATROL message texttranslation policy

If you ar e integrated w ith PATROL, the dynam ic data enrichmen t PATROL messagetran slation p olicy allows you to substitute existing PATROL messages w ith messages that

are meaningful to your enterp rise.

For example, you can u se the PATROL message translation p olicy to change this message:

NT_CPU.CPU_0.CPUprcrUserTimePercent parameter CPUCputil triggered on

90 <= 97 <= 100

to the follow ing, more comprehensible message:

CPU Utilization is at 97%

NOTE

A sam ple d ynam ic data enrichm ent service contact policy d ata sour ce file,

TextTranslation.csv, is prov ided in the %HOME%\ Mastercell\ console\ etc\ samples d irectory. The TextTranslation.csv file includes translations for man y common messages

that w ill be useful in y our enterprise. If you are integrated with PATROL, BMC Software

recommend s that you take advan tage of the da ta that is already includ ed in this samp le file.

For information abou t using the TextTranslation.csv file, see “Using the sam ple PATROL

messaging text translation dyn amic data enrichm ent source file” on page 279.





To enable a dynamic data enrichment PATROL message translation policy


Policy Type folder.


A list of out-of-the-box dyn amic data enrichm ent policies are displayed in the rightpan e of the Administration view as shown in Figure 86.


3 From the list of ou t-of-the-box dyn amic enr ichm ent policies, select

PATROL_Message_Translation.

4 Click the Update Policy button .

The Dy namic Enrichment Policy D etails tab, show n in Figure 87, is d isplayed in the








wan t to enable the event m anagement policy at this time, it can be enabled later.

6 In the Execution O rder field, if more th an one p olicy exists, specify the order of execution.



actions:



Active .


Timeframes .

NOTE











s To specify the periods of time wh en the p olicy shou ld be active, select theActive Timeframes check box and one or m ore timefram es from its scrollable

list.



scrollable list.


d iagnostic notes to the event, if necessary.

9 Click OK.

If this is the first time a policy is saved, the following confirmation d ialog box is

displayed:


10 Click Yes.


the event m anagement policies list. (You may need to scroll the w indow to theright to see the Enable column .) The policy also should show up in the tree in the



described in “Importing dyna mic data enrichm ent source” on page 347.

NOTE





Importing dynamic data enrichment source


Importing dynamic data enrichment source

Before a dynamic data en richmen t policy can take effect, the data in the dyn am ic

data enr ichm ent source file must be imp orted.

1 Ensure that the p olicy is enabled.

2 Select Import tab.

The Import tab is displayed as shown in Figure 89.

Figure 89 Import tab

Table 80 describes the u ned itable fields of the Import tab. These fields are for you r

information only.

3 In the field opp osite the Import button, select wh ether you w ant to Replace theexisting data in the cell or Merge new data with existing data in the cell .

4 Click Import.

The data is imp orted from the file into th e cell.

5 Verify that the information has been u ploaded by ensur ing that the Last Action information in the Import tab shows a completed up load message.

Table 80 Import tab uneditable fields

Field Description

Data File Path to the enrichm ent data sour ce

File Format Type of file used by the policy

Last Action Last time an impor t (replace or merge) was comp leted.



Verifying that the policy is running


Verifying that the policy is running

To verify that the p olicy is runn ing,

1 Send an event that shou ld trigger the p olicy

2 Access the History tab, scroll down to the Operations Log and verify that your

policy has executed .

Figure 90 shows the History tab for a successfully executed d ynamic data enrichmentpolicy.

Figure 90 History tab showing executed dynamic data enrichment policy

Editing event selection criteria

If you need to edit event selection criteria that you have already d efined , follow thesesteps:

1 From the even t man agemen t policy tab nav igation tree, select an event selector.

2 Click the Update Event Selector button .

3 From the Event Sele ction Criteria section of the Selector Details tab, select an even tselection criteria in the list and click Edit.

The Edit bu tton remains inactive un til you select an even t selection criteria.

4 Use the Edit Event Criteria editor to m ake the n ecessary changes to the d escription,event class, or expression.

5 To save th e ed ited even t selection criteria, click OK.



Deleting an event selector


6 From the Selector Details tab , click OK to save the ed ited even t selection criteria and

the even t selector.

Deleting an event selectorIf you n eed to d elete an even t selector that you h ave defined , follow these steps:

1 From the event man agement p olicy navigation tree, select the app ropr iate event

selector.

2 Click the Delete Event Selector button .

The Delete Confirmation d ialog box is displayed .

3 Click Yes.

The event selector is deleted .



Deleting an event selector





C h a p t e r 1313Creating and implementing user-defined policies

This chapter d escribes how to create and how to implement u ser-defined p olicytypes. This chap ter pr esents the follow ing topics:

Understand ing u ser-d efined even t policy typ es . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352

Und erstand ing event processing ru les (MRL) for policy types . . . . . . . . . . . . . . . . . 352

Format of event p rocessing ru les for p olicy types . . . . . . . . . . . . . . . . . . . . . . . . . 352

How a ru le for a p olicy type is processed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353

Sources of information about ru les . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353

User-d efined event policy typ e creation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354

Creating user-defined policy types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354

Defining the policy d ata class for a new policy typ e . . . . . . . . . . . . . . . . . . . . . . . 354

Defining presentation n ames for a new policy type . . . . . . . . . . . . . . . . . . . . . . . 356Crea ting th e even t pr ocessing ru le(s) for a n ew policy typ e. . . . . . . . . . . . . . . . . 357



Understanding user-defined event policy types


Understanding user-defined event policytypes

Pred efined policy types cannot cover all requirem ents of different BMC Imp actSolution imp lementations. To supp ort specialized event p rocessing, you can also

define an d implement custom event policy typ es to do specialized event processing

not sup ported by the p redefined policy types. For instructions on creating event

policy types, see “User-defined event p olicy type creation” on page 354.

Understanding event processing rules (MRL)for policy types

This section d escribes the form of policy type rules and discusses how they w ork.

Format of event processing rules for policy types

A typical event p rocessing ru le for a user -defined policy type has this form:

<rule-phase> rule-name:using_policy

{

<POLICY_TYPE > ($POL) where [ ($POL.enabled == 1) AND

(($POL.active_timeframes == [] OR

tf_active($POL.active_timeframes)) AND

NOT tf_active($POL.except_timeframes)) ]

}

$POL.selector_ecf ($EV) where [ <other conditions> ]

{

<actions>;

opadd($EV, $POL.name, "action name", "");

} END



User-defined event policy type creation


User-defined event policy type creation

If you wan t to create a new user-defined event policy to p erform specialized event

processing, first, you m ust define a new even t policy type. An even t policy type is a

da ta class, derived from that d efines the d istinct type of event processing to beperformed.

Creating user-defined policy types

To define a n ew user-defined policy typ e, you mu st do the follow ing things.

Defining the policy data class for a new policy type

To create a new policy type, first you m ust d efine a d ata class derived d irectly from

the IM_BASE_CUSTOM_POLICY base class. This policy d ata class d escribes the

policy type’s data. It also provides the tem plate of data fields (slots) used by BMC IM

to genera te the BMC IX Custom Policy Details panel in w hich users specify the

processing d etails for a policy of that typ e.

To define a new policy data class

1 Using a text editor, open the ap propr iate BAROC language file in the Know ledge

Base.

Because th e IM_BASE_CUSTOM_POLICY base class is defined in

.../kb/class/im_policies.baroc file, you mu st define the new policy type in a separate

file that is loaded for compilation after .../kb/class/im_policies.baroc file (it is listed

after th e im_policies.baroc in the .../kb/class/.load file list).

Table 81 Policy Type Creation process

Step Task Topic

1 Defin e a new p olicy da ta cla ss th at descr ib es

the policy type an d copy it to the Knowledg e

Base of each BMC IM instance to use the user -

defined policy.

“Defining th e policy data class for

a new p olicy type” on page 354

2 Defin e th e p resen tation nam es th at you w an t to

app ear in u ser interfaces for the p olicy type in a

BMCIX.properties configura tion file.

“Defining p resentation nam es for a

new p olicy type” on page 356

3 Create a new rule that d efines the eventprocessing don e by the p olicy type andcopy it to the Know ledge Base of each BMC

IM instance to use the policy.

“Creating the event p rocessing

rule(s) for a new policy typ e” on

page 357



Defining the policy data class for a new policy type


2 Define the new p olicy data class derived d irectly from the

IM_BASE_CUSTOM_POLICY base class.

A Create th e new class slots. You can create slots of these types:

s ENUMERATIONs INTEGER

s STRING

s LIST OF

No other slot types are su pp orted in custom event p olicies.

B Define the class slots in the ord er that you w ant th em to ap pear in the BMC IX

Custom Policy Type pan el.

The BMC IX Custom Policy Details panel created from the p olicy type w ill havea field for each slot ad ded to the IM_BASE_CUSTOM_POLICY class. Theinterface fields appear in the same order as the slots are d efined in the class

definition.

See the BMC Impact Solutions: Knowledge Base Development Reference Guide fordetailed information on creating new classes.

3 Save the edited file after d efining th e new policy type (data class).

4 Add and entry for the new file that you created to the comp iler load list in the

.../kb/class/.load file after the entry for the ../kb/class/im_policies .baroc file.w hichcontains the base policy data class that the new policy type references.

5 Recomp ile the BMC Imp act Manager instance’s Know ledge Base (KB) afterdefining the new p olicy data class.

For more information on compiling a KB, see “Comp iling a Know ledge Base” in

th e BMC Impact Solutions: Knowledge Base Development Reference Guide.

6 Finally, you must copy the changed KB to every BMC Imp act Manager instance

(cell) that w ill use the new policy.

Verifying that you created the class successfully

If you created the class successfully, you shou ld be a ble to see it in th e “By Policy” list

and the “Cu stom Policy Details” pan el.

Where to go from here

Next, define u ser-friendly p resentation n ames to ap pear in the u ser interface for the

policy type and its slots.



Defining presentation names for a new policy type


Defining presentation names for a new policy type

If you w ant u ser-friendly p resentation nam es to appear in the user interface for thepolicy type and its slots instead of the internal names, you m ust:

s define p resentation n ames for the p olicy type in a resource file

s list the resou rce file for the policy type in the BMC IX.properties file

To define presentation names for a policy type

1 Create a resou rce file for the policy typ e to list the p olicy type an d each slot with its

assigned presentation nam e. The resource file name m ust h ave the .properties file

extension.

2 Edit the resource file to ad d an en try for each p resentation n ame assignment.

A To define the p resentation name (label) for the policy type, add a line with th e

following form at to the r esource file:

B To define the p resentation name (label) used for a slot, add a line w ith the

following format to the r esource file.:

3 Place the resource file in the .../console/lib/lang/kbinfo directory.

A Add the base nam e of the resource file to the value of kb_info_resources

pa ram eter in the BMC Impact Explorer .../console/etc/ix.properties file using thisformat:

The defined presentation nam es will display in the BMC Imp act Manager EventMana gemen t Policies tree, the Policy Type p icker w indow, and in the Policy List

pan el. Any slot or policy type for w hich a pr esentation n ame is not d efined d isplaysits internal name.

The event p olicy d etails tab for all user-defined policy types is Custom Policy Details.

CLASS.< policy type name>=< policy type presentation name> Policy

SLOT.< policy type name>.<slot name>=<slot presentation name>

kb_info_resources=<resource file name>,kb_core_resource,kb_deprecated_resource



Creating the event processing rule(s) for a new policy type



Before you can define an event p olicy based on the user-defined policy type that youcreated, you m ust:

s create a new Knowledge Base rule or rules to define the event processing d one by

the policy type

s copy the ru le or rules to the Know ledge Base of each BMC IM instance on w hichthe user -defined policy will ru n

Event Processing Rule Requirements

The event processing ru le or rules that you define for the n ew u ser-defined p olicy

type must:

s do d ynam ic selection (use the using_policy clause)

s reference the policy data class that d escribes the new p olicy type

To create the event processing rule for a new policy type

1 , Add a new file in the .../kb/rules d irectory, for example, my_policies.mrl, for the

new event processing ru le or ru les for the new policy type.

2 Edit the policy MRL file and w rite the event processing ru le for the ap propr iate

rule phase.

For more informa tion, see

s “Evaluation ord er of event p olicy types” on page 269

s “Und erstanding event processing ru les (MRL) for p olicy types” on page 352

s See the MRL for th e pre-defined p olicy types in ...\ kb\ rules\ im_internal.mrl file.

3 Add the file name for the new rule or ru les to the compiler load list in the

.../kb/rules/.load file.

4 Comp ile the BMC Imp act Manager instan ce’s Knowledge Base (KB) after defining

the ru le for the policy type.

For more information on compiling a KB, see BMC Impact Solutions: Knowledge Base

Development Reference Guide.

5 Copy this KB change to every BMC Imp act Manager instance (cell) that w ill use apolicy based on the new policy type.





The definition of the p olicy type is comp lete and u sers can now create policies based

on it in the Cu stom Policy Type pan el.




C h a p t e r 1414Building event groups and imageviews

This chapter d escribes event grou ps an d image views and explains howadm inistrators create them for u se by op erators. This chapter p resents the following

topics:

Understand ing event grou ps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360

Typ es of event grou pings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360

Even t grou p configu ration files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361

Even t tree h iera rchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362

Event tr ee objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362

Understand ing image view s. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

Plann ing even t groups and image view s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364

Working with event groups and image view s. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365Crea ting an event grou p (event tr ee top -level) nod e . . . . . . . . . . . . . . . . . . . . . . . 365

Creating an event group subn ode (even t tree node) . . . . . . . . . . . . . . . . . . . . . . . 366

Deleting an event group subn ode (event tree top -level nod e) . . . . . . . . . . . . . . . 367Hiding a collector in an even t group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367

Show ing a hid den collector in an even t group . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368

Putting an event group into p rod uction or d evelopm ent . . . . . . . . . . . . . . . . . . . 368Ad ding a cu stom image view to an even t group . . . . . . . . . . . . . . . . . . . . . . . . . . 369

Granting u ser access to ev ent groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371



Understanding event groups


Understanding event groups

The Event Groups tab on the Events view of BMC Imp act Explorer allows you to create

and control access to the event group s and their image views th at IT operators u se to

monitor and man age events.

Event grou ps allow the organization of cells and collectors to make event d isplays

mean ingful for operators. For examp le, you m ight create an event grou p for collectorsthat gather database warning events and allow on ly operators that are database

adm inistrators access to that event group . Event group s are d isplayed in a

hierarchical navigation tree. Althou gh som e of the objects displayed in th e tree areun ique to event group s, other objects are common across all three event m anagemen t

tabs on the Events tab of the BMC Imp act Explorer. The rem ainder of this section

provides more detail about the nav igation tree and its objects.

Types of event groupings

In BMC Imp act Explorer, events can be group ed or organized in these ways:

s event collectors--an event list, a mean ingful grou ping of events or even ts groupedby their relationships

s MetaCollectors--a group ing of even ts from several d ifferent even t lists (collectors),

showing their combined status

s event grou ps--a hierarchy of event lists

s image views--a grap hical rep resentation of the collectors in an event group

Event collectors

Event collectors grou p even ts for d isplay in an event list to provide operators w ith

meaningful group s of events and to show relationship throu gh the hierarchy of the

nod es in th e tree. To access the event list for a collector, op erators click th e collectornod e in the navigation tree.

NOTE

Unlike metacollectors, which operators can define themselves in BMC Impact Explorer, only

adm inistrators create event grou ps and image views.





Event collectors are d ynam ic or static. Nodes for d ynam ic collectors ap pear or

disapp ear from the navigation tree based on w hether or not events are pr esent that

meet th e collectors’ criteria. Nod es for static collectors rem ain in th e nav igation treewh ether events are present or not.

MetaCollectors

A MetaCollector is a grou ping of collectors. Op erators create MetaCollectors to view

events from several event lists. Each even t list is shown as a tab in the even t list pan e.

The MetaCollector nod e rep resents the state of the combined events. MetaCollectors

are often used to view collectors from mu ltiple cells in the netw ork.

Event groups

An event grou p is another w ay for showing the relationship of events through th e

hierarchy of the navigation tree. Service ad ministrators and man agers d efine eventgrou ps and associate them w ith one or more collectors. Each level of the collector isshown as a nod e und er the event group . An event list is associated w ith the lowest

level nodes of an event grou p. The parent level of an event group represents all of theevents associated w ith the collectors and it is associated w ith an image view.

Image views

An image view is a grap hical rep resentation of the collectors in an even t grou p. Thecollectors are rep resented by objects that can be placed on a backgroun d im age. The

objects can be g rap hics, such as icons; statistical information, such as the n um ber of

events by p riority or by sever ity; or text, such as a label.


The event grou p configuration file structure is listed in Table 82:

Table 82 Event group configuration files (part 1 of 2)

Folder Contains

\ Imag es Backg rounds an d Icons directories

\ Imag es \ Backgrounds background image files that are shared by all Map

definitions

\ Imag es \ Icons image files wh ich are shared by all Map d efinitions

\ M ap event group tree node template

MapObjectTemplate.xml

\ M ap event group default image view configuration

DefaultMapPage.xsl

\ M ap Map tree definition Maps.xml



Event tree hierarchy


Event tree hierarchy

Event grou ps are displayed in a hierarchical tree, the event tree, in the navigationpan e of the Event Groups tab, as show n in Figure 91. Although adm inistrators see all

the event grou ps th ey create in th e event tree, operators view ing the event tree see

only those event grou ps to w hich th ey are granted access.

Figure 91 Event tree hierarchy

Event group s ap pear as event tree top-level nodes. Beneath event tr ee top-level nodes

you can ad d event tree nodes (child nod es of event group s) to further organ ize event

tree display. To event tree top-level nodes and event tree nodes you can ad dcollectors and subcollectors which rep resent, cells, collectors, an d subcollectors. Use

the Event Group Editor to create and mod ify the event group hierarchy to organize

the d isplay of these objects.

Event tree objects

Table 83 show s the icons and d escriptions of the objects rep resented in the event tree.

\ M ap\ Map_ xxx Map.xml for Map_ xxx as w ell as its MapPages directory

\ M ap\ Map_ xxx \ M apPages all map p age definitions for Map Map_ xxx

Table 82 Event group configuration files (part 2 of 2)

Folder Contains



Understanding image views


Ad ditionally, each object icon in the event tr ee has an associated status, shown as an

icon to the right of the object icon. For information abou t the statu ses represented by

each icon, see the BMC Impact Solutions: Event Monitoring.

Understanding image views

Image view s provide op erators with a gr aph ical representation of the aggregated

state of the event grou ps th ey represent. Adm inistrators create image views by

dragging and dropp ing an image view object, called a widget (shown in Figure 92 on

page 363), onto a backgroun d image. Each wid get represents a group nod e, collector,

or child collector from the event tree.

Figure 92 Image view widgets

Table 83 Event tree objects and definitions

Objecticon Name and definition

event tree top-level node in p rodu ction statu s; the top-level nod e of an event

group that is in p rodu ction status, making the Event Group Editor an d ImageView Editor un available for the event grou p

event tree top-level node in d evelopment statu s; the top-level nod e of an event

group that is in d evelopment status, making the Event Group Editor available

for the event group

event group nod e; an event grou p su bnod e of an event tree top-level nod e or

another event group n ode

child collector nod e; d isplays inform ation from a collector or subcollector of a

cell or collector ad ded as a collector nod e

subcollector node; child node of a collector node

image view widgets



Planning event groups and image views


All event tree nod es with childr en (event tree top-level nodes, event grou p nodes,

and collector nod es with child collectors) have either a default image view or a

custom image view. All such nodes initially display a defau lt image view thatcontains a blank backgroun d and a wid get for each child n ode, as shown in Figure 92.

Adm inistrators create custom image views by add ing an imp orted image (for

examp le, a map of a geograp hical region or a d iagram of the IT system of anenterprise) to replace the blank background of a default image view and by arran ging

widgets rep resenting some or all of the child odes on th e backgroun d, as show n in

Figure 93.

Figure 93 Custom image view

Planning event groups and image views

Planning is essential to creating even t grou ps an d image views tha t logically and

efficiently dep ict IT assets of your enterpr ise. Before creating even t grou ps an d im age

views, consider th ese guidelines:

s Event grou ps an d image views organize and represent the contents of collectors

Consequ ently, you sh ould carefully plan and create the collectors for yourenterprise. Event groups an d image views can pr ovide no more information than

that gathered by collectors. (Collectors must be created before the event grou psthat u se them. For more information abou t collectors, see the BMC Impact Solutions:

Knowledge Base Development Reference Guide.)

s Creating even t grou ps by u sing static collectors allow s you to create the event

group s before you run the event managem ent system in a test or prod uctionenvironment. H owever, this practice can require a significant am oun t of manu al

work d epend ing on the number of event group s you create.



Working with event groups and image views


s Creating event group s by u sing d ynam ic collectors requires less manua l work th an

using sta tic collectors, but th e event groups d o not exist un til cells receive events to

populate the dynamic collectors.

Working with event groups and image views

This section provides instructions for creating event groups and adding associated

nod es that make up an event tree. This section also provides instru ctions for definingcustom image views for event group s.

Creating an event group (event tree top-level) node

Use the Event Group s tab to create an event group .

To create an event group (event tree top-level node)

1 On the menu bar of the Event Groups tab of the Events tab view, choose Edit => AddEvent Group.

The Event Group Editor, shown in Figure 94, is displayed.

Figure 94 Event Group editor

NOTE

Event group s are a pr erequisite for image views. You m ust first create an event grou p to

wh ich you then ad d an image view.



Creating an event group subnode (event tree node)


2 On the Available Collectors pane, select a cell, collector, or su bcollector to ad d to the

new event group .

3 On the Event Group pane, select NewEventsGroup .

4 To add the selected collector in th e Available Collectors pan e to the new eventgroup in the Event Group pane, click the right arrow .

The selected collector ap pears beneath the new event group in the Event Group

pane.

5 To add anoth er collector (or cell or su bcollector) to the new event group , select the

ad ditional collector from th e Available Collectors pan e and click the right arrow .

Repeat this step as necessary to ad d more cells, collectors, or su bcollectors to th e

new event group .

6 To save the even t grou p , click OK.

Creating an event group subnode (event tree node)

Use the Event Group s tab to create an event group subnod e.

To create an event group subnode (event tree node)

1 On the menu bar of the Event Groups tab of the Events tab view, choose

Edit => Add Event Group.

The Event Group Editor is displayed.

2 On the Event Group pane, select NewEventsGroup and click Insert Group.

An event group su bnod e, New Group , is inserted beneath the NewEventsGroup nod e, as shown in Figure 95.

Figure 95 Event tree node addition

3 On the Available Collectors pane, select a cell, collector, or su bcollector to ad d to the

new event group subnode.



Deleting an event group subnode (event tree top-level node)


4 To add the selected collector in th e Available Collectors pan e to the new event

group subnod e in the Event Group pane, click the right arrow.

5 To add a noth er collector (or cell or subcollector) to the new even t grou p su bnod e,

select the ad d itional collector from th e Available Collectors pan e and click the right

arrow.

Repeat this step as necessary to ad d more cells, collectors, or su bcollectors to th enew event group subnode.

6 To save the event group su bnod e, click OK.

Deleting an event group subnode (event tree top-level node)

Use the Event Group s tab to delete an event group subnod e.

To delete an event group (Event tree top-level node)

1 On the event tree of the Event Groups tab, select an even t grou p or an y of its

descendant nodes.

2 From the menu bar, choose Edit => Delete Event Group.

An action confirmat ion dialog box appear s.

3 To delete the event group and its descend ants, click OK.

Hiding a collector in an event group

Use the Event Group pan e to hide a collector in an event group .

NOTE

To delete an event grou p, it must be in developm ent status. If the event grou p is in

prod uction status you m ust change the status before deleting it.

WARNING

Deleting an event grou p d eletes the entire event group and all its descend ants, regardless

of wh at node you select in the event grou p.



Showing a hidden collector in an event group


To hide a collector in an event group

1 In the Event Grou p p ane, select a collector node.

2 Click Hide.

A lock icon is displayed with th e node to show th at the collector w ill not app ear in the

prod uction event group . Event information from the collector an d any subcollectorsare still aggregated by the event group it appears in.

Showing a hidden collector in an event group

Use the Event Group pane to show a hidden event group.

To show a hidden collector in an event group

1 In the Event Group pan e, select a hidd en collector nod e.

2 Click Show.

The collector now app ears in the prod uction event grou p.

Putting an event group into production or development

Use the Image Group Editor to put an event group into produ ction or developm ent.

To put an event group into production or development

1 On the menu bar of the Event Groups tab of the Events tab view, choose

Edit => Add Event Group.

The Event Group Editor is displayed.

2 In the Event Group navigation p ane, select an event group .

3 Click the app ropr iate Status rad io button.

4 Click OK to save your change.



Adding a custom image view to an event group



Use the Image View Editor to add a custom image view to an event group .

Before you begin

Custom image views requ ire files in .jpg or .gif format for use as background images

and icon images. To make these images available to the Image View Editor, copy th e

files to the Backgrounds directory and th e Icons directory in the

$BMCPORTAL_HOME/appserver/websdk/tools/jboss/server/all/data/smsConsoleServer/

Image/Background directory on the system ru nning BMC Imp act Portal.

To add a custom image view to an event group

1 From the event tree of the Event Groups tab, select the event group (an event tree

top-level node).

2 From the menu bar, choose Edit => Edit Image V iew .

The Image View Editor is d isplayed . The Image View Editor shows the current,default image view.

3 To create a custom image v iew, click Use Custom.

4 To add a custom image view backgroun d, from the View tab click the Filename list

and select an im age file.

NOTE

If two ad ministrators have the same event group open and one adm inistrator changes the

status of the event group from developm ent to prod uction, the prop erties of the event group

will not be protected an d th e other adm inistrator will be able to edit the prop erties of the

event group .

Image view objects become disabled after editing the event grou p.

NOTE

An event group mu st be in d evelopment status to ad d a custom image view. If the event

group is in p roduction status you mu st change the status before add ing the image view.

Custom image view still displays an event grou p or collector object that w as deleted u sing

the Event Group Editor.





The selected image file appears in the image p ane of the Image View Editor, as

shown in Figure 96. If no image file is ava ilable from the list, see “Before you

begin” on p age 369 before the start of this procedu re.

Figure 96 Image View editor

5 To place the wid gets representing collectors for the event group , drag an d d rop the

wid gets onto the image view background .

When you drag and drop a w idget, the Selected Object tab is enabled for the

wid get. Use the controls on this tab to modify the appearan ce of the widget on th e

image view background .

6 To save the custom image view an d close the Image View Editor, click Save Custom

Image & Close.

NOTE

You shou ld choose contrasting w idget fill colors and custom im age canvas colors. Some

color combinations can result in text that cannot be seen. For examp le, if the wid get fill

color is set to transp arent an d the custom image canvas color is set to w hite, wh ite letters

that app ear on the wid get cannot be seen against the white canvas.

image view widgets



Granting user access to event groups


The saved image view is displayed in the Event Groups tab.


Adm inistrators grant op erators access privileges for event grou ps using the Event

Group Properties editor. The Event Group Properties editor controls access to and th e

status of each event tree top-level nod e.

To grant user access to event groups

1 From the event tree of the Event Groups tab, select an event grou p (an event tree

top-level node).

2 From the menu bar, choose Edit => Edit Event Group Properties.

The Event Group Properties editor, shown is displayed.

3 (optional) Add a text description of the event grou p.

4 Modify the Read an d Write perm issions to grant or deny access for each group asnecessary. When complete, click OK.

BMC Imp act Explorer saves th e access settings for the selected event grou p.

TIP To modify the app earance of widgets that ap pear on a default image view, edit the object

app earance attributes in the file defaultmappage.xsl located in the

BMCPORTAL_HOME\ appserver\ w ebsdk\ tools \ jboss \ server\ all\ data\ smsConsoleServer directory on the system ru nning BMC Imp act Portal. The file contains comm ents

that identify the app earance attributes.



Part 3 Appendixes 373

3Part

Part 3Appendixes


Appendix ATrou ble-shoot ing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375

Appendix B

BMC SIM and EM CLI Referen ce . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381

Appendix C

mcell.conf file pa rameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443

Appendix D

Environ ment va riables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465

Appendix E

BMC Microsoft Wind ow s serv ices and UN IX processes. . . . . . . . . . . . . . . . . . . . . 469

Appendix F

BMC Im pact Event Ad ap ters MAP files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473

Appendix G

IP Adap ter s. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489

Appendix H

BMC Im pact Event Ad ap ters parsers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505

Appendix I

Backend processes for pu blishing and un pu blishing MIB files . . . . . . . . . . . . . . . 517




A p p e n d i x AATrouble-shooting

This appen dix presents the follow ing topics:

Trou ble-shooting BMC Im pact Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375Problem : The cell w ill not start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375

Problem: The p rimary and secondary servers for my h igh availability cell are in

active m ode simultaneously or are unsyn chronized . . . . . . . . . . . . . . . . . . . . . 376Trou ble-shootin g event managem ent policies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377

Problem : The policy is not runn ing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377Problem: The notification p olicy is configured to generate a n otification em ail,

bu t no em ail is being sen t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378

Problem: I receive an invalid d ata error w hen ru nning a d ynam ic dataenrichment p olicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378

Problem: I receive an error message when run ning a d ynam ic data enr ichm ent

blackout p olicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379Trouble-shooting tools for d ynam ic data en richment policies . . . . . . . . . . . . . . . 380

Trouble-shooting BMC Impact Manager

Problem: The cell will not start

If there is nothing in the log trace files to help you d iagnose the p roblem, try ru nn ing

the cell in the foreground . This w ill frequen tly p rovide the information n eeded to

correct the problem or enough information for BMC Sup port to diagnose theproblem. To run the cell in the foreground , enter:

mcell –n {cell_name} –d



Problem: The primary and secondary servers for my high availability cell are in active mode simultaneously or are


Possible solution: Delete the mcdb file

If the cell has been ru nn ing p reviously, it is likely that th e mcdb file is corru pted . To

correct this p roblem, follow these steps:

1 Back up the current mcdb file (located a t MCELL_HOME \ log\ cellName).

2 Delete the original mcdb file from MCELL_HOME \ l og \ cellName.

3 Restart the cell.

The cell will create a new mcdb file when it is restarted .

Problem: The primary and secondary servers for my highavailability cell are in active mode simultaneously or areunsynchronized.

This problem can occur wh en the primary and second ary servers are running on anetwork that d oes not have a reliable connection, if you h ave started a highavailability cell u sing an y of the -i initialization options (for exam ple, -ia, -id or oth er

variants), or if the p rimary server w as started first and terminates before the

second ary server is started.

Possible solution: Synchronize the mcdb and xact files ofthe primary and secondary servers

Follow these steps to correct the incomp atible states between the p rimary and

second ary servers:

1 If the p roblem was caused by an u nreliable network, resolve the network issue.

2 Shu t d own both cell servers

3 Copy the mcdb and xact files of the p referred server to th e other server. (The

preferred server can be either primary or second ary.)

4 Restart both servers.

NOTE

Transactions can be lost when th e mcdb is deleted. The new mcdb w ill only hold the

transactions in th e xact file at the tim e the cell is started .



Problem: There are two notification objects from the Impact Portal in the cell.


Problem: There are two notification objects from the ImpactPortal in the cell.

There shou ld on ly be one notification object from the Imp act Portal per cell. Perform

the following steps to clean u p th e objects:

1 Edit the mcell.conf file to uncomm ent the ServiceModelPublish parameter and set

its value to No.

2 Obtain a list of all of the notification ob jects for the cell by entering the followingcommand:

mquery -n <cellname> -d -f baroc -a SIM_NOTIFICATION_REGISTRY

A list of notification objects is displayed.

3 Note the d ata_han dles for each notification object.

4 To delete each n otification object, follow these steps for each notification object:

A From a comman d line, enter: mposter -n cell_name -d

B Then enter: ddelete notification_data_handle ; END

C Then enter Ctr l C: ^C

Trouble-shooting event management policies

This section lists some comm on p roblems en coun tered w ith event man agementpolicies and some tools to assist you troub le-shoot pr oblems not listed h ere.

Problem: The policy is not runningIf the p olicy is not ru nn ing, try the following:

s Access the Policy Details tab for the policy and en sure that th e Enabled check box is

selected.

s ( Dynamic data enrichment policies only ) Access the Policy Details tab for the p olicyand ensure that the Match Fields an d Output Fields contain th e exact same n um ber of

match fields in the sam e ord er as the associated data enrichment sou rce file.



Problem: The notification policy is configured to generate a notification email, but no email is being sent


s ( Dynamic data enrichment policies only ) Ensure that you have imported the data from

the d ata enrichm ent source file into the cell using th e Import tab.

Problem: The notification policy is configured to generate anotification email, but no email is being sent

When the p rod uct is installed, par t of the installation process locates the SMTP server.If an SMTP server is not installed before the p rod uct installed, the ema il notification

will not be able to send an email. If you installed an SMTP server a fter the productwas installed, follow these steps to allow the p rod uct to recognize the SMTP server:

1 Down load and install the blat utility. (This utility is pu blic dom ain.)

2 From a comm and line, run mc_setup_mail.cmd.

3 Run blat and specify the nam e of the mail server and th e name that you w ant toappear in the From line of the notification email.

Problem: I receive an invalid data error when running adynamic data enrichment policy

Access th e Policy Details tab for the p olicy and ensu re that the Match Fields an d Output

Fields contain the exact same nu mber of match fields in the sam e order as the associated d ata

enrichment source file.

Figure 97 shows an examp le error message generated by dynam ic data enrichment

policy that has a m ismatch between th e match and outp ut fields defined in the p olicyand the nu mber of colum ns includ ed in the enr ichm ent data source file.



Problem: I receive an error message when running a dynamic data enrichment blackout policy


Figure 97 Invalid data error: dynamic enrichment policy

Problem: I receive an error message when running a dynamicdata enrichment blackout policy

Ensure that the timefram e defined in the data sou rce enrichm ent file actually exists.

For inform ation on creating valid timefram es, see “How to create a new local

timeframe” on page 274.

Figure 98 shows an example error message generated by d ynam ic blackout p olicy

that has an invalid timeframes.

Figure 98 Invalid timeframe error: dynamic blackout policy



Trouble-shooting tools for dynamic data enrichment policies


Trouble-shooting tools for dynamic data enrichment policies

You can use the following m ethods to trou ble-shoot the d ynam ic data enrichm entpolicies that you have d efined:

s Enable the Match Tracing check box in th e Dynamic Enrichment Policy D etails tab toto add diagnostic notes to the event.

s Access the History tab and check the Op erations Log to determine w hich d ynam icdata en richm ent policy ad ded the informa tion into the event.




A p p e n d i x BBBMC SIM and EM CLI Reference

This appen dix provid es reference information on the BMC Impa ct Solutions and

BMC Imp act Portal comm and line interfaces (CLI) and their configu ration. It contains

the following top ics:

BMC Im pact Manager CLI comm ands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382

BMC Impact Man ager CLI common com mand op tions . . . . . . . . . . . . . . . . . . . . 383BMC Im pa ct Manager CLI comm on r etu rn codes . . . . . . . . . . . . . . . . . . . . . . . . . 384

mccomp—Comp iling ru les in the Know ledge Base. . . . . . . . . . . . . . . . . . . . . . . . 385mcell—Start ing a cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386

mcfgtrace—Con figuring tr acing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389

mclassinfo—Requ estin g class in form ation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390mcollinfo—Getting inform ation abou t a sp ecific collector . . . . . . . . . . . . . . . . . . 396

mcontrol—Perform ing cell contro l operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398

mcrtcell—Creating a n ew cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401mcstat—Return ing cell status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405

mdelcell—Deleting a cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406

mgetinfo—Retrieving information abou t a cell . . . . . . . . . . . . . . . . . . . . . . . . . . . 408mgetrec—Obtaining a global record valu e . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412

mkb—Up dating the Know ledge Base . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414

mkill—Stopping a cell. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417

mlogchk—Performing consistency checks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418

mp kill—Stopp ing mposter and msen d server p rocesses . . . . . . . . . . . . . . . . . . . 420

mp oster and msen d—Man aging d ata, global record s, and events . . . . . . . . . . . 422

mqu ery—Retr ieving objects from a cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427

mrecover—Recover ing from a catas trop hic data loss . . . . . . . . . . . . . . . . . . . . . . 432

mrextract—Extracting cell state files to create n ew state files . . . . . . . . . . . . . . . 434mrm erge—Merging event objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436

msetm sg—Mod ifying an event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437

msetrec—Setting the valu e of a global record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439

BMC Im pa ct Man ager CLI configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440

Configuring tracing for BMC Imp act Manager CLI command s . . . . . . . . . . . . . 442

BMC Im pa ct Man ager CLI trace configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442



BMC Impact Manager CLI commands


BMC Impact Manager CLI commands

Use the comm and s from th e command line interface (CLI). All of the cell-related CLI

comm and s are located in MCELL_HOME /bin. You can invoke the comman ds from a

comm and prom pt on Microsoft Window s, from a UN IX prom pt, or from a script. Acommand can affect the cell, the Knowled ge Base, or other files.

Table 84 lists all of the available BMC Imp act Manager command s along w ith a brief

description of the purp ose for each comm and .

Table 84 BMC Impact Manager CLI command descriptions

Command Description Page

mccomp compiles rules in the Knowledge Base 385

mcell starts a cell 386

mcfgtrace mod ifies tracing configuration of a ru nning cell 389

mclassinfo obtains class information from a cell 390

mcollinfo obtains collector inform ation from a cell 396

mcontrol performs control operations on a ru nning cell 398

mcrtcell creates a new cell 401

mcstat return s the statu s of a cell 405

mdelcell deletes a cell 406

mgetinfo retrieves information abou t a ru nning cell 408

mgetrec retrieves the content of a global record 412

mkb views/ up dates the Knowledge Base 414

mkill stops a cell 417

mlogchk performs consistency checks 418

mposter sends or man ipulates data, records, and even ts 422

mrecover recovers catastroph ic loss of d ata 432

mrextract extracts cell state files to create n ew state files 434

mrmerge mer ges extracted cell state files 436

mquery retrieves objects from a cell 437

msend sends an event to a cell 437

msetmsg mod ifies an event in a cell 437

msetrec sets the valu e of a global record 439



BMC Impact Manager CLI common command options


BMC Impact Manager CLI common command options

Many comm and s use the same options that perform th e same functions in eachcomm and . Add itional options that are specific to the command are listed in th e

section of this app end ix that is ded icated to that comm and .

Table 85 describes the comm on command options that app ly to all comm and s.

Using the -n option

To interact with anoth er cell, a cell uses th e mcell.dir file, which maps cell names to a

host name or to an IP add ress and port. With CLI comm and s, you can use the -n

option to sp ecify a cell by using either of the following form ats that ar e used in the

mcell.dir file:

s Designate a cell name by sp ecifying -n cellName.

This format m aps the cellName to the host, port, and encryption key in the

mcell.dir file.

NOTE

A few comm and s have comman d-specific options that override the comm on CLI comman d

options listed inTable 85. For example, the -p option for the mkb comm and p rints the

contents of the designated manifest.kb file, rather th an assigning the specified value (Value)

to the option Var. If a command has an op tion that overrides the common option, thecommand -specific option is noted in the section of this app end ix dedicated to thatcommand.

Table 85 Common options for CLI commands

Option Description

-c ConfigFile specifies a configuration file to use instead of the defau lt

MCELL_HOME \ e tc\ mcl ient.conf file

-h

or

-?

displays help information, includ ing syntax and op tions

-l HomeLocation specifies home directory (HomeLocation) for the comm and if it is not

specified with MCELL_HOME-n cellName

or

-n @Host[/Port[#Key ]]

starts the cell named cellName (as defined in mcell.dir). For more

information, see “Using the -n option”.

-p Var =Value assigns the sp ecified valu e (Value) to the option Var

-q invokes quiet execution (no bann er app ears)

-v activates verbose mod e to display m ore information

-z displays version information



BMC Impact Manager CLI common return codes


s Designate the h ost, port, and encryption key by u sing -n @Host[/Port[#Key ]],

where

— Host is either a host name or an IP address

— Port is the port nu mber

— Key is the encryption key

The importance of setting a valid encryption key when using the -n option

If you do n ot specify Key or Key and Port, the default values are app lied. The default

value for Key is 0, and the d efault value for Port is 1828.

Accepting th e default value for Port means th at your cell has to listen on p ort 1828,wh ich is normally the case with the default installation p rocedu re.

When BMC Imp act Manager is installed, the d efault installation proced ure sets Key tomc, instead of 0. Unless you chan ge the encryption key to 0 du ring installation orafterw ard s by manu ally editing the $MCELL_HOME/etc/mcell.dir file, you need to

specify th e Key explicitly. Otherw ise, if you d o not specify the Key, the CLI will not be

able to connect to the cell.

For security p urp oses, you should set Key to a valid value other than the default.

BMC Impact Manager CLI common return codes

Table 86 describes the retur n codes common to all CLI comm and s. Some CLIcomm and s have r eturn codes th at are sp ecific to that comm and . If a CLI comm and

has comm and -specific return codes, those codes are listed in th e section of this

append ix dedicated to that command .

Table 86 Common return codes for CLI commands

Code Description

0 success

1 bad u sage (comman d includes non existent options or an invalid combination of options and argu ments)

10 initialization failur e

11 trace initialization failed

12 configura tion initialization failed

13 outbound communication setup failed

14 inboun d comm un ication setup failed

15 message hand ling initialization failed

16 persistency setup failed



mccomp—Compiling rules in the Knowledge Base


mccomp—Compiling rules in the Knowledge Base

The mccomp command is the executable that calls the Know ledge Base compiler. The

only required comm and option is the path to the manifest.kb file.

mccomp syntax

Figure 99 shows the syntax for mccomp.

Table 87 lists the command -specific options for mccomp. For a list of common

comm and options that ap ply to all CLI comm and s, see “ BMC Imp act Manager CLI

common command options” on page 383.

17 port range limitation failed

20 connection to cell failed

25 memory fault26 comman d failed

27 syntax error

28 invalid answ er received

Figure 99 mccomp syntax

mccomp [-h|?] [-z] [-t] [-v [VERBOSE|INFORM|WARNING|ERROR|FATAL]] [-eErrorLogFile] [-p prefix] [-n CellName | ManifestKBFilePath]

Table 87 mccomp options

Option Description

-e ErrorLogFile redirects error m essages to a user-specified file; used prim arily in scripts

-n CellName |

ManifestKBFilePath

specifies to u se $MCELL_HOME/etc/CellName/kb/manifest.kb as the

KB manifest file.

This option is ignored if ManifestKBFilePath is sp ecified explicitly.

-p prefix Creates a package named prefix.pkg

-t generates tracing calls in the resu lting compiled files for debu gging

pu rposes. For more information, see “ mccomp examp le” on page 386.

- v

[VERBOSE|INFORM|WARNING

|ERROR|FATAL]

sets the verbosity level of messages. Only m essages of the sp ecified level or

higher are pr inted. If -v is not u sed, the d efault level is INFORM. If -v is

used without sp ecifying a level, the d efault level is VERBOSE.

Table 86 Common return codes for CLI commands

Code Description



mcell—Starting a cell


The -t option en ables extra cell ru ntime tracing by the rules engine if the cell

configuration param eter TraceRuleLevel=2. The trace outpu t goes to the standard

cell trace in th e RULES mod ule. You can includ e the outp ut in the transaction file bysetting TraceRuleToXact=Yes.

mccomp example

Figure 100 shows an examp le of mccomp .

This comm and prod uces outp ut similar to the examp le shown in Figure 101.

mccomp return codes

There are no command -specific retu rn codes for mccomp. For a list of common return

codes that ap ply to all CLI command s, see “ BMC Impact Manager CLI comm onreturn codes” on page 384.


The mcell comma nd starts a sp ecified cell.

mcell syntax

Figure 102 shows the syntax for mcell.

WARNING

A Knowledge Base compiled for run time rule tracing u sing -t can experience considerable

runtime performance degrad ation.

Figure 100 mccomp examplemccomp -n cell1

Figure 101 Example output for mccomp

Parsing BAROC file classes/root.baroc

Parsing BAROC file classes/intevt.baroc

Compilation ended successfully

Figure 102 mcell syntax

mcell [-h|-?] [-z] [-q] [-d] [-i [a][c][d][e]] [-r] [-n cellName] [-lHomeLocation] [-c ConfigFile] {-p "Var =Value"}





Table 88 lists the comm and -specific options for mcell. For a list of common comm and

options that ap ply to all CLI comm and s, see “ BMC Imp act Manager CLI comm on

command options” on page 383.

mcell example

On UNIX, mcell can be started from a comm and p romp t as a daem on (running in

backgroun d) or as a terminal program (running in foregroun d).

On Microsoft Wind ows, mcell can be started from a comm and prom pt as a service or

as a terminal program .

You can sta rt the cell using any of the following method s:

s To start the cell in the foreground rather th an as a service or d aemon on UN IX and

Microsoft Window s platforms, type the comman d shown in Figure 103.

Table 88 mcell options

Option Description

-c specifies a configura tion file other than th e defau lt. If -c is u sed, all configu ration

files are assum ed to be in the d irectory in w hich the sp ecified configuration file is

located.

-d run s in foregroun d instead of as a service or daem on

-i initializes the cell repository; can combine with suboptions:

s -i—-ied

s -ie—events

s -id—data --initializes all data

s -ic—EventCounters -ia—-iedc—initializes all da ta

Warning : Unexpected cell states can occur if you initialize only events or only d ata,

because events and data m ay be correlated.

-r run s in cell recovery mod e

Figure 103 Starting a cell

mcell -n cellName -d

NOTE

When starting BMC Imp act Solutions software as a d aemon process on UN IX platforms, use

the method described in “ Stopp ing or starting a cell on UNIX compu ters” on page 40.





s To start the cell as a service on a Microsoft Window s platform, type the command

shown in Figure 104.

When started from command promp t without the -d option, mcell contacts theService Control Man ager to start itself as a service. It uses mcell_cellName as the

service nam e, with the cell name as specified w ith the -n option. Without the -n

option, the host name is taken as cellName.

s To start the BMC Imp act Solutions service on Microsoft Wind ow s and initialize the

dyn amic data in the cell, type the following comm and shown in Figure 105.

mcell return codes

Table 89 lists the comm and -specific return codes for mcell. For a list of comm onreturn codes that app ly to all CLI comm and s, see “ BMC Imp act Manager CLI

common return codes” on page 384.

Figure 104 Starting a cell as a service on windows

: net start mcell_cellName

Figure 105 Starting the BMC Impact Manager service on Microsoft Windows

net start mcell_cellName -ia

WARNING

If you start a cell with th e mcell -ia or mcell -id comman ds, you mu st re-register the cell with

the BMC Portal.

Table 89 mcell return codes (part 1 of 2)

Code Description

2 bad h ome d irectory option u sage

3 no h ome directory specified

4 invalid home directory specification

5 application system initialization failed

19 logging facility initialization failed

29 Know ledge Base load failed

37 message han dling m od ule initialization failed

39 internal object in itialization failed

47 event p rocessing mod ule initialization failed

49 save state reload failed

57 query h and ling m odu le initialization failed

59 service activation failed



mcfgtrace—Configuring tracing


mcfgtrace—Configuring tracing

The mcfgtrace comm and mod ifies the tr acing configuration of a ru nning cell andtakes the same argu ment format as a line in the mcell.trace file.

See “ BMC Imp act Manager CLI trace configuration” on page 442 for instructions on

setting u p CLI trace configuration files.

mcfgtrace syntax

Figure 106 shows th e syntax for mcfgtrace .

The -n opt ion is required if the cell is remote or if cellName d iffers from HostName.

See “ Using the -n option” on page 383 for more information.

Table 90 lists the comm and -specific option for mcfgtrace. For a list of comm on



mcfgtrace parameters

Table 91 lists the parameters for mcfgtrace .

67 internal event module initialization failed

69 metr ics initialization failed

77 data processing mod ule initialization failed79 metr ics activation failed

97 service setup failed

Figure 106 mcfgtrace syntax

mcfgtrace [-h|-?] [-z] [-q] [-c ConfigFile]{-p "Var =Value"} [-n cellName|-n @Host[/Port[#Key]]] [-l HomeLocation] [-v](Module Level Destination|

Module SWITCH Switch Destination)

Table 90 mcfgtrace option

Option Description

Module Level Destination See “ mcfgtrace parameters” on p age 389.

Table 89 mcell return codes (part 2 of 2)

Code Description



mclassinfo—Requesting class information


mcfgtrace example

To activate maximu m tracing for all mod ules and send the outp ut to the file all.trace

in the temp orary directory for Cell1, w hich is by defau lt MCELL_HO ME \ tmp\ Ce ll1,type the command shown in Figure 107.

mcfgtrace return codes

There are n o specific retu rn codes for mcfgtrace. See “ BMC Imp act Manager CLIcommon r eturn codes” on page 384 for a list of comm on retu rn codes that app ly to all

CLI command s.


The mclassinfo comm and retrieves class information about both event an d d ata

classes that are load ed in the cell. Inform ation consists of class name, slot

descriptions, and subclasses.

You can retrieve the complete class tree in a h ierarchical form, or you can retrieve

only selected classes, instead of the whole hierarchy.

You can r etrieve associated definitions of enum erations u sed in th e classes. Thesedefinitions are repor ted before the class tree.

Table 91 mcfgtrace parameters

Parameter Available values

Module ALL | Module

Level ALL | VERBOSE | INFORM | WARNING | ERROR | FATAL

SWITCH SwitchName

Destination no | stderr | console | DestinationFileName

Figure 107 mcfgtrace examplemcfgtrace -n Cell1 ALL ALL '%T/all.trace'





mclassinfo syntax

Figure 108 shows th e syntax for mclassinfo.

Table 92 lists the command -specific options for mclassinfo. For a list of common

comm and options that ap ply to all CLI comm and s, see “ BMC Imp act Manager CLIcommon command options” on page 383.

mclassinfo output

You can requ est outpu t in raw format for parsing by a p rogram. You can also requeststandard outp ut formatted for users, includ ing verbose outpu t that provides

ad ditional information. See Table 92 for the available options.

Raw output format

The outp ut consists of the class tree, optionally pr eceded by the enu mera tion

definitions, as show n in Figure 109. The enu meration d efinitions are r eported asEnumInfo.

Figure 108 mclassinfo syntaxmclassinfo [-h|-?] [-z] [-q] [-c ConfigFile]{-p "Var =Value"} [-n cellName | -n @Host[/Port[#Key]]] [-1 HomeLocation] [-v][-a Amount] [-d] [-e] [-x] [-u] [-r]

[-o OutputFile] [{Class}]

Table 92 mclassinfo options

Option Description

-a Amount specifies the amo un t of information: 0, 1, 2, 3

(See “ Information amou nt” on page 393); default is 2

-d reports data class d efinitions instead of event class

-e reports enu meration d efinitions used in th e classes

-o OutputFile prod uces the outp ut in a file called OutputFile, instead of using

standard ou tput

-r produ ces raw outpu t for programs

-u reports u nique slots only, exclud ing red efined slots in su bclasses

-x reports enu meration d efinitions only (exclud e classes)

Class nam es of selected classes

Figure 109 Raw output format for mclassinfo

EnumInfo = EnumTypeCount (EnumTypeInfo)*EnumTypeCount

EnumTypeInfo = EnumTypeName EnumValCount (EnumValName)*EnumValCount





The class tree is rep orted depth -first, left-to-right, as ClassInfo, as shown in

Figure 110.

Slot value typ es (ClassSlotValType) are encoded by tw o characters. The first one

ind icates wh ether it is a simp le slot (S) or a list (L). List slots are defined in BAROC asLIST_OF. The second character determ ines the type of the slot value. It corresponds to

the BAROC d efinition as listed in Table 93.

A slot representation typ e (ClassSlotRepType) correspond s to the representation

facet of the slot. If that facet is not sp ecified, it is rep orted as an asterisk (*).

Flags contain Boolean facets of the slot. For every facet, one character is repor ted. Anup percase character mean s the facet is TRUE; a lowercase character mean s it is FALSE.

Table 94 lists the facets that are rep orted .

Figure 110 Class tree for mclassinfo

ClassInfo = ClassCompCount(ClassCompInfo)*ClassCompCount

ClassCompInfo = ClassName ClassFlags ClassSlotCount

(ClassSlotInfo)*ClassSlotCount ClassInfo

ClassSlotInfo = ClassSlotName ClassSlotValType ClassSlotRepType

ClassSlotFlags ClassSlotDefaultValueLength

ClassSlotDefaultValueText

ClassSlotValType = ClassSlotStructCode ClassSlotTypeCode

ClassSlotStructCode = S | L

ClassSlotTypeCode = i | r | p | s | e:EnumerationTypeName

| c | c:BaseClass

| q | q:BaseClass

ClassSlotFlags = (r|R) (k|K) (p|P) (d|D) (h|H)

Table 93 Type of slot value for mclassinfo

Slot Type Definition

i INTEGER

r REAL

p POINTER

s STRING

e;EnumerationTypeName Enumeration

c:BaseClass ECF of BaseClass

q:BaseClass QUERY of BaseClass

Table 94 Reported facets

Facet Function

r|R read_only

k|K key

p|P parse





Standard output format

Stand ard ou tpu t format is formatted for end-users but d oes not report the coun ts and

represents the tree structure through indentation.

Information amount

The amoun t of reported information is limited as sh own in Table 96.

mclassinfo examples

mclassinfo can be used a s shown in the following examp les.

Obtaining a list of classes

To obtain a list of classes used by a cell nam ed grace, type the comm and sh own inFigure 111.

d|D dup_detect

h|H hidden

Table 95 Class flags

Flag Function

p|P pu blishable class

Table 96 Information amount limitation options for mclassinfo

Option Description

-a 0 reports on ly class names; no slot information is reported

-a 1 reports slot names

-a 2 add s slot names and r epresentation type (default)

-a 3 add s slot flags and d efault value

Figure 111 Example of mclassinfo command for a list of classes

mclassinfo -n grace -a 0

Figure 112 Example output of mclassinfo command for a list of classes (part 1 of 2)

Class: CORE_EVENT

Class: MC_CELL_CONTROL

Table 94 Reported facets

Facet Function





Obtaining a List of Slot Names

To obtain a list of slot names u sed by a cell nam ed grace, type the comm and shown inFigure 113.

Figure 114 shows an examp le of the outpu t.

Adding Slot names and representation types

To add slots names and representation types for u se by a cell nam ed grace, type thecommand shown in Figure 115 on page 394.

Class: MC_CELL_START

Class: MC_CELL_STOP

Class: MC_CELL_TICK

Class: MC_CELL_STATBLD_START

Class: MC_CELL_STATBLD_STOPClass: MC_CELL_DB_CLEANUP

Class: MC_CELL_CONNECT

Class: MC_CELL_CONNECT_RESOURCES_EXPANDED

Class: MC_CELL_CONNECT_SUSPENDED

Class: MC_CELL_CONNECT_RESUMED

Class: MC_CELL_CLIENT

.

Figure 113 Example of mclassinfo command for list of classes


Figure 114 Example of mclassinfo command output for list of classes

Class: CORE_EVENTSlot: event_handle

Slot: mc_ueid

Slot: source

Slot: sub_source

Slot: hostname

Slot: origin

.

.

.

Figure 115 Example of mclassinfo command for adding slot names


Figure 112 Example output of mclassinfo command for a list of classes (part 2 of 2)





Figure 116 shows an examp le of the outp ut.

Adding slot flags and default values

To add slot flags and default values for use by a cell named grace, type the comm and



mclassinfo return codes

Table 97 lists the comm and -specific return codes for mclassinfo. For a list of comm on

return codes that app ly to all CLI comm and s, see “ BMC Imp act Manager CLIcommon return codes” on page 384.

Figure 116 Example of mclassinfo command output for adding slot names

Class: CORE_EVENT -Flags: p

Slot: event_handle - Type: INTEGER

Slot: mc_ueid - Type: STRING

Slot: source - Type: STRING

Slot: sub_source - Type: STRING

Slot: hostname - Type: STRING

Slot: origin - Type: STRING

.

.

.

Figure 117 Example of mclassinfo command for adding slot flags


Figure 118 Example of mclassinfo command output for adding slot flags

Class: CORE_EVENT -Flags: p

Slot: event_handle - Type: INTEGER - Flags: rkpd - Def: 0

Slot: mc_ueid - Type: STRING - Flags: rkPd - Def:

Slot: source - Type: STRING - Flags: rkPd - Def:

Slot: sub_source - Type: STRING - Flags: rkPd - Def:

Slot: hostname - Type: STRING - Flags: rkPd - Def:

Slot: origin - Type: STRING - Flags: rkPd - Def:.

.

.

.

Table 97 mclassinfo return codes

Code Description

31 cannot read inp ut file



mcollinfo—Getting information about a specific collector



The mcollinfo command retrieves information abou t collectors loaded in a cell.Information consists of collector nam e, perm ission settings, referenced classes and

subcollectors. The complete collector tree is retrieved an d reported in a h ierarchicalform. As an option , specific information abou t selected collectors can be retrievedinstead of the wh ole tree.

mcollinfo syntax

Figure 119 shows the syntax for mcollinfo .

The -n option is required if the cell is remote or if cellName d iffers from HostName.See “ Using the -n option” on page 383 for more information.

Table 98 lists the command -specific options for mcollinfo . For a list of common


mcollinfo output

You can requ est outpu t in raw format for parsing by a p rogram. You can also requeststandard outp ut formatted for users, including verbose outp ut that provides

ad ditional information. See the preced ing table for the ava ilable options.

Figure 119 mcollinfo syntax

mcollinfo [-h|-?] [-z] [-q] [-c ConfigFile] {-p “Var =Value”}

[-n cellName | -n @Host[/Port[#Key]]] [-1 HomeLocation] [-v][-a Amount][-r] [-o OutputFile] ( -d | [-i] [-s] ( Collector | -f InputFile ) )

Table 98 mcollinfo optionsOption Description

-a Amount specifies the amou nt of inform ation (0, 1, 2); the defau lt is 2. For m ore

information, see “ Information amou nt” on page 393.

-d reports collector definitions

-f {InputFile} read s collectors from InputFile instead of from comm and line

-i rep orts collector object identifier (OID)

-o OutputFile pro du ces the outp ut in a file called OutputFile, instead of using

standard outpu t

-r prod uces raw outp ut for programs

-s reports collector status and severity coun ters

Collector specifies the collector nam e or OID with op tional + suffix for closure





Raw output format

Raw ou tpu t consists of the collector tree, as show n in Figure 120 on page 397. The

collector t ree is rep orted depth -first, left-to-right, as CollInfo.


Stand ard ou tpu t is essentially the same as raw outp ut, but standard outp ut d oes not

report the counts. Standard ou tpu t represents the tree structure through indentation.

By defau lt, it reports perm issions as a sequen ce of role nu mbers. Classes are repor tedas object identifiers (OIDs). In verbose-form atted outp ut, it reports roles and classes

with their nam es instead of num bers or OIDs.

Information amount

The amoun t of reported information is limited as sh own in Table 99.

mcollinfo examples

Figure 121 shows an examp le of mcollinfo .

Figure 120 Raw output format for mcollinfo

CollInfo = CollCompCount (CollCompInfo)*CollCompCount

CollCompInfo = CollName CollPerm CollClassCount(CollClass)*CollClassCount CollInfo

CollPerm : CollPermR CollPermW CollPermX

CollPerm_ : CollRoleCnt (CollRole)*CollRoleCnt

Table 99 Information amount limitation options for mcollinfoOption Description

-a 0 reports on ly collector n ames

-a 1 add permissions

-a 2 add referenced classes

Figure 121 mcollinfo example

mcollinfo -n dbg -o Net.Global

6.1



mcontrol—Performing cell control operations


You can requ est user-formatted outp ut in verbose mod e as shown in Figure 122.

You can also request the nu mber of events for each severity/ status combination in

the collector as show n in Figure 123. You m ust sp ecify the collector name.

mcollinfo return codes

Table 100 lists the comm and -specific return code for mcollinfo . For a list of common



The mcontrol command per forms control operations on a cell. The operation is stated

as an argument.

mcontrol syntax

Figure 124 on page 398 shows the syntax for mcontrol.

The -n option is required if the cell is remote or if cellName d iffers from HostName.

See “ Using the -n option” on page 383 for more information.

Figure 122 mcollinfo command for verbose mode

mcollinfo -n dbg -v -o Net.Global

Collector Net.Global

OID=6.1

Figure 123 mcollinfo command for number of events for severity/status

mcollinfo -n dbg -v -s Net.Global

Collector Net.Global

Severities=0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

Table 100 mcollinfo return codes

Code Description

31 cannot read inp ut file

Figure 124 mcontrol syntax

mcontrol [-h|-?] [-z] [-q] [-c ConfigFile] {-p "Var =Value"}

[-n cellName | -n @Host[/Port[#Key]]] [-1 HomeLocation] [-v] Control





Table 101 lists the comm and -specific option for mcontrol. For a list of common



Table 102 lists the following controls that ar e available.

Table 101 mcontrol option

Option Description

Control specifies the control command to use. See Table 102 for the available control

commands.

Table 102 mcontrol controls (part 1 of 2)

Control Description

metrics [on|off|reset] on = enables metrics

off = disables metrics

reset = resets runn ing coun ters

If an arg um ent is not specified, metrics are reported by d efault.

pause susp ends reception of adapter m essages; events are no longer

accepted

prop [{Destination}] if one or m ore Destinations are mentioned , only

prop agations to these d estinations are r etried; if no

Destinations are specified, all pend ing pr opagation

destinations are r etried

reload [{dir|trace|conf|collect

|kb|data|all}]

reload cell configuration , for one or more categories; if you do

not choose an argu men t, all categories reload

s dir—mcell.dir

s trace—mcell.trace

s conf—mcell.conf , propagate, mod ify

s collect—collector definitions

s kb—Knowledge Base, classes, rules

s data—data instances

s all—all the categories

restart stops and restarts the cell

shutdown terminates the cell in fast shu tdow n m ode; same as mkill -s

standby switches cell to stand by mod e

start resum es reception of ad apter m essages; cell operates normally

again

statbld forces the cell to perform a StateBuild immediately instead of

waiting for th e next schedu led StateBuild; mcontrolwaits un til

termination of the forced StateBuild and, if successful, returns

the path to the resulting saved state file

stop terminates the cell in normal m ode; same as mkill

tracerule on|off turn s rule tracing on or off





mcontrol examples

mcontrol can be used as shown in the follow ing examp les.

Retrying pending propagations

To retry pend ing prop agations for a cell nam ed grace, type the comm and sh own in

Figure 125.

Figure 126 shows an examp le of the outpu t.

Terminating a cell

To terminate a cell nam ed grace, type the comm and shown in Figure 127.

tracerule phases Phases mod ifies the configuration of wh ich ru le phases are enabled for

tracing. The Phases value has the same format as the

TraceRulePhases par ameter. For example,

mcontrol -n CellName tracerule phases -new,-abstract

This comm and disables tracing of all new and abstract rules.

tracerule names Names mod ifies the configuration of which rules are enabled for

tracing. The Names value has the same format as the

TraceRuleNames param eter. For examp le,

mcontrol -n CellName tracerule namesproblem_rule

This comm and enables tracing of the ru le namedproblem_rule (assum ing that problem_rule is of a ph asethat h as ru le tracing enabled).

Figure 125 Retrying Pending propagations with mcontrol command

mcontrol -n grace -v prop

Figure 126 Example of mcontrol command output for retrying pending propagations

Command on server grace acknowledged

Figure 127 Terminating a cell using the mcontrol command

mcontrol -n grace -v stop

Table 102 mcontrol controls (part 2 of 2)

Control Description



mcrtcell—Creating a new cell



Reconfiguring a cell

To reconfigure cell grace after mcell.dir has been modified, type the comm and shown

in Figure 129.


The cell grace reconfigures without stopping and restarting.

mcontrol return codes

There are no comma nd -specific retu rn codes for mcontrol. For a list of common



Use the mcrtcell comm and to create a new cell. You can only run the mcrtcell comm and on the local comp uter w here you are creating the new cell.

Cell names

Cell names mu st be unique through out the enterprise.

Figure 128 Example of mcontrol command output for terminating a cell


Figure 129 Reconfiguring a cell

mcontrol -n grace reload dir

Figure 130 Example of mcontrol command output for reconfiguring a cell


WARNING

Cells with id entical cell names on different comp uters w ithin you r enterp rise will cause

un expected results.





The cell nam e cannot contain sp aces or special characters. You can use any

alphanu meric string a nd un derscores (_) in a cell name, such as th e following:

s my_cell

s spike12

s oracle

Do not give a cell the sam e nam e as any item in the MCELL_HOME \ e tc directory, such

as the kb directory or the mcell.conf , mcell.dir, or mcell.trace files.

Using th e mcrtcell comm and to add cells ensures that the cell names are un ique.

mcrtcell actions

The mcrtcell command performs the following actions:

s determines if an entry exists in the mcell.dir file that m atches the cell being created

If a matching entry exists, the creation fails. You can u se the -f option to force the

creation of the cell.

s creates the etc\ cellName d irectory, wh ich contains a Know ledge Base copied fromth e etc\ default\ Em\ kb directory

s creates a services entry on Microsoft Wind ow s NT, unless you specify the -m

option

s add s an entry to the local mcell.dir file

s

creates an entry in the startu p scripts on UN IX platform s, unless you specify the -m option

UNIX files

When you install the cell or ru n mcrtcell -p PortNumber cellName on a UN IX

system, you create the files listed in Table 103 that enable the cell to start on reboot

and to stop on shut d own. If you ru n mdelcell cellName, these files areautom atically r emoved .

TIP When n aming cells, adopt a n aming convention for test and pro du ction cells that clearly

identifies its purp ose. For examp le, you could assign test cells nam es that u se test as a p refix

or su ffix. A clear n aming convention is imp ortant because in BMC Imp act Explorer viewsthere is no way to d istingu ish test and p rodu ction cells other than by the cell name.





After you configure the cell, you m ust stop and restart it for the changes to take effect.For instru ctions, see “ Stopp ing or starting a cell on UN IX comp uters” on page 40.

mcrtcell syntax

Figure 131 shows th e syntax for mcrtcell.

If you do n ot specify the -ie or -is opt ion, you create a cell with an em pty

Knowledge Base, and the cell does not r espond to requests.

Table 104 lists the comm and -specific options for mcrtcell. For a list of common



Table 103 Files for UNIX

Platform File

AIX platforms etc/ cellName.d

HP-UX platforms sbin/ init.d / m c_cellName

Solaris platforms etc/ init.d / cellName

etc/ rc2.d/ K99cellName

etc/ rc2.d/ S99cellName

Linux platforms etc/ rc.d / init.d / m c_cellName

etc/ rc.d/ rc3.d/ K99mc_cellName

etc/ rc.d/ rc3.d/ S99mc_cellName

Figure 131 mcrtcell syntax

mcrtcell -p PortNumber [-s SourceCell]

[-l HomeLocation] [-f] [-m] [-z] [-h|-?] [-ie|-is] NewcellName

Table 104 mcrtcell options (part 1 of 2)

Option Description

-f forces the creation o f a cell when the mcell.dir file contains an entry of the sam e nam e;

reinstalls the Knowledge Base

If you d o not u se this option, mcrtcell exits withou t creating a new cell when it find s a

du plicate entry in the mcell.dir file.

-ie installs the default BMC Event Manager Knowledge Base

-is installs the default BMC Service Impact Manager Knowledge Base





mcrtcell example

Figure 132 shows an examp le of how to create a service using mcrtcell.

Figure 133 shows the outpu t produ ced.

Figure 134 shows an examp le of how to create another service using mcrtcell.

Figure 135 shows the outpu t produ ced.

mcrtcell return codes

-m preven ts autom atic restart on reboot

-p PortNumber specifies the cell port nu mber (PortNumber )

Note: The -p option for mcrtcell overrides the common CLI-p option listed in “Table 85

Common options for CLI comm ands” on p age 383.

-s SourceCell specifies the cell (SourceCell) from w hich to copy a Knowledg e Base

NewcellName specifies the n ame for the cell being created . For information on cell nam ing conventions,

see “ Cell names” on page 401.

Figure 132 Example of mcrtcell command

mcrtcell -p 2591 -is was05dal

Figure 133 Example of output of mcrtcell

Service successfully created

Figure 134 Example of mcrtcell command

mcrtcell -s was05dal -p 2592 was04fra

Figure 135 Example output of mcrtcell

Service successfully created

NOTE

This command does not use the -ie or -is option. It makes a copy of the KB from the

previous cell.

Table 104 mcrtcell options (part 2 of 2)

Option Description



mcstat—Returning cell status


Table 105 lists the comm and -specific return codes for mcrtcell. For a list of common

return codes that app ly to all CLI comm and s, see “ BMC Imp act Manager CLI


mcstat—Returning cell status

The mcstat comm and obtains the status of a cell. This comman d shows wh ether a cell

is ru nning or stopp ed.

mcstat Syntax

Figure 136 shows th e syntax for mcstat.

Table 106 lists the comm and -specific option for mcstat. For a list of commoncomm and options that ap ply to all CLI comm and s, see “ BMC Imp act Manager CLI


Table 105 mcrtcell return codes

Code Description

-1 uname comman d failed

3 MCELL_HOME environm ent variable not set or d up licate cell nam e or p ort d efinition

in mcell.dir

31 no MCELL_HOME environm ent variable is defined

32 dup licate cell definition in mcell.dir

33 existing cell with sam e nam e on a different host

34 existing cell with sam e nam e on a different p ort

35 existing cell with sam e name on a d ifferent host/ port

36 failed to create new directory

37 cannot get OS

38 failed to r emov e a cell

Figure 136 mcstat syntax

mcstat [-h|?] [-z] [-q] [-c ConfigFile]

{-p "Var =Value"} [-n cellName | -n @Host[/Port[#Key]]] [-v] [-t TimeOut ]

Table 106 mcstat option

Option Description

-t TimeOut specifies the length of time, in millisecond s, for th e comm and to w ait for

answ er before terminating; default is 60000, or 1 minu te



mdelcell—Deleting a cell


mcstat example

To obtain the status for a cell nam ed examplecell, type the comm and shown in

Figure 137.

If the cell is not ru nn ing, a message similar to the examp le in Figure 138 appears.

If the cell is runn ing, the message show n in Figure 139 appears.

mcstat return codes

There are no command -specific retu rn codes for mcstat. For a list of comm on retu rncodes that ap ply to all CLI command s, see “ BMC Impact Manager CLI comm on

return codes” on page 384.


Use mdelcell to d elete a specified cell on the local comp uter . Deleting a cell by using

th e mdelcell comm and removes the cell and its entry in the mcell.dir file. You can u se

this comm and only locally on the comp uter w here the cell resides. Execu ting this

command resu lts in the following actions:

s removes the entry in the mcell.dir files deletes the etc\ cellName

s removes the entry from the services on Microsoft Wind ows or the startup scripts

on UNIX

Figure 137 mcstat example

mcstat -n examplecell

Figure 138 Message for cell not running

Could not connect to Cell examplecell.

Figure 139 Message for cell running

Running





mdelcell syntax

Figure 140 shows th e syntax for mdelcell .

Table 107 lists the comm and -specific options for mdelcell . For a list of common


mdelcell example

To delete a cell nam ed grace, type the comm and shown in Figure 141.

If grace is not currently runn ing, this comm and prod uces output similar to the

example shown in Figure 142 on M icrosoft Wind ows platforms:

On UN IX platforms, the comm and does not prod uce outpu t when it run s

successfully.

If grace is curr ently runn ing, this comm and prod uces outpu t similar to the examp le


Figure 140 mdelcell syntaxmdelcell cellName [-z] [-h|?] [-k] [-w TimeOut]

Table 107 mdelcell options

Option Description

-k keeps tmp an d log directories of the cell

-w TimeOut specifies the length of time, in second s, for the comm and to wait wh en

terminating the cell.

Figure 141 Deleting a cell using mdelcell

mdelcell grace

Figure 142 Output for mdelcell if cell is not running

Service successfully removed

Figure 143 Output for mdelcell if cell is running

Warning! Cell grace was running and mdelcell tries to terminate it.

Service successfully removed.



mgetinfo—Retrieving information about a cell


mdelcell return codes

Table 108 lists the comm and -specific return codes for mdelcell . For a list of common




The mgetinfo comm and retrieves information abou t a cell.

mgetinfo syntax

Figure 144 shows the syntax for mgetinfo .

The -n opt ion is requ ired if the cell is remote and d efined in the mcell.dir file, or if the

cell is local and nam ed something other than HostName.

Table 109 lists the comm and -specific option for mgetinfo . For a list of common



Table 108 mdelcell return codes

Code Description

-1 unam e command failed

31 no MCELL_HOME environm ent variable is defined

Figure 144 mgetinfo syntax

mgetinfo [-h|?] [-z] [-q] [-c ConfigFile] {-p "Var =Value"}

[-n cellName | -n @Host[/Port[#Key]]][-1 HomeLocation] [-v] Information

Table 109 mgetinfo optionOption Description

Information specifies the Information option to use. See Table 110 for the available

Informa tion options.





Table 110 describes the mgetinfo information options.

A connect request d isplays the information show n in Table 111.

Table 110 mgetinfo information options

Information Description

activity retrieves the activity statu s of the cell0 = stand by

1 = limited

2 = full activity.

config retrieves configuration of a cell, including the cell name, home directory, Knowledge Base

d irectory, and th e full paths of all configura tion files the cell uses

connect retrieves information abou t the curren t connections th at are op en from and to the cell; see

Table 111 for description of that information

kbmodules lists KB modu les with version in formation from th e cell’s loaded KB; inform ation is disp layed

in raw format. When combined with the -v switch, it is retur ned in a m ore verbose and

readable format.

kbsources lists KB source files with version inform ation from the cell’s loaded KB; information isdisplayed in raw format. When combined w ith the -v switch, it is return ed in a m ore verbose

and readable format.

metrics rep orts th e met rics, collected by the cell, tha t are stor ed in MC_CELL_METRIC da ta objects

param retrieves the options found in the mcell.conf file

This informa tion d oes not necessarily represent the effective values of th ese options. If the

value is set to an ou t-of-range value, that value is returned , but the effective value u sed

internally will be the range boun dary .

NOTE: All parameter settings are return ed in ord er of definition. There can be mu ltiple

settings for th e same param eter. Only the last setting rep orted is effective.services reports service metrics coun ting the compon ents and relationships

version displays the v ersion num ber of the cell

Table 111 Information from connect request (part 1 of 2)

Connect information Description

All Connections

direction IN for incoming and OUT for outgoing

This information refers to the initiator of the connection. An incoming connection

means a client contacted the cell, while an outg oing connection m eans the cell itself

contacted an other cell. In both cases, data can flow in both d irections.

type o f clien t the clien t type, such as unknown, cell, b rowser , adap ter , CLI, and EIF, which are

reported as literal values

nam e of connected

program

the nam e of the connected p rogram (for example: Imp act Explorer, mp oster,

cellName)





mgetinfo examples

This section contains exam ples of mgetinfo .

mgetinfo config example

Figure 145 shows an examp le of mgetinfo config.

On UN IX, this comm and prod uces outpu t similar to the examp le show n in

Figure 146.

sou rce ad dress IP ad dress/ p ort of sou rce sid e of the con nection

for inboun d connections, this is the client; for ou tboun d, it is the cell

dest ination address IP address/ port of dest ination side of the connect ionfor inboun d connections, this is the cell; for outbou nd , it is the d estination

Incoming Connections

name of user the name of the user; example: Admin

tim e d elta betw een both sen der an d receiver in secon ds, to be ad ded to tim e stam ps com in g

in to convert to th e cell time

sequence sequence number of last incoming message

sequence sequence number of last answer

Outgoing Connections

time stamp timestamp of last connection setup or trial

sequence sequence number of last outgoing message

message number of messages waiting for connection opening

message number of messages waiting for answer

Figure 145 Example of mgetinfo config

mgetinfo -n aspen config

Figure 146 mgetinfo config command output on UNIXcellName=aspen

HomeDir=/opt/mcell

KBDir=/opt/mcell/etc/aspen/kb/

ConfigFile=/opt/mcell/etc/mcell.conf

TraceConfigFile=/opt/mcell/etc/mcell.trace

TraceDefaultFile=/opt/mcell/tmp/aspen/trace

ServerDirectoryFile=/opt/mcell/etc/mcell.dir

PropagateConfigFile=/opt/mcell/etc/mcell.propagate

ModifyConfigFile=/opt/mcell/etc/mcell.modify

Table 111 Information from connect request (part 2 of 2)

Connect information Description





On Microsoft Window s, this comm and prod uces outpu t similar to the examp le


mgetinfo param example

Figure 148 shows an examp le of mgetinfo param.

This comm and prod uces outp ut similar to the examp le show n in Figure 149.

mgetinfo services example

Figure 150 shows an examp le of mgetinfo services.

Figure 147 mgetinfo config command output on Microsoft Windows

cellName=aspen

HomeDir=C:/mcell/server

KBDir=C:/mcell/server/etc/aspen/kb/

ConfigFile=C:/mcell/server/etc/mcell.conf

TraceConfigFile=C:/mcell/server/etc/mcell.trace

TraceDefaultFile=C:/mcell/server/tmp/aspen/trace

ServerDirectoryFile=C:/mcell/server/etc/mcell.dir

PropagateConfigFile=C:/mcell/server/etc/mcell.propagate

ModifyConfigFile=C:/mcell/server/etc/mcell.modify

Figure 148 Example of mgetinfo param

mgetinfo -n aspen param

Figure 149 mgetinfo param command output

Trace=Yes

TraceSrc=No

TraceRuleLevel=1

TraceConfigFileName=mcell.trace

TraceDefaultFileName=%T/trace

LicenseServer=

CellOperationLevel=Consolidation

CellOperationRelax=No

.

.

.

Figure 150 Example of mgetinfo services

mgetinfo services



mgetrec—Obtaining a global record value



mgetinfo connect example

Figure 152 shows an examp le of mgetinfo connect.


mgetinfo return codes

Table 112 lists the comm and -specific return codes for mgetinfo. For a list of comm on




Use the mgetrec comm and to obtain the value of a global record.

Figure 151 mgetinfo param command output

MC_SM_COMPONENT Number of MC SM Component 87

CONNECTIVITY Number of Connectivity 11

IT_COMPONENT Number of IT Component 22

LOGICAL_COMPONENT Number of Logical Component 47

SERVICE_LEVEL_AGREEMENT Number of Service Level Agreement 7

MC_SM_RELATIONSHIP Number of MC SM Relationship 126

IMPACT_RELATIONSHIP Number of Impact Relationship 126

NULL_RELATIONSHIP Number of Null Relationship 0”

Figure 152 Example of mgetinfo services

mgetinfo connect

Figure 153 Output of mgetinfo connect

IN browser ImpactExplorer 10.0.10.17:1545 10.0.10.28:1828 Admin 0 2028 2071

Table 112 mgetinfo return codes

Code Description

31 not a SIM cell





mgetrec syntax

Figure 154 shows th e syntax for mgetrec.

The -n option is required if the cell is remote and defined in the mcell.dir file, or if th e

cell is local and nam ed something other than HostName.

Table 113 lists the comm and -specific option for mgetrec. For a list of common



mgetrec example

Figure 155 shows an examp le of mgetrec.

The preceding comman d p rod uces outp ut similar to the examp le show n in

Figure 156.

Figure 154 mgetrec syntaxmgetrec [-h|?] [-z] [-q] [-c ConfigFile]

{-p "Var =Value"} [-n cellName | -n @Host[/Port[#Key]]]

-r Record [.Slot]

Table 113 mgetrec option

Option Description

-r Record [.Slot] specifies the global record to be obtained, op tionally limited to one

of its slots

Figure 155 Example of mgetrec

mgetrec -r EM_KB_OPTIONS

Figure 156 Output of mgetrec (part 1 of 2)

startup_script_enabled

-----

NO

-----

dfilter_enabled

-----

NO

-----

dnotification_enabled

-----

NO

-----



mkb—Updating the Knowledge Base


mgetrec return codes

There are no command -specific return cod es for mgetrec. For a list of comm on retu rn

codes that ap ply to all CLI command s, see “ BMC Impact Manager CLI comm on



Use the mkb command to create, view, or up date the Know ledge Base. When you useth e mkb comm and to create a new Knowledge Base, a manifest.kb file is also created .

Use the mkb comm and primarily to check or m odify a Knowledge Base with scripts,

such as wh en you n eed to up grade the Know ledge Base automatically for a num berof cells installed across you r n etwork. After installing the files, comp ile using the

mccomp command.

mkb syntax

Figure 157 shows the syntax for mkb.

Table 114 lists the command -specific options for mkb . For a list of common comm and



dpropagation_enabled

-----

NO

-----

default_location-----

Figure 157 mkb syntax

mkb [-h|-?] [-z] [-q] [-v] [-n CellName | -n @Host[/Port[#Key]] ] [-fManifestFile] [-b BinFile] [-c ClassFile] [-d DataFile] [-i Interp][-j RecordFile] [-l LibFile] [-m Directory] [-o CollectorFile] [-p][-r RuleFile]

Table 114 mkb options (part 1 of 2)

Option Description

-b BinFile binary file nam e

-c ClassFile imp orts th e sp ecified ClassFile .baroc that defines the class d efinitions

Figure 156 Output of mgetrec (part 2 of 2)





Use the options d escribed in Table 115 to ad d new files to the Know ledge Base that

you specified with th e -f opt ion. The n ew files are also described in Table 115.

-d DataFile imp orts the specified DataFile.baroc that d efines data instances

-f manifest specifies the path to the manifest.kb file

-i Interp specifies interpreter typ e either: [a|l2|p4|s5|w4]

-j RecordFile imports RecordRile.baroc that d efines the record d efinitions

-l LibFile imports the specified library file ( filename.wic).

Note: The -l option for the mkb comm and overrides the -l option in

“Table 85 Common options f or CLI commands” on page 383.

-m Directory creates a new Knowled ge Base directory hierarchy based on th e

contents of the designated manifest.kb file

-o CollectorFile imp orts the specified CollectorFile .mrl that defines that collector

definitions

-p pr ints the contents of the d esignated manifest.kb file, alongw ith the names of the .load files in th e various d irectoriescomprising th e Knowledg e Base

Note: The -p option for mkb overrides the comm on CLI -p option

listed in “Table 85 Comm on options for CLI comman ds” on

page 383.

-r RuleFile imp orts the specified RuleFile mrl that d efines the r ule d efinitions

Table 115 mkb new file options

mkb Option Description

-b BinFile add s the binary file (BinFile ) for the architecture

-i Interp specifies the ap prop riate interpreter to u se for the architecture; the

KB is copied as designated by the Interp value to the approp riate

directory for that architectur e:

s l2 - Linux 5.2 and 6.0

s p4 - AIX 4.0 (Pow er PC)

s s5 - Solaris 2.5 (Sparc)

s w4 - Microsoft Wind ows/ NT 4.0 (Intel)

-c ClassFile ad ds the class file (ClassFile) to the designated Know ledge Base

-o CollectorFile ad ds the collector file (CollectorFile) to the d esignated

Knowledge Base

-d DataFile add s the data file (DataFile) to the designated Know ledge Base

-l LibFile add s the library file (LibFile) to the designated Knowledg e Base

Note: The -l option for the mkb comm and overrides the -l option in

“Table 85 Common options for CLI commands” on page 383.

-r RuleFile add s the ru le file (RuleFile) to the designated Know ledge Base

Table 114 mkb options (part 2 of 2)

Option Description





Each of the above op tions causes mkb to copy the d esignated files into the p roper

Knowledge Base directory and add s information to the .load file of that d irectory.

mkb examples

This section contains UN IX and Microsoft Window s examples.

UNIX example

Figure 158 shows an examp le of mkb on UNIX.

This comm and prod uces outp ut similar to the examp le shown in Figure 159 on a

UNIX comp uter n amed spud .

Figure 158 mkb command on UNIX

mkb -f ./manifest.kb -p

Figure 159 mkb output on UNIX

classes = \mcell\server\etc\spud\kb\.\classes

load file: .load

root.baroc

intevt.baroc

.

.

.patrol.baroc

collectors = \mcell\server\etc\spud\kb\.\collectors

load file: .load

collectors.mrl

internal.mrl

Adapters.mrl

catchall.mrl

data = \mcell\server\etc\spud\kb\.\data

load file: .load

lib = \mcell\server\etc\spud\kb\.\lib

load file: .load

can not open file: \mcell\server\etc\spud\kb\.\lib\.load

rules = \mcell\server\etc\spud\kb\.\rules

load file: .load

new.mrl

records = \mcell\server\etc\spud\kb\.\records

load file: .load

intrec.wic



mkill—Stopping a cell


Microsoft Windows example

Figure 160 shows an examp le of mkb on Microsoft Wind ows.

This comm and prod uces outp ut similar to the examp le show n in Figure 161 on

Microsoft Windows.

mkb return codesThere are no comma nd -specific retu rn codes for mkb . For a list of common retu rn

codes that ap ply to all CLI command s, see “ BMC Imp act Manager CLI comm on


mkill—Stopping a cell

Use the mkill command to stop a ru nning cell or gateway.

mkill syntax

Figure 162 shows th e syntax for mkill.

If you do n ot specify a cell to stop, this comm and stops th e defau lt cell, HostN ame.

You m ust u se the -n cellName option on mu ltiple cell hosts.

Figure 160 mkb command on Microsoft Windows

mkb -f kb\manifest.kb -m new_kb

Figure 161 mkb command output on Microsoft Windows

manifest directory tree created successfully

Figure 162 mkill syntax

mkill [-h|?] [-z] [-q] [-c ConfigFile] {-p "Var =Value"}

[-n cellName | -n @Host[/Port[#Key]]]

[-l HomeLocation][-v] [-s]



mlogchk—Performing consistency checks


Table 116 lists the comm and -specific option for mkill. For a list of comm on comm and



mkill example

Figure 163 shows an examp le of mkill.

The preceding command produ ces outpu t similar to the example shown in

Figure 164.

mkill return codes

There are no command -specific retu rn codes for mkill. For a list of common retu rncodes that ap ply to all CLI command s, see “ BMC Impact Manager CLI comm on



The mlogchk command performs consistency checks on the persistency directory

MCELL_HO ME \ log\ cellName. This directory could be in an inconsistent state after

abnormal cell or StateBuilder term ination. It is an interactive tool that tells the

operator wh at is wrong an d w hat should be corrected.

You mu st shut dow n th e cell before runn ing the checks because a run ning cell might

mod ify the log d irectory d uring a check.

Table 116 mkill option

Option Description-s performs rap id shu tdow n termination; byp asses StateBuilder

Figure 163 Example of mkill

mkill -n examplecell

Figure 164 Output of mkill

server examplecell terminated

NOTE

The mkill -s comman d terminates a cell and bypa sses the StateBuilder. If a user has cells set

to ru n the StateBuilder b efore terminating, then mkill -s -n cellName overrides theStateBuilder option.





The mlogchk comm and does the following:

s determines whether an mcdb.lock file exists and , if so

— checks for a run ning statbld and waits for termination

— reports trailing lock file and rem oves it (after confirm ation)

s determines whether an xact.1 file exists and , if so, reports and instru cts the user to

run statbld

s determines whether an mcdb.0 file exists and , if so, reports and proposes to renam e

or remove it

mlogchk syntax

Figure 165 shows th e syntax for mlogchk.

There are no comm and -specific options for mlogchk.

mlogchk exampleFigure 166 shows an examp le of mlogchk .

For a cell nam ed spud , the preceding comm and prod uces outpu t similar to the

example shown in Figure 167.

The outpu t continues w ith the m essage shown in Figure 168 on page 420 if you

respond w ith y.

Figure 165 mlogchk syntax

mlogchk [-h|?] [-z] [-q] [-c ConfigFile] {-p "Var =Value"}


[-l HomeLocation] [-v]

Figure 166 Example of mlogchk

mlogchk -n spud -v

Figure 167 Output of mlogchk

Warning: Cell spud is running - this may influence the consistency check.

To ensure correct results, you should shutdown the Cell now.

Do you want to continue (y/n) ?



mpkill—Stopping mposter and msend server processes


mlogchk return codes

Table 117 lists the comm and -specific return codes for mlogchk. For a list of common



Use the mpkill comm and to stop a runn ing mposter or msend process.

When an msend or mposter comm and is started in persistent bu ffering mod e (for

examp le, using the -j option ), a second msend or mposter process is started in

backgroun d—this is the msend or m poster server process. When the server is already

runn ing and an msend or mposter comm and starts using the same bu ffer directory as

the existing server, an ad ditional server is not started; msend or mposter (client) just

connects to the server.

mpkill syntax

Figure 169 shows the syntax for mpkill.

Figure 168 mlogchk message

No inconsistency found.

Table 117 mlogchk return codes

Code Description

21 cannot access cell log d irectory

NOTE

This msend or mposter server process, which is hidd en to th e user, autom atically stops itself

wh en it is idle for 10 minutes. “Idle” means th at there is no msend or mposter client

connected to it and every event in the buffer has been sent and acknow ledged by the

destination cell. A new server w ill be started by th e client as soon as a msend or mposter

client requires it. This feature considerably limits the need to u se mpkill.

Figure 169 mpkill syntax

mpkill [-h|?] [-z] [-q] [-c ConfigFile] {-p "Var =Value"}

[-n cellName | -n @Host[/Port[#Key]]] (-a | -j Bufdir )





Table 118 lists the comm and -specific option for mpkill. For a list of comm on



mpkill example

Figure 170 shows an examp le of mpkill. If msend has been started as

msend -n cell1 -j "C:\bufdir\cell1"

to stop the run ning msend server process, you w ould enter the mpkill command asshown in Figure 170.

The preceding comman d p rod uces outp ut similar to the examp le show n in

Figure 171.

Table 118 mpkill option

Option Description-a kills all msend or mp oster server processes

-j Bufdir kills msen d or m poster server p rocesses on a sp ecified p ersistent bu ffer

Figure 170 Example of mpkill

mpkill -j "C:\bufdir\cell1

Figure 171 Output of mpkillBMC Impact MposterKiller 7.0.00 (Build 10891339 - 30-Mar-2006)

Copyright 1998-2006 BMC Software, Inc. as an unpublished work. Allrights reserved.



mposter and msend—Managing data, global records, and events


mpkill return codes

There are no command -specific retu rn codes for mpkill. For a list of common retu rn

codes that ap ply to all CLI command s, see “ BMC Impact Manager CLI comm on


mposter and msend—Managing data, global records, andevents

Use the msend comm and to man age events in a cell.

Use the mposter command to manage d ata, global records, and events in a cell. You

can m odify global records and create, modify, and delete data instances and events

using the mposter command.

You can u se the mposter comm and to mod ify dyn amic data objects in the cell evenwh en the cell is pau sed.

mposter and msend syntax

Figure 172 shows the syntax for mposter.

NOTE

The mposter an d msend comm ands can both be u sed to send or mod ify events, but mposter

also can be used to send or m odify data.

NOTE

BMC Software recomm end s that you u se the msend comm and instead of the mposter

comman d w hen you d o not need to access or modify dynam ic data or global records. The

msend comman d is a more secure comman d because it is more restrictive than mposter.

BMC Impact Solutions does not su pp ort using the mposter comman d to create or to edit

service mod el comp onent instan ces.Althou gh it is possible to use the mposter command to

create and to edit the service mod el class instances on a cell, these chan ges are m ade to onlythe BAROC service mod el run ning on the cell, not to the cell’s stand ard (reference) pu blished

service mod el in the CMDB. This causes a loss of service model integrity and subsequ ent

service model publishings will fail.

Figure 172 mposter syntax (part 1 of 2)

mposter [-h|?] [-z] [-q] [-c ConfigFile]


[-y] [-f DirFile] [-v]





Figure 172 shows th e syntax for msend , wh ich is iden tical to the syn tax for mposter.

Table 119 lists the comm and -specific options for mposter an d msend. For a list of

comm on comman d op tions that ap ply to all CLI comm and s, see “ BMC Imp act

Manager CLI comm on comm and op tions” on page 383.

[-i] [-I] [-x] [-u] [-w MSecAnswerWait] [-t MSecTerminationWait]

[-j BufDir ] [-d] [-e] [ - | {SourceFile} | -a Class

[-o Source] [-m Message] [-r Severity ] [-b SlotSetValue] |

-l EventID [-b SlotSetValue]]

Figure 173 msend syntax

msend [-h|?] [-z] [-q] [-c ConfigFile]


[-y] [-f DirFile] [-v]

[-i] [-I] [-x] [-u] [-w MSecAnswerWait] [-t MSecTerminationWait]

[-j BufDir ] [-d] [-e] [ - | {SourceFile} | -a Class

[-o Source] [-m Message] [-r Severity ] [-b SlotSetValue] |

-l EventID [-b SlotSetValue]]

Table 119 mposter and msend options (part 1 of 2)

Option Description

- input from standard input stream

-a Class send s an object of class Class

-b SlotSetValue adds SlotSetValue settings (form at: “slot=valu e;...”)

-d send s as data instead of as an event

-e specifies to use EIF instead of MCELL form at

-f DirFile specifies the d irectory file path ; the d efault valu e is

MCELL_HOME \ e tc\ mcel l.dir

-i sets to interactive mod e

-I reinitializes persistent buffers

-j BufDir mak es the buffer d irectory p ersistent

-l EventID mod ify the sp ecified event instead of a new event

Note: The -l option for the mposter comm and overrides the -

l option in “Table 85 Common options for CLI commands”

on page 383.

-m Message sets event message to the specified Message text

-o Source sets event sou rce to the specified Source

-r Severity sets the event severity value to the Severity specified

-t MSecTerminationWait sets the length of time in m illisecond s to w ait for trailing

answ ers before terminating; default is 5000

-u leave messages unanswered

Figure 172 mposter syntax (part 2 of 2)





mposter examples

Figure 174 shows an examp le of mposter.

The inform ation for the event is entered u sing BAROC-style inpu t as shown in

Figure 175.

The outpu t of the mposter session is similar to w hat is show n in Figure 176.

Then, the following wou ld be inpu t, as shown in Figure 177.

-w MSecAnswerWait sets the length of time in m illisecond s to w ait for message

answ er; default is 0

-x examine timings-y immed iately terminate u pon conn ection failure

NOTE

All examp les and inform ation in this section also can app ly to msend.

Figure 174 Example of mposter

mposter -n aspen -v -

Figure 175 mposter BAROC-style input

HOST_DOWN;

origin='HOST_DOWN';

msg='host blue is down';

END

Figure 176 mposter BAROC-style output

Event time stamp : 943392578

Sending eventMessage 1 - #0

Message 1 - #1 - evtid = 0

Figure 177 mposter BAROC-style input

HOST_DOWN;

origin='HOST_DOWN';

msg='host orange is down';

END

Table 119 mposter and msend options (part 2 of 2)

Option Description





And the mposter outp ut w ould be similar to what is shown in Figure 178.

In the examp le show n in Figure 179, mposter add s an instance of the DATA class

AppByHost to the host aspen. The examp le uses dyn amic data technology in thefollowing ways:

s specifying that th e instance to ad d is an instance of AppByHost

s defining the h ost as aspen

s specifying that it defines ap plications as word or excel

You can u se the mposter comm and to change any one of definitions w ithout

changing any of the others.

The preceding command does not prod uce any outpu t.

Enabling persistent buffering

To enable persistent bu ffering, first create a w riteable directory ( BufDir in Figure 180),then u se the syntax shown in Figure 180.

The mposter.lck, mposter.buf , and mposter.pos files are p laced in BufDir after the

mposter (or msend) comm and is executed . Multiple instan ces of mposter (and/ or

msend) can use the same BufDir directory if the destination cells are the sam e.

Figure 178 mposter BAROC-style output

Event time stamp : 943392646

Sending event

Message 2 - #2 - evtid = 0Message 2 - #2

Figure 179 Definition changes using mposter

mposter -n aspen -d -a AppByHost -b "host='aspen';applications=['word','excel']"

NOTE

On Microsoft Wind ows, the mposter an d msend comman ds accept only dou ble qu otes w ith

th e -b option. If you use single quotation mar ks with the -b option on Microsoft Wind ows, the

event is not sent, and no error m essage appears.

On UN IX, with the with the -b option, the comm and accepts both single and d ouble quotation

marks.

Figure 180 Enabling persistent buffering using mposter

mposter [current options] -j BufDir





When p ersistent buffering is enabled, both mposter an d msend can send events to one

of a list of cells. To sup ply a list of cells, use the -n option or the ServerName option

and separate each of the cells in the list with a colon, as show n in Figure 181 onpage 426.

Write access for persistent buffering

To successfully start the mposter or msend CLI command s in a persistent bu ffering

mod e, you m ust ensure that you have w rite access to the bu ffers file. You can locate

the bu ffers file at:

s UNIX— /etc/itm/.reg/Buffers

s Microsoft Windows—HKEY_LOCAL_MACHINE/SOFTWARE/BMC Software/BMC

Impact/mposter/Buffers

The Microsoft Wind ows registry key for the Buffers file is not created by d efault; it iscreated the first time the mposter (or msend) comm and is executed using the -j option

in a p ersistent buffering mod e.

If the Buffers file is not w ritable, you w ill receive the error message sh own in

Figure 182.

Decreasing the buffer size

The persistent d irectory may contain th e following th ree files:

s mposterbuf.buf

s mposterbuf.pos

s mposterbuf.lck

The purp ose of the mposterbuf.lck file is to provide a file-locking m echanism w hen

mu ltiple mposter-like servers are started at the sam e time.

Figure 181 Supplying a list of cells for mposter

mposter -n cell1:cell2:cell3 -j BufDir

Figure 182 Error message if buffers files are not writableLaunching mposter server... OK

Getting Server Port number... OK (33992)

Connecting mposter server... Fatal error! Cannot negotiate connectionwith mposter server. Check if the cell(s) name, location, port andencryption key are the same as those running server (protocol error:4)

Fatal error! Client initialization failed. A current cause of thisproblem is a wrong/unavailable cell destination (hostname, port,encryption key).



mquery—Retrieving objects from a cell


The mpos terbuf.pos file contains a positive integer, betw een 0 and the size, in bytes, of

mposterbuf.buf . This value, pos correspond s a position in mposterbuf.pos; every even t

or da ta contained in the first pos bytes of mposterbuf.buf has been sent to andacknow ledged by a cell. Every event contained betw een pos and the end of file either

has not been sent yet or h as been sent but h as not been acknowledged by the cell yet.

The size of the mpos terbuf.buf file is decreased w hen all the following cond itions are

met:

s The size of mposterbuf.buf is at least 50000 bytes (50 KB).

s The percentage of events sent and acknowledged mu st make u p at least 30% of thetotal file size. For in stan ce, if mposterbuf.buf is 10 MB, at least 3 MB of

acknow ledged events must be in mposterbuf.buf for its size to be decreased. This

means that mposterbuf.pos shou ld contain a nu mber larger than 3,000,000.

mposter and msend return codes

Table 120 lists the retu rn cod es for mposter an d msend. For a list of comm on retu rn

codes that ap ply to all CLI command s, see “ BMC Imp act Manager CLI comm on



The mquery comm and retrieves objects from a cell.

mquery syntaxFigure 183 shows th e syntax for mquery.

Table 120 mposter and msend return codes

Code Description

2 failed to in itialize in Server m od e

3 failed to find a v alid cell

4 failed to close the client conn ection

Figure 183 mquery syntax

mquery [-h|-?] [-z] [-q] [-c ConfigFile] {-p "Var =Value"}

[-n cellName | -n @Host[/Port[#Key]]] [-l HomeLocation] [-v] [-r] [-f Format]( [-d] [-a Class] [-w Where]

[-s SlotList | -x SlotList] [-i Collector ] [-o OrderSlot] |

-Q Query | - | {File} )





Table 121 lists the command -specific options for mquery. For a list of comm on



mquery output

Outpu t of the mquery command is available in raw format for parsing by a program ,

and in printed format for users, with several variations.

Raw output format

The outp ut consists of the nu mber of solutions, terminated with RS (Record

Separ ator, ASCII code 30), and followed by th e solutions. Each solu tion is terminated

with RS. A solution consists of a sequence of slot values, separated by FS (Field

Separa tor, ASCII code 28). There is no FS after th e last slot value (that is followed by

the RS solution term inator). Emp ty slot values, or nonexistent slots, are rep resented

by an em pty value, such as two FS with n othing in between.

Table 121 mquery options

Option Description

- performs queries as read from standard input stream

-a Class select from a sp ecified Class (defau lt is either CORE_EVENT or

CORE_DATA).

-d select data objects instead of event ob jects

-f Format format u sing: quoted , BAROC, CSV, or XML

-i Collector selects only in a collector (op tional + su ffix for closure)

-o OrderSlot sorts on th e specified slot order (OrderSlot).

Set the sort order by ap pend ing a suffix to the OrderSlot value thatyou specify. App end a plu s sign (+) for ascend ing sort or a m inus sign (-)

for a descend ing sort.

-Q Query perform th e specified qu ery

-r sets outpu t to be raw o utp ut. For more information, see “ Raw ou tput

format” on page 397.

-s SlotList selects specific slots from th e comm a-separ ated SlotList; the d efault is

ALL). Use sp ecial value COUNT to retrieve only the nu mber of selected

items. Use special value DELETE to d elete the selected items.

-w Where specifies a where condition on the sp ecified Class

-x SlotList excludes specific slots from the comma-separated SlotList (selecting

ALL)

File performs queries as read from one or m ore specified files





Figure 184 shows a n examp le of a raw outp ut specification.


By defau lt, solutions are p rinted in sequen tial ord er. For every solut ion, the values of

the requ ested slots are p rinted, one p er line. Empty or nonexistent slot values take an

emp ty line. A slot value containing a new line w ill occup y more than one line. It is notpossible to d etect these values in stand ard format.

Verbose mode

In verbose mod e, every solution is p receded by a line of the form as show n in

Figure 185 on page 429.

where

s N is the num ber of the solution (starting from 1)

s M is the total nu mber of solutions.

The last solu tion is follow ed by a line of the form as shown in Figure 186.

Special quoted format

In this variant of the standard format, slot values are qu oted w hen n ecessary.

Special BAROC format

In this variant of the standard format, every solution is represented by a BAROC

instance. This consists of the class name, term inated by a semicolon (;) as show n in

Figure 187.

Figure 184 Example of raw output specification

RawOutput = SolutionCount RS Solution RS ... Solution RS

Solution = SlotValue FS ... SlotValue

Figure 185 Verbose mode options

-----N/M-----

Figure 186 End of form

-----END-----

Figure 187 Special BAROC format

slotname=slotvalue;





Values h ave qu otes when needed . Nonexistent slots are not p rinted. The solution is

terminated with an END on a line.

Special XML format

In this variant of the standard form at, every solution is represented by an XMLinstance. Nonexistent slots are not print ed.

Special CSV format

In the Com ma Separated Value (CSV) variant of the stand ard format, solutions areprinted in mu ltiple colum ns over several rows. In non -verbose mod e, each solution is

printed on one row. Slot values are p laced in columns in th e same ord er as in the

colum n selection. If ALL slots are requested, the ord er is determined by the cell anddep ends on the class definitions.

In verbose m ode, solutions can be on m ultiple row s. For an explicitly specified

selection of colum ns, the first row conta ins those colum n n ames. If you requ est ALL slots, every solution row is preceded by a row containing the slot names. This is

required, as the r eturn ed slots may vary d epend ing on th e class of the object.

Colum ns are separated w ith a comma (,). A value that contains a comm a (,) or a qu ote

("), or a n ew line, is quoted with a qu ote ("). A qu ote (") within su ch a value is

doubled.

Query specificationYou can sp ecify a qu ery either w ith comm and line op tions or w ith th e -Q option

through standard input. Using -Q w ith stand ard inpu t, you m ust specify the query in

MRL syntax. You can u se the options d escribed in Table 122 to specify the query w ith

CLI.

Table 122 mquery query options (part 1 of 2)

Option Description

-d retrieves data instances instead of events

-a Class selects instances of class Class or its subclasses

If omitted, a d efault valu e of CORE_EVENT or CORE_DATA is assumed (depending on

wh ether the -d option is specified)

-w Where imp oses one or more cond itions on the instance slot values

The Where value is a general MRL expression as u sed in a Where clause. Several

subexpr essions can be combined with a comm a (,) or AND. Qu otes may be needed to escape

from sh ell interpretation.





mquery examples

This section contains examples of the mquery command.

Selecting events with a severity level

Use the comm and shown in Figure 188 to select all MC_CELL_CONTROL events with

severity of at least MINOR, and non-closed statu s. This query return s the ind icatedslots and the effective class name.

The comm and show n in Figure 189 selects all events from the ByHost collectors for

hosts host1 an d host2 includ ing all of their su bcollectors, if any. The result isordered on status in ascending ord er beginning w ith OPEN, and for each equal status

value, descending on severity beginning with DOWN.

-s SlotList selects the slots listed in SlotList, a comm a-separated sequ ence of slot names

Special values are

s ALL—gets all slots

s COUNT—gets no slots, only a count of ma tching objects is return ed

s DELETE—all matching ob jects are d eleted, return ing a cou nt of these

The default is ALL.

-x SlotList exclud es the slots listed in SlotList, a comm a-separ ated sequ ence of slot names

All slots are rep orted except for th ese.

-i Collector retrieves only m atching ob ject instances that belon g to one of the collectors specified in

Collector

This is a comm a-separa ted sequence of collector object identifiers (OIDs), names, or both .

Each on e can be su ffixed optionally w ith a + to include its su bcollectors as w ell.

-o OrderSlot sorts the slots mentioned in OrderSlot

This is a comm a-separ ated sequ ence of slot nam es. Each one can be su ffixed o ptionally with

a + to indicate ascend ing ord er or a - to ind icate d escend ing ord er. Withou t su ffix, a + is

assum ed. Ord ering is done first on the first slot, then on the next one, and so on.

Figure 188 Example of mquery—Select events with severity status

mquery -a MC_CELL_CONTROL

-w "severity: >= MINOR AND status: != CLOSED"

-s "mc_ueid,CLASS,severity,msg"

Table 122 mquery query options (part 2 of 2)

Option Description



mrecover—Recovering from a catastrophic data loss


Deleting events using the mquery command

You can u se the value DELETE with the -s option to d elete events, as shown in shownin Figure 190.

This comm and removes the event w ith hand le 123.

mquery return codesTable 123 lists the comm and -specific return codes for mquery. For a list of common




Use the mrecover command to recover the sta te of a cell after a catastrop hic loss of

da ta. Typically, a catastrop hic data loss is caused by a system failure. You u se the

mrecover comm and locally on the compu ter hosting the cell from wh ich the d ata was

lost.

Figure 189 Example of mquery—Select events from collector

mquery -i "'By Host'.host1+,'By Host'.host2+"

-s "mc_ueid,CLASS,severity,hostname,msg"

-o "status,severity-"

NOTE

The curr ent imp lementation of the mquery comman d h as the following limitations:

s The XML format is experimen tal and may change in futu re BMC Imp act Solutions

prod uct releases.

s The list slot valu es in XML are pr inted as strings, not as XML lists.

Figure 190 Deleting events using mquery

mquery -n cellName -s DELETE -w "event_handle: == 123"

Table 123 mquery return codes

Code Description

21 syntax error in inpu t





The process recovers the d ata from oth er cells that received events from the local cell

and that sent events to the local cell. The comm and cannot recover u np ropagated

events sent directly from adap ters.

The mrecover command contacts each of the cells that you list in the TargetCell option and requests that each target cell prod uce an u p-to-date saved state. The

events tha t were prop agated from the local cell are extracted from each target cell and

stored locally. After all of the target cells have been p romp ted an d the p ropagatedevents are retr ieved, they are merged into a new sav ed state for the local cell. Then ,

the saved state is processed by the local cell dur ing a recovery p rocess.

If the local cell is running or contains a n mcdb file, the recovery p rocess aborts. If the

recovery process cannot connect to a target cell, you ar e prom pted to choose to stop

or continu e the recovery process. If you choose to continue, you ar e prom pted to

choose to includ e events collected from th e previous session. After the recovery

process completes, the saved state is used to restart the recovered cell.

mrecover syntax

Figure 191 shows th e syntax for mrecover.

Table 124 lists the comm and -specific option for mrecover. For a list of comm on



NOTE

The mrecover comm and recovers only propagated events.

NOTE

If the d ata loss includes th e BMC Imp act Solutions p rodu ct executables or the Knowledge

Base definition of the cell, you must r einstall the cell software, the Know ledge Base, and a

ded icated recovery Knowledg e Base (if app licable) before u sing th e mrecover command.

Figure 191 mrecover syntax

mrecover [-h|-?] [-z] [-q] [-c ConfigFile] {-p “Var =Value”}


[-1 HomeLocation] {TargetCell} . . .

Table 124 mrecover option

Option Description

TargetCell specifies the name of the cell that prop agated events or to wh ich events

have been propagated



mrextract—Extracting cell state files to create new state files


mrecover example

To fix a broken cell w ith input from cella, cellb, and cellc, type the comman d


mrecover return codes

Table 125 lists the comm and -specific return codes for mrecover. For a list of comm on




Events are extracted from th e remote cell repository for th e local cell being recovered .The mrextract command is one step in the r ecovery pr ocess. For m ore information,

see “ m recover—Recovering from a catastrophic data loss” on p age 432.

The cell mu st be stopped before using th e mrextract command.

Figure 192 Fixing a broken cell using mrecover

mrecover -n broken_cell cella cellb cellc

Table 125 mrecover return codes

Code Description

2 failed to send the comm and that started the StateBuilder on a r emote cell

3 could not obtain informa tion from one or m ore neighbor cells

5 could not launch an external program (mrmerge or mcell)

6 mrmerge exited abnorm ally

7 mcell (in r ecovery m ode) exited abnorm ally

WARNING

This comm and is used by mrecover and shou ld be avoided by end users.





mrextract syntax

Figure 193 shows th e syntax for mrextract.

Table 126 lists the comm and -specific options for mrextract. For a list of comm on



mrextract example

Figure 194 shows an examp le of mrextract.

mrextract return codes

Table 127 lists the comm and -specific return codes for mrextract. For a list of comm on


Figure 193 mrextract syntaxmrextract [-h|-?] [-z] [-q] [-c ConfigFile]

{-p Var =Value} [-n cellName | -n @Host[/Port[#Key]]]

[-1 HomeLocation] [-i InputStateFile] [-o OutputFile]

{TargetCell} . . .

Table 126 mrextract optionsOption Description

-i InputStateFile specifies to u se inpu t from InputStateFile; the default is the

cell’s mcdb

-o OutputFile sends ou tpu t to the specified OutputFile file; the d efault is to

send output to standard ou tput

TargetCell specifies the n ame of th e cell to w hich events h ave been

pr opagated ; separate mu ltiple cell nam es with a space

Figure 194 Example of mrextract

mrextract -n CellTwo -o \tmp\mcdb.CellOne

Table 127 mrextract return codes

Code Description

37 failed to en able tracing

47 cannot access state builder

67 failure load ing kb classes

97 cannot start w hile state builder is active



mrmerge—Merging event objects


mrmerge—Merging event objects

The mrmerge command is one step in the cell recovery process. This comm andmerges events recovered from other cells into a n ew saved sta te for the local cell

being recovered. For more information, see “ mr ecover—Recovering from acatastrophic data loss” on page 432.

mrmerge syntax

Figure 195 shows the syntax for mrmerge.

Table 128 lists the command -specific options for mrmerge. For a list of common


mrmerge example

Figure 196 shows an examp le of mrmerge.

WARNING

This comm and is used by mrecover and shou ld be avoided .

Figure 195 mrmerge syntax

mrmerge [-h|-?] [-z] [-q] [-c ConfigFile] {-p “Var =Value”}

[-n cellName | -n @Host[/Port[#Key]]] [-l HomeLocation]

[-o OutputFile] {InputFile}

Table 128 mrmerge options

Option Description

-o OutputFile specifies the file (OutputFile) to which to send comman d outpu t; the

default outp ut target is terminal; the p ath n am e of the recovery cell’s

database file (mcdb) to be created by this comm and

InputFile specifies the inp ut file for the mrextract command

Figure 196 Example of mrmerge

mrmerge -n Cellone -o $MCELL_HOME \log\Cellone\mcdb\tmp\mcdb.X1 \tmp\mcdb.X2



msetmsg—Modifying an event


mrmerge return codes

Table 129 lists the comm and -specific return codes for mrmerge. For a list of comm on




Use the msetmsg comma nd to mod ify the statu s value of an event in a specified cell.

Use the -s option to m odify the slot value.

msetmsg syntax

Figure 197 shows th e syntax for msetmsg .

Table 130 lists the comm and -specific options for msetmsg. For a list of comm on



Table 129 mrmerge return codes

Code Description

37 failed to en able tracing

47 cannot access StateBuilder

67 failure loading kb classes

97 cannot start while StateBuilder is active

Figure 197 msetmsg syntax

msetmsg [-h|-?] [-z] [-q] [-c ConfigFile]


-i EventId -C -O -B -A -G -S "Slot=Value[{;Slot=Value}]"

Table 130 msetmsg options (part 1 of 2)

Option Description

-i EventId specifies the event han dle of the event to b e

modified

-C sets the status v alue of the specified event to

CLOSED

-O sets the status value of the sp ecified event to OPEN

-A sets the status v alue of the specified event to ACK





msetmsg example

To close an event w hose event ID (event_handle) is 12981, type the comman d


If this comm and is successful, it does not p rodu ce outpu t.

msetmsg return codes

Table 131 lists the comm and -specific return codes for msetmsg . For a list of common



-G sets the status v alue of the specified event to

ASSIGNED

-B sets the status v alue of the specified event toBLACKOUT

-S "Slot=Value[{;Slot=Value}]" specified the slot to be mod ified and the changes

to be mad e to the slot’s value

Figure 198 Using msetmsg to close an event

msetmsg -n cellName -i 12981 -C

Table 131 msetmsg return codes

Code Description

31 no event han dle specified

32 failed to set m essage

Table 130 msetmsg options (part 2 of 2)

Option Description



msetrec—Setting the value of a global record


msetrec—Setting the value of a global record

Use the msetrec command to set the field v alues in a global record . Global records are+defined in the records d irectory o f a Knowledge Base. The cell uses global record s

as global variables in ru les.

msetrec syntax

Figure 199 shows th e syntax for msetrec.

Table 132 lists the comm and -specific options for msetrec. For a list of comm on



msetrec example

Figure 200 shows an examp le of msetrec.

Figure 199 msetrec syntax

msetrec [-h|?] [-z] [-q] [-c ConfigFile]


-r Record -S Slot -V Value

Table 132 msetrec options

Option Description

-b specifies slot value assignment

-r Record specifies the global record containing the Slot to be m odified

-S Slot specifies the Slot to be m od ified

-V Value specifies the Value to set for th e specified Slot

Figure 200 Example of msetrec

msetrec -n <cellName> -r test_rec -S slot_list_int -V ‘[4,5,6]’



BMC Impact Manager CLI configuration


msetrec return codes

Table 133 lists the comm and -specific return codes for msetrec. For a list of comm on




The mclient.conf file contains the d efault client options for configuring CLIs. Most of the cell configu ration op tions also can be specified for CLIs. For a more information ,see “ Cell configuration p arameters” on p age 444.

The configurat ion options u se the following syn tax: option=value, wh ere value

equa ls one of the follow ing:

s Boolean: Yes | On | No | Off

s Number

s String

s Path

Table 134 describes the CLI configu ration param eters.

Table 133 msetrec return codes

Code Description

31 failed to set record slot

Table 134 BMC Impact Manager CLI configuration parameters (part 1 of 3)

Option Description/DefaultDefaultvalue

ServerName specifies the n ame of the cell; an a lternative for the -n

cellName option

HostN ame

ServerLocation the host n ame or IP ad dress of the cell HostN ame

ServerDirectoryName specifies the n am e of the cell directory file mcell.dirServerPort specifies the TCP/ IP port nu mber w here the cell listens

for all in-bound requests from sources, such as th e BMC

Impact Explorer, CLIs, and ad apters

1828

Encryption enables or disables encryption to an d from the cell Yes

EncryptionKey used by encryption process as part of the encoding key no default





ConnectionSetupTimeOut the maximu m time, in second s, that a CLI comman d

attemp ts to establish a connection to a cell

If the conn ection w ith the cell cannot be completely

established within th is timeframe, the comm and aborts.

Note th at if the cell is busy w ith a d atabase cleanup , it

may be imp ossible to connect the CLI with the d efault

values. A database cleanup has a d ur ation limit defined

by the EventDBCleanupDurationLimit option, with a

default valu e of 30 second s. With a default

ConnectionSetupTimeOut of 10 second s, the connection

cannot be established within th e first 20 second s of a

cleanup.

10 (seconds)

ConnectionPortRange specifies the ran ge of ports to u se for outgoing

connections

It is the p ort u sed on the client side. This is useful only to

pass the event thro ugh firewalls with high restrictions.

Most firewall configu rations ignore sou rce port

information but requ ire destination port information.

How ever, firewall configuration u sually can restrict the

source ports as w ell.

The syntax is PortRange = PortSequence {,

PortSequence} PortSequence = Port [- Port]

Warning: On Windows p latforms, when using

ConnectionPortRange for a CLI runn ing on the same

ma chine as the cell, it is possible that th e CLI w ill not be

able to connect. This can occur when th e CLI needs m ore

than one attemp t to connect (for instance, because the

cell was too busy d uring the first attemp t). Subsequent

connection attemp ts w ill fail du e to limitations of the OS.

empty

ConnectionPortReuse indicates whether or n ot the por ts specified in

ConnectionPortRange should be reused as mu ch as

possible

By default the cell tries to reuse por ts from th e specified

range, in the given ord er. When

ConnectionPortReuse=No , for every new connection

within th e same session, the next free port from the

specified ran ge is used. Only w hen it reaches the end of

the range w ill it restart at the beginning of the ran ge.

Yes





Configuring tracing for BMC Impact Manager CLI commands


Configuring tracing for BMC Impact Manager CLI commands

You configure CLI comm and tracing in the MCELL_HO ME \ etc\ mcl ient.trace file. The

mclient.trace file uses the same p arameters as the mcell.trace configuration file. Fordetails on the cell tracing configuration, see “ Configuring cell tracing” on p age 73.

BMC Impact Manager CLI trace configuration

Tracing of CLIs is configured in the MCELL_HOME \ e tc\ mcli ent.trace file.

To send tracing outp ut to a text file, add the line of code show n in Figure 201 to the

mclient.trace file.

This line prod uces tracing to the MCELL_HOME \ tmp\ mclient\ out.txt file.

MessageBufferSize the nu mber of messages, or events, retained in th e buffer

wh en the cell is unable to send, or wh en waiting for an

answ er; a message that is not sent because thedestination is dow n, for example, or a message that w as

sent but n ot yet answered , remains in the bu ffer

2000

MessageBufferCleanupPercentage 10

MessageBufferReconnectInterval the time interval, in second s, in w hich the cell attempts

reconnection to a destination if the original connection

failed

600

MessageBufferKeepWait The amou nt of time, in second s, that messages are

retained in the bu ffer un til they can be sent.

Once the sp ecified time elapses, the retained m essages

are removed from th e buffer.

3600

MessageBufferKeepSent the time, in seconds, to keep sent m essages buffered

wh ile waiting for an answ er

300

MessageBufferResendCount the num ber of times to resend unansw ered messages 1

Figure 201 command to send tracing output to text file

ALL ALL out.txt






A p p e n d i x CCmcell.conf file parameters

This app endix discusses all of the p arameters in the mcell.conf file and contains the

following topics:

Action result event p aram eter s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444

Cell configura tion param eter s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444

Cell failover con figuration param eter s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446Client communication parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447

Encryp tion param eters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449Event rep ository cleanu p parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450

Hear tbea t p aram eter s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452

Interna l cell mon itor param eter s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455KB param eters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455


Reporting client connection param eters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459Service m od el param eter s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460

StateBuild er p aram eter s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460

Trace param eter s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461



Action result event parameters


Action result event parameters

Cell configuration parameters

Table 135 Action result event parameters

Parameter Description Type Default valueActionResultInlineLimit the size limit, in bytes, for an action resu lt to be

includ ed directly in th e action r esult event slots

This applies to both the ou tpu t stream (slot

"outp ut_val") and the error stream (slot

"error_val"). If the respective resu lt is larger

than the ind icated size, it is stored in a file.

Instead of placing the valu e directly in the *_val

slot, the reference to the file is placed in the

corresponding *_ref slot.

number 4096 (4 KB)

ActionResultKeepPeriod the p eriod, in second s, that an action result is

kep t on beh alf of a (Brow ser) client

The client shou ld retrieve the result w ithin that

period . After the period h as expired, the result

is drop ped . This is ind epend ent of the action

result event. A generated action resu lt event is

not influenced by th is param eter. It exists as

long as other events.

number 120 (2 minutes)

Table 136 Cell configuration parameters

Parameter Description Type Default value

CellDescription used as the initial value of the cell_description

slot of the internal MC_CELL_INFO record

string BMC Impact

Manager

CellOperationLevel indicates the level on w hich the cell mu st operate

The operation level determines from wh ich clients the

cell accepts connections and events. The default value

can accept connections from any comp uter.

strin g Con solid ation

CellOperationRelax indicates wh ether the operation level shou ld be

lower ed in case there is no license available for the

desired level, as set by CellOperationLevel

Typically, more license token s are available for lower

operation levels.

Boolean N o



Cell configuration parameters


ConnectionPortRangea specifies the ran ge of ports to u se for outgoing

connections

For forward p ropag ation, this port is used on th eclient side (or on th e prop agatin g cell side). This is

useful to pass the event throu gh firewalls with h igh

restrictions. Most firewall configurations ignore

source port information but require destination port

information. How ever, firewall configuration u sually

can restrict the sou rce ports as w ell.

string empty

ConnectionPortReusea indicates whether or n ot the po rts specified in

ConnectionPortRange should be reused as mu ch

as possible

By d efault, the cell or comm and line interface (CLI)tries to reuse ports from the sp ecified rang e, in th e

given order. When ConnectionPortReuse=No, for

every new connection w ithin the same session, the

next free port from th e specified ran ge is used. On ly

wh en it reaches the end of the range will it restart at

the beginning of the range.

Boolean Yes

ProcessingLimit

Percentage

specifies limitation of event processing speed

At 100% the cell accepts even ts as fast as it can . At x%

it does n ot accept events d ur ing (100- x)% of the tim e.

This limits the cell’s CPU ut ilization .

nu mber 100%

ServerAllInterfaces determ ines wh ether the cell listens on one sp ecific

interface or on all available interfaces

When ServerAllInterfaces=Yes, the cell

commu nicates on all network interfaces on th e host.

When ServerAllInterfaces=No, the cell only

commu nicates with the network interface that has the

IP add ress specified in the mcell.dir file of that cell.

Boolean Yes

ServerDirectoryNamea specifies the name of the cell d irectory file path mcell.dir

ServerPorta specifies the TCP/ IP port num ber at which the cell

listens for all in-boun d requests from sou rces, such as

the BMC Imp act Explorer console, CLIs, and adap ters

nu mber 1828

SystemLogDirName specifies the p ath to the d efault system-d efined log

directory

path %H/log

SystemTmpDirName specifies the p ath to the d efault system-d efined tmp

directory

path %H/tmp

a Can also be used in the mclient.conf configura tion file, which affects the behav ior of all of the BMC Impact

Solutions CLI comm and s. These par ameters retain the sam e qualities and definitions in th e mclient.conf file

as they have in the mcell.conf file.

Table 136 Cell configuration parameters (continued)




Cell failover configuration parameters


Cell failover configuration parameters

Table 137 Cell failover configuration parameters

Parameter Description Type Default valueCellDuplicateAutoFailOver determines whether the p rimary server

autom atically fails over to the second ary

server.

For automatic failover to occur , this

param eter must be set to YES on both

servers.

Boolean Yes

CellDuplicateAutoSwitchBack determines whether the secondary server

autom atically sw itches back to th e

primary server when the primary server

restarts after failover.

For autom atic switchback to occur , this

param eter must be set to YES on both the

primary and secondary servers.

Boolean Yes

CellDuplicateFailOverStart

TimeOut

specifies the length of time (in second s)

that the secondary server w aits to become

active after it is started .

When th e second ary server starts, it

expects the p rimary to conn ect to it. If the

prima ry server does not connect to the

second ary w ithin the time specified by theCellDuplicateFailOverStartTime

Out param eter, the second ary server w ill

become active.

The time sp ecified for CellDuplicate

FailOverStartTimeOut should be

longer than the time sp ecified for

CellDuplicateFailOverTimeOut to

allow operators to start up primary and

second ary servers at almost the same time,

in any order.

number 120



Client communication parameters



CellDuplicateFailOverTimeOut specifies the length of time (in second s)

that the secondary server w aits to become

active after th e secondary server loses

connection to the p rimary server.

number 30

CellDuplicateMode specifies the op eration mod e of the server.

1 = prim ary server

2 = second ary server

0 = the server is operating as a n on-high

availability cell.

This is the only param eter that needs a

different value between pr imary and

secondary.

number 0

Table 138 Client communication parameters


ClientCleanupInterval the interval, in seconds, between clean-up s of

pen ding clients

After each su ch period, clients that d id no t give

the cell a notice of life are disconn ected.

number 300

ClientPollTimeOut the m aximu m time, in m illisecond s, the cell

waits for a client request before it continues

processing

number 200 milliseconds

ClientSendTimeOut the time interva l, in millisecond s, that the cell

has to send a packet to a client on the lowest

commu nication level


DateFormat the format u sed to d isplay timestamp s in the

da te slot

A d efault valu e of CIM ind icates use of the

Comm on Information Mod el (CIM) format

from the Desktop Management Force Group .

DateFormat param eters use the syntax of

%[letter ]. Table 139 on page 448 lists the

DateFormat p aram eters for Solaris; for oth er

operating systems, see their d ocumen tation.

string CIM

SynchronizeTimeOut the m aximu m time, in m illisecond s, the cell

waits for synchronization before drop ping a

connection


Table 137 Cell failover configuration parameters (continued)






If the cell receives an event w ith an emp ty value for the date slot, it sets the date slot

to the textua lly formatted value of the date_reception slot. That value is

determined by the DateFormat param eter. This assignm ent is performed only once,when th e event first enters the cell. If the cell is shut d own and resta rted , the value of

date remains the same even if the DateFormat param eter has been mod ified in the

interval.

The CIM format is yyyymmddhhmmss.mmmmmmsutc, where:

yyyy = year

mm = monthdd = day

hh = hou r, based on 24-hour clock mm = minutesss = second s

mmmmmm = microseconds

s = + or -utc = offset in minu tes from UTC; UTC is the Universa l Time Coord inate system

Table 139 lists the param eters from th e Solaris platform. Other platforms, includ ing

UNIX and Microsoft Window s platforms, may h ave slight differences.

Table 139 Date and time format parameters for Solaris (part 1 of 2)


%% same as %

%a locale’s abbreviated w eekday n ame

%A locale’s full weekd ay n ame

%b locale’s abbreviated m onth nam e

%B locale’s full month name

%c locale’s app ropr iate date and time representation

%C locale’s date and time representation as p rodu ced by d ate (1)

%d day of mon th [1,31]; single d igits are preceded by zero (0)

%D date as %m/%d/%y

%e day of month [1,31]; single d igits are p receded by a space

%h locale’s abbreviated m onth nam e

%H hou r (24-hou r clock) [0,23]; single d igits are p receded by zero (0)

%I hou r (12-hou r clock) [1,12]; single d igits are p receded by zero (0)

%j day nu mber of year [1,366]; single digits are p receded by zero (0)

%k hou r (24-hou r clock) [0,23]; sing le digits are p receded by a blan k

%l hou r (12-hou r clock) [1,12]; sing le digits are p receded by a blan k

%m mon th nu mber [1,12]; single d igits are preceded by zero (0)

%M min ute [00,59]; initial 0 is perm itted bu t not required

%n insert a new line



Encryption parameters


Encryption parameters

Table 140 lists the encryption p aram eters.

%p locale’s equ ivalent of A.M. or P.M.

%r app ropriate time representation in 12-hou r clock format w ith %p

%R time as %H:%M

%S seconds [00,61]

%t insert a tab

%T time as %H:%M:%S

%u weekd ay as a d ecimal nu mber [1,7], where 1 represents Sund ay

%U week n um ber of year as a decimal nu mber [00,53], where Sund ay is the first day of week 1

%V week n um ber of the year as a d ecimal n um ber [01,53], where Mond ay is the first day of the week

If the week containing Janu ary 1st has four or m ore days in th e new year, then it is considered

week 1. Otherw ise, it is week 53 of the previous year, and the n ext week is considered week 1.

%w weekd ay as a d ecimal nu mber [0,6], where 0 represents Sund ay

%W week n um ber of year as a decimal nu mber [00,53], where Mond ay is the first d ay of week 1

%x locale’s ap prop riate date representation

%X locale’s ap prop riate time r epresentation

%y year w ithin centu ry [00,99]

%Y year, includ ing th e centu ry. (for examp le, 2006)

%Z time zone n am e or abbreviation, or no bytes if no time zone information exists

Table 140 Encryption parameters (part 1 of 2)


AllowAdapterFrom specifies the adap ters within the r ange of IP add resses

These are adap ters that u se the BMC Imp act Solutions

commu nications protocol.

string 0./0

AllowBrowserFrom specifies the BMC Imp act Explorer and the BMC

Impact Portal connections w ithin the ran ge of IP

addresses

string 0./0

AllowCellFrom specifies the ce lls wi thin the range of IP addresses str ing 0./0

AllowCLIFrom specifies the command line interfaces (for example,

mkill or mcstat) within the rang e of IP ad dr esses

string 0./0

AllowConnectionFrom specifies the client w ithin the ran ge of IP add resses that

is allowed to conn ect to a cell

string 0./0

Table 139 Date and time format parameters for Solaris (part 2 of 2)




Event repository cleanup parameters



AllowEIFFrom specifies the EIF event sou rces (for exam ple, a

postemsg) within the range of IP add resses

string 0./0

Encryption specifies to use encryption Boolean YesEncryptionKey specifies the encryption key string (empty)

ForceEncryption specifies if encryption is to be forced Boolean No

Table 141 Event Repository cleanup parameters

Parameter Description Type Default valueEventAutoClose autom atically closes a d up licate event

in the database when an event arrives

with status=CLOSED, or it is closed in

the Refine ru le phase

If the d efault valu e is left as Yes, the

event is drop ped and the du plicate is

closed. If the value is set t o No, there is

no du plicate detection and the CLOSED

event is not dropp ed.

Boolean Yes

EventDBCleanupDurationLimit the maximu m d uration, in seconds, of a

single cleanup

After expiration of that p eriod, the

cleanup is interrupted. N ormal

operation p roceeds for an equal

du ration. Then cleanup is resum ed,

with th e same limit again.

number 30

EventDBCleanupInterval the time interval, in second s, between

periodic cleanup s of the repository

number 3600, or 1

hour

minimu m = 60;

no maximu m

EventDBCleanupPercentage the p ercentage of free space required attermination of an EventDB cleanup

With a default EventDBSize of

100000, this mean s that a t least 10000

places mu st be available at termination

of a comp leted cleanup .

number 10minimum=5;

no maximu m

EventDBCleanupOnDateReception indicates the p reference for d eleting

events from the repository based on

wh en they were received instead of

wh en they were last mod ified

Boolean No

Table 140 Encryption parameters (part 2 of 2)






The related grou p of event cleanup param eters gives you control over which eventsare rem oved , limits the du ration of the cleanup, and specifies a pr eference for

cleaning up closed events rather than older events.

EventDBCleanupPreferClosed indicates the p reference for cleaning u p

closed events rather th an older events

When there is not enou gh free spaceafter rem oving all expired events,

add itional, un expired events are

removed. These are selected, oldest

first, either from any events or from th e

closed ones first.

The default is no, meaning th at the

event status valu e is not taken into

accoun t w hen selecting events for

removal.

Boolean No

EventDBKeepClosed the minimu m ag e, in second s, of CLOSED events before they are

removed from the repository

Note: Any m odifications to the

EventDBKeepClosed parameter

should be carefully considered. Events

of these classes remain in th e event

repository until you manu ally delete

them.

number 604800, or 7days;

no minimum ;

no maximu m

EventDBKeepNonClosed the minimu m age, in second s, of non-

closed events before they ar e removed

from the repository

number 2592000, or

30 day s

minimumvalue=0;

maximum

value =

4294967295, or

136 years

EventDBSize the nu mber of events to retain in the

repository

The defau lt size is 100000.

number 100000

minimum

value=100;

no maximu m

EventDBNoCleanupClosed list of classes in w hich closed even ts

will not be deleted from the rep ository

string empty

EventDBNoCleanupNonClosed list of classes in w hich n on-closed

events w ill not be deleted from th e

repository; comma sep arated

Boolea n SM C_STATE_

CHANGE

Table 141 Event Repository cleanup parameters (continued)




Heartbeat parameters


A cleanup first removes expired events. Expired events are those that are older than

the times in th e EventDBKeepClosed an d EventDBKeepNonClosed param eters, for

closed and non -closed even ts, respectively. After this cleanup, if there is still less freespace than specified in the EventDBCleanupPercentage param eter, additional,

un expired events are removed . As man y events are removed as needed to reach the

desired am ount of free space.

Older even ts are remov ed first, w ith one possible exception. If param eter

EventDBCleanupPreferClosed=Yes, closed events ar e remov ed first, even if some

older unclosed events remain. In EventDBCleanupPreferClosed=No mod e, all

events are considered , starting w ith the oldest first.

The mc_date_modification slot is considered to determine th e time of an event.

How ever, if param eter EventDBCleanupOnDateReception=Yes, thedate_reception slot is considered instead .

Cleanup is interru pted if it takes longer than the value of theEventDBCleanupDurationLimit param eter. By d efault, this value is 30 second s. If the cleanu p p eriod was n ot long enou gh to rem ove all expired events, a new cleanup

is schedu led for a later time w ith the same am ount of time as th e d uration limit. If all

expired events were rem oved, the next cleanup is schedu led after the n ormal interval

value of EventDBCleanupInterval.


The hear tbeat featu re allows a sp ecific cell, called th e monitoring cell, to mon itor one

or m ore cells, called th e monitored cell or cells, for enabled access by th e m onitoring

cell.

Table 142 Heartbeat parameters


HeartbeatEnabled indicates wh ether the heartbeat monitoring

mechanism is enabled or not

Boolean Yes

HeartbeatInterval the d efault interval between two beats, if not

specified in the d ata object

number 60

HeartbeatMissedCritical the d efault nu mber of consecutive m issed beats

that are needed to generate a critical event, if not


number 3

HeartbeatMissedMinor the d efault nu mber of consecutive m issed beatsthat are needed to generate a minor event, if not


number 2

HeartbeatMissedWarning the d efault nu mber of consecutive m issed beats

that are needed to generate a warning event , if not


number 1





The parameter in the mcell.conf file of the m onitored cell should be

HeartbeatEnabled=Yes. By d efault, the mon itored cell sends a beat every 300

seconds.

Heartbeats are configured throu gh MC_CELL_HEARTBEAT dynam ic data objects in the

mon itoring cell. An MC_CELL_HEARTBEAT dynam ic da ta object contains information,such as the nam e of the cell to be monitored , the length of the expected time interva ls

between the heartbeats, and the nu mber of heartbeats that m ust be missed to generate

corresponding internal events in the monitoring cell.

The cell receives the d ynam ic da ta object either by loading it from the data directory,receiving it th rough an mposter call, or viewing it in the Ad ministrative View of the

BMC Imp act Explorer. The mon itoring cell sends a requ est to the m onitored cell. The

mon itored cell send s a heartbea t back to the mon itoring cell at the specified interva ls.If the m onitoring cell does not receive a heartbeat in the expected timeframe, the

mon itoring cell generates an a lert that can be viewed in the BMC Imp act Explorer

console.

The defau lt settings for m issing h eartbeats are as follows:

s 1 missed h eartbeat generate a warning event

s 2 missed h eartbeats generate a m inor event

s 3 missed hear tbeats generate a critical event

For examp le, in Figure 202 on page 453, cell 1 is the monitoring cell, w hich send s a

requ est to cell 2, the monitored cell. If it does not receive a response at a sp ecifiedinterval, then the mon itoring cell sends an alert that can be seen in the BMC Imp act

Explorer.

Figure 202 Example of Heartbeat

After a mon itoring cell term inates and restarts, it is aware of pr ior requests forhear tbeats because it reread s the dynam ic data objects that ar e stored in the cell

repository mcdb. After it reread s the data, the mon itoring cell attemp ts to resend therequ est to the mon itored cell.

Request

Heartbeat

cell 1 cell 2





If the mon itored cell terminates, the mon itoring cell resends the request for heartbea ts

at the sp ecified in tervals. Table 143 lists the MC_CELL_HEARTBEAT slots.

Table 143 Heartbeat slots

Slot Descriptioncell target mon itored cell nam e

enable 0 = disabled, 1 = enabled

last_time time last heartbeat w as received

interval length of interval between heartbeats

Specify zero (0) to use the d efault, as determined by the HeartbeatInterval

configuration parameter.

missed_warning nu mber of missed heartbeats before a WARNING event is generated

Specify zero (0) to use the d efault, as determined by the correspond ing

HeartbeatMissedWarning configuration parameter. Specify -1 to d isable

generation of the correspon ding even t.

missed_minor nu mber of missed heartbeats before a MINOR event is generated


HeartbeatMissedMinor configuration parameter. Specify -1 to d isable generation

of the correspond ing event.

missed_critical nu mber of missed heartbeats before a CRITICAL event is generated


HeartbeatMissedCritical configuration parameter. Specify -1 to d isable

generation of the correspon ding even t.

missed nu mber of consecutive missed heartbeats

NOTE

Deleting an inst ance of an MC_CELL_HEARTBEAT data object from a m onitoring cell

terminates the mon itoring of the correspond ing cell or cells.



Internal cell monitor parameters


Internal cell monitor parameters

KB parameters

Table 144 Internal cell monitors parameters

Parameter Description Type Default valueCellEventEnable a flag that ind icates wh ether the cell should generate

internal events, such as start, stop, and heartbeat; does

not includ e events generated by th e rules

Boolean Yes

CellErrorEvents indicates whether an event p rocessing error should

pr odu ce a special internal event to flag that error, or not

Boolean Yes

CellMetricsEnabled determ ines wh ether metrics for cell performance are

collected or not

Boolean Yes

CellTickInterval the time interval, in second s, between gen eration of cell

heartbeat events (ticks)

The pu rpose of such heartbeats is to send a sign of lifefrom th e cell. A zero (0) value d isables cell ticks with out

disabling other internal events. This para meter op erates

only if the CellEventEnable is set to Yes.

number 600

RuleLoopDetect a flag that req uires th e cell to check for certain cond itions

that can ind uce infinite looping of events

Setting th is parameter to Yes can cause mild cell

performance degradation.

Boolean N o

Table 145 KB parameters


KBDirName the path to the active KB directory path the kb directory in the

cell’s cell-specific

configuration directory

KBRecoveryDirName the path to an alternate kb directory to be used

for recovery from catastroph ic dam age

For more information, see “mrecover—

Recovering from a catastrophic data loss” on

page 432.

path kbrecovery



Propagation parameters



The propagation parameters allow you to configure prop agation and destination

buffers.

You can configu re these parameters for ind ividual destinations and also configure a

defau lt value for a ll other d estinations. Use the aster isk (*) to specify all destinations.The following parameter definition illu strates how to configure these pa ram eters for

all destinations.

This example sp ecifies that the interval to try to reconnect is 600 second s for all

destinations. If the * is not explicitly d efined , the d efault value for th e pa ram eter w illbe app lied to all destinations.

To configure param eters for ind ividu al destinations, the value for these p arameters is

formatted as a comma-separated sequen ce of destination-specific settings in the form

of DestinationName=Value. DestinationNames #1 an d #2 are reserved to indicate

the p rimary and second ary n odes of a h igh availability cell.

For example,

This examp le specifies that th e interval to try to reconnect is 10 seconds for the highavailability nod es, 1200 second s for a cell called SlowCell and 600 second s for all

other d estinations. If the * is not explicitly d efined , the default value for th e param eter

will be applied to all unsp ecified d estinations.

DestinationBufferReconnectInterval = *=600

DestinationBufferReconnectInterval = #1=10,#2=10,*=600,SlowCell=1200

Table 146 Propagation parameters

Parameter Description TypeDefaultvalue

DestinationBufferBaseSize the initial nu mber of m essages, or

events, retained in the b uffer

n um ber 5000

DestinationBufferExpandPercentage percentage of the actual bu ffer size that

the buffer expan ds w hen events

continu e to be prop agated after the

buffer is full

number 10





DestinationBufferSizeLimit maximu m allowed bu ffer size

The default value of 0 mean s the buffersize is unlim ited. In pr actice, the size is

limited to 2^ 32-1, or to th e available

amount of memory.

If the limit is set to a v alue lower th an

DestinationBufferBaseSize, the

buffer w ill not expan d beyon d

DestinationBufferBaseSize.

number 0

DestinationBufferReducePercentage minimu m p ercentage of free buffer size

required to perform a redu ction

number 50

DestinationBufferKeepSenta the time, in second s, to keep sent eventsbuffered w hile waiting for an answer

number 300

DestinationBufferKeepWait The amou nt of time, in seconds, that

events are retained in the bu ffer un til

they can be sent.

Once the specified time elapses, the

retained events are removed from the

buffer.

number 3600, o r 1

hour

DestinationBufferReconnectInterval the time interval, in seconds, in w hich

the cell attemp ts reconnection to a

destination if the original connectionfailed

The cell contin ues to reestablish a

connection as long as th ere are events

in the b uffer.

number 600

DestinationBufferResendCount the nu mber of times to resend

unansw ered events

number 1

PropagateBufferBaseSize the num ber of requests for pro pagation

to retain in the p rop agation buffer

Such a requ est correspon ds to firing a

Propagate ru le. There is one prop agate

buffer p er cell with as man y p laces for

requests as set by the param eter.

n um ber 20000

PropagateBufferExpandPercentage percentage of the actual bu ffer size that

the buffer expand s w hen events

continu e to be prop agated after the

buffer is full

number 10

Table 146 Propagation parameters (continued)




Deprecated MessageBuffer propagation parameters


Deprecated MessageBuffer propagation parameters

TheMessageBuffer

propagation parameters d escribed in this section h ave beendep recated, but are retained for backw ard compatibility with earlier versions of BMC

Impact Manager. These param eters may be removed in a later version of the p rodu ct.

If one of the DestinationBuffer param eters is not specified, or if it does not contain

a d efault setting, the value of the correspond ing MessageBuffer para meter is used asdefault. If the corresponding MessageBuffer par ameter is not specified, an intern al

default value is used.

PropagateBufferSizeLimit maximu m allowed bu ffer size

The default value of 0 means th e buffersize is unlimited. In p ractice, the size is

limited to 2^ 32-1, or to th e available

amount of memory.

If the limit is set to a va lue lower th an

PropagateBufferBaseSize, the

buffer w ill not expan d beyon d

PropagateBufferBaseSize.

number 0

PropagateBufferReducePercentage minimu m percentage of free buffer size

required to perform a redu ction

number 50

PropagateConfigFileName the nam e of the prop agationconfigurat ion file

path mcell.propagate

a Can also be used in the mclient.conf configu ration file, which affects the behav ior of all of the BMC Impact Solutions CLI

command s. These param eters retain the same qu alities and d efinitions in the mclient.conf file as they h ave in the

mcell.conf file.

Table 147 Deprecated MessageBuffer propagation parameters


MessageBufferSize the initial nu mber of m essages, or events,

retained in the bu ffer

n um ber 5000

MessageBufferKeepSenta the time, in second s, to keep sent m essages

buffered wh ile waiting for an answ er

number 300

MessageBufferKeepWait The amou nt of time, in seconds, that m essages

are retained in th e buffer until they can be sent.

Once the specified time elapses, the retained

messages are removed from the bu ffer.

number 3600, o r 1

hour

Table 146 Propagation parameters (continued)




Reporting client connection parameters


Reporting client connection parameters

Table 148 lists the parameters that rep ort on client op erations on the cell.

MessageBufferReconnectInterval the time interval, in seconds, in w hich the cell

attemp ts reconnection to a d estination if the

original conn ection failed

The cell cont inu es to reestablish a connection

as long as there are m essages in th e buffer.

number 600

MessageBufferResendCount the nu mber of times to resend u nansw ered

messages

number 1

MessageBufferSize the nu mber of m essages, or events, retained in

the bu ffer when the cell is unable to send , or

when w aiting for an answer; a message that is

not sent because the d estination is dow n, for

example, or a message that was sent but no t

yet answered, remains in the buffer

A cell ma intains on e buffer for each

destination. Such buffers have the same size,

as set by the param eter.

n um ber 20000

PropagateBufferSize the num ber of requests for prop agation to

retain in the prop agation buffer

Such a requ est correspon ds to firing a

Propag ate rule. There is one prop agate buffer

per cell w ith as man y places for requ ests as set

by the p arameter.

n um ber 20000

a Can also be used in the mclient.conf configu ration file, which affects the behav ior of all of the BMC Impact Solutions CLI

command s. These param eters retain the sam e qu alities and definitions in th e mclient.conf file as they h ave in the

mcell.conf file.

Table 148 Reporting client connection parameters


ReportConnectClients reports connect and disconnect of

clients

string browser, Console,

ImpactExplorer, mcontrol,

mkill, mposter, msetmsg,

msetrec

ReportModifyClients reports m odifications of events by

clients

string mposter, msetmsg, msetrec

Table 147 Deprecated MessageBuffer propagation parameters (continued)




Service model parameters


Service model parameters

Table 149 lists the param eters that control the service mod el.

StateBuilder parameters

The runn ing of the StateBuilder is controlled by th e cell, using th e param eters in the

mcell.conf file. Table 150 lists the StateBuilder pa ram eters.

Table 149 Service model parameters


ServiceModelPublish controls wheth er or not Service Model Data is

published

Note: If ServiceModelPublish is disabled, the

ServiceModelDirectFeed parameter has no

imp act. In this case, Service Model Data is always

accepted th rou gh d irect feed.

Boolean YES

ServiceModelDirectFeed when ServiceModelPublish is enabled,

ServiceModelDirectFeed controls wh ether ornot Service Model Data is accepted throu gh d irect

feed

Boolean NO

Table 150 StateBuilder parameters


StateBuildInterval the time interval, in second s, between two

builds of saved states of the cell

nu mber 3600

StateBuildSize the m aximu m size, in kilobytes, of a tran saction

file before it is transformed into a new saved

state wh en the StateBuilder ru ns again.

If BMC Imp act Manager seems to be

consum ing too mu ch CPU, verify that State

Builder is not run ning too frequently. Comparethe time stamps of the m cdb.* files in the log

d irectory of the cell. If the time between tw o

state builds is less than 10 minutes, increase the

StateBuildSize parameter.

nu mber 1000

StateBuildConfigFileName th e StateBu ild er con figu ration file n am e p ath statbld.conf

StateBuildAtTerminate indication to run the StateBuilder w hen the cell

terminates

Boolean N o

StateBuildRunTimeOut the timeout, in second s, to consider w hen

waiting for th e StateBuilder to terminate

n u mber 600 secon d s



Trace parameters


Trace parameters

Table 151 Cell tracing parameters

Parameter Description Type Default valueTracea allows the generation of trace messages Boolean Yes

TraceSrc includes the file and line number in the trace messages Boolean No

TraceConfigFileName location of the file containing the configuration o f the

trace messages

path mcell.trace

TraceDefaultFileName destination file to redirect trace messages from

stderr to, in case the cell run s as a d aemon or service

path %T/trace

TraceRuleLevel sets the level of ru le execution tracing:

s 0—no ru le tracing and no cell error catch (not

recommended)

s 1—no ru le tracing; cell errors are caught in the

standa rd cell trace (default)

s 2—rule tracing enabled

number

TraceRulePhases When r ule tracing is enabled, lists the ru le phases to be

traced. The valu e ALL can be u sed to sp ecify that all

ph ases are to be traced. Each p hase can be p refixed

with a + or a - sign to indicate add ition or rem oval

from the list. The list is interpr eted in sequ ential order.

For example, the following param eter setting:

TraceRulePhases=ALL,-refine,-regulate

indicates that all rule p hases w ill be traced except for

th e refine an d regulate phases.

NOTE: TraceRulePhases an d TraceRuleName

wo rk together to determ ine which ru les are traced. A

rule is only traced if both th e ph ase to wh ich it belongs

and the ru le itself are configured for tracing.

string ALL



Trace parameters


TraceRuleNames When rule tracing is enabled, lists module:rule

combinations to be traced. The value ALL can be used

to specify that all modu les and/ or rules are to be

traced. Each mo du le:rule combination can be p refixedwith a + or a - sign to ind icate add ition or rem oval

from the list. The list is interpr eted in sequ ential order.

For examp le, the following p aram eter setting:

TraceRuleNames=HelpDesk:ALL,

-HelpDesk:rule1,SendMail:rule1

indicates that all rules in th e HelpDesk modu le will

be traced except for rule1. Add itionally,rule1 from

th e SendMail mod ule will be traced.

NOTE: TraceRulePhases an d TraceRuleNames

wor k together to determ ine wh ich ru les are traced. A

rule is only traced if both th e ph ase to wh ich it belongs

and the ru le itself are configured for tracing.

string

TraceRuleHeader allows you to configur e the head er text of the trace

messages. You can configur e the h eader text to contain

references to par ameters, using the following

designations to represent the associated p arameters:

s %I — message id

s %F — sou rce file nam e

s

%L — source line nu mbers %M — KB mod ule nam e

s %R — rule nam e

s %P — ru le phase

s %H — han dle of the main event being p rocessed

(event_hand le slot)

s %C — class name of the m ain event being

processed

For examp le, the d efault param eter setting

TraceRuleHeader=%F, %L: %P %R: %C #%H:

results in a m essage similar to:mc_intevt.mrl, 42: new StbldStop:

MC_CELL_STATBLD_STOP #118: Rule execution

starting

text %F, %L: %P

%R: %C

#%H:

TraceRuleToXact indicates whether to include r ule tracing in th e

tran saction file, as well as in the stan dard cell trace, in

module RULES

Boolean N o

Table 151 Cell tracing parameters (continued)




Trace parameters


TraceFileSize limit on the size of a trace destin ation file, expressed in

kilobytes

When the trace file grows beyon d the ind icated size, itis renam ed w ith a num erical suffix app end ed. A new

trace file is started .

Special valu e 0 (the default) means n o limitation on

file size.

number

TraceFileHistory nu mber of trace files to be kept in h istory

When this num ber is reached, a new num bered trace

file will remove the oldest one.

number 0

TraceFileAppend indicates whether to ap pend to existing trace files or

empty existing trace files at startup

Boolean Yes

a Can also be used in the mclient.conf configura tion file, which affects the behav ior of all of the BMC Impact

Solutions CLI comm and s. These param eters retain th e same qu alities and d efinitions in th e mclient.conf file

as they have in the mcell.conf file.

Table 151 Cell tracing parameters (continued)




Trace parameters





A p p e n d i x DDEnvironment variables

The installation process creates or up dates environm ent var iables used by BMC

Imp act Solutions.


Microsoft Win dow s environ ment var iables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466

Recreating env ironment var iables on Wind ows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466UN IX environment var iables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467

Recreating env ironment var iables on UN IX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467



Microsoft Windows environment variables


Microsoft Windows environment variables

Table 152 lists the Windows environm ent var iables for BMC Imp act Solutions.

Recreating environment variables on Windows

An execu table is available for backward compa tibility and the rare occasion w hen th e

environment var iables mu st be recreated on the same system or a d ifferent system.

To recreate the environm ent variables, ru n the following script:

..\ system32\ drivers\ etc\ mcell\ setup_env.bat

Table 152 Microsoft Windows environment variables

Environment variable Full path name Default directory

BMC_PORTA L_KIT_HOM E

defines the path to BMC

Impact Por tal configur ation

files and executable files

%BMC_PORTAL_KIT_HOME% C:\ BMCSoftware\ BMCPortalKit\

DATASTORE_HOME

defines the path to the BMC

Datasto re files

%DATASTORE_HOME% C:\ BMCSo ftware\ Datastore

MCELL_HOME


Impact Manager configuration

files and executable files

%MCELL_HOME% C:\ Program Files\ BMC

Software\ MasterCell\ server



UNIX environment variables


UNIX environment variables

Table 153 lists the UN IX environ men t variables for BMC Imp act Solutions.

Recreating environment variables on UNIXAn execu table is available for backwa rd compatibility and the rare occasion w hen th e

environment var iables mu st be recreated on the same system or a different system.

To recreate the environ men t variables, ru n one of the following scripts:

. /etc/mcell/mcadapter/setup_env.sh

source /etc/mcell/mcadapter/setup_env.csh

Table 153 UNIX environment variables

Environment variable Full path name Default directory

BMC_PORTA L_KIT_HOM E


Impact Po rtal configu ration

files and executa ble files

$BMC_PORTAL_KIT_HOME /opt/bmc/BMCPortalKit

DATASTORE_HOME

defines the path to the BMC

Datasto re files

$DATASTORE_HOME /opt/bmc/Datastore

MCELL_HOME


Impact Manager configu ration

files and executa ble files

$MCELL_HOME /opt/mcell



Recreating environment variables on UNIX





A p p e n d i x EEBMC Microsoft Windows services and UNIX

processes

This app end ix describes the services and p rocesses for BMC Imp act Solutionsprodu cts and components.


BMC M icrosoft Window s services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470

BMC UN IX processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470



BMC Microsoft Windows services


BMC Microsoft Windows services

Table 154 lists the Microsoft Window s services for BMC Imp act Solutions p rod ucts

and components.

BMC UNIX processesTable 155 lists the UN IX processes for BMC Imp act Solutions p rod ucts andcomponents.

Table 154 BMC Microsoft Windows services

Service name

datastore s BMCPDSAgent VM IC7 has

‘OracleBMCPDSORA92Agent’

s BMCPDSListener VM IC7 has

‘OracleBMCPDSORA92TNSListener’

s BMCPDSServ ice VM IC7 has ‘OracleServiceBMCPDS’

Portal appserver s BMC Portal

Portal webserver s BMCPortalWebserver

BMC Atrium CMDB s AR System Portmap per

s Remed y Action Request System Server

mcell s mcell_cellName

BMC Imp act

Publishing Server

s BMC Impact Publishing Server

Impact Integration

Web Services

s SIM Web Services VM IC7 has ‘iiws_cellName’

Table 155 BMC UNIX processes

These names are shown as part of the string

datastore s BMCPDS

BMCPDS is the default; the process name is user-defined

du ring installation

Portal appserver s bmc/ BMCPortalKit/ appserver

Portal webserver s bmc/ BMCPortalKit/ webserver

BMC Atrium CMDB s bmc/ cmdb/ bin/ arserverd

s bmc/ cmdb/ bin/ arsvcdsp

s bmc/ cmdb/ bin/ armonitor

mcell s mcell –n cellName



BMC UNIX processes


BMC Imp act

Publishing Server

s pserver

Impact IntegrationWeb Services

s

iiws

Table 155 BMC UNIX processes

These names are shown as part of the string



BMC UNIX processes





A p p e n d i x FFBMC Impact Event Adapters MAPfiles

This app endix discusses how to define the syntax of and how to use a MAP file.

Defau lt MAP files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474

Custom maps an d ma p-related files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474

Cu stom MAP files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474

Cu stomized Perl MAP-fun ctions file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475

MAP file structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475

Section s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475

Directives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486

Overview

When an event is read by an Adap ter, the Adap ter mu st convert the event from its

interna l representa tion, such as a Perl hash , into the BMC Imp act Manager

compa tible format, the BAROC language. The structure of the conversion is

controlled by a sp ecial configu ration file, the MAP file. Each Ad ap ter u ses its ownMAP file to prod uce BMC Impact Manager even ts.

BAROC classes for Adap ters are d efined in the mcxa.baroc file, wh ich is installed inthe d efault Knowledge Base of each BMC Imp act Manager Even t Processor. TheAd ap ters create a copy of this file in the MCELL_HOME\ etc directory . This file also

contains classes for standard events sent by msend an d mposter.



Default MAP files


Default MAP files

Table 156 lists the d efault nam es for the MAP files of the d ifferent BMC Imp act Event

Adapters.

On UNIX platforms, MAP files are located in the MCELL_HOME/etc directory.

On Wind ow s platforms, MAP files are located in th e MCELL_HOME\ etc directory.

Custom maps and map-related files

If you w ant to expand map functionality beyond tha t offered u sing the d efault map s,

you can create custom map files that p rodu ce the event formats that you require.

Custom MAP files

To use a MAP file other than the d efault, specify the p ath and nam e of the map file as

the value of the MapFile param eter in the Ad apter sp ecification in the mcxa.conf file.For example:

MapFile = mymap.map

Table 156 Default MAP files

Adapter Default MAP file name

Perl EventLog for Wind ows mceventlog.map

LogFile mclogfile.map

SNMP Trap mcsnmptrapd.map

Ap ache LogFile mcapache.map

UN IX syslog mcsyslogd.map

TCP Client mctcpclt.map

TCP Server mctcpsrv.map

Telnet mctelnet.map

UDP Client mcudpclt.map

UDP Server mcudpsrv.map



Customized Perl MAP-functions file


Customized Perl MAP-functions file

The MAP file can use other MAP-fun ctions files by using the REQUIRE d irective in theconfigu ration file. While you still can define custom ized functions in BMC Impact

Manager, theREQUIRE

directive should be u sed rather than theMapFunctionsName

param eter. For m ore information, see “REQUIRE directive” on page 486.

Table 157 lists the default MAP-functions file for each Ad apter .

By default, the MAP-functions file is located in MCELL_HOME /li b (UNIX) or in

MCELL_HO ME \ lib (Windows).

MAP file structure

The stru cture of a MAP file is line-oriented . Each line can be one of the six (6) types of recognized statements:

s a comm ent

s a d efine statement

s an inpu t variables statement

s an initialization statement

s a defau lt class statement

s a class statemen t

Sections

The MAP file can be d ivided into the following sections:

s INPUT_VARIABLES

In this section, inpu t variables from the Ad apter are d efined. Inpu t variables

statemen ts belong in th is section. See “INPUT_VARIABLES section” on page 476.

Table 157 Default map functions Perl files

Adapter MAP-functions file

Perl EventLog for Wind ows eventlogmap.pl

LogFile logfilemap.pl

SNMP snmptrapdmap.pl

Syslog syslogdmap.pl



Sections


s INIT

In this section comm on initialization of the slots is perform ed. Init statementsbelong in th is section. See “INIT section” on page 482.

s DEFAULT

A d efault class is defined in th is section. Defau lt class statements belong in this

section. See “DEFAULT section” on p age 483.

s CLASS

The map ping betw een BMC Impact Manager classes and internal Adap ter classes

is defined in the CLASS section. Class statem ents belong in th is section. See“CLASS section” on p age 483.

INPUT_VARIABLES section

Inpu t variables take their value from the p arsing of data received by the Ad apter.Parsers d o this by pa rsing a log file from a Syslog or LogFile Ad apter , decoding a

packet from a n SNMP Ad apter, or u sing a ded icated API from a u ser-defined

Adap ter. Variables are stored internally by the Adap ter in the form a Perl Hash table.Variables mu st be declared inside the INPUT_VARIABLES structure in order to be

recognized and u sed by the MAP file. The inp ut var iables are not chosen arbitrarily.

They must correspond to the internal Perl structure of the event.

Single variables

The INPUT_VARIABLES section begins w ith a line that contains on ly the keyword

INPUT_VARIABLES and ends w ith a line that contains only the keyword END . Withinthe section each variable is declared in a single line. The nam e of a variable mu st

begin w ith the $ character.

Variables contain scalar values su ch as $avariable. These values are scalar in thecontext of the Perl langu age. They can represent a string or a nu mber, dep ending on

the var iable definition. Therefore, these variables mu st be assigned on ly to relevant

BMC Imp act Manager slots.

NOTE

These variables cann ot be customized u nless the method of event reception is changed .



Sections


The var iables also can be references in Perl context to a ny type of object. Such

reference variables cannot be u sed for slot assignm ent, except a s references to a list as

discussed below, but can be used as argu ments of customized functions. If thevariable is a reference to a Perl list, it can be an assignm ent value for a slot wh ich is of

th e LIST_OF type.

Series of variables

The MAP file sup por ts declaration of series of variables. The syn tax is the same as for

scalar var iables except that the var iable nam e must be followed by an interva l of

values. Three forms of acceptable declarations of sets are:

$setA 0—43

$setB 43

$setC 0—i

The first line declares 44 scalar variab les,$setA1,$setA2,...,$setA43. The second

line is equ ivalent to the first declaration. The third line d eclares a set of un definedsize. In th is case, var iables$setC0, $setC1, $setC2, ..., $setC99can be used in the

MAP file. If the set h as a size larger than 100, its size mu st be sp ecified in the

declaration. There is no size limit to sets other than you r computer ’s mem oryresources. In other w ords,

$set N

is equivalent to

$set0

$set1

...

$setN

Order

Except in the var iables declaration, the inp ut variables section can contain comments.This section mu st be the first, as illustrated in the examp le of the inp ut v ariables

section of the SNMP Trap Ad ap ter in Figure 203.

Figure 203 Comments code example

INPUT_VARIABLES

$Version

$Community

$Enterprise

$TrapType

$Specific

$TimeTicks

$SourceAddr



Sections


The MAP file is case sensitive. $Source an d $SOURCE are tw o different var iables.

For backw ard compatibility, the$LOGFILE INPUT_VARIABLEScontains the value of the

LogLOGFILE param eter in the configu ration file or “logfile” as d efault. A new

INPUT_VARIABLE, $logname, is available and contains the n ame of the log file. In

add ition, the syntax of the param eters is changed to be consistent with all Adap ters.Specific par ameters to the LogFile Adap ter begin w ith Log in which the ‘L’ is up per

case.

Slot assignments

Most MAP file entries are either a slot assignmen t or a cond ition. A slot assignm ent is

used to enter an inp ut value into a BMC Imp act Manager slot.

Unlike variables, the BMC Imp act Manager slots are not declared in the MAP file.

They are syntactically rep rodu ced wh en th ey are sent to the cell. Figure 204 illustrates

acceptab le slot assignm ent forma ts:

$RequestId

$ErrorStatus

$ErrorIndex

$EnterpriseName

$TrapTypeStr# Special INPUT_VARIABLES (references on list)

$var

$oid

$oidt

# Variable for indexes. $idx is a reference on a list # of lists.

# It cannot be used for direct slot assignments

$idx

END

Figure 204 Slot assignment formats

slot_name = 1234

slot_name = “a string”

slot_name = #mydefine

slot_name = $variableslot_name = $variable[3]

slot_name = buildlist (<args>, ...)

slot_name = gethostbyaddr (<arg>)

slot_name = gethostbyname (<arg>)

slot_name = lower (<arg>)

slot_name = printf (<format>, <args>, ...)

slot_name = substr (<arg>, <start_pos>, <length>)

slot_name = upper (<arg>)

slot_name = <perl_func> (<args>, ...)

Figure 203 Comments code example



Sections


The first five lines are simp le assignm ents either from constants (lines 1–3) or from a

variable (lines 4 an d 5). When slot_name is assigned to a constant, this constan t is

recognized from th e first non -space character after the equ al (=) sign, to the last non-space character on the sam e line.

Strings mu st be delimited by d ouble quotes (“”). Because of the construction of aMAP file, a string cannot contain new lines. In ord er to includ e new lines in a string, a

user -defined Perl fun ction must be defined. For more detail, see the last assignmen t

for slot_name containing <perl_func>. Strings can contain dou ble quotes since the

last dou ble quote in the line is considered to be the end of the string.

Line 5 involves a substring of a var iable,$variable. This corresponds to the m atching

substring of $variable, evaluated in a condition statement involving a regu lar

expression matching $variable.

Slots can also be assigned to th e retu rn v alue of one of the seven functions as listed in

Table 158. Fun ctions are u sed to insert in a slot a value h eld by an entity in th enetwork, such as the IP add ress of a comp uter.

Table 158 Slot Functions

Function Description

buildlist (<args>, ...) <args> is a list of argu ment s represented by constants or

variable names. buildlist return s a list of values that can be

assigned to a LIST_OF slot. See th e BMC Impact Manager

Knowledge Base Reference Guide for details about LIST_OF slots. If

the left side of the buildlist assignment is not a LIST_OF slot,

the cell will reject the even t.gethostbyaddr (<arg>) <arg> is either a string or a variable name containing the internet

addressof acomputer,suchas123.456.789.012.gethostbyaddr

return s the full nam e of the compu ter, or zero (0) if not found .

gethostbyname(<arg>) <arg> is either a string or a v ariable nam e containing th e name of

a comp uter. gethostbyname return s the internet ad dress of the

compu ter in the form a string, such as123.456.789.012, or zero

(0) if not foun d.

lower (<arg>) <arg> is either a string or a v ariable nam e containing a string.

The fun ction retur ns <arg> converted to low ercase.

substr(<arg>,<start_pos>,<length>) <arg> is either a string or a v ariable nam e containing a string.

<start_pos> an d <length> are either integers or v ariablescontaining integers.substr acts as the Perl substr fun ction. See

Perl docum entation for details.



Sections


The most general method of assignment is represented by the following assignment

form:slot_name can be assigned to the retu rn va lue of built-in Perl functions, or any

user d efined Perl function, that is defined in an external file and loaded w ith th e

REQUIRE directive.

slot_name = <perl_func>( <args>, ...)

<perl_func> can be either a bu ilt-in Per l fun ction, such a s length or time, or a

function defined in files loaded with the REQUIREdirective. The argu ments <argS>of

<perl_func> can be any of the following:

s constants su ch as “a string”, 1234

s inpu t variables such as $avariable, $anothervar[1]

s variables know n in the global context such as @INC, $ENV{’PATH’}

s simp le expressions involving fun ction calls such as length($avariable)

Constants and inp ut var iables are used as in other assignments. In ad dition,<perl_func> can accept other argum ents that ar e valid Perl expressions in th e global

context. Local variables of the MAP module MA::Map and other m odules are not

know n, except for variables with a global scope not declared w ith a “my’ statemen t,wh en their nam e is preceded by the modu le nam e and : : ). These expressions cann ot

contain comm a characters (,), except in str ings that h ave single or doub le quotes. For

example, an argu ment such as badarg($farg1, $farg2) is not valid, wh ile

goodarg(“string, string”) is a valid argu ment.

Conditions

A cond ition is a Boolean expression associated w ith a CLASS statement that must be

satisfied so the current event m atches the class. A cond ition has the format:

<var> <operator> <comp_value>

<var> is either an inpu t variable or a substring of an inpu t variable set in a p revious

condition, such as:

printf (<format>, <args>, ...). <format> is either a string or a variable name containing a string.

<args> is a list of argum ents, possibly emp ty, represented by

constants or variables, similar to oth er assignmen ts, whose

values must correspond to the <format> argument. printf behaves like the printf Perl fun ction an d therefore like the C

printf function. See C and Perl docum entation about printf for

details.

upper (<arg>) <arg> is either a string or a va riable nam e containing a string.

The fun ction retur ns <arg> converted to uppercase.

Table 158 Slot Functions

Function Description



Sections


$avariable

$anothervar[1]

<operator> is one of the operator s listed in Table 159.

Whenth eoperatorissmaller,greater,smaller_or_equals orgreater_or_equals,<var>

mu st contain a num ber.

<comp_value> represents:

s num ber, such as 12, –2, 0xFF, .314E+2.

s string, such as “A string” (<operator> mu st be equals or not_equals).

s regular expression, such a s /.*matchthis.*/ (<operator>mu st be equalsor

not_equals).

s DEFINE representing one of the above three values, such as #mydefine.

Pattern matching

<comp_value> regular expressions are evaluated with th e Perl rules for p attern

matching. See your Perl documentation abou t p attern m atching for details. Theregular expression can contain paren theses that match substrings of <var>. These

substrings can be accessed by u sing th e [] operator on <var>. Technically, if <var>

represents$var, the Perl variables$1,$2,...,$9are stored in$var[1],$var[2],...,

$var[9]. For examp le:

Table 159 Operators

Operator Description

equals When<var>an d <comp_value>contain nu mbers, the cond ition is satisfied if <var>

an d <comp_value> are equal. When <var> an d <comp_value>contain strings, the

cond ition is satisfied if <var>an d <comp_value>contain the same string. Remember

tha t these are case sensitive. When<var>contain a string an d <comp_value> is a Perl

regular expression, the cond ition is satisfied wh en <var> matches with the Perl

regular expression.

not_equals not_equals can be used in the same cond itions as equals and returns the negation

of the expression w here not_equals is replaced by equals.

smaller When <var> an d <comp_value> are nu mbers, the cond ition is satisfied if <var> isstrictly smaller than <comp_value> (<var> < <comp_value>).

greater When <var> an d <comp_value> are nu mbers, the cond ition is satisfied if <var> is

strictly larger than <comp_value> (<var> > <comp_value>).

smaller_or_equals When <var> an d <comp_value> are nu mbers, the cond ition is satisfied if <var> is

smaller or equal to <comp_value> (<var> _ <comp_value>).

greater_or_equals When <var> an d <comp_value> are nu mbers, the cond ition is satisfied if <var> is

larger or equal to <comp_value> (<var> _ <comp_value>).



Sections


Sup pose that $matchcontains “first second third etc....” The first condition is

satisfied since$matchcontains at least two w ord s. After the first cond ition,$match[1]

contains “first” and $match[2]contains “second”. The second condition is satisfiedan d slot is set to “second.”

A more comp lex examp le is:

The second condition also involves pattern m atching. The second cond ition issatisfied;$match[1]contains “ir” and $match[2]contains “st”.slot is set to “st”.

Such su bstrings can be used in nested CLASS stru ctures. The second exam ple show s

how a substring, itself, can be used as an exp ression for pattern matching. In this case,

the new partial strings extracted from the subexpression ar e accessed by u sing th eoperator[]from th e base string. To clarify, examine th e condition:$match[1] equals

/f(..)(.*)/. After a successful matching, the expressions correspond ing to the two

expressions (..) and (.*) will be stored in $match[1] an d $match[2], wh ichoverrides the previous values of $match[1] an d $match[2]. Expressions such as

$match[1][1]an d$match[1][2]arenot allowed.This m ay seem counterintuitive, but

it is very m uch in accordan ce with the Perl approach to p attern matching, where

special variables $1, $2, ..., take new values at each match.

Regular expressions

s cannot contain references to the variables declared in the INPUT_VARIABLESsection

s sup port the follow ing mod ifiers: g i m o s x

Consu lt the Perl docum entation for details about such modifiers. For example.

$match equals /AnY_cAsE/i

matches the string “any_case” in lower and up per case.

INIT section

The INIT section contains assignm ents of BMC Imp act Manager slots that are

common to all events. Figure 205 illustrates th e stru cture of the IN IT section.

$match equals /\s*(\w+)\s+(\w+)\s+.*/

$match[1] equals “first”

slot = $match[2]

$match equals /\s*(\w+)\s+(\w+)\s+.*/

$match[1] equals /f(..)(.*)/

slot = $match[2]



Sections


<assignment> is an assignm ent. When an external event is map ped into a BMC

Impact Manager event, the assignm ents of the INIT section are evaluated for each

event. ACLASSor DEFAULTassignm ent overrides a slot value p reviously set in the INIT

section.

DEFAULT section

Figure 205 illustrates the stru cture of the DEFAULT section.

<class_name> is the name of the defau lt class, such as EVENT, DEF_ADAPTER_EV.

Be certain that th e class nam e is recognized by the cell to which it is sent. If an event

does not ma tch any CLASS requ iremen ts, an event of class <class_name> can begenera ted. The slots of the event are set by evaluation of the assignmen ts of the INIT

an d DEFAULT sections. DEFAULT assignm ents override INIT assignm ents of the same

slot. TheDEFAULTsection can contain n o assignmen ts. The DEFAULTsection is optiona l.At most, one DEFAULT section is authorized.

By d efault, the DEFAULTmechan ism is disabled. That is, if an event d oes not ma tch any

class, it is dropp ed before being sent to the cell. To enable the DEFAULT classmechanism, either:

s Use the -e comm and -line option w ithout argum ent, or

s Use the MapUseDefaultClass (MapUseDefaultClass=1) parameter in theconfigu ration file (etc/*.conf).

CLASS section

The CLASS structures contain the main information about how to map Ad apter events

into BMC Imp act Manager events. CLASS stru ctures can be nested .Figure 207illustra tes th e CLASS leaf section .

Figure 205 INIT structure

INIT

<assignment>

<assignment>

...

END

Figure 206 DEFAULT structure

DEFAULT <class_name>

<assignment>

<assignment>

...

END



Sections


General structure

Figure 208 illustrates the general structure for n ested class map ping.

<class_name>,<sub_class_name>,an d<subsub_class_name> ar enamesof th eBAROC

classes. An even t m atches a CLASS<class_name>when all cond itions (<condition>)associated with that class and pa rent classes are satisfied. If all cond itions

(<condition>) are satisfied, assignmen ts (<assignment>) associated w ith tha t CLASS

and possible paren t classes (CLASS) are evaluated in order to build a BAROC event.This BAROC event is then sent to a cell. Classes are evaluated sequen tially. As soon

as an incoming event satisfies all conditions of a CLASS and does not match any

subclass of that CLASS, an event of the correspon d ing BAROC class is created, thensent.

Figure 207 CLASS leaf structure

CLASS <class_name>

<condition>

<condition>

...

<assignment><assignment>

...

END

Figure 208 Nested class mapping Structure

CLASS <class_name><condition>

<condition>

...

<assignment>

<assignment>

...

CLASS <sub_class_name>

<condition>

...

<assignment>

...

CLASS <subsub_class_name>

...END

END

CLASS <sub_class_name>

...

END

END



Sections


Even if it is often the case, the CLASS stru cture of the MAP file is not requ ired to

reflect th e BAROC classes as defined in a .baroc file. The n atu re of the h ierarchical

classes in the MAP file is purely syntactic. The BAROC class correspond ing to asubclass need not be a su bclass, in the BAROC sense, of the BAROC class

correspon d ing to the pa rent CLASS in the MAP file sense. In addition, a MAP file can

contain several classes hav ing the sam e <class_name>.

Class name

Moreover, a MAP file can contain CLASS <class_name> statemen ts of nonexistent

correspon d ing BAROC class names (<class_name>). In this case, either th e MAP

wr iter h as verified that n o event w ill match that CLASS without m atching any

subclass or events of CLASS <class_name> w ill be drop ped by the cell, as in

Figure 208.

The above CLASS stru cture defines several possible matches for CLASS A or CLASS B.

Even if CLASS B is nested in CLASS A in the first CLASS A structure, CLASS B is notnecessarily a BAROC su bclass of CLASS A. Note that the BAROCCLASS Bmu st have a

defined slot, slot1. CLASS dummy need not be a defined BAROC class since thecond ition u nd er the nestedCLASS B,$var2 equals /.*/, is alw ays satisfied, w hich

means tha t it is impossible to generate a du mm y event from that MAP file samp le.

Figure 209 Class name exampleCLASS A

$var1 equals /string3/

slot1 = “abc”

CLASS B


slot2 = “def”

END

END

CLASS B


slot1 = “ghi”

END

CLASS dummy$var1 equals /string3/

CLASS A


slot1 = “jkl”

CLASS B

$var2 equals /.*/

slot1 = “mno”

END

END



Directives


Directives

A MAP file can also contain a DEFINE or a REQUIRE directive.

DEFINE directive

A DEFINE directive is a line beginning w ith the DEFINE keyword, as the following

illustrates.

DEFINE the_define “define value” <new line>

When su ch a statement is made, each su bsequent statement in w hich a v alue isrepresented by#the_define(the first ’#’ character is requ ired), is rep laced by“define

value,” exclud ing the sp ace characters before the end o f line.

A comment line is a line in wh ich the first non-space character is a # , a ! , or a %

character. Comment lines and emp ty lines are ignored.

REQUIRE directive

Instead of using th e MapFunctionsName param eter, user-defined Per l files can be

included in the .map file by using th e REQUIRE directive, as follow s:

REQUIRE <perl_module>

In general, <perl_module> is a Perl mod ule or script containing fun ctions accessible

from within the .map file. The location mu st be either th e Perl standard librarydirectory or in the MCELL_HOME \ l ib \ perl d irectory. Subd irectories are allowed with

the standard Perl “::“ notation. For example, Figure 210 is an extract from the

mcsyslogd.map file.

DateSyslog2Epoch is defined in MCELL_HOME\ lib\ perl\ MA\ MapUtil.pm.

Multiple REQUIRE statements are allow ed w ithin the sam e .map file.

Figure 210 mcsyslogd.map file excerpt

REQUIRE MA::MapUtil

# ... lines are missing

CLASS SYSLOG_BASE $complete equals

logfile = $LOGFILE

source = "Syslog"

mc_incident_time = DateSyslog2Epoch ($complete[1])



Directives


Following th e object-oriented Perl method s, the first argu men t of each u ser-defined

call is a reference to the MA::Mapobject. The INPUT_VARIABLESof the MAP file can be

found in the {specific_event} key of the MA::Map object, as Figure 211 illustrates.

In Figure 211, above, DateSyslog2Epoch has been called with the single argum ent$complete[1]. The Ad apter au tomatically ad ds the MA::Map object to the beg inningof function argu men ts, so that the first shift inside the implementa tion of

DateSyslog2Epoch retu rns the MAP object, while the second shift return s the stringcorrespond ing to $complete[1]. See the MCELL_HOME \ l ib \ perl\ MA\ Map.pm file for

more details.

Figure 211 Map call

sub DateSyslog2Epoch

{

my MA::Map $map = shift;

my $str = shift;

# See MapUtil.pm for the rest of source.

#

# INPUT_VARIABLES could accessed as (for instance):

# my $ivars = $map–>{specific_event};

# foreach my $iv (keys %$ivars)

# {

# # Do something with $iv and $ivars > {$iv}

NOTE

The function th at $comp lete performs in the LogFile, Perl EventLog for Window s, and SNMPAda pter m app ings is performed by $data for the IP Ad apters (see references to the $d ata

variable on p ages 115, 117 and 121). $data is p rovided autom atically. You do not h ave to get it.

How ever, you cannot renam e it.



Directives





A p p e n d i x GGIP Adapters


Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489IP Ad ap ter architectu re . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490

IP Ad ap ters configu ration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490

IP Adapter types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491TCP Clien t Ad ap ter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491

TCP Server Ad ap ter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494Telnet Ad ap ter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496

UDP client Ad ap ter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500

UDP server Ad ap ter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503

OverviewThe IP Adap ters use the variou s pro tocols of the IP protocol suite to establish

connections with p rograms from w hich you wan t to generate events.

With the IP Adap ters, you are able to specify the connection m ethod to the d atasource and the typ e of parsing that you wan t performed on the collected d ata.

Data tha t is collected u sing an IP conn ection is parsed into a Perl hash (nam e-value

pair d ata tokens) by a p arser that you sp ecify. The par sed d ata is passed to a map ping

function, wh ich converts the d ata tokens into events. The events are sent to m send,which passes them to the cell.

For inform ation about h ow an d w hen an Adap ter collects data, see “IP Adap ter

architecture” on page 490.

The IP Ad apters are bu nd led with th ree pluggable parsers. You sp ecify w hich p arser

you w ant to u se as a param eter in the Ad apter configuration. For m ore informationabout p arsers, see the BMC Impact Solutions: General Admin istration guide.



IP Adapter architecture


IP Adapter architecture

The Adap ter architecture is a loop that is a central waiting state for a p rogram.

When an Ad ap ter is started, it registers to the loop. The loop checks to see if any filedescriptor s are active. When a d escriptor becomes active, the Adap ter receives the

new data.

IP Adapters configuration

The Adap ter configuration is contained in a list of param eters that are recorded in th e

Adap ter definition in the mcxa.conf file. You configu re an Ad ap ter by sp ecifying

values for that Adap ter’s parameters. For information about configuring an Ad apterdefinition, see the BMC Impact Solutions: General Administration Guide.

Each Ad apter has u nique p arameters that ap ply only to that instance of theparam eter. These param eters are listed u nd er the description for each p arameter typ e

in “IP Adapter types” on page 491.

In ad dition, global and comm on p arameters also determine the configuration of an

Adap ter p arameter instance (where instance-specific param eters do n ot overridethem).

The global param eters that affect IP Adap ters are:

s EngineMgrName

s PollInterval

s TraceFile

s TraceLevel

s TraceSizeCount

s TraceSizeMax

s TraceSizePeriod

The comm on p aram eters that affect IP Adap ters are:

s MapFile

s MapFunctionsName

s MapUseDefaultClass

s ServerName

For m ore information about global and common param eters, see the BMC Impact

Solutions: General Administration guide.



IP Adapter types


IP Adapter types

The BMC Imp act Event Ad apters includ e a n um ber of different IP Ad apters. With the

variety of different Adap ters tha t are available, you can select the mean s for collecting

event data that is most app ropriate to your requirements.

The IP Adap ters are:

s “TCP Client Adap ter” on page 491

s “TCP Server Adap ter” on page 494

s “Telnet Adap ter” on page 496

s “UDP client Adap ter” on page 500

s “UDP server Ad apter” on page 503

The parameter d escriptions includ e tables that d escribe the specific pa ram eters of each Adapter type. Specific pa ram eters determ ine how a single instan ce of anAdap ter behaves. How ever, Adapter behavior is also determ ined by global and

comm on p aram eters. The settings of global and comm on p arameters affect mu ltiple

instances of variou s types of Adap ters. For more information, see the BMC Impact

Solutions: General Administration guide.

TCP Client Adapter

The TCP Client Adapter connects to a TCP Server to receive a data stream . The

Adap ter passes the data stream to a par ser. The parser parses the data stream into

data tokens, which th e map ping fun ction converts into events.

Table 160 on page 491 describes the TCP Client Ad apter param eters.

Table 160 TCP Client Adapter configuration parameters (part 1 of 3)


instancename nam e of the Adap ter instance

The instance nam e is the first entry in the Ad apter configuration and mu st be enclosed

in squar e brackets.

Required.

Note: To run m ore than on e instance of the Adap ter, specify a un ique nam e and

configuration for each Ad apter instan ce.

ConnectTimeout maximu m tim e, in second s, to wait until a connection attemp t is considered

unsuccessful

Default: 10



TCP Client Adapter


Engine type of Adapter in use

Required.

Valid value: MA::Adapter::TcpClient

LocalHost local IP ad dress on a comp uter w ith mu ltiple network interfaces to wh ich the TCP

Client Ad apter binds

Specify a value for this parameter only w hen the Ad apter is on a compu ter that has

mu ltiple netw ork interfaces. By d efault, the Ad apter w ill bind to the d efault interface.

Valid values: host name or IP add ress

Note: Do not sp ecify localhost, 127.0.0.1, or INADDR_ANY as a value for this

parameter.LocalPort local port nu mber to w hich the TCP Client Ad apter bind s

Default: AN Y

Mapfile nam e of the MAP file used to generate events from the tokenized d ata

Required.

Parser parser instance to use to parse and tokenize the client inpu t stream

Required.

You m ust code the nam e of anoth er section in the mcxa.conf file that d efines a par serwith a u nique nam e. It is not valid to code the nam e of a parser typ e as would be u sed

in the Engine parameter.

Example:

Parser = ParseSyslog

where ParseSyslog is the uniqu e name for a parser d efinition, such as:

[ParseSyslog]

Engine = MA::Parser::FixedWidth

In the Adap ter definition, do n ot code:

Parser = MA::Parser::FixedWidth

RemoteHost hostname or IP add ress of the remote compu ter to which the TCP Client Ad apter is

connecting

Required.





TCP Client Adapter


Figure 212 shows a sam ple TCP Client Ad apter configuration, as it w ould app ear in

th e mcxa.conf file.

Diagnostics

All Ad apter er rors are logged as events. Optionally, you can enable tracing by settingthe tracing pa ram eters in the global section of the mcxa.conf file. For more

information, see the BMC Impact Solutions: General Admin istration guide.

The TCP Client Ad ap ter can generate an ERR_RECV error, w hich indicates that a

problem occurr ed w hen r eceiving d ata from the server. For more information, see theevent that is created for th is error.

RemotePort port on the remote compu ter to wh ich the TCP Client Ad apter is conn ecting

Required.

RestartInterval interval, in second s, at wh ich:

s the TCP Client Ad apter re-attempts to bind to the local port if that port is bu sy

wh en the Ad apter makes its first bind attempt

s the TCP Client Ad apter send s a packet if the connection tha t the Ad apter u ses is

functioning

Note: If the current connection fails or the rem ote server stops resp ond ing, this

para meter value is also used to schedule add itional connection attemp ts by the

Adapter.

Default: 60

Figure 212 Sample TCP Client Adapter configuration

[TcpClient] DISABLE

Engine = MA::Adapter::TCPClient

Parser = SeparatorParser

MapFile = mctcpclt.map

RemoteHost = localhost

RemotePort = 13 # date/time service





TCP Server Adapter


TCP Server Adapter

The TCP Server Adapter receives connections from on e or m ore TCP clients. Theseclients send d ata streams to the Adap ter. The Ad apter p asses the data stream to a

parser. The p arser parses the data stream into d ata tokens, w hich the m app ingfunction converts into events.

Table 161 on page 494 describes the TCP Client Ad apter param eters.

NOTE

You cannot u se Telnet as a m eans for commu nicating with th e TCP Server Ad apter. The TCP

Server Adap ter does not recognize incoming Telnet comman ds as m eaningful binary control

codes. Instead, the Adap ter interprets Telnet informa tion as raw d ata.

Table 161 TCP server Adapter configuration parameters (part 1 of 2)


instancename nam e of the Ada pter instance



Required.

Note: To run m ore than one instance of the Ad apter, specify a uniqu e nam e and

configuration for each Ad apter instance.


Required.

Valid v alue: MA::Adapter::TcpServer

LocalHost local IP add ress on a compu ter with m ultiple network interfaces to which the TCP

Server Adapter binds

Specify a value for this parameter only w hen th e Adap ter is on a comp uter that h as



Note: Do not sp ecify localhost, 127.0.0.1, or INADDR_ANY as a valu e for this

parameter.

LocalPort local port n um ber on w hich the TCP Server Ad apter listens for connections

Default: 1999


Required.



TCP Server Adapter


Figure 213 shows a sam ple TCP Server Adap ter configuration, as it would app ear inth e mcxa.conf file.

Diagnostics

All Ad apter er rors are logged as events. Optionally, you can enable tracing by setting

the tracing pa ram eters in the global section of the mcxa.conf file. For moreinformation, see the BMC Impact Solutions: General Admin istration guide.

MaxClients maximu m n um ber of clients allowed to conn ect simultaneou sly to the TCP Server

Adapter

Default: 10

Parser parser instance that should be used to parse and tokenize the client inpu t stream

You m ust code the nam e of another section in the mcxa.conf file that d efines a par ser

with a u nique nam e. It is not valid to code the nam e of a parser type as wo uld be u sed

in the Engine parameter.

Example:


wh ere ParseSyslog is the uniqu e nam e for a parser d efinition, such as:

[ParseSyslog]


In the Ada pter d efinition, do n ot code:


RestartInterval interval, in seconds, at which the TCP Server Ad apter r e-attemp ts to bind to the local

port if that p ort is busy w hen the Ad apter m akes its first bind attempt

Default: 30

Figure 213 Sample TCP server adapter Configuration

[MyTcpServer]

Engine = MA::Adapter::TcpServer

MaxClients = 10

RestartInterval = 30

MapFile = mctcpsrv.map

LocalHost = 127.0.0.5LocalPort = 1999

Parser = MyFixedWidthParser

Table 161 TCP server Adapter configuration parameters (part 2 of 2)




Telnet Adapter


The TCP Server Ad ap ter can generate an ERR_RECV error, wh ich ind icates that a

problem occurr ed w hen r eceiving d ata from the server. For more information, see the

event tha t is created for this error.

Telnet Adapter

The Telnet Ad apter is a Telnet client that can connect to a Telnet Server to receive a

data stream. The Adap ter passes the data stream to a p arser. The parser par ses the

data stream into data tokens, which the map ping fun ction converts into events.

Use the Telnet Ad ap ter in the following situations:

s interactivity is required (the Ad apter logs on, subm its a comm and , and receivesoutput)

s the pr ocess that is being monitored by th e Adap ter is not meant to stop (such as log

file monitoring )

The Telnet Adap ter operates on the following p rinciples:

s The Telnet Adap ter u ses the “interpret as comm and ” functions DO, DON T, WILL,

and WONT.

s The Telnet Adap ter uses “supp ress go ahead” (SGA) to decrease negotiation time.

s To eliminate looping p roblems w ith SGA, each comm and is accepted or rejectedonly once and the rep ly is consistent every time.

s The current Telnet Adap ter sup ports a m inimal set of Telnet N egotiation

comm and s. Almost every p roposal (DO) that the Telnet Adap ter receives from its

peer is replied to with a negation (WON T).

Table 162 on page 497 describes the Telnet Ad apter p aram eters.



Telnet Adapter


Table 162 Telnet adapter configuration parameters (part 1 of 3)



The instance name is the first entry in the Ad apter configu ration and mu st beenclosed in squ are brackets.

Required.


configu ration for each Ad apter instan ce.

ConnectTimeout maximu m tim e, in second s, to wait until a connection attemp t is considered

unsuccessful

Default: 10


Required.

Valid v alue: MA::Adapter::Telnet

IdleTimeout maximu m tim e, in second s, after which n ew d ata is expected to have arr ived. After

this time, the conn ection is considered un successful.

Default: 15 seconds

LocalHost local IP add ress on a compu ter with m ultiple network interfaces to wh ich the Telnet

Adap ter binds

Specify a value for this para meter only when the Ad apter is on a compu ter that hasmu ltiple netw ork interfaces. By d efault, the Adap ter w ill bind to th e default

interface.



parameter.

LocalPort local port n um ber to w hich the Telnet Client binds

Default: AN Y

LoginPrompt regular expression of the login prom pt

Required.

Default: "login[: ]*$| username[: ]*$"


Required.



Telnet Adapter


Parser parser instance that should be u sed to parse and tokenize the client inpu t stream

Required.

Example:


where ParseSyslog is the u niqu e name for a p arser definition, such as:

[ParseSyslog]




PasswordPrompt regular expression that pr ovides valid alternative password prom pt text

Required.

Default: "password[: ]*$"

Prompt list of alternate prom pt characters

Required.

Default: "[\ $>#%]"

script Telnet login script

Required.

Default: telnet.conf

RemoteHost hostnam e or IP add ress of the remote compu ter to which the Telnet Adapter is

connecting

Required.

RemotePort port on the remote compu ter to wh ich the Telnet Adapter is connecting

Required.

RestartInterval interval at which the Telnet Ad apter re-attemp ts to bind to the local port if that port

is busy w hen the Ad apter mak es its first bind attemp t

This interval also can be used for any other reschedu ling th at hap pen s within the

Ad apter (such as reschedu ling timeou t or termination).

Default: 60





Telnet Adapter


Figure 214 shows a sam ple Telnet Adapter configuration, as it wou ld app ear in the

mcxa.conf file.

Diagnostics

All Telnet Ad ap ter errors are logged as events. Optionally, you can enable tracing by

setting the tracing parameters in the global section of the mcxa.conf file.

RestartWhenDone reestablishes a connection w hen it fails or is broken d ue to a h ang-up

Valid v alues:

s 0 – no reconnect

s 1 – reconnect

Default: 0

TelnetAuthTimeout maximu m tim e, in second s, to wait for the comp letion of the au thentication p hase

Required.

TelnetCommand comman d to execute after logging onto the rem ote comp uter

Required.

TelnetPassword password used to connect to the remote comp uter

Required.

TelnetUsername user nam e used to connect to the remote comp uter

Required.

Figure 214 Sample Telnet Adapter configuration

[MyTelnet] #name of Adapter instance

Engine = MA::Adapter::Telnet


# Use the parser you want for the output

MapFile = mctelnet.map

RestartInterval = 60 # Interval used when an error occurs

# Or when Adapter restarts

IdleTimeout = 15 # Close the connection when no data has

# been received for 10 seconds (implicit restart)

ConnectTimeout = 10 # Restart if the connection takes longer

# Than 10 seconds to complete

RemoteHost = localhost # Which host to connect toRemotePort = 23 # Which port (23 = telnetd port)

TelnetAuthTimeout = 15

TelnetUsername = myusername # Username for login

TelnetPassword = mypasswd # Password for login

TelnetCommand = "ls -l" # Command to execute after login





UDP client Adapter


The Telnet Adap ter can generate an ERR_RECV error, wh ich indicates that a problem

occurred wh en receiving d ata from the server. For m ore inform ation, see the event

that is created for this error.

UDP client Adapter

The UDP Client Ad ap ter connects to a UDP Server to receive a data str eam. TheAdap ter passes the data stream to a par ser. The parser parses the data stream into


Table 163 describes the UDP Client Ad apter p arameters.

NOTE

If you su spect problems w ith the Telnet N egotiation comman ds, mon itor the Telnet option

negot iation p rocess by enabling Trace level 6. For d etails about tr acing, see the BMC Impact

Solutions: Event Monitoring Operator’s Guide.

Table 163 UDP client Adapter configuration parameters (part 1 of 3)


instancename nam e of the Ada pter instance

The instance nam e is the first entry in the Ad apter configu ration and mu st be enclosed


Required.

s Note: To run m ore than on e instance of the Ad apter, specify a uniqu e name an d

configuration for each Ad apter instance.

ConnectTimeout maximu m time a connection w ill stay active

After the period of time sp ecified in Conn ectTimeou t has expired, the Ad apter closes

the connection. No more d ata w ill be received from th at connection.

If no Con nectTimeou t value is specified or if the va lue sp ecified is 0, the timer is

disabled. This is the d efault beha vior.

Engine type of Adapter in u se.

Required.

Valid v alue: MA::Adapter::UdpClient



UDP client Adapter


IdleTimeout maximu m time, in second s, after wh ich n ew d ata is expected to hav e arrived. After this

time, the connection is considered un successful.

Default: 15

The UDP Client Ad apter send s a packet at a regular interval, specified by the sum of

the period s specified by the IdleTimeout an d RestartInterval parameters.

LocalHost local IP add ress on a compu ter with m ultiple network interfaces to which the UDP

Client Adapter binds

Specify a value for this parameter only w hen th e Adap ter is on a comp uter that h as



Note: Do not specify localhost, 127.0.0.1, or INADDR_ANY as a valu e for this

parameter.

LocalPort local port nu mber to which the UDP Client Adap ter bind s

Default: AN Y


Required.

Parser parser instance that should be used to parse and tokenize the client inpu t stream

Required.

Example:


wh ere ParseSyslog is the uniqu e nam e for a parser d efinition, such as:

[ParseSyslog]


In the Ada pter d efinition, do n ot code:


RemoteHost hostname or IP address of the remote comp uter to wh ich the UDP Client Adap ter is

connecting

RemotePort port on the remote comp uter to w hich the UDP Client Ad apter is conn ecting





UDP client Adapter


Figure 215 shows a samp le UDP Client Adap ter configuration, as it would app ear in


Diagnostics

All Ad apter er rors are logged as events. Op tionally, you can enable tracing by setting

the tracing pa ram eters in the global section of the mcxa.conf file. For m ore

information, see the BMC Impact Solutions: General Administration guide.

The UDP Client Ad apter can generate an ERR_UDP_INIT error , which indicates that a

problem occurr ed w hen r eceiving d ata from the server. For more information, see theevent tha t is created for this error.

RestartInterval interval, in second s, at w hich

s the UDP Client Ad apter re-attempts to bind to the local port if that por t is busy

wh en the Ad apter makes its first bind attempt

s the UDP Client Ad apter send s a packet at the rate prescribed by this par ameter

plus th e interval prescribed in the IdleTimeoutparam eter, if the connection th at the

Ada pter u ses is functioning

Default: 60

The RestartInterval par ameter value is also used to schedu le add itional connection

attemp ts by the Adap ter when a ny of the following occur:

s the current connection fails

s the remote server han gs

s the amou nt of time specified in th e IdleTimeout parameter expires

SendOnConnect string that is sent after a connection is established

Figure 215 Sample UDP client Adapter configuration

[MyUDPClient]

Engine = MA::Adapter::UdpClientMapFile = mcudpclt.map

RemoteHost = test.bmc.com

RemotePort = 13






UDP server Adapter


UDP server Adapter

The UDP Server Ad ap ter receives connections from one or m ore UDP clients. TheAdap ter passes the data stream to a par ser. The parser parses the data stream into


Table 164 describes the UDP Server Ad apter p arameters.

Table 164 UDP Server Adapter configuration parameters (part 1 of 2)





Required.


configuration for each Ad apter instan ce.

Engine type of Adapter in u se.

Required.

Valid value: MA::Adapter::UdpServer

IdleTimeout maximu m tim e, in seconds, after w hich new data is expected to have arr ived. After this

time, the connection is considered un successful.

Default: 15

LocalHost local IP add ress on a compu ter with m ultiple network interfaces to which the UDP

Client Ad apter binds

Specify a value for this parameter only w hen the Ad apter is on a compu ter that has



parameter.

Valid values: host nam e or IP addr ess

LocalPort local port n um ber on w hich the UDP Server Adap ter listens for connections

Default: 2000


Required.



UDP server Adapter


Figure 216 shows a samp le UDP Server Adap ter configuration, as it w ould app ear in


Diagnostics

All Ad apter er rors are logged as events. Op tionally, you can enable tracing by setting

the tracing pa ram eters in the global section of the mcxa.conf file. For m ore

information, see the BMC Impact Solutions: General Administration guide.

The UDP Server Ad apter can generate the following errors:

s ERR_RECV—ind icates that a p roblem occurred wh en receiving d ata from the server

s ERR_UDP_INIT—ind icates that a problem occurr ed w hen starting the UDP

connection

For more information, see the event tha t is created for this error.

Parser parser instance that should be u sed to parse and tokenize the client inpu t stream

Required.

Example:


wh ere ParseSyslog is the u nique n ame for a p arser definition, such as:

[ParseSyslog]




RestartInterval interval, in second s, at which the UDP Server Ada pter re-attempts to bind to the local

port if that p ort is busy w hen the Ad apter m akes its first bind attemp t

Default: 60

Figure 216 Sample UDP Server Adapter configuration

[MyUDPServer]

Engine = MA::Adapter::UdpServer

MapFile = mcudpsrv.map

LocalPort = 1997


Table 164 UDP Server Adapter configuration parameters (part 2 of 2)





A p p e n d i x HHBMC Impact Event Adapters parsers


Wh at a parser does . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505LogFile, Perl EventLog for Window s, and SNMP Ad apter p arsers . . . . . . . . . . . . . . 505

IP Ad ap ter parsers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507

Specifying a CSV parser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507Specifying a Fixed-width (colum n) parser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509

Specifying Record and Field separated pa rser . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514

What a parser does

A par ser formats the data th at is collected by one of the BMC Impact Event Ad ap ters,converts it into tokens (fields), and passes these tokens to the map ping p rocess.

The SNMP Adap ter, the BMC LogFile Adap ter, and th e Perl Wind ows EventLogAdap ter each use a d edicated p arser engine. This engine cannot be replaced or

mod ified. You do not need to specify the par ser in the Ad apter d efinition.

The BMC Impact Event IP Adap ters can u se any of three p luggable parsers, which

each p arse the d ata in a d ifferent format. For each IP Ad apter, you mu st specify a

parser in the Ad apter d efinition in the mcxa.conf file. The IP Adap ter requ ests the

parser as an object.

LogFile, Perl EventLog for Windows, and SNMPAdapter parsers

The LogFile Ad apter, Perl EventLog for Wind ows Ad apter, and SNMP Adap ters

include ded icated internal parsing fun ctions.



LogFile, Perl EventLog for Windows, and SNMP Adapter parsers


Events in a log file are d etermined either by a record separator or by a Perl regular

expression.

The most comm on event separator is the newline ( \ n ). The p arameter

LogRecordSeparatorcontains the record separator of the events.LogRecordSeparator

recognizes Perl escape characters, such as \ n , and gen erally can contain severalcharacters or even a r egular expression. For examp le, setting

LogRecordSeparator="\n\n"resu lts in events being d elimited by tw o consecutive new

line characters that results in a single emp ty line. By d efault, settingLogRecordSeparator = "\n" creates events that ar e line-based. In other cases, the

parsing will be mu lti-lined.

The input variable $complete is set to the string between the tw o consecu tiveLogRecordSeparator entries.

According to the value of the p aram eter LogRegExpr, the following instances are

considered:

s LogRegExpr is emp ty. $complete is split into substrings, delimited by th e

LogFieldSeparator variable. These substrings are stored in $varlog<N> variables

(N>=0). For examp le, if

$complete contains "a;b;c;d", and

$LogFieldSeparator contains ";"

then

$varlog0="a"$varlog1="b"

...

s LogRegExpris not empty . The regular expressionLogRegExpris applied to$complete.

Subp atterns of $complete are stored in $varlog<N> variables (N>=1). For examp le,

$complete contains "12345 abcde", and

$logRegExpr contains "(\d+)\s*(\w+)"

then

$varlog1=12345

$varlog2="abcde"

s LogRecordSeparator is emp ty and LogRegExpr is not emp ty. In this case, the regular

expression contained in LogRegExpr will be app lied to th e log file from the p oint at

wh ich th e previous su ccessful m atching stopp ed. The inpu t variable$completewillbe set to the w hole matching of the regular expression. LogVarPrefix contains the

nam es of variables containing subp atterns. By default,

LogVarPrefix="varlog"



IP Adapter parsers


If both variables are emp ty, the behavior of the Adap ter is not d etermined.

IP Adapter parsers

Unlike the Logfile Adap ter, the SNM P Ad apter, and the Perl EventLog for Window sAdap ter, wh ich have their own ded icated par sers, the IP Adap ters can u se any one of

the follow ing parsers that ar e included with th e BMC Impact Event Adap ters.

s “Specifying a CSV par ser”

s “Specifying a Fixed-width (colum n) p arser” on page 509

s “Specifying Record and Field separated parser” on page 514

Specifying a CSV parser

The CSV parser, MA::Parser::CSV, is a p luggable parser that par ses a datastream into

records (new line), in w hich each record is a comm a-separated value list. The parser

return s each value as a token to the map per.

To specify the CSV parser

1 Using a text ed itor, open the mcxa.conf file.

2 In the section of the file that d escribes the Adap ter that you wan t to u se with theCSV parser, ad d th e following line:

Parser = parsername

3 In the p arser section of the mcxa.conf file, define par ser parsername.

Table 165 on page 508 describes the param eters that you can m odify in the p arserdefinition.



Specifying a CSV parser


Table 165 CSV parser parameters (part 1 of 2)


FieldSeparator a set of characters that w ill be used as a d elimiter

Optional.

Default: comma (,)

KeepEmptyRecords indicates whether emp ty records are formatted as tokens and passed

to the mapp ing fun ction

Required.

Valid v alues:

s 1 – tokenize empty record s

s 0 – discard emp ty records (Default)

RecordNegFilter a regu lar expression th at acts as a criterion to w hich each p arsed

record is comp ared

If the criterion is includ ed in the record, the record is d iscard ed.

Optional.

RecordPosFilter a regu lar expression th at acts as a criterion to w hich each p arsed

record is comp ared

If the string is includ ed in th e record , the record is formatted as a

token and p assed to the m apping function.

Optional.



Specifying a Fixed-width (column) parser


Figure 217 on page 509 shows a sam ple parser d efinition for a par ser named

MyParser.

4 Save an d close the mcxa.conf file.


The fixed-wid th parser, MA::Parser::FixedWidth, is a plu ggable parser that par ses adatastream into records. From each record , a field is extracted based on a fixed-width

format.

RecordSeparator regular expression used to break a datastream into separa te record s

The resulting record is return ed in the $data variable, wh ich can then

be used in the MAP file to refer to the en tire record as one field. The$data variable is provided autom atically. You cann ot renam e it.

Optional.

Default: \ r?\ n

Note: The inp ut variable $data is set to the string between tw o

consecutive RecordSeparator entries. It performs th e function that

$complete performs in the LogFile, Perl EventLog for Window s, and

SNMP Ad apter mapp ings.

VarPrefix variable prefix used by the map per

Each token w ill be returned as prefix0 ... prefix n.

Optional.

Default: varlog

Default variables sent to the map per are n amed varlog0, varlog1, ...

Figure 217 Sample CSV parser specification example

[MyParser]

Engine = MA::Parser::CSV

FieldSeparator = "," # Default

KeepEmptyRecords= 0 # Discard Empty Records

RecordNegFilter = "(test|dummy) event"

RecordPosFilter = "(ERROR|WARNING)"

VarPrefix = "token" # Return token0 ... tokenn

Table 165 CSV parser parameters (part 2 of 2)






To specify the fixed-width parser

1 Using a text editor, open the mcxa.conf file.

2 In the section of the file that describes the Ad apter th at you w ant to u se with the

fixed-width p arser, add the follow ing line:

Parser = parsername

3 In the pa rser section of the mcxa.conf file, define par ser parsername.

Table 166 on page 510 describes the param eters that you can m odify in the p arser

definition.

Table 166 Fixed-Width parser parameters (part 1 of 2)

Parameter DescriptionFieldDefinitions a nu merical pair that sp ecifies which data are u sed in a field

The first nu mber in the p air specifies from w hich character in th e

string to b egin collecting d ata. The second nu mber specifies how

ma ny consecutive characters are to be includ ed in the field.

For more information, see “Defining Fields” on pag e 512.

Required.

KeepEmptyRecords indicates whether emp ty records are formatted as tokens and passed


Required.

Valid Values:



RecordNegFilter a regu lar expression th at acts as a criterion to w hich each p arsed

record is comp ared


Optional.

RecordPosFilter a regu lar expression th at acts as a criterion to w hich each p arsed

record is comp ared


token and p assed to the m apping function.

Optional.





RecordSeparator regular expression used to break a datastream into separa te record s

The resulting record is return ed in the $data variable, wh ich can then

be used in the MAP file to refer to the en tire record as one field. The$data variable is pro vided autom atically. You cannot renam e it.

Optional.

Default: \ r?\ n

Note: The inp ut variable $data is set to the string between tw o

consecutive RecordSeparator entries. It performs th e function that

$complete performs in the LogFile, Perl EventLog for Window s, and

SNMP Ad apter mapp ings.

TrimLeadingWS removes leading wh ite space, if any, from fields

Required.

Valid Values:

s 1 – removes w hite space (Default)

s 0 – does not remove w hite space

TrimTrailingWS removes trailing white space, if any, from fields

Required.

Valid Values:

s 1 – removes w hite space (Default)

s 0 – does not remove w hite space

VarPrefix variable prefix used by the map per

Each token w ill be returned as prefix0 ... prefix n.

Optional.

Default: varlog

Default variables sent to the map per are n amed varlog0, varlog1, ...

Table 166 Fixed-Width parser parameters (part 2 of 2)






Figure 218 shows a sam ple parser d efinition for a p arser named MyParser.

4 Save and close the mcxa.conf file.

Defining Fields

The conten ts of each field ar e determ ined by a p air of nu mber s. Each record from

which the field is extracted is a string of data. The first field nu mber ind icates thestarting position in the record at w hich the string field begins. The second nu mber

ind icates the length of the string.

Defining a Single Field

The first character of the record is zero (0). A starting num ber of 5 indicates that the

string begins with the sixth character in the record string.

Either n um ber in the field sp ecification can includ e a negative nu mber. The field

length position can include an asterisk w ildcard (*).

s When the starting p oint (the first nu mber) is negative, the starting position isdetermined from the end of the record.

Figure 218 Fixed-width parser specification example

[MyParser]


RecordSeparator = "\r?\n"

FieldDefinitions = "0:10,5:10,15:20"

KeepEmptyRecords = 0

TrimLeadingWS = 1

TrimTrailingWS = 1


EXAMPLE In this examp le, the string is:

ABCDEFGHIJKLMNOPQRSTUVWXYZ

If the field specification is <0,3>, then the string that comp oses the field is ABC. The A is at

position 0, and then starting from p osition 0, three characters are selected to comp rise the

field.

If the field specification is <11,2>, then the string th at composes th e field is LM (remember

that th e first character in the record is at p osition 0, not 1). The L is at position 11, and then

starting from p osition 11, two characters are selected to comp rise the field.





s When th e field length (the second nu mber) is negative, the ending p oint of thestring is calculated by counting back that nu mber of characters from the end of the

string and including everything in between the start point and up to that end

point.

s Both the starting p oint and the length can be negative values.

s When th e length is an asterisk (*), all characters from the star ting point to th e endof the record string comp rise the field string. Use the asterisk when you d o not

know the record field length but wan t to select all of it from the starting p oint thatyou specify.



If the field specification is <-8,3>, then the string that comp oses the field is STU . The S is atposition -8, and then starting from p osition -8, three characters are selected to comp rise the

field.

Alternately, you can express the same string in p ositive nu mbers: <18,3>.



If the field specification is <8,-3>, then the string that comp rises the field is

IJKLMNOPQRSTUVW . The string star ts at I (position 8) and includes all but the last three

characters in the record string.



If the field specification is <-20,-4> , then the string that comp rises the field is

GHIJKLMNOPQRSTUV. The string starts at G (position -20) and includ es all but th e last

four characters in th e record string.



Specifying Record and Field separated parser


Defining Multiple Fields

Each record can contain m ultiple fields. A prototyp e for their ord er is

<START1>:<LENGTH1>[, <START2>:<LENGTH2>[, <STARTn>:<LENGTHn>[...]]]


The Record and Field Separated parser, MA::Parser::Separator, is a pluggable parser

that p arses a d atastream into u ser-definable records. Each record is then converted

into a token using a user-d efineable field sep arator .

To Specify the Record and field separated parser

1 Using a text editor, open themcxa.conf

file.

2 In the section of the file that describes the Ad apter th at you w ant to u se with the

record and field separated p arser, add the following line:

Parser = parsername

3 In the p arser section of the file, define parser parsername.

The param eters of the p arser d efinition that you can mod ify are d escribed in

Table 167 on page 515.


ABCDEFGHIJKLMNOPQRSTUVWXYZABC

If the field sp ecification is <15,*>, then the string that comp rises the field isPQRSTUVWXYZABC. The string sta rts at P (position 15) and includ es all remaining

characters in th e record string.





Table 167 Record and field separated parser parameters (part 1 of 2)


FieldSeparator regular expression used to break a record into m ultiple fields

Required.

Default: \ s+ (separates on any instan ce of white space)

KeepEmptyRecords indicates whether emp ty records are formatted as tokens and p assed


Required.

Valid Valu es:



RecordNegFilter a regu lar expression th at acts as a criterion to w hich each parsed

record is comp ared


Optional.

RecordPosFilter a regu lar expression th at acts as a criterion to w hich each parsed

record is comp ared


token and passed to the map ping function.

Optional.

RecordSeparator regular expression used to break a datastream into separ ate records

The resulting record is returned in th e $data variable, which can then

be used in the MAP file to refer to the en tire record as one field. The

$data variable is provid ed au tomatically. You cannot renam e it.

Optional.

Default: \ r?\ n

Note: The inp ut v ariable $data is set to the string between twoconsecutive RecordSeparator entries. It performs the fun ction th at

$complete performs in the LogFile, Perl EventLog for Wind ows, and

SNMP Adap ter mappings.





Figure 219 shows a sam ple parser d efinition for a p arser named MyParser.

4 Save and close the mcxa.conf file.

TrimLeadingWS trims the leading white space from th e record before app lying the

RecordSepara tor, which is don e using the split function

In this parser, TrimLeadingWS does not trim th e wh ite space fromeach FIELD after th e RecordSeparator has been app lied.

VarPrefix variable prefix used by the ma pp er. Each token w ill be returned as

prefix0 ... prefix n.

Optional.

Default: varlog

Default variables sent to the map per are nam ed varlog0, varlog1, ...

Figure 219 Record and Field Separated Parser Specification Example

[MyParser]

Engine = MA::Parser::Separator

RecordSeparator = "\r?\n"

FieldSeparator = "\s+"

KeepEmptyRecords = 0 # Discard Empty Records

RecordNegFilter = "(test|dummy) event"

RecordPosFilter = "(ERROR|WARNING)"


Table 167 Record and field separated parser parameters (part 2 of 2)





A p p e n d i x IIBackend processes for publishingand unpublishing MIB files


The p ublish MIB files back-end process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517

The u np ublish MIB files back-end pr ocess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518

The publish MIB files back-end process

The Produ ct N ame au tomates the p ublish MIBs process. The steps involved in the

pu blish MIB files back-end process have been reprod uced here for your referenceonly.

1. The new MIB files are moved from you r local comp uter to the Net-SNMP directory.

2. Before overwr iting a MIB file that already exists in the Net-SNMP d irectory, a

backup of that file is saved in the MCELL_HOME \ tmp\ adapters\ snmpadapter\ mibs directory.

3. The mib2map.pl ut ility, which is located in the MCELL_HO ME \ bin directory, is run .

It generates the following four ou tpu t files:

— mcsnmptrapdmib.baroc: This file conta ins the BAROC class definitions of the

SNM P Traps found .

— mcsnmptrapdmibe.baroc: This file contains the BAROC enu merations of the MIBenum erated variables that are sent by traps.

— mcsnmptrapdmib.dat : This file contains information abou t object identifiers

(OIDs), symbolic nam es, enu merations and indexes found in MIB trap s.

— mcsnmptrapdmib.map : This file conver ts traps in to BAROC.



The unpublish MIB files back-end process


4. The four outpu t files are saved in the MCELL_HOME \ bin directory.

5. A backup of the previous mcsnmptrapd.dat file is saved in the

MCELL_HO ME \ tmp\ adapters\ snmpadapter\ mib2mapOutput directory.

6. A backup of the previous mcsnmptrapd.map file is saved in the MCELL_HO ME \ tmp\ adapters\ snmpadapter\ map d irectory. The file is renamed to

mcsnmptrapdLastModified.map.

7. The mcsnmptrapdmib.dat and mcsnmptrapdmib.map files are renam ed to

mcsnmptrapd.dat an d mcsnmptrapd.map respectively, and moved to the

MCELL_HO ME \ e tc directory.

8. The customizations in the previous mcsnmptrapd.map file are merged w ith the new

mcsnmptrapd.map file.

All the invalid MIB files in th e Net-SNMP directory are identified an d displayed in the

status a rea. Before you m anu ally delete an invalid file existing in th e Net-SNMP directory, ensur e that the invalid file does not su pp ort any valid MIB files.


The Produ ct Na me au tomates the unpu blish MIB files pr ocess. The steps involved inthe u np ublish MIB files back-end process have been rep rodu ced here for your

reference only.

NOTE

s In the mcxa.conf file, if you h ave not sp ecified the file names for th e MapFile an d

SnmpDatFile param eters, by default the Produ ct Name u ses the mcsnmptrapd.map

an d mcsnmptrapd.dat file nam es respectively. This d ocumen t u ses mcsnmptrapd.map

an d mcsnmptrapd.dat to refer to the files tha t are configured for the MapFile an d

SnmpDatFile par ameters respectively in the mcxa.conf file.

s In the mcxa.conf file, if you h ave not specified the file name for th e MapFile parameter,the Product Name renames the mcsnmptrapd.map file to

mcsnmptrapdLastModified.map. Otherwise, ‘mcsnm ptrap d’ is replaced w ith the file

name that you h ave specified for the MapFile parameter in the mcxa.conf file. For

example, filenameLastModified.map.

NOTE

The Publish MIBs process preserves the entr ies of classes in the mcsnmptrapd.map file

even if the correspond ing MIB files do n ot exist in th e Net-SNMP directory.





1. A backup of the mcsnmptrapd.map an d mcsnmptrapd.dat files is saved in the

MCELL_HO ME \ backup\ adapters\ snmpAdapter\ removeMib d irectory. These two

files are located in th e MCELL_HOME \ e tc directory.

2. The mcsnmptrapd.map temp late file is copied to the MCELL_HO ME \ etc directory.

3. A backup of the mcsnmptrapdmib.baroc and mcsnmptrapdmibe.baroc files is saved

in the MCELL_HOME \ backup\ adapters\ snmpAdapter\ removeMib d irectory. Thesetwo files are located in the MCELL_HOME \ b in directory.

4. The following tasks are rep eated for each MIB file that h as to be un pu blished.

A. The modu les within the MIB file that has to be unpu blished are identified.

B. The mib2map.pl utility, which is located in th e MCELL_HOME \ bin d irectory, is

run only for the MIB file that has to be u np ublished. The four ou tpu t files that

are generated are mcsnmptrapdmib.baroc, mcsnmptrapdmibe.baroc,mcsnmptrapdmib.dat , and mcsnmptrapdmib.map . The four ou tpu t files are saved

in the MCELL_HOME \ b in directory.

C. The classes created for the MIB file are extracted from th e mcsnmptrapdmib.map

file, which is located in the MCELL_HOME \ b in directory. The same classes arethen removed from the mcsnmptrapd.map file, which is located in the

MCELL_HO ME \ etc directory.

D. The content of the mcsnmptrapd.dat file, which is located in the

MCELL_HO ME \ bin directory, is referenced and then th e same content is

removed from the mcsnmptrapd.dat file, which is located in the MCELL_HO ME \ etc directory.

5. The backup of the mcsnmptrapdmib.baroc an d mcsnmptrapdmibe.baroc files, which

are located in the MCELL_HOME \ backup\ adapters\ snmpAdapter\ remo veMib

directory, is restored to the MCELL_HOME \ b in directory.

6. The MIB files that are unp ublished ar e also removed from the Net-SNMP directory.



Glossary 521

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

AAbstract phase

The event-processing p hase in w hich Abstract ru les are evaluated and , if cond itions are met,

abstraction events are generated. See also abstraction event.

Abstract rule

An event-processing rule that creates an abstraction event from one or m ore raw events. See alsoabstraction event.

abstracted eventAn even t that contribu tes to the creation of an abstraction event. The abstracted event is thebasis for inferring tha t som e condition exists. For exam ple, if a critical subp rocess of an

app lication is dow n, the ap plication is down . See also abstraction event.

abstraction eventA conceptu al or sum mary event based on other events that are occurr ing. You cannot

un der stand the context of an abstraction event by its details. To und erstand its context, you

mu st view the relationships between th e abstraction event an d the events that triggered itscreation in the BMC Imp act Explorer Events tab, Relationships w indow . See also abstracted

event.

AcknowledgeThe event opera tion action tha t acknow ledges the existence of an even t. See also local action.

Acknowledged s tatusThe event status that resu lts from an Acknow ledge event operation action; it mean s that anoperator h as acknowledged the event's existence.

action

1. Generally, a procedu re that is invoked to p rod uce a specific result. It can be a script or a call toan executable that is invoked au tomatically in respon se to an event, or it can be a m anu al

intervention . Actions can be sched uled or imm ediately invoked locally or remotely.

2. In BMC Imp act Manager, an executable that can be ru n by a cell. Actions ar e called in anExecute ru le. Users can request th e execution of actions in the BMC Impact Explorer. See alsolocal action and non-local action.





adapterA backgrou nd process that au d its da ta from var ious sources, evaluates it for specific conditions,

and creates the correspond ing events. Adap ters also transform event d ata into the formatun derstood by BMC Imp act Manager.

adapter instanceAn instan ce of an adap ter that is defined in the adap ter configu ration file. The definition is

given a nam e and specifies an ad apter typ e, such as a log file adapter.

adapter map fil eA text file that d efines the tran slation of a message between one event form at and anoth er. It is

also known as a .map file.

Adminis trative View

The BMC Imp act Explorer u ser interface for cell adm inistration. Adm inistrative users can start,

pa use, stop, an d reconfigure a cell by using th is interface. They can a lso make chan ges to a cell’sdynamic data tables. You access this view by clicking the Administration tab in BMC Imp act

Explorer.

administratorThe person r esponsible for adm inistrative tasks within the p rodu ct.

aliasSee service componen t alias.

annotated data point

A specially marked p oint on a param eter graph th at provides d etailed information about a

parameter at a p articular m oment. The associated data is accessed by d ouble-clicking th e d atapoin t, w hich is represented by a user-specified character.

API

See App lication Program Interface (API).

Application Program Interface (API)A set of externalized functions that allow interaction w ith an ap plication.

assetAn object instance in the BMC Atrium Con figuration Management Database (BMC Atrium

CMDB). There are two types of assets in th e BMC Atriu m CMDB: non-service componen ts, such

as d esks and other n on-IT ph ysical assets, and service compon ents that p articipate in the

delivery of enterp rise services.

asset inventoryThe list of all ph ysical and logical assets that h ave an identifiable value to the organization oragainst wh ich threats and vulnerabilities can be identified and quan tified a s p art of risk

assessment.



Glossary 523


Assign ToThe event operation action that assigns the respon sibility for an event to an individu al.

Assigned s tatus

The event status th at indicates that the specified operator is respon sible for the even t. It resultsfrom the Assign To or the Take Own ership event op eration actions.

attributeA characteristic or prop erty of an object, such as a comm on-data-mod el service-mod el

comp onent class. An attribute ma y contain a value.

automationIn BMC Imp act Explorer, operator responses that ha ve been programm ed to occurautoma tically w hen an event is received.

BBAROC language

Basic Recorder of Objects in C. A stru ctured language u sed to create and mod ify class definitions.

A class definition is similar to a structure in the C program ming language. The elements in a

BAROC class are called slots.

base classIn program ming, a root superclass, a class from which all other classes of its type are d erived.

base priorityA static priority value that is combined w ith the comp onent's current status to d etermine the

final self-priority value. Typically, the base p riority determines the highest self-priority that acomponent will reach when its status become Unavailable.

blackout scheduleA schedule that d etermines when one or m ore comp onents w ill be automatically placed in a

blackou t state.

BMC Atrium CMD B Common D ata Model (BMC Atrium CMD B CDM)An extensible schema that p rovides a u nified representation of configuration items an d their

relationships to each other. It is used to store asset data (such as hard ware information, serviceman agement information, and people information) and to provid e a mechanism for linking that

information to p rovid e a comp lete view of how all assets are connected and can affect each

other.

BMC Atrium CMDB Reconciliation EngineThe BMC Atrium CMDB app lication u sed to m erge data from m ultiple sources, such astopology d iscovery an d configuration d iscovery, into a consistent da taset.





BMC Atrium Configuration Management Database (BMC Atrium CMDB)The database ap plication th at is the comm on d atastore for asset, configuration m anagement,

and service mod el data in BMC Business Service Managemen t products. It enables BMCprod ucts to share IT managem ent and m onitoring da ta and p erform service man agement.

BMC Desktop Status Ind icator (BMC DSI)An icon that ap pears in the desktop system tray of a comp uter to show the current status of an

object being monitored by BMC Imp act Portal. To view the statu s page of the monitored object,

you doub le-click the icon.

BMC Event Manager (BMC EM)A real-time event managem ent produ ct license package that provides event managem ent,

includ ing even t collection, correlation, enrichment, and integration. It enables IT operations

staff to focus th e proper resources on resolving the most critical events.

BMC EMSee BMC Event Mana ger (BMC EM).

BMC IDG

See BMC Imp act Database Gatew ay (BMC IDG).

BMC IEA

See BMC Impact Event A dapters (BMC IEA).

BMC IELASee BMC Imp act Event Log Ad ap ter for Wind ows (BMC IELA).

BMC Impact Database Gatew ay (BMC IDG)

The interface that enables BMC Imp act Manager even ts to be exported to a relational da tabase.

BMC Impact Event Adapters (BMC IEA)The adap ters that collect log file inform ation, conver t it to BMC Imp act events, and sen d the

events to designated BMC Impact Manager instances.

BMC Impact Event Log Adapter for Window s (BMC IELA)The native Wind ows p latform executable that au dits Window s event logs. It ru ns as a Window s

service and checks for new event log records.

BMC Impact Explorer (BMC IX)The console with w hich you can connect to BMC Imp act Manager instan ces, examine the even ts

stored in them , and perform event an d service management activities.

BMC Impact Explorer ServerObsolete term. See BMC Imp act Portal.



Glossary 525


BMC Impact Integration product (BMC II product)An interface that enables the synchronized flow of events and data between a BMC Imp act

Manager instance and another BMC Software prod uct or a specific third-party p rodu ct.

BMC Impact Manager (BMC IM)The BMC Impact prod uct that provides automated event and service impact managem ent. It

run s as a service on supp orted Window s platforms and as a daemon on UNIX platforms, and

can be d istributed throu ghou t the networked enterprise and connected in var ious topologies to

sup port IT goals.

BMC Impact Manager instanceAn installation of the BMC Imp act Manager produ ct on a h ost comp uter. Compare with cell.

BMC Impact Publi shing Server

The BMC Impact Portal service or daem on tha t obtains the service mod el from the BMC Atrium

CMDB and pu blishes (distribu tes) it to the d esignated service imp act management cell or cells.

BMC Impact PortalThe BMC Portal mod ule that you use to m onitor the status of business services and their

components.

BMC Impact ReportingThe BMC Imp act Solutions compon ent that you u se to create and view long-term reports.

BMC Impact Service Model EditorA grap hical editor that you use to d evelop, maintain, and extend the service mod el that is stored

in the BMC Atrium Configuration Managem ent Database (BMC Atrium CMDB).

BMC Impact Web Console (BMC IWC)Obsolete term. See BMC Imp act Portal.

BMC IWCObsolete term. See BMC Imp act Portal.

BMC IX

See BMC Im pact Explorer (BMC IX).

BMC IXSObsolete term. See BMC Por tal.

BMC Portal

A BMC product that consists of the BMC Portal Server (infrastru cture) and console mod ules,

each of which deliver specific Business Service Management (BSM) functionality. The BMCImpact Portal and BMC Performance Manager Por tal are exam ples of console mod ules.

BMC Reporting Foundation

The base comp onent on wh ich BMC Software rep orting systems and solutions are built.





BMC Service Impact Manager (BMC SIM)A real-time service impact managemen t prod uct license package that provides technologies for

both service imp act and event m anagemen t. BMC SIM iden tifies related ap plications and theun derlying systems and databases of any software or infrastructure compon ent and ties

systems-level monitoring to the supported business services, enabling IT personnel to respondqu ickly to problems th at threaten the d elivery of business services.

BMC SIMSee BMC Service Impact Man ager (BMC SIM).

BMC_System classIn the BMC Atrium CMDB Comm on Data Model, the p arent class for all system information . In

this class tree, classes representing comp uter system s, ma inframes, app lication systems, and

virtual systems ar e d efined.

buil t-in actionAn au tomated, pred efined action performed by a system.

business function

A grou p of business processes that m ake up a sp ecific function, such as customer su pp ort.

business objectsAn object defined in the BMC Impa ct Service Model Editor, pu blished to a BMC Impact

Manager instan ce, and mon itored in BMC Impact Portal. Business objects contribu te business

service data for use in status ind icators and reports.

business processA series of related bu siness activities tha t operate to achieve one or more business objectives in ameasu rable way. Typical business processes includ e receiving orders, marketing services,

delivering services, d istributing products, invoicing for services, and accounting for mon ey

received . A business process rarely operates in isolation. It dep end s on other bu siness processes,and other bu siness processes, in turn, rely on it. A business p rocess usua lly relies on several

business fun ctions for su pp ort, such as IT and Personn el.

business process decompositionThe identification and cataloging of the bu siness activities and IT resources that combine to

make up a bu siness pr ocess. The result of business decomposition is a business process model.

business serviceA service that is identifiable by business rep resentat ives and su pp orts explicit business

processes that h ave a clear link to the bu siness’s value chain. Most business services have an

easily iden tifiable senior bu siness representative, are composed of a num ber of specific

applications, and rely on the fun ctioning of infrastru cture services. For example, the provision

of all logistic componen ts un derpinn ing the sale of consum er good s is a business service. See

also service.



Glossary 527


Business Service Management (BSM)A d ynam ic method for connecting key bu siness services to the IT systems that m anage them .

BSM enables users to un derstand and pred ict h ow technology changes w ill affect their bu siness,and how changes in the bu siness affect the IT infrastructure.

Ccause event

In a sequen ce of events, the event that is iden tified as the cause of the other events. See also effect

event.

CDMSee BMC Atrium CMDB Comm on Data Mod el (BMC Atrium CMDB CDM).

cell

The event p rocessing engine that collects, processes, and stores events w ithin a BMC Imp actManager instan ce. Each cell uses th e information in its associated Knowledge Base to iden tify

the types of events to accept an d how to process and d istribute them.

child collectorA collector contained w ithin anoth er collector. See also event collector.

class1. A da ta storage element. In da tabase terms, it relates to a table in a d atabase or a form in th eRemedy AR System.

2. In BMC Imp act Manager , a BAROC-language da ta stru cture that d efines a typ e of object used

in BMC Imp act Manager . A BAROC class is mad e up of data fields, called slots, that define itsproperties.

3. In BMC Impact Portal: see object class.

CLI commandA comman d that is issued on the O S comm and line for autom ation or immed iate execution. For

a comp lete list of CLI command s, see BMC Impact Solutions: Administration. See also command

line inter face (CLI).

CloseThe event opera tion action tha t closes an event. If the event w as assigned to the cur rent u ser,

Close sets the status to Closed an d shows an Operator Closed entry in the op eration h istory.Otherw ise, Close sets the status to Closed and shows an Overr ide Closed entry in the operation

history.

Closed statusThe event status that resu lts from a Close event operation action.





CMDBSee BMC Atrium Configura tion Managem ent Database (BMC Atrium CMDB).

collector

See event collector.

collector rule

See event collector rule.

collector setSee event collector set.

command line interface (CLI)

A user interface in which you issue comm and s one at a time on a comman d line for au tomationor imm ediate execution . In BMC Imp act Manager , you u se the CLI in conjun ction w ith a

grap hical user interface (GUI) to operate the p rod uct.

componentA logical or ph ysical asset that is represented in the BMC Atriu m CMDB. There ar e two types of

assets represented in the BMC Atrium CMDB: non -service comp onen ts, such as desks and other

non -IT physical assets, and serv ice comp onen ts that participa te in the delivery of business

services. See also service component.

component instanceA nam ed compon ent that represents an actual IT resource. See also service component.

component poolA reference to all of the logical and ph ysical assets that pa rticipa te in the delivery of enterp rise

services and can be part of the service mod el. The comp onen t pool includ es both assets that arepar t of the service mod el and assets that are not. See also object and component .

component relationship

See service component relationship .

component typeIn the Service Model Ed itor, an icon w ith an ed itable temp late that rep resents a sp ecific comm on

data mod el comp onent class. A user can select a comp onent typ e and edit its temp late to createa new instance of the comp onen t class.

computed priority

See priority.

configuration management database (CMD B)See BMC Atrium Configura tion Managem ent Database (BMC Atrium CMDB).



Glossary 529


consoleOne of the follow ing commonly BMC Imp act Manager p rod uct GUIs: BMC Imp act Portal, BMC

Impact Explorer, BMC Imp act Repor ting Console, and Service Model Editor.

console local actionAn action taken from a console and that is executed on the console host compu ter.

consolidation nodeA BMC Imp act Manager instan ce that can receive and p rocess events originating from other

systems on the netw ork.

consumerIn a service mod el comp onent relationship, the compon ent that uses a service provided byanother component, the provider. See also provider .

core competency

Capabilities that collectively account for a ll business activities within a bu siness enterp rise, suchas planning and developing produ cts.

CORE_DATA classThe base class for all BMC Imp act Manager BAROC d ata classes. It is the paren t class for all

customized data classes.

CORE_EVENT classThe base class for all BMC Imp act Manager even t classes. It is the p aren t class for all custom izedevent classes.

Correlate phase

The event-processing p hase in w hich the Correlate rules are evaluated to d etermine wh etherany even ts have a cause-and -effect relationship. See also Correlate rule.

Correlate ruleAn event -processing rule that establishes the cause-and-effect relationship betw een two events.

Correlate rules represent a one-to-one relationship.

correlation

1. The process of identifying a cau se-and-effect relationship between tw o events from one ormore sou rces for the pu rpose of identifying a root cause.

2. The cause and effect relationship itself.

3. A typ e of policy.





Ddata class

A BAROC class that is a child of the base data class, CORE_DATA, and th at defines a type of data.

Users can create their own d ata classes.

datastoreA central place in which an aggregation of data is kept and maintained in an organ ized w ay.

Decline OwnershipThe event operation action tha t indicates that the assigned op erator d oes not accept

responsibility for an even t. Decline Ownersh ip clears the ow ner’s name, sets the status back to

Acknowledged, and shows a Declined entry in the op eration h istory.

default status view type

In the BMC Imp act Portal, one of the view types ava ilable from the Status tab.

Delete phase

The event-processing ph ase in wh ich Delete rules are evaluated and actions are taken to ensur e

that d ata integrity is maintained w hen an event is deleted from th e event repository du ring thecleanup process.

Delete rule

An event-processing ru le that is used to clean u p obsolete information w hen an event is deletedfrom the rep ository. Delete ru les are evaluated w hen an event is deleted an d they take actions to

ensure th at data integrity is maintained.

destinationOne end of a relationship. In the case of an imp act relationsh ip, it is the end associated w ith the

consu mer of events.

draft service modelA w orking version of the service mod el that can contain both pu blished and un pu blished

elements.

duplicate eventA su bsequent occurr ence of an event th at has already been received, such as the second or later

notification that a comp onent is dow n. An event that has matching values for all the slots

defined with the dup_detect=yes facet in the even t class definition. You can use Regulate ru lesto detect and count du plicate events. See also facet.

During Schedule

Time p eriods in w hich a compon ent has a higher service dema nd and higher importance than inthe off-schedu le time per iod. In a During Sched ule time per iod, the compon ent is typically

assigned a higher pr iority value and dow ntime cost than d uring an off-schedule time period.



Glossary 531


For example, if a high service demand occur s dur ing 9:00 AM an d 5:00 PM, you can create aDuring Sched ule timeframe for that time period. See also off-sched u le time and Exceptions

Within During Schedule.

During Schedule costThe outage cost (per second) related to th e comp onent w hen the ou tage occurs within the

During Sched ule timeframe.

dynamic collectorA special type of collector that, in respon se to events, can ad d or rem ove event collectors from

the cell du ring ru ntime.

dynamic dataContextua l reference data th at is stored in a table in the even t repository (mcdb) and that is

up dated du ring run time if the context has changed . Administrators can use and m anipu late

dynam ic data in the BMC Impact Explorer Administration View.

EECF

See Event Cond ition Formula (ECF).

effect eventIn a sequ ence of events, the even t that is identified as an effect of a cause even t. See also causeevent.

elected event

See impact event.

encryption keyThe seed encryp tion key. If the d estination product has a key value, all clients must encrypt

their comm un ications u sing the same key va lue.

enrichment1. The process of ad d ing to or mod ifying the original event d ata to enhance it for prob lem

man agemen t, service managem ent, correlation, autom ation, notification, or reporting fun ctions.


escalation

1. The process of referring a problem u p the chain of comm and .






escalation procedureThe par ticular step s defined for performing escalation. For examp le, you m ight specify that

operations personn el would be notified within 5 minu tes of a problem occur rence, a man agerwould learn of it after 15 minu tes, and a director after 1 hour (if the prob lem still exists).

eventIn a BMC Imp act environm ent, a structured message passed to and from cells. Each event is an

instance of an event class.

Event Adapters

See BMC Impact Event A dapters (BMC IEA).

event class1. A BAROC class tha t is a child of the base event class, CORE_EVENT, and that d efines a type of

event.

2. A category of events th at you can create as a child of the base even t class, CORE_EVENT,according to how you wan t the events to be handled by an event man ager and w hat actions you

wan t to be taken w hen the event occurs. Event classes may be inherited from p arent objects,

depen ding on the specific product. Event classes are inherited from p aren t objects in BMCImpact Manager.

event collectorAn even t grou ping whose content is defined by its collector ru le. Event collectors are d isplayed

in the BMC Imp act Explorer and ar e defined in the BMC Impact Manager Know ledge Base. See

also event collector rule.

event collector ruleA typ e of rule in the Knowledge Base that d efines how events from a cell are organized an d

presented in th e BMC Impact Explorer. Collector rules are wr itten in Master Rule Langu age

(MRL).

event collector setA grou p of event collectors, organ ized in a paren t-child hierarchy , that resu lts from p rogressive

filtering of the incoming even ts tha t ma tch the top -level (pa rent event collector) criteria. Acollector set organizes the even ts for disp lay in the BMC Imp act Explorer.

Event Condition Formula (ECF)

The section of an MRL ru le definition that sp ecifies the conditions tha t an incoming ev ent mustmeet to trigger evaluation of the ru le du ring p rocessing. For examp le: APP_MISSING_PROCESSES

where [hostname: == ‘red1’,sub_origin: contains ‘System’] is an ECF. See Master

Rule Langu age (MRL).

event datastoreAn archive of generated event d ata.



Glossary 533


event groupA grouping of collectors that d epicts the relationship of events throu gh the hierarchy of the

nav igation tree. Each level of the collector set is show n as a nod e under the event group . Theparent level of an even t grou p r epresents all of the even ts associated w ith the collectors. An

event list is associated w ith the lowest level nodes of an event grou p. The pa rent level of anevent group is associated with an image view.

event list1. A tabu lar listing of events.

2. In BMC Imp act Explorer , you can access the even t list from the Events tab.

Event Log Adapter for Window sSee BMC Imp act Event Log Ad ap ter for Wind ows (BMC IELA).

event management

The collection and correlation of events across an en terp rise to enable IT operations to focus th eproper resources on the most critical events.

event management policyOne of several generic ru le types that p erform actions against even ts that meet selection criteria

specified in an associated event selector. Unlike manua lly written ru les, event p olicies are

defined interactively using the Event Man agement Policy Editor in the BMC Imp act Explorer.

See also user-defined policy.

event operation history

The tabular d isplay of the operation actions taken against an even t in BMC Imp act Explorer.

You can access the event operation h istory from the Operations History tab of the Event D etails pane on the Events tab in BMC Imp act Explorer.

event operations

Comman ds issued by operators to respond to events and correct the problems that the eventsrepresent. Operators p erform these comm and s from an event list in BMC Imp act Explorer.

event processorSee cell.

event propagationThe act of forw ard ing events and maintaining their synchronization am ong m ultiple BMC

Impact Manager instances (cells).

event repository1. An a rchive of generated event d ata.

2. In BMC Impact Man ager instan ces (cells), the storage facility (mcdb) in which event

information is stored.





event selection criteriaThe syntax of an event selector that sp ecifies the conditions that an incoming event m ust m eet to

trigger selection of the event for rule evaluation d ur ing each ph ase of event p rocessing. You canspecify even t selection criteria throu gh the BMC Impa ct Explorer GUI. An MRL Event

Cond ition Form ula (ECF) also contains event selection criteria. An event selector contains one ormore event selection criteria.

event sele ctorThe filtering mechan ism associated w ith an event managemen t policy that selects the events

against w hich the event man agement policy performs actions. An event selector contains one or

more event selection criteria. Event selectors are defined interactively by u sing the BMC Impact

Explorer. An event man agement policy can use one or m ore event selectors.

event sourceThe mon itored IT resource from which source event data is collected, such as an operating

system or ap plication log file.

event timeoutAn even t timeout p olicy chan ges an event statu s to closed after a specified p eriod of time

elapses.

Events ViewThe BMC Imp act Explorer user interface for viewing an d man ipulating event d ata. See alsoServices View an d Adm inistration View.

Exceptions Within During ScheduleTime period s in a service sched ule that are exceptions to the Du ring Sched ule timeframe, and in

wh ich a component h as a lower service deman d an d lower imp ortance than in the During

Schedu le time period . For example, if you have a Du ring Sched u le timefram e of 9:00 AM to 5:00PM, you can specify the p eriod betw een 12:00 PM and 1:00 PM as an Exception Within Du ring

Schedu le timeframe. The time betw een 12:00 and 1:00 is treated as Off sched u le time, and a

lower p riority is associated with th e component in that time. See also During Schedu le and off-schedu le time.

Exceptions Within During Schedule cost

The outage cost (per second ) related to the compon ent w hen th e outage occurs w ithin th eExceptions Within During Sched ule timeframe.

Execute phase

The event-processing ph ase in wh ich Execute ru les are evalua ted, and , if cond itions are met,specified actions are performed.

Execute ruleAn event-processing rule that performs actions w hen an attribute (slot) value changes in the

event repository. Execute ru les are evaluated du ring the Execute p hase of event p rocessing.

Often, the resulting actions are intern al actions, but you can u se the execute primitive in a rule

to call an externa l executable.



Glossary 535


expressionA combination of operator s, operand s (constan ts, variables, functions, and p rimitives), and

cond itions that r epresents a value or a relationship betw een values.

Ffacet

A sp ecific attribute of a BAROC class slot (field) that either controls the v alues th at th e slot can

have or controls aspects of a class instan ce's processing.

fieldSee attribute.

Filter phaseThe event-processing ph ase in w hich Filter r ules are evaluated to d etermine w hich events need

add itional processing or are un needed and can be discarded.

Filter ruleAn event-processing ru le that d etermines wh ether a sp ecific type of event shou ld be p assed as it

is, subjected to furth er processing, or discard ed d uring the Filter phase.

function

Code that executes an op eration in a cell and return s a value. A function can be used as an

expression w ithin a ru le or a p olicy and in alias formulas. See also primitive.

Ggateway

See BMC Imp act Integration product (BMC II product).

gateway.export fileA special file that controls the p rop agation and syn chronization of events to a BMC Imp actManager Integration p rod uct. The file is in the $MCELL_HOME/etc/ directory on UNIX

platforms and in the %MCELL_HOME\ etc\ directory on Wind ows p latforms.

global record

A sp ecial BAROC class instance that d efines a p ersistent global variable. When a cell starts, itcreates one instan ce of each global record d efined in the Knowled ge Base and restores any

existing values. Global record d efinitions are stored in the record subd irectory of the cellKnowled ge Base. You can get and set global record values in MRL rules or by u sing the BMC

Impact Manager CLI mgetrec an d msetrec commands.

global slot orderIn BMC Imp act Explorer, a set of slots (attributes), in a p articular ord er, that is associated with a

filter and is shared amon g users.





global timeframeA timeframe that is created in the Service Mod el Editor an d stored in the BMC Atrium CMDB.

A global timefram e is usable from within the BMC Imp act Service Model Editor and the BMCImp act Explorer an d is available to all cells within an env ironm ent. See also local timeframe.

groupA logical or an arbitrary collection of user-defined objects that may or may not have measurable

relationships and m ay or may not have summ ary data associated w ith them.

Hheartbeat

1. A per iodic message sent betw een comm un icating objects to inform each object that the other

is still active and accessible.

2. In BMC Imp act Manager, a dynam ic data object sent by a cell to monitor oth er cells to verifythat th ey remain active and accessible.

heartbeat intervalThe time between h eartbeats; the period of the heartbeat.

highest value function

A calculation m ethod that is used to d etermine impacts priority

Iimage viewA grap hical and hierarchical d isplay that depicts a business view. You can create image view

objects or elemen ts to represent managed systems (tools), geograph ic locations, operator s, time,

severity levels, categories, and so forth.

impactAn assessed m easure of the effect that an incident, fault, or other chan ge will or may have on

business operations or service levels.

impact event

An even t wh ose status is used in comp uting the statu s of its associated service comp onen t. Bydefault, the status of each event associated w ith a service comp onen t is used to comp ute its

status. How ever, you can exclude events.

impact production datasetInstances of an env ironm ent that are effectively published to the environm ent’s imp act

manager s. The following examp le is an imp act dataset:

BMC.IMPACT.PROD: the imp act prod uction d ataset associated with the BMC Impact Service

Model Editor



Glossary 537


impact propagationThe effect of an imp act to a providing serv ice compon ent (prov ider) on the service comp onen ts

that u se its services (consum ers) as defined by an imp act relationship. See also impactrelationship.

impact relationshipA relationship betw een tw o service components in a service infrastructure in w hich a consum er

comp onent d epend s on a p rovider component to d eliver some need ed resource to it. A change

in status of the p rovider affects (has an imp act on) the status of the consum er componen t.

impacted stateThe object state that ind icates that an object’s functioning is impaired .

impacts priority

The priority of a comp onen t based on the self-pr iorities of componen ts that this comp onen t

impacts. So that th e remed iation p rocess can be aligned with bu siness needs, the compu tedpriority for each causal comp onent is based u pon impacts priority.

The value is the result of the combined pr iorities of all the other comp onen ts that are imp acted

wh en the comp onent goes d own . The value is d ynam ic and changes as the self-priorities of theimpacted components change.

import datasetA da taset that contains objects imp orted to the BMC Atrium CMDB from an external data

source such as BMC Topology Discovery.

inactive relationshipA relationship betw een tw o components in a service infrastructure in wh ich there is no impactto the consumer component. An inactive relationship indicates that the tw o compon ents are

connected logically and are repr esented v isually as “linked .” See also impact relationship.

in-modelQualifies a service compon ent as being p art of a service model. By defau lt, new comp onents in

the BMC Atrium CMDB do n ot belong to any service mod el. To chan ge a compon ent to in-

mod el, you will typically use th e BMC Imp act Service Model Editor. Impact relationsh ips getautoma tically set to in-model wh en their related compon ents are in-model. Only those that are

in-mod el can be pu blished to a prod uction cell.

included timeframesA set of timeframes that are includ ed in the service sched ule.

indexA value tha t is used by an MRL rule to sort the slot information for an even t or da ta object.

informational alert

An alert of relatively low importan ce, such as a message abou t a rou tine state chan ge. See alsoseverity.





infrastructure elementAn ad dressable object that can be m onitored, such as a m anaged system in PATROL.

instance

1. A sp ecific object with sp ecific attributes or characteristics tha t d istingu ish it from oth er items(members) of its class or typ e.

2. In BMC Imp act Manager , an object that has sp ecific attribute values and that w as created

using a class d efinition.

integration product

See BMC Imp act Integration product (BMC II pr oduct).

interface classA BAROC class that defines the pr ogram ming interface used by an MRL rule pr imitive, such as

get_external, to retu rn d ata from an extern al program. At cell startup , an interface class is

loaded into mem ory. The cell invokes the executable defined in an argu men t of the p rimitive.The executable’s value is retu rned by the interface.

internal base classA BAROC internal class that d efines the requ ired stru cture for the base class from w hich a

grou p of BMC Imp act Manager classes is derived .

internal eventAn even t that is created by the cell du ring event p rocessing. An intern al event is processed inthe same way as an incoming event. All internal events are p rocessed before any new, incoming

external events are processed.

Internet Protocol (IP) adapterAn ad ap ter that collects and tran slates events from a Telnet, UDP, or TCP data sou rce.

IP adapter

See Internet Protocol (IP) adap ter.

IT component

See BMC_System class.

Kkey slot

A slot whose value is comp ared du ring searches.

Knowledge Base (KB)A collection of information that forms th e intelligence of a BMC Imp act Manager instance and

enables it to process events and perform service imp act managemen t activities. This inform ation

includ es event class definitions, service comp onen t definitions, record d efinitions, interfacedefinitions, collector d efinitions, da ta associations, and processing ru les.



Glossary 539


Llocal action

An executable that you can ru n d irectly from th e BMC Imp act Manager . Local actions are

wr itten in XML and are stored in the OS-specific subd irectory of the bin directory of the BMCImpact Manager cell Know ledge Base.

local timeframeA timefram e that is created in the BMC Impact Explorer. A local timeframe is stored in a single

cell and is available to the event m anagemen t policies within the cell. See also global timeframe.

logical componentA non -physical object that r epresents someth ing that d oes not exist physically in the IT

infrastructure su ch as a service, geograph y, organization, or u ser group .

Mmacro

An executable used in .map files to manip ulate the fields used for event translation.

manifest.kbA central locator file that sp ecifies the locations of the d irectories that m ake u p a Know ledge

Base. The manifest.kb file is used by the compiler to load the Know ledge Base sources files for

compilation.

mapSee image view.

masking

The process of combining an overlay dataset w ith a standar d dataset to obtain a view in w hich

the standar d dataset objects are overlaid or m asked by an y mod ified copy contained in theoverlay dataset.

Master Rule Language (MRL)

A compact, declarative langu age used to define rules and collectors for processing andorgan izing events in BMC Imp act Manager. Uncompiled ru le and collector source files have a

.mrl file extension .

mccompThe BMC Imp act Manager rules compiler. Rules are written in the Master Rule Language

(MRL). The p latform-indep end ent compiler converts them to byte code that the cell can read

and process.

mcdb

See event rep ository.





mcell.conf fi leThe configuration file that contains configurat ion options for a BMC Imp act Manager instan ce

(cell). It is in the $MCELL_HOME/etc/ directory on UN IX platforms an d in the

%MCELL_HOME%\ etc\ directory on supp orted Window s platforms.

mcell.dir fileThe file that lists the cells to w hich a BMC Imp act Solutions p rod uct or compon ent can conn ect

and commun icate. The informat ion in each cell includes its nam e, its encryption key, and its

host nam e and port n um ber. This file is in the $MCELL_HOME/etc/ d irectory on UN IX platform s

and in the %MCELL_HOME%\ etc\ directory on supp orted Window s platforms.

mcell.modify fileThe file that lists the slots that affect the mc_modification_date slot. When a specified slot is

modified , the time stam p of the mod ification is reset in the mc_modification_date slot, so thatslot is listed in mcell.modify .

mcell .propagate file

The configura tion file that sp ecifies the slot values that ar e synchron ized d uring eventpropa gation betw een BMC Imp act Manager insta nces (cells). It is in the $MCELL_HOME/etc/

directory on UN IX platforms an d in th e %MCELL_HO ME%\ etc\ directory on supp orted

Windows platforms.

mcell .trace fileThe configu ration file that specifies the trace information abou t a BMC Imp act Manager (cell)

that shou ld be recorded and the location to w hich it is wr itten. It is in $MCELL_HOME/etc/

directory on UN IX platforms an d in th e %MCELL_HO ME%\ etc\ directory on supp orted

Window s platforms.

mclient.conf fileThe configu ration file that specifies the configu rations for the BMC Impact Manager CLI

comm and s. It is in th e $MCELL_HOME/etc/ directory on UN IX platforms an d in the

%MCELL_HOME%\ etc\ directory on supp orted Window s platforms.

mclient.trace fileThe configu ration file that specifies the trace information th at shou ld be collected for the BMC

Imp act Manager CLI comm and s and the location to wh ich it should be wr itten. This file is in the

$MCELL_HOME/etc/ directory on UNIX platforms an d in the %MCELL_HO ME%\ etc\ directory

on sup ported Windows platforms.

mcontrol commandThe CLI command that send s control comm and s to a BMC Imp act Manager instan ce (cell).

mc_udidSee un iversal d ata identifier (mc_ud id).



Glossary 541


mean time between failures (MTBF)The average elapsed time from th e point at w hich an IT service object is mad e available un til the

next occurren ce of failure in the same service object.

mean time between system/service incidents (MTBSI)The average elapsed time between the occur rence of a system or serv ice failure and the next

failure in the same system or service.

mean time to repair (MTTR)The average elapsed time from the occurren ce of an incident to restoration of the service.

metaclassSee interna l base class.

MetaCollectorA virtual collector that contains a grou p of event collectors from mu ltiple BMC Imp act Manager

instances. It exists only in the BMC Imp act Explorer . You can custom ize it to suit you rorganizational n eeds.

moduleA produ ct that p lugs into the BMC Portal.

MTBF

See mean time betw een failures (MTBF).

MTBSISee mean time between system/ service incidents (MTBSI).

MTTR

See mean time to rep air (MTTR).

Nnavigation tree

See navigation tree view.

navigation tree v iew1. A hierarchical d isplay of the objects and user -defined grou ps and v iews.

2. In BMC Imp act Explorer, a h ierarchical view of d efined objects and grou ps. An object can be afilter, rule, or event. The group s are arranged to show relationship an d d epend ency between the

man aged systems. The navigation tree view ap pears in the left pane.

3. In the BMC Portal, a hierarchical disp lay of grou ps defined in a view.





New phaseThe event-processing ph ase in wh ich N ew rules are evaluated to determine w hich events in the

repository shou ld be upd ated w ith new information from new incoming events.

New ruleAn event p rocessing ru le that is evaluated d uring th e New event processing phase, and can

up date events stored in the repository (mcdb) with fresh information from new incoming

events.

nodeA BMC Imp act Manager instance that can receive only events originating on th e local host

system.

non-local action

A u ser-initiated action that d oes not execute on the u ser console host comp uter.

non-service componentA logical or ph ysical asset defined in the BMC Atriu m CMDB that d oes not p articipate in th e

delivery of bu siness services, such as a d esk or oth er non -IT physical asset. A non-service

componen t is not visible within the BMC Imp act Service Model Ed itor.

normalizationThe process of homogenizing event d ata into a comm on event format so that a standard set of

event d ata is collected an d reported regardless of the event source.

not-in-model

A service comp onen t that exists as a logical or physical asset in th e BMC Atriu m CMDB bu t is

not cur rently part of the service mod el. A not-in-mod el service componen t is visible within th eBMC Imp act Service Model Editor component p ool.

notification

1. A message, either d etailed or concise, that contains information about a cond ition thattriggered an alert state on a monitored element. An email message or SNMP tr ap th at is sent

wh en the pr ogram d etects a problem that triggers an alert.


null relationship

See inactive relationship .



Glossary 543


Oobject

1. An item that can be inserted into a d ashboard. For examp le, a chart, link, or Active-X control.

2. A generic term for anyth ing that is displayed in the user interface.

See class.

object classIn BMC Impact Solutions, a d ata structu re th at d efines a type of object. An ob ject class can be a

BAROC-langu age data stru cture in a BMC Imp act Manager cell Knowledge Base or a Comm on

Data Mod el (CDM) data structu re in the BMC Configurat ion Managemen t Database. A class is

mad e up of data fields, called attr ibutes (slots) that define its proper ties. See also event class and

object.

object linkingIn BMC Porta l, the ability to associate two objects that ar e the sam e IT asset or resou rce but that

occur in different console mod ules, and m anage th em as one object.

off-schedule timeTime p eriods in wh ich th e comp onent has a lower service dem and , a lower p riority, and lower

dow ntime cost than in the Du ring Schedule time periods. Off-schedule time includes an y time

that is not defined in the service sched ule. Exceptions Within Du ring Schedu le time per iods aretreated as off-schedu le time w hen determining base p riority. See also service schedu le,

Exceptions Within Dur ing Schedu le, and During Schedu le.

open eventAn event that m ay require action. An open event m ay have a status of Open, Acknow ledged,

Assigned, or Blackou t.

Open statusThe event status that ind icates that the event h as not been examined, or th at neither an operator

nor an autom ated p rocess has been assigned respon sibility for the event.

Pparent event collector

A even t collector that conta ins child collectors to form an event collector set.

permissionA ru le associated w ith an object to control wh ich u sers, group s, and roles can access the object

and in what m ann er. A perm ission gives the u ser a specific type of access to the object (for

example, read p ermission or wr ite permission). See right.

phase, ruleSee rule phase.





policySee event man agement p olicy.

policy class

A BAROC class that is a child o f the base d ata class POLICY and that d efines a type of policy.

policy instanceA specific imp lementation of any of the types of event managemen t policies. For examp le, you

could have an instance of a blackou t policy that defined blackou t period s for holidays and

another instance of the same policy that d efined blackout p eriods for monthly m aintenance.

portA nu mber th at designates a specific comm un ication channel in TCP/ IP networking. Ports areidentified by n um bers. BMC Imp act Manager commu nicates using the p orts specified du ring

installation.

portalThe access point for web-based m anagemen t tools. The porta l houses app lications installed by a

user and comm un icates with remotely monitored systems. See also BMC Por tal.

presentation nameA descriptive name or label that you can d esignate to app ear instead of a specific interna l slot

nam e or class nam e in the user interface screens. You define presentation nam es in resource

files.

primitive

Similar to a function, code th at executes an operation in a cell and retu rns a value; can be u sed as

an instruction, or as a function if contained in a Boolean expression.

priorityAn attr ibute ind icating the p recedence or scale of imp ortan ce of an event.

priority propagatorA compon ent that is configured to prop agate its priority to its causal comp onents.

production cel l

A BMC EM or BMC SIM cell that service opera tors and service manager s use to m onitor theevents an d services associated w ith IT resources in real time.

production viewA read -only view in the BMC Imp act Service Model Editor that d isplays some of the

comp onents and relationships contained in the prod uction d ataset (the visibility can be

constrained by user permissions). Each BMC Imp act Service Model Editor user can h ave several

of these views. BMC Imp act Service Model Editor u sers can d ynam ically convert a prod uctionview into a sand box View. See also sandbox and sand box View.



Glossary 545


promotionA u ser-initiated action in BMC Impact Service Model Ed itor tha t assists in reconciling objects

(such as compon ents, relationships, and man agement d ata) from a sand box dataset to theproduction dataset.

Propagate phaseThe event-processing ru le phase in wh ich Prop agate rules are evaluated to d etermine the events

to be forward ed to another cell or to a BMC Imp act Integration prod uct.

propagate policyA type of policy that forwards events to other cells in the m anaged dom ain. A prop agate policy

is evaluated d uring th e Propagate p hase of event p rocessing.

propagate priority

When a comp onen t forw ard s its self-pr iority to its causal comp onents.

Propagate ruleAn event-processing ru le that is used to forw ard events to other cells in the man aged d omain.

Propagate ru les are evaluated du ring the Propagate ph ase of event processing.

propagated eventAn event that is forward ed from one cell to another cell or to a BMC Imp act Integration prod uct

du ring the Propagate ph ase of event processing.

providerA logical or ph ysical asset that delivers services or prov ides resources that are used by other

service component s in the d elivery of business services.

publish environmentAn environm ent that consists of a produ ction dataset, an impact prod uction d ataset, and one or

more test or p rodu ction cells that ar e pu blished.

published-modified componentA service componen t that h as been m odified since its service model w as p ublished (distributed )

to BMC Imp act Manager in stances.

published componentA service component that is currently part of the pu blished service mod el that has been

distributed to BMC Impact Manager instances.

publishingThe autom ated or u ser-initiated action perform ed by the BMC Impact Publishing Server in

wh ich componen ts, relationships, and m anagement d ata from the p rod uction dataset are

pu blished to one or several produ ction or test cells.

publishing serverSee BMC Imp act Publishing Server.





published service modelA service mod el that is cu rren tly distributed to BMC Imp act Manager instances (cells). It

contains only p ublished elements.

RReconciliation Engine

See BMC Atrium CMDB Reconciliation Engine.

record

See global record .

recurrence1. The characteristic of occur ring m ore th an once.

2. The type of policy that h and les recurr ent events. See also recurrent event.

recurrent eventAn event that occurs m ore than one time. Both scheduled an d u nscheduled events can be

recurrent events: a monitored hard ware device could experience multiple voltage spikes within

a single polling cycle, and a reminder notification could be sched u led to be sent p eriodicallyun til acknowledgm ent is received. See also du plicate event.

Refine phase

The first phase of event processing, in w hich Refine rules are evaluated to validate incoming

events and , if necessary, collect add itional da ta need ed before furth er event p rocessing canoccur.

Refine ruleA ru le evaluated d uring th e first ph ase of event processing to validate an incoming event and , if

necessary, to collect any add itional data need ed before furth er processing can occur.

regular express ionSometimes referred to as “regex,” regu lar expressions are used in pattern matching and

substitu tion operator s. A simp le regu lar expression is a sequence or pattern of characters that is

matched against a text string w hen p erforming search and replacement fun ctions.

Regulate phaseThe event-processing ph ase in wh ich Regulate ru les are evaluated an d, if tru e, collect du plicate

events for a time per iod and , if a specified th reshold of du plicates is reached , passes an event tothe next processing p hase.

Regulate rule

An even t-processing rule that p rocesses dup licate events or even ts that occur with a specifiedfrequen cy. With a Regulate rule, you can create a new event based on the d etection of repetitive

or frequent events. See also Regulate p hase.



Glossary 547


related eventThe event that w as generated by a source event. A related event can also be the source of other

related events.

relationA logical association tha t expresses the r elevance of one even t to another.

relation definitionThe BAROC da ta instance that d efines a relation.

remote action

A user-initiated action that does not execute on th e user console host comp uter; an executable

that can be ru n by a cell. Remote actions are w ritten in the Master Ru le Langu age (MRL) and a restored in the OS-specific subd irectory o f the bin directory of the Know ledge Base.

Reopen

The event opera tion action tha t reopens an event th at is in the Closed state. Reopen sets thestatus to Open an d sh ows a Reopen entry in the operation history.

repositorySee event rep ository.

restricted objectA dyn amically created object that contribu tes to service statu s, bu t wh ich the u ser does not have

perm ission to v iew.

rightAn au thorization entitling a user to p erform a certain action. Rights ap ply to a w hole

application o r to specific objects of a certain typ e.

root cause analysisThe process of mon itoring events and correlating event da ta to identify the true cause of a

problem.

ruleA conditional statemen t wr itten in MRL and that, if determined to be true, executes actions. Cell

event p rocessing occurs in ph ases with the cell comparing each event to the series of ru lesassociated w ith that p hase. Each p hase’s ru les are evalua ted on e by one before the event is

passed to the next phase. The ord er in wh ich ru les are evaluated du ring a particular phase is

based on the order in w hich the ru les were loaded.

rule engine

See cell.

rule phaseA specific stage of event processing. Event pr ocessing comprom ises a combination of sequentialph ases and non sequential ph ases, each w ith a correspond ing rule type.





rule typeThe designation that iden tifies a rule as being in a specific ph ase of event p rocessing. The cell

execu tes rules within th e context of the associated event-p rocessing p hase and in th e order inwh ich the ru les w ere loaded from the ru le file.

Ssandbox

An overlay d ataset associated with th e prod uction d ataset. The overlay d ataset provides a view

of the und erlying p rodu ction dataset masked by changes mad e by the user in the overlaydataset.

sandbox View

In the BMC Imp act Service Model Editor, a personal work area for designing and developing aservice model.

saved stateThe state of a BMC Imp act Manager instance (cell) as d etermined by the StateBu ilder u tility,

statbld.exe. The StateBu ilder u tility per iodically consolidates the da ta in th e tran sactions file

(xact) to prod uce the “saved state” of the p rodu ct instance. This information is stored in th e

event repository (mcdb) and th e state is reloaded w hen BMC Impact Manager r estarts.

schedule

See service schedu le.

SD KSee Software Developm ent Kit (SDK).

selector

See event selector.

selector classA BAROC class that is a child o f the base d ata class SELECTOR and that d efines a type of event

selector.

self-priority

The result of map ping th e base priority value for a component with its status value.

send to testA u ser-initiated action in the BMC Imp act Service Model Editor in which objects (such ascomp onents and relationships) are copied from a sand box View to a test d ataset. The copy

captures both sandbox objects and prod uction objects to rep rodu ce a consistent mod el or

subm odel in the test environment.



Glossary 549


serviceAn integrated comp osite of several comp onents, such as man agement p rocesses, hard ware,

software, facilities, and peop le, that d elivers something of value to satisfy a man agement needor objective.

service catalogA list of IT services that ident ifies the physical and logical assets that help provide a service. The

da ta collected in the service catalog can be used to form a configu ration m anagemen t data base.

service componentA logical or ph ysical resource that participa tes in the d elivery of services. A service comp onen t

is any class that is a su bclass of the BMC_BaseElemen t class in th e BMC Atr ium CMDB or the

cell Knowledge Base.

service component aliasA nam e that is assigned to a service comp onent instance and u sed in associating an event typewith th e comp onen t instance. You ad d an alias to a service comp onent instance’s definition in

the Service Mod el Ed itor. A service component instance can have several d ifferent aliases toenable different even t types to be associated w ith it.

service component relationshipIn a service mod el, the association of two service comp onen ts in wh ich one comp onen t, the

provider, d elivers some resource or service to the consum ing comp onent or components. See

also provider an d consumer.

Service Impact Management (SIM)A technique for managing the impact of IT events on the comp any’s core bu siness services to

ensure their delivery. See also BMC Service Impact Man ager (BMC SIM).

service modelAn extensible system for defining the var ious resour ces that combine to d eliver businessservices, for modeling their behaviors and functional relationships, and for managing the

delivery of the resu lting serv ices. In Service Imp act Managem ent, the m ap of how ITcompon ents relate to the business processes that they su pp ort. All IT events and service issues

are analyzed against the service mod el to determine the root cause of problems and to report on

service imp acts.

service scheduleA set of timeframes that includ es Dur ing Schedu le timefram es, Exceptions Within the During

Schedule timeframes, and the p riority values and dow ntime costs for a compon ent associatedwith each timeframe.

Services ViewThe BMC Imp act Explorer u ser interface for viewing service-mod el comp onen ts and their

relationships an d for viewing and manag ing the events tha t affect service availability.





Set PriorityThe event op eration action tha t escalates or d e-escalates an event. Set Priority sets the even ts

priority to the sp ecified values and show s a Pr iority Set entry in the op eration h istory.

severityAn ind ication of the seriousness of an event.

severity-to-status mapping tableOne of the tw o tables that relate event severity and service component status. It is used by the

cell to map the severity of an imp act event to a status value to be u sed in th e comp utation of the

associated service component's status. See also status-to-severity mapping table.

slotAn field in a BAROC class definition. A class definition consists of one or mor e slots. Each slot

has a d ata type and can have sp ecific attributes, called facets, that can control the values that the

slot can have or other aspects of a class instan ce’s p rocessing. A su bclass inher its all the slots of the p arent class. See also attribute.

slot facet

See facet.

SM

See service model.

SNMP adapterAn ad apter that listens at a port for SNMP traps. It evaluates the trap s and formats them based

on th e configured event map ping. If the event-mapp ing conditions are satisfied, it sends th e

event to the cell.

SN MP Adapter Configuration ManagerA compon ent of the BMC Imp act Event Ad apters that converts Man agement Information Base

(MIB) data into BMC Imp act Manager class data.

Software D evelopment Kit (SDK)A set of procedu res and tools with w hich you can develop a type of app lication.

source dataThe information that enters the BMC Imp act Manager system from an other entity and that w ill

be transformed into an event in the system.

source eventThe event that generates a related event.

statbld.conf file

The configuration file for the StateBuilder u tility. It is in th e $MCELL_HOME/etc/ directory on

UNIX platforms an d in the %MCELL_HOME%\ etc\ directory on supp orted Window s platforms.



Glossary 551


statbld.trace fileThe configuration file that specifies the tra ce inform ation to be collected for th e StateBuilder

utility and w here it should be w ritten. It is in the $MCELL_HOME/etc/ directory on UNIXplatforms and in the %MCELL_HOME%\ etc\ directory on supp orted Window s platforms.

state change eventA generated event type that records changes in a compon ent’s status. State change events never

participate in compon ent status compu tation.

StateBuilder utilityThe u tility, statbld.exe, that p eriodically consolidates the d ata in a cell’s tran sactions file (xact)

and writes the “saved state” of the cell to the rep ository (mcdb).

status

1. For events, an ind ication of the event’s managemen t. Possible values are Op en, Closed,

Acknowledged, Assigned, and Blackout.

2. For service compon ents, an ind ication of th e relative availability of an IT resource. Possible

values are OK, Unkn ow n, Blackou t, Information, Warn ing, Minor Imp act, Imp acted, and

Unavailable.

status-to-severity mapping tableThe status-to-severity map is used by the cell to map the main statu s of a comp onent to the

severity of a history event.

status computation model

A mod el that d etermines the status of a consum er service comp onent w hen a change in the

status of its prov ider service comp onen t occurs.

status propagationThe effect that a change in status of a provider component has on the status of its consum er

components.

STATUS_PROPAGATION tableA d ynam ic data table that defines the d ifferent p airs of service comp onent typ es wh ose

instances can h ave a relationship and the status pr opagation mod el to be used for each

relationship.

store and forwardA mechan ism that ensures that if an even t cannot reach its destination, it is saved in a file and

sent when a v iable connection to the destination becomes available.

stored eventAn event that has been processed by the cell and stored in its event rep ository. Only storedevents can be retu rned by qu eries and displayed in BMC Imp act Explorer, returned by the

mqu ery CLI comm and , or referenced by the Using and Upd ate clauses of an MRL rule.





superclassA hierarchically sup erior event or d ata class. A class that is derived from another class inh erits

pa rt of its attributes (slots) from its sup erclass.

suppression1. The intentional exclusion of an event or a typ e of event.

2. The type of policy that governs event supp ression.

syslog adapterAn ad ap ter that collects information from the log file generated by th e UNIX daemon syslogd.

The syslog adapter read s syslogd events and formats and sends them to the cell.

TTake Ow nership

The event operation action that assigns the curr ent u ser as the event’s own er, sets the event

status as Assigned, and shows an entry of Taken in the op eration history.

targetThe entity d esignated to receive events from an adap ter, an event generator, or a BMC Imp actManager instan ce. Also, a cell whose content curr ently is displayed in a BMC Imp act Explorer

d ialog box.

test cell

A cell, d istinct from a p rod uction cell, in wh ich to test an in-d evelopment service mod el. A testcell is either a BMC EM cell used to develop and test even t man agem ent d ata, rules, policies,

actions, and collectors, or a BMC SIM cell used to dev elop, test, and pu blish service mod els.

test datasetA d ataset tha t is used to relay objects from a sand box View to a test cell. Each BMC Imp act

Service Mod el Ed itor user h as a ded icated test dataset. A test da taset combines with a test cell to

make a user test environm ent. The following examp le is a test da taset:

BMC.IMPACT.Joe.TEST.1: the impact dataset contain ing instances that ar e effectively pu blished

to the imp act manager of Joe’s Test environ men t

threshold1. In BMC Imp act Manager, the point beyon d w hich the value of a facet, slot, or other a ttribu te

can trigger an alert.


Threshold ruleA ru le that executes if the nu mber of events exceeds the specified nu mber w ithin a particular

timeframe.



Glossary 553


TIME_FRAME classA BAROC class tha t is a child of the base d ata class TIME_FRAME and that defines a type of

timeframe.

TIME_ZONE classA BAROC class tha t is a child of the base d ata class TIME_ZONE and that d efines a type of time

zone.

timeframe1. User-defined blocks of time that can be ad ded to a service sched ule. Timeframes are add ed to

the service schedu le as During Sched ule timeframes or Exceptions Within Du ring Sched ule

timeframes. Any un assigned time is considered Off schedule. See also During Schedule,

Exceptions Within Dur ing Schedu le, and off-sched ule time.

2. The specification for the period dur ing which an event m anagemen t policy instance is in

effect.

Timer phaseThe event-processing phase in w hich Timer ru les for the delayed execut ion of anoth er ru le type

are evaluated. This phase sp ans th e N ew, Abstract, Correlate, and Execute p hases of eventprocessing.

Timer ruleAn event-processing ru le that triggers the d elayed execution of anoth er type of rule.

Timer trigger

See Timer rule.

treeSee navigation tree view.

Uunknown object

An object wh ose status cannot be d etermined because of a connectivity failur e.

universal data identifier (mc_udid)A un ique, system-genera ted va lue used to identify a specific service comp onen t instance. Each

service component mu st have a value for the mc_udid attribu te (slot). One use of the universal

da ta iden tifier is in associating aliases to a service componen t instance.

unpublished componentA service comp onent that is curr ently part of the service mod el but that h as not been p ublished

(distributed ) to BMC Imp act Manager instan ces.





user-defined policyA type of policy that a service manager or op erations manager can d efine to perform specialized

event p rocessing; not available through an y BMC Imp act Explorer bu ilt-in p olicy. See also eventman agement p olicy

Using clauseAn MRL rule clause that is used p rimarily to retrieve data instances for a dyn amic rule, but can

also be used to retrieve instances of past events.

VView

In the Service Model editor, the centralized area w here you begin to build and maintain a

service mod el. Each View is un ique to a u ser accoun t. Multiple users can have d ifferent Viewsinto the sam e service mod el. You can save Views for later reu se.

Wweighted function

A calculation m ethod that is used to d etermine impacts priority.

When clauseA part of MRL ru le syntax for Abstract, Correlate, Execute, Prop agate, and Timer ru les. Eventsmu st first meet the selection criteria in the ru le before the When clause is evalua ted. Chan ges to

slot values cause When clauses to be re-evaluated .

wildcardA typ e of pattern m atching tha t uses the asterisk character (*) to represent any nu mber of

different characters, and the qu estion m ark character (?) to represent a single un know n

character. See also regular expression.

workspace

See View .



Index 555


Index

Symbols$data v ariable 509, 511, 515

.jar files

d igitally signing 220

Aaction result event p arameters

ActionResultInlineLimit 444

ActionResultKeepPeriod 444

activating maximu m tracing for all mod ules 390

adapter engine 197

adap ter, event

described 238

adapters

BAROC classes 473

default configu ration file 196

default engines 197

Engine parameter specifies type 197

global parameters 197mcxa.conf 196

adding

slot flags and default values 395

slot nam es and representation types 394

administering remote cells

Ad ministration View (BIX) 80

Administration View

creating new data instance 253

edit menu 255

exporting data 256

man aging cells from 80

menu , context 253

metrics collection 87overview 242

Reload m enu 82

Slot Quick Filter 248

sort mu ltiple colum ns 251

sort, s ingle-click 252

administrator activities

mod ifying cell connection settings 136

AllowAdapterFrom 449

AllowBrowserFrom 449

AllowCellFrom 449

AllowCLIFrom 449

AllowConnectionFrom 449

AllowEIFFrom 450

application.properties configuration file 129

architecture

IP adap ters 490

assignm ents, map files, slots 478

BBAROC

classes, mcxa.baroc file 473

BAROC langua ge

described 238

Basic Recorder of Objects in C. See BAROC

BIX

defining p resentation nam e search ord er using

ix.properties file 217

extracting presentation name resource files 215

BIX tool tips

enabling an d d isabling for presentation n ames 221blackout policy (standard), creating 285

blackout p olicy, creating 286, 320

Blackout.cfg 272

BMC Event Manager solution

overview 237

BMC Impact Administration server

command line interface 91

configu ration files 91

customizing BMC IX colors 109

default mapp ing of roles and perm issions 98

defining client logging 108

defining grou p roles 95

defining high availability for Impact Administration

cell 112

defining permissions 98

defining primary an d secondary servers 109

defining stand alone servers 109

editing logging prop erties 108

high a vailability 109

iadmin command 91

iadm in command format 93

iadm in command options 92

iadmin reinit options 111

LDAP configu ration 115

manu al editing gu idelines 94

Master server 90, 109





BMC Impact Administration server (continued)

purpose 90

relation to BMC Impact Portal 90, 102

relation to Impact Administration cell 93

Standa rd server 90, 109

starting and stopp ing 91

sup porting remote actions for infrastructure

management 114

synchronization prop erties 110

synchronizing with BMC Atrium CMDB 105

synchronizing with BMC Impact Portal 102

transaction and trace logs 112

up dating cell information 106

up dating user information (file-based authen tication)

103

BMC Impact Event Ad apters

used in event collection 238

BMC Imp act Explorer

Administration View, overview 240

configu ration files, event grou p 152

console views 239

defining p resentation nam e search ord er using

ix.pr operties file 217

Event Group s, described 361

Events View, overview 239

overview 239

remote cell administration 80

role in event man agement 239

Services View, overview 240

BMC Impact Manager CLI

common options 383

configuration of 440

described 40

BMC Impact Manager p rodu ct

cell, described 36

overview 36

BMC Impact Portal

commun ication and encryption parameters 139

configuration p arameters 128

configuring the ixs.pr operties file 128

policy file 147

report g oal line configuration param eters 139

BMC Imp act Service Mod el Editor

role in service model d evelopment 241

BMC Porta lstarting from comm and line 127

starting from Services Window 127

starting on UNIX 127

stopping from comm and line 127

stopping on UNIX 127

URL add ress 128

URL add ress syntax 128

BMC Software, contacting 2

BMC_PORTAL_KIT_HOME environ men t variable 466,

467

buffering

mposter comm and 426

buffering (continued)

using mposter 426

Business Service Managem ent

role of BMC Event Manager solution 237

role of BMC Imp act Explorer 239

Ccell

Admin 185

defining high availability for Impact Administration

112

Impact Ad ministration 112, 185

cell con figu ration

creating files for sp ecific cells 46

files 69

mod ifying cell conn ection settings 136

cell fun ctionsSIM 37

Cell Info d ialog box (BIX) 87

cell nam es

conventions for 401

cell objects, retrieving 422, 437

cell parameters

CellDescription 444

CellOperationLevel 444

CellOperationRelax 444

ConnectionPortRange 445

ConnectionPortReuse 445

ProcessingLimitPercentage 445

ServerAllInterfaces 445ServerDirectoryName 445

ServerPort 445

SystemLogDirName 445

SystemTmpDirName 445

cell tracing par ameter s, list of 461

CellDescription 444

CellErrorEvents 455

CellEventEnable 455

CellMetricsEnabled 455

CellOperationLevel 444

CellOperationRelax 444

cells

administering remote cell (in BIX) 81creating new 401, 434

deleting 406

described 36

EM

functions of 36

extracting state files from 434

heartbeats 455

importing data into 272

naming, m crtcell comm and 401

obtaining statu s using mcstat 406

permissions required to start on UN IX 41

posting events 422



Index 557


cells (continued )

prod uction, described 37

reconfiguring 69, 401

recovering d ata 432

remote ad ministration 80

retrieving information 408

runn ing in foregroun d 387

sending events to 422, 437

SIM, functions of 36

starting 387

starting a specified cell 386

starting and stopp ing 40

starting and stopping on UNIX 40

starting and stopp ing on Wind ows 41

starting or stopping on Window s 41

starting with services 42

status 405

stopping w ith mkill 42, 417

stopping with services 42

test, described 37

view information 81

CellTickInterval 455

class information request 390

Class Mana ger console. See BMC Atrium CM DB Class

Manager console

classes

map file sections 476

map files 483

CLI, BMC Imp act Manager. See BMC Impa ct Manager CLI

client configuration for p assive connections 62

client parameters 455

ClientCleanupInterval 447

ClientPollTimeOut 447

ClientSendTimeOut 447

DateFormat 447

SynchronizedTimeOut 447

ClientCleanupInterval 447

ClientPollTimeOut 447

ClientSendTimeOut 447

closing an event 438

closure p olicy, creating 288

collectors 396

dynamic 365

static 364

com.bmc.sms.iwc.component.properties.generalProperties.properties file property 138

com.bmc.sms.iwc.domain.notification.impact.type

property 138

com.bmc.sms.iwc.domain.recentitem.

RecentItemsFolderIcon property 138

com.bmc.sms.iwc.event.table property 138

com.bmc.sms.iwc.event.table.maximumevents property

138

com.bmc.sms.iwc.event.table.minimumevents property

138

com.bmc.sms.iwc.status. 138

com.bmc.sms.iwc.status.table property 138

com.bmc.sms.iwc.status.table. existinggroup property 138

com.bmc.sms.iwc.status.table.causes property 138

com.bmc.sms.iwc.status.table.consumers property 138

com.bmc.sms.iwc.status.table.providers property 138

com.bmc.sms.iwc.ui.recentitems.maxsize property 137

Comm and Line Interface (CLI), BMC Imp act Manager

described 40

command options

mkill 417

mrmerge 436

commands

mccomp 385

mcell 41, 386

mcfgtrace 387, 389

mclassinfo 390

mcollinfo 396

mcontrol 398

mcrtcell 401

mcstat 405

mdelcell 406

mgetinfo 408

mgetrec 412

mkb 414

mkill 41, 42, 417

mlogchk 418

mpkill 420

mposter 422, 425

mquery 422, 437

mrecover 432

mrextract 434

mrmerge 436

msend 422, 437

msetmsg 437

msetrec 439

net start 42

net stop 42

reference 382

comm ents, configu ration file 198

common parameters 200

defined 199

definitions 199

commun ication and en cryption

AllowAdapterFrom 449

AllowBrowserFrom 449

AllowCellFrom 449AllowCLIFrom 449

AllowConnectionFrom 449

AllowEIFFrom 450

BMC Impact Portal configuration parameters 139

encryption behavior 65

ForceEncryption 65

mcell.conf settings 64

mcell.dir settings 65

mclient.conf settings 65

compiling

Knowledge Base 385





conditions

for map files 480

configu ration activities for adm inistrators

mod ifying cell connection settings 136

configu ration files

cell 69

cell-specific, creating 46

comments 198

definitions 198

ix.properties 150

ixs.properties 128

MAP file 473

mcell.conf 41, 44, 47

mcell.modify 63–64

mcell.propagate 59

mcell.trace 73

parameters 198

sections 198

StateBuilder configuration 225

structure 196

configuration p arameters

BMC Impact Portal configuration and encryption 139

HeartbeatEnabled 452

HeartbeatInterval 452

HeartbeatMissedCritical 452

HeartbeatMissedMinor 452

HeartbeatMissedWarning 452

configuring

BIX using the ix.properties file 150

BMC Impact Portal using ixs.properties 128

clients for passive connections 62

error tracing for BMC Impact Manager 387, 389

reloading cell configuration 69

setting cell-specific configurations u p 46

StateBuilder 225

TCP Server adapter 494

telnet adap ter 497

UDP Client ada pter 500

UDP Server adap ter 503

connecting

cells in a protected zon e 62

ConnectionPortRange 441, 445

ConnectionPortReuse 441, 445

consistency checks 418

consoledynamic data 252

exporting data 256

Slot Quick Filter 248

sort data fields 251

sort, s ingle-click 252

console_policy.prop 147

consumer relationship, described 241

control operations 398

conventions

for cell nam ing 401

correlation p olicy, creating 291

creating

a new cell 401

a new service with mcrtcell 404

another service 404

configu ration files

cell-specific 46

csv parser

description 507

customer sup port 3

Ddata

creating new instance 253

dynamic 252

exporting 256

importing 272

sorting 251Data instance menu 253

DATASTORE_HO ME environm ent va riable 466, 467

DateFormat 447

default adapters configuration file 196

DEFAULT map file sections 476, 483

defau lt, map files 474

DEFINE, map file d irective 486

definitions, configuration file 198

deleting

a cell 406, 407

events using mqu ery 432

diagnostics

TCP client adap ter 493TCP Server adapter 495

telnet adap ter 500

UDP Client ad apter 502

UDP Server ad apter 504

diagram

event man agement p rocess flow 242

service impact management process flow 242

digital test certificate 220

digitally signing .jar files 220

dynamic blackout policy, enabling 333

dyn amic collectors 365

dynamic data 252

model 453dyn amic data enrichment p olicies

blackout 333

creating new 321

dynamic enrichment policy, creating 336

EECF (event cond ition form ula) 267

edit menu 255

EM cell

functions of 36



Index 559


EM cell (continu ed )

production 37

test 37

enabling

persistent buffering 425

encryption

behavior 65

mcell.conf settings 64

mcell.dir settings 65

mclient.conf settings 65

encryption key 65

Engine parameter

adap ter type, specified by 197

enrichm ent policy, creating 294

environment variables

BMC_PORTAL_KIT_HOME 466, 467

DATASTORE_HOME 466, 467

for UNIX 467

for Wind ows 466

MCELL_HOME 466, 467

recreating on UNIX 467

recreating on Window s 466

error file

mcell.err 79

escalation policy, creating 297, 298

establishing inbou nd connection in protected environment

62

evalua tion order of policies 269

event

sources 238

event adapter

described 238

event collectors

described 360

event condition formula 267

event group

configuration files 152

event groups

described 360

granting access 371

event management

cell fun ctions 36

overview 237

po licies, described 260

process flow diagram 242event man agement p olicies

closure 288

correlation 291

enabling and disabling 320

escalation 297

notification 302

propagation 306

recurrence 308

standard blackout 285

suppression 311

threshold 313

timeout 317

event parameters

EventAutoClose 450

EventDBCleanupDurationLimit 450

EventDBCleanupInterval 450

EventDBCleanuponDateReception 450

EventDBCleanupPercentage 450

EventDBCleanupPreferClosed 451

EventDBKeepClosed 451

EventDBKeepNonClosed 451

EventDBNoCleanupClosed 451

EventDBNoCleanupNoCleanupNonClosed 451

EventDBSize 451

repository cleanu p 450

event p olicy

compiling 270

defined 261

evaluation order 269

types of 262

event processor (cell), described 36

event propaga tion

enabling 61

illustrated 61

event repository

cleanup parameters 450

described 40

event selectors

defined 266, 281

groups 266

EventAutoClose 450

EventDBCleanupDurationLimit 450

EventDBCleanupInterval 450

EventDBCleanupOnDateReception 450

EventDBCleanupPercentage 450

EventDBCleanupPreferClosed 451

EventDBKeepClosed 451

EventDBKeepNonClosed 451

EventDBNoCleanupClosed 451

EventDBNoCleanupNonClosed 451

EventDBSize 451

events

deleting using mqu ery 432

exporting to a flat file 231

merg ing objects 436

modifying 437

posting with mposter 422prop agating using a gateway 59

Events View (BIX) navigation trees 239

events, sorting 251

examples

mccomp 386

mcell 387

mcfgtrace 390

mclassinfo 393

mcollinfo 397

mcontrol 400

mcrtcell 404

mcstat 406





examples (continued )

mdelcell 407

mgetinfo config 410

mgetinfo connect 412

mgetinfo param 411

mgetinfo services 411

mgetrec comman d 413

mkb 416

mkill 418, 421

mlogchk 419

mquery 431, 432

mrecover 434

mrextract 435

mrmerge 436

msetmsg 438

msetrec 439

ExportConfigFileName 225

ExportDiscarded 225

exporting

event d ata from m cdb by StateBuilder 225

events to a flat file 231

exporting data 256

ExportTriggerArguments 225

ExportTriggerProgram 225

external d ata sources 270

Ffiles

application.properties 129

gateway.export 224, 231, 232ixs.properties 128

kb_core_resource.properties 214

kb_deprecated_resource.properties215

manifest.kb 385

mcdb state 224

mcell.conf 41, 47

mcell.dir 47–50, 383

mcell.err error 79

mcell.modify 63, 128

mcell.propagate 59

mcell.trace 73

mcfgtrace 387, 389

prop agation configuration 59statbld.conf 224, 231

statbld.exe 224

statbld.trace 224, 233

StateBuilder configuration 225

trace configuration 73

xact transaction 224

filters

using hidd en slots 147

fixed-width parser

description 509

ForceEncryption 65

foreground , runn ing cell in 387

functions

map files, slots 479

Ggateway 59

gateway configuration 226

gatew ay.export file 224, 231, 232

global parameters 200

adapters 197

list of 200

global records

obtain a value 412

setting a value 439

goal line (reports) configuration parameters 139

HHeartbeatEnabled p arameter 452

HeartbeatInterval p arameter 452

HeartbeatMissedCritical parameter 452

HeartbeatMissedMinor p arameter 452

HeartbeatMissedWarning p arameter 452

heartbea ts, cell 455

home directory, defining 145

Iicons

BMC Imp act Explorer configuration files for event

groups 152

image views

overview 128

image views, defined 363

importing data 272

infrastructure managem ent

Adm in cell 185

Adm inister subtabs 172

aud it log 179, 181, 184

default service mod el 156, 158

Details subtabs 169

editing infrastructure relationships 173GUI view 160, 166

high availability cells 177

icons 166

Impact Administration cell 185

Impact Ad ministration server 186

manu ally deleting compon ents 186

navigation tree 159, 168

permissions 157

registered comp onents 157, 180, 186

related compon ents 171

remote actions 164, 166, 177, 187

remote systems 161

roles 157



Index 561


infrastructure man agement (continu ed)

run states 187

specifying support files 183

sup port files 162, 182, 184

INIT 482

map file sections 476

section, map file 482

INPU T_VARIABLES, map file sections 475, 476

integration

described 238

IP adap ters

architecture 490

list of types 491

overview 489

TCP client adapter description 491

TCP Server adapter description 494

telnet adapter description 496

UDP Client adap ter description 500

UDP Server adap ter description 503

ix.prop erties file

defining p resentation n ame search ord er for BIX 217

entry format 216

prop erty descriptions 150

ixs.properties file

parameters 141

using to customize BMC Impact Portal 128

J jar files, d igitally sign ing 220

Java Web Start ap plicationextracting presentation name resource files 215

Kkb_core_resource.properties file

entry format 218

modifying 219

kb_deprecated_resource.properties file 215

KBDirName 455

KBDirName param eter 455

KBRecoveryDirName parameter 455

keyscreating and mod ifying presentation names 218

formats for presentation n ames 218

Knowledge Bases

compiling 385

components of 39

described 39

EM, comp onents of 39

KBDirName 455

parameters

KBRecovery 455

SIM. comp onen ts of 39

updating 414

LLocation.cfg 272

LogFile Adapter, parsing 505

Mman ifest.kb file 385

map files

Class structure 483

conditions 480

configu ration file 473

default 474

directives

DEFINE 486

REQUIRE 486

INIT 476

operators 481

personalized 474

REQUIRE directive 486

sections

CLASS 476

DEFAULT 476, 483

INIT 482

INPUT_VARIABLES 475, 476

slots

assignments 478

functions 479

structure 475

mccomp command 385

example 386

options 385

return codes 386

syntax 385

mcd b state file 224

affects on recovery p rocess 433

mcell comman d 41, 386

example 387

options 387

return codes 388

syntax 386

mcell.conf file

param eter rules 44

path su bstitution param eters 45specifying paths 45

mcell.dir file 383

configu ring clients for passive connections 62

description and u sage 47–50

examp le file 48

format of entries 47

keyword s for entries 48

rules app lied to entries 48

ways to update 49

mcell.err file 79

mcell.modify file 63, 63–64, 128





mcell.pr opagate file 59

default options 60

usage 59

mcell.trace file 73, 387, 389

MCELL_HOME environment variable 466, 467

mcfgtrace comman d 387, 389

example 390

options 389

parameters 389

syntax 389

mclassinfo command 390

add ing slot flags and default values 395

add ing slot names and rep resentation types 394

examples 393

obtaining a list of classes 393

obtaining a list of slot nam es 394

options 391

output 391

return codes 395

syntax 391

mcollinfo command 396

example 397

options 396

output 396

return codes 398

syntax 396

mcontrol comma nd 398

commands

mcontrol 399

examples 400

options 399

reconfiguring a cell 401

retrying pending propagations 400

syntax 398

terminating a cell 400

mcrtcell command 401

actions 402

creating a serv ice 404

creating another service 404

examples 404

options 403

return codes 405

syntax 403

mcstat comm and 405

example 406options 405

return codes 406

md elcell comman d 406

deleting a cell 407

example 407

options 407

return codes 408

syntax 407

menu , editing 255

menu, Reload 82

merging event objects 436

message buffer p arameters

MessageBufferKeepSent 457, 458

MessageBufferKeepWait 457, 458

MessageBufferReconnectIntervalparameters

MessageBufferReconnectInterval 457, 459

MessageBufferResendCount 457, 459

MessageBufferSize 456, 458, 459

MessageBufferKeepSent 457, 458

MessageBufferKeepWait 457, 458

MessageBufferReconnectInterval 457, 459

MessageBufferResendCount 457, 459

MessageBufferSize 456, 458, 459

MetaCollector, even t

described 361

metrics collection, tab for 87

mgetinfo comman d 408

config examp le 410

connect example 412

options 408

param example 411

return codes 412

services example 411

syntax 408

mgetrec comman d 412

example 413

options 413

return codes 414

syntax 413

mkb command 414

examples 416

options 414

return codes 417

syntax 414

mkill comm and 41, 42, 417

command options 417

examples 418, 421

options 418, 421

return codes 418, 422

syntax 417, 420

mlogchk comm and 418

examples 419

return codes 420

syntax 419

modifying

cell connection setting s 136monitoring p assive connections 63

mp kill comma nd 420

mposter command 422, 425

buffering 426

enabling persistent buffering 425

options 423

return codes 427

syntax 422, 423

mp oster processes

stopping 420

mquery command 422, 437

deleting events 432



Index 563


mquery command (continued)

examples 431, 432

options 428

output 428

return codes 432

selecting even ts with a severity level 431

syntax 427

mrecover comm and 432

example 434

options 433

return codes 434

syntax 433

mrextract comma nd 434

example 435

options 435

return codes 435

syntax 435

mrmerge command 436

command options 436

example 436

options 436

return codes 437

syntax 436

msend command 422, 437

msend processes

stopping 420

msetmsg comman d 437

closing an event 438

examples 438

options 437

return codes 438

syntax 437

msetrec comm and 439

example 439

options 439

return codes 440

syntax 439

Nname keys

creating and mod ifying 218

nam ing conventions

for cells 401new data instance, creating 253

notification policy, creating 302, 303

Oobjects

list of presentation n am es for 214

obtaining a global record value 412

obtaining a list of classes 393

obtaining a list of slot nam es 394

obtaining statu s of cell using m cstat 406

operators, map files 481

options

mccomp 385

mcell 387

mcfgtrace 389

mclassinfo command 391

mcollinfo 396

mcontrol 399

mcrtcell 403

mcstat 405

mdelcell 407

mgetinfo 408

mgetrec 413

mkb 414

mkill 418, 421

mposter 423

mquery 428

mrecover 433

mrextract 435

mrmerge 436

msetmsg 437

msetrec 439

output

mclassinfo 391

mcollinfo 396

mquery command 428

overview, IP ad apters 489

Pparameter types

common 199

global 199

specific 199

parameters

ActionResultInlineLimit 444

ActionResultKeepPeriod 444

BMC Imp act Portal configu ration 128

client 455

common

definitions of 199

configu ration file 198

definitions of common 199

destination Cell name 198HeartbeatEnabled 452

HeartbeatInveral 452

HeartbeatMissedCritical 452

HeartbeatMissedMinor 452

HeartbeatMissedWarning 452

KBRecovery 455

list of 200

mcfgtrace 389

Server 455

specific

Logfile, characteristics 205

Logfile, list of 205





param eters (continued )

specific (continu ed)

SNMP Trap , characteristics 209

SNMP Trap , list of 209

state 455

trace, list of 461

tracing, configu ring 77

parsers

csv parser 507

fixed-width parser 509

separator parser 514

passive connections 62

client configuration 62

monitoring 63

passwords

invalid, logging on to BMC Portal 126

pending progagations

retrying 400

permissions

considerations for root user 40

persistent bu ffering, mposter comman d 426

personalized map files 474

PMEP files 272

policies

Blackout 285, 320

Closure 288

compilation 270

Correlation 291

creating new d ynamic data enrichment 321

defined 261

dyn amic data enrichment blackout 333

Dynam ic Enrichm ent 336

enabling dyn amic data enrichment dyn amic data

enrichment policies

enabling ou t-of-the-box 332

enabling standard out-of-the-box 320

Enrichment 294

Escalation 297

evaluation order 269

new closure 288

new correlation 291

new escalation 297

new notification 302

new propagation 306

new recurrence 308new standard blackout 285

new suppression 311

new threshold 313

new timeout 317

Notification 302

Propagation 306

Recurrence 308

Suppression 311

Threshold 313

Timeout 317

po licy file

BMC Impact Portal 147

policy file (continued )

console_policy.prop 147

policy type, user-defined

creating p resentation n ames for 356

creating processing ru les for 357

creating, task overview 354

defining p olicy data class for 354

posting events to a cell 422

presentation names

about 214

creating a new resour ce file 216

creating and mod ifying name keys 218

default definitions 215

defining 218

defining for a n ew policy typ e 356

enabling an d d isabling BIX tool tips for 221

extracting resource files for BIX (Java Web Start) 215

files 217

key formats 218

list of objects w ith 214

resour ce file locations 214

resour ce file search ord er 217

ProcessingLimitPercentage 46, 445

product support 3

production cells

described 37

PropagateBufferSize 457, 459

PropagateConfigFileName 458

propagating

events using a gateway 59

propagation configuration file, mcell propagate 59

propagation parameters

PropagateBufferSize 457, 459

PropagateConfigFileName 458

propagation policy, creating 306

protected environm ents

client configuration for passive connections 62

monitoring p assive connections 63

protected zone, connecting cells in 62

provider relationship, described 241

Rreconfiguring

cell files for 69

cells with m control comman d 401

recreating environm ent variables

on UNIX 467

on Windows 466

recurrence policy, creating 308, 309

Reload menu (BIX)

Administration View (BIX) 82

remote cell administration (BIX), control cell 81

reports

BMC Impact Portal goal line configuration p aram eters

139



Index 565


REQUIRE directive, map files 486

REQUIRE, map file directive 486

resour ce files

creating 216

extracting for BIX (Java Web Star t) 215

locations o f 214

search ord er 217

retrieve objects from cell 422, 437

retrying pend ing progagations 400

return codes

mccomp 386

mcell 388

mclassinfo 395

mcollinfo 398

mcrtcell 405

mcstat 406

mdelcell 408

mgetinfo 412

mgetrec 414

mkb 417

mkill 418, 422

mlogchk 420

mposter 427

mquery 432

mrecover 434

mrextract 435

mrmerge 437

msetmsg 438

msetrec 440

statbld 225

root p ermissions

considerations 40

rule phases 269

RuleLoopDetect 455

Ssaved state 433

scripts

setup_env.bat 466

setup_env.csh 467

setup_env.sh 467

sections, configuration file 198

selectingevents w ith a severity level 431

separator parser

description 514

server parameters 455

CellErrorEvents 455

CellEventEnable 455

CellMetricstEnabled 455

CellTickInterval 455

ConnectionPortRange 441, 445

ConnectionPortReuse 441, 445

ProcessingLimitPercentage 46, 445

RuleLoopDetect 455

server parameters (continued )

ServerDirectoryName 445

ServerPort 445

ServerAllInterfaces 445

ServerDirectoryName 445

ServerPort 445

service imp act managemen t

cell fun ctions 37

how it works 241

process flow diagram 242

service model developm ent

described 241

ServiceContact.cfg 273

services

starting cells with 42

stopping cells with 41

setting

a value in a global record 439

cell-specific configuration up 46

setup_env.bat script 466

setup_env.csh script 467

setup_env.sh script 467

SIM cell

functions 37

production 37

test 37

Slot Qu ick Filter 248

slots

assignments, map files 478

functions, map files 479

sorting 251, 252

source event 238

specific parameters 200

starting cells

specific cell 386

UNIX platform s 40, 41

using m cell 40

Windows 41

with net start 42

with serv ices 42

statbld retu rn codes 225

statbld.conf file 224, 231

statbld.exe file 224

statbld.trace file 224, 233

state configuration p arameters 455ExportConfigFileName 225

ExportDiscarded 225

ExportTriggerArguments 225

ExportTriggerProgram 225

StateHistoryCount 225

state files, extracting 434

state parameters 455

StateBuildAtTerminate 460

StateBuildConfigFileName 460

StateBuildInterval 460

StateBuildRunTimeOut 460

StateBuildSize 460





StateBuildAtTerminate 460

StateBuildConfigFileName 460

StateBuilder 224, 460

configuration param eters for event d ata export 225

StateBuildInterval 460

StateBuildRunTimeOut 460

StateBuildSize 460

StateHistoryCount 225

static collectors 364

stopping cells

on Windows 41

UNIX platforms 41

using the mk ill comm and 42

with m kill 40, 417

with net stop 42

with services 42

stopping msend a nd m poster processes 420

structure, map files 475

subcollector node 363

sup port, customer 3

suppression policy, creating 311

SynchronizedTimeOut 447

syntax

mccomp 385

mcell 386

mcfgtrace 389

mclassinfo 391

mcollinfo 396

mcontrol 398

mcrtcell 403

mdelcell 407

mgetinfo 408

mgetrec 413

mkb 414

mkill 417, 420

mlogchk 419

mposter 422, 423

mquery 427

mrecover 433

mrextract 435

mrmerge 436

msetmsg 437

msetrec 439

SystemLogDirNam e p arameter

described 445used to specify log and trace file directories 41

SystemTmpDirNam e parameter

described 445

used to specify trace and log file directories 41

TTCP client adapter

description 491

diagnostics 493

TCP Server adapter

description 494

diagnostics 495

TCP server Adap ter


technical supp ort 3

telnet adap ter


description 496

diagnostics 500

termina ting a cell 400

test cells

described 37

test certificate, digital 220

TextTranslation.cfg 273

threshold policy, creating 313, 314

Timeframe Edit dialog 275

timeframes

creating 274

Timeframes wind ow 274

timeou t policy, creating 317

tool tips

BIX, enabling an d disabling 221

toolbar

in dynam ic data ed itor 248

trace configuration file 73

configuring 73

parameters 74

Trace p arameter 461

trace parameters

list of 461

trace, disable encryp tion to 66

TraceConfigFileName parameter 461

TraceDefaultFileName parameter 461

TraceFileAppend param eter 463

TraceFileHistory parameter 463

TraceFileSize pa ram eter 463

TraceRuleLevel parameter 461

TraceRuleToXact p aram eter 462

TraceSrc param eter 461

tracing p arameters

configuring 77

Trace 461

TraceConfigFileName 461

TraceDefaultFileName 461TraceFileAppend 463

TraceFileHistory 463

TraceFileSize 463

TraceRuleLevel 461

TraceRuleToXact 462

TraceSrc 461



Index 567


UUDP Client ada pter


description 500diagnostics 502

UDP Server adap ter


diagnostics 504

UNIX

permissions required to start cells 41

root user p ermissions 40

starting cells 40, 41

stopping cells 41

UNIX platforms

environment variables 467

up dating the Knowledge Base 414

Wwidgets, defined 363

Windows

starting a cell with services 42

starting cells 41

starting cells with n et start 42

stopping a cell with mk ill command 42

stopp ing a cell with serv ices 42

stopping cells 41

stopping cells with net stop 42

stopping w ith mkill 42

Windows p latforms

environment variables 466

Xxact transa ction file 224



Notes

bmc impact solutions 7.1- general administration

Documents