You are on page 1of 258

PATROL Configuration Manager User Guide

Version 1.4.01

August 15, 2003

Copyright 2003 BMC Software, Inc., as an unpublished work. All rights reserved. BMC Software, the BMC Software logos, and all other BMC Software product or service names are registered trademarks or trademarks of BMC Software, Inc. All other registered trademarks or trademarks belong to their respective companies. THE USE AND CONTENTS OF THIS DOCUMENTATION ARE GOVERNED BY THE SOFTWARE LICENSE AGREEMENT ENCLOSED AT THE BACK OF THIS DOCUMENTATION.

Restricted Rights Legend


U.S. GOVERNMENT RESTRICTED RIGHTS. UNPUBLISHEDRIGHTS RESERVED UNDER THE COPYRIGHT LAWS OF THE UNITED STATES. Use, duplication, or disclosure by the U.S. Government is subject to restrictions set forth in FAR Section 52.227-14 Alt. III (g)(3), FAR Section 52.227-19, DFARS 252.227-7014 (b), or DFARS 227.7202, as amended from time to time. Contractor/Manufacturer is BMC Software, Inc., 2101 CityWest Blvd., Houston, TX 77042-2827, USA. Any contract notices should be sent to this address.

Contacting BMC Software


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

United States and Canada


Address BMC Software, Inc. 2101 CityWest Blvd. Houston TX 77042-2827 713 918 8800 or 800 841 2031 713 918 8000

Outside United States and Canada


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

Telephone Fax

Customer Support
You can obtain technical support by using the Support page on the BMC Software Web site or by contacting Customer Support by telephone or e-mail. To expedite your inquiry, please see Before Contacting BMC Software.

Support Web Site


You can obtain technical support from BMC Software 24 hours a day, 7 days a week at http://www.bmc.com/support.html. From this Web site, you can read overviews about support services and programs that BMC Software offers find the most current information about BMC Software products search a database for problems similar to yours and possible solutions order or download product documentation report a problem or ask a question subscribe to receive e-mail notices when new product versions are released find worldwide BMC Software support center locations and contact information, including e-mail addresses, fax numbers, and telephone numbers

Support by Telephone or E-mail


In the United States and Canada, if you need technical support and do not have access to the Web, call 800 537 1813. Outside the United States and Canada, please contact your local support center for assistance. To find telephone and e-mail contact information for the BMC Software support center that services your location, refer to the Contact Customer Support section of the Support page on the BMC Software Web site at www.bmc.com/support.html.

Before Contacting BMC Software


Before you contact BMC Software, have the following information available so that Customer Support can begin working on your problem immediately: product information product name product version (release number) license number and password (trial or permanent)

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

BMC Software, Inc., Confidential and Proprietary Information

iii

sequence of events leading to the problem commands and options that you used messages received (and the time and date that you received them) product error messages messages from the operating system, such as file system full messages from related software

BMC Software, Inc., Confidential and Proprietary Information

iv

PATROL Configuration Manager User Guide

Contents

Contents
About This Book Chapter 1 Introduction

About PATROL Configuration Manager . . . . . . . . . . . . . . . . . . . . . . 1-2 Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3 User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3 PATROL Knowledge Module for Event Management . . . . . . . . 1-3 Agent Repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4 Rules Repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
Chapter 2 Getting Started

Where to Install PATROL Configuration Manager . . . . . . . . . . . . . . 2-2 System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4 Installation Utility Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5 Target Computers and Their Roles . . . . . . . . . . . . . . . . . . . . . . . 2-6 Typical and Custom Installation Types . . . . . . . . . . . . . . . . . . . . 2-8 PATROL Security Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9 Installing the PATROL Configuration Manager . . . . . . . . . . . . . 2-10 Starting the PATROL Configuration Manager . . . . . . . . . . . . . . 2-14 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-15 Folders/Paths Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-16 Archives Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-18 Tree Font Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-21 Working with Configuration Files . . . . . . . . . . . . . . . . . . . . . . . 2-23 Creating a New Configuration File . . . . . . . . . . . . . . . . . . . . . . . 2-23 Opening a Configuration File . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-23
BMC Software, Inc., Confidential and Proprietary Information

Contents

Chapter 3

User Interface and Menu Commands

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-2 Menu Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-3 File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-3 Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-4 Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-7 Other . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-8 Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-16 Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-16 Save . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-17 Get Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-17 Apply Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-18 Search RuleSets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-18 Agent Tree View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-22 Group Shortcut Menu Commands . . . . . . . . . . . . . . . . . . . . . . . .3-23 Agent Shortcut Menu Commands . . . . . . . . . . . . . . . . . . . . . . . .3-26 RuleSet Tree View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-33 RuleSet Folder Shortcut Menu Commands . . . . . . . . . . . . . . . . .3-34 RuleSet Shortcut Menu Commands . . . . . . . . . . . . . . . . . . . . . .3-36 Rule Shortcut Menu Commands . . . . . . . . . . . . . . . . . . . . . . . . .3-45 Status Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-49 Agent Lock Indicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-49 Operation Status Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-49
Chapter 4 Working with Agents, Groups, RuleSets, and Rules

Agents and Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-2 Sharing Agents and Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-3 Moving and Copying Agents and Groups . . . . . . . . . . . . . . . . . .4-6 Adding Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-7 Adding Agents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-8 Removing Agents and Groups . . . . . . . . . . . . . . . . . . . . . . . . . . .4-10 RuleSets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-13 Moving and Copying RuleSets and RuleSet Folders . . . . . . . . .4-14 Creating a New RuleSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-15 Creating a RuleSet From an Existing RuleSet . . . . . . . . . . . . . .4-17 Deleting RuleSets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-18 Local RuleSets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-20 Creating Local Rulesets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-21 Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-22 RuleSet Locking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-23
BMC Software, Inc., Confidential and Proprietary Information

vi

PATROL Configuration Manager User Guide

Creating a Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-24 Editing a Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-26


Chapter 5 Event Management Commands

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2 Alert Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3 Add and Remove Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4 Show Override Periods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5 Alert Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6 Notification System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7 Notification Blackouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-10 Notification Targets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-11 Alert Resend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-14 Alert Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-15 Send Reset On Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-20 Notification Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-21 Recovery Action Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-22 Recovery Action Command Type . . . . . . . . . . . . . . . . . . . . . . . . 5-25 Custom Identifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-26 Class Active State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-28 Parameter Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-30 Thresholds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-32 Polltimes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-35 What If... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-36
Chapter 6 Working with PATROL Agents and PATROL Consoles

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2 AS_CHANGESPRING KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2 Loading the AS_CHANGESPRING KM . . . . . . . . . . . . . . . . . . 6-3 Accessing the KM Commands and InfoBoxes . . . . . . . . . . . . . . 6-5 AS_CHANGESPRING KM Menu Commands . . . . . . . . . . . . . 6-6 PATROL Console Configuration Files . . . . . . . . . . . . . . . . . . . . . . . 6-18 Importing PATROL Console Desktop Settings . . . . . . . . . . . . . . 6-19
Appendix A Appendix B Appendix C Configuration Settings Supported Regular Expressions Troubleshooting and Frequently Asked Questions

Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .C-2
BMC Software, Inc., Confidential and Proprietary Information

Contents

vii

NT_CPU Polltime Changes are Not Working . . . . . . . . . . . . . . C-3 PATROL Configuration Manager Does Not Start on Windows C-4 PATROL Configuration Manager Does Not Start on Unix . . . . C-5 KM Parameters are not in the Object Selection List . . . . . . . . . C-6 Rule Value Length Too Long . . . . . . . . . . . . . . . . . . . . . . . . . . . C-7 PATROL Configuration Manager Labels Missing . . . . . . . . . . C-8 PATROL Configuration Manager Does Not Start on Windows with Abnormal Termination Errors . . . . . . . . . . . . . . . . . . . . . . . . C-9 PATROL Configuration Manager Opens an Extra Window . . . C-10 Frequently Asked Questions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-12 How Do I Move PATROL Configuration Manager from Unix to Windows? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-13 What is the purpose of the DELVAR operation? . . . . . . . . . . . . C-13
Glossary Index

BMC Software, Inc., Confidential and Proprietary Information

viii

PATROL Configuration Manager User Guide

Figures

Figures
Figure 2-1 Figure 2-2 Figure 2-3 Figure 2-4 Figure 2-5 Figure 3-1 Figure 3-2 Figure 3-3 Figure 3-4 Figure 3-5 Figure 3-6 Figure 3-7 Figure 3-8 Figure 3-9 Figure 3-10 Figure 3-11 Figure 3-12 Figure 3-13 Figure 3-14 Figure 3-15 Figure 3-16 Figure 3-17 Figure 3-18 Figure 3-19 Figure 3-20 Figure 3-21 Figure 3-22 Figure 3-23 Version Information Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . Select Products and Components to Install . . . . . . . . . . . . . . . . Configure Dialog BoxFolders/Paths Tab . . . . . . . . . . . . . . . . . Configure Dialog BoxArchives Tab. . . . . . . . . . . . . . . . . . . . . Configure Dialog BoxTree Font Tab . . . . . . . . . . . . . . . . . . . . PATROL Configuration Manager User Interface. . . . . . . . . . . . Apply RuleSets Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . Agents List Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Job Status Information Dialog Box . . . . . . . . . . . . . . . . . . . . . . ToolTip Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ApplyOnNew Activated and Deactivated . . . . . . . . . . . . . . . . . Group ApplyOnNew Dialog Box . . . . . . . . . . . . . . . . . . . . . . . Agent ApplyOnNew Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . ApplyOnApply Activated Command. . . . . . . . . . . . . . . . . . . . . ApplyOnNew Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PATROL Configuration Manager Toolbar . . . . . . . . . . . . . . . . . Configuration - Get Example. . . . . . . . . . . . . . . . . . . . . . . . . . . RuleSet Search Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . Search Reached Matching Limit Dialog Box . . . . . . . . . . . . . . Search Results Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . Group Shortcut Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Agent Shortcut Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Alert Settings Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Parameter Settings Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . What If... Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RuleSet Folder shortcut Menu . . . . . . . . . . . . . . . . . . . . . . . . . . RuleSet Shortcut Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Edit Configuration Source File Dialog Box. . . . . . . . . . . . . . . . 2-5 2-12 2-16 2-18 2-21 3-2 3-5 3-6 3-9 3-10 3-12 3-12 3-13 3-14 3-15 3-16 3-17 3-18 3-20 3-21 3-23 3-26 3-30 3-31 3-32 3-34 3-36 3-37

BMC Software, Inc., Confidential and Proprietary Information

Figures

ix

Figure 3-24 Figure 3-25 Figure 3-26 Figure 3-27 Figure 3-28 Figure 3-29 Figure 3-30 Figure 3-31 Figure 4-1 Figure 4-2 Figure 4-3 Figure 4-4 Figure 4-5 Figure 4-6 Figure 4-7 Figure 4-8 Figure 4-9 Figure 4-10 Figure 4-11 Figure 4-12 Figure 4-13 Figure 4-14 Figure 4-15 Figure 4-16 Figure 4-17 Figure 4-18 Figure 4-19 Figure 4-20 Figure 4-21 Figure 4-22 Figure 4-23 Figure 4-24 Figure 5-1 Figure 5-2 Figure 5-3 Figure 5-4 Figure 5-5 Figure 5-6 Figure 5-7 Figure 5-8

RuleSet Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Edit Rule Variable Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . Edit Value for Event Management Rule Example . . . . . . . . . . . RuleSet Comparison Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . Search Backup RuleSets Dialog Box . . . . . . . . . . . . . . . . . . . . . Rule Shortcut Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RuleSet Search Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . Search Results Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . Lock Indicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Lock Indicator Tooltip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Unlock Indicator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Unlock Indicator Tooltip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Reload Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . New Group Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . New Agent Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Group Shortcut Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Confirm Delete Items Dialog Box . . . . . . . . . . . . . . . . . . . . . . . Agent Backups Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . Agent Localized Settings Dialog Box . . . . . . . . . . . . . . . . . . . . RuleSet Folder Shortcut Menu New Commands . . . . . . . . . . . . New RuleSet Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . New RuleSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Rule Shortcut Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RuleSet Shortcut Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Confirm Delete Items Dialog Box . . . . . . . . . . . . . . . . . . . . . . . New Local RuleSet Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . File Locked Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RuleSet Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Edit Configuration Source File Dialog Box . . . . . . . . . . . . . . . . RuleSet Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Edit Rule Variable Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . Edit Value for Event Management Rule Example . . . . . . . . . . . Alert Settings Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Object Selection Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . Override Settings... Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . Alert Settings Dialog BoxAlert Action Tab . . . . . . . . . . . . . . . Alert Settings Dialog BoxNotification System Tab . . . . . . . . . Alert Settings Dialog BoxNotification Blackouts Tab . . . . . . . Alert Settings Dialog BoxNotification Targets Tab . . . . . . . . . Alert Settings Dialog BoxAlert Resend Tab. . . . . . . . . . . . . . .

3-38 3-39 3-40 3-42 3-44 3-45 3-47 3-48 4-4 4-4 4-5 4-5 4-5 4-7 4-8 4-10 4-11 4-11 4-12 4-15 4-15 4-16 4-17 4-18 4-19 4-21 4-23 4-24 4-26 4-27 4-28 4-29 5-3 5-4 5-5 5-6 5-8 5-10 5-12 5-14

BMC Software, Inc., Confidential and Proprietary Information

PATROL Configuration Manager User Guide

Figure 5-9 Figure 5-10 Figure 5-11 Figure 5-12 Figure 5-13 Figure 5-14 Figure 5-15 Figure 5-16 Figure 5-17 Figure 5-18 Figure 5-19 Figure 5-20 Figure 5-21 Figure 5-22 Figure 5-23 Figure 6-1 Figure 6-2 Figure 6-3 Figure 6-4 Figure 6-5 Figure C-1

Alert Settings Dialog BoxAlert Messages Tab . . . . . . . . . . . . Alert Settings Dialog BoxSend Reset On Init Tab. . . . . . . . . . Alert Settings Dialog BoxNotification Command Tab . . . . . . Alert Settings Dialog BoxRecovery Action Commands Tab. . Alert Settings Dialog BoxRecovery Action Command Type Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Alert Settings Dialog BoxCustom Identifiers Tab . . . . . . . . . . Alert Settings Dialog BoxClass Active State Tab . . . . . . . . . . Parameter Settings Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . Object Selection Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . Parameter SettingsThresholds Tab. . . . . . . . . . . . . . . . . . . . . . Parameter SettingsPolltimes Tab . . . . . . . . . . . . . . . . . . . . . . . What If... Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . What If RuleSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . What If Results Dialog BoxResults Tab . . . . . . . . . . . . . . . . . What If Results Dialog BoxReport Tab . . . . . . . . . . . . . . . . . . AS_CHANGESPRING Menu Commands . . . . . . . . . . . . . . . . RuleSet File Name Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Select the Knowledge Modules Dialog Box . . . . . . . . . . . . . . . Create List Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Get File Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Rule Value Length Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . .

5-16 5-20 5-21 5-23 5-25 5-27 5-28 5-30 5-31 5-32 5-35 5-36 5-36 5-37 5-38 6-5 6-7 6-9 6-13 6-14 C-7

BMC Software, Inc., Confidential and Proprietary Information

Figures

xi

BMC Software, Inc., Confidential and Proprietary Information

xii

PATROL Configuration Manager User Guide

Tables

Tables
Table 2-1 Table 2-2 Table 3-1 Table 3-2 Table 3-3 Table 3-4 Table 4-1 Table 4-2 Table 5-1 Table 6-1 Table A-1 Table B-1 System Requirements for Installing PATROL Configuration Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Folder and Path Configuration File . . . . . . . . . . . . . . . . . . . . . . Search Specifications Check Boxes . . . . . . . . . . . . . . . . . . . . . . Default RuleSet Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Search Backup RuleSets Dialog Box Options . . . . . . . . . . . . . . Search Specifications Check Boxes . . . . . . . . . . . . . . . . . . . . . . New Agent Dialog Box Fields . . . . . . . . . . . . . . . . . . . . . . . . . . Rule Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Alert Message Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Accessing KM Commands and InfoBoxes . . . . . . . . . . . . . . . . PATROL Configuration Manager Configuration Variables . . . . Supported Regular Expressions . . . . . . . . . . . . . . . . . . . . . . . . .

2-3 2-17 3-19 3-33 3-44 3-47 4-9 4-25 5-17 6-5 A-3 B-1

BMC Software, Inc., Confidential and Proprietary Information

Tables

xiii

BMC Software, Inc., Confidential and Proprietary Information

xiv

PATROL Configuration Manager User Guide

About . . .

About This Book


This book contains detailed information about the PATROL Configuration Manager component and is intended for PATROL administrators, system administrators, and database administrators (DBAs). PATROL Configuration Manager is used with the PATROL Knowledge Module (KM) for Event Management. The PATROL KM for Event Management provides notification and alert control. For more information on the PATROL KM for Event Management, see the PATROL Knowledge Module for Event Management User Guide.
Note

This book assumes that you are familiar with your host operating system. You should know how to perform basic actions in a window environment, such as choosing menu commands and dragging and dropping icons.

BMC Software, Inc., Confidential and Proprietary Information

About This Book

xv

How This Book Is Organized


This book is organized as follows. In addition, this book contains a glossary of terms and an index.
Chapter/Appendix
Chapter 1, Introduction Chapter 2, Getting Started

Description
provides an overview of PATROL Configuration Manager describes how to install, start, and configure PATROL Configuration Manager describes the PATROL Configuration Manager user interface and menu commands describes how to work with agents, groups, and RuleSets describes the PATROL KM for Event management commands in PATROL Configuration Manager describes how to convert PATROL Agent settings into rules and RuleSets for PATROL Configuration Manager describes the directories, files, and settings used by PATROL Configuration Manager describes the regular expressions supported by the PATROL Configuration Manager search dialog boxes describes how to correct common PATROL Configuration Manager problems contains PATROL terms and definitions lists index entries for this book

Chapter 3, User Interface and Menu Commands Chapter 4, Working with Agents, Groups, RuleSets, and Rules Chapter 5, Event Management Commands Chapter 6, Working with PATROL Agents and PATROL Consoles Appendix A, Configuration Settings Appendix B, Supported Regular Expressions Appendix C, Troubleshooting and Frequently Asked Questions Glossary Index

BMC Software, Inc., Confidential and Proprietary Information

xvi

PATROL Configuration Manager User Guide

Related Documentation
BMC Software products offer several types of documentation: online and printed books release notes

Online and Printed Books


The books that accompany BMC Software products are available in online and printed formats. Online books are formatted as Portable Document Format (PDF) files. Some online books are also formatted as HTML files.
To Access Online Books

To view any online book that BMC Software offers, visit the Customer Support page of the BMC Software Web site at http://www.bmc.com/support.html. You can also access PDF books from the documentation compact disc (CD) that accompanies your product. Use the free Acrobat Reader from Adobe Systems to view, print, or copy PDF files. In some cases, installing the Acrobat Reader and downloading the online books is an optional part of the product-installation process. For information about downloading the free reader from the Web, go to the Adobe Systems site at http://www.adobe.com.
To Request Additional Printed Books

BMC Software provides some printed books with your product order. To request additional books, go to http://www.bmc.com/support.html.

BMC Software, Inc., Confidential and Proprietary Information

About This Book

xvii

Release Notes
Printed release notes accompany each BMC Software product. Release notes provide up-to-date information such as updates to the installation instructions last-minute product information

The latest versions of the release notes are also available on the Web at http://www.bmc.com/support.html.

Conventions
The following conventions are used in this book: This book includes special elements called notes, warnings, examples, and tips:
Note

Notes provide additional information about the current subject.

Warning

Warnings alert you to situations that can cause problems, such as loss of data, if you do not follow instructions carefully.

Example

An example clarifies a concept discussed in text.

Tip

Tips contain information that might improve product performance or that might make procedures easier to follow.

BMC Software, Inc., Confidential and Proprietary Information

xviii

PATROL Configuration Manager User Guide

All syntax, operating system terms, and literal examples are presented in this typeface. In instructions, boldface type highlights information that you enter. File names, directories, Web addresses, e-mail addresses, and names of GUI elements also appear in boldface type. The symbol => connects items in a menu sequence. For example, Actions => Create Test instructs you to choose the Create Test command from the Actions menu. The symbol

denotes one-step instructions.

In syntax, path names, or system messages, italic text represents a variable, as shown in the following examples: The table tableName is not available.
system/instance/fileName

In syntax, the following additional conventions apply: A vertical bar ( | ) separating items indicates that you must choose one item. In the following example, you would choose a, b, or c: a | b | c An ellipsis ( . . . ) indicates that you can repeat the preceding item or items as many times as necessary. Square brackets ( [ ] ) around an item indicate that the item is optional.

BMC Software, Inc., Confidential and Proprietary Information

About This Book

xix

BMC Software, Inc., Confidential and Proprietary Information

xx

PATROL Configuration Manager User Guide

Introduction

This chapter introduces PATROL Configuration Manager. The following topics are discussed: About PATROL Configuration Manager . . . . . . . . . . . . . . . . . . . . . . 1-2 Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3 User Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3 PATROL Knowledge Module for Event Management . . . . . . . . 1-3 Agent Repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4 Rules Repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4

BMC Software, Inc., Confidential and Proprietary Information

Introduction

1-1

About PATROL Configuration Manager


The PATROL Configuration Manager component allows system administrators to focus on the development of business rules by providing the following benefits: separation of business rules from the management tool rule management features, such as, basic change control, rule organization, and rule deployment methods manages different PATROL Agent versions on multiple hosts intuitive interface ease of use

PATROL Configuration Manager frees administrators from spending excessive amounts of time on PATROL product specifics and enables them to focus on the delivery of an enterprise management solution.

BMC Software, Inc., Confidential and Proprietary Information

1-2

PATROL Configuration Manager User Guide

Components
This section describes the components of PATROL Configuration Manager: user interface PATROL KM for Event Management agent repository rules repository managed systems (agents)

The following sections describe the PATROL Configuration Manager components.

User Interface
The PATROL Configuration Manager user interface, shown in Figure 3-1 on page 3-2, configures managed agents and administers rules. The user interface provides features similar to the Windows Explorer interface such as drag and drop and cut and paste.

PATROL Knowledge Module for Event Management


The PATROL KM for Event Management provides notification and alert control. PATROL Configuration Manager provides an interface to the PATROL KM for Event Management commands. When you are using PATROL Configuration Manager, you should have the PATROL KM for Event Management installed on your PATROL Agents. Without the PATROL KM for Event Management, you cannot use the Event Management features of the PATROL Configuration Manager. See the PATROL Knowledge Module for Event Management User Guide for more information.

BMC Software, Inc., Confidential and Proprietary Information

Introduction

1-3

Agent Repository
The agent repository contains communication settings and grouping information for each agent. The agent repository information is stored in the following files: agents.ini groups.ini

Rules Repository
The rules repository contains the following information: rules and RuleSets backup agent configurations recent transaction history localized agent RuleSets

The rules repository contains rules that are installed with the PATROL Configuration Manager and user-defined rules. Rules are logically grouped to form RuleSets. For example, rules could be grouped according to their related action or object: notification typeall rules that apply to e-mail notifications could be grouped into a RuleSet object all rules pertaining to an agent parameter could be grouped into a RuleSet

RuleSets can be grouped together into folders. While you usually manage your RuleSets and folders with PATROL Configuration Manager, the RuleSets are stored in text files and can be managed using standard system utilities such as text editors and file management utilities. The RuleSets are in the same format as standard PATROL Agent change files (.cfg).

BMC Software, Inc., Confidential and Proprietary Information

1-4

PATROL Configuration Manager User Guide

Getting Started

This chapter describes how to install, start, and configure the PATROL Configuration Manager component. The following topics are discussed: Where to Install PATROL Configuration Manager . . . . . . . . . . . . . . 2-2 System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4 Installation Utility Version. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5 Target Computers and Their Roles . . . . . . . . . . . . . . . . . . . . . . . 2-6 Typical and Custom Installation Types . . . . . . . . . . . . . . . . . . . . 2-8 PATROL Security Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9 Installing the PATROL Configuration Manager . . . . . . . . . . . . . 2-10 Starting the PATROL Configuration Manager. . . . . . . . . . . . . . . 2-14 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-15 Folders/Paths Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-16 Archives Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-18 Tree Font Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-21 Working with Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . 2-23 Creating a New Configuration File . . . . . . . . . . . . . . . . . . . . . . . 2-23 Opening a Configuration File . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-23

BMC Software, Inc., Confidential and Proprietary Information

Getting Started

2-1

Where to Install PATROL Configuration Manager


PATROL Configuration Manager should be installed on the same system as the PATROL Developer Console, but PATROL Configuration Manager can be installed on any system that has a PATROL Console or Agent. Installing PATROL Configuration Manager on the same system as the PATROL Developer Console is preferred for the following reasons: The PATROL Developer Console and PATROL Configuration Manager provide a complementary set of administrative tools. The PATROL Console usually has connectivity to agents and PATROL Configuration Manager can share firewall rules with the PATROL Console. PATROL Agent configuration files can be imported to PATROL Configuration Manager. See AS_CHANGESPRING KM Menu Commands on page 6-6. PATROL Console profiles describing the monitored systems can be converted to PATROL Configuration Manager initialization files. See PATROL Console Configuration Files on page 6-18.

BMC Software, Inc., Confidential and Proprietary Information

2-2

PATROL Configuration Manager User Guide

System Requirements
PATROL Configuration Manager requires a Java Runtime Environment (JRE) and some PATROL components. Verify that the target computer meets the installation requirements listed in Table 2-1.
Table 2-1 System Requirements for Installing PATROL Configuration Manager

Resource
operating systems

Requirements
PATROL Configuration Manager is supported on the same operating systems as the PATROL Console for Microsoft Windows 3.5.x and the PATROL Console for Unix 3.5.x, provided the operating system has a supported JRE version. PATROL Console 3.4.x or later PATROL Agent 3.4.x or later PATROL KM for Event Management 2.4.05 or later

Comments
For a list of supported operating systems for the PATROL Console, see the PATROL Console for Microsoft Windows and the PATROL Console for Unix Release Notes.

PATROL products

PATROL Console or Agent 3.4 or later must be installed on the same system as PATROL Configuration Manager. The PATROL KM for Event Management is required on all managed systems where you use PATROL Configuration Manager Event Management features.

installation utility disk space memory External software products

PATROL Installation Utility 7.3.x or later 80 MB 256 MB Java Runtime Environment (JRE) v1.3.1 or later JRE 1.4 or later is required for international support.

See Installation Utility Version on page 2-5 for information on determining the version of your installation utility.

On Windows, the JRE (v1.4) is installed with PATROL Configuration Manager. On Unix, you must install the JRE before you can use PATROL Configuration Manager. You can either install the JRE before or after you install PATROL Configuration Manager.

BMC Software, Inc., Confidential and Proprietary Information

Getting Started

2-3

Installation
This section provides background information about the installation utility and detailed instructions for installing the PATROL Configuration Manager.

Overview
BMC Software recommends that you first install PATROL Configuration Manager on a limited number of development or test machines, then configure and test PATROL Configuration Manager before installing it onto production machines. The installation utility installs only to a local computer. The installation utility cannot perform remote installations. You must install PATROL Configuration Manager locally on each computer that you want to use it on.
Note

The installation utility provides you with the ability to create an installable image of the products that you select during install. After you create the installable image, you can export it to a shared BMC Software directory to install the package on all computers that share the same BMC Software product installation directory, PATROL default logon, PATROL Agent port number, PATROL 3.x product directory, PATROL 7.x product directory, and security option. For more information about creating and exporting installation packages, see the PATROL Installation Reference Manual.

BMC Software, Inc., Confidential and Proprietary Information

2-4

PATROL Configuration Manager User Guide

Installation Utility Version


The PATROL Configuration Manager is installed with the PATROL Installation Utility 7.3.x or later. The installation instructions contained in this version of PATROL Configuration Manager User Guide pertain to version 7.4.00 of the PATROL Installation Utility. If you use a version of the PATROL Installation Utility other than version 7.4.00, the installation instructions in this manual may not accurately describe what you see on your screen. Your version of the installation utility might be different because it was included on another product CD or you may have downloaded it from the BMC Software Electronic Product Download (EPD) site. To determine the version of an installation utility, perform the following steps:
Step 1 Step 2 Step 3

Open a command prompt. Navigate to the directory where the installation utility is located. Enter one of the following commands:
setup.exe -v (Windows) setup.sh -v (Unix)

A message displays the version of the installation utility. Figure 2-2 shows the Version Information dialog box for PATROL Installation Utility version 7.4.00:
Figure 2-1 Version Information Dialog Box

BMC Software, Inc., Confidential and Proprietary Information

Getting Started

2-5

Target Computers and Their Roles


The PATROL installation utility prompts you to select the roles performed by the computer that you are installing BMC Software products on (the target computer). Before beginning the installation process, review the following definitions of the roles that are presented in the installation utility and decide which of these roles is performed by each computer in your environment.
Note

The PATROL Configuration Manager is a Console System application.


Console Systems (also referred to as console computers) host user

desktop applications such as consoles, user interfaces, viewers, console KMs, and browsers. Select this option if the computer to which you are installing performs any of the following roles: monitor, manage, and develop KMs on Windows by using a PATROL Console for Windows (PATROL 3.x architecture) monitor, manage, and develop KMs on Unix by using a PATROL Console for Unix (PATROL 3.x architecture) monitor and manage on Unix or Windows by using a PATROL Central Operator Web Edition console (PATROL 7.x architecture) monitor and manage on Windows by using a PATROL Central Operator Microsoft Windows Edition console (PATROL 7.x architecture)

BMC Software, Inc., Confidential and Proprietary Information

2-6

PATROL Configuration Manager User Guide

Managed Systems (also referred to as agent computers) host software that manages the resources on the computer, such as a PATROL Agent, PATROL Knowledge Modules, and Service Reporting Retrievers. Select this option if the computer to which you are installing performs any of the following roles:

host a PATROL Agent 3.5 (works with both the PATROL 3.x and PATROL 7.x architecture) host KMs and components that contain the knowledge that PATROL uses to monitor the resources on this computer
Common Services (new with PATROL 7.x architecture) computers host services that are shared among managed systems and console systems. You can install each of these common services on any computer in the network. Select this option if the computer to which you are installing performs any of the following roles:

host the PATROL Central Operator Web Edition (PATROL 7.x architecture) Web server host the PATROL Console Servers host the RTservers For more information about these products, see PATROL Console Server and RTserver Getting Started, PATROL Central Operator Web Edition Getting Started, and PATROL Central Operator Web Edition online Help.

BMC Software, Inc., Confidential and Proprietary Information

Getting Started

2-7

Typical and Custom Installation Types


The PATROL installation utility prompts you to select a Typical or Custom installation. The Typical and Custom installation are the same for the PATROL Configuration Manager, but you may be installing other products at the same time. Use the Typical installation type in any or all of the following instances: You are new to the product you want to install. You are performing a first-time installation (you are not upgrading). The Typical installation type installs some components by default when you select other components. Use the Custom installation type in any or all of the following instances: You want to install individual components You are upgrading PATROL Configuration Manager from a previously installed version. You are installing into a PATROL 3.3.x or 3.4.x environment. With each installation type, you can deselect any components that you dont want to install.

BMC Software, Inc., Confidential and Proprietary Information

2-8

PATROL Configuration Manager User Guide

PATROL Security Levels


You can secure the data passed between PATROL components and restrict unauthorized users from accessing your data by implementing PATROL security. PATROL contains five security policy levels in a predefined set of security configurations that you can select from when you install PATROL. Basic security (level 0) is a minimal level of security with no configuration requirements. At the highest level of advanced security (4), all communicating components must authenticate with each other and key databases must validate connection requests. High security requires more configuration of the communicating components (the agent and the console) and is more difficult to use than lower levels of security. You can select the security level that best balances the ease of use with your need for security.
Note

All PATROL components, including agents and consoles, must operate at the same security level to communicate with each other. Review the security level definitions in the PATROL Security User Guide before installing PATROL to determine the appropriate security level for your system needs. If you want to implement a new security level after having previously installed PATROL security, see the PATROL Security User Guide for instructions. For more information about implementing and using PATROL security, see the following documentation: PATROL Security User Guide PATROL Security Release Notes

How PATROL Security Affects the PATROL Configuration Manager

PATROL security is installed as part of the agent and console. The PATROL Configuration Manager inherits the security policy from the agent or console installed on the same system.
BMC Software, Inc., Confidential and Proprietary Information

Getting Started

2-9

Installing the PATROL Configuration Manager Summary:


Before You Begin

In the following task, you install the PATROL Configuration Manager.

Ensure that you install a PATROL Console with the PATROL Configuration Manager or that you have a PATROL Console or PATROL Agent installed on the system where you are installing PATROL Configuration Manager.
To Install the PATROL Configuration Manager Step 1

From the installation CD or from an electronically downloaded installation (EPD) image, run setup.exe (Windows) or setup.sh (Unix). In the Welcome to the Installation Utility window, click Next to begin your installation. Review the license agreement, select Accept, and click Next to continue. In the Select Installation Option window, select one of the following options: If you want to install the products without creating an installable image, select I want to install products on this computer now and click Next to continue. If you want to create an installable image that you can use to install the products on this computer and other computers later, select I want to create an installable image to be installed later, enter the directory where you want to store the installable image, and click Next to continue.

Step 2

Step 3 Step 4

For more information, see the Installation Utility Reference Manual.

BMC Software, Inc., Confidential and Proprietary Information

2-10

PATROL Configuration Manager User Guide

Step 5

In the Select Type of Installation window, select Typical or Custom and click Next to continue.
Note

The PATROL Configuration Manager installation is the same for both the Typical and Custom installation.
Step 6

In the Specify Installation Directory window, accept the default directory and click Next to continue. In the Select System Roles window, select Console Systems and click Next. Fore more information, see Target Computers and Their Roles on page 2-6.

Step 7

BMC Software, Inc., Confidential and Proprietary Information

Getting Started

2-11

Step 8

On the Select Products and Components to Install window, expand the PATROL Configuration Management folder, and select the PATROL Configuration Manager as shown in Figure 2-2.
Figure 2-2 Select Products and Components to Install

PATROL Configuration Manager product selection

Note

The list of products in the Product Selection tree may be different that the list in Figure 2-2, but the product selection is still PATROL Configuration Manager.
Step 9 Step 10

Click Next. Complete the remaining windows. The number and content of the windows depend on other products selected. Click Help as needed to complete the windows.

BMC Software, Inc., Confidential and Proprietary Information

2-12

PATROL Configuration Manager User Guide

Step 11

In the Review Selections and Install or the Review Selections and Create Installable Image window, review the selections carefully to make sure they are correct. If you want to change your selections, click Back and make those changes. If the selections are correct, select Start Install to start installing or Create Image to start exporting the image to the directory you entered in Step 4 on page 2-10. A status window opens that contains current messages, current milestones and percent complete.

Step 12

When the status window reports that the installation is 100% complete, click Next to view the results window. (Next does not appear until the installation is 100% complete.) In the results window, click View Log to review the details of the installation or click Exit to close the installation utility. PATROL Configuration Manager is installed by default in the following the following directories: Windows
C:\Program Files\BMC Software\pconfmgr

Unix
/opt/bmc/pconfmgr

BMC Software, Inc., Confidential and Proprietary Information

Getting Started

2-13

Starting the PATROL Configuration Manager


The procedures for starting PATROL Configuration Manager depend on the operating system. Follow the procedure below corresponding to the appropriate operating system.
Windows

To start PATROL Configuration Manager on Windows, select the following on the Windows Start menu:
Programs => BMC PATROL => PATROL Configuration Manager Unix

To start PATROL Configuration Manager on Unix, perform the following steps: 1. Change to the installation directory.
cd installation directory

For example,
cd /opt/bmc/pconfmgr

2. Start PATROL Configuration Manager with the following command.


./ChangeSpring.sh Note

$PATROL_HOME must be set to start PATROL Configuration Manager.

BMC Software, Inc., Confidential and Proprietary Information

2-14

PATROL Configuration Manager User Guide

Configuration
After you install PATROL Configuration Manager, the default directories, agents, and RuleSets may need to be configured. This section describes how to change the default directories used by PATROL Configuration Manager. PATROL Configuration Manager stores agent and RuleSet information in text files and directories. During the installation, a default PATROL Configuration Manager initialization file, ChangeSpring.ini, is created in the installation directory. The initialization file is a text file that specifies default directories and files that PATROL Configuration Manager uses to store the agent and RuleSet information. The directories, files, and settings listed in the initialization file are described in Appendix A, Configuration Settings. To manage the directories and settings for PATROL Configuration Manager, select the File =>Configure menu command to open the Configure dialog box, shown in Figure 2-3 on page 2-16. The Configure dialog box contains the following tabs for configuring PATROL Configuration Manager: Folders/Paths Archives Tree Font

See Working with Configuration Files on page 2-23 for more information on PATROL Configuration Manager initialization files.

BMC Software, Inc., Confidential and Proprietary Information

Getting Started

2-15

Folders/Paths Tab
Use the Folders/Paths tab of the Configure dialog box, shown in Figure 2-3, to change directories and files used by PATROL Configuration Manager. The directories are called folders.
Figure 2-3 Configure Dialog BoxFolders/Paths Tab

Note

The Initialization File area at the bottom of the Configure dialog box shows the .ini file of the configuration that is currently loaded.

BMC Software, Inc., Confidential and Proprietary Information

2-16

PATROL Configuration Manager User Guide

Table 2-2 describes the folder, file, and path settings that you can set using the Folders / Paths tab:
Table 2-2 Folder and Path Configuration File

Setting
Ini Folder

INI File Variable


ini_dir

Value Type
directory

Description
contains information about configured agents (agents.ini) and groups (groups.ini) Default <install_dir>/ini contains all RuleSet sub-folders and files Default <install_dir>/rulesets contains the change history for each agent Default <install_dir>/rulesets/ChangeSpring/tlog contains agent configuration backups Default <install_dir>/rulesets/ChangeSpring/backup contains all rules to be applied Default <install_dir>/rulesets/ChangeSpring/queue contains images used in the PATROL Configuration Manager interface Default <install_dir>/images contains comments for RuleSets Default <install_dir>/comments logs operations performed against agents Default <install_dir>/ChangeSpring.log logs error messages Default <install_dir>/changespring.err contains localized agent rulesets Default <ruleset_dir>/ChangeSpring/local

RuleSet Folder

ruleset_dir

directory

Transaction Folder Backup Folder

tlog_dir

directory

backup_dir

directory

Queue Folder

queue_dir

directory

Images Folder

images_dir

directory

Comments Folder

comments_dir

directory

Log File

logfile

file

Error File

errorfile

file

Local Folder

local_dir

directory

BMC Software, Inc., Confidential and Proprietary Information

Getting Started

2-17

Archives Tab
Use the Archives tab of the Configure dialog box, shown in Figure 2-4, to set the archive options for PATROL Configuration Manager. You can specify the following information for archives: Backup Settings Transaction Settings Virtual Backup Folder Settings
Configure Dialog BoxArchives Tab

Figure 2-4

BMC Software, Inc., Confidential and Proprietary Information

2-18

PATROL Configuration Manager User Guide

Backup Settings

Agents configuration backups are specified using the items in the BackUp Settings group box. The backup values apply to all agents. You can specify the following values:
Backups

Use the Backups box to type or select the number of configuration backups that you want to keep for each agent.
Save Backup Before Apply

Select the Save Backup Before Apply check box to make the Backup Agents Before Apply check box selected by default whenever configuration is applied to agents. When Backup Agents Before Apply is selected, a backup of the current agent configuration is retrieved and saved in the PATROL Configuration Manager backup folder before applying new RuleSets. If you make an error applying RuleSets, backups can be used to restore an agent to a previous configuration.
Save Identical Backups

Select the Save Identical Backups check box to specify that all backups are saved. If Save Identical Backups is not selected, PATROL Configuration Manager does not save the agent configuration if it is identical to the most recent backup for the agent, maximizing the number of unique backups.
Transaction Settings

Apply operations are saved in the transaction log folder. Use the Transaction Logs box to specify the number of apply operations you want to save in the transaction log folder.

BMC Software, Inc., Confidential and Proprietary Information

Getting Started

2-19

Virtual Backup Folder Settings

The Virtual Backup Folder Settings define how your agent configuration backups are displayed. The backups are physically stored in one directory. The virtual backup folders provide an easier way to view the backups. You can specify the following values:
Maximum Folders

Use the Maximum Folders text box to specify the maximum number of virtual folders that are created for backups.
Minimum Agents Per Folder

Use the Minimum Agents Per Folder text box to specify the number of agent backups that are created in a virtual backup folder before a new folder is created. These values work together to manage the display of the virtual agent backup folders. For example, if both values are set to five, the first five backups go into one directory. Then the next five backups go into a new virtual directory. This continues until there are five directories with five backups each. At this point, the maximum folders and the minimum agents per folder reach their limits, and as new backups are created, they are added to each folder in turn.
Note

If you change the virtual backup folder settings, you must refresh the RuleSets tree view or restart PATROL Configuration Manager.

BMC Software, Inc., Confidential and Proprietary Information

2-20

PATROL Configuration Manager User Guide

Tree Font Tab


Use the Tree Font tab of the Configure dialog box, shown in Figure 2-5, to set the font displayed in the PATROL Configuration Manager Agent and RuleSet tree views. You can specify the following font information: font font size bold italic
Configure Dialog BoxTree Font Tab

Figure 2-5

BMC Software, Inc., Confidential and Proprietary Information

Getting Started

2-21

Font Settings

The Font Settings define what fonts are use in the Agents and RuleSets tree views. You can specify the following values:
Size

Use the Size box to select the font size.


Font

Use the Font box to select the font you want to use in the tree views.
Bold

Use the Bold check box to select a bold font.


Italic

Use the Italic check box to select an italic font. The Tree Font tab displays a preview of the selected font.

BMC Software, Inc., Confidential and Proprietary Information

2-22

PATROL Configuration Manager User Guide

Working with Configuration Files


You can have more than one PATROL Configuration Manager initialization file, but only one can be opened at one time. The Configure dialog box changes are applied to the PATROL Configuration Manager initialization file that is opened by clicking OK. The initialization file that is used can be specified by the environment variable, CS_INI. If the CS_INI environment variable is not set, the default initialization file is the ChangeSpring.ini file located in the installation directory. However, you can open other initialization files or create new initialization files.

Creating a New Configuration File


To create a new configuration file, click Save As on the Configure dialog box, specify the new file name, and click Save.

Opening a Configuration File


To open a configuration file, use the File => Open menu command on the PATROL Configuration Manager window.

BMC Software, Inc., Confidential and Proprietary Information

Getting Started

2-23

BMC Software, Inc., Confidential and Proprietary Information

2-24

PATROL Configuration Manager User Guide

User Interface and Menu Commands 3


This chapter describes the PATROL Configuration Manager component interface and menu commands. The following topics are discussed: Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2 Menu Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3 File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3 Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4 Tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7 Other . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-8 Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-16 Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-16 Save . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-17 Get Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-17 Apply Changes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-18 Search RuleSets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-18 Agent Tree View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-22 Group Shortcut Menu Commands . . . . . . . . . . . . . . . . . . . . . . . . 3-23 Agent Shortcut Menu Commands . . . . . . . . . . . . . . . . . . . . . . . . 3-26 RuleSet Tree View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-33 RuleSet Folder Shortcut Menu Commands . . . . . . . . . . . . . . . . . 3-34 RuleSet Shortcut Menu Commands. . . . . . . . . . . . . . . . . . . . . . . 3-36 Rule Shortcut Menu Commands . . . . . . . . . . . . . . . . . . . . . . . . . 3-45 Status Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-49 Agent Lock Indicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-49 Operation Status Bar. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-49

BMC Software, Inc., Confidential and Proprietary Information

User Interface and Menu Commands

3-1

Introduction
When you start PATROL Configuration Manager, the main window opens as shown in Figure 3-1. The PATROL Configuration Manager interface consists of the following:
Figure 3-1

menu bar toolbar Agents tree view RuleSets tree view status window agent lock indicator operation status bar

PATROL Configuration Manager User Interface

menu bar toolbar Agents tree view RuleSets tree view

status window agent lock indicator operation status bar

BMC Software, Inc., Confidential and Proprietary Information

3-2

PATROL Configuration Manager User Guide

Menu Bar
The PATROL Configuration Manager menu bar contains the following menus: File Queue Tools Other Help

These menus are described in the following sections.

File
The File menu contains commands to modify and open PATROL Configuration Manager configurations as well as exiting PATROL Configuration Manager. The File menu contains the following menu commands:
Save

Save Open Configure Exit

The Save command saves changes to agents, groups, RuleSets, and configuration settings in the PATROL Configuration Manager configuration files. Configuration changes are saved to the configuration file that is currently open. The agent and group information is saved to the agents.ini and groups.ini files in the PATROL Configuration Manager Ini folder defined in the configuration file. For more information on configuration files, see Configuration on page 2-15. The Save command is also executed using the toolbar. See Toolbar on page 3-16, for more information on the toolbar.
BMC Software, Inc., Confidential and Proprietary Information

User Interface and Menu Commands

3-3

Open

The Open command opens and loads a configuration file to use as the current PATROL Configuration Manager configuration. The PATROL Configuration Manager configuration file specifies the directories and default settings to use when running PATROL Configuration Manager. ChangeSpring.ini is the default configuration file.
Configure

The Configure command opens the Configure dialog box that is used to change the settings, directories, and files used by PATROL Configuration Manager for storing agent and RuleSets. Default settings are specified during installation in the ChangeSpring.ini file. For more information on configuration settings and the default values, see Appendix A, Configuration Settings. See Configuration on page 2-15 for more information on PATROL Configuration Manager options and the Configure dialog box.
Exit

The Exit command exits PATROL Configuration Manager.

Queue
The Queue menu contains commands for applying agent rules. The Queue menu contains the following commands: Clear Apply

The following sections describe the Queue menu commands.

BMC Software, Inc., Confidential and Proprietary Information

3-4

PATROL Configuration Manager User Guide

Clear

The Clear command clears all rules waiting to be applied to agents. Agents that have rules that are not applied yet have their icon highlighted in red in the agent tree view.
Note

If you exit PATROL Configuration Manager, the queue is also cleared.

Apply

The Apply menu command transfers all rules waiting to be applied to the PATROL Configuration Manager queue folder for processing. The Apply command can also be executed using the toolbar. See Toolbar on page 3-16, for more information on the toolbar. After selecting Apply, the Apply RuleSets dialog box opens as shown in Figure 3-2.
Figure 3-2 Apply RuleSets Dialog Box

The Overwrite Localized Settings option is unavailable unless the rules being applied contain a rule that is the same as a localized rule on an agent.

The Agents Selected text box indicates the number of agents that have rules that need to be applied. To view a list of the agents with rules to apply, click Show Agents to open the Agents List dialog box shown in Figure 3-3 on page 3-6.

BMC Software, Inc., Confidential and Proprietary Information

User Interface and Menu Commands

3-5

Figure 3-3

Agents List Dialog Box

You can remove agents from the list by selecting the agent and clicking Remove Agent. When an agent is removed from the list, the rules that are waiting to be applied are also cleared for the agent. See Clear on page 3-5 for more information on clearing rules that are waiting to be applied.
Apply Options

When rules are applied to an agent, you have several options for handling the existing agent configurations: Overwrite localized Settings If an agent that you are applying RuleSets to has a localized rule that is the same as one of the rules you are applying, you can select this option to overwrite the localized rule with the applied rule. This option is typically available when there is a localized rule that matches a rule being applied. See Local RuleSets on page 4-20 for more information on localized rules. Purge Agents Before Apply Purging agents before applying RuleSets is useful when you are resetting an agent configuration to a previous version. If the purge option is not selected, the applied rules are combined with the agents current rules.

BMC Software, Inc., Confidential and Proprietary Information

3-6

PATROL Configuration Manager User Guide

Backup Agents Before Apply Agent configurations are retrieved and saved in the PATROL Configuration Manager backup folder prior to the application of new rules. If you make an error applying RuleSets, backups can be used to restore an agent to a previous configuration.
Note

Purging an agents configuration reverts the agent back to its default configuration, deleting any changes that have been previously applied. If both options are selected, the backup occurs before the purge.

Tools
The Tools menu contains commands for manipulating PATROL Agents. The Tools menu contains the following commands: Reload Agent... Purge Agent... Reinitialize Agent... Kill Agent... Update License...

Before choosing a command from the Tools menu, select one or more agents in the agent tree view to execute the command on. The following sections describe the Tools menu commands.
Reload Agent...

The Reload command forces a reload of the selected agents config.default file and the agents change configuration file.
Purge Agent...

The Purge command purges all non-default or changed agent configuration variables for the selected agents.

BMC Software, Inc., Confidential and Proprietary Information

User Interface and Menu Commands

3-7

Reinitialize Agent...

The Reinitialize Agent command restarts the selected agents.


Kill Agent...

The Kill Agent command stops the selected agents.


Update License...

The Update License command applies a PATROL license file to the selected PATROL Agents.

Other
The Other menu contains commands to manipulate the PATROL Configuration Manager display windows. The Other menu contains the following commands: Refresh RuleSets Clear Status Window View job Status Display Tooltips ApplyOnNew Activated

The following sections describe the Other menu commands.


Refresh RuleSets

The Refresh RuleSets command forces a refresh of the entire RuleSet tree view. The refresh collapses open folders. This command is useful after installing new RuleSets while PATROL Configuration Manager is running.
Clear Status Window

The Clear Status Window command clears the Status window at the bottom of the PATROL Configuration Manager window.

BMC Software, Inc., Confidential and Proprietary Information

3-8

PATROL Configuration Manager User Guide

View Job Status

The View Job Status command displays the Job Status Information dialog box as shown in Figure 3-4.
Figure 3-4 Job Status Information Dialog Box

The Job Status Information dialog box shows the status of the last completed task. A permanent status summary can be obtained from the PATROL Configuration Manager log file that is specified in the PATROL Configuration Manager initialization file. The default log file is ChangeSpring.log located in the installation directory.
Note

Select the Redisplay when updated check box to have the Job Status Information dialog box open whenever the job status information is updated. If the Redisplay when updated check box is not selected the Job Status Information dialog box is not opened automatically.

BMC Software, Inc., Confidential and Proprietary Information

User Interface and Menu Commands

3-9

Display ToolTips

The Display ToolTips command either turns the ToolTips display on or off depending on the current setting. When Display ToolTips is on, a short description of the rule pops up when the mouse hovers over a rule. Figure 3-5 shows an example of a tooltip:
Figure 3-5 ToolTip Example

ToolTip text

When ToolTips are on, a check mark is displayed next to the Display ToolTips command on the Other menu. Not all rules have ToolTips. ToolTips are stored in the rules.tip file in the PATROL Configuration Manager installation directory. You can create your own ToolTips or edit existing ToolTips by editing the rules.tip file. The format of the ToolTips is documented in the rules.tip file, and you can use the existing ToolTips as examples. If you make changes to the ToolTips, you must restart PATROL Configuration Manager to see the new ToolTips.

BMC Software, Inc., Confidential and Proprietary Information

3-10

PATROL Configuration Manager User Guide

You can add an additional tooltips file that contains your own custom tooltips by creating a file with the same syntax as the rules.tip file and specifying that file as the custom tooltip file using the tips_file_custom configuration variable.See Appendix A, Configuration Settings for more information on the PATROL Configuration Manager configuration variables.
Note

If you use custom tooltips, you should create a custom tooltip file. If you edit the existing rules.tip file, you may lose your customized tooltip text if you upgrade PATROL Configuration Manager. When the rules.tip file contains the same tooltip as a custom tooltip file, PATROL Configuration Manager uses the text in the custom tooltip file.

ApplyOnNew Activated

The ApplyOnNew Activated command either activates or deactivates the ApplyOnNew rules. When ApplyOnNew is activated, any agent that is added to a group with rules in the ApplyOnNew container has the rules in the container applied at the time the agent is added. There is an ApplyOnNew container for the entire agent tree, and each group has an ApplyOnNew container. If ApplyOnNew is activated, the ApplyOnNew command has a check next to it on the Other menu. If ApplyOnNew is deactivated, the ApplyOnNew command does not have a check next to it on the Other menu. In addition to the checks on the Other menu, the ApplyOnNew icons indicate if ApplyOnNew is deactivated by displaying with an X over the icon. Figure 3-6 on page 3-12 shows an example of ApplyOnNew activated and deactivated.

BMC Software, Inc., Confidential and Proprietary Information

User Interface and Menu Commands

3-11

Figure 3-6

ApplyOnNew Activated and Deactivated

ApplyOnNew Activated

ApplyOnNew Deactivated

ApplyOnNew Group Options

If you right click the ApplyOnNew icon and select ApplyOnNew, the Group ApplyOnNew dialog box opens as shown in Figure 3-7:
Figure 3-7 Group ApplyOnNew Dialog Box

Use the Group ApplyOnNew dialog box to manually apply the ApplyOnNew RuleSets to existing agents. You can specify the following options:

BMC Software, Inc., Confidential and Proprietary Information

3-12

PATROL Configuration Manager User Guide

Apply to Agents in Select the groups of agents you want to apply the RuleSets to. You can select the current group or the current groups and all sub groups. Apply All ApplyOnNew Items In... Select the ApplyOnNew items that you want to apply. You can select the items from the current, parent, or sub tree groups. Apply Options The apply options are the same as the regular apply options. See Apply Changes on page 3-18 for more information on the apply options.

ApplyOnNew Agent Options

When you add an agent to the Agent tree view, and you have ApplyOnNew active with rules in the ApplyOnNew container, the Agent ApplyOnNew dialog box opens as shown in Figure 3-8:
Figure 3-8 Agent ApplyOnNew Dialog Box

Use the Agent ApplyOnNew dialog box to set the following ApplyOnNew options:

BMC Software, Inc., Confidential and Proprietary Information

User Interface and Menu Commands

3-13

Apply All ApplyOnNew Items In.. Select the ApplyOnNew items that you want to apply. You can select the items from the current, parent, or sub tree groups. Apply Options The apply options are the same as the regular apply options. See Apply Changes on page 3-18 for more information on the apply options.

ApplyOnApply

ApplyOnApply option specifies a RuleSet that is applied to a group of agents whenever an apply is performed on the agents. The ApplyOnApply rules are appended to the end of the apply list when the RuleSets are applied to the agents. If you have RuleSets in the ApplyOnNew container, you can activate the ApplyOnApply by right clicking the RuleSet and selecting ApplyOnApply as shown in Figure 3-9:
Figure 3-9 ApplyOnApply Activated Command

The ApplyOnApply selection only applies to the RuleSet that you selected. If you want all RuleSets in the AppplyOnNew container to be applied on every apply, you must activate each RuleSet. The check in front of the command indicates that ApplyOnApply is activated.

BMC Software, Inc., Confidential and Proprietary Information

3-14

PATROL Configuration Manager User Guide

ApplyOnNew Example

In the Agent tree view in the example shown in Figure 3-10 on page 3-15, there are ApplyOnNew containers for each group folder (Agents, east_ops, so_east, west_ops). The Shipped.Licenses RuleSet is in the ApplyOnNew container in the Agents group. All rules in the Shipped.Licenses RuleSet are applied to new agents that are added to any group since the Agents group is the parent of all groups. The email_rules RuleSet is in the ApplyOnNew container in the east_ops group. All rules in the email_rules RuleSet are applied to new agents that are added to both the east_ops group and the so_east group since so_east is a child of the east_ops group.
Figure 3-10 ApplyOnNew Example

BMC Software, Inc., Confidential and Proprietary Information

User Interface and Menu Commands

3-15

Help
The Help menu command provides information about PATROL Configuration Manager with the About command.
About

The About command displays the PATROL Configuration Manager version and copyright information.

Toolbar
The PATROL Configuration Manager toolbar contains four buttons that provide quick access to common PATROL Configuration Manager commands. The PATROL Configuration Manager toolbar is shown in Figure 3-11.
Figure 3-11 PATROL Configuration Manager Toolbar
Save Apply Changes

Get Configuration

Search RuleSets

This section describes the following toolbar buttons: Save Get Configuration Apply Changes Search RuleSets

BMC Software, Inc., Confidential and Proprietary Information

3-16

PATROL Configuration Manager User Guide

Save
The Save button saves changes made to agents and RuleSets to the directories specified in the current PATROL Configuration Manager initialization file. Changes are also saved by selecting File => Save from the Menu bar.

Get Configuration
The Get Configuration button creates copies of agent configurations in the PATROL Configuration Manager backup folder that is displayed in the RuleSet tree view. The agent configuration is timestamped with the date and time that the get was performed. To get copies of agent configurations, select one or more agents in the Agent tree view and click the Get Configuration button. Agent configurations can also be retrieved by right-clicking on an agent and choosing Configuration => Get. Figure 3-12 shows the backup folder in the RuleSets tree view after the Get Configuration button was used to get the configuration of agent Agent_5__bmc_com at 11:54:50 on August 13, 2003. The agent configuration is saved as RuleSet 20030813-115450 in the Agent_5__bmc_com folder in the Agent_1__bmc_com - Agent_5__bmc_com virtual folder.
Figure 3-12 Configuration - Get Example
virtual folder

agent configuration backup

BMC Software, Inc., Confidential and Proprietary Information

User Interface and Menu Commands

3-17

Apply Changes
The Apply Changes button transfers all rules applied to agents to the PATROL Configuration Manager queue for processing. This action can also be performed by selecting Queue => Apply from the Menu bar. See Apply on page 3-5 for more information on applying changes.

Search RuleSets
The Search RuleSets button searches folders or RuleSets for rule items. A folder or RuleSet must be selected in order to perform a search. When the Search RuleSets button is selected, the RuleSet Search dialog box opens as shown in Figure 3-13.
Figure 3-13 RuleSet Search Dialog Box

BMC Software, Inc., Confidential and Proprietary Information

3-18

PATROL Configuration Manager User Guide

Search parameters enable matching on variable name, operation, and value. For example, to search for all machines that have local targets, enter emailtargetslocal in the Variable text box. To find rules that are applied that prevent email notification from occurring, enter emailtargets in the Variable text box and none in the Value text box. Table 3-1, Search Specifications Check Boxes, on page 3-19 describes the Search Specifications check boxes.
Table 3-1 Field Partial String Match Case Sensitive Search Use Regular Expressions Search Specifications Check Boxes Description matches any rule items that contain the partial string values specified in the search parameters only matching strings with matching case are included in the result set allows entering regular expressions as search parameters such as *, [, Appendix B, Supported Regular Expressions for information on supported regular exprssions. Search All Subfolders Search Most Recent Backups Only Return Results With No Matches searches the selected folder and all subfolders underneath it for the rule item (only available if selected item to search is a folder) searches only the most recently saved agent configuration in the backup folders for rule item matches (only available if the selected item is a backup folder or it contains backup folders) when this option is seleted only items that do not match the serach criteria are returned in the results

Once search criteria are specified, click OK to execute the search.

BMC Software, Inc., Confidential and Proprietary Information

User Interface and Menu Commands

3-19

If the search returns more matches than the maximum number of results allowed (5000 by default), the search stops when it reaches the maximum number of results and PATROL Configuration Manager displays the Search Reached Matching Limit dialog box as shown in Figure 3-14:
Figure 3-14 Search Reached Matching Limit Dialog Box

The Search Reached Matching Limit dialog box tells you how many matches you see which is based on your ruleset_max_search_results configuration setting. PATROL Configuration Manager does not tell you how many matches there were because the search stops when it reaches the maximum number. For more information on setting the ruleset_max_search_results configuration variable, see Appendix A, Configuration Settings. When the search is completed, the results are displayed in the Search Results dialog box shown in Figure 3-15 on page 3-21.

BMC Software, Inc., Confidential and Proprietary Information

3-20

PATROL Configuration Manager User Guide

Figure 3-15 Search Results Dialog Box

To go directly to a rule item in the RuleSets Search Results list, double-click the item in the list. Selected rules from the search results can be saved to a new RuleSet, or you can save the list of selected rules to a text file. To save items as a RuleSet, perform the following steps: 1. Select one or more rule items in the list. 2. Click Save Selections. 3. Enter the name of the new RuleSet in the Save Selected Rules dialog box. 4. Click OK to save the new RuleSet in the root RuleSets folder. To save items in a text file report, perform the following steps: 1. Select one or more rule items in the list. 2. Click Save Report. 3. Select the fields to include in the report in the Report Options... dialog box, and click OK. 4. Specify the file name and location of the report with the Save dialog box.

BMC Software, Inc., Confidential and Proprietary Information

User Interface and Menu Commands

3-21

Agent Tree View


The Agent tree view displays the agents and agent groups that are configured for PATROL Configuration Manager. Groups can contain sub-groups and agents can be copied to multiple groups. Groups and agents can be copied and moved using standard Windows Explorer controls, such as drag and drop.
Note

Agent and group definitions are stored in the agents.ini and groups.ini files. If you want to use different agents and groups with different configurations, you must specify a new Ini folder in the PATROL Configuration Manager Configure dialog box for each configuration. See Configuration on page 2-15 for more information on configuring PATROL Configuration Manager. Most commands that you execute against agents and groups are accessed using the right-click shortcut menus. To access the menus select one or more agents or groups and right click. The following sections describe the Agent and Group shortcut menus.

BMC Software, Inc., Confidential and Proprietary Information

3-22

PATROL Configuration Manager User Guide

Group Shortcut Menu Commands


In the Agent tree view you can execute group commands using the Group shortcut menu. Right click on a group in Agent tree view to open the Group shortcut menu shown in Figure 3-16.
Figure 3-16 Group Shortcut Menu

Some commands can be executed on more than one group at a time. To select multiple groups, press and hold Ctrl while you click all the groups you want to work with. After you have selected the groups, continue to hold Ctrl and right click one of the selected groups and choose the appropriate command. The Group shortcut menu contains the following commands: Properties New (Agent or Group) Delete Paste Configuration (Get or Purge) Search (Agents or Backups)

The following sections describe the Group shortcut menu commands.


Properties

Use the Properties command to open the Group Properties dialog box for changing the group name. The Properties command is only available when one group is selected.

BMC Software, Inc., Confidential and Proprietary Information

User Interface and Menu Commands

3-23

New

Use the New menu commands to create new agent groups or add agents to the Agent tree view. See Agents and Groups on page 4-2 for more information on adding agents and groups.
Delete

Use the Delete command to delete all selected groups. When a group is deleted, all agents and sub-groups of the selected group are also deleted. If there are configuration backups for any of the agents within the selected groups, the Agent Backups dialog box prompts you to keep the backups, delete the backups too, or cancel.
Paste

Use the Paste command to paste agents that have been cut or copied using the agent shortcut menu into the selected group. You cannot copy groups.
Configuration

Use the Configuration menu to Get and Purge agent configurations. The Get command retrieves the configurations for all agents in the selected group and saves them in the PATROL Configuration Manager backup folder that is displayed in the RuleSet tree view. The backup agent configurations are timestamped with the date and time that the Get was performed. See Get Configuration on page 3-17 for more information on the Get command. The Purge command purges the configuration of all agents in the selected group.

BMC Software, Inc., Confidential and Proprietary Information

3-24

PATROL Configuration Manager User Guide

Search

Use the Search command to search for agents or backup RuleSets.


Agents

Use the Search => Agents command to search the group folder and any subfolders within the group folder for agents with properties (hostname, display name, port, protocol) specified in the Agent Search dialog box.
Note

To perform a search for an agent within the entire agent tree, choose the Search command from the Group shortcut menu on Agents group folder or choose the Search command from the Agent shortcut menu by right-clicking on an agent.
Rulesets

Use the Search => Backups command to search folders or RuleSets for rule items. See Search RuleSets on page 3-18 for more information on the search command.

BMC Software, Inc., Confidential and Proprietary Information

User Interface and Menu Commands

3-25

Agent Shortcut Menu Commands


In the Agent tree view you can execute agent commands using the Agent shortcut menu. Right click on an agent in the Agent tree view to open the Agent shortcut menu shown in Figure 3-17.
Figure 3-17 Agent Shortcut Menu

Some commands can be executed on more than one agent at a time. To select multiple agents, press and hold Ctrl while you click all the agents you want to work with. After you have selected the agents, continue to hold Ctrl and right click one of the selected agents and choose the appropriate command. The Agent shortcut menu contains the following commands: Properties Clear Delete Copy Cut Paste Configuration (Get, Purge, and ApplyOnNew) Search (Agents or Backups) Event Management (Alert Settings, Parameter Settings, and What If...)

The following sections describe the Agent shortcut menu commands.


BMC Software, Inc., Confidential and Proprietary Information

3-26

PATROL Configuration Manager User Guide

Properties

Use the Properties command edit the following agent properties: Hostname Display Name Port Protocol

The Properties command is only available when one agent is selected.


Clear

Use the Clear command to clear all rules that have not yet been applied to the selected agents.
Delete

Use the Delete command to delete the selected agents. If there are copies of the agent, PATROL Configuration Manager prompts you to delete the copies too. If you delete the agent and all copies, and the agent has configuration backups or localized RuleSets, PATROL Configuration Manager prompts you to delete the backups and localized RuleSets.
Copy/Cut/Paste

Use the Copy, Cut, and Paste commands to copy, cut, and paste agents within the Agent tree view.
Configuration

Use the Configuration menu to Get and Purge agent configurations and apply ApplyOnNew RuleSets. The Get command retrieves the configurations for all the selected agents and saves them in the PATROL Configuration Manager backup folder that is displayed in the RuleSet tree view. The backup agent configurations are timestamped with the date and time that the Get was performed. See Get Configuration on page 3-17 for more information on the Get command.

BMC Software, Inc., Confidential and Proprietary Information

User Interface and Menu Commands

3-27

The Purge command purges the configuration of all selected agents. The ApplyOnNew command reapplies all rules to the agent that are in the RuleSets in the ApplyOnNew container in the selected agents immediate and parent groups.

Search

Use the Search command to search for agents or backup RuleSets.


Agents

Use the Search => Agents command to search the group folder and any subfolders within the group folder for agents with properties (hostname, display name, port, protocol) specified in the Agent Search dialog box.
Note

To perform a search for an agent within the entire agent tree, choose the Search command from the Group shortcut menu on Agents group folder or choose the Search command from the Agent shortcut menu by right-clicking on an agent.
Rulesets

Use the Search => Backups command to search folders or RuleSets for rule items. See Search RuleSets on page 3-18 for more information on the search command.

BMC Software, Inc., Confidential and Proprietary Information

3-28

PATROL Configuration Manager User Guide

Event Management

Use the Event Management menu to create Event Management (EventSpring) rules without using the PATROL console or the New Rule command on the RuleSet shortcut menu. The Event Management menu contains the following commands: Alert Settings sets Event Management rules such as blackouts and message rewording Parameter Settingssets parameter thresholds and polltimes What If...simulates rule lookup behavior. Rule lookup includes both the sequence in which rules are used and the rule lookup order

Once an Event Management rule is created using either the Alert Settings or Parameter Settings dialog box, the rule appears in the Agent tree view under the selected agent, but the rule is not applied to the agent until you apply it. The rule can be saved to an existing RuleSet in the RuleSet tree view and then applied to agents or groups. The following sections provide an overview of the Event Management commands. See Chapter 5, Event Management Commands for more information on Event Management commands.

BMC Software, Inc., Confidential and Proprietary Information

User Interface and Menu Commands

3-29

Alert Settings

Use the Alert Settings command to set Event Management alert properties. The Alert Settings command opens the Alert Settings dialog box as shown Figure 3-18.
Figure 3-18 Alert Settings Dialog Box

The Alert Settings dialog box contains tabs for setting Event Management alert settings. See Chapter 5, Event Management Commands for more information on Event Management commands.

BMC Software, Inc., Confidential and Proprietary Information

3-30

PATROL Configuration Manager User Guide

Parameter Settings

Use the Parameter Settings command to set parameter thresholds and polltimes. The Parameter Settings command opens the Parameter Settings dialog box as shown Figure 3-19.
Figure 3-19 Parameter Settings Dialog Box

See Chapter 5, Event Management Commands for more information on Event Management commands.

BMC Software, Inc., Confidential and Proprietary Information

User Interface and Menu Commands

3-31

What If...

Use the What If... command to test or simulate PATROL KM for Event Management configurations as they pertain to notification rules. The What If... command opens the What If dialog box as shown Figure 3-20.
Figure 3-20 What If... Dialog Box

What If tests are performed by PATROL Configuration Manager using agent backup configurations or a special What If... (whatif.cfg) RuleSet stored in the agent backup directory. See Chapter 5, Event Management Commands for more information on Event Management commands.

BMC Software, Inc., Confidential and Proprietary Information

3-32

PATROL Configuration Manager User Guide

RuleSet Tree View


The RuleSet tree view displays the RuleSets and RuleSet folders that are configured. RuleSet folders can contain sub-folders. Folders and RuleSets can be copied and moved using standard Windows Explorer controls, such as drag and drop, or cut, copy, and paste. Several RuleSet folders are provided with PATROL Configuration Manager and are in the RuleSet tree view by default. The default RuleSet folders are described in Table 3-2.
Table 3-2 Default RuleSet Folders Description contains backups of agent configurations The backup directory is specified by the PATROL Configuration Manager backup_dir configuration setting. ChangeSpring/local contains localized agent configurations The local directory is specified by the PATROL Configuration Manager local_dir configuration setting. See Local RuleSets on page 4-20 for more information on localized RuleSets. ChangeSpring/queue contains rules that are queued to be applied The queue directory is specified by the PATROL Configuration Manager queue_dir configuration setting. ChangeSpring/tlog contains the history of changes that were made to each agent The tlog directory is specified by the PATROL Configuration Manager tlog_dir configuration setting. shipped contains sample RuleSets and pre-packaged RuleSets for other products.

RuleSet Folder ChangeSpring/backup

BMC Software, Inc., Confidential and Proprietary Information

User Interface and Menu Commands

3-33

RuleSet Folder Shortcut Menu Commands


In the RuleSet tree view you can execute RuleSet folder commands using the RuleSet Folder shortcut menu. Right click on a RuleSet folder in the RuleSet tree view to open the RuleSet Folder shortcut menu shown in Figure 3-21.
Figure 3-21 RuleSet Folder shortcut Menu

Some commands can be executed on more than one RuleSet folder at a time. To select multiple folders, press and hold Ctrl while you click all the folders you want to work with. After you have selected the folders, continue to hold Ctrl and right click one of the selected folders and choose the appropriate command. The RuleSet Folder shortcut menu contains the following commands: New (Folder and RuleSet) Copy Cut Paste Rename Delete Refresh Search

The following sections describe the RuleSet Folder shortcut menu commands.

BMC Software, Inc., Confidential and Proprietary Information

3-34

PATROL Configuration Manager User Guide

New

Use the New command to create a new folder or RuleSet in the selected folder.
Copy/Cut/Paste

Use the Copy, Cut, and Paste commands to copy, cut, and paste folders in the RuleSet tree view.
Rename

Use the Rename command to rename the selected folder.


Delete

Use the Delete command to delete the selected folders.


Refresh

Use the Refresh command to refresh the display of RuleSets for the selected folder and its sub-folders. You may need to refresh a folder if RuleSets are added, removed, or modified outside of the PATROL Configuration Manager interface while PATROL Configuration Manager is running.
Search

Use the Search command to search the selected folder for rule items that match specific search criteria. A search can also be performed by clicking the Search RuleSets button on the Toolbar under the Main Menu Bar. See Search RuleSets on page 3-18 for more information on the search command.

BMC Software, Inc., Confidential and Proprietary Information

User Interface and Menu Commands

3-35

RuleSet Shortcut Menu Commands


In the RuleSet tree view you can execute RuleSet commands using the RuleSet shortcut menu. Right click on a RuleSet in the RuleSet tree view to open the RuleSet shortcut menu shown in Figure 3-22.
Figure 3-22 RuleSet Shortcut Menu

Some commands can be executed on more than one RuleSet at a time. To select multiple RuleSets, press and hold Ctrl while you click all the RuleSets you want to work with. After you have selected the RuleSets, continue to hold Ctrl and right click one of the selected RuleSets and choose the appropriate command. The section describe the following RuleSet shortcut menu commands:
3-36

Edit (Source and Rules) New Rule Copy Cut Paste Rename Delete Comment Compare Search Search Backups Sort

BMC Software, Inc., Confidential and Proprietary Information

PATROL Configuration Manager User Guide

Edit

Use the Edit menu to edit the selected RuleSet. There are two commands on the Edit menu: Sourcedirect editing of the RuleSet using a text editor Rulesediting of the RuleSet in a table form

Source

When you choose the Source command the Edit Configuration Source File dialog box opens as shown in Figure 3-23.
Figure 3-23 Edit Configuration Source File Dialog Box

You can edit the source and save your changes by clicking OK.
Note

The Edit Configuration Source File dialog box does not provide syntax checking, so you should not edit the source unless you are an experienced user.

BMC Software, Inc., Confidential and Proprietary Information

User Interface and Menu Commands

3-37

Rules

When you choose the Rules command the RuleSet dialog box opens as shown in Figure 3-24.
Figure 3-24 RuleSet Dialog Box

Use the RuleSet dialog box to edit the following values: variables operations values

You can edit the values by clicking the value in the table and entering or selecting a new value. You can also edit the value by selecting a row in the table and clicking Edit Value to open the Edit Rule/Value dialog box as shown in Figure 3-25 on page 3-39.

BMC Software, Inc., Confidential and Proprietary Information

3-38

PATROL Configuration Manager User Guide

Figure 3-25 Edit Rule Variable Dialog Box

Event Management Rules When you click Edit Value and you have an Event Management rule selected, a different dialog box opens. An example of an Event Management rule dialog box is shown in Figure 3-26 on page 3-40. Event Management rules have predefined dialog box tabs that are displayed when you choose the Event Management menu command on the Agent shortcut menu, the same dialog associated with the Event Management menu command opens when you click Edit Value for an Event Management rule.

BMC Software, Inc., Confidential and Proprietary Information

User Interface and Menu Commands

3-39

Figure 3-26 Edit Value for Event Management Rule Example

Note

Only the rule value can be edited for an Event Management rule when the dialog is displayed by selecting the Edit Value button. Objects cannot be added or removed.

BMC Software, Inc., Confidential and Proprietary Information

3-40

PATROL Configuration Manager User Guide

New Rule

Use the New Rule command to insert a new rule into the selected RuleSet. When you choose the New Rule command, the RuleSet dialog box opens for you to create a new rule. The RuleSet dialog box is the same as the RuleSet dialog shown in Figure 3-24 on page 3-38 except it is blank so you can enter a new rule. Event Management rules can also be created by selecting the Event Management command from the Agent popup menu.
Copy/Cut/Paste

Use the Copy, Cut, and Paste commands to copy, cut, and paste RuleSets to folders in the RuleSet tree view.
Rename

Use the Rename command to rename the selected RuleSet.


Delete

Use the Delete command to delete selected RuleSets.


Comment

Use the Comment command to view and enter comments or information about a RuleSet. Comments are stored in the comments directory specified in the PATROL Configuration Manager configuration file. The default directory is the comments directory located in the PATROL Configuration Manager installation directory. PATROL Configuration Manager provides a change history of modifications that are made to RuleSets in the comments file.

BMC Software, Inc., Confidential and Proprietary Information

User Interface and Menu Commands

3-41

Compare

Use the Compare command to compare the rules that make up two selected RuleSets. The RuleSet Comparison dialog box displays the comparison results as shown in Figure 3-27.
Figure 3-27 RuleSet Comparison Dialog Box

Unique rules from the first selected RuleSet are shown in blue font with a less than (<) symbol in the first column. Unique rules from the second selected RuleSet are shown in red font with a greater than (>) symbol in the first column. Rules that are common to both RuleSets are shown in black with an equal (=) sign in the first column. If the operation or value for a common rule is different in each RuleSet, the rule is displayed twice. The rule variable is displayed in black font, but the different operation or value is displayed in blue for the first RuleSet and red for the second RuleSet. There are several different display options for the comparison results: All Displays all rules for both selected RuleSets. Rules are color coded so that differentiation between the two RuleSets is obvious.

BMC Software, Inc., Confidential and Proprietary Information

3-42

PATROL Configuration Manager User Guide

Different Values displays rules with common names from each RuleSet that have different operations or values Same Values displays common rules from each RuleSet that have the same operations and values First RuleSet displays rules found in the first selected RuleSet First Unique displays the rules in the first selected RuleSet that are not found in the second selected RuleSet or have different operations or values specified Second RuleSet displays rules found in the second selected RuleSet Second Unique displays rules in the second selected RuleSet that are not found in the first selected RuleSet or have different operations or values specified

Rules can be selected from the comparison results and saved as a new RuleSet in the root RuleSets folder by selecting the Save Selection button in the RuleSet Comparison dialog.
Search

Use the Search command to search the selected RuleSet for rule items that match specific search criteria. See Search RuleSets on page 3-18 for more information on searching RuleSets. A search can also be performed by clicking the Search RuleSets button on the toolbar. See Toolbar on page 3-16 for more information on the toolbar.

BMC Software, Inc., Confidential and Proprietary Information

User Interface and Menu Commands

3-43

Search Backups

Use the Search Backups command to search the agent configuration backups for RuleSets that contain the selected RuleSet or some or all of the same rules as the selected RuleSet. When you select the Search Backups command from the RuleSet shortcut menu, the Search Backup RuleSets dialog opens with the selected RuleSet as the source RuleSet used for comparisons as shown in Figure 3-30 on page 3-47.
Figure 3-28 Search Backup RuleSets Dialog Box

Table 3-3 describes the Search Backup RuleSets dialog box options:
Table 3-3 Option Search most recent backup only Show backups not containing selected rulesets Search Backup RuleSets Dialog Box Options Description searches only the most recently saved agent configurations in the backup folders for matches returns backups that do not contain all of the selected RuleSet This option is useful when you want to know which agents do not have a RuleSet applied or which agents may have the RuleSet applied but the RuleSet values have changed.

Sort

Use the Sort command to sort the rules in the selected RuleSet alphabetically. The sort is always is ascending order (A to Z).
BMC Software, Inc., Confidential and Proprietary Information

3-44

PATROL Configuration Manager User Guide

Rule Shortcut Menu Commands


In the RuleSet tree view, you can execute rule commands using the Rule shortcut menu. Right click on a rule in RuleSet tree view to open the Rule shortcut menu shown in Figure 3-29.
Figure 3-29 Rule Shortcut Menu

Some commands can be executed on more than one rule at a time. To select multiple rules, press and hold Ctrl while you click all the rules you want to work with. After you have selected the rules, continue to hold Ctrl and right-click one of the selected rules and choose the appropriate command. The Rule shortcut menu contains the following commands: Edit Rules Copy Cut Paste Delete Duplicate Save As Search Backups

The following sections describe the Rule shortcut menu commands.

BMC Software, Inc., Confidential and Proprietary Information

User Interface and Menu Commands

3-45

Edit Rule

Use the Edit Rule command to open the RuleSet dialog box for editing the selected rule. Figure 3-24 on page 3-38 shows the RuleSet dialog box.
Delete

Use the Delete command to delete one or more selected rules.


Copy/Cut/Paste

Use the Copy, Cut, and Paste commands to copy, cut, and paste selected rules to other RuleSets in the RuleSet tree view.
Duplicate

Use the Duplicate command to create copies of selected rules within the same RuleSet folder. The duplicate command is a short cut to copy and paste a rule into the same RuleSet folder.
Save As

Use the Save As command to save selected rules to a new RuleSet, called NewRuleSet. The RuleSet created by the Save As command is placed in the same folder as the RuleSet of the last selected rule. Once the new RuleSet is created, it can be renamed and moved to any RuleSet folder. This command is useful when creating new RuleSets from an agent configuration that you saved to the backup folder using the Get Configuration command. See Get Configuration on page 3-17 for more information on saving backups of agent configurations.
Search Backups

Use the Search Backups command to search the backup RuleSets for rule items that match specific search criteria. When you select the Search Backups command from the Rule shortcut menu, the RuleSet Search dialog opens with the values of the selected rule as the search parameters as shown in Figure 3-30 on page 3-47.

BMC Software, Inc., Confidential and Proprietary Information

3-46

PATROL Configuration Manager User Guide

Figure 3-30 RuleSet Search Dialog Box

Search parameters enable matching on variable name, operation, and value. Table 3-4 describes the Search Specifications check boxes.
Table 3-4 Field Partial String Match Case Sensitive Search Use Regular Expressions Search Specifications Check Boxes Description matches any rule items that contain the partial string values specified in the search parameters only matching strings with matching case are included in the result set allows entering regular expressions as search parameters such as *, [, See Appendix B, Supported Regular Expressions for more information on supported regular expressions. Search All Subfolders searches the selected folder and all subfolders underneath it for rule item matches Hostname or IP address where agent is running (only available if selected item to search is a folder)

BMC Software, Inc., Confidential and Proprietary Information

User Interface and Menu Commands

3-47

Table 3-4

Search Specifications Check Boxes searches only the most recently saved agent configuration in the backup folders for rule item matches (only available if the selected item is a backup folder or it contains backup folders) returns items that do not match the search criteria

Search Most Recent Backups Only Return Results With No Matches

When the search is complete, the matches are displayed in the Search Results dialog box shown in Figure 3-31.
Figure 3-31 Search Results Dialog Box

To go to a rule in the RuleSet tree view, double-click the item in the Search Results list. To save items as a RuleSet, perform the following steps: 1. Select one or more rule items in the list. 2. Click Save Selections. 3. Enter the name of the new RuleSet in the Save Selected Rules dialog box. 4. Click OK to save the new RuleSet in the root RuleSets folder.

BMC Software, Inc., Confidential and Proprietary Information

3-48

PATROL Configuration Manager User Guide

Status Window
The Status window displays detailed results of PATROL Configuration Manager operations such as apply and get. To clear the Status window, choose Other => Clear Status Window on the menu bar. See Clear Status Window on page 3-8 for more information on the Status window. You can also view a status summary of each operation using the Job Status dialog box. See View Job Status on page 3-9 for more information on the Job Status dialog box.

Agent Lock Indicator


In an environment where multiple users are working with the same agent tree the agent lock indicator shows that a user is either editing the list of agents or groups, and the indicator also shows when the other user has finished editing the Agent tree view and the changes are save. For more information on agent and group locking, see Sharing Agents and Groups on page 4-3.

Operation Status Bar


The operation status bar shows the progress of the current operation. Normally, you only notice the progress status of operations on a large number of agents. If you are performing an operation on just a few agents, the operation normally completes faster than the status bar is updated.

BMC Software, Inc., Confidential and Proprietary Information

User Interface and Menu Commands

3-49

BMC Software, Inc., Confidential and Proprietary Information

3-50

PATROL Configuration Manager User Guide

Working with Agents, Groups, RuleSets, and Rules

This chapter describes how to work with the agents, groups, and RuleSets with the PATROL Configuration Manager component The following topics are discussed: Agents and Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2 Sharing Agents and Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3 Moving and Copying Agents and Groups . . . . . . . . . . . . . . . . . . 4-6 Adding Groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7 Adding Agents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8 Removing Agents and Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10 RuleSets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13 Moving and Copying RuleSets and RuleSet Folders. . . . . . . . . . 4-14 Creating a New RuleSet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15 Creating a RuleSet From an Existing RuleSet. . . . . . . . . . . . . . . 4-17 Deleting RuleSets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18 Local RuleSets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-20 Creating Local Rulesets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-21 Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-22 RuleSet Locking. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-23 Creating a Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-24 Editing a Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-26

BMC Software, Inc., Confidential and Proprietary Information

Working with Agents, Groups, RuleSets, and Rules

4-1

Agents and Groups


This section describes some common tasks for working with agents and groups. The agent and group information is stored in the agents.ini and groups.ini files. If you want to use different agents and groups with different configurations, you must specify a new Ini folder in the PATROL Configuration Manager Configure dialog box for each configuration. See Configuration on page 2-15 for more information on configuring PATROL Configuration Manager. The following topics and tasks are discussed in this section: Agent and Group Locking Moving and Copying Agents and Groups Adding Groups Adding Agents Removing Agents and Groups

BMC Software, Inc., Confidential and Proprietary Information

4-2

PATROL Configuration Manager User Guide

Sharing Agents and Groups


PATROL Configuration Manager supports multiple users sharing one set of agents and groups by locking the agent.ini file or group.ini file when one user is actively changing the agents or groups in the Agents tree view. The lock indicator is displayed in the bottom, left-hand corner of the PATROL Configuration Manager main window, below the Agent tree view.
Lock Types

There are two types of locks: group lockA group lock indicates that another user is editing the PATROL Configuration Manager groups. You cannot edit the groups when a group lock exists, but you can still edit agents in the groups. agent lockAn agent lock indicates that another user is editing the PATROL Configuration Manager agents.
Note

If another user deletes an agent group, PATROL Configuration Manager locks both the agents and groups because it does not know what groups are deleted until the other user saves. If the agents are not locked when a group is deleted by another user, you could add an agent to a group that no longer exists.

BMC Software, Inc., Confidential and Proprietary Information

Working with Agents, Groups, RuleSets, and Rules

4-3

Lock Indicator

PATROL Configuration Manager indicates a lock with a red lock icon in the bottom, left-hand corner of the PATROL Configuration Manager main window. Figure 4-1 shows the lock icon:
Figure 4-1 Lock Indicator

When there is a lock on an agent or group, you can see who has the lock by hovering your cursor over the lock. Figure 4-2 shows the lock indicator tooltip that shows the following information about the lock: lock type (agent or group) date and time the lock was created user name of the lock owner hostname where the lock exists IP address of lock owner
Lock Indicator Tooltip

Figure 4-2

If the agents and groups are locked, both locks are shown. When there is a lock on the agents or groups, the menu commands for editing the agents or groups are unavailable.
Note

Lock indicators are only shown when one or more users are sharing PATROL Configuration Manager configurations, and the lock owner sees no indication of owning the lock.

BMC Software, Inc., Confidential and Proprietary Information

4-4

PATROL Configuration Manager User Guide

Unlock Indicator

PATROL Configuration Manager indicates that the lock owner saved the changes to agents or groups and the lock is released with a yellow unlock icon in the bottom, left-hand corner of the PATROL Configuration Manager main window. Figure 4-3 shows the unlock icon:
Figure 4-3 Unlock Indicator

When the lock is released, your menu commands for editing the unlocked objects are unavailable until you refresh the Agents tree view. Figure 4-4 shows the unlock indicator tooltip that tells you to click the lock icon to refresh the Agents tree view.
Figure 4-4 Unlock Indicator Tooltip

Note

When a lock is released you must reload the PATROL Configuration Manager configuration by clicking the yellow unlock icon or restart PATROL Configuration Manager. When you click the unlock icon, the Reload Configuration confirmation opens as shown in Figure 4-5. Click Yes to reload your PATROL Configuration Manager configuration.
Figure 4-5 Reload Configuration

BMC Software, Inc., Confidential and Proprietary Information

Working with Agents, Groups, RuleSets, and Rules

4-5

Moving and Copying Agents and Groups


Agents and groups can be moved from one group to another using drag and drop features similar to the Windows Explorer interface, or you can use menu commands to copy or move agents and groups:
Note

Drag and drop in the PATROL Configuration Manager interface is a little different than the standard Windows drag and drop. When you are selecting multiple items to drag, you must either continue to hold the mouse button down after you click the last item, or continue hold Ctrl or Shift and click off an object after you select the last item, and then drag the items before releasing the mouse button. In Windows, you can click the last item and release the mouse button, and then click any selected item and drag the group. This does not work in the PATROL Configuration Manager interface. To copy an agent to another group, perform the following steps: 1. Right click the agent, and choose Copy. 2. Right click on the target group, and choose Paste. To move an agent to a group perform the following steps: 1. Right click the agent, and choose Cut. 2. Right click the target group, and choose Paste. You can also drag and drop the agents to a new group.The same agent or group can appear in more than one group. To move groups, you can drag and drop the groups one at a time to a new group.
Note

After making changes to agents, groups or RuleSets, you must select File => Save from the menu bar to save your changes.

BMC Software, Inc., Confidential and Proprietary Information

4-6

PATROL Configuration Manager User Guide

Adding Groups Summary:


In this task you add a new group to the PATROL Configuration Manager Agent tree view.

To Add a Group to the Agent Tree View Step 1

Right click on a group folder in the Agent tree view. The Agent Folder shortcut menu opens.

Step 2

Choose New => Group. The New Group dialog Box opens as shown in Figure 4-6
Figure 4-6 New Group Dialog Box

Step 3

Enter the new group name in the New Group dialog box. The group name cannot contain spaces or periods. Click OK to create the new group. A new group folder is created under the selected group folder. When a new group is created, the ApplyOnNew container is automatically created in the new group folder. ApplyOnNew stores RuleSets and RuleSet folders that are applied automatically when an agent is added to the group or any of groups subgroups. See ApplyOnNew Activated on page 3-11 for more information on ApplyOnNew.

Step 4

BMC Software, Inc., Confidential and Proprietary Information

Working with Agents, Groups, RuleSets, and Rules

4-7

Adding Agents Summary:


In this task you add an agent to a Group in the Agent tree view.

To Add an Agent to a Group in the Agent Tree View Step 1

Right click on the group folder in the Agent tree view. The Agent Folder shortcut menu opens.

Step 2

Choose New => Agent from the Agent Folder shortcut menu. The New Agent dialog box opens as shown Figure 4-7.
Figure 4-7 New Agent Dialog Box

BMC Software, Inc., Confidential and Proprietary Information

4-8

PATROL Configuration Manager User Guide

Step 3

Specify the information for your new agent in the New Agent dialog box. Table 4-1 describes the required information for adding a new agent.
Table 4-1 New Agent Dialog Box Fields

Field
Hostname Display Name

Description
hostname or IP address of PATROL agent name of the agent as it should appear in the PATROL Configuration Manager Agent tree view Default value entered in the Hostname text box

Port

the PATROL Agent port Default 3181 (the default PATROL Agent port)

Protocol

protocol used to communicate with PATROL Agents Default TCP

Note

The default port and protocol values that are used in the New Agent dialog box can be changed by editing the first two lines of the agents.ini file.
Step 4

Click OK to add the agent to the group.

BMC Software, Inc., Confidential and Proprietary Information

Working with Agents, Groups, RuleSets, and Rules

4-9

Removing Agents and Groups Summary:


In this task you remove agents and groups from the PATROL Configuration Manager Agent tree view.

Before You Begin

This tasks assumes you have agents and groups to delete.


To Remove Agents and Groups from the Agent Tree View Step 1

In the Agent tree view, select the agents and groups that you want to delete. To select multiple agents and groups, press and hold Ctrl while you click the agents and groups you want to delete.

Step 2

Continue to hold Ctrl and right click one of the selected agents or groups. The Agent or Group shortcut menu opens as shown in Figure 4-8.
Figure 4-8 Group Shortcut Menu

BMC Software, Inc., Confidential and Proprietary Information

4-10

PATROL Configuration Manager User Guide

Step 3

Choose Delete. The Confirm Delete Items dialog box opens for you to confirm that you want to delete the selected items as shown in Figure 4-9.
Figure 4-9 Confirm Delete Items Dialog Box

Step 4

Click Yes. If any of the agents that are being deleted have backup configurations in the backup folder, the Agent Backups dialog box opens as shown in Figure 4-10.
Figure 4-10 Agent Backups Dialog Box

Step 5

Click the appropriate button:


Yesdelete the backup configurations for the selected items. Nodo not delete the backup configurations for the selected items. Canceldo not delete anything.

If any of the agents that are being deleted have RuleSets in the local folder, the Agent Localized Settings dialog box opens as shown in Figure 4-11 on page 4-12.
BMC Software, Inc., Confidential and Proprietary Information

Working with Agents, Groups, RuleSets, and Rules

4-11

Figure 4-11 Agent Localized Settings Dialog Box

Step 6

Click the appropriate button:


Yesdelete the local RuleSets for the selected items. Nodo not delete the local RuleSets for the selected items. Canceldo not delete anything.

BMC Software, Inc., Confidential and Proprietary Information

4-12

PATROL Configuration Manager User Guide

RuleSets
This section describes how to create, move, and delete RuleSets. A RuleSet is a collection of rules or agent configuration items. RuleSets and RuleSet folders are stored in the RuleSet directory specified in the PATROL Configuration Manager initialization file. The following tasks are presented in this section: Creating a New RuleSet Creating a RuleSet From an Existing RuleSet Deleting RuleSets

In addition to the these tasks, RuleSets and RuleSet folders can be moved from one folder to another using drag and drop features similar to the Windows Explorer interface.
Note

Drag and drop in the PATROL Configuration Manager interface is a little different than the standard Windows drag and drop. When you are selecting multiple items to drag, you must either continue to hold the mouse button down after you click the last item, or continue hold Ctrl or Shift and click off an object after you select the last item, and then drag the items before releasing the mouse button. In Windows, you can click the last item and release the mouse button, and then click any selected item and drag the group. This does not work in the PATROL Configuration Manager interface.

BMC Software, Inc., Confidential and Proprietary Information

Working with Agents, Groups, RuleSets, and Rules

4-13

Moving and Copying RuleSets and RuleSet Folders


RuleSets and RuleSet Folders can be moved from one group to another using drag and drop features similar to the Windows Explorer interface, or you can use menu commands to copy or move RuleSets and RuleSet folders.
Note

You cannot move or copy RuleSets and RuleSet folders at the same time. To copy RuleSets or RuleSet folders to another folder, perform the following steps: 1. Select the RuleSets or RuleSet folders that you want to copy. To select multiple RuleSets or RuleSet folders, press and hold Ctrl while you click the RuleSets or RuleSet folders you want to copy, and continue to hold Ctrl for the next step. 2. Right click on a selected item, and choose Copy. 3. Right click on the target folder, and choose Paste. To move RuleSets or RuleSet folders to another folder, perform the following steps: 1. Select the RuleSets or RuleSet folders that you want to move. To select multiple RuleSets or RuleSet folders, press and hold Ctrl while you click the RuleSets or RuleSet folders you want to move, and continue to hold Ctrl for the next step. 2. Right click on a selected item, and choose Cut. 3. Right click on the target folder, and choose Paste. The same RuleSet or RuleSet folder can appear in more than one folder.
Note

After making changes to agents, groups or RuleSets, you must select File => Save from the menu bar to save your changes.
BMC Software, Inc., Confidential and Proprietary Information

4-14

PATROL Configuration Manager User Guide

Creating a New RuleSet Summary:


In this task you create a new RuleSet folder and RuleSet in the RuleSet tree view.

To Create a New RuleSet Folder Step 1

In the RuleSet tree view, right click on a folder. The RuleSet Folder Shortcut Menu opens.

Step 2

Choose New => Folder from the RuleSet Folder Shortcut Menu shown in Figure 4-12 with the New menu commands expanded.
Figure 4-12 RuleSet Folder Shortcut Menu New Commands

The new folder is created in the selected folder in the RuleSet tree view as shown in Figure 4-13.
Figure 4-13 New RuleSet Folder

Step 3

Edit the NewFolder name by back spacing in the folder name text box and typing a new folder name. Press Enter. If you do not press Enter, the name converts back to NewFolder.

Step 4

BMC Software, Inc., Confidential and Proprietary Information

Working with Agents, Groups, RuleSets, and Rules

4-15

To create a new RuleSet Step 1

In the RuleSet tree view, right click on a folder. The RuleSet Folder Shortcut Menu opens.

Step 2

Choose New => RuleSet from the RuleSet Folder Shortcut Menu shown in Figure 4-12 on page 4-15 with the New menu commands expanded. A new RuleSet, NewRuleSet, is created in the RuleSet tree view as shown in Figure 4-14.
Figure 4-14 New RuleSet

Step 3

Edit the NewRuleSet name by back spacing in the RuleSet name text box and typing a new RuleSet name.
Note

RuleSet names can only contain the underscore and alphanumeric characters (a...z, A...Z, 0...9, and _).
Step 4

Press Enter. If you do not press Enter, the name converts back to NewRuleSet. Now you can create rules or copy rules from other RuleSets into the new RuleSet. See New Rule on page 3-41 for more information on creating rules.

BMC Software, Inc., Confidential and Proprietary Information

4-16

PATROL Configuration Manager User Guide

Creating a RuleSet From an Existing RuleSet Summary:


Step 1

In this task you create a new RuleSet from an existing RuleSet. In the RuleSet tree view, select rules from an existing RuleSet or from an agent configuration in the backup folder. To select multiple rules, press and hold Ctrl while you click the rules you want to include in your new RuleSet. After you have selected the rules, continue to hold Ctrl and right click one of the selected rules to open the Rule shortcut menu shown in Figure 4-15.
Figure 4-15 Rule Shortcut Menu

Step 2

Choose Save As. A new RuleSet is created in the current folder, named NewRuleSet with a copy of the selected rule items. The new RuleSet can be renamed and moved.

BMC Software, Inc., Confidential and Proprietary Information

Working with Agents, Groups, RuleSets, and Rules

4-17

Deleting RuleSets Summary:


In this task you delete RuleSets and RuleSet folders from the RuleSet tree view.

Before You Begin

This tasks assumes you have RuleSets and RuleSet folders to delete.
To Remove RuleSets and RuleSet Folders from the RuleSet Tree View Step 1

In the RuleSets tree view, select the RuleSets and RuleSet folders that you want to delete. To select multiple RuleSets and RuleSet folders, press and hold Ctrl while you click all the RuleSets and RuleSet folders you want to delete.

Step 2

Continue to hold Ctrl and right click one of the selected RuleSets and RuleSet folders. The RuleSets and RuleSet folders shortcut menu opens as shown in Figure 4-16.
Figure 4-16 RuleSet Shortcut Menu

BMC Software, Inc., Confidential and Proprietary Information

4-18

PATROL Configuration Manager User Guide

Step 3

Choose Delete.

The Confirm Delete Items dialog box opens for you to confirm that you want to delete the selected items as shown in Figure 4-17.

Figure 4-17 Confirm Delete Items Dialog Box

Step 4

Click Yes.

BMC Software, Inc., Confidential and Proprietary Information

Working with Agents, Groups, RuleSets, and Rules

4-19

Local RuleSets
Localized RuleSets allow you to specify rules that cannot be changed for an agent. Rule localization provides a method for you to indicate which rules, or agent configuration variables, are specific for a particular agent. Localized RuleSets prevent the accidental application of a global rule from overwriting what is a unique rule applied to an agent. This feature provides a way to keep track of and manage localized changes. The following behaviors apply to local RuleSets: Localized rules are stored in a special RuleSet folder called Local which can contain one RuleSet for each agent, defined by the agent display name. Localized RuleSets contain localized settings that are not overwritten by a global apply. If an agent is renamed the local RuleSet for the agent is renamed to match the new name. If an agent is deleted PATROL Configuration Manager prompts you to delete the related local RuleSet. When PATROL Configuration Manager applies a rule or RuleSet to an agent PATROL Configuration Manager compares all the rules being applied to the rules in the localized RuleSet. PATROL Configuration Manager uses the following behaviors to apply rules that are in the localized RuleSet and the rules being applied to the agent: If the operation is REPLACE, the conflicting rule is removed from the apply set. If the operation is MERGE or APPEND, the rule is moved to the bottom of the apply set so that the REPLACE occurs first. If the operation is DELETE, the rules are moved to the bottom of the apply list (the last rules considered by the agent).

BMC Software, Inc., Confidential and Proprietary Information

4-20

PATROL Configuration Manager User Guide

Creating Local Rulesets Summary:


Before You Begin

In this task you create a local RuleSet for an agent.

This tasks assumes you have an agent without a local RuleSet.


To Create a Local RuleSet Folder Step 1

In the RuleSets tree view, right click the local folder and select New => RuleSet. The New Local RuleSet dialog box opens as shown Figure 4-18.
Figure 4-18 New Local RuleSet Dialog Box

The local folder contains RuleSets that have the same display name as the associated agent. To ensure the RuleSet name matches the agent name, the New Local RuleSet dialog box only provides a list of agents that do not have local RuleSets when you create a new local RuleSet.
Step 2

Select the agent you want to create a local RuleSet for and click OK.

BMC Software, Inc., Confidential and Proprietary Information

Working with Agents, Groups, RuleSets, and Rules

4-21

Rules
A rule is a a set of values that are combined and applied to a PATROL Agent to change the agent configuration. A rule contains the following values: PATROL Agent configuration database variable operation performed on the variable value of the configuration variable that is used during the operation

The following topics and tasks are discussed in this section: RuleSet Locking Creating a Rule Editing a Rule

In addition to the these tasks, rules can be moved from one folder to another using drag and drop features similar to the Windows Explorer interface.

BMC Software, Inc., Confidential and Proprietary Information

4-22

PATROL Configuration Manager User Guide

RuleSet Locking
PATROL Configuration Manager supports multiple users sharing RuleSet folders by locking a RuleSet when one user is editing the RuleSet. There is no visual indication in PATROL Configuration Manager that a RuleSet is locked, but if you try to edit a rule in a RuleSet that is being edited by another user, the File locked dialog box opens as shown in Figure 4-19:
Figure 4-19 File Locked Dialog Box

The File Locked dialog box indicates who owns the lock as well as the time the lock was created and the host name the lock is open from.

BMC Software, Inc., Confidential and Proprietary Information

Working with Agents, Groups, RuleSets, and Rules

4-23

Creating a Rule Summary:


Before You Begin

In this task you create a Rule.

Use the New Rule command to insert a new rule into the selected RuleSet.
To Create a Rule Step 1

In the RuleSets tree view, right click a RuleSet and select New Rule. The RuleSet dialog box opens as shown Figure 4-20.
Figure 4-20 RuleSet Dialog Box

Step 2

Edit the rules properties by clicking the cell in the table and entering or selecting a value. The rule properties are described in Table 4-2, Rule Properties, on page 4-25.

BMC Software, Inc., Confidential and Proprietary Information

4-24

PATROL Configuration Manager User Guide

Table 4-2

Rule Properties

Property
Variable

Description
The variable is the PATROL Agent configuration variable. There are standard PATROL Agent configuration variables and PATROL KMs use the agent configuration variables to store configuration information. The PATROL KM for Event Management stores Event Management Rules as e PATROL Agent configuration variables. The operation that the rule performs on the variable using the specified value. The following operations are available: DELETE deletes the value of the variable and leaves it blank on the agent (Only deletes it if it is there, and the value is not null.) REPLACE replaces the current value of the variable on the agent with the specified value MERGE merges the specified value with the existing value of the variable on the agent APPEND adds the specified value to the existing value of the variable on the agent DELVAR deletes the variable from the PATROL Agent configuration database (This is a short cut for DELETE and REPLACE with a null value.) The value that is used with the operation.

Operation

Value

Note

DELETE, MERGE, and APPEND operations only work with lists of values when the list is comma separated. These operations do not work when the list items are separated by new lines.
Step 3

Click OK to save the new rule.

BMC Software, Inc., Confidential and Proprietary Information

Working with Agents, Groups, RuleSets, and Rules

4-25

Editing a Rule Summary:


To Edit a Rule Step 1

In this task you edit a rule.

In the RuleSets tree view, right click a RuleSet and select one of the following commands:
Edit => Sourcedirect editing of the RuleSet using a text editor Edit => Rulesediting of the RuleSet in a table form Note

If you right click a rule and select Edit, you can edit a single rule using the same steps in Creating a Rule on page 4-24.
Source Editing

When you choose the Source command, the Edit Configuration Source File dialog box opens as shown in Figure 4-21.
Figure 4-21 Edit Configuration Source File Dialog Box

BMC Software, Inc., Confidential and Proprietary Information

4-26

PATROL Configuration Manager User Guide

Edit the source and save your changes by clicking OK.


Note

The Edit Configuration Source File dialog box does not provide syntax checking, so you should not edit the source unless you are an experienced user.
Rules Editing

When you choose the Rules command the RuleSet dialog box opens as shown in Figure 4-22.
Figure 4-22 RuleSet Dialog Box

You can edit the values by clicking the value in the table and entering or selecting a new value. You can also edit the value by selecting a row in the table and clicking Edit Value to open the Edit Rule/Value dialog box as shown in Figure 4-23.

BMC Software, Inc., Confidential and Proprietary Information

Working with Agents, Groups, RuleSets, and Rules

4-27

Figure 4-23 Edit Rule Variable Dialog Box

Step 2

Edit the rule Vales and click OK. See Table 4-2, Rule Properties, on page 4-25 for a description of the rule properties.
Event Management Rules

When you click Edit Value, and you have an Event Management rule selected, a different dialog box opens. An example of an Event Management rule dialog is shown in Figure 4-24. Event Management rules have predefined dialog box tabs that are displayed when you choose the Event Management menu command on the Agent shortcut menu, the same dialog associated with the Event Management menu command opens when you click Edit Value for an Event Management rule.

BMC Software, Inc., Confidential and Proprietary Information

4-28

PATROL Configuration Manager User Guide

Figure 4-24 Edit Value for Event Management Rule Example

Note

Only the rule value can be edited for an Event Management rule when the dialog is displayed by selecting the Edit Value button. Objects cannot be added or removed. See Chapter 5, Event Management Commands for more information on Event Management Commands.

BMC Software, Inc., Confidential and Proprietary Information

Working with Agents, Groups, RuleSets, and Rules

4-29

BMC Software, Inc., Confidential and Proprietary Information

4-30

PATROL Configuration Manager User Guide

Event Management Commands

This chapter describes how to work with the event management commands of the PATROL Configuration Manager component. The following topics are discussed: Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2 Alert Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3 Add and Remove Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4 Show Override Periods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5 Alert Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6 Notification System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7 Notification Blackouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-10 Notification Targets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-11 Alert Resend. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-14 Alert Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-15 Send Reset On Init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-20 Notification Command. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-21 Recovery Action Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-22 Recovery Action Command Type . . . . . . . . . . . . . . . . . . . . . . . . 5-25 Custom Identifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-26 Class Active State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-28 Parameter Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-30 Thresholds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-32 Polltimes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-35 What If.... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-36

BMC Software, Inc., Confidential and Proprietary Information

Event Management Commands

5-1

Overview
The Event Management commands provide an interface with the PATROL KM for Event Management. Use the Event Management commands to create and test Event Management rules without using the PATROL Console or the New Rule command on the RuleSet shortcut menu. The Event Management menu contains the following commands: Alert Settingssets Event Management rules such as blackouts and message rewording Parameter Settingssets parameter thresholds and polltimes What Ifsimulates rule lookup behavior Rule lookup includes both the sequence in which rules are used and the rule lookup order.

Once an Event Management rule is created using either the Alert Settings or Parameter Settings command, the rule appears in the Agent tree view under the selected agent, but the rule is not applied until you apply it to the agent. You can save the rule to a RuleSet in the RuleSet tree view and then apply the rule agents or groups. The following sections describe the Event Management commands.
Note

You must have the PATROL KM for Event Management installed, loaded, and configured on the PATROL Agents that use the Event Management rules if you are using Event Management commands.

BMC Software, Inc., Confidential and Proprietary Information

5-2

PATROL Configuration Manager User Guide

Alert Settings
Use the Alert Settings command to set Event Management alert properties. The Alert Settings command opens the Alert Settings dialog box as shown Figure 5-1.
Figure 5-1 Alert Settings Dialog Box

The Alert Settings dialog box contains tabs for setting Event Management alert settings. The tabs of the Alert Settings dialog box correspond to the alert settings provided by the PATROL KM for Event Management. Normally, you work with one tab at a time when you create alert settings. Each tab is a separate alert setting for the selected agent. Most of the Alert Settings dialog box tabs provide an Add Objects button, a Remove Objects button, and a Show Override Periods button.
BMC Software, Inc., Confidential and Proprietary Information

Event Management Commands

5-3

Add and Remove Objects


The Remove Objects button removes selected objects displayed in the alert setting dialog box so the rule is not applied. Normally, you work with one object at a time in the regular PATROL Console, but the PATROL Configuration Manager alert settings dialog box works with many objects at one time. The Add Objects button opens the Object Selection dialog box shown in Figure 5-2.
Figure 5-2 Object Selection Dialog Box

Use the Object Selection dialog box to select the objects for the alert settings tab. The alert settings on each tab applies to the objects selected on the tab. You can select any level of object from all hosts to a parameter on a host.
Note

You should only select a specific host when you are creating a rule for a notification server.

BMC Software, Inc., Confidential and Proprietary Information

5-4

PATROL Configuration Manager User Guide

The list of objects in the add object list is not a dynamic list of objects from the PATROL Agent. The list of objects is a list of standard PATROL objects, but you can add objects to this list. If the objects you want to work with do not appear in the list of objects, see Chapter 6, Working with PATROL Agents and PATROL Consoles.

Show Override Periods


The Show Override Periods button on the Alert Settings dialog box opens the Override Settings... dialog box shown in Figure 5-3.
Figure 5-3 Override Settings... Dialog Box

Specify periods that you do not want to have the alert settings active for the selected objects. The alert settings are not used during the override periods.

BMC Software, Inc., Confidential and Proprietary Information

Event Management Commands

5-5

Alert Action
Use the Alert Settings dialog boxAlert Action tab to enable notification and recovery actions for selected PATROL objects. Figure 5-4 shows the Alert Settings dialog boxAlert Action tab.
Figure 5-4 Alert Settings Dialog BoxAlert Action Tab

BMC Software, Inc., Confidential and Proprietary Information

5-6

PATROL Configuration Manager User Guide

The following table describes the Alert Action settings.


Setting
Select Action Type

Description
select the object status for the alert settings The following options are supported: ANY_STATUS INFORMATION WARNING ALARM

Allow Recovery Actions

specifies if the PATROL KM for Event Management recovery actions are enabled for the selected objects specifies if the PATROL KM for Event Management performs notification for the selected objects and status

Trigger NOTIFY_EVENT (Perform Notification)

Notification System
Use the Alert Settings dialog boxNotification System tab to specify where notification is performed for the selected PATROL objects. Figure 5-5 on page 5-8 shows the Alert Settings dialog boxNotification System tab.

BMC Software, Inc., Confidential and Proprietary Information

Event Management Commands

5-7

Figure 5-5

Alert Settings Dialog BoxNotification System Tab

The following table describes the Notification System tab settings.

BMC Software, Inc., Confidential and Proprietary Information

5-8

PATROL Configuration Manager User Guide

Setting
Select Action Type

Description
select the object status for the alert settings The following options are supported: ANY_STATUS INFORMATION WARNING ALARM

LOCAL

local notification is performed for the selected objects Notification is performed by the PATROL Agent that is doing the monitoring. This configuration is sufficient for sending e-mail notification, but most systems do not have paging capabilities. Paging usually requires the Remote option. Using the Local option, notification failures have no impact on other systems. Local notification is potentially more reliable since it requires fewer intermediate components (for example, the network connection, the remote notification server). Some disadvantages to using the Local option are Notification scripts and procedures are required on each computer. Most systems are unable to perform paging locally. Notification targets (for example, who is paged or e-mailed) must be maintained for each computer.

REMOTE

remote notification is performed for the selected objects Send alerts to a notification server. You can specify a primary and a backup notification server. If the primary notification server is unavailable, fail-over to the backup notification server is automatically performed. Using Remote, allows for centralized notification and simplifies maintenance of notification settings and procedures. A disadvantage is that the failure of a notification server affects many systems.

LOCAL, REMOTE NONE

both LOCAL and REMOTE notification notification is not performed for the selected PATROL objects

BMC Software, Inc., Confidential and Proprietary Information

Event Management Commands

5-9

Notification Blackouts
Use the Alert Settings dialog boxNotification Blackouts tab to specify periods when you do not want notification to be performed. Figure 5-6 shows the Alert Settings dialog boxNotification Systems tab.
Figure 5-6 Alert Settings Dialog BoxNotification Blackouts Tab

BMC Software, Inc., Confidential and Proprietary Information

5-10

PATROL Configuration Manager User Guide

The following table describes the Notification Blackout tab settings.


Setting
Selected Blackout Periods

Description
the Selected Blackout Periods list shows the periods when notification is not performed for the objects in the Selected Objects list click Add Periods to add blackout periods to the Selected Blackout Periods list select a blackout period in the Selected Blackout Periods list and click Remove Periods to remove the blackout period form the Selected Blackout Periods list

Add Periods Remove Periods

Notification Targets
Use the Alert Settings dialog boxNotification Targets tab to define the notification targets for selected objects. Figure 5-7 on page 5-12 shows the Alert Settings dialog boxNotification Targets tab.

BMC Software, Inc., Confidential and Proprietary Information

Event Management Commands

5-11

Figure 5-7

Alert Settings Dialog BoxNotification Targets Tab

The following table describes the Notification Targets tab settings.

BMC Software, Inc., Confidential and Proprietary Information

5-12

PATROL Configuration Manager User Guide

Setting
Notification Type

Description
select the notification type from the following values: Email Pager Custom Trouble Ticket

Ensure that your notification server is configured to perform the selected Notification Type. Target Notification Types select the target notification types for the selected objects The following local and remote notification types are supported: ANY_STATUS INFORMATION WARNING ALARM ESCALATED You can select more than one value by holding CTRL and clicking multiple selections in the Target Notification Type(s) list. Enter Targets specify the notification targets for the selected objects and notification types Multiple targets are separated by commas.

BMC Software, Inc., Confidential and Proprietary Information

Event Management Commands

5-13

Alert Resend
Use the Alert Settings dialog boxAlert Resend tab to define the number of times the agent resends active alerts. You can configure alarm and warning alerts to have different resend values. Figure 5-8 shows the Alert Settings dialog boxAlert Resend tab.
Figure 5-8 Alert Settings Dialog BoxAlert Resend Tab

BMC Software, Inc., Confidential and Proprietary Information

5-14

PATROL Configuration Manager User Guide

The following table describes the Alert Resend tab settings.


Setting
ALARM Resends WARN Resends

Description
specify the number of times you want alerts resent for alarm and warning conditions Alerts are resent at the interval specified by the PATROL KM for Event Management ResendAlertQueue parameter polling time (10 minute default setting), and the alerts contain the current alert information (parameter value, status, and so on.). A resend value of -1 makes the PATROL KM for Event Management resend outstanding alerts for the selected objects as long as the alert is active.

Alert Messages
Use the Alert Settings dialog boxAlert Messages tab to reword alert messages for selected objects. Build your own alert message for E-mail, pages, trouble tickets, and event notification. Figure 5-9 on page 5-16 shows the Alert Settings dialog boxAlert Messages tab.

BMC Software, Inc., Confidential and Proprietary Information

Event Management Commands

5-15

Figure 5-9

Alert Settings Dialog BoxAlert Messages Tab

The following table describes the Alert Messages tab settings.

BMC Software, Inc., Confidential and Proprietary Information

5-16

PATROL Configuration Manager User Guide

Setting
Select message type(s) to reword

Description
select the message type that you want to reword for the selected objects The following message types are supported: ANY_STATUS INFORMATION WARNING ALARM

Enter Custom Message Text

specify your new message text using a combination of regular text and variables The variables are replaced with the actual values from the associated object that is in the selected state.

Message Variables

The message variable text shown in the bottom of the dialog box is for you to use as a reference when you create your message. The text in the bottom pane is read only and has nothing to do with your new message. You can copy and paste variables from the bottom to use in your message.

The following table describes the message variables you can use to create custom alert messages:
Table 5-1 Alert Message Variables

Variable
%HOSTNAME% %IPADDRESS% %TCP_PORT% %UDP_PORT% %APPCLASS% %APPINSTANCE% %ICON_NAME% %PARENT_INSTANCE% %PARAMETER_NAME% %PARAMETER_STATUS%

Description
hostname of the PATROL Agent IP Address of the PATROL Agent TCP listening port on the PATROL Agent UDP listening port on the PATROL Agent application class name application instance name instance icon name parent instance name parameter name parameter status (ALARM,WARN,OK)

BMC Software, Inc., Confidential and Proprietary Information

Event Management Commands

5-17

Table 5-1

Alert Message Variables

Variable
%PARAMETER_VALUE% %DATE% %TIME% %TIMEZONE% %LAST10%

Description
parameter value date of alert (MM/DD/YYYY) time of alert (HH:MM:SS) time zone on affected system the last 10 parameter values %LAST10% returns up to the last 10 data points (There may not be 10 data points available).

%AVE10% %LAST10TS%

the average of last 10 parameter values the last 10 parameter timestamps The %LAST10TS% values correspond to %LAST10% parameter values and represent the time the parameter value was set. The %LAST10TS% values are in seconds since 00:00:00 GMT, Jan 01, 1970.

%LAST10TP%

the overall time period, in minutes, of the %LAST10% The %LAST10TP% is the difference, in minutes, between the first and last %LAST10TS% values.

%EVENT_ID% %USERDEFINED%

the PATROL Event Manager event ID for the alert the value of variable /_my_%APPCLASS%_%APPINSTANCE%_%PARAMETER_NAME % the PATROL Event Manager event type for the alert the PATROL Event Manager event status for the alert the operating system type the lower threshold of the current alarm range the upper threshold of the current alarm range the custom identifier assigned to object See Custom Identifiers on page 5-26.

%EVENT_TYPE% %EVENT_STATUS% %OS_TYPE% %ALARM_MIN% %ALARM_MAX% %CUSTOM_ID1%

%CUSTOM_ID2%

the custom identifier assigned to object See Custom Identifiers on page 5-26.

BMC Software, Inc., Confidential and Proprietary Information

5-18

PATROL Configuration Manager User Guide

Table 5-1

Alert Message Variables

Variable

Description Variables Available with the PATROL KM for Event Management 2.4.05.02 and Later

%AGENT_VERSION% %EVENT_CATALOG% %EVENT_CLASS% %EVENT_STATUS% %EVENT_SEVERITY% %EVENT_TYPE%

the PATROL Agent version the event catalog name of originating event the event class name of originating event the event status of originating event the event severity of originating event the event type of originating event

Variables Only Available from a Notification Server


%NOTIFY_EVENT_ID% %NOTIFY_EVENT_TYPE% %NOTIFY_EVENT_STATUS% the PATROL Event Manager event id for the NOTIFY_EVENT the PATROL Event Manager event type of the NOTIFY_EVENT the PATROL Event Manager event status of the NOTIFY_EVENT

Example

Specify the following custom message text:


The Oracle server %APPINSTANCE% on %HOSTNAME% is consuming %PARAMETER_VALUE%% CPU (Ave CPU=%AVE10%%)

The following message is sent for notifications:


The Oracle server PROD1 on glamis is consuming 99.55% CPU (Ave CPU=76.54%)

BMC Software, Inc., Confidential and Proprietary Information

Event Management Commands

5-19

Send Reset On Init


Use the Alert Settings dialog box Send Reset On Init tab to specify if the PATROL Agent sends reset alerts when the agent is restarted. Reset alerts are sent for each alert condition (for example, alarm or warning) that existed when the agent was shutdown. This rule does not apply to particular objects, and is not activated by default. Figure 5-10 shows the Alert Settings dialog boxSend Reset On Init tab.
Figure 5-10 Alert Settings Dialog BoxSend Reset On Init Tab

BMC Software, Inc., Confidential and Proprietary Information

5-20

PATROL Configuration Manager User Guide

Notification Command
Use the Alert Settings dialog boxNotification Command tab to specify a script or program to perform notification, such as paging or E-mail. The PATROL KM for Event management contains sample notification scripts located in the PATROL PSL directory. The notification command is typically set at the root (/) object level so that it applies to all PATROL objects, for example, application classes, instances, and parameters with an ALERT status. Figure 5-11 shows the Alert Settings dialog boxNotification Command tab.
Figure 5-11 Alert Settings Dialog BoxNotification Command Tab

BMC Software, Inc., Confidential and Proprietary Information

Event Management Commands

5-21

The following table describes the Notification Command tab settings.


Setting
Enter Notification Command

Description
the path and file to execute for local notification The command must be in the path or you must specify the full path of the notification command on the agent.

Call command using Event Management environment variables only

defines if the command is called with command-line arguments Environmental variables are always available When you call a shell script or a batch program you can pass command-line arguments. However, most operating systems have command size limitations or there are special characters that cause the command to fail. If you are using blat to send e-mail, and you want to send the e-mail to multiple targets, you must use command-line arguments.

Recovery Action Commands


Use the Alert Settings dialog boxRecovery Action Commands tab to specify a script or program that performs recovery procedures pertaining to the selected PATROL objects with an ALERT status. The PATROL KM for Event Management contains sample notification scripts located in the PATROL PSL directory. Figure 5-12 shows the Alert Settings dialog boxRecovery Action Commands tab.

BMC Software, Inc., Confidential and Proprietary Information

5-22

PATROL Configuration Manager User Guide

Figure 5-12 Alert Settings Dialog BoxRecovery Action Commands Tab

The following table describes the Recovery Action Commands tab settings.

BMC Software, Inc., Confidential and Proprietary Information

Event Management Commands

5-23

Setting
Select Status

Description
select the status of objects that require the recovery action command The following status types are supported: ANY_STATUS WARNING ALARM

Enter Recovery Action Command

enter the text of the recovery action command PSL Commands If you are specifying a PSL script file, enter the absolute path to the file on the agent. If you are entering the PSL text, click Edit to enter a multi-line PSL script. Operating System Command The command must be in the path, or you must specify the absolute path to the command. You can use environment variables. You must specify the absolute path for the recovery command when you are specifying a custom command type. Ensure you set the following values if you are using recovery actions: Enable Alert Actions to perform recovery action commands. See Alert Action on page 5-6. Set the command type. See Recovery Action Command Type on page 5-25.

BMC Software, Inc., Confidential and Proprietary Information

5-24

PATROL Configuration Manager User Guide

Recovery Action Command Type


Use the Alert Settings dialog boxRecovery Action Command Type tab to specify the command type (PSL and OS) to use when executing the recovery action command. The AS_CHANGESPRING application class contains a sample PATROL command type. Figure 5-13 shows the Alert Settings dialog boxRecovery Action Command Type tab.
Figure 5-13 Alert Settings Dialog BoxRecovery Action Command Type Tab

Note

The recovery action command type should be set at the same object level as the recovery action command.

BMC Software, Inc., Confidential and Proprietary Information

Event Management Commands

5-25

The following table describes the Recovery Action Command Type tab settings.
Setting
Select Status

Description
select the status of objects that require the recovery action command The following status types are supported: ANY_STATUS WARNING ALARM

Enter Recovery Action Command

enter the command type of the recovery action command The command type must be defined for objects selected for the recovery action. Use PSL for PSL commands.

Custom Identifiers
Use the Alert Settings dialog boxCustom Identifiers tab to assign custom identifiers to PATROL objects. The custom identifiers can be used to associate internally affected applications with PATROL. For example, you may want to add a custom identifier that identifies what part of your infrastructure the object belongs to, like financial_app or production_app. Figure 5-14 on page 5-27 shows the Alert Settings dialog boxCustom Identifiers tab.

BMC Software, Inc., Confidential and Proprietary Information

5-26

PATROL Configuration Manager User Guide

Figure 5-14 Alert Settings Dialog BoxCustom Identifiers Tab

The following table describes the Custom Identifiers tab settings.


Setting
Set Custom Identifier 1 Enter Custom Identifier 1

Description
specifies that you are setting customer identifier 1 the value of custom identifier 1 The identifier cannot contain a comma.

Set Custom Identifier 2 Enter Custom Identifier 2

specifies that you are setting customer identifier 2 the value of custom identifier 2 The identifier cannot contain a comma.

BMC Software, Inc., Confidential and Proprietary Information

Event Management Commands

5-27

Class Active State


Use the Alert Settings dialog boxClass Active State tab to set the active state of selected application classes. Figure 5-15 shows the Alert Settings dialog boxClass Active State tab.
Figure 5-15 Alert Settings Dialog BoxClass Active State Tab

BMC Software, Inc., Confidential and Proprietary Information

5-28

PATROL Configuration Manager User Guide

The following table describes the Class Active State tab settings.
Setting
Disabled Pre Discovery Full Discovery

Description
disables the application class set the application class in pre-discovery mode set the application class in full discovery mode

The Class Active State settings only apply to application classes, and you can only select hosts or application classes using the Add Objects button on this dialog box.

BMC Software, Inc., Confidential and Proprietary Information

Event Management Commands

5-29

Parameter Settings
Use the Parameter Settings command to set parameter thresholds and polltimes. The Parameter Settings command opens the Parameter Settings dialog box as shown Figure 5-16.
Figure 5-16 Parameter Settings Dialog Box

BMC Software, Inc., Confidential and Proprietary Information

5-30

PATROL Configuration Manager User Guide

The Parameter Settings dialog box tabs provide an Add Objects button and a Remove Objects button for adding and removing a parameter. The Remove Objects button removes the selected parameter so the parameter setting is not applied to the parameter. The Add Objects button opens the Object Selection dialog box shown in Figure 5-17.
Figure 5-17 Object Selection Dialog Box

When you access the Object Selection dialog box from the Parameter Settings dialog box, you can only add one parameter because the parameter settings are applied to only one parameter.

BMC Software, Inc., Confidential and Proprietary Information

Event Management Commands

5-31

Thresholds
Use the Parameter Settings dialog boxThresholds tab to set the parameter thresholds. Figure 5-18 shows the Parameter Settings dialog boxThresholds tab.
Figure 5-18 Parameter SettingsThresholds Tab

The following table describes the Thresholds tab settings.

BMC Software, Inc., Confidential and Proprietary Information

5-32

PATROL Configuration Manager User Guide

Setting
Active

Description
specifies if the parameter is active or inactive

Range Tabs
Border Range alarm range limits If it is possible for the parameter to return a value outside the range limits, you can set a border range for information only or as a third-level alert condition that represents either a warning state or an alarm state. The value must be greater than Alarm1 and Alarm2 values If you use the border range as a third-level alert range, you may need to make the maximum range limit lower than you would without the third-level alert. Alarm Range 1 first-level alert condition that typically represents a warning state or an alarm state must be less than Alarm2 values cannot overlap the Alarm2 range cannot fall outside the range limits or border range If you want the parameter to alarm when a low value occurs, choose these settings: Alarm1 for the alarm state Alarm2 for the warning state For example, if you are monitoring CPU utilization of a machine and you want a backup utility to run when utilization is below 5%, you could choose these settings: range limit of 0 to 100% Alarm2 range of 6% to 10% (warning state) Alarm1 range of 0 to 5% (alarm state) Alarm Range 2 second-level alert condition that typically represents a warning state or an alarm state must be greater than Alarm1 values cannot overlap the Alarm1 range cannot fall outside the range limits or border range If you want the parameter to alarm when a high value occurs, choose these settings: Alarm2 for the alarm state Alarm1 for the warning state For example, if you are monitoring users consumption of a servers resources, you could choose these settings: range limit of 0 to 25% Alarm1 range of 20% to 23% (warning state) Alarm2 range of 24% to 25% (alarm state)

BMC Software, Inc., Confidential and Proprietary Information

Event Management Commands

5-33

Setting

Description Range Tab Properties

Enable Alert State

specifies if the range is enabled or disabled the state of the alert when the value of the parameter is outside the specified range Click OK when the result of the range breach is informational for users or non-critical (for example, back up a file when it exceeds a certain size). Click Warning or Alarm to have the parameter undergo a state change when the range is breached. (Use these states when you are using a border alarm as a third-level alert range.)

Trigger Alarm

specifies when the alarm is triggered To discount random spikes in the return values, select After an alarm occurs N times. You must also specify how many consecutive times the alarm range can be breached before the parameter actually alarms in the N text box. Click Immediately on alarm. when you know the value returned is of concern. Click After all recovery actions fail. if you want to be alerted after all recovery actions fail, and the returned value is still within the defined warning or alarm range. number of times range is broken before alarm is triggered If you selected After an alarm occurs N times for the trigger alarm, specify how many consecutive times you want the alarm value returned during parameter execution before the parameter actually alarms.

BMC Software, Inc., Confidential and Proprietary Information

5-34

PATROL Configuration Manager User Guide

Polltimes
Use the Parameter Settings dialog boxPolltimes tab to set the polltime for a selected parameter. Figure 5-19 shows the Parameter Settings dialog boxPolltimes tab.
Figure 5-19 Parameter SettingsPolltimes Tab

Enter the polltime for the selected parameter in minutes.

BMC Software, Inc., Confidential and Proprietary Information

Event Management Commands

5-35

What If...
Use the What If... command to test or simulate PATROL KM for Event Management configurations as they pertain to notification rules. The What If... command opens the What If... dialog box as shown Figure 5-20.
Figure 5-20 What If... Dialog Box

What If tests are performed by PATROL Configuration Manager using the most recent agent backup configuration in the agent backup folder, or if the backup folder of the selected agent or the target notification server contains a whatif RuleSet (whatif.cfg), the special whatif RuleSet is used for the WhatIf simulation. Figure 5-21 shows a whatif rule in the agent backup folder.
Figure 5-21 What If RuleSet

What If RuleSet

BMC Software, Inc., Confidential and Proprietary Information

5-36

PATROL Configuration Manager User Guide

The following table describes the What IF...dialog box options.


Setting
Select Object Select Status Select Time

Description
Click [Click To Select Object] to specify a parameter to use for the What If simulation. Select the parameter status that you want to test with for the What If simulation. Select the time that you want the test to simulate. This option is used for testing blackout periods.

When you click OK PATROL Configuration Manager performs the What If simulation and returns the results in the WhatIf Results... dialog boxResults tab as shown Figure 5-22.
Figure 5-22 What If Results Dialog BoxResults Tab

BMC Software, Inc., Confidential and Proprietary Information

Event Management Commands

5-37

Use the Results tab to view the execution of the rules. The Results tab shows each rule executed during the simulation in the order they are executed. Click Save Report to save the report to a text file.
Note

ToolTips work in the Rule column of the What If Results... dialog box. See Display ToolTips on page 3-10 for more information on ToolTips. The What If dialog boxReport tab shows a text version of the What If report as shown Figure 5-23.
Figure 5-23 What If Results Dialog BoxReport Tab

Click Save Report to save the report to a text file.

BMC Software, Inc., Confidential and Proprietary Information

5-38

PATROL Configuration Manager User Guide

Working with PATROL Agents and PATROL Consoles

This chapter describes how to work with PATROL Agent and PATROL Console settings and import them into the PATROL Configuration Manager component. The following topics are discussed: Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2 AS_CHANGESPRING KM. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2 Loading the AS_CHANGESPRING KM . . . . . . . . . . . . . . . . . . 6-3 Accessing the KM Commands and InfoBoxes . . . . . . . . . . . . . . 6-5 AS_CHANGESPRING KM Menu Commands. . . . . . . . . . . . . . 6-6 PATROL Console Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . 6-18 Importing PATROL Console Desktop Settings . . . . . . . . . . . . . . 6-19

BMC Software, Inc., Confidential and Proprietary Information

Working with PATROL Agents and PATROL Consoles

6-1

Overview
PATROL Configuration Manager includes tools that help you get your PATROL environment into PATROL Configuration Manager. These tools help you turn PATROL Agent configuration information into PATROL Configuration Manager RuleSets and turn PATROL Console desktop configurations into PATROL Configuration Manager agent groups. PATROL Configuration Manager includes the following tools for converting PATROL data into PATROL Configuration Manager information: AS_CHANGESPRING KM PATROL Configuration Manager csmi Utility

AS_CHANGESPRING KM
The AS_CHANGESPRING KM helps you convert your PATROL configurations into PATROL KM for Event Management and PATROL Configuration Manager configurations. The AS_CHANGESPRING KM has the following features and limitations: provides menu commands and an InfoBox supported on Windows and Unix works with the active PATROL Agent namespace does not provide international support
Note

Since the AS_CHANGESPRING KM works with the active PATROL Agent namespace, the KMs that you use with the AS_CHANGESPRING KM must be loaded on the PATROL Agent and active.

BMC Software, Inc., Confidential and Proprietary Information

6-2

PATROL Configuration Manager User Guide

Loading the AS_CHANGESPRING KM Summary:


Before you can begin using the AS_CHANGESPRING KM, you must first load the KM on the PATROL Developer Console. In this task, follow the instructions that apply to your console.

Before You Begin

Start the PATROL Console in Developer mode and connect to the PATROL Agent that you want to get configuration information from.
To Load KMs from the PATROL Console for Microsoft Windows Step 1

From the PATROL Console for Microsoft Windows menu bar, choose File => Load KM. The Load KMs dialog box displays a list of available .kml files. Display .km files instead (equivalent to application classes) by selecting KM Files (*.km) from the drop-down list box.
Note

The AS_CHANGESPRING.km is installed with PATROL Configuration Manager in the utils subdirectory of the installation directory. See Installation on page 2-4 for more information.
Step 2

Select the AS_CHANGESPRING.km file, and click Open. PATROL loads the AS_CHANGESPRING.km on all of the computers listed under PATROLMainMap in the tree view.
Note

Do not commit the AS_CHANGESPRING.km to the connected agents. You only need to load the KM in the PATROL Developer Console to use the AS_CHANGESPRING.km.

BMC Software, Inc., Confidential and Proprietary Information

Working with PATROL Agents and PATROL Consoles

6-3

To Load KMs from the PATROL Console for Unix Step 1

From the PATROL Console for Unix menu bar, choose File => Load KM. The Load KMs dialog box displays a list of available .kml files. Display .km files instead (equivalent to application classes) by changing the filter.
Note

The AS_CHANGESPRING.km is installed with PATROL Configuration Manager in the utils subdirectory of the installation directory. See Installation on page 2-4 for more information.
Step 2

Select the AS_CHANGESPRING.km file, and click Open. PATROL loads the AS_CHANGESPRING.km on all of the computers to which your console is connected.
Note

Do not commit the AS_CHANGESPRING.km to the connected agents. You only need to load the KM in the PATROL Developer Console to use the AS_CHANGESPRING.km.

BMC Software, Inc., Confidential and Proprietary Information

6-4

PATROL Configuration Manager User Guide

Accessing the KM Commands and InfoBoxes


Table 6-1 provides information about how to access KM commands and InfoBoxes from the PATROL Consoles.
Table 6-1 Accessing KM Commands and InfoBoxes

Console
PATROL Console for Microsoft Windows

To access menu commands


In either the Desktop tree tab or work area, right-click a computer or application icon and choose KM Commands from the pop-up menu. In the work area, right-click a computer or application icon to display a pop-up menu that contains KM-specific commands.

To access InfoBoxes
In either the Desktop tree tab or the work area, right-click an application class or parameter icon and choose InfoBox from the pop-up menu. With the middle mouse button, click an application class or parameter icon.

PATROL Console for Unix

Figure 6-1 shows the AS_CHANGESPRING menu commands in the PATROL Console for Microsoft Windows.
Figure 6-1 AS_CHANGESPRING Menu Commands

BMC Software, Inc., Confidential and Proprietary Information

Working with PATROL Agents and PATROL Consoles

6-5

AS_CHANGESPRING KM Menu Commands


The AS_CHANGESPRING KM provides commands for converting PATROL Agent settings into PATROL Configuration Manager settings and RuleSets. The AS_CHANGESPRING KM provides the following command menus: Get Localized Parameters Get Global Parameters Get Global Polltimes Create RuleSet for config.default Create Files for patrol_dir Create Ruleset from CSV File Convert Overrides to EVS Turn Off Alarm Ranges

The following sections describe the AS_CHANGESPRING KM menu commands.


Get Localized Parameters

The Get Localized Parameters commands create a RuleSet for all localized parameters running on a managed system. You can add these localized settings to the local RuleSet for the agent in PATROL Configuration Manager. These commands are very useful for migrating KMs. Normally, when you migrate a KM, you must record the localized settings and reapply them to the new KMs. These command find all the localized thresholds running on an Agent and create a RuleSet equivalent to the thresholds. You can take this new RuleSet and apply it to a new KM to migrate your localized thresholds. You only need to do this once, and then you have the RuleSets to reuse with each new version of the KM. The KM provides the following Get Localized Parameters menu commands: Get Localized Parameters => Create a Ruleset Get Localized Parameters => Store in PATROL Configuration DB

BMC Software, Inc., Confidential and Proprietary Information

6-6

PATROL Configuration Manager User Guide

Create a Ruleset

If you select to Create a Ruleset, the command creates a PATROL Configuration Manager RuleSet file that you can apply to many agents. The name and location of the RuleSet are printed to the system output window after you execute the command. Figure 6-2 shows the RuleSet file name in the PATROL Console System Output window.
Figure 6-2 RuleSet File Name Output

The configuration file has the following naming convention:


host_port_localizedParams.cfg

When you create a RuleSet, you must move the new file from the agent where it is created to the RuleSets directory of PATROL Configuration Manager before you can apply it to agents.
Store in PATROL Configuration DB

You can also store the RuleSet information in the PATROL Agent configuration database on the selected agent instead of creating an external configuration file. The advantage of creating the RuleSet in the PATROL configuration database on the agent is that you do not have to move files around. You can save it to the agent and then do a get on an agent and create a RuleSet from the backup without having to move a file from one host to another.

BMC Software, Inc., Confidential and Proprietary Information

Working with PATROL Agents and PATROL Consoles

6-7

Get Global Parameters

The Get Global Parameters commands create a RuleSet for all of your global thresholds. With these commands you can create RuleSets for all of your thresholds and manage them with PATROL Configuration Manager. The KM provides the following Get Global Parameters menu commands: Get Global Parameters => Create a Ruleset => All Knowledge Modules Get Global Parameters => Create a Ruleset => Select Knowledge Modules Get Global Parameters => Store in PATROL Configuration DB => All Knowledge Modules Get Global Parameters => Store in PATROL Configuration DB => Select Knowledge Modules

Create a Ruleset => All Knowledge Modules

If you select to create a RuleSet, the command creates a PATROL Configuration Manager RuleSet file that you can apply to many agents. The name and location of the RuleSet are printed to the system output window after you execute the command. Figure 6-2 on page 6-7 shows an example of a RuleSet file name in the PATROL Console System Output window. The configuration file has the following naming convention:
host_port_GlobalParms.cfg

When you create a RuleSet, you must move the new file from the agent where it is created to the RuleSets directory of PATROL Configuration Manager before you can apply it to agents.

BMC Software, Inc., Confidential and Proprietary Information

6-8

PATROL Configuration Manager User Guide

Create a Ruleset => Select Knowledge Modules

This command is the same as the Get Global Parameters => Create a Ruleset => All Knowledge Modules command, but you can select the KMs you want to include. Figure 6-3 shows the Select the Knowledge Modules dialog box.
Figure 6-3 Select the Knowledge Modules Dialog Box

Store in PATROL Configuration DB => All Knowledge Modules

This command stores the RuleSet information in the PATROL Agent configuration database on the selected agent instead of creating an external configuration file.

BMC Software, Inc., Confidential and Proprietary Information

Working with PATROL Agents and PATROL Consoles

6-9

Store in PATROL Configuration DB => Select Knowledge Modules

This command is the same as the Get Global Parameters => Store in PATROL Configuration DB => All Knowledge Modules command, but you can select the KMs you want to include. Figure 6-3 on page 6-9 shows the Select the Knowledge Modules dialog box.
Get Global Polltimes

The Get Global Polltimes commands create a RuleSet for all of your global polltimes. With these commands you can create RuleSets for all of your thresholds and manage them with PATROL Configuration Manager. The KM provides the following Get Global Polltimes menu commands: Get Global Polltimes => Create a Ruleset => All Knowledge Modules Get Global Polltimes => Create a Ruleset => Select Knowledge Modules Get Global Polltimes => Create a Ruleset =>Store in PATROL Configuration DB => All Knowledge Modules Get Global Polltimes => Create a Ruleset =>Store in PATROL Configuration DB => Select Knowledge Modules

Create a Ruleset => All Knowledge Modules

If you select to create a RuleSet, the command creates a PATROL Configuration Manager RuleSet file that you can apply to many agents. The name and location of the RuleSet are printed to the system output window after you execute the command. The configuration file has the following naming convention:

host_port_GlobalPolltimes.cfg

When you create a RuleSet, you must move the new file from the agent where it is created to the RuleSets directory of PATROL Configuration Manager before you can apply it to agents.
BMC Software, Inc., Confidential and Proprietary Information

6-10

PATROL Configuration Manager User Guide

Create a Ruleset => Select Knowledge Modules

This command is the same as the Get Global Polltimes => Create a Ruleset => All Knowledge Modules command, but you can select the KMs you want to include. Figure 6-3 on page 6-9 shows the Select the Knowledge Modules dialog box.
Store in PATROL Configuration DB => All Knowledge Modules

This command stores the RuleSet information in the PATROL Agent configuration database on the selected agent instead of creating an external configuration file.
Store in PATROL Configuration DB => Select Knowledge Modules

This command is the same as the Get Global Polltimes => Store in PATROL Configuration DB => All Knowledge Modules command, but you can select the KMs you want to include. Figure 6-3 on page 6-9 shows the Select the Knowledge Modules dialog box.
Create RuleSet for config.default

PATROL Configuration Manager shows you what is different from your PATROL Agent config.default file. However, you may want to manage your config.default file as a RuleSet. PATROL Configuration Manager uses pconfig, and since pconfig only shows you what changed and not all settings, creating a RuleSet from the config.default file allows you to see everything that is set on the agent. Figure 6-2 on page 6-7 shows an example of a RuleSet file name in the PATROL Console System Output window. This command creates the following file on the PATROL Agent:
Default_Config_RuleSet.cfg

BMC Software, Inc., Confidential and Proprietary Information

Working with PATROL Agents and PATROL Consoles

6-11

Create Files for patrol_dir

The Create files for patrol_dir command creates files that define PATROL objects for PATROL Configuration Manager. PATROL Configuration Manager does not have dynamic connections to the PATROL Agent. When you create Event Management rules using PATROL Configuration Manager, and you select the command to add an object, the Add Object list contains a static list of PATROL objects that is created from files installed with PATROL Configuration Manager. The files that create the objects in PATROL Configuration Manager interface are in the following directory:
<install_dir>\patrol

There are many files in this directory. The key file is called application_classes.def which defines all the application classes that are available in the PATROL Configuration Manager event management commands. For each application class listed in the application_classes.def file, there is a file that defines the associated parameters and a file that defines the associated instances. For example, if NT_CPU is an entry in application_classes.def file, the following files define the parameters and instances for NT_CPU:
NT_CPU.prm (parameters) NT_CPU.sid (instances)

The Create files for patrol_dir command opens the Create List dialog box as shown in Figure 6-4 on page 6-13:

BMC Software, Inc., Confidential and Proprietary Information

6-12

PATROL Configuration Manager User Guide

Figure 6-4

Create List Dialog Box

Use the Create List dialog box to specify the output directory for the patrol_dir files.
Note

The output directory must exist on the PATROL Agent or the command fails. The results of the command are printed to the system output window. After you create the new files, move them to the <install_dir>\patrol directory on the PATROL Configuration Manager system. You can merge the new files with the existing object definitions by copying the entries in the new application_classes.def file to the existing application_classes.def file and then copying all the new .prm and .sid files to the <install_dir>\patrol directory. When you copy the files, replace any identical files with the new files because the new files more accurately reflect your environment.

BMC Software, Inc., Confidential and Proprietary Information

Working with PATROL Agents and PATROL Consoles

6-13

Create Ruleset from CSV File

The Create Ruleset from CSV (comma separated values) File command converts a specifically formatted CSV file into a PATROL Configuration Manager RuleSet. The PATROL KM for Event Management Reports command saves PATROL KM for Event Management configurations to a CSV file in the format supported by this command. You can create a CSV file with the PATROL KM for Event Management, edit the CSV file using Microsoft Excel or a text editor, and create a RuleSet for the new settings using the Create Ruleset from CSV File command. The Create Ruleset from CSV File command opens the Get File dialog box as shown in Figure 6-5:
Figure 6-5 Get File Dialog Box

Use the Get File dialog box to specify the CSV file that you are using as input. Specify the location of the CSV file on the PATROL Agent.
Note

The Create Ruleset from CSV File command requires input in the same format as the PATROL KM for Event Management CSV report format. The configuration file is created in the same directory as the other configuration files, and it has the following naming convention:
host_port_ThresholdRuleSet.cfg

BMC Software, Inc., Confidential and Proprietary Information

6-14

PATROL Configuration Manager User Guide

After you create the RuleSet from the CSV file, you can copy it to the PATROL Configuration Manager RuleSets directory and apply it to PATROL Agents.
Convert Overrides to EVS

The Convert Overrides to EVS commands delete operator overrides and create PATROL KM for Event Management rules for all of your operator overrides.
Warning

The operator overrides are removed from the agent. With these commands you can create rules for all of your operator overrides and manage them with PATROL Configuration Manager. The KM provides the following Convert Overrides to EVS menu commands: Convert Overrides to EVS => Create a Ruleset Convert Overrides to EVS => Store in PATROL Configuration DB

Create a Ruleset

If you select to create a RuleSet, the command creates a PATROL Configuration Manager RuleSet file that you can apply to many agents. The name and location of the RuleSet are printed to the system output window after you execute the command. Figure 6-2 on page 6-7 shows an example of a RuleSet file name in the PATROL Console System Output window. The configuration file has the following naming convention:
host_port_overrideParams.cfg

When you create a RuleSet, you must move the new file from the agent where it is created to the RuleSets directory of PATROL Configuration Manager before you can apply it to agents.

BMC Software, Inc., Confidential and Proprietary Information

Working with PATROL Agents and PATROL Consoles

6-15

Store in PATROL Configuration DB

You can also store the RuleSet information in the PATROL Agent configuration database on the selected agent instead of creating an external configuration file.
Turn Off Alarm Ranges

The Turn Off Alarm Ranges commands turn off alarm ranges for all or selected KMs. Sometimes when you first load a new KM, there are many parameters flashing because they are in a warning or alarm state. With this command you can turn off these alarms until you get the correct alarm ranges configured. These commands do not change the alarm ranges; they creates a RuleSet that turns off the alarms by making the alarm ranges inactive.
Note

After you turn the alarm ranges off, you must adjust and activate each parameter individually. The KM provides the following Turn Off Alarm Ranges menu commands: Turn Off Alarm Ranges => Create a Ruleset => All Knowledge Modules Turn Off Alarm Ranges => Create a Ruleset => Select Knowledge Modules Turn Off Alarm Ranges => Create a Ruleset =>Store in PATROL Configuration DB => All Knowledge Modules Turn Off Alarm Ranges => Create a Ruleset =>Store in PATROL Configuration DB => Select Knowledge Modules

BMC Software, Inc., Confidential and Proprietary Information

6-16

PATROL Configuration Manager User Guide

Create a Ruleset => All Knowledge Modules

If you select to create a RuleSet, the command creates a PATROL Configuration Manager RuleSet file that you can apply to many agents. The name and location of the RuleSet are printed to the system output window after you execute the command. Figure 6-2 on page 6-7 shows an example of a RuleSet file name in the PATROL Console System Output window. The configuration file has the following naming convention:
host_port_GlobalParams.cfg

When you create a RuleSet, you must move the new file from the agent where it is created to the RuleSets directory of PATROL Configuration Manager before you can apply it to agents.
Create a Ruleset => Select Knowledge Modules

This command is the same as the Turn Off Alarm Ranges => Create a Ruleset => All Knowledge Modules command, but you can select the KMs you want to include. Figure 6-3 on page 6-9 shows the Select the Knowledge Modules dialog box.
Store in PATROL Configuration DB => All Knowledge Modules

You can also store the RuleSet information in the PATROL Agent configuration database on the selected agent instead of creating an external configuration file.
Store in PATROL Configuration DB => Select Knowledge Modules

This command is the same as the Turn Off Alarm Ranges => Store in PATROL Configuration DB => All Knowledge Modules command, but you can select the KMs you want to include. Figure 6-3 on page 6-9 shows the Select the Knowledge Modules dialog box.

BMC Software, Inc., Confidential and Proprietary Information

Working with PATROL Agents and PATROL Consoles

6-17

PATROL Console Configuration Files


You can import PATROL Console desktop configuration files into PATROL Configuration Manager by converting the PATROL Console desktop files to PATROL Configuration Manager agent.ini and group.ini files and copying the new ini files into your PATROL Configuration Manager ini directory. The PATROL Console desktop files are converted to PATROL Configuration Manager ini files with the csmi utility.
Note

The csmi utility only converts PATROL Console desktop files from the PATROL Console for Windows and the PATROL Console for Unix version 3.5.00 or earlier. If you are using the PATROL Console 3.5.20 or later, you cannot use the csmi conversion utility. The csmi utility converts the PATROL Console desktops files into PATROL Configuration Manager ini files using the following guidelines: Each PATROL Console profile becomes a PATROL Configuration Manager agent group. Each PATROL Agent in a PATROL Console profile is added to the group created for the profile.

The following task shows you how to convert your PATROL Console desktop data and import the data into PATROL Configuration Manager.

BMC Software, Inc., Confidential and Proprietary Information

6-18

PATROL Configuration Manager User Guide

Importing PATROL Console Desktop Settings Summary:


In this task, you convert you PATROL Console desktop configuration into ini files and import the data into PATROL Configuration Manager.

Before You Begin

Ensure you have access to the PATROL cache directory (PATROL_CACHE) where your PATROL Console configuration files are saved.
To Convert Your PATROL Console Desktop Files Step 1 Step 2

Open a command prompt. Change to the utils directory in PATROL Configuration Manager installation directory.
cd installation directory/utils Example cd /opt/bmc/pconfmgr (Unix) cd C:\Program Files\BMC Software\pconfmgr\utils (Windows)

Step 3

Start the csmi utility with the following command:


csmi.csh (Unix) csmi.bat (Windows)

Step 4

Enter the full path of your PATROL cache directory, or press Enter to accept the default. Enter the most frequently used Agent port number, or press enter to accept the default value (3181). Enter the most frequently used protocol (UDP/TCP) for connecting to the PATROL Agent, or press enter to accept the default value (TCP).

Step 5

Step 6

BMC Software, Inc., Confidential and Proprietary Information

Working with PATROL Agents and PATROL Consoles

6-19

Step 7

The csmi utility converts your PATROL desktop configuration files into the following files: groups.ini agents.ini

The new agents.ini and groups.ini files are written to the PATROL Configuration Manager utils directory where you started the csmi utility in Step 3 on page 6-19. If you have additional PATROL cache directories to convert, move the new agents.ini and groups.ini files before you run the csmi utility because it overwrites any agents.ini and groups.ini files that are in the utils directory if you run the utility again.
To Import the Converted Data into PATROL Configuration Manager Before You Begin

Exit PATROL Configuration Manager before you import the converted PATROL Console desktop settings.
Step 1

Copy the agents.ini and groups.ini files from the PATROL Configuration Manager utils directory to the PATROL Configuration Manager ini directory. If you already have agents.ini and groups.ini files in your ini directory, you should backup or rename the existing ini files.

Step 2

If you have desktop settings from several different PATROL Consoles or user profiles, you can manually merge the .ini files, but you must move the ini files out of the utils directory each time you convert a profile, or you overwrite the last one you converted.

BMC Software, Inc., Confidential and Proprietary Information

6-20

PATROL Configuration Manager User Guide

Configuration Settings

This appendix describes the directories, files, and settings used by the PATROL Configuration Manager component. PATROL Configuration Manager configuration values are stored in the ChangeSpring.ini file. Some configuration values are changed using the File => Configure command, and some configuration values are changed by editing the ChangeSpring.ini file.
Note

Prior to performing an upgrade, backup the entire PATROL Configuration Manager installation directory. All configuration values are stored in the PATROL Configuration Manager initialization file, defaulted to ChangeSpring.ini at installation.

BMC Software, Inc., Confidential and Proprietary Information

Configuration Settings

A-1

The following configuration settings are changed using the File=> Configure command on the Menu bar. backup_before_apply backup_dir backup_folder_groups backup_folder_min backup_identical_configurations backups_saved comments_dir errorfile images_dir ini_dir logfile local_dir PATROL Configuration Manager initialization file queue_dir ruleset_dir tlog_dir transactions_saved tree_font_name tree_font_size tree_font_style

BMC Software, Inc., Confidential and Proprietary Information

A-2

PATROL Configuration Manager User Guide

The following configuration settings are changed by editing the ChangeSpring.ini file: evs_menu lock_check_timer message_max_lines message_truncate_lines patrol_dir pconfig_local_port ruleset_max_search_results ruleset_search_items_file search_sleep_delay search_sleep_interval tips_file tips_file_custom threads_delay threads_max
Note

Some of the configuration variables are not be in the ChangeSpring.ini file, and you need to create the variable to set the configuration value. Table A-1, PATROL Configuration Manager Configuration Variables, on page A-3 describes the configuration settings.
Table A-1 PATROL Configuration Manager Configuration Variables

Variable
backup_before_apply

Type
setting

Description
indicates if the agent configuration is backed up before new RuleSets are applied Default Value true

backup_dir

directory

directory that contains agent configuration backups Default Value <install_dir>/rulesets/ChangeSpring/backup

BMC Software, Inc., Confidential and Proprietary Information

Configuration Settings

A-3

Table A-1

PATROL Configuration Manager Configuration Variables

Variable
backup_folder_groups

Type
setting

Description
maximum number of virtual backup folders Default Value 20

backup_folder_min

setting

minimum number of agents in a virtual backup folder before creating a new virtual backup folder Default Value 20

backup_identical_configurations

setting

indicates if agent configurations that are identical to the most recent agent configuration backup are saved Default Value false

backups_saved

setting

maximum number of backups to save for an agent Default Value 5

comments_dir

directory

directory that contains comments for RuleSets Default Value <install_dir>/comments

errorfile

file

file that contains PATROL Configuration Manager error messages Default Value <install_dir>/changespring.err

evs_menu

setting

indicates if the Event Management menu is included on the Agent short cut menu Default Value true

images_dir

directory

directory that contains images used in the PATROL Configuration Manager interface Default Value <install_dir>/images

BMC Software, Inc., Confidential and Proprietary Information

A-4

PATROL Configuration Manager User Guide

Table A-1

PATROL Configuration Manager Configuration Variables

Variable
ini_dir

Type
directory

Description
the directory that contains information about all configured agents (agents.ini) and groups (groups.ini) Default Value <install_dir>/ini

local_dir

directory

the directory that contains the localized agent RuleSets Default Value <ruleset_dir>/ChangeSpring/local

lock_check_timer

setting

determines how often to check for agent and group locks and update the lock information in PATROL Configuration Manager Default Value 1 sec file that contains a log of all operations performed against agents Default Value <install_dir>/ChangeSpring.log

logfile

file

message_max_lines

setting

maximum number of lines displayed in the Status window Default Value 150

message_truncate_lines

setting

number of lines in status buffer before truncating to maximum number of lines in Status Window Default Value 50

PATROL Configuration Manager initialization file

file

the file that contains these variables that define application defaults such as directory and file locations and PATROL Configuration Manager settings Default Value <install_dir>/ChangeSpring.ini

BMC Software, Inc., Confidential and Proprietary Information

Configuration Settings

A-5

Table A-1

PATROL Configuration Manager Configuration Variables

Variable
patrol_dir

Type
directory

Description
directory that contains a static list of PATROL objects Default Value <install_dir>/patrol

pconfig_local_port

setting

defines the local port that PATROL Configuration Manager uses to communicate with PATROL Agents This variable is used when you need to communicate with agents through a firewall where the firewall rules require a host to use a specific port number. When the pconfig_local_port variable is specified, PATROL Configuration Manager single threads all agent operations. If single threading all agent operations is an issue, you can use one .ini file for all agents that you connect to through a firewall and another .ini file for agent connections that are not through a firewall. Default Value randomly assigned port number

queue_dir

directory

contains all rules to be applied Default Value <install_dir>/rulesets/ChangeSpring/queue

ruleset_dir

directory

contains all RuleSet sub-folders and files Default Value <install_dir>/rulesets

BMC Software, Inc., Confidential and Proprietary Information

A-6

PATROL Configuration Manager User Guide

Table A-1

PATROL Configuration Manager Configuration Variables

Variable
ruleset_max_search_results

Type
setting

Description
the maximum number of matches returned by the RuleSet search If the search returns more that the default number, PATROL Configuration Manager opens a dialog box that tell you. Default Value 5000

ruleset_search_items_file

file

contains the persistent settings of the last RuleSet search criteria Default Value <ini_dir>/ruleset_seearch.ini

search_sleep_delay

setting

how long, in milliseconds, that PATROL Configuration Manager sleeps after searching for search_sleep_interval seconds This setting, together with search_sleep_interval is used to limit CPU usage during long searches. Default Value 100 milliseconds

search_sleep_interval

setting

how often, in seconds, that PATROL Configuration Manager sleeps for search_sleep_delay milliseconds This setting, together with search_sleep_delay is used to limit CPU usage during long searches. Default Value 2 seconds

threads_delay

setting

the number of milliseconds PATROL Configuration Manager waits before starting a new thread after a thread is freed Default Value 1000

BMC Software, Inc., Confidential and Proprietary Information

Configuration Settings

A-7

Table A-1

PATROL Configuration Manager Configuration Variables

Variable
threads_max

Type
setting

Description
the maximum number of threads used to perform RuleSet operations like simultaneous apply operations Default Value 20

tips_file

file

the file that contains the tooltips that are displayed when a users mouse is positioned on a rule Default Value <install_dir>/rules.tip

tips_file_custom

file

file that contains custom tooltips that are displayed when a users mouse is positioned on a rule Adds to or overrides definitions in the tips_file. Default Value <install_dir>/rules_custom.tip

tlog_dir

directory

directory where the change history for each agent is stored Default Value <install_dir>/rulesets/ChangeSpring/tlog

transactions_saved

setting

the maximum number of transactions to save in the transaction log Default Value 5

tree_font_name

setting

font type for Agent and RuleSet tree view display Default Value Arial

BMC Software, Inc., Confidential and Proprietary Information

A-8

PATROL Configuration Manager User Guide

Table A-1

PATROL Configuration Manager Configuration Variables

Variable
tree_font_size

Type
setting

Description
font size for Agent and RuleSet tree view Default Value 12

tree_font_style

setting

font style for Agent and RuleSet tree view Valid Values 0 = Regular 1 = Bold 2 = Italic 3 = Italic Bold Default Value 0 (Regular)

BMC Software, Inc., Confidential and Proprietary Information

Configuration Settings

A-9

BMC Software, Inc., Confidential and Proprietary Information

A-10

PATROL Configuration Manager User Guide

Supported Regular Expressions

This appendix describes the supported regular expressions that you can use for searching with the PATROL Configuration Manager component. The regular expression search in PATROL Configuration Manager supports a limited sub-set of regular expressions. Table B-1 lists the regular expression features that are supported by PATROL Configuration Manager.
Table B-1 Supported Regular Expressions

Example
b bc \c

Description
Match any character b, where b is not a special character. Match the occurrence of regular expression b followed by the occurrence of regular expression c. (Concatenation) Match the special character c, where c is any character that has special meaning, for example, \n (new-line character) and \\ (single backslash). There are also character class shortcuts, for example, \b (word boundary), \B (non-word boundary), \w (alpha-numeric), and \W (non-alpha-numeric).

Match the following characters at the beginning of a line. For example, ^abc matches abc only if it is at the beginning of a line.

Match the following characters at the end of a line. For example, abc$ matches abc only if it is at the end of a line.

BMC Software, Inc., Confidential and Proprietary Information

Supported Regular Expressions

B-1

Table B-1

Supported Regular Expressions

Example
.

Description
Match any character. For example, a.c matches a, then any one character, then c. Note that a\.c matches a, then a dot, then c.

[s]

Match a sequence of characters (must be a non-empty set). Ranges may be specified as m-n. The characters ^, -, ], and [ cannot be included in the set. For example, [A-Z], [a-zA-Z], [0-9a-z], and [?.*] The last example, [?.*], matches any string with either a question mark, a dot, a star, or a string containing any combination of the three. Ranges are only valid if the LC_COLLATE category is set to the C locale. If the LC_COLLATE category is not set to the C locale., the effect of using the range notation is unspecified.

[^s] r*

Match strings that do not contain the characters in the set. Match zero or more successive occurrences of the regular expression r. The longest left-most match is returned.

r+

Match one or more successive occurrences of the regular expression r. The longest left-most match is returned.

r?

Match zero or one occurrence of the regular expression r. Without an anchor to the right, this regular expression matches a string containing more than one occurrence, because it contains one occurrence. For example, x? matches x, xx, and xxxxx

BMC Software, Inc., Confidential and Proprietary Information

B-2

PATROL Configuration Manager User Guide

Table B-1

Supported Regular Expressions

Example
r{m,n}

Description
Match any number of m through n successive occurrences of the regular expression r. The regular expression r{m} matches exactly m occurrences, and r{m,} matches at least m occurrences. The maximum number of occurrences is matched. For example, a(1,3} matches the following strings: a, aa, aaa, as well as aaaa, aaaaa, and so on. Since the regular expression looks for one to three occurrences of a at any point in the string, it also matches four occurrences of a. Consider anchoring the end of the string to limit the upper-bound match count. for example, a{1,3}$ or a{1,3}[b-z].

(r)

Specifies the regular expression r is used for grouping. The ( and ) are ignored.

\n

The back-reference expression \n matches the same (possibly empty) string of characters matched by a sub expression enclosed between ( and ) preceding \n. The character n must be a digit between 1 to 9 that defines how many previous sub expressions are matched. The expression is invalid if less than n sub expressions precede the \n. Examples ^(.*)\1$ matches a line consisting of two adjacent appearances of the same string (a)*\1 fails to match a but matches aa (abc)\2 is invalid because there is only one sub expression but two are specified (abc)(efg)\2 is a valid expression The limit of nine back-references to sub expressions is based on the need to have a single digit identifier.

BMC Software, Inc., Confidential and Proprietary Information

Supported Regular Expressions

B-3

Table B-1

Supported Regular Expressions

Example
|

Description
The regular expression OR operator allows for more than one regular expression to match. For example, (abc)|(xyz) matches any item with abc or xyz, or both.

Character classes

A character class expression represents the set of characters belonging to a character class, as listed in the LC_CTYPE category in the current locale. All character classes specified in the current locale are recognized. A character class expression is expressed as a character class name enclosed within bracket-colon ([: :]) delimiters. Imbedding a character class into another character class is not supported. For example, [^[:alnum:]] is not supported. The following character class expressions are supported: [:alnum:] [:cntrl:] [:lower:] [:space: [:alpha:] [:digit:] [:upper:] [:blank:] [:punct:]

BMC Software, Inc., Confidential and Proprietary Information

B-4

PATROL Configuration Manager User Guide

Troubleshooting and Frequently Asked Questions

This appendix provides common troubleshooting tasks and answers to frequently asked questions (FAQs) for the PATROL Configuration Manager. The following topics are discovered: Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .C-2 NT_CPU Polltime Changes are Not Working . . . . . . . . . . . . . . .C-3 PATROL Configuration Manager Does Not Start on Windows. .C-4 PATROL Configuration Manager Does Not Start on Unix . . . . .C-5 KM Parameters are not in the Object Selection List . . . . . . . . . .C-6 Rule Value Length Too Long . . . . . . . . . . . . . . . . . . . . . . . . . . . .C-7 PATROL Configuration Manager Labels Missing. . . . . . . . . . . .C-8 PATROL Configuration Manager Does Not Start on Windows with Abnormal Termination Errors. . . . . . . . . . . . . . . . . . . . . . . . . .C-9 PATROL Configuration Manager Opens an Extra Window . . . .C-10 Frequently Asked Questions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .C-12 How Do I Move PATROL Configuration Manager from Unix to Windows? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .C-13 What is the purpose of the DELVAR operation? . . . . . . . . . . . . .C-13

BMC Software, Inc., Confidential and Proprietary Information

Troubleshooting and Frequently Asked Questions

C-1

Troubleshooting
The following tables list the troubleshooting topics discussed in this section:
Problem
NT_CPU Polltime Changes are Not Working PATROL Configuration Manager Does Not Start on Windows PATROL Configuration Manager Does Not Start on Unix KM Parameters are not in the Object Selection List Rule Value Length Too Long PATROL Configuration Manager Labels Missing PATROL Configuration Manager Does Not Start on Windows with Abnormal Termination Errors PATROL Configuration Manager Opens an Extra Window

Page
C-3 C-4 C-5 C-6 C-7 C-8 C-9 C-10

BMC Software, Inc., Confidential and Proprietary Information

C-2

PATROL Configuration Manager User Guide

NT_CPU Polltime Changes are Not Working


Problem

The NT_CPU parameter polltimes do not change when the collector polltime or the polltime for the individual parameter is changed through PATROL Configuration Manager.
Solution

This problem is related to agents running the NT OS KM. In this version of the NT_OS KM 3.8.xx. The CPUProcessorColl is no longer associated with NT_CPU; it is now associated with NT_CPU_CONTAINER. Since PATROL Configuration Manager is retrieving the information from NT_CPU, the entry has to be manually added, it cannot be added through PATROL Configuration Manager. One of the following entries is necessary depending on the KM version:
NT_OS KM Versions Earlier than 3.8.xx "/AS/EVENTSPRING/PARAM_SETTINGS/POLLTIMES/NT_CPU/__ANYINST__/CPUProce ssorColl/interval" = { REPLACE = "600" }, NT_OS KM Versions 3.8.xx and Later "/AS/EVENTSPRING/PARAM_SETTINGS/POLLTIMES/NT_CPU_CONTAINER/NT_CPU_CON TAINER/CPUProcessorColl/interval" = { REPLACE = "600" },

BMC Software, Inc., Confidential and Proprietary Information

Troubleshooting and Frequently Asked Questions

C-3

PATROL Configuration Manager Does Not Start on Windows


Problem

PATROL Configuration Manager does not start with the following command:
Programs => BMC PATROL => PATROL Configuration Manager

And when you try to start the PATROL Configuration Manager using the ChangeSpring.bat file you receive the following error:
Unable to read file \\<host>\$c\Program Files\BMC Software\pconfmgr\ini\groups.ini Solution

This problem is cause by not being authenticated on the network share where the files are being read from when loading PATROL Configuration Manager. Usually, when trying to map a shared drive or going directly to the remote computer files with UNC, Windows asks for a username/password before it connects to the remote resource. Accessing files from PATROL Configuration Manager is subject to the same restrictions, only there is no way to provide the share username/password when PATROL Configuration Manager tries to access the resources. Instead, access is denied by the operating system and PATROL Configuration Manager cannot read the file. To correct this, do one of the following: Map a shared drive to the location Access that remote machine with a UNC path so Windows prompts for the username/password and connect. After you connect one time, PATROL Configuration Manager accesses the files since Windows previously authenticated the remote computer.

BMC Software, Inc., Confidential and Proprietary Information

C-4

PATROL Configuration Manager User Guide

PATROL Configuration Manager Does Not Start on Unix


Problem

There are several reasons why PATROL Configuration Manager does not start on a Unix platform.
Solutions Explanation
Java is not installed on the system.

Solution
Install the required version of Java for your operating system. See System Requirements on page 2-3 for Java version requirements for PATROL Configuration Manager.

The directory location of the java executable or link is not in the $PATH environment variable. The Java Compiler is running an older version of the java compiler.

Add the directory location of the java executable or link to the $PATH environment variable set in the .profile of the user account. The Java compiler is not required for PATROL Configuration Manager. Set and export the environment variable JAVA_COMPILER=off in the user .profile.

The $PATROL_HOME environment variable is not set for the current process.

Ensure PATROL_HOME is set.

BMC Software, Inc., Confidential and Proprietary Information

Troubleshooting and Frequently Asked Questions

C-5

KM Parameters are not in the Object Selection List


Problem

PATROL Configuration Manager does not have a dynamic connection to the PATROL Agent. So when you are creating Event Management rules using PATROL Configuration Manager, and you select the command to add an object, the Add Object list contains a static list of PATROL objects that created from files installed with PATROL Configuration Manager.
Solution

You can manually edit the files that create the items in the Add Object list. See Create Files for patrol_dir on page 6-12 for more information on adding PATROL objects to the PATROL Configuration Manager object selection dialog boxes.

BMC Software, Inc., Confidential and Proprietary Information

C-6

PATROL Configuration Manager User Guide

Rule Value Length Too Long


Problem

When you create a rule the Rule Value Length dialog box opens as shown in Figure C-1:
Figure C-1 Rule Value Length Dialog Box

Solution

PATROL Configuration Manager opens this dialog box when the agent configuration variable contains more than 1,020 characters. PATROL Agent 3.4.x and earlier do not support more than 1,020 characters for an agent configuration variable. However, PATROL Agent 3.5.00 and later does not have this limitation on the agent configuration variable. If the agent configuration variable is for a PATROL Agent version 3.5 or later, click No. If the agent configuration variable is for a PATROL Agent earlier than version 3.5.00, you have the following options: click Yes This trims the agent configuration variable to 1,020 characters, but you lose all the information that is trimmed. click Cancel This cancels the operation and you can edit the rule to fit into the 1,020 length restriction.

BMC Software, Inc., Confidential and Proprietary Information

Troubleshooting and Frequently Asked Questions

C-7

PATROL Configuration Manager Labels Missing


Problem

Labels in PATROL Configuration Manager do not show up on Unix.


Solution

You may need to change the color preferences in CDE?


To change the colors of your terminal windows on CDE Step 1

From the system console, select the Style Manager icon from the CDE Control Bar. Select the Color Pallet. In the Style Manager - Color dialog box, find the Defaults section. You see at least four colored squares.

Step 2 Step 3

Step 4 Step 5 Step 6

Select the black square or the one on the far right. Click Modify. In the Style Manager - Modify Color window, slide the very bottom slide all the way to the right. The New square in the top-left corner of the window changes to white.

Step 7 Step 8 Step 9

Click OK. Click OK on the Style Manager - Color dialog box. Save your changes and exit CDE.

BMC Software, Inc., Confidential and Proprietary Information

C-8

PATROL Configuration Manager User Guide

PATROL Configuration Manager Does Not Start on Windows with Abnormal Termination Errors
Problem

When starting PATROL Configuration Manager, the following error is returned:


ChangeSpring.jar Assertion failed: offset < fFileSize, file ../../../src/share/native/sun/awt/font/fontmanager/fontobjects/fontOb ject.cpp, line 256 abnormal program termination Solution

This is a generic Java error and not specific to PATROL Configuration Manager. This happens when a bad font is installed in the Windows Fonts directory. This problem has happened with the following font: johnny-b.ttf To see if this font is present, you must view the fonts from a command prompt. If the font is present delete it. This problem can also be caused by non-font files in the Fonts folder. If the Fonts folder in Windows is set up incorrectly, it can cause system-wide problems that affect javaw.exe. The Fonts folder should only contain regular font files. Shortcuts to font files in other locations cause problems in the Fonts folder. If you find a shortcut to a font file in the Fonts folder, locate the font file it is pointing to and copy that font to the Fonts folder, and delete the shortcut. Do this for every shortcut you find in Fonts folder, and reboot the computer.

BMC Software, Inc., Confidential and Proprietary Information

Troubleshooting and Frequently Asked Questions

C-9

PATROL Configuration Manager Opens an Extra Window


Problem

When the PATROL Configuration Manager is started on Microsoft Windows, an extra command prompt window is opened too. If the extra command prompt window is closed, the PATROL Configuration Manager closes.
Solution

To start the PATROL Configuration Manager on Windows without the extra command prompt window, edit the PATROL Configuration Manager Start menu shortcut to use javaw.exe to start the PATROL Configuration Manager. Edit the Start menu shortcut using the Shortcut tab of the Properties dialog box for the PATROL Configuration Manager shortcut. The steps for accessing the properties of the PATROL Configuration Manger shortcut vary depending on your version of Windows, but you can normally open the Properties dialog box by right-clicking the shortcut. On the Shortcut tab of the shortcut property dialog box, change the default value, ChangeSpring.bat, in the target text box to one the following values, replacing C:\Program Files\BMC Software with your actual installation path. For the default ChangeSpring.ini file, use the following target:

"C:\Program Files\BMC Software\pconfmgr\jre\bin\javaw.exe" -Xmx64m -jar ChangeSpring.jar

BMC Software, Inc., Confidential and Proprietary Information

C-10

PATROL Configuration Manager User Guide

For your own .ini file, use the following shortcut target, replacing my.ini with your ini file name:

"C:\Program Files\BMC Software\pconfmgr\jre\bin\javaw.exe" -Xmx64m -DCS_INI="my.ini" -jar ChangeSpring.jar

You can also set your CS_INI environment variable to the absolute path and file name of your .ini file, and use the following shortcut target:

"C:\Program Files\BMC Software\pconfmgr\jre\bin\javaw.exe" -Xmx64m -DCS_INI="%CS_INI%" -jar ChangeSpring.jar

BMC Software, Inc., Confidential and Proprietary Information

Troubleshooting and Frequently Asked Questions

C-11

Frequently Asked Questions


The following tables list the questions discussed in this section:
Problem
How Do I Move PATROL Configuration Manager from Unix to Windows? What is the purpose of the DELVAR operation?

Page
C-13 C-13

BMC Software, Inc., Confidential and Proprietary Information

C-12

PATROL Configuration Manager User Guide

How Do I Move PATROL Configuration Manager from Unix to Windows?


Install PATROL Configuration Manager on the Windows system and ftp the data files over to the respective directories. Everything under the following directories is interchangeable:
./ini ./patrol ./rulesets Note

Do not copy any binaries or ini files that contain path information because the format is different between Windows and Unix.

What is the purpose of the DELVAR operation?


The DELVAR operation in PATROL Configuration Manager deletes the agent configuration variable on the PATROL Agent. The DELVAR operation is actually a short cut for deleting the value of the variable and replacing it with a null value. For example, you want to delete the agent configuration variable called /AgentSetup/testvariable on the PATROL Agent using PATROL Configuration Manager. From PATROL Configuration Manager, you edit the same agent configuration variable and change the operation to DELVAR and click OK. Apply that rule to the PATROL Agent and the agent configuration variable is delete from the agent configuration file.
Note

Before performing the above method, ensure there is a backup copy of the agent configuration variable.

BMC Software, Inc., Confidential and Proprietary Information

Troubleshooting and Frequently Asked Questions

C-13

BMC Software, Inc., Confidential and Proprietary Information

C-14

PATROL Configuration Manager User Guide

Glossary

Glossary

Note: In this glossary, the names of all Microsoft Windows products are referred to as Microsoft Windows or simply Windows. No distinctions are made between various Windows Servers, Windows 2000, and Windows NT.
access control list

A list that is set up by using a PATROL Agent configuration variable and that restricts PATROL Console access to a PATROL Agent. A PATROL Console can be assigned access rights to perform console, agent configuration, or event manager activities. The console server uses access control lists to restrict access to objects in the COS namespace. See PATROL Agent namespace. A PATROL Console feature that constructs SQL-like statements for querying PATROL Agents connected to the console. Agent Query produces a tabular report that contains information about requested objects and can be used to perform object management activities, such as disconnecting and reconnecting computers. Queries can be saved, reissued, added, or changed. PATROL offers built-in queries in the Quick Query command on the Tools menu from the PATROL Console main menu bar. See also Quick Query.

agent namespace Agent Query

BMC Software, Inc., Confidential and Proprietary Information

Glossary

alarm

An indication that a parameter for an object has returned a value within the alarm range or that application discovery has discovered that a file or process is missing since the last application check. An alarm state for an object can be indicated by a flashing icon, depending on the configuration of a console preference. See also warning.
A PATROL object changing status. For example, Ok to Alarm. An alert condition is typically caused by a parameter exceeding a threshold.

alert

alert range

A range of values that serve as thresholds for a warning state or an alarm state. Alert range values cannot fall outside of set border range values. See also border action, border range, and recovery action. The highest-level computer class in PATROL. Attributes assigned to this class will be inherited by all computer classes known to PATROL. See also class and computer class. A specially marked point on a parameter graph that provides detailed information about a parameter at a particular moment. The associated data is accessed by double-clicking the data point, which is represented by a user-specified character (the default is an asterisk) in PATROL 3.x and earlier or by a set bitmap in PATROL Central 7.x. See also parameter. An account that you define at KM setup and that you can change for an application class or instance. An application account is commonly used to connect to an RDBMS on a server where the database resides or to run SQL commands. The interval at which application discovery occurs. The PATROL Agent process cache (as opposed to the system process table) is checked to ensure that all application instances and files previously discovered still exist there. See also application discovery, application discovery rules, prediscovery, process cache refresh, PSL discovery, and simple discovery.

ALL_COMPUTERS class

annotated data point

application account

application check cycle

BMC Software, Inc., Confidential and Proprietary Information

PATROL Configuration Manager User Guide

application class

The object class to which an application instance belongs; also, the representation of the class as a container (Unix) or folder (Windows) on the PATROL Console. You can use the developer functionality of a PATROL Console to add or change application classes. See also class. A PATROL Agent procedure carried out at preset intervals on each monitored computer to discover application instances. When an instance is discovered, an icon appears on the PATROL interface. The application class includes rules for discovering processes and files by using simple process and file matching or PSL commands. Application definition information is checked against the information in the PATROL Agent process cache, which is periodically updated. Each time the PATROL Agent process cache is refreshed, application discovery is triggered. See also application check cycle, application discovery rules, PATROL Agent process cache, prediscovery, PSL discovery, and simple discovery. A set of rules stored by the PATROL Agent and periodically evaluated to find out whether a specific instance of an application class exists in the monitored environment. The rules describe how a PATROL Agent can detect instances of the application on a computer. There are two types of application discovery: simple and PSL; PSL discovery can include prediscovery rules as well as discovery rules. See also application check cycle, application discovery, prediscovery, PSL discovery, and simple discovery. A feature used from the PATROL Console to hide all instances of selected application classes for a particular computer. The PATROL Agent continues to monitor the application instances by running parameter commands and recovery actions. A system resource that is discovered by PATROL and that contains the information and attributes of the application class that it belongs to. See also application class and instance.

application discovery

application discovery rules

application filter

application instance

BMC Software, Inc., Confidential and Proprietary Information

Glossary

application state

The condition of an application class or an application instance. The most common application states are OK, warning, and alarm. An application class or instance icon can also show additional conditions. See also computer state and parameter state. A characteristic that is assigned to a PATROL object (computer class, computer instance, application class, application instance, or parameter) and that you can use to monitor and manage that object. Computers and applications can have attributes such as command type, parameter, menu command, InfoBox command, PATROL setup command, state change action, or environment variable. Parameters can have attributes such as scheduling, command type, and thresholds. An attribute can be defined globally for all instances of a class or locally for a particular computer or application instance. An instance inherits attributes from a class; however, an attribute defined at the instance level overrides inherited attributes. See also global level and local level.

attribute

border action

A command or recovery action associated with a parameter border range and initiated when that range has been breached. Border actions can be initiated immediately when the parameter returns a value outside the border range, after a warning or alarm has occurred a specified number of times, or after all other recovery actions have failed. See also border range. A range of values that serve as thresholds for a third-level alert condition when it is possible for a parameter to return a value outside of the alarm range limits. When a border range is breached, border actions can be initiated. See also border action. An internal command available from the PATROL Agent that monitors and manages functions such as resetting the state of an object, refreshing parameters, and echoing text. The command is identified by the naming convention %command_name. See also built-in macro variable.

border range

built-in command

BMC Software, Inc., Confidential and Proprietary Information

PATROL Configuration Manager User Guide

built-in macro variable

An internal variable created and maintained by PATROL for use in built-in commands and PSL. The naming convention for the variable is %{variable_name}. See also built-in command. A plot of parameter data values made by the PATROL Console Charting Server. See also multigraph container and PATROL Console Charting Server. See PATROL Console Charting Server. The object classification in PATROL where global attributes can be defined; the attributes are then inherited by instances of the class. An instance belongs to a computer class or an application class. See also application class, computer class, and event class. A type of parameter that contains instructions for gathering values for consumer parameters to display. A collector parameter does not display any value, issue alarms, or launch recovery actions. See also consumer parameter, parameter, and standard parameter. An option for starting a PATROL Agent or a PATROL Console at the operating system command line. PATROL Agent arguments include names of KMs to load and port numbers for agent-console connection. PATROL Console arguments include connection mode (developer or operator), user ID to start the PATROL Console, names of KMs to load, and names of the files to use. See PATROL Command Line Interface (CLI). The component that provides basic text editing functions for a PATROL Console. It is commonly used to add or change commands (menu commands, parameter data collection and recovery actions, InfoBox commands, setup commands, and state change actions).

chart

charting server class

collector parameter

command line argument

command line interface command text editor

BMC Software, Inc., Confidential and Proprietary Information

Glossary

command type

The designation assigned to a command according to its manner of execution. This attribute must be defined for a parameter command, a parameter recovery action, a menu command, an InfoBox command, a setup command, or a state change action. The PATROL Agent provides two command types: operating system (OS) and PSL. PATROL KMs provide additional command types. The developer functionality of a PATROL Console can be used to add or change command types. The process of saving to PATROL Agent computers the changes that have been made to a KM by using a PATROL Console. A PATROL user can disable a PATROL Consoles ability to commit KM changes. The basic object class to which computer instances of the same type belong. Examples include Solaris, OSF1, HP, and RS6000. PATROL provides computer classes for all supported computers and operating systems; a PATROL Console with developer functionality can add or change computer classes. A computer that is running in an environment managed by PATROL and that is represented by an icon on the PATROL interface. A computer instance contains the information and attributes of the computer class that it belongs to. See also instance. The condition of a computer. The main computer states are OK, warning, and alarm. A computer icon can show additional conditions that include no output messages pending, output messages pending, void because a connection cannot be established, and void because a connection was previously established but now is broken. See also state. See KM configuration file. See PATROL Agent configuration file.

commit

computer class

computer instance

computer state

configuration file, KM configuration file, PATROL Agent

BMC Software, Inc., Confidential and Proprietary Information

PATROL Configuration Manager User Guide

connection mode

The mode in which the PATROL Console is connected to the PATROL Agent. The mode can be developer or operator and is a property of the Add Host dialog box (PATROL 3.x and earlier), an Add Managed System wizard, or other connecting method. The connection mode is a global (console-wide) property that can be overridden for a computer instance. See also PATROL Console. A program that extends the functionality of PATROL Central or PATROL Web Central. Console modules can collect data, subscribe to events, access Knowledge Module functions, authenticate users, and perform security-related functions. A server through which PATROL Central and PATROL Web Central communicate with managed systems. A console server handles requests, events, data, communications, views, customizations, and security. A type of parameter that displays a value that was gathered by a collector parameter. A consumer parameter never issues commands and is not scheduled for execution; however, it has alarm definitions and can run recovery actions. See also collector parameter, parameter, and standard parameter. A custom object that you can create to hold any other objects that you selectsuch as computers, applications, and parametersin a distributed environment. In Windows, a container is referred to as a folder. You can drag and drop an object into and out of a container icon. However, objects from one computer cannot be dropped inside another computer. Once a container is defined, the object hierarchy applies at each level of the container. That is, a container icon found within a container icon assumes the variable settings of the container in which it is displayed. See also object hierarchy and PATROL Console Charting Server. To modify properties or attributes locally or globally. See also global level and local level. See override a parameter.

console module

console server

consumer parameter

container

customize a KM

customize a parameter

BMC Software, Inc., Confidential and Proprietary Information

Glossary

custom view

A grid-like view that can be created in PATROL Central or PATROL Web Central to show user-selected information. To stop running a parameter for selected computer or application instances. In PATROL Consoles for Microsoft Windows environments, deactivating a parameter stops parameter commands and recovery actions and deletes the parameter icon from the application instance window without deleting the parameter definition in the KM tree. A deactivated parameter can be reactivated at any time. See also snooze an alarm and suspend a parameter. To stop monitoring an application class and all of its instances on selected computer instances. In PATROL Consoles for Microsoft Windows environments, deactivating an application class deletes the application class and all of its instance icons from the computer window without deleting the application class or definition in the KM tree. A deactivated application class can be reactivated at any time. See also application filter and deactivate a parameter. In PATROL 3.x and earlier, a file that stores your desktop layout, the computers that you monitor, the KMs that you loaded, and your PATROL Console user accounts for monitored objects. You can create multiple desktop files for any number of PATROL Consoles. By default, desktop files always have a .dt extension. Desktop files are replaced by management profiles in PATROL 7.x. See also desktop template file. In PATROL 3.x and earlier, a file that stores information about the desktop setup of one computer. You can create multiple desktop template files for any number of PATROL Consoles. Each PATROL Console user can apply a template to selected computers on the desktop. By default, desktop template files always have a .dtm extension. See also desktop file. A feature of PATROL for Microsoft Windows only. One of the views of folders available with PATROL for Microsoft Windows environments, the Desktop tree displays the object hierarchy. See also KM tree.
BMC Software, Inc., Confidential and Proprietary Information

deactivate a parameter

deactivate an application class

desktop file

desktop template file

Desktop tree

PATROL Configuration Manager User Guide

developer mode

An operational mode of the PATROL Console that can be used to monitor and manage computer instances and application instances and to customize, create, and delete locally loaded Knowledge Modules and commit these changes to selected PATROL Agent computers. See also PATROL Console. To temporarily or permanently block an application or KM from loading and to block the PATROL Agent from using that KM. When a KM is disabled (added to the disabled list) in the agent configuration file, the KM files are not deleted from the PATROL Agent computers, but the PATROL Agent stops using the KM to collect parameter data and run recovery actions. The default is that no KMs are disabled. Most KMs are composed of individual application files with a .km extension. See also preloaded KM, static KM, and unload a KM. See application discovery. A CD or tape that contains a copy of one or more BMC Software products and includes software and documentation (user guides and online help systems). A variable used to specify settings, such as the program search path for the environment in which PATROL runs. You can set environment variables for computer classes, computer instances, application classes, application instances, and parameters. The occurrence of a change, such as the appearance of a task icon, the launch of a recovery action, the connection of a console to an agent, or a state change in a monitored object (computer class, computer instance, application class, application instance, or parameter). Events are captured by the PATROL Agent, stored in an event repository file, and forwarded to an event manager (PEM) if an event manager is connected. The types of events forwarded by the agent are governed by a persistent filter for each event manager connected to a PATROL Agent. A command that is triggered by the PATROL Agent when an event is acknowledged in an event manager (PEM). See also event escalation command and event notification command.

disable an application, disable a KM

discovery distribution CD or tape

environment variable

event

event acknowledgment command

BMC Software, Inc., Confidential and Proprietary Information

Glossary

event catalog

A collection of event classes associated with a particular application. PATROL provides a Standard Event Catalog that contains predefined Standard Event Classes for all computer classes and application classes. You can add, customize, and delete an application event catalog only from a PATROL Console in the developer mode. See also event class and Standard Event Catalog. A category of events that you can create according to how you want the events to be handled by an event manager and what actions you want to be taken when the event occurs. Event classes are stored in event catalogs and can be added, modified, or deleted only from a PATROL Console in the developer mode. PATROL provides a number of event classes in the Standard Event Catalog, such as worst application and registered application. See also event catalog and Standard Event Catalog. A command that is run by the PATROL Agent when certain events occur and that is used in conjunction with an event manager (PEM). The commands are specified for the event class that the event is associated with. A command can be one of three types: escalation, notification, or acknowledgment. See also event acknowledgment command, event escalation command, and event notification command. The part of an event manager (PEM) where you can store or change comments about any event in the event log. You can enter commands at any time from the PATROL Event Manager Details window. A command that is triggered by the PATROL Agent when an event is not acknowledged, closed, or deleted within an event manager (PEM) by the end of the escalation period. See also event acknowledgment command, event escalation period, and event notification command.

event class

event class command

Event Diary

event escalation command

BMC Software, Inc., Confidential and Proprietary Information

10

PATROL Configuration Manager User Guide

event escalation period

A period during which the severity of an event is increased as a result of the events persistence. Escalation actions are part of escalation command definitions for event classes and can be triggered only by the PATROL Agent. See also event escalation command. A circular file where events are stored by the PATROL Agent and accessed by an event manager, such as the PEM. The file resides on the PATROL Agent computer and retains a limited number of events. When the maximum number of events is reached and a new event is stored, the oldest event is removed in a cyclical fashion. See also parameter history repository. A graphical user interface for monitoring and managing events. The event manager can be used with or without the PATROL Console. See also PATROL Event Manager (PEM). A command that is triggered by the PATROL Agent when an event is logged into an event manager (PEM). See also event acknowledgment command and event escalation command. The PATROL-provided category for an event according to a filtering mechanism in an event manager. Event types include information, state change, error, warning, alarm, and response. See view filter. A kind of scheduling that starts a parameter when certain conditions are met. See also periodic scheduling. Comments about or instructions for dealing with PATROL events as reported by the agent. Expert advice is defined in the Event Properties dialog box in a PATROL Console in the developer mode. PATROL Consoles in an operator mode view expert advice in the PATROL Event Manager. See application filter. See view filter.

event history repository

event manager

event notification command

event type

event view filter event-driven scheduling expert advice

filter, application filter, event view

BMC Software, Inc., Confidential and Proprietary Information

Glossary

11

filter, persistent global channel

See persistent filter. A single dedicated connection through which PATROL monitors and manages a specific program or operating system. The PATROL Agent maintains this connection to minimize the consumption of program or operating system resources. In PATROL hierarchy, the level at which object properties and attributes are defined for all instances of an object or class. An object at the local level inherits characteristics (properties) and attributes from the global level. See also local level. A periodic message sent between communicating objects to inform each object that the other is still alive. For example, the PATROL Console checks to see whether the PATROL Agent is still running. The interval (in seconds) at which heartbeat messages are sent. The longer the interval, the lower the network traffic. See also message retries, message time-out, and reconnect polling. Parameter and event values that are collected and stored on each monitored computer. Parameter values are stored in binary files for a specified period of time; events are stored in circular log files until the maximum size is reached. The size and location of parameter history files are specified through either the PATROL Console or the PATROL Agent; size and location of event history files are specified through an event manager, such as the PEM, or the PATROL Agent. A binary file in which parameter values (except those that are displayed as text) are stored by the PATROL Agent and accessed by the PATROL Console for a specified number of days (the default is one day). When the number of storage days is reached, those values are removed in a cyclical fashion.

global level

heartbeat

heartbeat interval

history

history repository

BMC Software, Inc., Confidential and Proprietary Information

12

PATROL Configuration Manager User Guide

history retention level

The specified level (global or local) where the parameter history retention period for an object is set. The period can be inherited from the next higher level in the object hierarchy or set at the local level. If the history retention level is local, the number of days that history is stored (retention period) must be set. See also history retention period. The number of days that parameter values are stored in the history database before they are automatically purged by PATROL. The period can be specified at the class (global) or instance (local) level. History retention can be set for all parameters of a computer class, a computer instance, an application class, or an application instance. History for an individual parameter on an application instance can be manually cleared at any time by using a PATROL Console. See also history retention level. The combined settings for a parameters history retention level and history retention period. See also history retention level and history retention period. A dialog box that contains a static list of fields and displays current information about an object, such as the version number of an RDBMS and whether the object is online or offline. Commands are run when the InfoBox is opened. Information can be manually updated if the InfoBox remains open for a period of time. PATROL provides a number of commands for obtaining and displaying object information in an InfoBox. Only a PATROL Console in the developer mode can be used to add or change commands. Any event that is not a state change or an error. Typical information events occur when a parameter is activated or deactivated, a parameter is suspended or resumed, or application discovery is run. The default setting for PATROL is to prevent this type of event from being stored in the event repository. To store and display this type of event, you must modify the persistent filter setting in the PATROL Agent configuration file.

history retention period

history span

InfoBox

information event

BMC Software, Inc., Confidential and Proprietary Information

Glossary

13

instance

A computer or discovered application that is running in an environment managed by PATROL. An instance has all the attributes of the class that it belongs to. A computer instance is a monitored computer that has been added to the PATROL Console. An application instance is discovered by PATROL. See also application discovery, application instance, and computer instance. See Knowledge Module (KM). A file in which the characteristics of a KM are defined through KM menu commands during KM installation and setup (if setup is required). See also Knowledge Module (KM) and PATROL Agent configuration file. A list of KMs used by a PATROL Agent or PATROL Console. See also Knowledge Module (KM). See PATROL KM Migrator. See also Knowledge Module (KM). See Knowledge Module package. A feature of PATROL for Microsoft Windows only. One of two views of folders available in Windows. The KM tree displays computer classes, application classes, and their customized instances in the knowledge hierarchy and also displays the Standard Event Catalog. A PATROL Console in operator mode can only view the KM tree; only a PATROL Console in the developer mode can change KM properties and attributes. See also Desktop tree and Knowledge Module (KM). The rules by which objects inherit or are assigned attributes. (In PATROL Consoles for Microsoft Windows environments, classes of objects are represented in the Computer Classes and Application Classes sets of folders on the KM tree.) Properties and attributes of a customized instance override those defined for the class to which the instance belongs.

KM KM configuration file

KM list

KM Migrator KM package KM tree

knowledge hierarchy

BMC Software, Inc., Confidential and Proprietary Information

14

PATROL Configuration Manager User Guide

Knowledge Module (KM)

A set of files from which a PATROL Agent receives information about resources running on a monitored computer. A KM file can contain the actual instructions for monitoring objects or simply a list of KMs to load. KMs are loaded by a PATROL Agent and a PATROL Console. KMs provide information for the way monitored computers are represented in the PATROL interface, for the discovery of application instances and the way they are represented, for parameters that are run under those applications, and for the options available on object pop-up menus. A PATROL Console in the developer mode can change KM knowledge for its current session, save knowledge for all of its future sessions, and commit KM changes to specified PATROL Agent computers. See also commit, KM configuration file, KM list, KM Migrator, KM tree, load KMs, and version arbitration.

Knowledge Module package

A package of PATROL KM files that can be distributed by an installation program or stored in and distributed by the PATROL KMDS. The package file has a .pkg file extension. KM packages are created by using a PATROL Console in the developer mode. See also Knowledge Module (KM), PATROL Console, PATROL Knowledge Module Deployment Server (PATROL KMDS), and PATROL Knowledge Module Deployment Server Manager (PATROL KMDS Manager). Same as load KMs. Most KMs are composed of application files with a .km extension. To place KM files into memory for execution. After configuration and during startup, the PATROL Agent loads the KM files that are listed in its configuration file and that reside on the PATROL Agent computer. When a PATROL Console connects to the PATROL Agent, the KM versions that the agent executes depend on whether the console has developer or operator functionality. See also Knowledge Module (KM) and version arbitration. The history (stored parameter values) for an object or instance. See also global level and local level.

load applications

load KMs

local history

BMC Software, Inc., Confidential and Proprietary Information

Glossary

15

local history retention period local level

The length of time set by the user during which stored parameter values for an object or instance are retained. In PATROL hierarchy, the level of a computer instance or an application instance. An object (instance) at the local level inherits properties and attributes that are defined globally. When properties and attributes are customized locally for an individual instance, they override inherited attributes. See also global level. Any object that PATROL manages. See object. A systemusually a computer on which a PATROL Agent is runningthat is added (connected) to a PATROL Console to be monitored and managed by PATROL and that is represented by an icon on the PATROL interface. A user profile for PATROL Central and PATROL Web Central that is stored by the console server. A management profile is similar to a session file and contains information about custom views, your current view of the PATROL environment, information about systems that you are currently managing, Knowledge Module information, and console layout information for PATROL Central. Management profiles replace desktop files and session files that were used in PATROL 3.x and earlier. See PATROL SNMP Master Agent. A feature of UDP only. The number of times that the PATROL Console will resend a message to the PATROL Agent. The greater the number of message retries, the more time the PATROL Console will give the PATROL Agent to respond before deciding that the agent connection is down and timing out. The number of message retries multiplied by message time-out (in seconds) is the approximate time allowed for a connection verification. See also heartbeat, heartbeat interval, message time-out, and reconnect polling.

managed object managed system

management profile

master agent message retries

BMC Software, Inc., Confidential and Proprietary Information

16

PATROL Configuration Manager User Guide

message time-out

A feature of UDP only. The time interval (in seconds) that the PATROL Console will give the PATROL Agent to respond to a connection verification before deciding that the Agent connection is down. The number of message retries multiplied by message time-out is the approximate time allowed for a connection verification. See also heartbeat, heartbeat interval, message retries, and reconnect polling. A window that displays command output and error messages from the PATROL Console graphical user interface. See also response window, system output window, and task output window. A custom object into which you can drop parameter objects to be plotted as charts. See also PATROL Console Charting Server.
An action in response to a PATROL event. Notifications can include pages, emails, trouble tickets, and pop-up windows.

message window

multigraph container

notification

object

A computer class, computer instance, application class, application instance, parameter, or container (folder) in an environment managed by PATROL. Objects have properties and are assigned attributes (command types, parameters, menu commands, InfoBox commands, setup commands, state change actions, and environment variables). Parameter objects use data collection commands to obtain values from classes and instances. See also object class, object hierarchy, object icon, and object window. A computer class or application class. See also class, object, and object hierarchy. The structure of object levels in PATROL. On the PATROL interface, computers contain application folders (containers) representing a loaded KM, application folders contain one or more application instances, and application instances contain parameters.

object class

object hierarchy

BMC Software, Inc., Confidential and Proprietary Information

Glossary

17

object icon

A graphic that represents a computer instance, application class, application instance, parameter, or container (folder) in an environment managed by PATROL. See also object, object hierarchy, and object window. An open object container (folder) that may contain application class icons, application instance icons, parameter icons, custom containers (folders), and shortcuts. The object window is displayed when you double-click the object icon. See also application instance, computer instance, object, and object icon. An operational mode of the PATROL Console that can be used to monitor and manage computer instances and application instances but not to customize or create KMs, commands, and parameters. See also PATROL Console. An account that is set up at installation to grant the PATROL Agent access to a computer. Operating system commands executed by the PATROL Agent and PATROL Console use this account. The PATROL Agent configuration specifies a default operating system account, which can be changed. To disable or change the behavior of a local PATROL application parameter. The changes to the parameter are local to the managed system running the parameter and are stored in the agent configuration database. You must be granted specific permissions by a PATROL Administrator through the PATROL User Roles file in order to override parameters. Override a parameter is replaced by customize a parameter in PATROL 7.x. See also PATROL roles.

object window

operator mode

operating system account

override a parameter

BMC Software, Inc., Confidential and Proprietary Information

18

PATROL Configuration Manager User Guide

parameter

The monitoring element of PATROL. Parameters are run by the PATROL Agent; they periodically use data collection commands to obtain data on a system resource and then parse, process, and store that data on the computer that is running the PATROL Agent. Parameters can display data in various formats, such as numeric, text, stoplight, and Boolean. Parameter data can be accessed from a PATROL Console, PATROLVIEW, or an SNMP console. Parameters have thresholds and can trigger warnings and alarms. If the value returned by the parameter triggers a warning or an alarm, the PATROL Agent notifies the PATROL Console and runs any recovery actions associated with the parameter. See also parameter history repository and parameter state. The memory location where current parameter data is kept. In the PATROL Agent's configuration file, you can set the size of the cache, the maximum number of data points that can be stored, and the interval (in seconds) for emptying the cache. Also known as parameter history file. See history repository. See override a parameter. The condition of a parameter. The most common parameter states are OK, warning, and alarm. In PATROL 3.x and earlier, a parameter icon can show additional conditions that include no history, offline, and suspended. In PATROL 7.x, the suspended state is shown in the labelfor example, MyParam (suspended)rather than in the icon. A parameter can also be deactivated; when a parameter is deactivated, no icon is displayed. See also state. The core component of PATROL architecture. The agent is used to monitor and manage host computers and can communicate with the PATROL Console, a stand-alone event manager (PEM), PATROLVIEW, and SNMP consoles. From the command line, the PATROL Agent is configured by the pconfig utility; from a graphical user interface, it is configured by the xpconfig utility for Unix or the wpconfig utility for Windows. See also PATROL SNMP Master Agent.
Glossary 19

parameter cache

parameter history repository parameter override parameter state

PATROL Agent

BMC Software, Inc., Confidential and Proprietary Information

PATROL Agent configuration file

A file in which you can define the characteristics of the PATROL Agent by setting PATROL Agent configuration variables. You can edit the configuration file by using the pconfig utility, the wpconfig utility, or the xpconfig utility. See also KM configuration file, PATROL Agent configuration variable, pconfig, wpconfig, and xpconfig. The means by which the characteristics of a PATROL Agent are defined. PATROL provides default variable values that can be customized. Configuration variables determine such characteristics as how errors are handled, which KMs are loaded and how, how SNMP support is configured, and how events trigger SNMP traps. See also PATROL Agent configuration file. A feature of PATROL for Microsoft Windows only. The graphical user interface used to install and run the PATROL Agent. A memory array that contains an internal representation of the PATROL object hierarchy. Values in the agent namespace are available to PSL scripts, eliminating the need to develop code to collect this data. A snapshot of the operating system process table on a monitored computer. The agent process cache is updated periodically. A periodic process of the PATROL Agent that issues a platform-dependent system query to obtain a list of the active processes. This data is used to update the PATROL Agent process cache. A time-ordered schedule of actions, such as application discovery and parameter execution, to be carried out by the PATROL Agent. See also PSL run queue.

PATROL Agent configuration variable

PATROL Agent Manager PATROL Agent namespace

PATROL Agent process cache PATROL Agent process cache refresh

PATROL Agent run queue

BMC Software, Inc., Confidential and Proprietary Information

20

PATROL Configuration Manager User Guide

PATROL Command Line Interface (CLI)

An interface program that you can access from the command line of a monitored computer and through which you can run some PATROL products and utilities. With the CLI, you can monitor the state of PATROL Agents remotely, execute PSL functions, and query and control events. The CLI is used in place of the PATROL Console when memory and performance constraints exist. The graphical user interface from which you launch commands and manage the environment monitored by PATROL. The PATROL Console displays all of the monitored computer instances and application instances as icons. It also interacts with the PATROL Agent and runs commands and tasks on each monitored computer. The dialog is event-driven so that messages reach the PATROL Console only when a specific event causes a state change on the monitored computer. A PATROL Console with developer functionality can monitor and manage computer instances, application instances, and parameters; customize, create, and delete locally loaded Knowledge Modules and commit these changes to selected PATROL Agent computers; add, modify, or delete event classes and commands in the Standard Event Catalog; and define expert advice. A PATROL Console with operator functionality can monitor and manage computer instances, application instances, and parameters and can view expert advice but not customize or create KMs, commands, and parameters. See also developer mode and operator mode.

PATROL Console

PATROL Console Charting Server

A PATROL function that creates charts and graphs of actual values returned by more than one parameter. Charts and graphs are created by dragging and dropping various parameters into a multigraph container (folder) and plotting the results into a chart. Parameter data is plotted either in real time or from history sets and can be presented in a number of chart styles, including line graphs, pie charts, 3-D bar charts, and area plots. Charts can be viewed through the PATROL Console and printed to a local printer or PostScript file.

BMC Software, Inc., Confidential and Proprietary Information

Glossary

21

PATROL Enterprise Manager (PATROL EM)

An event management system that gathers, filters, translates, and prioritizes messages from the managed systems in an enterprise and displays them as alerts in a single console. The PATROL EM consolidates alerts from different vendors and different geographical locations into a single display for fast identification and resolution of potential problems. An event manager that you can use to view and manage events that occur on monitored system resources and that are sent by PATROL Agents. You can access the PEM from the PATROL Console or use it as a stand-alone facility. It works with the PATROL Agent and user-specified filters to provide a customized view of events. See also event manager. A PATROL utility used to convert PATROL parameter history data into an ASCII data file or to store parameter history data directly into a particular relational database management system. Formerly PATROLVIEW or PATROLINK. Products that can be used to view events and to monitor and display all the parameters provided by the PATROL Agents and KMs in a network or enterprise management console. See PATROL Knowledge Module Deployment Server (PATROL KMDS). See PATROL Knowledge Module Deployment Server Manager (PATROL KMDS Manager). A PATROL utility used to propagate KM user customizations to newly released versions of PATROL Knowledge Modules. The change and version control tool for KMs. A repository for storage of PATROL KMs and changes to those KMs.

PATROL Event Manager (PEM)

PATROL History Loader KM

PATROLVIEW

PATROL KMDS

PATROL KMDS Manager PATROL KM Migrator

PATROL Knowledge Module Deployment Server (PATROL KMDS)

BMC Software, Inc., Confidential and Proprietary Information

22

PATROL Configuration Manager User Guide

PATROL Knowledge Module Deployment Server Manager (PATROL KMDS Manager) PATROL roles

The graphical interface for the PATROL KMDS that can be used to manage and deploy or distribute KM changes in the production environment.

In PATROL 3.x and earlier, a set of permissions that grant or remove the ability of a PATROL Console or PATROL Agent to perform certain functions. PATROL roles are defined in the PATROL User Roles file, which is read when the console starts. A scripting language (similar to Java) that is used for generic system management and that is compiled and executed on a virtual machine running inside the PATROL Agent. PSL is used for writing application discovery procedures, parameters, recovery actions, commands, and tasks for monitored computers within the PATROL environment. The agent through which a PATROL Agent interacts with an SNMP agent and SNMP manager. The PATROL Master Agent configuration file contains the community name and port number for all agents in such a multiple-agent architecture. In PATROL 3.x and earlier, a domain group that can be set up by a Windows system administrator to restrict user access to a PATROL Developer Console. When a user tries to start a PATROL Console with developer functionality, PATROL checks whether the user is in the patroldev group. If the user is not in the group, a PATROL Console with operator functionality is started instead. See also ptrldev. The command line utility for setting PATROL Agent configuration variables. See also PATROL Agent configuration file, PATROL Agent configuration variable, wpconfig, and xpconfig. See PATROL Event Manager (PEM). A kind of scheduling that starts a parameter at a certain time and reruns the parameter at certain intervals. See also event-driven scheduling.

PATROL Script Language (PSL)

PATROL SNMP Master Agent

patroldev

pconfig

PEM periodic scheduling

BMC Software, Inc., Confidential and Proprietary Information

Glossary

23

persistent filter

A filter maintained by the PATROL Agent for each PATROL Console or event manager that connects to it. The filter is used to minimize network traffic by limiting the number and types of events that are forwarded from a PATROL Agent to a PATROL Console or an event manager (PEM). The schedule on which a parameter starts running and the intervals at which it reruns; the cycle is expressed in seconds. See also event-driven scheduling and periodic scheduling. The menu of commands for a monitored object; the menu is accessed by right-clicking the object. A quick one-time test written in PSL to determine whether a resource that you want to monitor is installed or running on a monitored computer. If the results are affirmative, the PATROL Agent runs the discovery script. Prediscovery helps reduce PATROL Agent processing requirements. A KM that is loaded by the PATROL Agent at startup and run as long as the Agent runs. See also disable an application, disable a KM and static KM. See PATROL Agent process cache refresh. A characteristic or attribute of an object, such as its icon. See PATROL Script Language (PSL).

polling cycle

pop-up menu

prediscovery

preloaded KM

process cache refresh property PSL PSL Compiler

A PATROL utility that compiles PSL scripts into a binary byte code that can be executed by the PSL virtual machine. The PSL Compiler can also be used to check a PSL script for syntax errors. The compiler is embedded in the PATROL Agent and PATROL Console (PATROL 3.x and earlier) and can also be run as a command-line utility.
A PATROL Console utility that is used to debug PSL scripts. The PSL debugger is accessed through a computer's pop-up menu.

PSL Debugger

BMC Software, Inc., Confidential and Proprietary Information

24

PATROL Configuration Manager User Guide

PSL discovery

A type of application discovery in which the discovery rules are defined by using PSL. PSL discovery can consist of prediscovery and discovery PSL scripts. A PATROL utility that is used to tune the CPU usage and minimize child processes or file operations of a newly created KM. When the PSL Profiler is enabled, the PATROL Agent starts accumulating and recording profile statistics. A queue of the currently executing PSL processes. The PSL run queue is used to distribute processing time between PSL processes in a round-robin fashion. In PATROL 3.x and earlier, a form of patroldev that can be used in environments that support domain names no larger than eight characters. See also patroldev. In PATROL 3.x and earlier, a command on the Tools menu from the PATROL Console main menu bar that contains built-in predefined commands that you can use to query the agent for frequently needed information. For example, you can query the agent regularly about all computer instances, application instances, and parameters that are in a warning or alarm state. See also Agent Query. The time interval (in seconds) at which the PATROL Console will try to reconnect to a PATROL Agent that has dropped the previous connection. The longer the interval, the lower the network traffic. See also heartbeat, heartbeat interval, message retries, message time-out. A procedure that attempts to fix a problem that caused a warning or alarm condition. A recovery action is defined within a parameter by a user or by PATROL and triggered when the returned parameter value falls within a defined alarm range.

PSL Profiler

PSL run queue

ptrldev

Quick Query

reconnect polling

recovery action

BMC Software, Inc., Confidential and Proprietary Information

Glossary

25

refresh parameter

An action that forces the PATROL Agent to run one or more parameters immediately, regardless of their polling cycle. Refreshing does not reset the polling cycle but gathers a new data point between polling cycles. Refresh parameter is also called update in PATROL 7.x. The filter used by the PATROL Agent when transmitting events to consoles (event cache) from the event repository (located at the agent) for statistical reports. An input and output display for many KM menu commands that provides a customizable layout of the information (for example, the sort method for outputting system process IDs). See also system output window and task output window. An individual configuration item or variable. A collection of rules or configuration items. See PATROL Agent run queue. A standard parameter that starts a process that runs indefinitely. The started process periodically polls the resource that it is monitoring and emits a value that is captured by the PATROL Agent and published as the parameter value. Self-polling avoids the overhead of frequently starting external processes to collect a monitored value. A self-polling parameter differs from most other parameters that run scripts for a short time and then terminate until the next poll time. In PATROL 3.x and earlier, any of the files that are saved when changes are made and saved during the current PATROL Console session. A session file includes the session-1.km file, which contains changes to KMs loaded on your console, and the session-1.prefs file, which contains user preferences. Session files are replaced by management profiles in PATROL 7.x.

reporting filter

response window

rule RuleSet run queue self-polling parameter

session file

BMC Software, Inc., Confidential and Proprietary Information

26

PATROL Configuration Manager User Guide

setup command

A command that is initiated by the PATROL Console and run by the PATROL Agent when the PATROL Console connects or reconnects to the agent. For example, a setup command can initialize an application log file to prepare it for monitoring. PATROL provides some setup commands for computer classes. Only a PATROL Console with developer functionality can add or change setup commands. An alias or copy of an object icon in the PATROL hierarchy. A type of application discovery that uses simple pattern matching for identifying and monitoring files and processes. See Simple Network Management Protocol (SNMP). A communications protocol that is supported by the PATROL Agent. SNMP allows network management systems to access PATROL Agents and allows PATROL Agents to monitor and manage SNMP devices. A condition which, when satisfied, results in an SNMP agent issuing a trap message to other SNMP agents and clients. Within the PATROL Agent, all events can be translated to SNMP traps and forwarded to SNMP managers. To temporarily suspend an alarm so that a parameter does not exhibit an alarm state. During the user-set snooze period, the parameter continues to run commands and recovery actions, and the parameter icon appears to be in an OK state. See also deactivate a parameter and suspend a parameter. A PATROL-provided collection of predefined event classes for all computer classes and application classes. To add, modify, or delete event classes and commands in the Standard Event Catalog, you must use a PATROL Console with developer functionality. See also event catalog and event class.

shortcut simple discovery

SNMP Simple Network Management Protocol (SNMP)

SNMP trap

snooze an alarm

Standard Event Catalog

BMC Software, Inc., Confidential and Proprietary Information

Glossary

27

standard parameter

A type of parameter that collects and displays data and can also execute commands. A standard parameter is like a collector parameter and consumer parameter combined. See also collector parameter, consumer parameter, and parameter. See setup command. The condition of an object (computer instance, application instance, or parameter) monitored by PATROL. The most common states are OK, warning, and alarm. Object icons can show additional conditions. See also application state, computer state, parameter state, and state change action. A parameter output style that represents the on or yes state of a monitored object as a check mark and the off or no state as the letter x. Parameters with this output style can have alerts (warning and alarm) and recovery actions. Numeric data output for the monitored object can be displayed as a graph. See also stoplight. An action that is stored, maintained, and initiated by the PATROL Console when the console is notified by the PATROL Agent that a monitored object has changed state. The action, or command, executes on the computer on which the console is running, not the computer on which the agent is running. A KM that is not loaded by the PATROL Agent before a PATROL Console with a loaded KM of the same name connects to the Agent. Once loaded by the agent, a static KM is never unloaded but continues to run as long as the agent runs, even if all PATROL Consoles with a registered interest disconnect from the PATROL Agent. If the PATROL Agent stops, static KMs will not be reloaded. See also disable an application, disable a KM and preloaded KM.

startup command state

state Boolean

state change action

static KM

BMC Software, Inc., Confidential and Proprietary Information

28

PATROL Configuration Manager User Guide

stoplight

A parameter output style that displays OK, warning, and alarm states as green, yellow, and red lights, respectively, on a traffic light. Parameters with this output style can have alerts (warning and alarm) and recovery actions. Numeric data output for the monitored object can be displayed as a graph. See also state Boolean. To stop running a parameter for selected computers or application instances. Suspending a parameter stops parameter commands and recovery actions but does not delete the parameter icon from the application instance window and does not delete the parameter definition from the KM tree in PATROL Consoles for Microsoft Windows environments. A suspended parameter can be resumed at any time. You can suspend a parameter from its pop-up menu. See also deactivate a parameter and snooze an alarm. A message window that displays the output of commands and tasks that the PATROL Console or the PATROL Agent execute on an instance. The window also displays error messages, commit status messages, and so forth. When the system output window contains unread messages in PATROL 3.x and earlier, the instance icon displays a yellow triangle for Windows; for Unix, it displays a blue screen with white text. A command or group of commands that can execute on one object or several objects simultaneously. A task runs in the background and is not part of the PATROL Agent run queue; a task icon is displayed for each running task. A window that contains command output generated by a task (for example, a KM menu command or a parameter warning or alarm). While executing, each task has its own icon, which usually appears in the PATROL interface or main window but may appear in an appropriate object window. A point or points that define a range of values, outside of which a parameter is considered to be in a warning or alarm range.

suspend a parameter

system output window

task

task output window

threshold

BMC Software, Inc., Confidential and Proprietary Information

Glossary

29

unload a KM

To delete a KM from a PATROL Console session in order to stop monitoring the KM-defined objects on all computers. The KM files are not deleted from the directories on the PATROL Console or the PATROL Agent computers, and the PATROL Agent will continue to run the KM, collect parameter data, and run recovery actions until no connected console has the KM loaded. To prevent the PATROL Agent computer from collecting parameter data and running recovery actions for a KM, disable the KM. If a KM has been flagged as static, then it will not be unloaded. See also disable an application, disable a KM, preloaded KM, and static KM. In PATROL 3.x and earlier, a connectionless network protocol that allows the PATROL Console to connect to many agents simultaneously. TCP requires an open file for each connection, and the number of files that a process can have open is generally limited. The PATROL Console settings that designate the account that you want to use to connect to monitored host computers, prevent a console with developer functionality from downloading its version of a KM to a PATROL Agent upon connection, disable the commit process for a console with developer functionality, determine certain window and icon display characteristics, specify the event cache size, and indicate whether startup and shutdown commands are enabled. A PATROL Console with either developer or operator functionality can change user preferences. In PATROL 3.x and earlier, the KM version comparison that PATROL makes when a PATROL Console connects to a PATROL Agent. By default, KM versions from PATROL Consoles with developer functionality are loaded rather than PATROL Agent KM versions, and PATROL Agent KM versions are loaded rather than KM versions from PATROL Consoles with operator functionality. A filter that can be created in an event manager (PEM) and that screens events forwarded from PATROL Agents. Views can be created, stored, and reapplied to host computers.
BMC Software, Inc., Confidential and Proprietary Information

User Datagram Protocol (UDP)

user preferences

version arbitration

view filter

30

PATROL Configuration Manager User Guide

warning

An indication that a parameter has returned a value that falls within the warning range. See also alarm. A feature of PATROL for Microsoft Windows only. The graphical user interface utility for setting PATROL Agent configuration variables. The wpconfig utility can be accessed from a computer pop-up menu on a computer running a PATROL Agent or a computer running a PATROL Console with developer functionality. See also PATROL Agent configuration file and PATROL Agent configuration variable. A feature of PATROL for Unix only. The graphical user interface utility for setting PATROL Agent configuration variables. You can access the xpconfig utility from an xterm session command line on a computer running a PATROL Agent or from a pop-up menu or an xterm session command line on a PATROL Console with developer functionality. See also PATROL Agent configuration file and PATROL Agent configuration variable.

wpconfig

xpconfig

BMC Software, Inc., Confidential and Proprietary Information

Glossary

31

BMC Software, Inc., Confidential and Proprietary Information

32

PATROL Configuration Manager User Guide

Index

Index
Symbols
$PATROL_HOME 2-14 .ini 2-16 application class name 5-17 application instance name 5-17 applied 3-6 apply 3-5 ApplyOnNew 3-11 archives 2-15 AS_CHANGESPRING 5-25 AS_CHANGESPRING KM 6-2 AS_CHANGESPRING.km 6-3

A
active 5-33, 6-2 adding agents 4-2 adding groups 4-2 agent installing a KM to 2-7 agent configuration 3-6, 3-17 agent configurations 3-24, 3-27 agent repository 1-3 Agent tree view 3-22 agent tree view 3-2 agents 3-26 agents per folder 2-20 agents.ini 3-3, 3-22 alarm range 5-33 alarm state 5-33 Alarm1 and Alarm2 alert ranges 5-33 alert 5-6 alert properties 3-30, 5-3 alert settings 3-29, 5-2 application class 5-29
BMC Software, Inc., Confidential and Proprietary Information

B
backup 3-7, 3-17, 3-33 backup agent configurations 1-4 backup before apply 2-19 backup settings 2-18 backup_before_apply A-3 backup_dir 2-17, A-3 backup_folder_groups A-4 backup_folder_min A-4 backup_identical_configurations A-4 backups_saved A-4 batch program 5-22 blackout period 5-11 blackouts 5-2

Index

C
ChangeSpring.ini A-1 clear 3-5 commands Custom Identifiers 5-26 Notification Command 5-21 Recovery Action Command 5-22 Recovery Action Command Type 5-25 Send Reset On Init 5-20 comments_dir 2-17, A-4 common tasks 4-2 communicate A-6 compare 3-42 configuration values A-1 configure 3-3 configuring 2-15 consoles, description of 2-6 conventions, document xviii Convert Overrides to EVS 6-6, 6-15 CPU usage A-7 Create a Ruleset 6-7 Create files for patrol_dir 6-6, 6-12 Create ruleset for config.default 6-6 Create Ruleset from CSV File 6-6, 6-14 csmi 6-2, 6-18 csmi.bat 6-19 csmi.csh 6-19 custom identifier 5-18, 5-27

duplicate 3-46

E
e-mail 5-22 error messages 2-17, A-4 errorfile 2-17, A-4 event catalog 5-19 event class 5-19 event ID 5-18 event id 5-19 Event Management 3-29, 5-2 Event Management rules 3-39, 4-28 event severity 5-19 event status 5-19 event type 5-19 evs_menu A-4 execute 3-34 exit 3-3

F
firewall 2-2, A-6 folders 2-15 font 2-15, 2-21 full discovery 5-29

G D
date of alert 5-18 default configuration 3-7 default directories 2-15 delete 3-24 desktop files 6-18 discovery 5-29 document conventions xviii Get Global Parameters 6-6, 6-8 Get Global Polltimes 6-6, 6-10 Get Localized Parameters 6-6 groups.ini 2-17, 3-3, 3-22, A-5

H
hostname 3-27, 5-17
BMC Software, Inc., Confidential and Proprietary Information

PATROL Configuration Manager User Guide

I
identical backups 2-19 images_dir 2-17, A-4 inactive 5-33 InfoBoxes 6-5 infrastructure 5-26 Ini folder 3-22, 4-2 ini_dir 2-17, A-5 init 5-20 installation choosing a target machine 2-6 system requirements 2-3 typical option 2-8 instance icon name 5-17

logfile 2-17, A-5

M
managed systems 1-3 managed systems, overview 2-7 maximum folders 2-20 menu bar 3-2, 3-3 message rewording 5-2 message_max_lines A-5 message_truncate_lines A-5

N
new configuration file 2-23 new folder 3-35 new PATROL users easy install option 2-8 new rule 3-41, 4-24 notification type 1-4, 5-13

J
Java Runtime Environment 2-3 Java Runtime Environment (JRE) 2-3 job status 3-9 JRE 2-3 JRE (Java Runtime Environment) 2-3

O
object 1-4 open 3-3 operations 3-38, 4-25 originating event 5-19 override 5-5

K
KM Commands 6-5 KMs installing 2-8

L
license 3-8 limits 5-33 listening port 5-17 Load 6-4 local notification 5-9 local_dir 2-17, A-5
BMC Software, Inc., Confidential and Proprietary Information

P
parameter alert ranges alarm1 5-33 alarm2 5-33 border 5-33 parameter name 5-17 parameter status 5-17

Index

parameter thresholds 3-29, 5-2 parameter timestamps 5-18 parameter value 5-18 parameter values 5-18 parent instance name 5-17 paste 3-24 path 5-24 PATROL Agent installing a KM to 2-7 PATROL Agent configuration files 2-2 PATROL Central Operator - Web Edition installing 2-7 PATROL Configuration Manager initialization file A-5 PATROL Console installing a KM to 2-6 PATROL Console profiles 2-2 PATROL Developer Console 2-2 PATROL objects A-6 PATROL security 2-9 patrol_dir A-6 pconfig_local_port A-6 platforms, supported 2-3 polling time 5-15 polltime 5-35 polltimes 3-29, 5-2, 5-30 port 3-27 pre-discovery 5-29 properties 3-23 protocol 3-27 PSL 5-21, 5-26 purge 3-6, 3-7

R
recovery action 5-24 recovery actions 5-7 refresh RuleSets 3-8 regular expressions 3-19, 3-47 reinitialize 3-8 release notes xviii reload 3-7 remote notification 5-9 removing agents and groups 4-2 report 5-38 requirements system 2-3 resend 5-15 reword 5-17 RTservers 2-7 rules 3-38, 4-27 rules and RuleSets 1-4 rules repository 1-3, 1-4 rules.tip file 3-10 RuleSet 3-17, 3-36 RuleSet tree view 3-2 ruleset_dir 2-17, A-5, A-6 ruleset_max_search_results A-7 ruleset_search_items_file A-7 RuleSets 2-19, 3-33

S
save 3-17 save as 3-46 script 5-21 search 3-18, 3-25, 3-28, 3-35, 3-43, 3-46 search criteria 3-19 search_sleep_delay A-7 search_sleep_interval A-7 security overview 2-9
BMC Software, Inc., Confidential and Proprietary Information

Q
queue 3-4, 3-33 queue_dir 2-17, A-6 quick access 3-16

PATROL Configuration Manager User Guide

shell script 5-22 shipped 3-33 shortcut menus 3-22 simulate 5-36 single thread A-6 starting 2-14 status 3-8, 5-7 system requirements 2-3 system roles console systems 2-6, 2-7 managed systems 2-7 overview of target machines 2-6

U
user interface 1-3

V
values 3-38, 4-25 variables 3-38, 4-25, 5-17 version 5-19 virtual backup folder 2-18

T
targets 5-13 threads_delay A-7 threads_max A-8 thresholds 5-2, 5-30 time of alert 5-18 time zone 5-18 tips_file A-8 tips_file_custom 3-11, A-8 tlog 3-33 tlog_dir 2-17, A-8 toolbar 3-2, 3-16 tooltip 3-10 transaction history 1-4 transaction logs 2-19 transaction settings 2-18 transactions_saved A-8 tree_font_name A-8 tree_font_size A-9 tree_font_style A-9 trigger 5-34 Turn Off Alarm Ranges 6-6, 6-16 typical installation option 2-8

W
warning state 5-33 What If 5-2 whatif.cfg 5-36

BMC Software, Inc., Confidential and Proprietary Information

Index

BMC Software, Inc., Confidential and Proprietary Information

PATROL Configuration Manager User Guide

END USER LICENSE AGREEMENT NOTICE


BY OPENING THE PACKAGE, INSTALLING, PRESSING "AGREE" OR "YES" OR USING THE PRODUCT, THE ENTITY OR INDIVIDUAL ENTERING INTO THIS AGREEMENT AGREES TO BE BOUND BY THE FOLLOWING TERMS. IF YOU DO NOT AGREE WITH ANY OF THESE TERMS, DO NOT INSTALL OR USE THE PRODUCT, PROMPTLY RETURN THE PRODUCT TO BMC OR YOUR BMC RESELLER, AND IF YOU ACQUIRED THE LICENSE WITHIN 30 DAYS OF THE DATE OF YOUR ORDER CONTACT BMC OR YOUR BMC RESELLER FOR A REFUND OF LICENSE FEES PAID. IF YOU REJECT THIS AGREEMENT, YOU WILL NOT ACQUIRE ANY LICENSE TO USE THE PRODUCT. This Agreement ("Agreement") is between the entity or individual entering into this Agreement ("You") and BMC Software Distribution, Inc., a Delaware corporation located at 2101 CityWest Blvd., Houston, Texas, 77042, USA or its affiliated local licensing entity ("BMC"). "You" includes you and your Affiliates. "Affiliate" is defined as an entity which controls, is controlled by or shares common control with a party. THIS AGREEMENT WILL APPLY TO THE PRODUCT, UNLESS (1) YOU AGREED TO A WEB BASED LICENSE AGREEMENT WITH BMC WHEN ORDERING THE PRODUCT, IN WHICH CASE THAT WEB BASED LICENSE AGREEMENT GOVERNS THE USE OF THE PRODUCT, OR (2) IF YOU DID NOT AGREE TO A WEB BASED LICENSE AGREEMENT WITH BMC WHEN ORDERING THE PRODUCT AND YOU HAVE A WRITTEN LICENSE AGREEMENT WITH BMC, THEN THAT WRITTEN AGREEMENT GOVERNS THE USE OF THE PRODUCT. THE ELECTRONIC AGREEMENT PROVIDED WITH THE PRODUCT AS PART OF THE INSTALLATION OF THE PRODUCT WILL NOT APPLY. In addition to the restrictions imposed under this Agreement, any other usage restrictions contained in the Product installation instructions or release notes shall apply to Your use of the Product. PRODUCT AND CAPACITY. "Software" means the object code version of the computer programs provided, via delivery or electronic transmission, to You. Software includes computer files, enhancements, maintenance modifications, upgrades, updates, bug fixes, and error corrections. "Documentation" means all written or graphical material provided by BMC in any medium, including any technical specifications, relating to the functionality or operation of the Software. "Product" means the Software and Documentation. "License Capacity" means the licensed capacity for the Software with the pricing and other license defining terms, including capacity restrictions, such as tier limit, total allowed users, gigabyte limit, quantity of Software, and/or other capacity limitations regarding the Software. For licenses based on the power of a computer, You agree to use BMCs current computer classification scheme, which is available at http://www.bmc.com or can be provided to You upon request. ACCEPTANCE. The Product is deemed accepted by You, on the date that You received the Product from BMC. LICENSE. Subject to the terms of this Agreement, as well as Your payment of applicable fees, BMC grants You a non-exclusive, non-transferable, perpetual (unless a term license is provided on an order) license for each copy of the Software, up to the License Capacity, to do the following: (a) install the Software on Your owned or leased hardware located at a facility owned or controlled by You in the country where You acquired the license; (b) operate the Software solely for processing Your own data in Your business operations; and (c) make one copy of the Software for backup and archival purposes only (collectively a "License"). If the Software is designed by BMC to permit you to modify such Software, then you agree to only use such modifications or new software programs for Your internal purposes or otherwise consistent with the License. BMC grants You a license to use the Documentation solely for Your internal use in Your operations. LICENSE UPGRADES. You may expand the scope of the License Capacity only pursuant to a separate agreement with BMC for such expanded usage and Your payment of applicable fees. There is no additional warranty period or free support period for license upgrades. RESTRICTIONS: You agree to NOT: (a) disassemble, reverse engineer, decompile or otherwise attempt to derive any Software from executable code; (b) distribute or provide the Software to any third party (including without limitation, use in a service bureau, outsourcing environment, or processing the data of third parties, or for rental, lease, or sublicense); or (c) provide a third party with the results of any functional evaluation or benchmarking or performance tests, without BMCs prior written approval, unless prohibited by local law.

TRIAL LICENSE. If, as part of the ordering process, the Product is provided on a trial basis, then these terms apply: (i) this license consists solely of a non-exclusive, non-transferable evaluation license to operate the Software for the period of time specified from BMC or, if not specified, a 30 day time period ("Trial Period") only for evaluating whether You desire to acquire a capacity-based license to the Product for a fee; and (ii) Your use of the Product is on an AS IS basis without any warranty, and BMC, ITS AFFILIATES AND RESELLERS, AND LICENSORS DISCLAIM ANY AND ALL WARRANTIES (INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT) AND HAVE NO LIABILITY WHATSOEVER RESULTING FROM THE USE OF THIS PRODUCT UNDER THIS TRIAL LICENSE ("Trial License"). BMC may terminate for its convenience a Trial License upon notice to You. When the Trial Period ends, Your right to use this Product automatically expires. If You want to continue Your use of the Product beyond the Trial Period, contact BMC to acquire a capacity-based license to the Product for a fee. TERMINATION. This Agreement shall immediately terminate if You breach any of its terms. Upon termination, for any reason, You must uninstall the Software, and either certify the destruction of the Product or return it to BMC. OWNERSHIP OF THE PRODUCT. BMC or its Affiliates or licensors retain all right, title and interest to and in the BMC Product and all intellectual property, informational, industrial property and proprietary rights therein. BMC neither grants nor otherwise transfers any rights of ownership in the BMC Product to You. BMC Products are protected by applicable copyright, trade secret, and industrial and intellectual property laws. BMC reserves any rights not expressly granted to You herein. CONFIDENTIAL AND PROPRIETARY INFORMATION. The BMC Products are and contain valuable confidential information of BMC ("Confidential Information"). Confidential Information means non-public technical and non-technical information relating to the BMC Products and Support, including, without limitation, trade secret and proprietary information, and the structure and organization of the Software. You may not disclose the Confidential Information to third parties. You agree to use all reasonable efforts to prevent the unauthorized use, copying, publication or dissemination of the Product. WARRANTY. Except for a Trial License, BMC warrants that the Software will perform in substantial accordance with the Documentation for a period of one year from the date of the order. This warranty shall not apply to any problems caused by software or hardware not supplied by BMC or to any misuse of the Software. EXCLUSIVE REMEDY. BMCs entire liability, and Your exclusive remedy, for any defect in the Software during the warranty period or breach of the warranty above shall be limited to the following: BMC shall use reasonable efforts to remedy defects covered by the warranty or replace the defective Software within a reasonable period of time, or if BMC cannot remedy or replace such defective copy of the Software, then BMC shall refund the amount paid by You for the License for that Software. BMCs obligations in this section are conditioned upon Your providing BMC prompt access to the affected Software and full cooperation in resolving the claim. DISCLAIMER. EXCEPT FOR THE EXPRESS WARRANTIES ABOVE, THE PRODUCT IS PROVIDED "AS IS." BMC, ITS AFFILIATES AND LICENSORS SPECIFICALLY DISCLAIM ALL OTHER WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT. BMC DOES NOT WARRANT THAT THE OPERATION OF THE SOFTWARE WILL BE UNINTERRUPTED OR ERROR FREE, OR THAT ALL DEFECTS CAN BE CORRECTED. DISCLAIMER OF DAMAGES. IN NO EVENT IS BMC, ITS AFFILIATES OR LICENSORS LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL, PUNITIVE OR CONSEQUENTIAL DAMAGES RELATING TO OR ARISING OUT OF THIS AGREEMENT, SUPPORT, AND/OR THE PRODUCT (INCLUDING, WITHOUT LIMITATION, LOST PROFITS, LOST COMPUTER USAGE TIME, AND DAMAGE OR LOSS OF USE OF DATA), EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, AND IRRESPECTIVE OF ANY NEGLIGENCE OF BMC OR WHETHER SUCH DAMAGES RESULT FROM A CLAIM ARISING UNDER TORT OR CONTRACT LAW. LIMITS ON LIABILITY. BMCS AGGREGATE LIABILITY FOR DAMAGES IS LIMITED TO THE AMOUNT PAID BY YOU FOR THE LICENSE TO THE PRODUCT. SUPPORT. If Your order includes support for the Software, then BMC agrees to provide support (24 hours a day/7 days a week) ("Support"). You will be automatically re-enrolled in Support on an annual basis unless BMC receives notice of termination from You as provided below. There is a free support period during the one year warranty period. (a) Support Terms. BMC agrees to make commercially reasonable efforts to provide the following Support: (i) For malfunctions of supported versions of the Software, BMC provides bug fixes, patches or workarounds in order to cause that copy of the Software to operate in substantial conformity with its then-current operating specifications; and (ii) BMC provides new releases or versions, so long as such new releases or versions are furnished by BMC to all other enrolled Support customers without additional charge. BMC may refuse to provide Support for any versions or releases of the Software other than the most recent version or release of such Software made available by BMC. Either party may terminate Your enrollment in Support upon providing notice to the other at least 30 days prior to the next applicable Support anniversary date. If You re-enroll in Support, BMC may charge You a reinstatement fee of 1.5 times what You would have paid if You were enrolled in Support during that time period. (b) Fees. The annual fee for Support is 20% of the Softwares list price less the applicable discount or a flat capacity based annual fee. BMC may change its prices for the Software and/or Support upon at least 30 days notice prior to Your support anniversary date.

VERIFICATION. If requested by BMC, You agree to deliver to BMC periodic written reports, whether generated manually or electronically, detailing Your use of the Software in accordance with this Agreement, including, without limitation, the License Capacity. BMC may, at its expense, audit Your use of the Software to confirm Your compliance with the Agreement. If an audit reveals that You have underpaid fees, You agree to pay such underpaid fees. If the underpaid fees exceed 5% of the fees paid, then You agree to also pay BMCs reasonable costs of conducting the audit. EXPORT CONTROLS. You agree not to import, export, re-export, or transfer, directly or indirectly, any part of the Product or any underlying information or technology except in full compliance with all United States, foreign and other applicable laws and regulations. GOVERNING LAW. This Agreement is governed by the substantive laws in force, without regard to conflict of laws principles: (a) in the State of New York, if you acquired the License in the United States, Puerto Rico, or any country in Central or South America; (b) in the Province of Ontario, if you acquired the License in Canada (subsections (a) and (b) collectively referred to as the "Americas Region"); (c) in Singapore, if you acquired the License in Japan, South Korea, Peoples Republic of China, Special Administrative Region of Hong Kong, Republic of China, Philippines, Indonesia, Malaysia, Singapore, India, Australia, New Zealand, or Thailand (collectively, "Asia Pacific Region"); or (d) in the Netherlands, if you acquired the License in any other country not described above. The United Nations Convention on Contracts for the International Sale of Goods is specifically disclaimed in its entirety. ARBITRATION. ANY DISPUTE BETWEEN YOU AND BMC ARISING OUT OF THIS AGREEMENT OR THE BREACH OR ALLEGED BREACH, SHALL BE DETERMINED BY BINDING ARBITRATION CONDUCTED IN ENGLISH. IF THE DISPUTE IS INITIATED IN THE AMERICAS REGION, THE ARBITRATION SHALL BE HELD IN NEW YORK, U.S.A., UNDER THE CURRENT COMMERCIAL OR INTERNATIONAL, AS APPLICABLE, RULES OF THE AMERICAN ARBITRATION ASSOCIATION. IF THE DISPUTE IS INITIATED IN A COUNTRY IN THE ASIA PACIFIC REGION, THE ARBITRATION SHALL BE HELD IN SINGAPORE, SINGAPORE UNDER THE CURRENT UNCITRAL ARBITRATION RULES. IF THE DISPUTE IS INITIATED IN A COUNTRY OUTSIDE OF THE AMERICAS REGION OR ASIA PACIFIC REGION, THE ARBITRATION SHALL BE HELD IN AMSTERDAM, NETHERLANDS UNDER THE CURRENT UNCITRAL ARBITRATION RULES. THE COSTS OF THE ARBITRATION SHALL BE BORNE EQUALLY PENDING THE ARBITRATORS AWARD. THE AWARD RENDERED SHALL BE FINAL AND BINDING UPON THE PARTIES AND SHALL NOT BE SUBJECT TO APPEAL TO ANY COURT, AND MAY BE ENFORCED IN ANY COURT OF COMPETENT JURISDICTION. NOTHING IN THIS AGREEMENT SHALL BE DEEMED AS PREVENTING EITHER PARTY FROM SEEKING INJUNCTIVE RELIEF FROM ANY COURT HAVING JURISDICTION OVER THE PARTIES AND THE SUBJECT MATTER OF THE DISPUTE AS NECESSARY TO PROTECT EITHER PARTYS CONFIDENTIAL INFORMATION, OWNERSHIP, OR ANY OTHER PROPRIETARY RIGHTS. ALL ARBITRATION PROCEEDINGS SHALL BE CONDUCTED IN CONFIDENCE, AND THE PARTY PREVAILING IN ARBITRATION SHALL BE ENTITLED TO RECOVER ITS REASONABLE ATTORNEYS FEES AND NECESSARY COSTS INCURRED RELATED THERETO FROM THE OTHER PARTY. U.S. GOVERNMENT RESTRICTED RIGHTS. The Software under this Agreement is "commercial computer software" as that term is described in 48 C.F.R. 252.227-7014(a)(1). If acquired by or on behalf of a civilian agency, the U.S. Government acquires this commercial computer software and/or commercial computer software documentation subject to the terms of this Agreement as specified in 48 C.F.R. 12.212 (Computer Software) and 12.211 (Technical Data) of the Federal Acquisition Regulations ("FAR") and its successors. If acquired by or on behalf of any agency within the Department of Defense ("DOD"), the U.S. Government acquires this commercial computer software and/or commercial computer software documentation subject to the terms of this Agreement as specified in 48 C.F.R. 227.7202 of the DOD FAR Supplement and its successors. MISCELLANEOUS TERMS. You agree to pay BMC all amounts owed no later than 30 days from the date of the applicable invoice, unless otherwise provided on the order for the License to the Products. You will pay, or reimburse BMC, for taxes of any kind, including sales, use, duty, tariffs, customs, withholding, property, value-added (VAT), and other similar federal, state or local taxes (other than taxes based on BMCs net income) imposed in connection with the Product and/or the Support. This Agreement constitutes the entire agreement between You and BMC and supersedes any prior or contemporaneous negotiations or agreements, whether oral, written or displayed electronically, concerning the Product and related subject matter. No modification or waiver of any provision hereof will be effective unless made in a writing signed by both BMC and You. You may not assign or transfer this Agreement or a License to a third party without BMCs prior written consent. Should any provision of this Agreement be invalid or unenforceable, the remainder of the provisions will remain in effect. The parties have agreed that this Agreement and the documents related thereto be drawn up in the English language. Les parties exigent que la prsente convention ainsi que les documents qui sy rattachent soient rdigs en anglais.

SW EULA Int 030102

Notes

*26101* *26101* *26101* *26101*


*26101*

You might also like