PATROL® Configuration Manager

User Guide

Supporting
PATROL Configuration Manager 1.6

November 2006

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

United States and Canada
Address BMC SOFTWARE INC 2101 CITYWEST BLVD HOUSTON TX 77042-2827 USA Telephone 713 918 8800 or 800 841 2031 Fax 713 918 8000

Outside United States and Canada
Telephone (01) 713 918 8800 Fax (01) 713 918 8000

Copyright 2006 BMC Software, Inc., as an unpublished work. All rights reserved. BMC Software, the BMC Software logos, and all other BMC Software product or service names are registered trademarks or trademarks of BMC Software, Inc. IBM is a registered trademark of International Business Machines Corporation. DB2 is a registered trademark of International Business Machines Corporation. Oracle is a registered trademark, and the Oracle product names are registered trademarks or trademarks of Oracle Corporation. All other trademarks belong to their respective companies. BMC Software considers information included in this documentation to be proprietary and confidential. Your use of this information is subject to the terms and conditions of the applicable End User License Agreement for the product and the proprietary and restricted rights notices included in this documentation.

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

Customer support
You can obtain technical support by using the BMC Software Customer Support website or by contacting Customer Support by telephone or e-mail. To expedite your inquiry, see “Before contacting BMC.”

Support website
You can obtain technical support from BMC 24 hours a day, 7 days a week at http://www.bmc.com/support_home. From this website, you can
I I I I I I I

read overviews about support services and programs that BMC offers find the most current information about BMC products search a database for issues similar to yours and possible solutions order or download product documentation report an issue or ask a question subscribe to receive proactive e-mail alerts when new product notices are released find worldwide BMC support center locations and contact information, including e-mail addresses, fax numbers, and telephone numbers

Support by telephone or e-mail
In the United States and Canada, if you need technical support and do not have access to the web, call 800 537 1813 or send an e-mail message to support@bmc.com. Outside the United States and Canada, contact your local support center for assistance.

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

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

I

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

I I I

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

3

4

PATROL Configuration Manager User Guide

Contents
Chapter 1 Introduction 15 16 16 16 16 17 17 17 17 18 19 19 19 20 20 20 22 22 28 28 28 30 31 33 33 33 34 34 35 36 37 38 40 42 43 44 46
5

About PATROL Configuration Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Concepts and Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RuleSet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Statically Linked RuleSets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Rule Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuration Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Interactions Among PATROL Agent, PATROL Configuration Database, and PATROL Configuration Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PATROL Knowledge Module for Event Management . . . . . . . . . . . . . . . . . . . . . . Agent Repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Rules Repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Knowledge Module Plug-ins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Graphical User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GUI Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Job Status Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Log File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Chapter 2 Setup and Customization of PATROL Configuration Manager

Managing Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Default Initialization File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Backup of Initialization Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Opening a Configuration File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating a New Configuration File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Storing PATROL Configuration Manager Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Specify the Location of Initialization Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Specify the Location of RuleSet Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Specify the Location of Transaction Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Specify the Location of Backup Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Specify the Location of Queue Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Specify the Location of Image Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Specify the Location of Comments Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Specify the Location of the Log File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents

Specify the Location of the Error File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 Specify the Location of Localized Agent RuleSets . . . . . . . . . . . . . . . . . . . . . . . . . . 49 Retaining Backups and Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 Select Backup Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 Select Transaction Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 Select Virtual Backup Folder Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 Managing Advanced Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 Set Default for Reporting Localized Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 Determine Whether Agent Authentication Is Used or Ignored . . . . . . . . . . . . . . . 59 Set the Number of Backup Files Retained . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 Activate Autosave for Group and Agent Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 Changing Graphic User Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 Customize the PATROL Configuration Manager GUI . . . . . . . . . . . . . . . . . . . . . . 63 Sharing a Configuration among Multiple Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 Supporting Failover . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 Overview of the Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 Sample Failover Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 Chapter 3 Add and Manage Agents and Groups 69

Authentication and Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 Security Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 Selecting an Agent to Be Managed by PATROL Configuration Manager . . . . . . . . . . 73 Setting Default Agent Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 Specifying an Individual PATROL Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 Discovering and Adding PATROL Agents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 Creating and Managing Agents in Groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 Creating Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 Organizing Agents into Groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 Changing Group Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82 Deleting an Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82 Deleting a Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 Locating Agents within PATROL Configuration Manager. . . . . . . . . . . . . . . . . . . 83 Managing the Agent Process and Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 Stopping an Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 Reinitializing an Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 Reloading the Configuration of an Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 Resetting the Configuration of an Agent to Its Default Configuration . . . . . . . . . 88 Managing Agent Accounts and Licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 Setting the PATROL Default Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 Managing Unique User Names and Passwords for Individual Agents . . . . . . . . 91 Updating the PATROL License File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 Sharing Agents and Groups among Multiple Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 Saving Agent and Group Changes Automatically . . . . . . . . . . . . . . . . . . . . . . . . . . 95 Configuring PATROL Configuration Manager for Multiple Users . . . . . . . . . . . . 96 Locking Agents and Groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 Discovering Rule and Configurations Assigned to Agents . . . . . . . . . . . . . . . . . . . . . . 98 Finding RuleSets Assigned to an Individual Agent . . . . . . . . . . . . . . . . . . . . . . . . . 98 Locating the Backup Configurations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
6 PATROL Configuration Manager User Guide

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Generate a Report Using PATROL Configuration Manager . . . . . . Editing a Rule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Memory Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Order of Operations for Applying Rules. . RuleSets. . . . . . . . . . . . . . . Naming Convention . . . . . . . . . . . . . . . Getting Configurations . . . . . . . . . . Benefits of Rules and RuleSets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Output Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Contents 7 . . . . . . . . . . . . . . . . . . . . . . . . . . . Deleting a Rule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Managing. . . . . . . . . . . . . . Assigning RuleSets to Agents . . Listing Localized Rules. . . Permissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RuleSets.Chapter 4 Report on the PATROL Environment 99 100 100 101 101 102 102 103 104 104 104 109 109 111 113 114 115 115 116 116 117 118 119 121 121 122 122 123 125 125 126 128 129 133 133 137 137 139 140 140 140 141 141 141 142 143 145 PATROL Configuration Manager Report Sources. . . . . . and Constraints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Printing . . . . . . . . . . . . . . . . . . . . . Creating a Rule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deleting RuleSets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Editing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Editing Local RuleSets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Copying or Duplicating a Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Chapter 5 Work with Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . Working with Configurations . . . Protecting Rules by Using Local RuleSets . . . . . . Creating a New RuleSet and New RuleSet Folder . . . . . . . . . . . Automated Reports . . . . . . . . . . . Overwriting Local RuleSets . . . . . . . . . . . . . . . . . . . . . . . . Automated Tasks. . . . . . . . . . . . . . . . . . . . . . and Configurations . . . . . Sharing and Locking RuleSet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Manual Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating a New RuleSet from an Existing RuleSet. . . . Moving and Copying RuleSets and RuleSet Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Locating a Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . and Managing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Defining and Generating a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . Dragging and Dropping in PATROL Configuration Manager . . . . . . . . . . . . . . . . . . . . . . . . . Comparing RuleSets . . . . . . . . . . . . . . . . Creating. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Backing Up the Configuration of an Agent . . . . . . . . . . . Limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating. . . . . . . . . . . . . . . . . . . . . . . . . . Formats. . . . . . . . . . . . . . and Deleting RuleSets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Editing RuleSets. . . . . . . . . Source of Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . and Configurations Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Characteristics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Applying Changes to Agent Configurations. . . . . . . . . . . . . . . . . . . . . . Creating Local RuleSets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Generating a Report of Local Rules before Applying Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . 189 Setting Precedence: Rules or KM Values . . . . . . . . . . . 185 Importing a RuleSet into PATROL Configuration Manager . . . . . . . . . . . . . . . . . . . . . . . . . 170 Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . 186 Chapter 7 Establish Notification and Manage Alerts 187 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190 PATROL Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147 Automating Updates to RuleSets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148 Types of Automated RuleSets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150 Activating/Deactivating Statically Linked RuleSets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 Accommodating Computer-Specific Data . . . . . . . . . . . . . . . . . . . . . . . . . . . .Purging All Configuration Changes from an Agent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 Storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149 Storage . . . . . . . . . . . . . . . . . . . . . 180 Accessing Parameter Poll Time Settings. . . . . . . . . . . . . . . . . . . . . . . 184 Prerequisites . . . . . . . . . . 170 Thresholds. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174 Specifying a Parameter for Which to Establish Thresholds. . . . . . . . . . . . . . . . 180 Specifying a Parameter for Which to Set a Poll Time . . . 148 Scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173 Establishing Thresholds. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149 Precedence. 183 Retrieving Customized Parameter Settings and Storing Them as a RuleSet. . . . . . . . . . . . . . . . . . . . . . 164 Defining a Rule Alias. . . . . . . . . . . . . . . . . 156 Identifying Linked RuleSets Associated with an Agent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151 Designating RuleSets to Be Applied to New Agents (ApplyOnNew). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190 Prerequisites . . . 172 Poll Times . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179 Setting Poll Times . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170 Range Settings for Monitoring Increasing and Decreasing Parameter Values . . . . . . . . . . . . . . . . . . 182 Defining Collection Cycles by Setting Poll Time. . . . . . . . . . . . 189 Notification Rules Stored as pconfig Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152 Designating RuleSets to Be Applied After Any RuleSet is Applied (ApplyOnApply) . . . . 163 Concept . . . . . . . . . . . . . . . . . . . 166 Chapter 6 Manage Parameters 169 Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149 Change to the Source Rule . . . . . . . . . . . . . . . 184 Saving Parameter Settings in a RuleSet . . . . . . . . . . . . . . . . . . . . . . . 174 Accessing Parameters Threshold Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190 Objects and Overrides . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 Viewing and Adding Missing Rule Alias. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 Operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 Predefined Rule Aliases (System Variables) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155 Designating Rules to be Updated Automatically (LinkedRuleSets) . . . . . . . . . . . . . . . . . . . . . . . . . 191 8 PATROL Configuration Manager User Guide . . . . . . . . . . . . . . . . . . . 176 Defining Border and Alarm Ranges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146 Restoring All Configuration Changes to an Agent . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . KM Migration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting Override Periods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Getting Global Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Message Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Recommended Configuration Order . . . . . . . . . . . . . . . Designating Who Receives Notifications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating RuleSet from Comma-Separated Value Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Assigning Custom Identifiers to PATROL Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Designating Type of Notification Sent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RuleSet Used for Testing . . . . . . . Testing Notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting Up Notification for PATROL Objects in Alert . . . . . . . Notification Configuration and Management . . . . . . . . . Updating the PATROL Object List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Alert Management . . . . . . . . . . . . . . . . . . . . . . . . Adding Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Getting Localized Parameters . . . . . . . . . . . . . . . . . . . . . . . . Determining How Many Times Alerts Are Resent . . . . Requirements . . . . Creating a Default RuleSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Suppressing Alerts upon Agent Restart to Avoid False Alerts . . . . . . . . . . . . . . Notification Tests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Disabling Notification. . . . . . . . . . . . . . . . . Loading the AS_CHANGESPRING KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . AS_CHANGESPRING KM. . . Accessing the KM Commands and InfoBoxes . . . . . . . . . . . . . . . . Defining Recovery Actions . . . . . . . . . . . . . . . Turning Monitoring On and Off at the Application Class Level . . . . . . . . . . . . Getting Global Poll Times . . . . . . . . . Removing Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Scope of Commands and Types . . Limitations . . . . . . . . . . . . . . Rewording Notification Messages . . . . . . . . . . . . . . . . . . . . . . Defining Recovery Action Command Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Alert Settings. . . . . . . . . Recovery Action Setup . . . . . . . . . . . . Naming Convention of RuleSets Created by AS_CHANGESPRING KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Enabling Recovery Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Getting All Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Make New RuleSets Available to PATROL Configuration Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Location and File Name of RuleSets Created by AS_CHANGESPRING KM . . . . . . . . . . . Retrieve. . . . . . . . . . . . . . . . . . . . . . Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Features and Limitations . . . . . . . . . . . . . Convert. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Chapter 8 Move PATROL Information into PATROL Configuration Manager 191 193 195 196 198 198 200 201 202 204 206 208 209 209 210 210 212 216 216 218 221 225 228 230 232 235 235 236 236 241 242 242 242 242 243 244 245 246 246 246 247 247 247 249 250 251 251 253 9 Overview . . . . . . . . Stopping Notification For Specific Periods (Notification Blackouts). . . . . . . . . . . . and Import Information from the PATROL Agent and KMs. . . . . . . . . . . . . . . Determining from Where Notifications Are Sent and Managed . . . . . . . . . . . . . . . . . . . . . . . . . .Difference between Blackouts and Overrides . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261 Command Line Interface (CLI) Options . 293 Reporting Generates Infinite Loop Error . . . . . . 258 Chapter 9 Command Line Interface 259 Features of the PATROL Configuration Manager CLI Utility . 255 Import PATROL Console Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263 Script File Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267 Sample Scripts . . . . . . . . . . . . . . . . . 273 Appendix B Appendix C Supported Regular Expressions Troubleshooting and Frequently Asked Questions 281 285 Troubleshooting . . . . . . . . . . . . . . . 296 What Is the Purpose of the DELVAR Operation? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289 KM Parameters Are Not in the Object Selection List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260 Dependencies . . . . . . . . . . . . . . . . . 290 Rule Value Length Too Long . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260 Authentication . . . . . . . . . . . . . . . . 292 PATROL Configuration Manager Does Not Start on Windows with Abnormal Termination Errors . . . 272 Configuration Settings Changed by Editing the PCM. 256 Conversion Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295 How Do I Move PATROL Configuration Manager from UNIX to Windows? . 254 Turning Off Alarm Ranges . . 287 PATROL Configuration Manager Does Not Start on Windows . . . . . . . . . . . . . .ini Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296 10 PATROL Configuration Manager User Guide . . . . . . . . . . . . . . . . . . . . . . . . . 264 Error Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257 Importing the Converted Data into PATROL Configuration Manager. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268 Appendix A Configuration Settings 271 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291 PATROL Configuration Manager Labels Missing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286 NT_CPU Polltime Changes Are Not Working . . . . . . . . . . . . . . . . . . . . . . 256 Converting PATROL Console Desktop Settings to . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294 Frequently Asked Questions. . . . . . . . . . . . . . . . . . . . . . . . . 272 Configuration Settings Changed Using the File => Configure Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .ini File . . . . 260 Location . . . 268 Scheduling. . . 288 PATROL Configuration Manager Does Not Start on UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . .Converting Parameter Overrides to RuleSets . . .

. . . . . . . 109 New RuleSet Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 Configure: Application – Folders / Paths Tab . . . . . . . 152 Group Apply LinkedRuleSet Dialog Box . . . 118 New RuleSet . . . . . . . . . . . . . . . . . . . . . . . . . . . 177 Border and Alarm Range Pane . . . . . . . . . .ini . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 Startup Command Line from PCM. . . . . . . . . . . 103 Apply RuleSets Dialog Box – Reporting Localized Rules before Apply . . . . . . . . . . . . . . . . . . . . 162 Rule Aliases: Add Rule Alias Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 Missing Rule Aliases Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 Configure: Agent Defaults Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179 Polltimes Tab of Parameter Setting Dialog Box . . . . . . . . . . . . . . 131 Edit Rule Variable Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Job Status Information Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 Configure: Application Dialog Box – Archive Tab . . . . . . . . . . . . . . . . . . 51 Configure: Application Dialog Box – Advanced Tab . . . . . . . . . . . . . . 102 Startup Command Line in Targets Text Box of Microsoft Windows Shortcut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126 Edit Configuration Source File Dialog Box . . . . . . . . . . . . . . . . . . . . . . . 29 Job Log File Viewer Dialog Box . . . . . . . . . . 150 Group ApplyOnNew Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199 Figures 11 . . . . . . . . . 157 Agent Apply LinkedRuleSet Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . .ini Sample Entry for Security Level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143 Example of an ApplyOnNew and LinkedRuleSet in agent. . . . . . . . 134 Local RuleSet Folder . . . . . . . . . . . . . . . . . . . . . . . . . 181 Alert Settings Dialog Box . . . . . . . . . . . . . . . . . . . 159 Search LinkedRuleSets Results Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 File Locked Dialog Box . . . 137 New Local RuleSet Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129 RuleSet Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Figures PATROL Configuration Manager Graphical User Interface (GUI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 RuleSet Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150 Statically Linked RuleSet Modified Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 Configure: Application Dialog Box – Fonts / Colors Tab . . . . . . . . . . 166 Rule Aliases: Add Rule Alias Dialog Box . . . . . . . . . . . . . . . . .sh on Solaris . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167 Thresholds Tab of Parameter Setting Dialog Box . . . . . . . . . . . . . . . . 175 Object Selection Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196 Override Settings Dialog Box . . 195 Object Selection Dialog Box – Multiple Hosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 RuleSet Search Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 Apply RuleSets Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131 Edit Value for Event Management Rule Example . . . . . . . . . . . 62 agent. . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269 Generate a Report by Using PATROL Configuration Manager CLI on Windows . . . . . . . . . . . . . . . . . . . . . . . . . 236 What If Dialog Box . . . . . . . . . . . . . . . . 269 Rule Value Length Dialog Box . . . . . . . . . . . . . . . . . 239 AS_CHANGESPRING Menu Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245 RuleSet File Name Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233 Blackout Period Selection Dialog Box . . . 217 Alert Settings Dialog Box – Notification Command Tab . . . . . . . . 262 Example of pcmcli Interacting with a Policy in Running Attended Mode . . . . . . . 291 12 PATROL Configuration Manager User Guide . . . . . . . . . . 263 PATROL Configuration Manager CLI Script File Syntax . . 220 Alert Settings Dialog Box – Notification System Tab . . .cmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214 Alert Settings Dialog Box – Notification Targets Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264 Generate a Report by Using PATROL Configuration Manager CLI on Solaris . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262 PATROL Configuration Manager CLI Syntax . 201 Alert Settings Dialog Box – Alert Resend Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249 Create List Dialog Box . . 208 Alert Settings Dialog Box – Recovery Action Command Type Tab . . . . . . 205 Alert Settings Dialog Box – Custom Identifiers Tab . . . . . 246 Select the Knowledge Modules Dialog Box . . . . . . . . . . . . . . . . . 227 Alert Settings Dialog Box – Notification Blackouts Tab . 253 Example of pmc_cli_allow_unattended_login. . . . . . . . . . . . . . . . . . 203 Alert Settings Dialog Box – Send Reset On Init Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237 What If Results Dialog Box – Results Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252 Get File Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234 What If RuleSet . . . . . . . . . . . . . 238 What If Results Dialog Box – Report Tab . . . . . . . . . . . . . . . . 268 Schedule a Report on UNIX – crontab Entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Alert Settings Dialog Box–Alert Action Tab . . . . . . 211 Alert Settings Dialog Box – Recovery Action Commands Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224 Alert Settings Dialog Box – Alert Messages Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207 Alert Settings Dialog Box – Class Active State Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . 135 Rule Search Results Report Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 Example of Monitoring a Parameter with a Decreasing Value . . . . . 164 Rule Aliases: Add Rule Alias Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172 Example of Monitoring a Parameter with an Increasing Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153 Group Apply Linked RuleSets Properties . . . . . . . . . . . . . . . . . . 55 Foreground/Fonts Colors Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 Queue of Rules to Be Applied Folder . . . . . . . . . . . . . . . . . 124 Rule Properties . . . . . . 29 Ini Folder . . . . . . . . . . . . . . . . . . . . . . . . . 149 Storage Location . . . . . . . . . . . . . . . . 199 Tables 13 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136 Apply RuleSet Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 Transaction Log Folder . . . . . . 49 Backup Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Information. . . . . . . . . . . . . . . . . . 42 Image Folder . . . . . . . . . . . . . . . . . . . . . 63 Sample Failover Setup Process . . . . . . . 105 Order of Operations for Applying Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159 Search LinkedRuleSet Properties . 23 Job Status Information Properties . . . . . .Tables PATROL Configuration Manager Graphical User Interface (GUI) Properties . . . . . . . . . . . . . . . . . . 43 Comments Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193 Override Settings Properties . 79 Agent Search Criteria Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 Local Folder . . . . . . . . . . 67 Agent Discovery Criteria for RT Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 Lock Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 Type of Information Gathered by the Report . . . . . . . . . . . . 84 Security Configuration Properties . . . . . . . . . . . . . . 127 RuleSet Search Properties . . . . . . . . . . . . . . . . . . . . . . . 161 Predefined Rule Aliases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 Automated RuleSet Variable Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Agent Configuration Backup Folder . . . . . . . . . . . . . 44 Log Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 Error File Folder . . . . . . . 157 Agent Apply LinkedRuleSet Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173 Configuration Order . . . . . . . . . . . . . 115 RuleSet Comparison Display Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150 Group ApplyOnNew Properties . . . . . . . . . . . . . . . . . . . . . . . . 77 Agent Discovery Criteria for PATROL Ping . . . . . . . . . 52 Virtual Backup Folder Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 RuleSet Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . and Behavior . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237 Accessing KM Commands and InfoBoxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232 Notification Blackout Properties . . . . . . . . . . . . . . . . . . . . . 244 PATROL Configuration Manager CLI Path and File Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260 Location of the pcm_cli_allow_unattended_login Script . . . . . . . . . . . 234 Blackout Period Selection Properties . . . . . . 265 PATROL Configuration Manager Configuration Variables . . . . . 261 PATROL Configuration Manager CLI Options and Arguments . . . . 263 PATROL Configuration Manager CLI File Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215 Notification Targets Properties . . . . . . . . . . . 204 Custom Identifier Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202 Alert Resend Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228 Types of Notification Blackouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273 Supported Regular Expressions . . . . . . . . . . . . . . . . . . . . . 234 What If Properties . . 226 Alert Message Properties . . . . . . . . 207 Class Active State Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281 14 PATROL Configuration Manager User Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212 Recovery Action Command Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261 pcm_cli_allow_unattended_login Script per Platform . . . . . . . . . 221 Notification System Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225 Notification Subject Line and Message Length Limits by Platform . . . . . . . . . . . . . . . . . . . . 209 Recovery Action Command Type Properties . . . . . . . . . . 228 Alert Message Variables . . . . . . . . . . . . . .Alert Action Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218 Notification Command Properties . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PATROL Configuration Database. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PATROL Knowledge Module for Event Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Rule Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Interactions Among PATROL Agent. . . . . . . . . . . . . . . . . . User Interface . . . . . . . . . . . . . . . . . . . . . . Access . . . . . . . . . . . . . . . . . . . Job Status Information. . . . . and PATROL Configuration Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GUI Controls . . . . . . . . . . . . Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Viewer . . . . Knowledge Module Plug-ins . . . . . . . . . . . . . . . . Agent Repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . Concepts and Definitions . . . . . . . . . . . . . . . . Chapter 1 Introduction 15 . Rules Repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Graphical User Interface . . . . . . . . . . . . . . . . . . . . . . Configuration Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Log File . . . . . . . . . . . . . . . . RuleSet. . . . . . . . . . . . . . . . . . . . Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Statically Linked RuleSets . . . . . . . . . . . . . . . . . . . . . . . . . . . The following topics are discussed: About PATROL Configuration Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Chapter 1 16 16 16 16 17 17 17 17 18 19 19 19 20 20 20 22 22 28 28 28 30 1 Introduction This chapter introduces PATROL Configuration Manager. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

rule organization. Many of the actions that can be performed on rules. can also be performed on RuleSets. and the operation to be performed on that variable with that value. This capability allows a user to apply a large number of rules to an agent or agents efficiently and consistently. the value. Rule A rule is an instruction to the PATROL Agent on how to update a configuration variable (historically referred to as a pconfig variable) in the PATROL Configuration Database (pconfig) of a PATROL Agent. 16 PATROL Configuration Manager User Guide . a rule may also be referred to as key/value or key/value/operation. RuleSet A RuleSet is a collection of rules that are associated by the user based on user-defined organizing principles. you must understand some basic concepts about both PATROL Configuration Manager and PATROL. When the constituent parts of a rule need to be emphasized. basic change control. Each rule consists of a variable to be changed (also referred to as a key). Concepts and Definitions Before you can properly use the PATROL Configuration Manager. such as Applying. such as. 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.About PATROL Configuration Manager 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: I I I I I separation of business rules from the management tool rule management features.

Changes to these defaults are stored in delta (change files). the PATROL Agent starts out with a default configuration. The default configuration is stored in a configuration database file entitled config. configuration variables control some aspect of agent behavior in which more than one option exist. Historically. At installation. Configuration Variable In the PATROL Agent. a configuration variable has also been referred to as a pconfig variable.Statically Linked RuleSets Statically Linked RuleSets A statically linked RuleSet is a RuleSet that is associated with an agent or group of agents by being placed in the either the ApplyOnNew or LinkedRuleSet container of the respective the agent or group of agents. Many Knowledge Modules add and change configuration variables when you install and/or load them into PATROL. Chapter 1 Introduction 17 . When a rule belonging to a statically linked RuleSet is updated. which contain only those configuration variables that have changed and their updated values. they change the configuration of the agent. Configuration A Configuration is a set of configuration variables and their values. This behavior includes but is not limited to the agent's interaction with PATROL Knowledge Modules® (KM) and other PATROL components. As users customize the behavior of their agent.default. Rule Alias A Rule Alias is a variable that enables you to insert in a rule a placeholder that is replaced by a computer-specific value when the rule is applied. PATROL Configuration Manager asks you if you want to apply this change to all of the agent to which the rule is linked. The changes are made by other means than PATROL Configuration Manager.

which connects to the PATROL Agent and sends the rules. PATROL Configuration Database.Interactions Among PATROL Agent. 18 PATROL Configuration Manager User Guide . The configuration manager calls the pconfig utility. and PATROL Configuration Manager PATROL Configuration Manager creates and places these rules in pconfig file format. performs the specified operations and stores the key/value in the persistent database. PATROL Configuration Database. The agent receives the rules. and PATROL Configuration Manager Interactions Among PATROL Agent.

See the PATROL Knowledge Module for Event Management User Guide for more information. Without the PATROL KM for Event Management. When you are using PATROL Configuration Manager. you cannot use the Event Management features such as alert settings and parameter settings of the PATROL Configuration Manager. Chapter 1 Introduction 19 . shown in “Graphical User Interface” on page 22. configures managed agents and administers rules. PATROL Configuration Manager provides an interface to the PATROL KM for Event Management commands. PATROL KM for Event Management is also required for reporting. PATROL Knowledge Module for Event Management The PATROL KM for Event Management provides notification and alert control. you should have the PATROL KM for Event Management installed on your PATROL Agents. User Interface The PATROL Configuration Manager user interface.Components Components This section describes the components of PATROL Configuration Manager: I I I I I user interface PATROL KM for Event Management agent repository rules repository managed systems (agents) The following sections describe the PATROL Configuration Manager components. The user interface provides features similar to the Windows Explorer interface such as drag and drop and cut and paste.

For example. Rules are logically grouped to form RuleSets. rules could be grouped according to their related action or object: I notification type—all 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 I RuleSets can be grouped together into folders.Agent Repository Agent Repository The agent repository contains communication settings and grouping information for each agent. The RuleSets are in the same format as standard PATROL Agent configuration files (.ini groups.ini Rules Repository The rules repository contains the following information: I I I I 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. The agent repository information is stored in the following files: I I agents. While you usually manage your RuleSets and folders with PATROL Configuration Manager. Knowledge Module Plug-ins Plug-ins are utilities that provide knowledge module-specific graphical user interfaces that assists users in configuring multiple rules to address complex product configuration needs. 20 PATROL Configuration Manager User Guide .cfg). the RuleSets are stored in text files and can be managed using standard system utilities such as text editors and file management utilities.

Knowledge Module Plug-ins For example. configuring the PATROL Knowledge Module for UNIX to monitor log files requires the creation of 4 or 5 rules that are interdependent. These utilities interact with the PATROL Configuration Manager. preventing conflicts between rules and checking for error. but are loaded and accessed through one of the PATROL Consoles. Chapter 1 Introduction 21 . the PATROL for UNIX product provides a plug-in that enables a user to create these rules simultaneously. Thus. The plug-in coordinates the rule creation.

Figure 1 menu bar PATROL Configuration Manager Graphical User Interface (GUI) tool bar Agents tree view pane message pane RuleSet tree view pane Table 1 describes the controls on the PATROL Configuration Manager GUI. Table 1 describes the various GUI controls built into the interface.Graphical User Interface Graphical User Interface The sections highlights the features of the PATROL Configuration Manager Graphical User Interface (GUI) and describes the controls that the GUI offers. GUI Controls Figure 1 provides a sample of the PATROL Configuration Manager Graphical User Interface (GUI). 22 PATROL Configuration Manager User Guide .

These commands are used in conjunction with the View and Focus commands.GUI Controls Table 1 GUI Control Menu bar PATROL Configuration Manager Graphical User Interface (GUI) Properties (part 1 of 5) Description The menu bar contains commands to manage configuration items and to manipulate the GUI. RuleSets. The File menu contains the following menu commands: I Save—command saves changes to agents. The Edit menu contains the following commands: I Drag Left—takes currently selected configuration tree item and prepares it to be dropped onto the agent tree Drag Right—takes currently selected agent tree item and prepares it to be dropped onto the configuration tree Drop—assign the dragged item to the currently selected item Cancel Drop—cancel the current drop operation I I I The actions performed by these commands can also be performed with the mouse. directories. Chapter 1 Introduction 23 . File The File menu contains commands to modify and open PATROL Configuration Manager configurations as well as exiting the configuration manager. groups. and files used by PATROL Configuration Manager for storing agent and RuleSets information Reload—reloads the PATROL Configuration Manager data Exit—closes PATROL Configuration Manager I I I I Edit The Edit menu contains commands for dragging and dropping items within the GUI. and configuration settings in the PATROL Configuration Manager configuration files Open—opens and loads a configuration file. which specifies the directories and default settings to use as the current PATROL Configuration Manager configuration Configure—opens the Configure dialog box that is used to change the settings.

Queue The Queue menu contains commands for applying agent rules. The Queue menu contains the following commands: I I Clear—clears all rules waiting to be applied to agents Apply—transfers all rules waiting to be applied to the PATROL Configuration Manager queue folder for processing. These commands are used in conjunction with the Edit and Focus commands. Focus The Focus menu contains commands for placing focus on either the Agents tree view pane or the RuleSets tree view pane.GUI Controls Table 1 GUI Control PATROL Configuration Manager Graphical User Interface (GUI) Properties (part 2 of 5) Description View The View menu contains commands for navigating and managing the tree view panes. These commands are used in conjunction with the Edit and View commands. 24 PATROL Configuration Manager User Guide . The Focus menu contains the following commands: I I Agents—place focus on the Agents tree view pane RuleSets—place focus on the RuleSets tree view pane The actions performed by these commands can also be performed with the mouse. The View menu contains the following commands: I I I I Expand All—expands all folders Expand—expands selected folder(s) Collapse All—collapses all folders Collapse—collapses selected folder(s) Tree View—display variable names in either a slash mode (elements of the name are separated by a forward slash) or a hierarchical mode (elements of the name are displayed as branch in a tree) I The actions performed by these commands can also be performed by the corresponding buttons.

A permanent status summary can be obtained from the PATROL Configuration Manager log file that is specified in the PATROL Configuration Manager initialization file. 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. a short description of the rule pops up when the mouse hovers over a rule ApplyOnNew Activated —either activates or deactivates the ApplyOnNew containers. Display Tooltips—either turns the ToolTips display on or off depending on the current setting.default file and the agents change configuration file. which shows the status of the last completed task. this information can be saved in a number of different formats Set Default Account—changes the default account on a PATROL Agent Reload Agent—forces a reload of the selected agents config. The Other menu contains the following commands: I Refresh RuleSets—forces a refresh of the entire RuleSet tree view and collapses open folders Clear Status Window—clears the Message pane at the bottom of the PATROL Configuration Manager GUI View Job Status—displays the Job Status Information dialog box. Purge Agent—purges all non-default or changed agent configuration variables for the selected agents Reinitialize Agent—restarts the selected agents Kill Agent—stops the selected agents Update License—applies a PATROL license file to the selected PATROL Agents I I I I I I I Other The Other menu contains commands to manipulate the PATROL Configuration Manager display. The Tools menu contains the following commands: I Discover Agents—find PATROL Agents that can be registered to PATROL Configuration Manager and managed by it Reporting—provides information for selected agents. and a change to any RuleSet or RuleSet folder that is referenced by a container automatically prompts you to update agents to which the RuleSet is assigned I I I I Chapter 1 Introduction 25 . when this option is activated.log located in the installation directory. The default log file is PCM.GUI Controls Table 1 GUI Control PATROL Configuration Manager Graphical User Interface (GUI) Properties (part 3 of 5) Description Tools The Tools menu contains commands for manipulating PATROL Agents. when Display ToolTips is on.

Search RuleSets searches folders or RuleSets for rule items A folder or RuleSet must be selected in order to perform a search. Get 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. 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. This action can also be performed by selecting Queue => Apply from the Menu bar. Agent configurations can also be retrieved by right-clicking on an agent and choosing Configuration => Get. To get copies of agent configurations. Expand All Expand Collapse All Collapse expand the tree in the tree view pane that has focus expand the selected portion of the tree in the tree view pane that has focus collapse the tree in the tree view pane that has focus collapse the selected portion of the tree in the tree view pane that has focus 26 PATROL Configuration Manager User Guide .GUI Controls Table 1 GUI Control PATROL Configuration Manager Graphical User Interface (GUI) Properties (part 4 of 5) Description Help The Help menu command provides information about PATROL Configuration Manager with the About command. Apply 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. I I Help Topics—launches the PATROL Configuration Manager help About—displays the PATROL Configuration Manager version and copyright information Tool bar Save The PATROL Configuration Manager toolbar contains buttons that provide quick access to common configuration manager commands. select one or more agents in the Agent tree view and click the Get Configuration button.

GUI Controls Table 1 GUI Control TreeView PATROL Configuration Manager Graphical User Interface (GUI) Properties (part 5 of 5) Description displays the rule name of a rule in hierarchical mode or slash (/) path mode I slash path mode I hierarchical mode Agents tree view pane displays the agents to be managed by PATROL Configuration Manager acts as the base container for all agent and group information stores and organizes agents into groups stores and organizes agent data designates rules to be applied to agents when they are added to a group associates RuleSets or RuleSet folders with agents or groups. local rules. queued rule sets. and transaction logs Message pane displays system messages and the status of requested operations Chapter 1 Introduction 27 . RuleSets and configurations that can be applied to agents stores and organizes Rule Sets stores and organizes rules stores and organizes PATROL Configuration Manager-specific information such as backup configurations. this container is used to distribute updates of rules when the original ruleset or rulesets contained within a ruleset folder are changed RuleSet tree view pane displays the rules.

this option the Job Status Information dialog box is not opened automatically. NOTE Select the Redisplay when updated check box to have PATROL Configuration Manager automatically open the Job Status Information dialog box whenever the job status information is updated. 28 PATROL Configuration Manager User Guide . The Job Status Information dialog box reports the progress and ultimate status of each operation on a per agent basis. PATROL Configuration Manager automatically displays the Job Status Information dialog box. You can also access the dialog box from the Menu bar. Viewer PATROL Configuration Manager presents job status information in a dialog box. If do not select.Job Status Information Job Status Information A single configuration manager operation such as applying configurations to hundreds of agents or getting configurations from hundreds of agents can take several minutes and result in various outcomes due to a multitude of factors such as an agent being offline or a configuration database being corrupted. Figure 2 on page 29 provides a sample of the Job Status dialog box. PATROL Configuration Manager displays Job Status Information dialog box. choose Other => View Job Status. Access When you perform a configuration operation. which lists the last operation that it performed. To view job status information From the Menu bar.

the dialog box color codes each job based upon its current status RUNNING—the operation is being processed (color = white) STOPPED—a user has intervened and manually stopped the job (color = yellow) OK—the operation completed successfully (color = green) FAILED—the operation failed (color = red) Chapter 1 Introduction 29 . Table 2 Field Time Job Status Information Properties Description displays the date and time at which the operation began The format is CCYYMMDD-HHMMSS. Agent Action Status lists the agent on which the operation is being performed lists action to be performed by the configuration manager on the configuration variable specified by a rule lists the current status of the operation.Viewer Figure 2 Job Status Information Dialog Box Table 2 describes the information provided by the Job Status Information dialog box.

You can view the log messages for an operation through the Job Status Information dialog box. 30 PATROL Configuration Manager User Guide . Log File A permanent job status summary can be obtained from the PATROL Configuration Manager log file. For instructions for opening the dialog box. The Job Status Information dialog box displays a pop-up menu. 3 Right-click. 4 Choose View Log File. the PATROL Configuration Manager records the failure in its log file. whose location is specified in the PATROL Configuration Manager initialization file. To view log file 1 Open the Job Status Dialog box. see “Specify the Location of the Log File” on page 46.Log File Diagnostics If an operation fails. The default log file is PCM. 2 Place the cursor on the operation whose log entries you want to view. For more information about the log file.log located in the installation directory. Figure 3 Job Log File Viewer Dialog Box 5 Scroll through the text to determine the cause of the result of the operation. The Job Status Information dialog box displays the Job Log File Viewer dialog box as shown in Figure 3. see “To view job status information” on page 28.

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating a New Configuration File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . colors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Opening a Configuration File . . . Select Virtual Backup Folder Settings. Default Initialization File . . . . . . . . . . . . . . . . . . . . . . . . . . . . Set the Number of Backup Files Retained . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . The following topics are discussed: Managing Configuration Files . . . . . . . . . . . . Storing PATROL Configuration Manager Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . Customize the PATROL Configuration Manager GUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . Set Default for Reporting Localized Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . Specify the Location of Comments Files . . . . . . . . . . Specify the Location of RuleSet Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . Specify the Location of the Log File . . . . . . . . . . .Chapter 2 Setup and Customization of PATROL Configuration Manager 2 This chapter describes how to designate locations (paths and filenames) for PATROL Configuration Manager information. . . . . . . . It also describes how to customize the user interface by allowing you to choose fonts. . . . . . . . . . . . . . . . . . . . . Activate Autosave for Group and Agent Data . . . . . . . . . . . . Managing Advanced Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Specify the Location of Transaction Files. . . . . . . . . Sharing a Configuration among Multiple Users . . . . . . . . . . . . . . . . . . . . . . . Select Transaction Settings . . . Specify the Location of Localized Agent RuleSets . . . . . . . . . . . . . . . . . . . Backup of Initialization Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Determine Whether Agent Authentication Is Used or Ignored . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . and other graphical user interface (GUI) attributes. . Changing Graphic User Interface . . Specify the Location of the Error File . . . . . . . . . . . . . . . . . . . . . . . . . . . . Specify the Location of Queue Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Chapter 2 Setup and Customization of PATROL Configuration Manager 33 33 33 34 34 35 36 37 38 40 42 43 44 46 48 49 51 52 54 55 57 58 59 60 61 62 63 66 31 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Select Backup Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Retaining Backups and Operations . . . . . . . . . . . . . . Specify the Location of Backup Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Specify the Location of Initialization Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Specify the Location of Image Files. . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 Sample Failover Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 Overview of the Process . . . . . . . . . . . 67 32 PATROL Configuration Manager User Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Supporting Failover . . . . . . . . . . . .

Default Initialization File On UNIX platforms. the initialization file that is used can be specified in a shortcut. PATROL Configuration Manager creates a backup copy of the . The default initialization file is the PCM.ini For information about setting the number of backups. the default initialization file is the PCM.ini) files listed below and save the configuration by selecting File => Save. I I I I PCM. If the CS_INI environment variable is not set.Managing Configuration Files Managing Configuration Files The PATROL Configuration Manager stores information about its own set up and configuration in an INI file. CS_INI. the initialization file that is used can be specified by the environment variable. The following initialization files are backed up. Backup of Initialization Files Whenever you modify content that is stored in one of the initialization (*. Multiple PATROL Configuration Manager initialization files can exist but the configuration manager can open and read only one at a time. Chapter 2 Setup and Customization of PATROL Configuration Manager 33 . On Windows platforms.ini file located in the $BMC_ROOT\pconfmgr\ini directory.ini groups.ini agents. You can open other initialization files or create new initialization files.ini rulealiases.ini file located in the $BMC_ROOT/pconfmgr/ini directory. see “Set the Number of Backup Files Retained” on page 60.ini file before writing the new changes to the file. The Configure dialog box changes are applied to the PATROL Configuration Manager initialization file that is opened by clicking OK.

3 Choose the file and click Open. 2 Click Save As on the Configure dialog box. 34 PATROL Configuration Manager User Guide . To open a configuration file 1 In the PATROL Configuration Manager. 3 Specify the new file name. 4 Click Save. choose File => Open 2 Navigate to the desired configuration file.Opening a Configuration File Opening a Configuration File The configuration file is stored in the ini folder. Creating a New Configuration File To create a new configuration file 1 Perform the steps in “Opening a Configuration File” on page 2-34.

Figure 4 Configure: Application – Folders / Paths Tab Chapter 2 Setup and Customization of PATROL Configuration Manager 35 . This section describes the ways in which you can customize the configuration manager to perform optimally in your environment. The tasks described in this section are all performed using the Folders / Paths tab of the Configure: Application dialog box shown in Figure 4.Storing PATROL Configuration Manager Data Storing PATROL Configuration Manager Data PATROL Configuration Manager is itself able to be configured.

ini.ini.ini files.Specify the Location of Initialization Files Specify the Location of Initialization Files PATROL Configuration Manager stores configuration information in *. 2 Click on the open file icon to the right of the Ini Folder text box. Rule Alias definitions are stored in the rulealiases. User interface configuration information is stored in ui. I I I I PATROL Agent configuration information is stored in agents. 3 Navigate to the directory in which you want to store configuration information. choose File => Configure => Application. 36 PATROL Configuration Manager User Guide . Configuration information about groups of agents is stored in groups. 4 Click Open to save the path.ini. Attributes of Configuration Information Table 3 lists the attributes of the information stored in the configuration file for configuration files. Table 3 Ini Folder Value ini_dir directory BMC_ROOT/pconfmgr/ini Configuration Configuration Variable Type of Information Default Value To Determine the Location of the Configuration Information 1 From the Menu Bar.ini.

3 Navigate to the directory in which you want to store RuleSets configuration information.Specify the Location of RuleSet Files Specify the Location of RuleSet Files PATROL Configuration Manager stores RuleSets files (*. choose File => Configure => Application. The default subdirectories created at install time are I I PCM Shipped Attributes of RuleSet Information Table 4 lists the attributes of the information stored in the configuration file for RuleSets. 4 Click Open to save the path.cfg) and their organizing folders and groups directories. All users that will be creating RuleSets need read/write/execute permissions for this directory. Table 4 RuleSet Folder Value ruleset_dir directory BMC_ROOT/pconfmgr/rulesets Configuration Configuration Variable Type of Information Default Value To Determine the Location of the RuleSet Information 1 From the Menu Bar. 2 Click on the open file icon to the right of the RuleSet Folder text box. Chapter 2 Setup and Customization of PATROL Configuration Manager 37 .

cfg extension. .. Definition and Purpose Transaction logs record which rules have been applied to an agent.Specify the Location of Transaction Files Specify the Location of Transaction Files PATROL Configuration Manager allows you to determine where it stores transaction log files./tlog/agent_display_name/datestamp-timestamp.cfg 38 PATROL Configuration Manager User Guide . Use them as the configuration history of the agent. Format. and Naming Convention The files are text files with a *. The default subdirectory created at install time is tlog. Path.

2 Click on the open file icon to the right of the Transaction Folder text box. 3 Navigate to the directory in which you want to store transaction log information. 4 Click Open to save the path. choose File => Configure => Application. Chapter 2 Setup and Customization of PATROL Configuration Manager 39 .Specify the Location of Transaction Files Attributes of Transaction Log Information Table 5 lists the attributes of the information stored in the configuration file for transaction logs. Table 5 Transaction Log Folder Value tlog_dir directory BMC_ROOT/pconfmgr/rulesets/PCM/tlog Configuration Configuration Variable Type of Information Default Value To Determine the Location of the Transaction Log Information 1 From the Menu Bar.

Table 6 Agent Configuration Backup Folder Value backup_dir directory BMC_ROOT/pconfmgr/rulesets/PCM/backup Configuration Configuration Variable Type of Information Default Value 40 PATROL Configuration Manager User Guide . the resulting backup file contains either I any changes/addition to the agents configuration—that is any additions or changes to the values stored in the config.cfg Attributes of Backup Information Table 6 lists the attributes of the information stored in the configuration file for backups of agent configurations./backup/agent_display_name/datestamp-timestamp.default that was installed with the agent any changes/addition to the agents configuration as well as all default values stored in config. Depending upon which menu command you choose. which enable you to restore an agent to its previous configuration.default I The Backup RuleSets can be used to rollback to a previous agent configuration. You can also use them to verify which rules have been applied to an agent. Path. Definition and Purpose Backup RuleSets are created when you perform a Get Configuration or Get Configuration with Defaults on an agent.cfg extension. Format. The default subdirectory created at install time is backup. .Specify the Location of Backup Files Specify the Location of Backup Files PATROL Configuration Manager allows you to determine where it stores agent configuration backup files.. and Naming Convention The files are text files with a *.

Specify the Location of Backup Files To Determine the Location of the Backup Information 1 From the Menu Bar. 3 Navigate to the directory in which you want to store Backup information. choose File => Configure => Application. Chapter 2 Setup and Customization of PATROL Configuration Manager 41 . 4 Click Open to save the path. 2 Click on the open file icon to the right of the Backup Folder text box.

cfg Attributes of Queue Information Table 7 lists the attributes of the information stored in the configuration file for the queue of rules to be applied to agents.. These files are temporarily stored in the Queue directory and then deleted once the rules have been applied to the designated agents. Table 7 Queue of Rules to Be Applied Folder Value queue_dir directory BMC_ROOT/pconfmgr/rulesets/PCM/queue Configuration Configuration Variable Type of Information Default Value To Determine the Location of the Queue Information 1 From the Menu Bar. 4 Click Open to save the path.Specify the Location of Queue Files Specify the Location of Queue Files PATROL Configuration Manager allows you to determine where it temporarily stores rules that are to be applied to selected agents. . choose File => Configure => Application. 3 Navigate to the directory in which you want to store queue information for rules to be applied. Format. If the rules are not applied for whatever reason. Definition and Purpose Queue files are RuleSets that are currently being applied to agents. The default subdirectory created at install time is queue. the RuleSet file remains in the Queue directory.cfg extension. 2 Click on the open file icon to the right of the Queue Folder text box. Use these files to determine whether the application of a RuleSet was successful./queue/agent_display_name/datestamp-timestamp. Path. 42 PATROL Configuration Manager User Guide . and Naming Convention The files are text files with a *.

. To conserve disk space and to ensure that multiple installations of the PATROL Configuration Manager use the same graphics. The default subdirectory created at install time is images.gif extension. Path. 2 Click on the open file icon to the right of the Images Folder text box.gif Attributes of Image Information Table 8 lists the attributes of the information stored in the configuration file for image files. Use these graphics to customize the interface by specifying your own icons./images/graphic_filename. choose File => Configure => Application. 4 Click Open to save the path.Specify the Location of Image Files Specify the Location of Image Files PATROL Configuration Manager allows you to determine where it stores graphic images for use in customizing the interface. and other graphics. Format. Table 8 Image Folder Value images_dir directory BMC_ROOT/pconfmgr/images Configuration Configuration Variable Type of Information Default Value To Determine the Location of the Images 1 From the Menu Bar.. and Naming Convention The files are binary files with a *. 3 Navigate to the directory in which you want to store images for rules to be applied. Definition and Purpose The images directory is used to store graphic files. place the files in a shared location and point the images to it. Chapter 2 Setup and Customization of PATROL Configuration Manager 43 . logos.

and Naming Convention The files are text files with a *. The default subdirectory created at install time is comments. Table 9 Comments Folder Value comments_dir directory BMC_ROOT/pconfmgr/comments Configuration Configuration Variable Type of Information Default Value 44 PATROL Configuration Manager User Guide . etc. Attributes of Comments Information Table 9 lists the attributes of the information stored in the configuration file for the comments files. Definition and Purpose Comment files are text files that contain I I system-generated change entries user-entered information Each comment file is associated with an individual RuleSet. PATROL Configuration Manager will create a comment file for that RuleSet with the name db_servers. warnings.txt extension./comments/1st_directory_name. ./ruleset/db_servers/finance/EOM_settings.) added by other users as well as yourself and descriptions of changes made to the RuleSet. The PATROL Configuration Manager automatically generates the filename of the comments file based on the relative path of the RuleSet.ruleset_name.finance.. Format. Path.EOM_settings.cfg.Specify the Location of Comments Files Specify the Location of Comments Files PATROL Configuration Manager allows you to determine where it stores comments for RuleSets.txt.txt EXAMPLE For a RuleSet stored at . Use them to view information (explanations..Nth_directory_name.2nd_directory_name.

3 Navigate to the directory in which you want to store comments information.Specify the Location of Comments Files To Determine the Location of the Comments Information 1 From the Menu Bar. 2 Click on the open file icon to the right of the Comments Folder text box. 4 Click Open to save the path. choose File => Configure => Application. Chapter 2 Setup and Customization of PATROL Configuration Manager 45 .

.Specify the Location of the Log File Specify the Location of the Log File PATROL Configuration Manager allows you to determine where it stores its log file.log extension.log. and whether or not those actions were successful. and Naming Convention The file is a text file with a *. Format. . The default name is PCM.log 46 PATROL Configuration Manager User Guide . Definition and Purpose The log file is a record of every configuration action (get.) performed using the PATROL Configuration Manager. The default location of the log file is pconfmgr. which users performed the actions. apply. The contents of the log file includes I I I I I the date and time of the action the name of the user who performed the action the action the display name of the agents on which the action was performed the status (success or failure) of the action Use the log file to review what actions have been performed. Path. etc./PCM. on which agents the actions were performed.

4 Type the logfile name. Chapter 2 Setup and Customization of PATROL Configuration Manager 47 . Table 10 Log Folder Value logfile file BMC_ROOT/pconfmgr/PCM. 5 Click Open to save the filename.log Configuration Configuration Variable Type of Information Default Value To Determine the Location of the Log File Information 1 From the Menu Bar.log. 3 Navigate to the directory in which you want to store log file information.Specify the Location of the Log File Attributes of the Log File Table 10 lists the attributes of the information stored in the configuration file for the log files. The default name is PCM. choose File => Configure => Application. 2 Click on the open file icon to the right of the Log File text box.

The default location of the error file is pconfmgr. . Format. and Naming Convention The file is a text file with a *. Path. The default name is PCM. The contents of the error file includes I I I I the date and time of the action the security level the error message other error information Use the error file to review the errors.err Configuration Configuration Variable Type of Information Default Value 48 PATROL Configuration Manager User Guide ./PCM.err extension.err.err Attributes of the Error File Table 11 lists the attributes of the information stored in the configuration file for the error files.. Table 11 Error File Folder Value errorfile file BMC_ROOT/PCM. Definition and Purpose The error file is a record of every error received when doing any PATROL Configuration Manager tasks.Specify the Location of the Error File Specify the Location of the Error File PATROL Configuration Manager allows you to determine where it stores the error file.

Format./PCM/local/agent_display_name. 4 Type the error file name. They cannot be overridden by the application of a global RuleSet. Specify the Location of Localized Agent RuleSets PATROL Configuration Manager allows you to determine where it stores unique rules that are specific to an agent. Definition and Purpose Localized RuleSets allow you to specify rules that are specific to a particular agent.. Use them where necessary to customize the configuration of an agent.cfg Attributes of Localized Agent RuleSet Information Table 12 lists the attributes of the information stored in the configuration file for the localized agent RuleSet files.err. The default subdirectory created at install time is local. 2 Click on the open file icon to the right of the Error File text box. and Naming Convention The files are text files with a *. 3 Navigate to the directory in which you want to store error files. choose File => Configure => Application. 5 Click Open to save the filename. These rules are exceptions to global rules for individual agents.Specify the Location of Localized Agent RuleSets To Determine the Location of the Error File Information 1 From the Menu Bar. .cfg extension. Table 12 Local Folder (part 1 of 2) Value local_dir Configuration Configuration Variable Chapter 2 Setup and Customization of PATROL Configuration Manager 49 . Path. The default name is PCM.

50 PATROL Configuration Manager User Guide .Specify the Location of Localized Agent RuleSets Table 12 Local Folder (part 2 of 2) Value directory BMC_ROOT/PCM/local Configuration Type of Information Default Value To Determine the Location of the Local Information 1 From the Menu Bar. 2 Click on the open file icon to the right of the Local Folder text box. 3 Navigate to the directory in which you want to store localized agent ruleset information. 4 Click Open to save the path. choose File => Configure => Application.

This section describes I how many sets of backups are retained and the organizational structure in which they are stored how many apply operations are recorded and saved I The tasks described in this section are all performed using the Archives tab of the Configure: Application dialog box shown in Figure 5. Figure 5 Configure: Application Dialog Box – Archive Tab Chapter 2 Setup and Customization of PATROL Configuration Manager 51 .Retaining Backups and Operations Retaining Backups and Operations PATROL Configuration Manager enables you to determine how much historical information is retained.

52 PATROL Configuration Manager User Guide . By not selecting this option. choose File => Configure => Application. 2 Select Archives tab. you minimize the amount of disk space used to store backups. Scope These settings apply to all agents. determine whether backups are saved before they are applied to selected agents. To Select Backup Settings 1 From the Menu Bar. You can set the number of backups that PATROL Configuration Manager retains for each agent.Select Backup Settings Select Backup Settings PATROL Configuration Manager allows you to manage your agent configuration backups. PATROL Configuration Manager does not save the agent configuration if it is identical to the most recent backup for the agent. and choose whether backups are made of configurations that have not changed since the last backup was made. 3 Make your selections based on the “Options” on page 2-52. Table 13 Field Backups Save Backup Before Apply Backup Settings Description sets the number of configuration backups that you want to keep for each agent retrieves backup of the current agent configuration and saves it in the PATROL Configuration Manager backup folder before applying new RuleSets This feature allows you to quickly and easily restore an agent’s configuration if you make an error applying RuleSets. Save Identical Backups retrieves configurations from agents and makes backups of the configurations regardless of whether an agent’s configuration has changed since the last backup If this option is not selected. 4 Click OK to save the settings. Options Table 13 lists the options available for Backup Settings.

Select Backup Settings Chapter 2 Setup and Customization of PATROL Configuration Manager 53 .

4 Click OK to save the settings. choose a number or the word Unlimited. 2 Select Archives tab.Select Transaction Settings Select Transaction Settings PATROL Configuration Manager allows you to manage how many Apply operations are saved in the transaction log folder. 54 PATROL Configuration Manager User Guide . choose File => Configure => Application. To Select Transaction Settings 1 From the Menu Bar. Scope These settings apply to all agents. Option You can choose to retain as few as 1 or as many as you perform (Unlimited). 3 In the Transaction Logs list box.

Select Virtual Backup Folder Settings Select Virtual Backup Folder Settings PATROL Configuration Manager allows you to determine how it organizes and presents agent configuration backups. PATROL Configuration Manager adds Agent26 to Folder1. At this point. and so on. After these criteria are met. Agent28 to Folder3. This continues until there are five directories with five backups each. The result is that Folder5 contains Agent20-Agent25. and each folder is filled with the minimum number of agents. the first five backups go into one directory. 5. Table 14 Field Maximum Folders Minimum Agents Per Folder Virtual Backup Folder Settings Description sets the maximum number of virtual folders that are created for backups sets the number of agent backups that are created in a virtual backup folder before a new folder is created. in this case Agents1-Agent5. Chapter 2 Setup and Customization of PATROL Configuration Manager 55 . Then the next five backups go into a new virtual directory. they are added to each folder in turn. the maximum folders and the minimum agents per folder reach their limits. Agent27 to Folder2. Options Table 14 lists the options available for Virtual Backup Folder Settings. if both values are set to five. When Folder1 is filled with the minimum number of agents. EXAMPLE If the Maximum Folder = 5 and the Minimum Agents Per Folder = 5. Results These values work together to manage the display of the virtual agent backup folders. 5. in this case Agents6-Agent10. PATROL Configuration Manager creates Folder2 and fills it with the minimum number of agents. For example. This process continues until the maximum number of folders are created. Scope These settings apply to all agents. PATROL Configuration Manager creates Folder1 and fills it with the minimal number of agents. and as new backups are created.

type the maximum number of virtual backup folders that you want PATROL Configuration Manager to create. 3 In Maximum Folder text box of the Virtual Backup Folder Settings pane. 56 PATROL Configuration Manager User Guide . you must refresh the RuleSets tree view or restart PATROL Configuration Manager to view the changes within the interface. type the minimum number agents that you want to store in each virtual backup folder. choose File => Configure => Application. NOTE If you change the Virtual Backup Folder Settings. 5 Click OK to save the settings.Select Virtual Backup Folder Settings To Select Virtual Backup Folder Settings 1 From the Menu Bar. 2 Select Archives tab. 4 In Minimum Agents Per Folder text box of the Virtual Backup Folder Settings pane.

Figure 6 Configure: Application Dialog Box – Advanced Tab Chapter 2 Setup and Customization of PATROL Configuration Manager 57 . This section describes how to I set the default for generating a report of localized rules before an apply operation is performed determine the frequency with which agent authentication is performed determine the number of backup file retained turn on the autosave feature for group and agent configuration data I I I The tasks described in this section are all performed using the Advanced tab of the Configure: Application dialog box shown in Figure 6.Managing Advanced Settings Managing Advanced Settings PATROL Configuration Manager provides some additional controls over various aspects of the utility.

58 PATROL Configuration Manager User Guide . I select Report Local Rules Before Apply check box to automatically generate a report of localized rules before performing an apply deselect Report Local Rules Before Apply check box to perform an apply operation without first generating a report of localized rules I 4 Click OK to save the settings. set the default. 2 Select Advanced tab. To Set Default for Reporting Localized Rules 1 From the menu bar. choose File => Configure => Application. Scope This setting applies to all apply operations to groups and agents.Set Default for Reporting Localized Rules Set Default for Reporting Localized Rules PATROL Configuration Manager enables you to set a default value for the Report Local Rules Before Apply option whenever an apply operation is performed. 3 In the Local Rules pane. Option You can set the default for all apply operations by selecting or deselecting the check box.

instructs the configuration manage to attempt to authenticate to the agent. To Determine Whether Agent Authentication is Used or Ignored 1 From the menu bar. 3 In the Verification of Agent Identification pane. choose File => Configure => Application. Scope This setting applies to all agents.Determine Whether Agent Authentication Is Used or Ignored Determine Whether Agent Authentication Is Used or Ignored PATROL Configuration Manager enables you to control when it informs you of the success or failure of authentication. The configuration manager provides this information in the Job Status Information dialog box. You would use the Verification of Agent Identification option to let you know whether the /AgentSetup/pconfigRequiresAuthentication rule is set on an agent (not set. results in an ‘ignored’ message). 2 Select Advanced tab. or set to 0. and if it is. You would enable the Use Authentication option in conjunction with the rule /AgentSetup/pconfigRequiresAuthentication to prevent unauthorized users from having the ability to configure the agent. whether authentication is successful. I None—do not use agent authentication Verify on each configuration job—use the user name and password stored in the Secure Key Store for the respective agent to verify the configuration manager’s identity every time the manager interacts with the agent and prevent unauthorized users from making configuration changes Verify only when agent added—use the user name and password stored in the Secure Key Store for the respective agent to verify the configuration manager’s identity when registering an agent to the configuration manager I I 4 Click OK to save the settings. set in the Agent Properties dialog box. Option You can set the default for all agents by selecting or deselecting the check box. The Use Authentication option. Chapter 2 Setup and Customization of PATROL Configuration Manager 59 . set the default. which may or may not require authentication to establish a connection.

agents.ini file and three of it’s backup files would be listed as agents. choose File => Configure => Application. and agents. max_ini_backups. To Set the Number of Backups of Initialization Files Retained 1 From the menu bar. The agent.ini) files are retained. agents. 3 In the File Backup Settings panel. Zero (0) indicates that no backups will be made or retained. 2 Select Advanced tab. The previous version of the .ini~# in which the most recent backup does not have a number following the tilde (~). 60 PATROL Configuration Manager User Guide . I I I I PCM.ini.ini rulealiases.ini file backups to keep enter the number of backups you want.ini~.ini~2. in Maximum .ini) files listed below and save the configuration by selecting File => Save. PATROL Configuration Manager creates a backup copy of the . Scope The following initialization files are backed up. Whenever you modify content that is stored in one of the initialization (*. You can change the number of backups retained.ini file before writing the new changes to the file.ini file is renamed to filename. 4 Click OK to save the settings.ini groups.Set the Number of Backup Files Retained Set the Number of Backup Files Retained PATROL Configuration Manager enables you to determine how many backup versions of initialization (*.ini~1.ini agents. This information is stored in the variable.ini Option The default number of back up is 2.

ini files. choose File => Configure => Application. Option You can enable or disable the automatic saving feature. Scope This setting applies to the groups. To Enable Autosave 1 From the menu bar. 2 Select Advanced tab. select Auto-save enabled. Chapter 2 Setup and Customization of PATROL Configuration Manager 61 . PATROL Configuration Manager does not save changes made to the information that it maintains for agents and groups until you perform a save by choosing File => Save or clicking on the Save button. 3 In the Auto-Saved panel. 4 Click OK to save the settings. PATROL Configuration Manager enables you to save group and agent information automatically when a change to that information occurs.Activate Autosave for Group and Agent Data Activate Autosave for Group and Agent Data By default.ini and agents.

Figure 7 Configure: Application Dialog Box – Fonts / Colors Tab 62 PATROL Configuration Manager User Guide . This section describes how to manipulate the colors and fonts of the GUI to meet your needs. The tasks described in this section are all performed using the Fonts / Colors tab of the Configure: Application dialog box shown in Figure 7.Changing Graphic User Interface Changing Graphic User Interface PATROL Configuration Manager enables you to determine how the appearance of graphical user interface (GUI).

Options Table 15 lists the options available for PATROL Configuration Manager GUI. Scope These settings apply to the PATROL Configuration Manager GUI only. Table 15 Field Scheme Item Item Color Font Foreground/Font Color Foreground/Fonts Colors Settings Description determines whether PATROL Configuration Manager GUI uses the default settings or the custom setting that you define designates the GUI object or control whose characteristics you want to customize defines the color of the GUI object or control specified in the Item text box defines the font of the text in the GUI object or control specified in the Item text box defines the color of the font for the text in the GUI object or control specified in the Item text box and the color of the foreground for those items with both foreground and background colors but no fonts defines the size of the font for the text in the GUI object or control specified in the Item text box defines as bold or unbold the style of the font for the text in the GUI object or control specified in the Item text box defines whether the text in the GUI object or control specified in the Item text box is italicized Font Size Font Style: Bold Font Style: Italic Chapter 2 Setup and Customization of PATROL Configuration Manager 63 .Customize the PATROL Configuration Manager GUI Customize the PATROL Configuration Manager GUI PATROL Configuration Manager allows you to choose the color and fonts that the GUI uses when presenting its objects and controls. The fields and the characteristics that they define do not apply to all GUI objects and controls.

4 From Item list box.OK Status Window .Light Highlight Status Window .Highlight Shadow .First Compare Window Text .Stopped Tables Text (Highlight) Text (Inactive) Text (Normal) Tool Tips Trees Window Borders Window Captions (Active) Window Captions (Inactive) Windows To Customize the PATROL Configuration Manager GUI 1 From the Menu Bar. The bottom portion of the dialog box is the sample pane. choose the object or control that you want to customize. It displays the settings.Reload Warning Lock Status .Dark Shadow Shadow . As you change the settings in step 5—step 9. 2 Select Fonts / Colors tab.Second Controls Lock Status . the sample pane reflects those choices. choose File => Configure => Application.Customize the PATROL Configuration Manager GUI List of Objects and Controls The GUI objects and controls that you can customize include I I I I I I I I I I I I I I I I I I I I I I I I I Compare Window Text .Locked Lock Status . select Custom.Failed Status Window . 64 PATROL Configuration Manager User Guide . 3 From Scheme list box.Unlocked Menus Scroll Bars Shadow Shadow .

choose a color. choose a color. 6 From the Font list box. choose a font. 10 Click OK to save the settings. 9 In the Font Style text boxs. choose the appropriate check box to italicize and/or bold the text. choose a size ranging from 8 to 56. 7 From the Foreground/Font Color list box. 8 From the Font Size list box.Customize the PATROL Configuration Manager GUI 5 From Item Color list box. Chapter 2 Setup and Customization of PATROL Configuration Manager 65 .

5 Open PCM.ini. 2 Copy the Secure Key Store (pcm.ini on the primary computer using a text editor and record the values of the following variables.Sharing a Configuration among Multiple Users Sharing a Configuration among Multiple Users In large enterprises. you must perform a few set up tasks.ini for backup purposes and store it outside of the %BMC_ROOT% directory structure. comments directories to the secondary computer.kdb) from the primary computer to corresponding location on the secondary computer. PCM. Overview of the Process 1 Install PATROL Configuration Manager on both the primary and secondary computers. (stored in a globally accessible location) and the same directories in a common location Using individual configuration files. Sharing a configuration can be achieved by I I Sharing the same configuration file.ini and update the variables to correspond with the failover configuration. open the PCM. several people can be in charge of managing the configuration of PATROL throughout the enterprise. PCM. PATROL Configuration Manager can be set up to allow multiple installations of the configuration manager in different locations and to share the same setup and configuration data. to implement this support. 3 Copy the rulesets. I I I ess_bin_dir ess_jar_path bin_dir On the secondary computer.ini. ini. However. 66 PATROL Configuration Manager User Guide . 4 Make a copy of PCM. (stored locally) that all point to the same directories in a common location Supporting Failover PATROL Configuration Manager provides failover support from one computer to another.

make a copy of PCM. Start PATROL Configuration Manager on the Solaris computer. open PCM. 5.0\Windows-x86 would become ess_bin_dir=/opt/bmc/pconfmgr/common/security/bin_v3. On the Windows computer (primary).ini and store it outside of the %BMC_ROOT% directory structure. Use the Configure: Application dialog box (File => Configure => Application) to update the directories. configure. The configuration manager informs you that all the directories are invalid. open PCM. ess_bin_dir ess_jar_path bin_dir 9. I I I ess_bin_dir ess_jar_path bin_dir For example. On the UNIX computer (secondary).0/ solaris-2-8-sparc Chapter 2 Setup and Customization of PATROL Configuration Manager 67 .ini. locate the following variables and record their value. Table 16 Order 1. Copy the pcm. Sample Failover Setup Process Procedure Install PATROL Configuration Manager on a Windows computer. using a text editor. 8. 2. 6. using a text editor. Paste the directories in the $BMC_ROOT directory on the Solaris computer.ini. 3.Sample Failover Setup Sample Failover Setup Table 16 is a high-level overview of the steps you would take to set up PATROL Configuration Manager to failover from an instance running on a Windows platform to one running on UNIX (specifically Solaris). ess_bin_dir=C:\Program Files\BMC Software\pconfmgr\common\security\bin_v3. Copy the following directories and their content. and test set up.kdb file from %BMC_ROOT%\pconfmgr\security\sks\ to $BMC_ROOT/common/security/sks/ on the Solaris computer. I I I %BMC_ROOT%\pconfmgr\rulesets %BMC_ROOT%\pconfmgr\comments %BMC_ROOT%\pconfmgr\ini 4. locate the following variables and change their values to correspond to the failover configuration. Install PATROL Configuration Manager on my Solaris host. On the Windows computer (primary). I I I 7.

Sample Failover Setup 68 PATROL Configuration Manager User Guide .

. . . . . . . . . . . . . . . . . . . . . . Discovering Rule and Configurations Assigned to Agents . . . . . . Security Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Saving Agent and Group Changes Automatically . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Resetting the Configuration of an Agent to Its Default Configuration . . . Updating the PATROL License File . . . . Selecting an Agent to Be Managed by PATROL Configuration Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deleting a Group . . . . . . . Creating Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Managing Unique User Names and Passwords for Individual Agents . . . . . . . . . . . . . . . . . Managing the Agent Process and Configuration . . . . . . . . . . . . . . . . Stopping an Agent. . . . . . . . . . . . . . . Chapter 3 Add and Manage Agents and Groups . . This chapter presents the following topics: Authentication and Security. . . . . . . . . Sharing Agents and Groups among Multiple Users. . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting Default Agent Values. . . .Chapter 3 70 70 71 73 73 74 76 81 81 81 82 82 83 83 85 85 86 87 88 89 89 91 93 95 95 96 96 98 98 98 69 3 Add and Manage Agents and Groups In PATROL. . . . . . . . . Discovering and Adding PATROL Agents . . . . . . . . . . . . . Finding RuleSets Assigned to an Individual Agent . . . Authentication . . . . . . . . . . . you can associate it in groups with other agents to more easily manage large numbers of similar agents. . . . . . . . . . Setting the PATROL Default Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Specifying an Individual PATROL Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Changing Group Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Locking Agents and Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring PATROL Configuration Manager for Multiple Users. . . . . . Organizing Agents into Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Managing Agent Accounts and Licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deleting an Agent . . . . . . . . PATROL Configuration Manager requires you to identify which PATROL Agents you want it to manage. . . . . . . . . . Reloading the Configuration of an Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating and Managing Agents in Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Locating Agents within PATROL Configuration Manager . . . . . . . . . . . . . . . . . . . . . . . . . Reinitializing an Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Locating the Backup Configurations . . . . . configurations are managed at the agent level. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Once you have registered or added an agent with the configuration manager. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Security Levels When registering an agent with the PATROL Configuration Manager and establishing how the configuration manager will communicate with an agent (port number. PATROL Configuration Manager defaults the security level to 0.ini is not required for PATROL Configuration Manager to function properly. Figure 8 agent. Storage The security level is defined for each agent.ini Sample Entry for Security Level [accts-payable-srvr-1] parent= host=accts-payable-srvr-1 port=2934 seclevel=3 Default The default security level for all agents being registered to PATROL Configuration Manager is set in the Configure: Agent Defaults dialog box as shown in Figure 9 on page 73. If you do not designate a security level in the agent defaults dialog box or in the Agent Properties dialog box. protocol. you can also specify the security level at which they communicate. see either “Setting Default Agent Values” on page 73 or “Specifying an Individual PATROL Agent” on page 74.Authentication and Security Authentication and Security PATROL Configuration Manager is equipped with two security features.ini file as shown in Figure 8. an entry in the agents. 70 PATROL Configuration Manager User Guide . At security level zero. These features include I specifying at which PATROL security level the configuration manager will communicate with an agent providing user credentials to prove the identity of the user I For instructions on how to set the security level and use authentication. The level is saved in the seclevel variable in the agents. and hostname).

Usage PATROL Configuration Manager uses the Secure Key Store to authenticate user credentials during the following operations: I generating reports with PATROL Configuration Manager retrieving objects from PATROL Agent when using the Event Management plugin to manage alert settings and parameter settings using secure PATROL Configuration Database (pconfig utility). see “Managing Unique User Names and Passwords for Individual Agents” on page 91.00 or later and the PATROL Configuration Database (also referred to as the pconfig utility) 3.00 or later. which control access to their individual configuration databases.5. Authentication PATROL Configuration Manager retrieves the user credentials stored in the Secure Key Store and uses them to access PATROL components such as agents.6. The components use the credentials to verify or prove the identity of the user. This process of verifying a user’s identity is called authentication and it is used in some but not all of the configuration manager operations. For information about how to set up and manage user credentials in the Secure Key Store.Authentication Dependencies Communicating with an agent at a designated security level requires both the PATROL Agent 3. which requires that the configuration manager provide user credentials to the PATROL Agent every time it attempts to perform an operation such as an apply or get I I Chapter 3 Add and Manage Agents and Groups 71 .

or set to 0. this option instructs the configuration manage to attempt to authenticate to the agent. you would use the Verification of Agent Identification option to let you know whether the /AgentSetup/pconfigRequiresAuthentication rule is set on an agent (not set. For more information about this feature.Authentication Dependencies Authentication requires PATROL Agent 3. I the agent must have the configuration variable /AgentSetup/pconfigRequiresAuthentication equal to 1 the Use Authentication check box must be selected in the PATROL Configuration Manager agent properties for the agent.00 or later.6. see “Determine Whether Agent Authentication Is Used or Ignored” on page 59. whether authentication is successful. results in an ‘ignored’ message). The results are reported in the Job Status Information dialog box. For secure PATROL Configuration Database (pconfig utility).6.00 or later and PATROL Configuration Manager must be running PATROL Configuration Database (pconfig utility) 3. which may or may not require authentication to establish a connection I Results To learn the results of authentication. and if it is. 72 PATROL Configuration Manager User Guide .

PATROL Configuration Manager displays the Configure: Agent Defaults dialog box as shown in Figure 9. if you attempt to add an agent. choose File => Configuration => Agent Defaults. Figure 9 Configure: Agent Defaults Dialog Box Chapter 3 Add and Manage Agents and Groups 73 . Therefore.Selecting an Agent to Be Managed by PATROL Configuration Manager Selecting an Agent to Be Managed by PATROL Configuration Manager PATROL Configuration Manager provides two ways in which you can identify a PATROL Agent to PATROL Configuration Manager and designate that it manage that agent. The values for which you can set defaults are I I I I port number communication protocol security level use of authentication during configuration operations To Set Default Values for Agents 1 From the menu bar. PATROL Configuration Manager populates the New Agent dialog box with these values. The two methods are I I specifying a individual agent searching a host or IP Address and range of port numbers to identify and specify multiple agents Setting Default Agent Values PATROL Configuration Manager allows you to set the default values for an agent.

the Job Status Information dialog box reports “Authentication unsupported.Specifying an Individual PATROL Agent 2 In the IP Port text box. NOTE The default port number for the PATROL Agent is 3181. If you leave this field blank. If this option is not selected the Job Status Information dialog box reports “Authentication ignored. 2 From the pop-up menu. 3 In the IP Protocol list box.00 or later. type the port number on which a majority of your agents listen.6. choose the security level at which you want to the PATROL Configuration Manager to connect to PATROL Agents.00. Specifying an Individual PATROL Agent Perform this procedure if you have a small number of agents that you want to manage. choose New => Agent. choose the communication protocol used by the agent. select this option if you want pconfig to verify the user credentials stored for the agent in the Secure KeyStore of the configuration manager.6. NOTE PATROL Agent must be 3.” 6 Click OK to save the default values that you have entered. Configuration manager displays the New Agent dialog box.” If the agent or pconfig is earlier than 3. You will need to know the hostnames of the computers on which those agent are running and the port numbers on which those agents are listening.00 or later and the PATROL Configuration Database (pconfig utility) must also be 3. 5 In the Use Authentication check box.6. it defaults to level 0. 74 PATROL Configuration Manager User Guide . The security level that you enter must match the security level at which the agents are running. I I TCP UDP 4 In the Security Level list box. To Add an Agent 1 In the Agent tree view (the left pane of the PATROL Configuration Manager interface). right click the Agent folder or the group folder in which you want to place an agent.

8 In the Use Authentication check box. The configuration manager adds the agent to the Agent tree view. choose the security level at which you want to the PATROL Configuration Manager to connect to PATROL Agents. select this option if you want pconfig to verify the user credentials stored for the agent in the Secure KeyStore of the configuration manager. If the level is not set in that dialog box.00.6. type the port number on which this agent is listening.00 or later. choose the communication protocol used by most of the agents. If you leave this field blank. type a DNS name or IP Address.6. 4 In the Display Name text box. the security level defaults to zero (0). 5 In the Port text box.” If the agent or pconfig is earlier than 3. Only alphanumeric characters (A-Z. the security level defaults to the level specified in the Configure: Agent defaults dialog box.6. type the name that you want to PATROL Configuration Manager to associate with this agent.Specifying an Individual PATROL Agent 3 In the Hostname text box. I I TCP UDP 7 In the Security Level list box. hyphens (-). the Job Status Information dialog box reports “Authentication unsupported. Chapter 3 Add and Manage Agents and Groups 75 .” 9 Click OK. a-z. 6 In the Protocol list box. If this option is not selected the Job Status Information dialog box reports “Authentication ignored. The security level that you enter must match the security level at which the agents are running. 0-9). and underscores (_) are valid. NOTE PATROL Agent must be 3.00 or later and the Patrol Configuration Database (pconfig utility) must also be 3.

3 On the Discovery Type pane. As search criteria. choose Search a PATROL RT Server cloud and then click Next. Types of Agent Discovery Methods PATROL Configuration Manager provides two methods for discovering agents: I I discover agents that are registered to the RT Server cloud discover agents through PATROL Ping The discovery method that you choose depends upon what versions of PATROL are running in your enterprise and which agents you want to manage. The RTserver method identifies agents that use RTservers and Console Servers to communicate with consoles. perform this procedure to discover all of the agents and register the ones that you want. To Locate Multiple Agents in an RT Server Cloud and Register Them 1 From the menu bar. choose Tools => Discover Agents. The PATROL Ping method identifies agents in both PATROL 3 and PATROL 7 installations. 2 Review the steps outlined in the wizard and then click Next. PATROL Configuration Manager opens the Discover Agents Wizard to the Overview pane. 76 PATROL Configuration Manager User Guide . define your search. Results The results of the discovery do not include the security level of the agent or whether the agent requires authentication when establishing a connection to it.Discovering and Adding PATROL Agents Discovering and Adding PATROL Agents If you have a large number of agents that you want to register with the PATROL Configuration Manager. 4 On the Agent Search Criteria pane. the wizard uses the agent properties defaults and supplements them with the protocol and port number that you provide the wizard. which occurs exclusively in a PATROL 7 installation.

use the Remove and Remove All. click Add All. 7 In the Discovery Results pane. I Chapter 3 Add and Manage Agents and Groups 77 . 6 When the wizard finishes its search. click Next to view the results. click Stop. The wizard begins searching for agents based upon the criteria that you specified. RT Server Locator String Agent Name Filter limits the search results to agents that match the criteria specified in this field The following options enable you to refine your filtering: I Partial String Match— include the agent in the search results if part of its name matches the filter string Use Regular Expressions—enables you to use regular expressions to create your Agent Name Filter I (This panel does not have a label. To interrupt the search. from the Discovered Agents list box choose the agents that you want to manage and click Add. separated by a space.) specifies the type and amount of information reported by the search I Include Domain Name in Discovered Host Names— determines whether agent names include the domain in which the agent resides Show Existing Agents—determines if agents that are already registered with the configuration manager are included in the discovery results I 5 Click Next. you can enter multiple RT Server locators. The default value is tcp:localhost:2059. To remove agents from management. I To manage all the agents discovered by the wizard.Discovering and Adding PATROL Agents Table 17 Field Agent Discovery Criteria for RT Server Description enter RT Server locator string in the format: protocol:hostname:portnumber protocol—udp for or tcp for TCP/IP hostname—localhost or the name of the computer on which the RT Server resides portnumber—the port number on which the RT Server is listening To discover agents in multiple RT Server clouds.

3 On the Discovery Type pane. define your search.Discovering and Adding PATROL Agents NOTE Before you move on to the next pane. click Close. 4 On the Agent Search Criteria pane. choose Tools => Discover Agents. To Locate Multiple Agents through PATROL Ping and Register Them 1 From the menu bar. choose Search the network using PATROL Ping and then click Next. PATROL Configuration Manager displays the Summary pane. 78 PATROL Configuration Manager User Guide . 9 To exit the wizard. PATROL Configuration Manager opens the Discover Agents Wizard to the Overview pane. 2 Review the steps outlined in the wizard and then click Next. 8 Click Next. you can change the agent display name that PATROL Configuration Manager will use and the communication protocol with which it will communicate to the agent.

ccc.Discovering and Adding PATROL Agents Table 18 Field Agent Discovery Criteria for PATROL Ping (part 1 of 2) Description the DNS name or IP Address of the computer on which the PATROL Agent resides The name must be valid and conform to the rules of hostnames. The range defaults to 3181-3181. and a dash (-). For example.). Chapter 3 Add and Manage Agents and Groups 79 .all ports. You can also leave this field blank to search. a period (. The name cannot be longer than 255 characters. aaa.bbb.ccc. You can further refine the results of an agent discovery by selecting one or more of the following options: I Host Name or Address Include Entire Class-C Subnet— searches the entire Class-C subnet (defined by the first 3 octets. aaa. enter (3|4)[0-9]{3} to search ports ranging from 3000 to 4999. Characters can be alphanumeric. of the IP Address.ddd) on which the computer designated in the Host Name or Address text box resides Include Domain Name in Discovered Host Names—list the domain to which the computer belongs Show Existing Agents—display the names of agents already being managed by the configuration manager I I Port Range enter the port number or range of ports on which the agent or agents might be listening. the default port for the PATROL Agent.bbb. Enter ranges in regular expression format.

Discovering and Adding PATROL Agents Table 18 Field Protocol Timeout Agent Discovery Criteria for PATROL Ping (part 2 of 2) Description choose the communication protocol. this feature works differently base upon the chosen protocol. For UDP. Because UDP is connectionless. To remove agents from management. the process must wait for the entire length of the timeout period to ensure that a response does not get lost from a slow network. The wizard begins searching for agents based upon the criteria that you specified. Normally. a TCP connection request is accepted or rejected very quickly. I 5 Click Next. 7 In the Discovery Results pane. 8 Click Next. the time out is the time that the discovery process waits for any response after the last packet has been sent out. I NOTE Before you move on to the next pane. and the timeout period rarely expires. 80 PATROL Configuration Manager User Guide . you can change the agent display name that PATROL Configuration Manager will use and the communication protocol with which it will communicate to the agent. click Add All. I For TCP. Due to the differences in implementation between TCP and UDP. To interrupt the search. which is either TCP/IP or UDP specify the amount of time in seconds that the discovery process waits for a response before it quits. I To manage all the agents discovered by the wizard. 9 To exit the wizard. the timeout is the time that the discovery process waits to receive a response to a connection request or to any PATROL communication. PATROL Configuration Manager displays the Summary pane. click Next to view the results. 6 When the wizard finishes its search. use the Remove and Remove All. from the Discovered Agents list box choose the agents that you want to manage and click Add. click Close. click Stop.

To Organize Agents into Logical Groups 1 Choose the agent that you want to move into a group. you can create groups at the top of the hierarchy or within other groups. the PATROL Configuration Manager supports dragging and dropping. To Create a Group 1 In the Agent tree view pane. happens (-). Within the Agent tree view pane. press and hold CTRL as you choose multiple agents. you must move the agents into the groups. right-click the Agent folder or Group folder to which you want to add a group. Chapter 3 Add and Manage Agents and Groups 81 . and underscores (_) are valid. Organizing Agents into Groups Once you have established the groups into which you want to organize your agents. Only alphanumeric characters (A-Z. Groups allow users to organize agents into logical groupings. Each group possesses its own ApplyOnNew container. 4 Click OK to create the group. 2 Right-click the folder and choose New => Group. 2 Drag the agent to the group folder. This capability allows you to consistently and quickly organize and manage large numbers of agents. If you are moving multiple agents. which applies rules contained within it to any agents added to that group. If you want to move more than one agent.Creating and Managing Agents in Groups Creating and Managing Agents in Groups The PATROL Configuration Manager provides the concepts of Groups. Creating Groups In the Agent tree view pane. Groups can be nested and contain subgroups. type the name of the group. PATROL Configuration Manager displays the New Group dialog box. 0-9). press and hold SHIFT as you drag the agents. a-z. Many of the actions that can be performed on agents can be performed on groups. 3 In the Group Name text box.

Such relationships could be geographic (East Coast US. Latin America). 3 In the Group Name text box. right-click the agent that you want to delete. A group’s only editable property is its name. PATROL Configuration Manager displays the Confirm Delete Items dialog box. This task does not remove the agent from the computer on which it is running. To Rename Group 1 In the Agent tree view pane. 3 Click Yes. right-click the group whose name you want to change. Online Order Forms). 2 From the pop-up menu. application-centric (Human Resources Data Base. and underscores (_) are valid.Changing Group Properties Changing Group Properties In PATROL Configuration Manager. choose Delete. PATROL Configuration Manager displays the Group Properties dialog box. the group is an organizing construct that enables you to arrange agents in groups that are meaningful to you and reinforce logical relationships in your environments. 82 PATROL Configuration Manager User Guide . 2 From the pop-up menu. which asks you if you are sure that you want to delete this agent. 4 Click OK. Siberia. Delete an agent when you no longer want to manage it with the configuration manager. or service-oriented (Oracle databases. Only alphanumeric characters (A-Z. Web Services). Deleting an Agent Deleting an agent unregisters the agent from PATROL Configuration Manager. a-z. Mail Server. happens (-). To Delete an Agent 1 In the Agent tree view pane. PATROL Configuration Manager changes the name of the group and displays the new name in the Agent tree view pane. choose Properties. 0-9). delete the existing name and type a new one. Domain Name Servers.

PATROL Configuration Manager displays the Confirm Delete Items dialog box. Locating Agents within PATROL Configuration Manager When managing hundreds or even thousands of agents.Deleting a Group If the agent is duplicated in other groups. WARNING When you delete a group. that instance of the agent is not deleted. you also delete all the agents and subgroups that belong to that group. Deleting a Group Deleting a group unregisters the agents that belong to that group and any of its subgroups from PATROL Configuration Manager. PATROL Configuration Manager enables you to search for an agent or agents based upon the following criteria: I I I I Display name in PATROL Configuration Manager Hostname Port number Protocol Chapter 3 Add and Manage Agents and Groups 83 . 2 From the pop-up menu. 3 Click Yes. right-click the group that you want to delete. If an agent is duplicated in another group. PATROL Configuration Manager redisplays the Confirm Delete Items dialog box. finding a single one by scrolling through the Agent tree view pane can be difficult. which informs you that multiple copies of this agent exist and asks you if want to delete them all. This task does not remove the agents from the respective computers on which they are running. PATROL Configuration Manager removes the agent as you specified. Click No if you just want to delete this instance of the agent. choose Delete. 4 Click Yes if you want to delete this agent from the configuration manager. To Delete a Group 1 In the Agent tree view pane. PATROL Configuration Manager removes the group and all its agents and subgroups.

Port Number enter the port number or range of ports on which the agent or agents might be listening Enter ranges in regular expression format. 4 Click Search.Locating Agents within PATROL Configuration Manager To Search for an Agent within PATROL Configuration Manager 1 In the Agent tree view pane. define your search by filling in the appropriate text boxes. enter (3|4)[0-9]{3} to search ports ranging from 3000 to 4999. Characters can be alphanumeric. 5 In the list of found agents. PATROL Configuration Manager closes the search dialog box and highlights (places focus on) and displays the agent in the Agent tree view pane. which means that an agent using either TCP or UDP to communicate will qualify as a match. Protocol the communication protocol used by the agent Valid values are TCP. choose the one you want to view and then click OK. right-click any agent or group. PATROL Configuration Manager displays the Agent Search Results dialog box. The name cannot be longer than 255 characters. You can also leave this field blank to search all ports. PATROL Configuration Manager displays the Agent Search dialog box. and a dash (-). a period (. and ANY. 2 From the pop-up menu. 84 PATROL Configuration Manager User Guide . For example. 3 In the Agent Search dialog box.). choose Search => Agents. UDP. Table 19 Field Display Name Hostname Agent Search Criteria Properties Description the user-defined name displayed by PATROL Configuration Manager the DNS name or IP Address of the computer on which the PATROL Agent resides The name must be valid and conform to the rules of hostnames.

3 Click Yes. 2 From the menu bar. the agent against which the action will be performed. PATROL Configuration Manager displays the Job Status Information dialog box. 4 If you want to be notified of the stop jobs outcome (success or failure). You can identify the job by the time-date stamp. and the action.Managing the Agent Process and Configuration Managing the Agent Process and Configuration PATROL Configuration Manager allows you to control certain aspects of the PATROL Agents that it manages. choose the agent that you want to stop. choose Tools = >Kill Agent. These capabilities include I I I I Process — stopping an agent — restarting an agent Configuration — reloading the configuration of an agent — resetting the configuration of an agent to the default configuration created at the time of installation Account — setting the PATROL default account — creating unique user names and passwords for individual agents License — updating the PATROL license file Stopping an Agent PATROL Configuration Manager allows you to stop a single agent or a large number of agents with ease of a single menu command. To Stop an Agent 1 In the Agent tree view pane. choose the Redisplay When Updated check box. Chapter 3 Add and Manage Agents and Groups 85 . PATROL Configuration Manager displays the Confirm Kill Agents dialog box. 5 Choose the job that you submitted and click OK. in this case KILL.

Reinitializing an Agent

6 If you selected the Redisplay When Updated check box, PATROL Configuration
Manager displays the Job Status Information dialog box when it attempts to stop the agent and informs you of its success or failure.

Reinitializing an Agent
PATROL Configuration Manager allows you to stop and restart, also referred to as reinitializing, a single agent or a large number of agents with ease of a single menu command. This procedure can be used to stop and restart an agent.

To Stop and Restart an Agent 1 In the Agent tree view pane, choose the agent that you want to stop and restart. 2 From the menu bar, choose Tools = >Reinitialize Agent. PATROL Configuration
Manager displays the Confirm Reinitialize Agents dialog box.

3 Click Yes. PATROL Configuration Manager displays the Job Status Information
dialog box.

4 If you want to be notified of the reinitialize jobs outcome (success or failure),
choose the Redisplay When Updated check box.

5 Choose the job that you submitted and click OK. You can identify the job by the
time-date stamp, the agent against which the action will be performed, and the action, in this case RESTART.

6 If you selected the Redisplay When Updated check box, PATROL Configuration
Manager displays the Job Status Information dialog box when it attempts to restart the agent and informs you of its success or failure.

86

PATROL Configuration Manager User Guide

Reloading the Configuration of an Agent

Reloading the Configuration of an Agent
PATROL Configuration Manager allows you to reload the most recent configuration (also known as the last configuration changes) to the agent. PATROL Configuration Manager checks to see if a newer version of config.default exists. If so, it loads that file and then reapplies any configuration changes that are stored in the PATROL Configuration Database (pconfig utility).

To Reload the Most Recent Configuration of an Agent 1 In the Agent tree view pane, choose the agent whose most recent configuration
you want to reload.

2 From the menu bar, choose Tools = >Reload Agent. PATROL Configuration
Manager displays the Confirm Reload dialog box.

3 Click Yes. PATROL Configuration Manager displays the Job Status Information
dialog box.

4 If you want to be notified of the reload job’s outcome (success or failure), select the
Redisplay When Updated check box.

5 Choose the job that you submitted and click OK. You can identify the job by the
time-date stamp, the agent against which the action will be performed, and the action, in this case RELOAD.

6 If you selected the Redisplay When Updated check box, PATROL Configuration
Manager displays the Job Status Information dialog box when it attempts to reload the most recent configuration of the agent and informs you of its success or failure.

Chapter 3

Add and Manage Agents and Groups

87

Resetting the Configuration of an Agent to Its Default Configuration

Resetting the Configuration of an Agent to Its Default Configuration
PATROL Configuration Manager allows you to set the configuration of an agent to its default configuration. In PATROL, this action is also referred to as purging the configuration because it removes or purges all the configuration changes made to the agent since it was installed.

Before You Begin
Backup the configuration of the agent. Creating a backup RuleSet provides you a means to restore the configuration of the agent.

To Purge the Configuration of an Agent 1 In the Agent tree view pane, choose the agent whose configuration you want to
reset to the default configuration.

2 From the menu bar, choose Tools = >Purge Agent. PATROL Configuration Manager
displays the Confirm Purge dialog box.

3 Click Yes. PATROL Configuration Manager displays the Job Status Information
dialog box.

4 If you want to be notified of the purge job’s outcome (success or failure), selected
the Redisplay When Updated check box.

5 Choose the job that you submitted and click OK. You can identify the job by the
time-date stamp, the agent against which the action will be performed, and the action, in this case PURGE.

6 If you selected the Redisplay When Updated check box, PATROL Configuration
Manager displays the Job Status Information dialog box when it attempts to purge the configuration of the agent and informs you of its success or failure.

88

PATROL Configuration Manager User Guide

Managing Agent Accounts and Licenses

Managing Agent Accounts and Licenses
The PATROL Configuration Manager enables users to change the PATROL Agent Default Account for an agent and update the license file used by that agent. PATROL Configuration Manager also provides a secure method for storing user names and passwords. This information is used by PATROL Configuration Manager to provide extensive and detailed reporting on the agents that it manages. A user must be granted access (explicitly or implicitly through group membership or an ‘allow everyone’ setting) by the ACL of the agent to connect to an agent and modify properties of the agent.

Setting the PATROL Default Account
PATROL Configuration Manager allows you to change the PATROL Default Account used by the agent.

NOTE
If the password for the operating system account that you use as the PATROL Default Account changes, you must change the password for this account in PATROL. However, this feature does not change the operating system account. To change the password for the account at the operating system level, you must use the appropriate operating system utility.

Before You Begin
To change the default account of a PATROL Agent,
I

the account that you are using must be granted configuration permissions in the agent’s ACL, which is stored in the pconfig variable /AgentSetup/accessControlList the pconfig variable /AgentSetup/pconfigRequiresAuthentication must be set to 0 or not exist

I

To Change the PATROL Default Account of an Agent 1 In the Agent tree view pane, choose the agent whose PATROL default account you
want to change.

2 From the menu bar, choose Tools = >Set Default Account. PATROL Configuration
Manager displays the Set PATROL Agent Default Account dialog box.

Chapter 3

Add and Manage Agents and Groups

89

Setting the PATROL Default Account

3 In Account Name, type the user name of the account that you want to make the
default account.

4 In New Password, type the password for the account and then retype it in Confirm
New Password.

5 Click OK. PATROL Configuration Manager displays the Job Status Information
dialog box.

6 If you want to be notified of the job’s outcome (success or failure), select the
Redisplay When Updated check box.

7 Choose the job that you submitted and click OK. You can identify the job by the
time-date stamp, the agent against which the action will be performed, and the action, in this case APPLY.

8 If you selected the Redisplay When Updated check box, PATROL Configuration
Manager displays the Job Status Information dialog box when it attempts to change the default account of the agent and informs you of its success or failure.

90

PATROL Configuration Manager User Guide

Managing Unique User Names and Passwords for Individual Agents

Managing Unique User Names and Passwords for Individual Agents
PATROL Configuration Manager provides a way for you to store securely authentication credentials for individual agents and manage these credentials. This procedure describes how to add and remove from the keystore user name and password information about a per agent basis.

Secure KeyStore
PATROL Configuration Manager uses Secure Key Store database to store and protect authentication credentials (user names and passwords) for either individual agents, system-specific credentials, or all agents, default credentials.

WARNING
The Secure Key Store installed with the PATROL Configuration Manager contains trial keys and certificates that are distributed to and possessed by every user that installs PATROL Configuration Manager. BMC Software recommends that you acquire and use your own keys and certificates. For information about how to configure PATROL Configuration Manager securely in your environment, see the PATROL Security User Guide.

User Credentials Precedence
When retrieving user credentials from the Secure Key Store, PATROL Configuration Manager searches for a system-specific entry. If no system-specific credentials are defined, the configuration manager uses the default credentials. If neither set of user credentials exists, the configuration manager cancels the operation.

Password Management for Secure Key Store
The default password for the Secure Key Store installed with PATROL Configuration Manager is password. To change this password, use the PATROL Security utilities, sslcmd. This utility is located in BMC_ROOT\common\security\bin_v30. For more information about how to use the security utility, see the PATROL Security User Guide.

Chapter 3

Add and Manage Agents and Groups

91

6 Click OK. PATROL Configuration Manager defaults to no authentication required. PATROL Configuration Manager displays the Enter Secure KeyStore Password dialog box. 92 PATROL Configuration Manager User Guide . choose File = >Configure => Security. To Store in the Secure KeyStore Unique User Names and Passwords for Individual Agents 1 From the menu bar. PATROL Configuration Manager saves information and lists it in the dialog box. enter default in the Agent text box and provide a user name and password. PATROL Configuration Manager closes the dialog box. PATROL Configuration Manager displays the Configure: Security dialog box.Managing Unique User Names and Passwords for Individual Agents Password Management for Agents The authentication requirement is defined for each agent. If you want to store a default user name and password to be used for all agents except those with individual credentials.ini is not required for the configuration manager to function properly. Username Password Save Permanently the account name for the PATROL default account the corresponding password for the PATROL default account saves the user name and password in the secure keystore If you do not select this option (indicated by a check mark). If authreq is not defined. 2 Type the password in Password text box.ini file using the variable authreq. the user name/password is stored in memory and will expire and be lost when you end the current PATROL Configuration Manager session. 3 Click Add. An entry in the agents. 4 Specify the agents and their user names and passwords. Table 20 Field Agent Security Configuration Properties Description the display name of a PATROL Agent <default> – The user name and password associated with this entry are used for all agents that do not have an individual entry in the keystore. 5 Click OK. and it is saved in the agents. PATROL Configuration Manager displays the Add: Agent Authentication dialog box.

3 Choose the agent whose user name and password you want to delete from the Secure Keystore. choose the file. choose File = >Configure => Security. PATROL Configuration Manager displays the Confirm Update License dialog box.Updating the PATROL License File To Remove Unique User Names and Passwords for Individual Agents from the Secure KeyStore 1 From the menu bar. 5 Click OK.lic extension. To change this password. choose Tools = >Update License. Updating the PATROL License File PATROL Configuration Manager allows you to update the PATROL License file used by a PATROL Agent. 4 Click Remove. To Update the PATROL License File of an Agent 1 In the Agent tree view pane. 4 Click Yes. PATROL Configuration Manager closes the dialog box. NOTE The default password is password. PATROL license files have a . PATROL Configuration Manager displays the Configure: Security dialog box. choose the agent or agents whose license you want to update. use the appropriate security utilities. 2 Type the password in Password text box. Chapter 3 Add and Manage Agents and Groups 93 . PATROL Configuration Manager displays the Job Status Information dialog box. 2 From the menu bar. and click Open. 3 Navigate to the location of the license file with which you want to update the selected agents. PATROL Configuration Manager displays the Open dialog box. PATROL Configuration Manager displays the Enter Secure KeyStore Password dialog box. PATROL Configuration Manager removes the entry from the dialog box.

Updating the PATROL License File 5 If you want to be notified of the update license job’s outcome (success or failure). in this case LICENSE. 94 PATROL Configuration Manager User Guide . 6 Choose the job that you submitted and click OK. select the Redisplay When Updated check box. the agent against which the action will be performed. You can identify the job by the time-date stamp. and the action. PATROL Configuration Manager displays the Job Status Information dialog box when it attempts to update the license for the agent and informs you of its success or failure. 7 If you selected the Redisplay When Updated check box.

For information about how to activate the autosave feature.Sharing Agents and Groups among Multiple Users Sharing Agents and Groups among Multiple Users PATROL Configuration Manager supports multiple users sharing one set of agents and groups by locking the agent. left-hand corner of the PATROL Configuration Manager main window. you can set PATROL Configuration Manager to automatically and immediately save agent and group information when a change is made to their respective data. By setting the autosaved_enabled variable to true in the PCM. Saving Agent and Group Changes Automatically By default. below the Agent tree view.ini file.ini file or group. PATROL Configuration Manager does not save changes made to the information that it maintains for agents and groups until you perform a save by choosing File => Save or clicking on the Save button. Chapter 3 Add and Manage Agents and Groups 95 . see “Activate Autosave for Group and Agent Data” on page 61. The lock indicator is displayed in the bottom.ini file when one user is actively changing the agents or groups in the Agents tree view.

and thus lock indicators are only shown. To prevent conflicts with overwriting and lost updates. A second configuration involves storing the configuration manager . You cannot edit the groups when a group lock exists. PATROL Configuration Manager locks the objects and their corresponding . If you do not share configuration. I 96 PATROL Configuration Manager User Guide . when one or more users are sharing configurations. you will not utilize PATROL Configuration Manager locking feature.ini files.Configuring PATROL Configuration Manager for Multiple Users Configuring PATROL Configuration Manager for Multiple Users PATROL Configuration Manager can be installed in different locations and configured to allow these multiple installations to share the same setup and configuration data. when one user is manipulating an agent or group.ini files on a network share and then mapping all the configuration manager to the network share and directory. Types of Locks PATROL Configuration Manager uses two types of locks: I group lock–A group lock indicates that another user is editing the PATROL Configuration Manager groups.ini files so that other users will not attempt to update the same objects. see “Sharing a Configuration among Multiple Users” on page 66. Applicable Only to Multiple Users This section discusses how PATROL Configuration Manager implements file locking to protect Agents and Groups. agent lock–An agent lock indicates that another user is editing the PATROL Configuration Manager agents. I For more information. Locking only applies. I One configuration involves designating a single PATROL Configuration Manager as the primary manager and then configuring all other installations of the configuration manager to map to the primary installations . but you can still edit agents within the groups. Locking Agents and Groups PATROL Configuration Manager supports multiple users sharing one set of agents and groups.

NOTE PATROL Configuration Manager supports simultaneous locking of Agents and Groups. left corner of the PATROL Configuration Manager main window. and Behavior Icon Tool Tip Information hovering your cursor over the lock reveals I I I I I I Effect and Action When locked. Table 21 lists the types of locks. PATROL Configuration Manager indicates that either agents and/or groups are locked by placing a red lock icon or unlocked by placing a yellow unlock icon in the bottom. see “Sharing and Locking RuleSet” on page 122. For more information. Status of Locks Locks in PATROL Configuration Manager can have one of two statuses: locked or unlocked. 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 X Window display name. If the agents are not locked when a group is deleted by another user. PATROL Configuration Manager locks both the agents and groups because it does not know what groups are deleted until the other user saves. the menu commands for editing the agents or groups are unavailable. below the Agent tree view. the configuration must be reloaded before menu commands agents or groups are available. To Reload the Configuration. and describes the effects that each status has upon agents and groups within PATROL Configuration Manager. After being unlocked. Chapter 3 Add and Manage Agents and Groups 97 . you could add an agent to a group that no longer exists. Information. NOTE If another user deletes an agent group. displays their respective icons. your menu commands for editing the unlocked objects are unavailable until you refresh the Agents tree view. click the unlock icon and then click Yes in the Reload Configuration dialog box. which is not covered in this section. Table 21 Status Lock Lock Status. describes what information is available for them through tool tips. If the agents and groups are locked by a user. PATROL Configuration Manager publishes information about both locks in the tool tip.Locking Agents and Groups I RuleSet lock—PATROL Configuration Manager also provides locking for RuleSets. if available Unlock When the lock is released.

expands the backup folder. To Locate the Most Recent Backup Configuration for an Agent 1 In the Agent tree view. 3 Choose Locate Latest Backup. PATROL Configuration Manager displays the drop down menu. For information about how to find rule sets assigned to an individual agent. Finding RuleSets Assigned to an Individual Agent The Search LinkedRuleSets feature (right-click selected groups/agents and choose Search => LinkedRuleSets) enables you to find which rules are assigned to selected agents or groups. Therefore. and highlights the rule set folder with the most recent date-time stamp. choose an agent. determining how a single agent is configured (which rule sets are assigned to which agents) by alternately navigating through the Agent tree view and the RuleSet tree view panes can be a timeconsuming task.Discovering Rule and Configurations Assigned to Agents Discovering Rule and Configurations Assigned to Agents Due to the size and complexity of some enterprises. Locating the Backup Configurations This task describes how to locate the most recent backup configuration for a selected agent. 2 Right-click on the selected agent. see “Identifying Linked RuleSets Associated with an Agent” on page 161. PATROL Configuration Manager provides two features to help you find the rule sets assigned to a particular agent and locate the most recent backup configuration of an agent. PATROL Configuration Manager changes focus to the RuleSet tree view. 98 PATROL Configuration Manager User Guide .

. . . . . . . . . . . . . . Memory Usage . . . . . . . . . . . . . . . . . . . . and parameters loaded on the agent. . . . . . . . . . . . . . . . . Printing . . . . . Permissions. . . . . . . . . . . . . Limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . This chapter presents the following topics: PATROL Configuration Manager Report Sources. . . . . . . . . . . . . . . . and Constraints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Output Formats . . . . . . . . . . . Formats. . . . . . . . . . . . . . . . . . Generate a Report Using PATROL Configuration Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Chapter 4 Report on the PATROL Environment 99 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . knowledge modules. . . . . . . . . . . . . . . . . Automated Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Chapter 4 100 100 101 101 102 102 103 104 104 104 109 109 4 Report on the PATROL Environment PATROL Configuration Manager can query agents for information about each agent’s PATROL installation and the application classes. Generating a Report of Local Rules before Applying Rules . . . . . . . . . . . . . . Defining and Generating a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Source of Information . . . . . . . . . . . . . . . .

type. I 100 PATROL Configuration Manager User Guide . PATROL Configuration Manager—The report retrieves information stored by the PATROL Configuration Manager in backup files. PATROL Configuration Manager allows you to control the source of the information. Formats. You can instruct the report to gather information from the following two sources: I PATROL Agent—The report retrieves information from each agent. and version the selected PATROL Agents—version the installed PATROL components—which ones are installed and what version the loaded Knowledge Modules—classes that are active or inactive. parameters Besides permitting users to choose from which agents to gather information and determining the type and amount of information gathered. the information may be stale and thus inaccurate. and Constraints PATROL Configuration Manager Report Sources. Reporting from this source is quicker because it is offline. However. and Constraints The reporting feature of PATROL Configuration Manager provides information about I I I I the Operating System—vendor.PATROL Configuration Manager Report Sources. Source of Information Depending upon the type of information you want to include in a report. instances that are online or offline. Formats. The information that it provides is more accurate and more comprehensive than information from PATROL Configuration Manager. it also allows you to save the report results to text files. Certain types of information can only be gathered from this source. depending upon when certain actions were last performed in PATROL Configuration Manager. Reporting from this source takes longer because it is real-time.

You cannot I I I save report requests—each time you generate a report you must choose on which agents you want to report and what type of information you want to gather view one report online while another report is being generated change the defaults of the report—each time you attempt to generate a report. The next time you attempt to generate a report. PATROL Configuration Manager displays the Reporting: Select Report Criteria dialog box with the following defaults.csv) — Formatted text (.html) — eXtensible Markup Language (. I Online—PATROL Configuration Manager displays the report in a proprietary viewer that allows you to review the report online and also provides a save feature that allows you to save it to a file File—PATROL Configuration Manager writes the report to a file in one of the formats that you specify. — Query For I Agent and OS Information I Active and Pre-loaded Knowledge Modules — User Data From I PATROL Configuration Manager — Send Report To I Report Viewer Chapter 4 Report on the PATROL Environment 101 . using UTF-8 encoding for full localized character support I Limitations The PATROL Configuration Manager has some limitations. Valid formats include — HyperText Markup Language (. You can select criteria other than the defaults for that report. the defaults will be the same. but you cannot alter the defaults for the dialog box.txt).xml) — Comma Separated Value (.Output Formats Output Formats The reporting feature of PATROL Configuration Manager provides its report in two formats.

To Change Memory Allocation on UNIX 1 Navigate to the location of PCM. To change the amount of memory allocated to PATROL Configuration Manager. Memory Usage By default. 2 Open the file in the text editor of your choice. PATROL Configuration Manager allocates 256 MB of memory to itself upon startup.jar & 4 Change the memory heap parameter. 102 PATROL Configuration Manager User Guide .sh on Solaris nohup java -DCS_INI="$CS_INI" -Duser. 5 Save and exit the file. you must edit the Java command line parameter to allocate the memory heap.xdisplay="$DISPLAY" -Xmx256m Xbootclasspath/p:/opt/bmc/pconfmgr/utils/xerces/xercesImpl.sh.jar:/opt/ bmc/pconfmgr/utils/xerces/xml-apis. This amount is more than adequate to perform all tasks in PATROL Configuration Manager. you might need to increase the amount of memory allocated to it. -Xm. However. to the desired size. if you want to run reports on large numbers of agents or agents with very large configurations.jar -jar /opt/bmc/pconfmgr/PCM. in the start up command. Figure 10 Startup Command Line from PCM.Authentication Authentication Reporting requires authentication (user names and passwords) to be configured for each agent on which you want to gather data. 3 Locate the startup command in the shell script. -Xm. For more information. see “Managing Unique User Names and Passwords for Individual Agents” on page 91. Then you must restart PATROL Configuration Manager.

Chapter 4 Report on the PATROL Environment 103 . 1 Choose Start => Settings => Taskbar & Start Menu. 6 In Target. Figure 11 Startup Command Line in Targets Text Box of Microsoft Windows Shortcut "C:\Program Files\BMC Software\pconfmgr\jre\bin\javaw. 3 Navigate to Documents and Settings => All Users => Start Menu => Programs => BMC PATROL. change the memory heap parameter. Microsoft Windows displays the PATROL Configuration Manager Properties dialog box. this location is patrol$home:[tmp]. Microsoft Windows displays the Start Menu dialog box. Microsoft Windows displays the Taskbar and Start Menu Properties dialog box.exe" Xmx1024m "-DCS_INI=C:\Program Files\BMC Software\pconfmgr\PCM. 4 Right-click the PATROL Configuration Manager shortcut or PATROL Configuration Manager (CMD Window) and choose Properties. You must edit them both. Microsoft Windows saves the new setting and closes the dialog box.Permissions To Change Memory Allocation on Windows The installation process for PATROL Configuration Manager installs two shortcuts: PATROL Configuration Manager shortcut and PATROL Configuration Manager (CMD Window) shortcut. -Xm.jar" 7 Click OK. Permissions The account used to perform reporting must have read and write permissions to PATROL_HOME on the agent where the report is generated. On OpenVMS.ini" jar "C:\Program Files\BMC Software\pconfmgr\PCM. to the desired size. 2 Click Advanced. 5 Select the Shortcut tab.

2 From the menu bar. 104 PATROL Configuration Manager User Guide . save it to a file (text. To Define and Generate a Report 1 In the Agent tree view (the left pane of the PATROL Configuration Manager interface). choose the type of information that you want included in the report. choose the agents and groups of agents for which you want to generate a report. Besides the criteria that you select. Generate a Report Using PATROL Configuration Manager Creating a report in PATROL Configuration Manager is simple. 3 In the Query For pane. To print the report. PATROL Configuration Manager displays the Reporting: Select Report Criteria dialog box. choose Tools => Reporting. which it manages. the report includes I I the start and end time.Printing Printing You cannot print the report from the Report Results dialog box. CSV or HTML format) and then print the contents of the file. including time zone summary of total agents by operating system type Defining and Generating a Report PATROL Configuration Manager allows you to customize a report for all or a subset of agents.

This option provides information about which KMs are loaded on the selected agents. The information includes I I I I I Agent and OS Information Host name IP Address Agent version TCP/UDP port used by the agent OS name.00 or higher agent Chapter 4 Report on the PATROL Environment 105 .6. The information includes I I I Component name Description Version Active and Pre-loaded Knowledge Modules Knowledge Module Application Classes (Active and Inactive) This option provides information about which KMs are preloaded on the selected agents. The information includes I I Loaded KM list — Name — Version — Static = true\false Application Class properties — Name — Active = true\false — Discovery Cycle for 3.KML file.Defining and Generating a Report Table 22 Field Type of Information Gathered by the Report (part 1 of 2) Description This option provides information about the selected PATROL Agents and the computer on which the agents are running. The information includes the filename of the .KM or . version and patch version Installed Components This option provides information about PATROL components installed on the selected agents.

00 or later Interval \ Polling Time Localized via PATROL Configuration Manager\PATROL KM for Event Management (__asLocalized__) Parameter Alarm properties — Name: Border. instances. Alarm2 — Active — Minimum and maximum — Trigger — Occurrences — RecoveryActions — State: OK. Alarm1.ALARM 4 If you want to limit the Knowledge Module information in the report to a single application class.6. The information includes the following instance properties I I Name Active = true\false Knowledge Module This option provides information about parameters and their Parameter and Configuration settings on the selected agents.Defining and Generating a Report Table 22 Field Type of Information Gathered by the Report (part 2 of 2) Description Knowledge Module Instances This option provides information about which KMs instances (Online and Offline) are online or offline on the selected agents. The information includes the (Active) following parameter properties I I I I I I Name Active = true/false Type Consumer = Std/Col \Consumer for agents earlier than 3.00 and Standard\ Collector\ Consumer for agents 3. 5 In the Use Data From panel. select the source from which the report gathers information.6. type the name of the application class in the Filter KM Data By text box. I Agent—retrieve in real-time information from the selected agents PATROL Configuration Manager—retrieve offline the information from PATROL Configuration Manager backups files I 106 PATROL Configuration Manager User Guide . WARN. This filter applies only to the knowledge module selections (application classes. and parameters) of the Query For pane.

Chapter 4 Report on the PATROL Environment 107 . 7 In the File name text box. PATROL Configuration Manager displays the Reporting: Report Viewer dialog box. choose a format. click OK. I I Report Viewer—displays the report online in a dialog box Disk—writes the report to a file in one of the following formats: — HyperText Markup Language — comma separated values — formatted text To View the Report Online 1 After selecting Report Viewer. 5 To save the online report to a file. 9 Click OK. 10 Click OK to close the Output Files Created dialog box and then click Close to exit the Report Viewer. If PATROL Configuration Manager cannot generate a report for an agent.Defining and Generating a Report 6 In the Send Report To panel. 2 PATROL Configuration Manager displays the Reporting: Report Generation Status dialog box until the report finishes. 8 In the Files of type text box. which provides the full path and file names of the saved files. 4 Navigate through the report using the scroll bar. navigate to the location where you want to save the report. type name of the report file. which lists the agents that could not be reported on. PATROL Configuration Manager saves the files to the specified location and displays the Reporting: Output Files Created dialog box. PATROL Configuration Manager displays the Save dialog box. PATROL Configuration Manager displays the Reporting: Report Viewer dialog box. click Save Report. select the output format of the report. Otherwise. the configuration manager displays the Reporting: Agents Failed to Generate a Report dialog box. 3 Click View Report. 6 Using the file browser tool.

3 In the File name text box. which lists the agents that could not be reported on. choose a format. 5 Click OK. which provides the full path and file names of the saved files. The number of files varies depending upon the search criteria and output format. navigate to location where you want to save the report. 2 Using file browser tool. 7 Click OK to close the Output Files Created dialog box. PATROL Configuration Manager displays the Reporting: Report Generation Status dialog box until the report finishes. Then the configuration manager displays the Reporting: Agents Failed to Generate a Report dialog box. 4 In the Files of type text box. 108 PATROL Configuration Manager User Guide . PATROL Configuration Manager displays the Reporting: Output Files Created dialog box. 6 Click Close. type name of the report file. click Select. PATROL Configuration Manager displays the Save dialog box.Defining and Generating a Report To Save the Report to a File 1 After selecting Disk.

Automated Reports Automated Reports Some operations in PATROL Configuration Manager provide you with the ability to generate a report and view the potential results of the operation before the operation is performed. select the Report Local Rules Before Apply check box in the Apply RuleSets dialog box as shown in Figure 12. Chapter 4 Report on the PATROL Environment 109 . you can specify the default setting. For instructions on how to set the default. see “Set Default for Reporting Localized Rules” on page 58. To initiate the generation of the report. Figure 12 Apply RuleSets Dialog Box – Reporting Localized Rules before Apply Configure the Report to Run Automatically PATROL Configuration Manager saves the setting for this option in its configuration. In the Configure: Application dialog box. Generating a Report of Local Rules before Applying Rules The Apply operation can generate a report to inform the user if a global rule gets overwritten by a local rule before an apply operation takes place. The apply operation includes the ability to report local rules assigned to agents before global rules are applied to those agents.

all rules in the queue folder are removed and the apply operation is not performed. rule.Generating a Report of Local Rules before Applying Rules Availability The report is available after all RuleSets have been processed by PATROL Configuration Manager and the resulting rules are placed in the queue folder. and agent display name. 110 PATROL Configuration Manager User Guide . Contents The report lists the localized rule and includes its RuleSet name and path. operation. Cancelling If you cancel the operation.

. . . . . . . . . . . edit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . and Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Dragging and Dropping in PATROL Configuration Manager . . . . . . . . RuleSets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating. . . Editing a Rule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Listing Localized Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating a Rule. . . . . . . . . . . RuleSets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Automated Tasks. . . . . . . . Chapter 5 Work with Rules. . . Creating a New RuleSet and New RuleSet Folder . . . . . . . . . . . . . . . . . . . . . . . Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Copying or Duplicating a Rule . . . . . . . . . . . . . . . . and configurations with the PATROL Configuration Manager. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Locating a Rule . . . . . . . . . . . . . . . Benefits of Rules and RuleSets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating. . and Configurations 5 This chapter describes how to create. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Assigning RuleSets to Agents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . The following topics are discussed: Introduction . . . Working with Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . and manage rules. . . . . . . . . . . . . . . . . . and Deleting RuleSets . . . . . . . . . . . . . . . . . . . . RuleSets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating Local RuleSets . . . . . . . . . . . . . . Naming Convention . . . . . . . . . Managing. . . . . . . . . . . . . . . . . . . . . . . . .Chapter 5 113 114 115 115 116 116 117 118 119 121 121 122 122 123 125 125 126 128 129 133 133 137 137 139 140 140 140 141 141 111 Work with Rules. . Editing Local RuleSets . . . . . . . . . . . . . . . . . . . . and Managing Rules . . . . . . . . . . Protecting Rules by Using Local RuleSets . . . . . . . . . . . . . . . . . . . . . . . . Deleting RuleSets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Comparing RuleSets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Editing RuleSets. Order of Operations for Applying Rules. . . . . . . . . . . . . . . . . . . . . . . Deleting a Rule. . . . . . . . . . . . . . . . . . . . . Characteristics . . . . Creating a New RuleSet from an Existing RuleSet. . . . . . . . . . . . . . . . . . . . . . . . . . Sharing and Locking RuleSet. . . . . . . . . . Editing. . . . . . . . . . . . . . RuleSets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Overwriting Local RuleSets . . . . . . . . . . . . . . . and Configurations . . Moving and Copying RuleSets and RuleSet Folders . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . 156 Identifying Linked RuleSets Associated with an Agent. . . . . . . . . . . . . . . . . . . . . . . . 164 Storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 Defining a Rule Alias. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150 Activating/Deactivating Statically Linked RuleSets . . . . . . . . . . . . . . . . . . . . 161 Accommodating Computer-Specific Data . . . . . . . . . . . . 151 Designating RuleSets to Be Applied to New Agents (ApplyOnNew). . . . . . . . . . . . . . . . . . . . . . . . . . 149 Storage . . . . . 146 Restoring All Configuration Changes to an Agent . . . . . . . . . . . . . . . . . . . . . . 148 Scope . . . . . . . 166 112 PATROL Configuration Manager User Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 Getting Configurations . . . . . . . . . . . . . . . . . . . . . . . . 143 Backing Up the Configuration of an Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 Operation. . . 142 Applying Changes to Agent Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148 Types of Automated RuleSets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145 Purging All Configuration Changes from an Agent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 Concept . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149 Change to the Source Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152 Designating RuleSets to Be Applied After Any RuleSet is Applied (ApplyOnApply) . . . . . . . . . . . . . . . . . . . . . . .Manual Methods . . . . . . . . . . 147 Automating Updates to RuleSets . . . . . . . . . . . . . . . . . . . . . . 149 Precedence. . . . . . . . . . . . . . . . . . . . 155 Designating Rules to be Updated Automatically (LinkedRuleSets) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 Viewing and Adding Missing Rule Alias. . . . 163 Predefined Rule Aliases (System Variables) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

PATROL Configuration Manager provides an easy and powerful way for you to create. the power in PATROL Configuration Manager resides in your ability to create a logical and well-conceived organizational principle that enables you to efficiently manage configuration variables.Introduction Introduction PATROL Configuration Manager provides a user-friendly. delete. The fundamental element of a configuration is the configuration variables. However. Some of the categories you might use to define and organize configurations are I application(s) being monitored business services supported such as — email servers — internet commerce servers — parts inventory database I I hardware on which the agent is running operating system on which the agent is running geographical location of the computer such as — building — city — state — country — continent I I Chapter 5 Work with Rules. and Configurations 113 . backup. graphically-based method of managing configurations. edit. protect for overwriting. RuleSets. Rules are a standardized mechanism for manipulating those variables. organize. and apply these rules throughout your enterprise.

Configuration A Configuration is a set of rules. RuleSets A RuleSet is a collection of rules that are associated by the user based on user-defined organizing principles. Rule Alias A Rule Alias is a variable that enables you to insert in a rule a placeholder that is replaced by a computer-specific value when the rule is applied. When a rule belonging to a statically linked RuleSet is updated.default. For a more detailed explanation of these terms. PATROL Configuration Manager asks you if you want to apply this change to all of the agent to which the rule is linked. a rule may also be referred to as key/value or key/value/operation. RuleSets. see “Concepts and Definitions” on page 16. 114 PATROL Configuration Manager User Guide . As users customize the behavior of their agent.Definitions Definitions This section contains brief definitions for Rules.cfg extension. Statically Linked RuleSets A statically linked RuleSet is a RuleSet that is associated with an agent or group of agents by being placed in the either the ApplyOnNew or LinkedRuleSet container of the respective the agent or group of agents. and configurations. the PATROL Agent starts out with a default configuration. A rule consists of the following parts: I I I key—the PATROL Agent configuration database variable (pconfig) value—the value of the configuration variable that is used during the operation operation—operation performed on the variable When the constituent parts of a rule need to be emphasized. they change the configuration of the agent. At installation. stored in the file config. Rule A rule is an instruction applied to a PATROL Agent that instructs the agent to change a variable in its agent configuration database. RuleSets are stored as text files with .

and Configurations The order in which PATROL Configuration Manager process rules. rules assigned to ApplyOnNew and ApplyOnApply are processed after all the rules waiting to be applied and listed in the Agent tree view. RuleSets. and configurations can affect what value is set for a PATROL Agent’s configuration variable. Table 23 Item RuleSets Rules Order of Operations for Applying Configurations Description processed in the order in which they appear under the Agent in the Agent tree view processed in the order in which they appear Rules at the top are processed first. Although. see “Designating RuleSets to Be Applied After Any RuleSet is Applied (ApplyOnApply)” on page 155 Chapter 5 Work with Rules. ApplyOnApply RuleSets designated as Activated ApplyOnApply are processed last For more information. The effectiveness of those configurations depends entirely upon you and I I I what rules you create how you organize those rules into rulesets to which agents you apply those rulesets WARNING PATROL Configuration Manager is a very powerful management utility. local overrides rules. RuleSets. RuleSets. PATROL Configuration Manager can save you innumerable hours in managing the PATROL Agents installed throughout your enterprise. Order of Operations for Applying Rules. the variable will be set with the value specified by the second rule. If two rules apply to the same variable. However. it can also instantaneously replicate poorly conceived configurations throughout your enterprise. Rules at the bottom are processed last. and Configurations 115 . Users can rearrange rules to ensure which one take precedence.Benefits of Rules and RuleSets Benefits of Rules and RuleSets The power of PATROL Configuration Manager lies in its ability to configure thousands of agents with a few simple clicks of a mouse. that is the one closest to the bottom of the list.

you can click the last item and release the mouse button. you must either continue to hold the mouse button down after you click the last item. Managing. or continue hold Ctrl or Shift and click off an object after you select the last item. This does not work in the PATROL Configuration Manager interface. group of agents.Creating. move. The following tasks are presented in this section: I I I I I I I “Creating a New RuleSet and New RuleSet Folder” on page 118 “Creating a New RuleSet from an Existing RuleSet” on page 119 “Editing RuleSets” on page 121 (adding and deleting rules) “Deleting RuleSets” on page 121 “Assigning RuleSets to Agents” on page 122 “Sharing and Locking RuleSet” on page 122 “Comparing RuleSets” on page 123 Dragging and Dropping in PATROL Configuration Manager RuleSets and RuleSet folders can be moved from one folder to another or to an agent. and then drag the items before releasing the mouse button. When you are selecting multiple items to drag. or ApplyOnNew and LinkedRuleSets containers by left-clicking on a RuleSet or folder and dragging and dropping it to a location or using the Drag Left menu command. 116 PATROL Configuration Manager User Guide . Managing. and delete RuleSets using PATROL Configuration Manager. This feature is similar to the Windows Explorer interface. and Deleting RuleSets Creating. and then click any selected item and drag the group. and Deleting RuleSets This section describes how to mechanically create. In Windows. NOTE Drag and drop in the PATROL Configuration Manager interface is different than the standard Windows drag and drop.

Chapter 5 Work with Rules. and choose Copy. To Move Either RuleSets or RuleSet Folders to Another Folder 1 Select the RuleSets or RuleSet folders that you want to move. press and hold Ctrl while you click the RuleSets or RuleSet folders you want to copy. and Configurations 117 . To select multiple RuleSets or RuleSet folders. or you can use menu commands to copy or move RuleSets and RuleSet folders. and continue to hold Ctrl for the next step. press and hold Ctrl while you click the RuleSets or RuleSet folders you want to move.Moving and Copying RuleSets and RuleSet Folders 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. The same RuleSet or RuleSet folder can appear in more than one folder. To Copy Either RuleSets or RuleSet Folders to Another Folder NOTE You cannot move or copy both RuleSets and RuleSet folders at the same time. and continue to hold Ctrl for the next step. 3 Right-click on the folder in which you want to place the copies of the RuleSet or folder. the rule that is a copy of the original does not change. To select multiple RuleSets or RuleSet folders. RuleSets. identical rule. 2 Right-click on a selected item. If you alter the original rule in anyway. and choose Cut. and choose Paste. 3 Right-click on the folder to which you want to move the item. WARNING When you copy a rule from one RuleSet or folder to another. you create a separate. 2 Right-click on a selected item. 1 Select the RuleSets or RuleSet folders that you want to copy. and choose Paste.

A new RuleSet. NewRuleSet. To Create a New RuleSet 1 In the RuleSet tree view. right-click a folder. The new folder is created in the selected folder in the RuleSet tree view as shown in Figure 13. is created in the RuleSet tree view as shown in Figure 14. PATROL Configuration Manager displays the RuleSet Folder menu. 2 Choose New => Folder. PATROL Configuration Manager displays the RuleSet Folder menu. 4 Press Enter to retain the new name. 2 Choose New => RuleSet from the RuleSet Folder menu. the name reverts back to NewFolder. If you do not press Enter. 118 PATROL Configuration Manager User Guide . Figure 13 New RuleSet Folder 3 Edit the name of the new folder by deleting the NewFolder text and typing a new folder name. To Create a New RuleSet Folder 1 In the RuleSet tree view.Creating a New RuleSet and New RuleSet Folder Creating a New RuleSet and New RuleSet Folder Create a new RuleSet folder and RuleSet in the RuleSet tree view. right-click a folder.

identical rule. To select multiple rules. If you alter the original rule in anyway. Chapter 5 Work with Rules. choose rules from an existing RuleSet or from an agent configuration in the backup folder. the name reverts back to NewRuleSet. After you have selected the rules. hyphens (-). and underscores (_) are valid. If you do not press Enter. Creating a New RuleSet from an Existing RuleSet Create a new RuleSet from rules with an existing RuleSet or by copying an entire RuleSet. RuleSets. PATROL Configuration Manager creates a new RuleSet in the current folder. a-z.Creating a New RuleSet from an Existing RuleSet Figure 14 New RuleSet 3 Edit the name of the new RuleSet by deleting the NewRuleSet text and typing a new RuleSet name. Only alphanumeric characters (A-Z. To Create a RuleSet from Rules within an Existing RuleSet 1 In the RuleSet tree view. named NewRuleSet with a copy of the selected rule items. 2 Choose Save As. 4 Press Enter to retain the new name. See “Creating a Rule” on page 126 for more information about creating rules. the rule that is a copy of the original does not change. and Configurations 119 . 0-9). press and hold Ctrl while you click the rules you want to include in your new RuleSet. WARNING When you copy a rule from one RuleSet or folder to another. continue to hold Ctrl and right click one of the selected rules to open the Rule menu. Where to Go from Here Now you can create rules or copy rules from other RuleSets into the new RuleSet. you create a separate.

5 Rename the new RuleSet by right-clicking it. PATROL Configuration Manager displays the folder menu. 2 Choose Copy. choosing Rename. PATROL Configuration Manager displays the RuleSet menu. deleting the existing text. 2 Choose New => RuleSet. deleting the existing text. 5 Select the rule or rules that you want to copy. choosing Rename. click to expand one of the RuleSet that contains a rule that you want to copy. and typing in a new name. 4 Choose Paste. PATROL Configuration Manager displays the rules menu. 8 Right-click on the folder in which you want to place the new RuleSet. 3 Right-click on the folder in which you want to place the new RuleSet.Creating a New RuleSet from an Existing RuleSet 3 Rename the new RuleSet by right-clicking it. 4 In the RuleSet tree view. 120 PATROL Configuration Manager User Guide . 3 Rename the new RuleSet by right-clicking it. right-click the RuleSet that you want to copy. 7 Choose Copy. 6 Right-click the rule or rules. and typing in a new name. and typing in a new name. PATROL Configuration Manager displays the rules. PATROL Configuration Manager creates the RuleSet in the selected folder with the same name as the original RuleSet. To Create a RuleSet by Copying an Existing RuleSet 1 In the RuleSet tree view. To Create a RuleSet by Copying Rules from Several Different RuleSets 1 In the RuleSet tree view. right-click the folder in which you want to create a new RuleSet. deleting the existing text. 9 Choose Paste. choosing Rename.

Editing RuleSets PATROL Configuration Manager creates the rule in the selected RuleSet. and typing in a new name. Before You Begin You must have RuleSets and RuleSet folders to delete. press and hold Ctrl while you click all the RuleSets and RuleSet folders you want to delete. Editing RuleSets Editing RuleSets consists of adding rules to RuleSets by means of creating and copying them. choosing Rename. select the RuleSets and RuleSet folders that you want to delete. deleting the existing text. and Configurations 121 . RuleSets. and deleting rules from RuleSets. To Remove RuleSets and RuleSet Folders from the RuleSet Tree View 1 In the RuleSets tree view. 2 Continue to hold Ctrl and right click one of the selected RuleSets and RuleSet folders. PATROL Configuration Manager displays the RuleSets and RuleSet folders menu. 11 Rename the new RuleSet by right-clicking it. 10 Repeat step 4 through step 9 for each set of rules in a separate RuleSet that you want to combine in the single RuleSet that you created in step 2. see I I I “Creating a Rule” on page 126 “Copying or Duplicating a Rule” on page 128 “Deleting a Rule” on page 133 Deleting RuleSets Delete RuleSets and RuleSet folders from the RuleSet tree view. Chapter 5 Work with Rules. To select multiple RuleSets and RuleSet folders. 3 Choose Delete. For instructions on how to perform these tasks.

PATROL Configuration Manager closes the dialog box and removes the selected object (RuleSet or folder) and any other subordinate objects such as folders.Assigning RuleSets to Agents PATROL Configuration Manager displays the Confirm Delete Items dialog box. 122 PATROL Configuration Manager User Guide . if you try to perform an action on a RuleSet that is being edited by another user. the cursor changes from a circle with a diagonal line through it to a folder with a plus. press and hold Ctrl while you click all the RuleSets and RuleSet folders you want to assign to an agent. The configuration manager does not provide a visual indication that a RuleSet is locked. To Assign RuleSets to an Agent 1 In the RuleSet tree view. PATROL Configuration Manager I changes the color of the agent icon to which you assigned the rules places the rules under the agent icon so that you can expand the hierarchy and view the rules that are assigned but not yet applied to each agent enables the Tools => Apply option in the menu bar I I Sharing and Locking RuleSet PATROL Configuration Manager supports multiple users sharing RuleSet folders by locking a RuleSet when one user is editing the RuleSet. However. 4 Click Yes. see “Applying Changes to Agent Configurations” on page 143. choose one or more RuleSets or RuleSet folders. For instructions on how to apply configurations (assigned rules and RuleSets) to an agent. To select multiple RuleSets and RuleSet folders. When the cursor is over a group or agent. 2 Drag the selected RuleSets and/or folders to the desired agent or group. and rules. and release the mouse button. RuleSets. PATROL Configuration Manager displays the File Locked dialog box as shown in Figure 15. Assigning RuleSets to Agents RuleSets must be assigned to agents or groups of agents before than can be applied.

and Configurations 123 . 2 In the RuleSet tree view.Comparing RuleSets Figure 15 File Locked Dialog Box The File Locked dialog box indicates I I I who owns the lock what the time the lock was created from which computer the user is editing the RuleSet Comparing RuleSets PATROL Configuration Manager provides a comparison feature that enables you to determine if two RuleSets contain the same rules. which by default displays all rules from both RuleSets. 3 Right-click on one of the two selected RuleSets and choose Compare. PATROL Configuration Manager displays the RuleSet Comparison dialog box. 4 Choose which rules the dialog box displays. Chapter 5 Work with Rules. NOTE You can compare the configurations of two agents by getting their configurations and then comparing their respective backup RuleSets as described in the following procedure. This RuleSet will be designated by the Compare utility as the Second RuleSet. RuleSets. To Compare Rules within Two RuleSets 1 In the RuleSet tree view. press and hold Ctrl and click a second RuleSet. click a RuleSet. The RuleSets can reside anywhere within the RuleSet folder hierarchy. This RuleSet will be designated by the Compare utility as the First RuleSet.

PATROL Configuration Manager displays the Save Selected Rules dialog box. choose the rules that you want to save to a new RuleSet. PATROL Configuration Manager creates the new RuleSet under the RuleSet folder. 0-9). 2 Click Save Selections. hold down Ctrl while you click the individual rules. click on the rule at the top or beginning of your range and then hold down Shift while clicking on the bottom or end of the range. 3 In the RuleSet Name field. and underscores (_) are valid. Only alphanumeric characters (A-Z. enter a name for the new RuleSet. 124 PATROL Configuration Manager User Guide .Comparing RuleSets Table 24 Option All RuleSet Comparison Display Properties Description displays all rules within both RuleSets displays only rules which have the same variable and operation but a different value displays only rules which have the same variable. To select a range. To select multiple rules that are not contiguous. operation. and value display only those rules that exist in the First RuleSet display only those rules that do not exist in the Second RuleSet display only those rules that exist in the Second RuleSet display only those rules that do not exist in the First RuleSet indicates the difference in the rule between the two rulesets < > = <! >! the rule is only in the 1st ruleset the rule is only in the 2nd ruleset the rule matches in both rulesets the rule has been modified in the 1st ruleset the rule has been modified in the 2nd ruleset Different Values Same Values First RuleSet First Unique Second RuleSet Second Unique Results * Rule / Variable Operation Value displays the rule / variable name displays the type of operation that the rule performs displays a numerical value or text string To Save Selected Rules to a New RuleSet 1 After completing step 1 through step 4 on page 123. a-z. hyphens (-).

PATROL Configuration Manager enables you to create and edit such rules. This option does not allow empty variable names and checks for the following conditions: I I I I I I must begin with a forward slash / must enclose Rule Aliases in percent signs such as %myRuleAlias% cannot end and with a forward slash / cannot contain 2 consecutive forward slashes // cannot contain quotes “ cannot end with an escape sequence such as \n NOTE While specifying values for variables with the PATROL Configuration Manager (PCM). If a variable name does not comply with the naming conventions. ensure that the values of the variables do not contain quotes (“).6.50 or later strictly enforces these guidelines.Creating. PATROL Configuration Manager supports the pconfig +strict option for apply operations. Editing.00 or later employs the pconfig utility +strict option. This section describes the following tasks: I I I I I “Creating a Rule” on page 126 “Editing a Rule” on page 129 “Copying or Duplicating a Rule” on page 128 “Deleting a Rule” on page 133 “Locating a Rule” on page 133 Naming Convention PATROL Configuration Manager 1. The invalid variable name is listed in the job log. RuleSets.6. and Managing Rules Creating. Failure PATROL Agent 3. which enforces strict guidelines for naming variables. PATROL Configuration Manager either drops the variable name and the agent places a note in the agent log or fails the operation. the Job Status Information dialog box displays the error message: FAILED – Invalid Variable Name. Chapter 5 Work with Rules. and Managing Rules The fundamental element of a configuration is the configuration variables. Rules are standardized mechanism for manipulating those variables. Editing. and Configurations 125 . If a variable name is invalid.

PATROL Configuration Manager displays the RuleSet dialog box as shown Figure 16. see PATROL Script Language (PSL) Reference Manual. For more information about valid variable names for the pconfig function. which do not employ the strict option. The default is true (strict enforcement enabled). right click a RuleSet and choose New Rule. Use Rule Aliases to handle unique computer-specific information that is built into the variable names.ini. Creating a Rule In this task you create a rule by specifying a pconfig variable. The feature will be turned off if pconfig utility is not at least version 3. I To Create a Rule 1 In the RuleSets tree view.6. This variable either enables or disables the strict adherence to the naming convention for rule variables.6. Before You Begin I Use the New Rule command to insert a new rule into the selected RuleSet. Volume 2 .50.Creating a Rule Backward Compatibility To support versions of PATROL Agent earlier than 3. you can add the pconfig_use_strict variable to PCM. see “Accommodating Computer-Specific Data” on page 163. Figure 16 RuleSet Dialog Box 126 PATROL Configuration Manager User Guide . and the relationship between the variable and the value.PSL Functions. For more information about Rule Aliases.50. its value.

Chapter 5 Work with Rules. MERGE. These operations do not work when the list items are separated by new lines. and cannot contain quotation marks (“). The rule properties are described in Table 25 on page 127. The PATROL KM for Event Management stores Event Management Rules as PATROL Agent configuration variables. and APPEND operations only work with lists of values when the list is comma separated. If you want to use a Rule Alias. the alias name must be enclosed in percent signs (%). must start with a forward slash (/). like such %alias_name%. and typing or selecting a value.) I I I I Value The value that is used with the operation. 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. NOTE DELETE. Table 25 Property Variable Rule Properties Description the PATROL Agent configuration variable name Variable names are case sensitive. Operation the action that the rule performs on the variable using the specified value The following operations are available: I DELETE—deletes the value of the variable and leaves it blank on the agent (Only deletes it if it is there. the alias name must be enclosed in percent signs (%). like such %alias_name%. 3 Click OK to save the new rule. clicking in the field. RuleSets. If you want to use a Rule Alias. and Configurations 127 .Creating a Rule 2 Enter the rules properties by placing the cursor in the field.

4 Right-click the RuleSet and choose Paste. but unrelated rules. thus placing two identical rules in the RuleSet. To Duplicate a Rule 1 Navigate to the rule that you want to make an identical copy of. 2 Right-click the rule and choose Duplicate. are applied to an agent. 3 Navigate to the RuleSet to which you want to paste it. 128 PATROL Configuration Manager User Guide . If you want to copy a rule into the same RuleSet. PATROL Configuration Manager does not allow you to copy and paste a rule into a RuleSet that already contains a rule identical to it. To Copy a Rule 1 Navigate to the rule that you want to copy. PATROL Configuration Manager attempts to apply the rule twice. 2 Right-click the rule and choose Copy. each containing an identical rule to the other. If two RuleSets. choose Duplicate. If you change either the original rule or the copy of the rule.Copying or Duplicating a Rule Copying or Duplicating a Rule Copying a rule from one RuleSet to another creates two identical. that is they are not linked. the change does not affect the other rule. PATROL Configuration Manager places a rule identical to the one that you selected in the RuleSet.

Each rule is presented as a text string separated from the next rule by comma and an end of line character. To Edit Multiple Rules that Belong to the Same RuleSet 1 In the RuleSets tree view. PATROL Configuration Manager displays the Edit Configuration Source File dialog box as shown in Figure 17. right click a RuleSet and choose one of the following commands: Edit => Source—edit the RuleSet using a text editor Edit => Rules—edit the RuleSet in a table form NOTE If you right click a rule and choose Edit. 2 When you choose Source. instance name. WARNING The Edit Configuration Source File dialog box does not provide syntax checking. Figure 17 Edit Configuration Source File Dialog Box 3 Locate the rule that you want to edit. You can either scroll through the list or use the Find feature to search for the rule based on a unique aspect of it such as pconfig variable name. This dialog box lists all the rules within the RuleSet. RuleSets. and Configurations 129 . they vary in the amount of control they afford you and the number of rules that you can edit at one time. Chapter 5 Work with Rules. however. or value. All the methods allow you edit the rules. you can edit a single rule using the same steps on page 126 involved in creating a rule.Editing a Rule Editing a Rule PATROL Configuration Manager provides several methods for editing individual rules. Typing errors can cause rules to fail.

D If case sensitivity applies. PATROL Configuration Manager closes the Find dialog box and highlights the first occurrence that matches. use the Replace feature. value. or other entity upon which you are basing your search. type the whole or partial name of the variable. value. type the whole or partial name of the variable. C If case sensitivity applies. E Click Replace to the current match and find the next one or click Replace All to replace all matches. PATROL Configuration Manager displays the Edit Configuration Source: Find dialog box. 6 Change the properties of the rule by deleting the characters that you want to change and replacing them with the desired ones. B In the Find What field. A Click Find. or other entity upon which you are basing your search. type the whole or partial name of the variable. A Click Replace. 5 After you have located the rule that you want to edit. D Click Find Next. place the cursor in the rule. select the Case Sensitivity Search check box. C In the Replace With field. instance. 4 If you want to search for and replace an entity within a rule (such as an instance name or a common prefix for a configuration variable name). 130 PATROL Configuration Manager User Guide . and click to insert the cursor. instance.Editing a Rule To Search through a large RuleSet for a single rule. instance. PATROL Configuration Manager displays the Edit Configuration Source: Find / Replace dialog box. B In the Find What field. select the Case Sensitivity Search check box. or other entity upon which you are basing your search. value.

Figure 20 displays an example of one such dialog box. You can also edit the value by selecting a row in the table and clicking Edit Value. PATROL Configuration Manager displays the Event Management-specific dialog box designated by the rule value that you are editing. PATROL Configuration Manager displays the Edit Rule/Value dialog box as shown in Figure 19. value) in a cell. Figure 19 Edit Rule Variable Dialog Box If the selected rule is an Event Management rule. Each rule is presented in a row with each property (variable. Figure 18 RuleSet Dialog Box 1 Edit the values by clicking in the table cell for a property and typing in a new value or selecting an option (Operator only). operation. and Configurations 131 . This dialog box lists all the rules within the RuleSet in a table format. Chapter 5 Work with Rules. RuleSets.Editing a Rule To Edit Rules Assuming you chose Rules in step 1 of “Edit Multiple Rules that Belong to the Same RuleSet” on page 129. PATROL Configuration Manager displays the RuleSet dialog box opens as shown in Figure 18.

2 Edit the rule values and click OK. For more information about Event Management Commands. 132 PATROL Configuration Manager User Guide . see “Establish Notification and Manage Alerts” on page 187. You cannot add or remove Objects. See Table 25 on page 127 for a description of the rule properties.Editing a Rule Figure 20 Edit Value for Event Management Rule Example NOTE Only the value of the rule can be edited for an Event Management rule when the dialog is accessed by selecting a notification rule and clicking Edit Value.

Chapter 5 Work with Rules. Manually searching for a single rule or a few rules can be time consuming and error prone. you must recreate it or copy it from a backup ruleset. 3 Click Yes. 2 Right-click the rule and choose Delete. Searches can be conducted by I I I I variable operation value any combination of the three Matches can be refined to I I I I I I include partial strings be case sensitive use regular expressions search all subfolders search only most recent backups return results with no matches Once the search utility has returned its results.Deleting a Rule Deleting a Rule Deleting a rule in PATROL Configuration Manager is final. if one exists. Locating a Rule RuleSets and configurations can contain hundreds and even thousands of rules. The configuration manager does not have an undo or undelete feature. and Configurations 133 . you can either save them to a text file or write them to a new RuleSet. To Delete a Rule 1 Navigate to the rule that you want to delete. or an identical rule in another RuleSet. RuleSets. To restore the rule. PATROL Configuration Manager provides a search utility that allows you to search for rules across folders and/or RuleSets. PATROL Configuration Manager displays the Confirm Delete Items dialog box.

2 Choose Search.Locating a Rule To Search for a Rule 1 In the RuleSet tree view. Figure 21 RuleSet Search Dialog Box 3 Use the RuleSet Search dialog box to define the search for a rule or rules. 134 PATROL Configuration Manager User Guide . The criteria are described in Table 26. PATROL Configuration Manager displays the RuleSet Search dialog box as shown in Figure 21. right-click the selected RuleSet folder or a RuleSet.

or value fields matches the entry determines whether the search uses case as a criteria for a successful match determines whether regular expressions can be used to define criteria for a successful match For more information about regular expressions.” on page 281. and Configurations 135 . PATROL Configuration Manager displays the Search Results dialog box which lists all the rules that match the search criteria. see Appendix B. operator. To preserve the results of your search. click on the rule at the top or beginning of your range and then hold down Shift while clicking on the bottom or end of the range. To select multiple rules that are not contiguous. you have two options: I Save the rules in a new RuleSet which will appear directly under the RuleSet folder in the hierarchy Save the results as a report in text file format I To Save Selected Rules to a New RuleSet 1 After completing step 1 on page 134 through step 4 on page 135. Chapter 5 Work with Rules. choose the rules that you want to save to new RuleSet. “Supported Regular Expressions. case sensitive use regular expressions search all subfolders determines whether the search is performed in the immediate folder only or if it includes all folders below the selected one in the hierarchy limits the search to the last set (most recent) of backup configurations determines whether the search facility closes or redisplays the dialog if no matches are found search only most recent backups return results with no matches 4 Click OK. Operator Value include partial strings part or all of the operation to be performed on the variable with the value part or all of the value string specified in the rule determines whether the search defines a successful match if only part of the information entered in one of the variable. To select a range. hold down Ctrl while you click the individual rules.Locating a Rule Table 26 Field Variable RuleSet Search Properties Description part or all of the PATROL Configuration variable name Regular expressions can be used if Use Regular Expressions is selected. RuleSets.

To Save Rule Search Results in a Report 1 After completing step 1 on page 134 through step 4 on page 135. enter a name for the new RuleSet. 0-9. operation. hyphens (-). a-z. Show RuleSet Show Rule Show Operation Show Value the RuleSets in which the rule appears the name of the pconfig variable affected by the rule operation performed by the rule the numerical value or text string assigned to the rule 3 Click OK. click OK. and underscores (_) are valid. PATROL Configuration Manager saves the report to the file and displays the report in the Report Viewer. 4 Navigate to the location where you want to save the file and type in the name. 7 Click OK to exit the search dialog box.Locating a Rule 2 Click Save Selections. and value fields the user-defined name assigned to the agent in PATROL Configuration Manager This information is available only for backup RuleSets and local RuleSets. PATROL Configuration Manager creates the new RuleSet under the RuleSet folder. 6 When you are done viewing the report online. 5 Click Save. 2 Choose the information to include in the report. 136 PATROL Configuration Manager User Guide . click Save Report. 3 In the RuleSet Name field. PATROL Configuration Manager displays the Report Options dialog box. Table 27 Option Show Search Criteria Show Agent Display Name Rule Search Results Report Options Description the information entered in the variable. Only alphanumeric characters (A-Z. PATROL Configuration Manager displays the Save dialog box. PATROL Configuration Manager displays the Save Selected Rules dialog box. Table 27 describes the options.

you can indicate which rules. and by extension which agent configuration variables. Characteristics Local RuleSets are distinct from other RuleSets based upon the location in which they are stored. I Each agent can have only one Local RuleSet. RuleSets. Local RuleSets prevent the accidental overwriting by a global rule of a rule unique to an agent. which resides under the RuleSets folder. The name of each agent-specific RuleSet is the agent display name. Location Local rules are stored in a special RuleSet folder within the PCM folder. I Chapter 5 Work with Rules. their behavior.Protecting Rules by Using Local RuleSets Protecting Rules by Using Local RuleSets Using Local RuleSets. This feature provides a way to protect configurations for individual agents and to track and manage localized changes by computer. are unique to a particular agent. Local RuleSet contains localized settings that cannot be overwritten when you apply configurations globally. and Configurations 137 . Figure 22 Local RuleSet Folder Behavior The following behaviors are unique to Local RuleSets. which can contain one RuleSet per agent. and the automated synchronization of their names and the names of the agents to which they apply. The local rules folder is called local.

the conflicting global rule is removed from the apply set. 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 local RuleSet for the agent is renamed to match the new name.Characteristics I 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. If an agent is deleted. — If the operation is DELETE. the rules are moved to the bottom of the apply list (the last rules considered by the agent). 138 PATROL Configuration Manager User Guide . PATROL Configuration Manager prompts you to delete the related local RuleSet. Synchronization of Agents and Local RuleSets If an agent is renamed. — If the operation is MERGE or APPEND. the rule is moved to the bottom of the apply set so that the REPLACE occurs first.

Creating Local RuleSets Creating Local RuleSets In this task you create a local RuleSet for an agent. Chapter 5 Work with Rules. The New Local RuleSet dialog box opens as shown Figure 23. and Configurations 139 . To ensure the RuleSet name matches the agent name. Before You Begin Because each agent can have only one Local RuleSet. To Create a Local RuleSet Folder 1 In the RuleSets tree view. 2 Choose the agent for which you want to create a local RuleSet for and click OK. you must have an agent without a local RuleSet to perform this task. Figure 23 New Local RuleSet Dialog Box The local folder contains RuleSets that have the same display name as the associated agent. PATROL Configuration Manager creates a RuleSet with the agent’s name in the local folder. RuleSets. right-click the local folder and choose New => RuleSet. 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.

the configuration manager gives you the option to generate a list of localized rules on the agent or agents to which the RuleSet is being applied. and Managing Rules” on page 125 and “Creating. customizations that have been to an agent may be undone. Overwriting Local RuleSets During an apply RuleSets operation. If you select this option. 140 PATROL Configuration Manager User Guide . The report contains the following information: I I I I RuleSet rule/variable operation agent for which the rule is localized For information about how to generate a report of localized rules. the configuration manager gives you the option to overwrite existing Local RuleSets with the global rules currently being applied. The only time a Local RuleSet’s name changes is when the display name for its associated agent changes. For instructions on how to edit Local RuleSets. Listing Localized Rules During an apply RuleSets operation. and Deleting RuleSets” on page 116. You can perform the following actions on Local RuleSets: I I I I I I I add a new rule to edit rules within copy rules from paste rules into delete rules delete a local RuleSet search for rules within However. see “Applying Changes to Agent Configurations” on page 143. For information about how to overwrite Local RuleSets. Managing. Editing. see “Creating. see “Applying Changes to Agent Configurations” on page 143. you cannot rename a Local RuleSet.Editing Local RuleSets Editing Local RuleSets Local RuleSets possess the same features as other types of RuleSets in PATROL Configuration Manager.

These tasks can be executed from either the menu bar or the tool bar or the Agent tree view popup menus or the Rule tree view pop-up menus.Working with Configurations Working with Configurations Working with configurations is equivalent to managing rules at an agent and group of agents level. including its automated tasks for applying and gathering configurations. and apply a designated set of rules after any apply is performed in order to preserve certain variable settings. apply a standard RuleSet to all agents added to a particular group. this feature allows you to restore the configuration of an agent to its installed defaults Manual Methods PATROL Configuration Manager provides menu-command controls for all its tasks. this feature allows you to restore the configuration of an agent from a certain point in time I Purge—instructs PATROL Configuration Manager to delete all the configuration changes made to the agent and revert back to its default configuration. the configuration manager provides the option to automate the following configuration tasks: I Backup—instructs PATROL Configuration Manager to record the configuration of an agent at a specific date and time. and Configurations 141 . Chapter 5 Work with Rules. RuleSets. The following tasks are presented in this section: I I I I I “Getting Configurations” on page 142 “Applying Changes to Agent Configurations” on page 143 “Backing Up the Configuration of an Agent” on page 145 “Purging All Configuration Changes from an Agent” on page 146 “Restoring All Configuration Changes to an Agent” on page 147 Automated Tasks When applying a configuration. PATROL Configuration Manager has some built in features that enable you to perform automatic backups before resetting an agent’s configuration to its default values.

default file at the time of the get operation. 2 Right-click on an agent and choose Configuration => Get with Default. This information is also saved in the backup folder and assigned a datetime stamp. To Get Copy of the Current Agent Configurations and Default Configuration 1 In the Agent tree view. PATROL Configuration Manager saves the agent configuration as RuleSet 20040813-115450 in the Agent_5__bmc_com folder in the Agent_1__bmc_com Agent_5__bmc_com virtual folder. It does not retrieve the default configuration values stored in config. 2 In the toolbar.Getting Configurations Getting Configurations The Get Configuration feature creates copies of agent configurations in the PATROL Configuration Manager backup folder that is displayed in the RuleSet tree view. choose one or more agents.default file at the time of the get operation. The configuration manager stores them in the following hierarchy in the RuleSet tree view. either click Get Configuration choosing Configuration => Get. RuleSet\PCM\backup\virtual_backup\agent_name\date_time or right-click on an agent and EXAMPLE You retrieve the configuration of agent Agent_5__bmc_com at 11:54:50 on August 13. PATROL Configuration Manager retrieves the changes to the configuration and the default configuration values from the config. The Get With Defaults feature creates a copy of the agent configuration and creates a rule for every default variable defined in the config. RuleSet\PCM\backup\virtual_backup\agent_name\date_time 142 PATROL Configuration Manager User Guide . To Get Copies of Agent Configurations 1 In the Agent tree view.default. choose one or more agents. 2004. This constitutes a complete back up of the agents configuration. The agent configuration is time stamped with the date and time that the configuration was retrieved. PATROL Configuration Manager retrieves the changes to the configuration and stores them in the following hierarchy in the RuleSet tree view.

Chapter 5 Work with Rules. you must assign RuleSets to one or more Agents. The properties are described in Table 28. RuleSets. or from the menu bar choosing PATROL Configuration Manager displays the Apply RuleSets dialog box as shown in Figure 24.default file that was installed with the agent and a series of changes that are managed by PATROL Configuration Manager. To Apply RuleSets to an Agent 1 In the toolbar.Applying Changes to Agent Configurations Applying Changes to Agent Configurations An Agent’s configuration consists of a default configuration defined by the config. This section describes how to apply those changes to the configuration of agents. and Configurations 143 . click Apply Configuration Queue => Apply. see “Assigning RuleSets to Agents” on page 122. Before You Begin Before you can apply configuration changes to an agent or agents. Figure 24 Apply RuleSets Dialog Box 2 Use the Apply RuleSet dialog box to specify how rules are applied. For instructions on how to assign a RuleSet to either an agent or a group of agents.

the Agents group) Apply Options 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. Report Localized Rules Before Apply If the agent that you are applying RuleSets to has localized rules. Agents Selected Apply All ApplyOnApply Items In Current Group Parent Tree Group applies the ApplyOnApply RuleSets that are activated for the group in which the agent resides applies the ApplyOnApply RuleSets that are activated for the immediately preceding group (or the top group. you can remove agents from the list by selecting the agent and clicking Remove Agent. This option is inactive if the agent or agents do not possess any localized rules. 144 PATROL Configuration Manager User Guide . to view the list of agents you must click Show. This option is inactive if the agent or agents do not possess any localized rules. On the Apply RuleSets: Agent Lists dialog box. the configuration manager creates a report that list the localized rules. These localized rules will take precedence over the global rules that you are about to apply unless you select the Overwrite Localized Settings check box. you can select this option to overwrite the localized rule with the applied rule.Applying Changes to Agent Configurations Table 28 Option Apply RuleSet Properties (part 1 of 2) Description allows you to review which agents the rules are scheduled to be applied to and remove agents. When an agent is removed from the list. the rules that are waiting to be applied are also cleared for the agent.

If the purge option is not selected. PATROL Configuration Manager retrieves all the changes that have been made to the default configuration of an agent and stores them as rules in a single RuleSet in the following hierarchy in the RuleSet tree view. PATROL Configuration Manager places the rules in the job queue and displays the Job Status Information dialog box. and the action. RuleSet\PCM\backup\virtual_backup\agent_name\date_time Chapter 5 Work with Rules.Backing Up the Configuration of an Agent Table 28 Option Apply RuleSet Properties (part 2 of 2) Description remove all previous configuration changes before applying the RuleSets Purging agents before applying RuleSets is useful when you are resetting an agent configuration to a previous version. and Configurations 145 . in this case APPLY. deleting any changes that have been previously applied. If you want to be notified of the outcome (success or failure) of the apply jobs. you can use backups to restore an agent to a previous configuration. Purge Agents Before Apply Backup Agents Before Apply retrieve agent configurations and save them to the PATROL Configuration Manager backup folder prior to the application of new rules If you make an error applying RuleSets. If you have requested that a backup or purge be performed before rules are applied. Purging an agent’s configuration reverts the agent back to its default configuration. You can identify the job by the time-date stamp. Backing Up the Configuration of an Agent Getting the configuration of an agent is the same as backing up an agent’s configuration. the backup occurs before the purge. the agent against which the action will be performed. 3 Click OK. If both options are selected. RuleSets. the applied rules are combined with the agent’s current rules. PATROL Configuration Manager closes the Job Status Information dialog box. select the Redisplay When Updated check box. jobs with those statuses (GET and PURGE) will appear prior to the APPLY job. 4 Click OK.

Purging the configuration of an agent is equivalent to returning an agent to its default configuration. If you want to be notified of the outcome (success or failure) of the purge jobs.Purging All Configuration Changes from an Agent For instructions on how to backup the configuration of an agent. To Purge Configuration Changes from an Agent 1 In the Agent tree view. PATROL Configuration Manager displays the Confirm Purge dialog box.default file that is installed with the agent. 146 PATROL Configuration Manager User Guide . in this case PURGE. select the Redisplay When Updated check box. choose one or more agents. 2 Right-click on a highlighted agent and choose Configuration => Purge. PATROL Configuration Manager displays the Job Status Information dialog box. You can identify the job by the time-date stamp. and the action. see “Getting Configurations” on page 142. 3 Click Yes. PATROL Configuration Manager closes the Job Status Information dialog box. 4 Click OK. the agent against which the action will be performed. Purging All Configuration Changes from an Agent An Agent’s default configuration is defined by the config.

see I I I “Assigning RuleSets to Agents” on page 122 “Applying Changes to Agent Configurations” on page 143 “Purging All Configuration Changes from an Agent” on page 146 NOTE If you are restoring a previous configuration after making some configuration changes. and Configurations 147 .Restoring All Configuration Changes to an Agent Restoring All Configuration Changes to an Agent PATROL Configuration Manager stores backup configurations in the backup folder. To restore the configuration of an agent. RuleSets. For instructions on how to assign and apply RuleSets to an agent and purge configurations from an agent. you assign the desired time-stamped RuleSet to the agent and then perform an apply. you should purge the existing configuration of the agent before attempting to restore a previous configuration. Chapter 5 Work with Rules.

When the rule is changed that is associated to the to an agent by means of its LinkedRuleSet. LinkedRuleSets The LinkedRuleSets feature enables PATROL Configuration Manager to associate (through a static link) a rule to various agents. the LinkedRuleSets must be applied. The following tasks are presented in this section: I I I I “Designating RuleSets to Be Applied to New Agents (ApplyOnNew)” on page 152 “Designating RuleSets to Be Applied After Any RuleSet is Applied (ApplyOnApply)” on page 155 “Designating Rules to be Updated Automatically (LinkedRuleSets)” on page 156 “Identifying Linked RuleSets Associated with an Agent” on page 161 Types of Automated RuleSets PATROL Configuration Manager provides three ways to quickly and efficiently distribute changes to a rule throughout your PATROL enterprise. the configuration manager prompts you to assign the modified rule to all the agents to which it is associated by the LinkedRuleSets container. RuleSets assigned to the ApplyOnNew container can also be set up to ApplyOnApply. This feature allows you to ensure that certain configuration variables are always set to a specific value.Automating Updates to RuleSets Automating Updates to RuleSets PATROL Configuration Manager has some built in features that enable you to automatically apply certain RuleSets and update others. Before the change takes effect. This feature ensures that all agents in a certain group or set of groups starts off with the same standard configuration. ApplyOnApply The ApplyOnApply feature enables PATROL Configuration Manager to automatically apply a set of rules to an agent after any other set of rules is applied. 148 PATROL Configuration Manager User Guide . ApplyOnNew The ApplyOnNew feature enables PATROL Configuration Manager to automatically apply a set of rules to an agent when it is added to a group.

The RuleSetName consists of the name of the RuleSet and its full path. and Configurations 149 . Table 29 lists the variable format for each type of automated RuleSet. Agent container RuleSets 2. agent RuleSets Storage The configuration manager stores automated RuleSet information in variables within the various groups. Variable Information about each instance of an automated RuleSet is stored in a unique variable.Scope Scope Automatically managed RuleSets can be assigned at the following levels: I I I root. 1. group RuleSets 3. a Chapter 5 Work with Rules. The last RuleSet to be applied takes precedence over the earlier ones. the Agents container groups and subgroups individual agent (Linked RuleSets only) Precedence ApplyOnNew and LinkedRuleSets are applied hierarchically. system-specific.ini and agents. RuleSets. The RuleSetName consists of the name of the RuleSet and its full path. The order in which RuleSets are applied follows.ini files depending upon the scope of the RuleSet. Table 29 Feature ApplyOnNew ApplyOnApply LinkedRuleSet Automated RuleSet Variable Format Variable Format ApplyOnNew_RS_1_N=RuleSetName ApplyOnApply_RS_1_N Link_RS_# =RuleSetName Description The RuleSetName consists of the name of the RuleSet and its full path.

ini above the groups section in the group. Figure 26 Statically Linked RuleSet Modified Dialog Box 150 PATROL Configuration Manager User Guide . which is the groups or agents to which they are associated. the configuration manager keeps track of which rules are linked to which groups and agents.ini [Windows_Servers] ApplyOnNew_RS_1_N=OSbaseline.Windows Change to the Source Rule To help you propagate changes to rules throughout your enterprise. Table 30 lists the location of automated RuleSet variables based upon their scope. Table 30 Storage Location Reference Stored In respective agent section of the agent. Figure 26 displays the dialog box that informs you of the change.ini Automated RuleSet Assigned to individual agent group Agents container (all agents) Example Figure 25 shows an example of automated RuleSets referenced in an agent.Windows Link_RS_1=OSThresholds.Change to the Source Rule Location Information about each instance of an automated RuleSet is stored in a different location depending upon its scope. When a referenced rule is changed.ini file. the configuration manager detects the change and prompts you to distribute the change to all groups and agents that reference the modified rule through the LinkedRuleSet and ApplyOnNew RuleSet features. Figure 25 Example of an ApplyOnNew and LinkedRuleSet in agent.ini respective group section of the group.

Activating/Deactivating Statically Linked RuleSets To implement the change on individual agents. RuleSets. and Configurations 151 . If you choose No. you must perform an apply operation. Activating/Deactivating Statically Linked RuleSets When establishing which rules and RuleSets will be statically linked by way of the ApplyOnNew and LinkedRuleSets containers. the modified rule is not assigned to ApplyOnNew or the LinkedRuleSets container of the relevant agents. Chapter 5 Work with Rules. you may want to temporarily deactivate this feature. A check mark to the left of the menu command indicates that statically linked RuleSets are turned on. The control is a toggle. To Activate and Deactivate ApplyOnNew and LinkedRuleSets From the menu bar. choose Others => ApplyOnNew and LinkedRuleSets activated.

To Activate ApplyOnNew For Either A RuleSet or Folder of RuleSets 1 In the RuleSet tree view. 2 Click on the RuleSet or folder and drag it to the ApplyOnNew container of the group to which you want to assign the rules. The properties are described in Table 31. 152 PATROL Configuration Manager User Guide . PATROL Configuration Manager places the RuleSet or folder and its subsequent contents in the ApplyOnNew container. navigate to the RuleSet or folder of RuleSets that you want applied to every new agent added to a particular group. 3 Right-click on the ApplyOnNew container and choose ApplyOnNew.Designating RuleSets to Be Applied to New Agents (ApplyOnNew) Designating RuleSets to Be Applied to New Agents (ApplyOnNew) This task involves setting up RuleSets to be applied automatically when a new agent is added. PATROL Configuration Manager displays the Group ApplyOnNew dialog box as shown in Figure 27. Figure 27 Group ApplyOnNew Dialog Box 4 Use the Apply RuleSet dialog box to specify how rules are applied.

you can select this option to overwrite the localized rule with the applied rule. the configuration manager creates a report that list the localized rules. the Agents group) applies the ApplyOnNew RuleSets that are activated to the agents in only the groups subordinate to the current group. This option is inactive if the agent or agents do not possess any localized rules. Apply to Agents in Current Group Only Agents in Current and All SubGroups Current Group Parent Tree Group Apply All ApplyOnNew Items In Sub Tree Groups Apply Options 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. only applies the ApplyOnNew RuleSets that are activated for the immediately preceding group (or the top group. Report Localized Rules Before Apply If the agent that you are applying RuleSets to has localized rules. RuleSets.Designating RuleSets to Be Applied to New Agents (ApplyOnNew) Table 31 Option Group ApplyOnNew Properties (part 1 of 2) Description applies the ApplyOnNew RuleSets to just the agents in the immediate group applies the ApplyOnNew RuleSets to all agents in this group and any subordinate groups applies the ApplyOnNew RuleSets that are activated for the group in which the agent resides. These localized rules will take precedence over the global rules that you are about to apply unless you select the Overwrite Localized Settings check box. This option is inactive if the agent or agents do not possess any localized rules. and Configurations 153 . Chapter 5 Work with Rules.

the backup occurs before the purge. If both options are selected. 5 Click OK. 154 PATROL Configuration Manager User Guide . the applied rules are combined with the agent’s current rules.Designating RuleSets to Be Applied to New Agents (ApplyOnNew) Table 31 Option Group ApplyOnNew Properties (part 2 of 2) Description remove all previous configuration changes before applying the RuleSets 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. you can use backups to restore an agent to a previous configuration. Purge Agents Before Apply Backup Agents Before Apply retrieve agent configurations and save them to the PATROL Configuration Manager backup folder prior to the application of new rules If you make an error applying RuleSets. deleting any changes that have been previously applied. Purging an agent’s configuration reverts the agent back to its default configuration.

navigate to the RuleSet or folder of RuleSets that you want automatically applied after any RuleSet has been applied. RuleSets. 3 Choose ApplyOnApply Activated. and Configurations 155 . PATROL Configuration Manager places a checkmark to the left of the menu command to indicate that the RuleSet or folder of RuleSets will be applied after any other RuleSet is applied. RuleSets assigned to the ApplyOnNew container can also be set up to ApplyOnApply. Chapter 5 Work with Rules. Before You Begin This procedure assumes that you have completed step 1 and step 2 of the task “Activate ApplyOnNew For Either A RuleSet or Folder of RuleSets” on page 152. To Activate ApplyOnApply For Either A RuleSet or A Folder of RuleSets 1 Within the ApplyOnNew container. PATROL Configuration Manager displays the ApplyOnNew menu.Designating RuleSets to Be Applied After Any RuleSet is Applied (ApplyOnApply) Designating RuleSets to Be Applied After Any RuleSet is Applied (ApplyOnApply) This task involves setting up RuleSets to be applied automatically after any RuleSet is applied to an agent. 2 Right-click the RuleSet or folder.

it still must be applied to the agent before the change that it contains takes effect. PATROL Configuration Manager displays the Group Apply LinkedRuleSet dialog box as shown in Figure 28. navigate to the RuleSet that you want to assign to a group.Designating Rules to be Updated Automatically (LinkedRuleSets) Designating Rules to be Updated Automatically (LinkedRuleSets) This task involves designating certain rules to be assigned automatically to an agent for updating when the rule that is referenced is modified. PATROL Configuration Manager places a reference to the RuleSet in the LinkedRuleSet container. consider creating a separate RuleSet for those rules that are good candidates for static linkage. right-click on the LinkedRuleSet container and choose Apply Linked RuleSet. 3 In the Agent tree view. 2 Click on the RuleSet or folder and drag it to the LinkedRuleSet container of the group to which you want to assign the rules. To Assign a LinkedRuleSet to a Group 1 In the RuleSet tree view. 156 PATROL Configuration Manager User Guide . Even though the rule is automatically assigned to an agent. If you want to assign only certain rules.

Table 32 Option Apply to Agents in Current Group Only Agents in Current and All SubGroups Apply All LinkedRuleSet Items In Current Group Parent Tree Group Sub Tree Groups Apply Options 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. applies the rules in the LinkedRuleSets container that are activated for the group in which the agent resides.Designating Rules to be Updated Automatically (LinkedRuleSets) Figure 28 Group Apply LinkedRuleSet Dialog Box 4 Use the Group Apply LinkedRuleSets dialog box to specify how rules are applied. The properties are described in Table 32. you can select this option to overwrite the localized rule with the applied rule. and Configurations 157 . only applies the rules in the LinkedRuleSets container that are activated for the immediately preceding group (or the top group. the Agents group) applies the rules in the LinkedRuleSets container that are activated to the agents in only the groups subordinate to the current group applies the rules in the LinkedRuleSets container to just the agents in the immediate group applies the rules in the LinkedRuleSets container to all agents in this group and any subordinate groups Group Apply Linked RuleSets Properties (part 1 of 2) Description Chapter 5 Work with Rules. This option is inactive if the agent or agents do not possess any localized rules. RuleSets.

2 Click on the RuleSet or folder and drag it to the LinkedRuleSet container of the agent to which you want to assign the rules. To Assign a LinkedRuleSet to an Agent 1 In the RuleSet tree view. These localized rules will take precedence over the global rules that you are about to apply unless you select the Overwrite Localized Settings check box. If you want to assign only certain rules. navigate to the RuleSet that you want to assign to the agent. Backup Agents Before Apply retrieve agent configurations and save them to the PATROL Configuration Manager backup folder prior to the application of new rules If you make an error applying RuleSets. Purging an agent’s configuration reverts the agent back to its default configuration. The rules are assigned to the group. 5 Click OK.Designating Rules to be Updated Automatically (LinkedRuleSets) Table 32 Option Group Apply Linked RuleSets Properties (part 2 of 2) Description If the agent that you are applying RuleSets to has localized rules. This option is inactive if the agent or agents do not possess any localized rules. Report Localized Rules Before Apply Purge Agents Before Apply remove all previous configuration changes before applying the RuleSets Purging agents before applying RuleSets is useful when you are resetting an agent configuration to a previous version. consider creating a separate RuleSet for those rules that are good candidates for static linkage. the applied rules are combined with the agent’s current rules. If the purge option is not selected. the configuration manager creates a report that list the localized rules. 158 PATROL Configuration Manager User Guide . PATROL Configuration Manager displays the Agent Apply LinkedRuleSet dialog box as shown in Figure 29. the backup occurs before the purge. If both options are selected. deleting any changes that have been previously applied. PATROL Configuration Manager places a reference to the RuleSet in the LinkedRuleSet container. you can use backups to restore an agent to a previous configuration.

This option is inactive if the agent or agents do not possess any localized rules. RuleSets. Report Localized Rules Before Apply If the agent that you are applying RuleSets to has localized rules. This option is inactive if the agent or agents do not possess any localized rules.Designating Rules to be Updated Automatically (LinkedRuleSets) Figure 29 Agent Apply LinkedRuleSet Dialog Box 3 Use the Apply LinkedRuleSet dialog box to specify how rules are applied. you can select this option to overwrite the localized rule with the applied rule. only applies the rules in the LinkedRuleSets container to the selected agent and all agents that are in the same group applies the rules in the LinkedRuleSets container to the selected agent and all agents in groups subordinate to the current group Apply All LinkedRuleSets Items In Apply Options 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. and Configurations 159 . Chapter 5 Work with Rules. the configuration manager creates a report that list the localized rules. Table 33 Option Current Agent Parent Tree Group Sub Tree Groups Agent Apply LinkedRuleSet Properties (part 1 of 2) Description applies the rules in the LinkedRuleSets container to the agent. These localized rules will take precedence over the global rules that you are about to apply unless you select the Overwrite Localized Settings check box. The properties are described in Table 33.

the backup occurs before the purge. Purge Agents Before Apply Backup Agents Before Apply retrieve agent configurations and save them to the PATROL Configuration Manager backup folder prior to the application of new rules If you make an error applying RuleSets. the applied rules are combined with the agent’s current rules. deleting any changes that have been previously applied. you can use backups to restore an agent to a previous configuration. Purging an agent’s configuration reverts the agent back to its default configuration. 4 Click OK. 160 PATROL Configuration Manager User Guide . If the purge option is not selected. The rules are assigned to the agent. If both options are selected.Designating Rules to be Updated Automatically (LinkedRuleSets) Table 33 Option Agent Apply LinkedRuleSet Properties (part 2 of 2) Description remove all previous configuration changes before applying the RuleSets Purging agents before applying RuleSets is useful when you are resetting an agent configuration to a previous version.

Use this procedure to determine whether your RuleSets are linked to the appropriate groups and agents. You can also use this procedure to find which RuleSets are not linked to an agent to which they should be. RuleSets. To select multiple groups or agents that are not contiguous. click on the group or agent at the top or beginning of your range and then hold down Shift while clicking on the bottom or end of the range. 3 Choose Search => Linked RuleSets. PATROL Configuration Manager displays the Search LinkedRuleSets dialog box. Chapter 5 Work with Rules.Identifying Linked RuleSets Associated with an Agent Identifying Linked RuleSets Associated with an Agent This procedure describes how to search groups and multiple agents for Linked RuleSets associated with the groups or agents. an agent. 2 Choose a group. 4 Use the Search LinkedRuleSet dialog box to discover which rules are statically linked (by means of LinkedRuleSets) to which agents. To select a range. or agents to search. choose the groups or agents that you want to search. To Search for Linked RuleSets Associated with Groups or Agents 1 In the Agent tree view. hold down Ctrl while you click the individual items. Table 34 Option Group Filter Agent Filter RuleSet Filter Find Non-linked RuleSets Partial String Match Case Sensitive Search Use Regular Expressions Search LinkedRuleSet Properties Description shows only groups that match the specified criteria shows only agents that match the specified criteria shows only RuleSets that match the specified criteria shows all groups and agents that are not linked to the specified RuleSet uses partial string to evaluate matches for the specified filters uses the case of strings to evaluate matches for the specified filters employs regular expressions to evaluate matches for the specified filter 5 Click Search. and Configurations 161 . The properties are described in Table 34.

Identifying Linked RuleSets Associated with an Agent PATROL Configuration Manager locates the rule sets that meet the search criteria and displays them in the Searched LinkedRuleSets Results dialog box as shown in Figure 30. which includes the item type (group or agent). full path in the Agent tree view. PATROL Configuration Manager closes the results dialog box. and rule set name. Figure 30 Search LinkedRuleSets Results Dialog Box 6 Click OK. 162 PATROL Configuration Manager User Guide .

and Configurations 163 . However. RuleSets. Chapter 5 Work with Rules. Rule Aliases enable you to insert a placeholder in a rule. the value assigned to the alias replaces the alias name. Rule Aliases enable you to write standardized rules that can accommodate the differences among relatively similar computers. PATROL Configuration Manager will fail the Apply for the related Agent(s). no two computers are completely identical. If an undefined Rule Alias name is used. Operation When the PATROL Configuration Manager processes a rule that contains a Rule Alias. you would write a rule that contains the predefined Rule Alias. %HOSTNAME%. EXAMPLE To write a rule to set a configuration variable that contains the computer name. The placeholder is replaced by a computer-specific value when the rule is applied.Accommodating Computer-Specific Data Accommodating Computer-Specific Data The power of RuleSets relies on a certain level of standardization and uniformity across PATROL installations and the computers on which they run. Concept A Rule Alias is a variable.

ini in which Rule Aliases that apply to all agents are stored at the top of the file and computer-specific aliases are listed in their respective agent section. the timestamp for the last applied RuleSet is the current time. and designate to which agents it applies. timestamp is taken from tlog If the tlog for the agent is empty.Predefined Rule Aliases (System Variables) Predefined Rule Aliases (System Variables) The PATROL Configuration Manager provides some predefined Rule Aliases that provide access to computer information. 164 PATROL Configuration Manager User Guide . assign it a value.ini file. %PORT% %PROTOCOL% %LA_TIME% port used to communicate with the Agent the rule is applied to protocol used to communicate with the Agent the rule is applied to last time and date a RuleSet was applied to the Agent. choose File => Configure => Rule Alias. Table 35 Rule Alias %HOSTNAME% %DISPNAME% %IPADDRESS% Predefined Rule Aliases Description computer name of the Agent the rule is applied to display name of the Agent the rule is applied to IP address of the computer on which the agent is running and to which the rule applies This alias requires DNS to be functional. Storage The configuration manager stores Rule Aliases in the rulealiases. To Define a Rule Alias 1 From the menu bar. Table 35 lists the predefined Rule Aliases. The file is structured similarly to the agents. PATROL Configuration Manager displays the Configure: Rule Aliases dialog box. Defining a Rule Alias This task describes how to create a Rule Alias.

The properties are described in Table 36. and Configurations 165 .ini and closes the dialog box. Figure 31 Rule Aliases: Add Rule Alias Dialog Box 3 Use the Rule Aliases: Add Rule Alias dialog box to define the Rule Alias. and underscore (_). Agent 4 Click OK. RuleSets. Agent specific Rule Aliases take precedence over <default> Rule Aliases. PATROL Configuration Manager saves the Rule Alias to rulealiases. PATROL Configuration Manager closes the dialog box and displays the Rule Alias on the Configure: Rule Aliases dialog box. which can consist of alphanumeric characters. 5 Click Close. Chapter 5 Work with Rules. dash (-).Defining a Rule Alias 2 Click Add. this value must consists only of those characters supported by the of PATROL Agent the computer or computers to which the Rule Alias applies. select one from the drop-down menu <default> represents all computers. Table 36 Field Alias Name Alias Value Rule Aliases: Add Rule Alias Properties Description the name of the Rule Alias. the value that will replace the variable when the rule is processed. PATROL Configuration Manager displays the Rule Aliases: Add Rule Aliases dialog box as shown in Figure 31.

2 Choose View Missing Rule Aliases. 166 PATROL Configuration Manager User Guide . right click a job with the status. Before You Begin The configuration manager makes this feature available only after an apply operation has failed due to a missing Rule Alias. operation. The rule/variable contains the missing Rule Alias. RuleSet.Viewing and Adding Missing Rule Alias Viewing and Adding Missing Rule Alias This task describes how to define a rule alias after the configuration manager has attempted to process a rule that references a non-existent rule alias. PATROL Configuration Manager displays a drop-down menu. which lists the agent. Figure 32 Missing Rule Aliases Dialog Box 3 Click OK. and value as shown in Figure 32. FAILED Undefined Aliases: alias_name. To View a Missing Rule Alias 1 In the Job Status Information dialog box. PATROL Configuration Manager closes the dialog box and displays the Job Status Information dialog box. denoted by percent signs (%). To view or add missing Rule Aliases using this procedure. PATROL Configuration Manager displays the Missing Rule Aliases dialog box. an apply operation has to fail due to a missing alias. rule/variable.

PATROL Configuration Manager redisplays the dialog box with the next missing Rule Alias. Otherwise. right click a job with the status. Figure 33 Rule Aliases: Add Rule Alias Dialog Box 3 In Alias Value. PATROL Configuration Manager closes the Job Status Information dialog box. 5 Click Close. 4 Click OK. in which the Alias Name and Agent values are displayed in non-editable text fields as shown in Figure 33. RuleSets. and Configurations 167 . To Add a Missing Rule Alias 1 In the Job Status Information dialog box. the configuration manager closes the dialog box and displays the Job Status Information dialog box. PATROL Configuration Manager closes the Job Status Information dialog box. 2 Choose Add Missing Rule Aliases. 6 Reapply the RuleSets. If more than one Rule Alias is missing.ini file. PATROL Configuration Manager saves the to the rulealiases. PATROL Configuration Manager displays the Rule Aliases: Add Rule Alias dialog box. FAILED Undefined Aliases: alias_name. PATROL Configuration Manager displays a drop-down menu. enter the desired value.Viewing and Adding Missing Rule Alias 4 Click Close. Chapter 5 Work with Rules.

Viewing and Adding Missing Rule Alias 168 PATROL Configuration Manager User Guide .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Establishing Thresholds . Prerequisites . . . . . . . . . . . . . . . . . .Chapter 6 170 170 172 173 174 174 176 179 180 180 182 183 184 184 185 186 6 Manage Parameters This chapter describes how to use PATROL Configuration Manager to set up borders and alarm ranges for parameters. . The following topics are discussed: Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Accessing Parameters Threshold Settings . . . . . . . . . Defining Collection Cycles by Setting Poll Time . . . . . . . . . . Specifying a Parameter for Which to Set a Poll Time. . . . . . . . . . . . . . . . . . . . . Range Settings for Monitoring Increasing and Decreasing Parameter Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Accessing Parameter Poll Time Settings . . Thresholds . . . Poll Times . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . You can also control how frequently information is gathered for parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Saving Parameter Settings in a RuleSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting Poll Times. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Importing a RuleSet into PATROL Configuration Manager . . Chapter 6 Manage Parameters 169 . . . . . . . . . . . . . . . Specifying a Parameter for Which to Establish Thresholds . . . . . . . . . . . . . . . . . . . . . . . Retrieving Customized Parameter Settings and Storing Them as a RuleSet . . . . . . . . . . . . . . . . . . . . . . . . Defining Border and Alarm Ranges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Saving parameter settings in PATROL Configuration Database variables I I allows you to quickly and easily reapply them when upgrading from one version of a PATROL product to another allows you to customize parameter settings once and distribute those settings throughout your enterprise to PATROL Agents monitoring the same applications PATROL Configuration Manager provides a utility that retrieves existing parameter settings from a Knowledge Module (KM) and converts the settings to rules in a RuleSet that can then be applied to other agents that are running the same KM. Thresholds In PATROL. You can apply those parameter settings. depending upon how you define the settings for that parameter. The three thresholds are Border Range. 170 PATROL Configuration Manager User Guide . Alarm Range 1. This feature makes upgrades easier since your thresholds are stored externally to the KM files. You can use this utility to fine tune PATROL to monitor exactly what you want and then save those settings to a RuleSet and apply that RuleSet throughout your enterprise. Requirements The PATROL Knowledge Module for Event Management must be installed and loaded on the PATROL Agent for the agent to process the rules containing the parameter settings and thresholds. and Alarm Range 2. through rules. When a parameter value breaches a threshold. and ALARM. you can create rules that set parameter thresholds and establish data collection intervals (also referred to as poll times) for individual parameters. An OK job status in PATROL Configuration Manager indicates only that rules have been successfully received by the agent. WARN. to PATROL Agents throughout your enterprise. not in the KM files. to another) and recovery actions associated with them.Introduction Introduction Through the graphical interface of the PATROL Configuration Manager. The thresholds are stored in agent configuration variables. thresholds are value ranges that can have alert changes (events that change an object’s state from any one state: OK. PATROL can issue a state change action and/or run a recovery action.

Border Range The Border Range defines the range of acceptable values that a parameter can return. If you use the border range as a third-level alert range. not in the console KM files. these changes are not reflected in the console display because the changes are made at the agent.Thresholds NOTE When you make threshold changes using PATROL Configuration Manager. It must meet the following criteria: I I I must be greater than Alarm1 values cannot overlap the Alarm1 range cannot fall outside the border range Chapter 6 Manage Parameters 171 . If the parameter returns a value inside the range limit but outside of the border range (either less than the minimum or greater than the maximum). It must meet the following criteria: I I I must be less than Alarm2 values. if Alarm2 is set cannot overlap the Alarm2 range cannot fall outside the border range Alarm Range 2 The Alarm Range 2 is second-level alert condition that typically represents a warning state or an alarm state. PATROL issues an alert and changes the state of the parameter to the one assigned to the border range. 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. Alarm Range 1 The Alarm Range 1 is the first-level alert condition that typically represents a warning state or an alarm state. you may need to make the maximum range limit lower than you would without the third-level alert.

such as when the amount of free memory is less than 2 MBs. as when the amount of used disk space exceeds 95% or I less than a set minimum value. Monitoring a Parameter with a Decreasing Value If you want the parameter to alarm when a resource is diminishing and a low value occurs. Table 37 Thresholds Example of Monitoring a Parameter with a Decreasing Value Min 0 0 0 6 Max 100 100 5 10 State not applicable ALARM ALARM WARN Recovery Action not applicable none none run backup utility Range Limit Border Alarm1 Alarm2 172 PATROL Configuration Manager User Guide . I I Alarm1 for the alarm state Alarm2 for the warning state EXAMPLE If you are monitoring CPU utilization of a computer and you want PATROL to issue a warning when utilization drops below 10% and issue a warning and run a backup utility when utilization goes below 5%. you could choose these settings.Range Settings for Monitoring Increasing and Decreasing Parameter Values Range Settings for Monitoring Increasing and Decreasing Parameter Values Thresholds for PATROL parameters can be set to trigger an alarm when a value becomes I greater than a set maximum value. set the thresholds as follows.

I I Alarm1 for the warning state Alarm2 for the alarm state EXAMPLE If you are monitoring server resource consumption by users and you want PATROL to issue a warning when resource consumption exceeds 20% and a warning when it exceeds 25%. which constitute a majority of the PATROL parameters. inherit their poll times from the collector parameter that provides their data. Applicable Parameter Types Consumer parameters. you must discover which collector parameter sets its value and then change the poll time of that collector. Table 38 Thresholds Example of Monitoring a Parameter with an Increasing Value Min 0 0 20 24 Max 100 25 23 25 State not applicable ALARM WARN ALARM Recovery Action not applicable none send a message to the user run a script that prevents the user from spawning any more processes Range Limit Border Alarm1 Alarm2 Poll Times The poll time defines the collection cycle interval. you could choose these settings. Poll times determine how often the PATROL Agent gathers statistical data reported by parameters.Poll Times Monitoring a Parameter with an Increasing Value If you want the parameter to alarm when a high value occurs. You cannot directly change consumer poll times by selecting the parameter and scheduling a time. To change the frequency with which a consumer parameter receives data. Chapter 6 Manage Parameters 173 . set the thresholds as follows.

it displays poll times in HH:MM:SS format. 2 Choose Event Management => Parameter Settings. see “Retrieving Customized Parameter Settings and Storing Them as a RuleSet” on page 184. When you view parameter settings using any of the PATROL consoles such as the PATROL Central Operator – Web Edition. the PATROL Agent’s configuration database stores this information in seconds. 3 Choose the Thresholds tab.Thresholds dialog box as shown in Figure 34. you can only specify one parameter at a time. Accessing Parameters Threshold Settings PATROL Configuration Manager allows you to set the thresholds for one agent at a time. Using the configuration manager’s interface. To Access the Threshold Settings 1 Right-click on an agent whose parameters you want to set thresholds and schedule polling times. The configuration manager gives you the power to define these settings once and distribute these changes to one agent or every agent in your enterprise. 174 PATROL Configuration Manager User Guide .Establishing Thresholds Differences in Format PATROL Configuration Manager accepts poll time in minutes. However. Establishing Thresholds PATROL Configuration Manager allows you to define these parameter settings locally on every agent. For information about how to retrieve all the parameter settings for a specified knowledge module. PATROL Configuration Manager displays the Parameter Setting .

you need to perform the following tasks: I I “Specifying a Parameter for Which to Establish Thresholds” on page 176 “Defining Border and Alarm Ranges” on page 179 Chapter 6 Manage Parameters 175 .Accessing Parameters Threshold Settings Figure 34 Thresholds Tab of Parameter Setting Dialog Box Where to Go from Here After you have accessed the Thresholds tab.

prm. The PATROL objects displayed in the Object Selection dialog box were available when PATROL Configuration Manager was released. 176 PATROL Configuration Manager User Guide . Before You Begin You must complete the procedure. currently loaded objects of the agent. To Select a Parameter For Which to Define Thresholds 1 On the Parameter Settings dialog box on the Thresholds tab.def. an application class.Specifying a Parameter for Which to Establish Thresholds Specifying a Parameter for Which to Establish Thresholds Because you can set thresholds for only one parameter at a time.sid files for each respective application class. “To Access the Threshold Settings” on page 174. You cannot attempt to apply thresholds to a host. NOTE The list of objects is static and does not reflect the real-time. To update the list of objects. click Add Objects. PATROL Configuration Manager displays the Object Selection dialog box as shown in Figure 35. or an instance. *. *. navigate to BMC_ROOT\pconfmgr\patrol and manually edit *. you can choose only one parameter and you must select at least one.

the configuration manager will prompt you for the password for the SKS database. choose the computer for which you want to establish thresholds. 3 In the Hosts list box. I Show All Hosts—the configuration manager lists all agents that are registered with the manager I Get Object from Agent—the configuration manager retrieves the application classes. instances and parameters from the PATROL Agent runtime namespace rather than the static files created at installation. Show All Hosts and Hosts are inactive NOTE If you have not accessed the Secure Key Store (SKS) database during your current PATROL Configuration Manager session. see “Managing Unique User Names and Passwords for Individual Agents” on page 91. the information displayed represent a snapshot of objects available at that point in time. if you choose this option. Chapter 6 Manage Parameters 177 . For more information about accessing and managing the SKS database.Specifying a Parameter for Which to Establish Thresholds Figure 35 Object Selection Dialog Box 2 Choose either the Show All Hosts check box or the Get Object from Agent check box.

7 Click Add. PATROL Configuration Manager closes the dialog box and displays the parameter in the Selected Objects List. PATROL Configuration Manager does not retain it when you exit the dialog box.Specifying a Parameter for Which to Establish Thresholds 4 In the Application Class list box. 6 In the Parameter list box. choose the application class for whose parameter you want to set thresholds. choose an instance. To apply threshold settings to parameters of all instances. 8 Click Close. 5 In the Instance list box. choose the parameter whose thresholds you want to set. If you do not add the selection. 178 PATROL Configuration Manager User Guide . choose __ANYINST__.

Unacceptable values are defined explicitly using alarm ranges. Select I OK—changes the state of the parameter to OK when the result of the range breach is informational for users or non-critical to the system WARN—changes the state of the parameter to WARN when the value constitutes a breach of the range. When the value of the parameter goes outside the range. which is undesirable ALARM—changes the state of the parameter to ALARM when the value constitutes a breach of the range. PATROL Configuration Manager activates all the fields on the tab as shown Figure 36.Defining Border and Alarm Ranges Defining Border and Alarm Ranges Range controls define for PATROL which parameter values are acceptable and which are unacceptable. PATROL changes the alert state to the one that you specify. 3 In Alert State. Figure 36 Border and Alarm Range Pane 2 Choose Enable. choose one of the alert states. To Set the Border and Alarm Ranges 1 Click the tab of the range that you want to set. Chapter 6 Manage Parameters 179 . Acceptable values are often defined implicitly in that acceptable values lie outside the alarm ranges but inside the border range and range limits. define the range using Min and Max. which is unacceptable I I 4 In the Range Settings section. I I Border Range—defines the range of acceptable values for the parameter. Alarm Range 1 and Alarm Range 2—establish ranges of undesirable (WARN) and unacceptable values (ALARM).

any value outside the range (less than the minimum or greater than the maximum) constitutes a breach of the range and thus generates an alarm. I For the Border Range. then PATROL issues an alert. I I 6 If you set Trigger Alarm to After an alarm occurs N times. 180 PATROL Configuration Manager User Guide . When you select this trigger alarm. in N. 7 Repeat steps for other ranges. Immediately on alarm—PATROL issues an alert the first time the range is breached. any value that falls within the range (greater than or equal to the minimum and less than or equal to the maximum) constitutes a breach of the range and thus generates an alarm. Setting Poll Times PATROL Configuration Manager can only set the poll times for collector parameters and standard parameters. After all recovery actions fail—PATROL runs all recovery actions. if applicable. I After an alarm occurs N times—PATROL ignores a user-defined number of breaches and thus discounts random spikes. For Alarms Range 1 and Alarms Range 2. you must also specify in N how many consecutive times the range can be breached before the PATROL issues an alert and changes the state of the parameter. select a sensitivity setting that determines how quickly and under what conditions PATROL issues an alert. the definition differs between what constitutes a breach of the range and thus is cause for generating an alarm.Setting Poll Times NOTE Depending upon the type of range: border or alarm. Accessing Parameter Poll Time Settings PATROL Configuration Manager allows you to set the poll times for one agent at a time. I 5 In Trigger Alarm. enter the number of consecutive times the parameter value must fall within either the Alarm Range 1 or Alarm Range 2 or without of the Border Range before PATROL issues an alert. and if the parameter value is still within the defined warning or alarm range.

3 Choose the Polltimes tab.Accessing Parameter Poll Time Settings To Access the Poll Time Settings 1 Right-click on an agent for whose parameters you want to schedule polling times. PATROL Configuration Manager displays the Parameter Setting .Polltimes dialog box as shown in Figure 37. Figure 37 Polltimes Tab of Parameter Setting Dialog Box Where to Go from Here After you have accessed the Polltimes tab. 2 Choose Event Management => Parameter Settings. you need to perform the following tasks: I I “Specifying a Parameter for Which to Set a Poll Time” on page 182 “Defining Collection Cycles by Setting Poll Time” on page 183 Chapter 6 Manage Parameters 181 .

Using the configuration manager. 182 PATROL Configuration Manager User Guide . you cannot schedule collection cycles (poll times) for a host. or an instance. For more information about accessing and managing the SKS database. choose the application class for whose parameter you want to set the poll time. click Add Objects. see “Managing Unique User Names and Passwords for Individual Agents” on page 91. Show All Hosts and Hosts are inactive NOTE If you have not accessed the Secure Key Store (SKS) database during your current PATROL Configuration Manager session. I Show All Hosts—the configuration manager lists all agents that are registered with the manager I Get Object from Agent—the configuration manager retrieves the application classes. PATROL Configuration Manager displays the Object Selection dialog box as shown in Figure 35 on page 177. choose an instance. if you select this option. 5 In Instance. 4 In Application Class.Specifying a Parameter for Which to Set a Poll Time Specifying a Parameter for Which to Set a Poll Time You must set a poll time for one and only one parameter at a time. the configuration manager will prompt you for the password for the SKS database. 2 Choose either the Show All Hosts check box or the Get Object from Agent check box. choose __ANYINST__. an application class. To apply a poll time to parameters of all instances. the information displayed represent a snapshot of objects available at that point in time. Before You Begin You must complete the procedure. “To Access the Poll Time Settings” on page 181. To Select a Parameter For Which to Set Poll Times 1 On the Parameter Settings dialog box on the Polltime tab. choose the computer for which you want to set the poll time. 6 In Parameter. 3 In the Hosts list box. instances and parameters from the PATROL Agent runtime namespace rather than the static files created at installation. choose the parameter whose poll time you want to set.

However. For information about parameters. where mm is expressed in minutes and ss is expressed in tenths of minutes. 2 Type the amount of time that PATROL waits between data collecting cycles for the parameter. If you do not add the selection. Therefore. 8 Click Close. To Set Poll Time 1 Place the cursor in Set Polltime. the Object Selection dialog box of the PATROL Configuration Manager does not distinguish among parameters types.ss. see the PATROL Parameter Reference Manual or the parameter help for the respective PATROL product. 7 Click Add. for example. 10.Defining Collection Cycles by Setting Poll Time NOTE Poll times can be set directly only for collector and standard parameters. Use the following format: mm. Defining Collection Cycles by Setting Poll Time The poll time defines the interval between attempts by the agent to gather data specified by knowledge modules. PATROL Configuration Manager closes the dialog box and displays the parameter in the Selected Objects List. Chapter 6 Manage Parameters 183 .50 = 10 minutes and 30 seconds 3 Click OK to close the dialog box and save the poll time. PATROL Configuration Manager does not retain it when you exit the dialog box. you must know which parameters are consumers and which are standard or collector parameters.

the ChangeSpring Knowledge Module. you can then apply those setting in the form of RuleSets to selected agents.00 or later(installed in agent and console) 184 PATROL Configuration Manager User Guide . the knowledge module has to reside only on the agent) or I PATROL Console for UNIX or PATROL Console for Microsoft Windows Servers — PATROL Console 3. that enables you to retrieve existing parameter settings for an application and saves those settings as configuration rules.00 or later (installed on the computer running the console) I PATROL for UNIX or PATROL for MS Windows — PATROL Agent 3.6. To capture these settings. you must first activate their respective parameters.Retrieving Customized Parameter Settings and Storing Them as a RuleSet Retrieving Customized Parameter Settings and Storing Them as a RuleSet PATROL Configuration Manager provides a utility.5.x running in Developer Mode — PATROL Configuration Manager 1. Using the configuration manager.x.5. Prerequisites The process of retrieving parameter settings and saving them as RuleSets requires that the following components be installed with these products: I PATROL Central – Web Edition or PATROL Central – Microsoft Windows Servers (If this console is used. NOTE This procedure does not capture the settings of deactivated parameters. — PATROL KM for Event Management 2.

The RuleSet creation process creates rules for parameters in the PATROL Agent’s namespace for the selected Knowledge Module. The KM is located in BMC_BASE/pconfmgr/utils. 5 Right-click AS_Changespring Instance.Saving Parameter Settings in a RuleSet Saving Parameter Settings in a RuleSet Gathering the parameter settings of a knowledge module and storing them in pconfig variables is the first task. you can start the console in either Operator or Developer mode. if after you imported the RuleSet into PATROL Configuration Manager. The following example is what you would see. The name and location of the file is displayed in the System Output Window. If the AS_CHANGESPRING KM is loaded on the agent. 4 Right-click the PATROL Agent and choose Show System Output Window. 6 Choose KM Commands => Get Global Parameters => Create RuleSets => Select Knowledge Modules. To Create a RuleSet from Parameter Settings 1 Start the PATROL Console. The RuleSet is stored in a file with the same name as the RuleSet and the extension *. Otherwise. Chapter 6 Manage Parameters 185 . 2 Load the AS_CHANGESPRING KM into the PATROL Console.cfg. 7 Choose the KMs for which you want to generate a RuleSet from the list. 8 Click Accept. you must start the console in Developer mode. 3 Choose the PATROL Agent that possesses the parameter customizations that you want to the KMs are loaded with the default configuration. you right-click on the RuleSet and then choose Edit => Source.

1 95 100 0 0 2"}. 5 Start PATROL Configuration Manager. "/AS/EVENTSPRING/PARAM_SETTINGS/THRESHOLDS/NT_CPU/__ANYINST__/CP UprcrProcessorTimePercent" = { REPLACE = "1. Use only alphanumeric characters. BMC_BASE/pconfmgr/rulesets/Shipped/KM_NAME. navigate to the RuleSets/Shipped/KM_NAME/KM_NAME_PURPOSE.0 0 0 0 0 0.0 0 0 0 0 0"}. in the menu bar choose Other => Refresh RuleSets.1 90 95 0 0 1. 2 Navigate to the location of the *. "/AS/EVENTSPRING/PARAM_SETTINGS/THRESHOLDS/NT_CPU/__ANYINST__/CP UprcrPrivTimePercent" = { REPLACE = "1.1 0 100 0 0 2. Relocating the file in the appropriate directory structure makes it available to the configuration manager.cfg.1 95 100 0 0 2"}.1 0 100 0 0 2. "/AS/EVENTSPRING/PARAM_SETTINGS/STATUSFLAGS/paramSettingsStatusFlag" = { REPLACE = "2" } Importing a RuleSet into PATROL Configuration Manager Once you have created a RuleSet.1 0 100 0 0 2. you must move the file containing the RuleSet into directory structure of PATROL Configuration Manager.cfg. "/AS/EVENTSPRING/PARAM_SETTINGS/THRESHOLDS/NT_CPU/__ANYINST__/CP UprcrUserTimePercent" = { REPLACE = "1.cfg file. 6 In the RuleSet tree view. dashes and hyphens such as NT_CPU_default_thresholds.0 0 0 0 0 0.1 90 95 0 0 1. 3 Rename the file using the following naming convention: KM_NAME_purpose.cfg. 186 PATROL Configuration Manager User Guide .1 95 100 0 0 2"}. 7 Expand the RuleSet and review the rules.Importing a RuleSet into PATROL Configuration Manager EXAMPLE "/AS/EVENTSPRING/PARAM_SETTINGS/THRESHOLDS/NT_CPU/__ANYINST__/CP UprcrInterruptsPerSec" = { REPLACE = "1.1 90 95 0 0 1. 4 Copy the file to the PATROL Configuration Manager directory. If your RuleSet is not visible. To Make the RuleSet Available to PATROL Configuration Manager 1 Open the file manager of your choice.

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Defining Recovery Action Command Type . Notification Rules Stored as pconfig Variables. . . . . . . Designating Type of Notification Sent . . . . . . . . . . . . . . . Setting Up Notification for PATROL Objects in Alert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . The chapter also provides information about how to manage the alerts that trigger the notifications. . . . . . . . . . . . . . . . . . . Enabling Recovery Actions . . . . . . . Chapter 7 Establish Notification and Manage Alerts 189 189 190 190 190 191 191 193 195 196 198 198 200 201 202 204 206 208 209 209 210 210 212 216 216 218 221 187 . . . . . . . . . . . . . . . . . . Recommended Configuration Order . . . . . . . . . . pager. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting Override Periods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Defining Recovery Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Scope of Commands and Types . . . . . . . . . Alert Settings. . . . . . . . . . . . . The following topics are discussed: Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting Precedence: Rules or KM Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Suppressing Alerts upon Agent Restart to Avoid False Alerts . . . . . . . . Adding Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Assigning Custom Identifiers to PATROL Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . or other communication method when some aspect of a application or system that is being monitored becomes unfavorable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Alert Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Determining from Where Notifications Are Sent and Managed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Difference between Blackouts and Overrides . . . . . . . . . . . . . . . . . . . . . . . . . Determining How Many Times Alerts Are Resent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Recovery Action Setup . . . . . . Objects and Overrides . . . Removing Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PATROL Objects . . . . . . . . . . . . . . . . . . . . . . . . Notification Configuration and Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Turning Monitoring On and Off at the Application Class Level . . . . . . . . . . . . . Designating Who Receives Notifications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Chapter 7 Establish Notification and Manage Alerts 7 This chapter describes how to set up notifications so that a user is automatically notified by email. . . . .

Rewording Notification Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225 Message Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228 Disabling Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230 Stopping Notification For Specific Periods (Notification Blackouts) . . . . . . . . . . 232 Notification Tests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235 RuleSet Used for Testing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235 Limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236 Testing Notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236

188

PATROL Configuration Manager User Guide

Overview

Overview
The Event Management menu command in PATROL Configuration Manager provides an interface with the PATROL KM for Event Management. Use the Event Management commands to create and test Event Management rules without having to use the PATROL Console or the New Rule command on the RuleSet shortcut menu. The Event Management menu contains that control notifications and alerts are
I

Alert Settings—sets Event Management rules such as blackouts and message rewording What If—simulates rule lookup behavior; rule lookup includes both the sequence in which rules are used and the rule lookup order.

I

After an Event Management rule is created using either the Alert Settings, the rule appears in the Agent tree view under the selected agent. However, 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 to agents or groups.

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.

Notification Rules Stored as pconfig Variables
Notification rules are stored in the PATROL Configuration Database (pconfig) as variables. They are not stored in the KM. Pconfig variables override KM parameter default settings. When you upgrade a KM, the pconfig settings are retained. You do not need to reconfigure an agent after an upgrade.

Chapter 7 Establish Notification and Manage Alerts

189

Setting Precedence: Rules or KM Values

Setting Precedence: Rules or KM Values
/AS/EVENTSPRING/PARAM_SETTINGS/STATUSFLAGS/paramSettingsStatusFlag, a

configuration variable, determines whether PATROL uses the PATROL KM for Event Management rules for parameter thresholds/poll times or the values stored in the individual knowledge modules (KM). Valid values are
1—the values set by the PATROL KM for Event Management rules are used 0—the values stored in the individual KM files are used

The default is 1, the rules take precedence.

Prerequisites
Before you begin establishing notification and setting up event management in PATROL Configuration Manager, you must
I I I

install PATROL KM for Event Management set up notification scripts to run in your environment test notification scripts

Objects and Overrides
All of the tasks described in this chapter are performed with the aid of the Alert Settings dialog box, which consist of several tabs. Most of the tasks can be performed on objects at various levels of the PATROL object hierarchy (computers, application classes, instances, parameters). To provide granularity and flexibility, most of the Alert Settings dialog box tabs provide Add Objects, Remove Objects, and Show Override Periods controls. You perform these tasks to assign behavior to an object or set of objects. You can also specify a period of time during which the assigned behavior will not take place.

190

PATROL Configuration Manager User Guide

PATROL Objects

PATROL Objects
PATROL objects are the computers, application classes, instances, and parameters that PATROL uses to monitor systems and applications.

Advantages
In the regular PATROL Console, you usually work with one object at a time. The PATROL Configuration Manager alert settings dialog box enables you to work with many objects at one time.

Updating PATROL Object Lists
The list of objects in the add object list is a list of standard PATROL objects that is not dynamically updated from the PATROL Agent. You can add objects to this list. If the objects that you want to work with do not appear in the list of objects, see “Updating the PATROL Object List”in Chapter 8, “Move PATROL Information into PATROL Configuration Manager.”

Difference between Blackouts and Overrides
A blackout period is a specific period of time during which PATROL does not issue notifications. An override period is a specific time when a rule and its behavior is superseded by another rule and alternate behavior. Use a blackout period when you do not want notifications sent to anyone, regardless of the alert status of the specified PATROL objects. Use the Override Period feature when you do not want certain conditions (defined within a rule) applied to specific PATROL objects during certain times but you still want the condition (and thus the rule) applied to a majority of the PATROL objects during the override period.

NOTE
You can also suppress notifications indefinitely for selected PATROL objects by setting the Notification System to None.

Chapter 7 Establish Notification and Manage Alerts

191

Difference between Blackouts and Overrides

Example of a Blackout Period
Create a rule to notify John whenever CPU usage exceeds an acceptable amount and the percentage value enters the Alarm threshold range.
/AS/EVENTSPRING/ALERT/EMAIL/CPU/CPU__Total/CPUprcrProcessorTime/emailTa rgetsLocalALARM = john@b.com

On Monday, the Information Support group will take the computer out of production and run some routine performance tests on it. Set a blackout period from midnight to 8 pm for the CPU usage rule above so that John will not receive notification during the test period.
/AS/EVENTSPRING/BLACKOUT/ CPU/CPU__Total/CPUprcrProcessorTime/blackoutPeriod = Mon bob@b.com 0 800

From midnight to 8 pm on Monday, notification will not be sent to john@b.com even if CPU usage enters into Alarm threshold range.

Example of an Override Period
Create a rule to notify Bob and Jane when CPU usage exceeds an acceptable amount and the percentage value enters the Alarm threshold range.
/AS/EVENTSPRING/ALERT/EMAIL/CPU/CPU__Total/CPUprcrProcessorTime/emailTarg etsLocalALARM = bob@b.com,jane@b.com

Set up an override period for the rule so that Jane is not notified during the hours from midnight to 8 pm.
/AS/EVENTSPRING/OVERRIDE/EMAIL/CPU/CPU__Total/CPUprcrProcessorTime/email TargetsLocalALARM = Mon 0 2000 = jane@b.com <mailto:jane@b.com>

From midnight to 8 pm on Monday notification will not be sent to jane@b.com. However, bob@b.com will continue to receive notification during this override period.

192

PATROL Configuration Manager User Guide

Recommended Configuration Order

Recommended Configuration Order
To set up notification and alert management and take full advantage of PATROL Configuration Manager and PATROL KM for Event Management, you must perform some setup and configuration tasks in either one product or the other. Some task can be performed in either product, but need be done in only one. Table 39 describes in which product each task can be performed and suggests a recommended order. Table 39
Configuration Task 1. Identify and Set Up Notification Servers

Configuration Order (part 1 of 2)
Application PATROL KM for Event Management Manual / Chapter / Section PATROL KM for Event Management User Guide / Chapter 3, “Using the PATROL KM for Event Management” / “Configuration Tasks” and “Configuring Notification Server” PATROL KM for Event Management User Guide / Chapter 3, “Using the PATROL KM for Event Management” /”Configuration Tasks” and “Setting Notification Targets” PATROL Configuration Manager User Guide / Chapter 7, “Designating Who Receives Notifications” / “Designating Who Receives Notifications” on page 216 PATROL KM for Event Management User Guide / Chapter 3, “Using the PATROL KM for Event Management” / “Using Notification Scripts” and “Testing Notification Scripts” PATROL KM for Event Management User Guide / Chapter 3, “Using the PATROL KM for Event Management” /“Configuring Notification Servers” PATROL KM for Event Management User Guide / Chapter 3, “Using the PATROL KM for Event Management” / “Rewording Notification Messages” PATROL Configuration Manager User Guide / Chapter 7, “Designating Who Receives Notifications” / “Designating Who Receives Notifications” on page 216

2. Identify and Set Up Notification Targets for PATROL Objects

PATROL KM for Event Management

PATROL Configuration Manager

3. Identify, edit, and test the PATROL KM for Event notification script. Management

4. Configure a notification server.

PATROL KM for Event Management

5. Reword default notification message for the notification server.

PATROL KM for Event Management

PATROL Configuration Manager

Chapter 7 Establish Notification and Manage Alerts

193

“Work with Rules. “Using the PATROL KM for Event Management” / “To Assign Notification Servers for NT2 and NT3”. 8. Use PATROL Configuration Manager to copy agent rules to other similar agents. “Using the PATROL KM for Event Management” / “To Assign Notification Servers for NT2 and NT3”. Configure availability monitoring. see PATROL KM for Event Management User Guide / Chapter 3. and Configurations” / “Creating.” and “Configuring Alert Settings” PATROL Configuration Manager User Guide / Chapter 7. see PATROL KM for Event Management User Guide / Chapter 3. Editing. Editing. and Managing Rules” on page 125 PATROL KM for Event Management User Guide / Chapter 3. and Managing Rules” on page 125 PATROL KM for Event Management User Guide / Chapter 3. “Setting Poll Times” on page 180. and “Alert Settings” on page 195 PATROL Configuration Manager User Guide / Chapter 5. PATROL KM for Event Management PATROL KM for Event Management PATROL Configuration Manager 9. “Using the PATROL KM for Event Management” / “Configuring Remote Agents” For example. “Work with Rules. “Using the PATROL KM for Event Management” / “Configuring Availability Monitoring” 6. “Establish Notification and Manage Alerts” / “Designating Who Receives Notifications” on page 216.” “Managing Parameter Thresholds and Poll Times. you would copy the settings to other agents that will use the same notification server. Use PATROL Configuration Manager to copy the notification server settings (rules) to the other notification servers PATROL Configuration Manager 7. Use PATROL Configuration Manager to copy agent rules to other similar agents. and Deleting RuleSets” on page 116 PATROL KM for Event Management User Guide / Chapter 3. RuleSets. 11. PATROL KM for Event Management PATROL Configuration Manager 10. RuleSets. “Establishing Thresholds” on page 174.Recommended Configuration Order Table 39 Configuration Task Configuration Order (part 2 of 2) Application PATROL KM for Event Management Manual / Chapter / Section For an example of how to use the PATROL Configuration Manager. RuleSets. PATROL Configuration Manager User Guide / Chapter 5. PATROL Configuration Manager User Guide / Chapter 5. “Work with Rules. For an example of how to accomplish this task. Configure notification rules and parameter settings for the agents. Managing. “Using the PATROL KM for Event Management” / “Setting Notification Targets. and Configurations” / “Creating. Configure remote agents to use a notification server. and Configurations” / “Creating. PATROL Configuration Manager PATROL KM for Event Management 194 PATROL Configuration Manager User Guide .

Figure 38 Alert Settings Dialog Box Chapter 7 Establish Notification and Manage Alerts 195 . right click an agent. PATROL Configuration Manager displays the Alert Settings dialog box as shown in Figure 38. you work with one tab at a time when you create alert settings. The tabs of the Alert Settings dialog box correspond to the alert settings provided by the PATROL Knowledge Module for Event Management. Each tab is a separate alert setting for the selected agent. Normally. 2 Choose Event Management => Alert Settings.Alert Settings Alert Settings The Alert Settings dialog box contains tabs for setting Event Management alert settings. To Access Alert Settings Dialog Box 1 In the Agents tree view.

not dynamic. The alert settings on each tab applies to the objects selected on the tab. Before You Begin Ensure that the lists of PATROL objects for the PATROL Agents are up-to-date. PATROL Configuration Manager displays the Object Selection dialog box as shown in Figure 39. You can choose any level of object from all computers (hosts) to a single parameter on an individual computer. Figure 39 Object Selection Dialog Box – Multiple Hosts 196 PATROL Configuration Manager User Guide . For information about how to update the object lists. The list of objects used by PATROL Configuration Manager is static. click Add Objects. see “Updating PATROL Object Lists” on page 191. To Select a PATROL Object 1 On the Alert Settings dialog box.Adding Objects Adding Objects Use the Object Selection dialog box to choose the objects for the alert settings tab. and must be updated manually.

if you choose this option. If you do not add the selection. Chapter 7 Establish Notification and Manage Alerts 197 . To select a range click on the first agent in the range. the information displayed represent a snapshot of objects available at that point in time. choose Show All Hosts. choose an instance. I Show All Hosts—the configuration manager lists all agents that are registered with the manager I Get Object from Agent—the configuration manager retrieves the application classes. and press Shift while clicking on the last agent. 7 Click Add. If you want to apply this settings specified in the current tab to computers besides the current one. press Ctrl while clicking the individual computer names. choose the parameter whose thresholds you want to set. I I 4 (Optional) In Application Classes. PATROL Configuration Manager does not retain it when you exit the dialog box. To select agents on multiple computers. select root (/). instances and parameters from the PATROL Agent runtime namespace rather than the static files created at installation. 3 In Hosts. the configuration manager will prompt you for the password for the SKS database. For more information about accessing and managing the SKS database. 5 (Optional) In Instances. PATROL Configuration Manager lists all the agents registered with the configuration manager and displayed in the Agent tree view. choose the computers to which you want to apply settings. choose __ANYINST__.Adding Objects 2 Choose either the Show All Hosts check box or the Get Object from Agent check box. choose the application class for whose parameter you want to set thresholds. see “Managing Unique User Names and Passwords for Individual Agents” on page 91. If you want to apply threshold settings to parameters of all instances. Show All Hosts and Hosts are inactive NOTE If you have not accessed the Secure Key Store (SKS) database during your current PATROL Configuration Manager session. move your cursor to the last agent in the range. I To choose the agent on the computer on which you launched the Alert Setting menu command. 6 (Optional) In Parameters.

PATROL Configuration Manager highlights the object(s). Setting Override Periods Specify periods during which you want a different alert setting. To select a range. press Shift and click on the first object in the range and then the last object in the range. To select a range. 198 PATROL Configuration Manager User Guide . PATROL KM for Event Management enacts the behavior defined during the Override Period and stored in an override rule. defined by a rule. PATROL Configuration Manager closes the dialog box and displays the PATROL Object in the Selected Objects List. to be applied and thus alternate behavior to occur for the selected objects. Override Periods apply to all objects in the Selected Objects List. PATROL Configuration Manager removes the highlighted object(s) from Selected Objects List. 2 Click Remove Objects. press Ctrl and click on the individual objects one at a time. press Ctrl and click on the individual objects one at a time.Removing Objects 8 Click Close. PATROL Configuration Manager activates Show Override Periods. choose an object. press Shift and click on the first and last object in the range. The alert settings are not used during the Override Periods. PATROL Configuration Manager highlights the object(s). To choose more than one object. To Remove an Object 1 In Selected Objects List. choose an object. To select more than one object. 2 Choose Override. Removing Objects Use the Remove Objects feature to removes selected objects displayed in the alert setting dialog box so that the settings are not applied. To Select Periods During Which Alert Settings Are Not Active 1 In Selected Objects List. Instead.

The override properties are described in Table 40. minute. PATROL Configuration Manager displays the Override Settings dialog box as shown in Figure 40. Table 40 Field Override Settings Properties (part 1 of 2) Description Override periods that have already been applied Makes the override periods selected in the Current Overrides field available for editing Removes the override periods selected in the Current Overrides field The hour. and second on which the override period begins The hour.Setting Override Periods 3 Click Show Override Periods. Figure 40 Override Settings Dialog Box 4 Set the override period. . and second on which the override period ends Current Overrides Change Selected Delete Selected Start Time End Time Chapter 7 Establish Notification and Manage Alerts 199 . minute.

Alert Management Using PATROL Configuration Manager. you can instruct PATROL KM for Event Management to run recover actions and issue notifications when a PATROL object changes to a specific alert status.Alert Management Table 40 Field Override Settings Properties (part 2 of 2) Description The days of the week on which the override occurs Designate the relationship between the new override period and any existing override periods I Override Days Merge or Replace Merge Selected Override Periods with Pre-Existing Settings—combines the current override period with any existing overrides periods listed in the Current Overrides field Replace Existing Override Periods with Current Selection—deletes any existing override periods listed in the Current Overrides field and applies the current ones I 5 Click Add. The aspects of alerts that you can control include I I I I I issuing notifications running recovery actions resending alerts assigning text descriptions to PATROL objects turning monitoring on or off 200 PATROL Configuration Manager User Guide . The dialog box displays the period in Current Overrides. 6 Click Close.

Chapter 7 Establish Notification and Manage Alerts 201 . Figure 41 Alert Settings Dialog Box–Alert Action Tab 2 Choose the PATROL objects for which you want to set up recovery actions and send notifications by “Adding Objects” on page 196.Alert Action tab.Setting Up Notification for PATROL Objects in Alert Setting Up Notification for PATROL Objects in Alert Use the Alert Settings dialog box–Alert Action tab to enable notification and recovery actions for selected PATROL objects. right-click on an agent for which you want to set up notifications such as emails or pages. A In the Agent tree view. To Set Up Notifications and Enable Recovery Actions 1 Access the Alert Settings .Alert Action tab dialog box as shown in Figure 41. PATROL Configuration Manager displays the Alert Settings . B Choose Event Management => Alert Settings.

4 Specify the alert status for the PATROL objects and allow PATROL KM for Event Management to run recovery actions and send notifications when the object alerts. or parameter. Determining How Many Times Alerts Are Resent Use the Alert Settings dialog box–Alert Resend tab to define the number of times the agent resends an active alert when it remains in a warning or alarm state for consecutive polling periods. and the alerts contain the current alert information (parameter value. PATROL Configuration Manager saves the Alert Action settings and closes the dialog box. The Alert Action settings are described in Table 41.Determining How Many Times Alerts Are Resent 3 Set up override period by “Setting Override Periods” on page 198. 202 PATROL Configuration Manager User Guide . To resend outstanding alerts for the selected objects as long as the alert is active. status. This setting is stored in the rule alertResend. You can configure alarm and warning alerts to have different resend values. Alerts are resent at the interval specified by the PATROL KM for Event Management ResendAlertQueue parameter polling time (10 minute default setting). instance. and you can configure them at the following PATROL object levels: application. Table 41 Field Select Action Type Alert Action Properties Description select the object status for the alert settings The following options are supported: I ANY_STATUS I INFORMATION I WARNING I ALARM Allow Recovery Actions Trigger NOTIFY_EVENT (Perform Notification) 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 5 Click OK. and so on). set the Alert resend to -1.

C Click on the Alert Resend tab. 3 Set up override period by “Setting Override Periods” on page 198. PATROL Configuration Manager displays the Alert Settings . Figure 42 Alert Settings Dialog Box – Alert Resend Tab 2 Choose the PATROL objects for which you want to specify how many times an alert is resent by “Adding Objects” on page 196. The Alert Resend settings are described in Table 42.Alert Resend tab dialog box as shown in Figure 42. B Choose Event Management => Alert Settings.Alert Resend tab. 4 Specify resend values for both ALARM and WARNING alerts.Determining How Many Times Alerts Are Resent To Specify How Many Times Alerts Are Resent 1 Access the Alert Settings . Chapter 7 Establish Notification and Manage Alerts 203 . right-click on an agent for which you want to set up notifications such as emails or pages. A In the Agent tree view.

1-# send outstanding alerts as many times as indicated by this value as long as the alert is active ALARM Resends WARN Resends specify the number of times you want PATROL KM for Event Management to resend alerts for WARN conditions. Reset alerts are sent for each alert condition (for example. 204 PATROL Configuration Manager User Guide . values are the same as ALARM Resends 5 Click OK. and is not activated by default. Suppressing Alerts upon Agent Restart to Avoid False Alerts 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. No additional alerts are sent after the initial alert. outstanding events that have not yet been processed by the enterprise console can remain open. This rule does not apply to particular objects. PATROL Configuration Manager saves the Alert Resend settings and closes the dialog box. alarm or warning) that existed when the agent was shutdown. These events are considered false alerts because after the agent or the agent computer restarts. The settings for this option are managed by the Send Reset On Init tab and stored in the rule alertResetOnInit. Why False Alerts Occur upon an Agent Restart When an agent or the computer on which an agent is running goes down. these events are no longer relevant. You can configure PATROL to determine which events are no longer relevant and close those events upon an agent restart.Suppressing Alerts upon Agent Restart to Avoid False Alerts Table 42 Field Alert Resend Properties Description specify the number of times you want PATROL KM for Event Management to resend alerts for alarm conditions Valid values are -1 resend outstanding alerts for the selected objects as long as the alert is active 0 send only the original alert.

Send Reset On Init tab.Suppressing Alerts upon Agent Restart to Avoid False Alerts To Revert to the Alert Status in Effect before Agent Restart 1 Access the Alert Settings . Figure 43 Alert Settings Dialog Box – Send Reset On Init Tab 2 Select Send reset notifications when agent restarts. right-click on an agent for which you want to set up notifications such as emails or pages. PATROL Configuration Manager displays the Alert Settings .Send Reset On Init tab dialog box as shown in Figure 43. B Choose Event Management => Alert Settings. C Click on the Send Reset On Init tab. Chapter 7 Establish Notification and Manage Alerts 205 . PATROL Configuration Manager saves the Send Reset On Init settings and closes the dialog box. A In the Agent tree view. 3 Click OK.

they add a custom identifier that indicated which application the object belongs to. such online_catalog. or online_transaction. EXAMPLE To help the IT staff of a large online retailer identify which objects serviced which business application.Assigning Custom Identifiers to PATROL Objects Assigning Custom Identifiers to PATROL Objects Use the Alert Settings dialog box–Custom Identifiers tab to assign custom identifiers to PATROL objects. PATROL Configuration Manager displays the Alert Settings .Custom Identifier tab dialog box as shown in Figure 44. The custom identifiers are text strings. They can be used to associate internally affected applications with PATROL. A In the Agent tree view. shopping_cart. B Choose Event Management => Alert Settings. C Click on the Custom Identifier tab. right-click the agent for which you want to set up notifications such as emails or pages. To Specify Custom Identifiers 1 Access the Alert Settings . 206 PATROL Configuration Manager User Guide .Custom Identifier tab.

3 Set custom identifiers for the selected objects.Assigning Custom Identifiers to PATROL Objects Figure 44 Alert Settings Dialog Box – Custom Identifiers Tab 2 Choose the PATROL objects for which you want to define custom identifiers by “Adding Objects” on page 196. Table 43 Field Set Custom Identifier 1 Enter Custom Identifier 1 Custom Identifier Properties 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. 4 Click OK. Chapter 7 Establish Notification and Manage Alerts 207 . The Custom Identifier settings are described in Table 43.

Figure 45 Alert Settings Dialog Box – Class Active State Tab 208 PATROL Configuration Manager User Guide . C Click on the Class Active State tab. right-click on an agent for which you want to set up notifications such as emails or pages. PATROL does not collect data for it.Class Active State tab dialog box as shown in Figure 45. B Choose Event Management => Alert Settings. To Activate or Deactivate PATROL Objects 1 Access the Alert Settings .Class Active State tab. The Class Active State settings apply only to application classes. PATROL Configuration Manager displays the Alert Settings .Turning Monitoring On and Off at the Application Class Level PATROL Configuration Manager saves the Custom Identifier settings and closes the dialog box. A In the Agent tree view. When an object is inactive\deactive. Turning Monitoring On and Off at the Application Class Level Use the Alert Settings dialog box–Class Active State tab to set the active state of selected application classes.

Chapter 7 Establish Notification and Manage Alerts 209 . Recovery Action Setup This section describes how to configure PATROL KM for Event Management recovery actions. Enabling Recovery Actions Before using PATROL Configuration Manager to configure PATROL KM for Event Management to execute a recovery action for a PATROL object. the PATROL KM for Event Management rule arsAction must be set to 2. which at periodic intervals causes PATROL to locate objects and collect data based on application class definitions Full Discovery 4 Click OK. The Class Active State settings are described in Table 44. 4.Recovery Action Setup 2 Choose the PATROL objects to activate or deactivate by “Adding Objects” on page 196. Table 44 Field Disabled Pre Discovery Class Active State Properties Description disables the application class and neither monitors nor collects data for the applications and instances defined by it set the application class to pre-discovery mode. see “arsAction” in Chapter 5. 6. “Rules and Configuration Variables” in PATROL Knowledge Module for Event Management User Guide. 3 Set Class Active State for the selected objects. PATROL Configuration Manager saves the Class Active State settings and closes the dialog box. For more information about arsAction. verify that the recovery action is enabled for that object. which causes PATROL to test if the object exists before attempting to run a full discovery set the application class in full discovery mode. To execute recovery actions. These recovery actions are executed at the agent and are associated with a PATROL object status change.

A In the Agent tree view. Defining Recovery Action Command Type Use the Alert Settings dialog box–Recovery Action Command Type tab to specify the command type (PSL and OS) to use when executing the recovery action command. PATROL KM for Event Management supports the following command types without any customization. To execute a recovery action. You can specify the command type for all PATROL objects or for any individual PATROL application.Scope of Commands and Types Scope of Commands and Types Recovery action command types and recovery action commands can be set at the same object level. B Choose Event Management => Alert Settings. However. arsCmdType. they must be defined in the application class for which they will run. right-click on an agent for which you want to set up notifications such as emails or pages. For recovery actions of a type different than the majority.Recovery Action Command Type tab. The command type is stored in the rule. 210 PATROL Configuration Manager User Guide . If most of your recovery actions are the same type. you can set both the command and the type at the applicable object or instance level. you can set the value of the command type for the majority of recovery actions at the host level (for the entire computer). if you want to use custom scripts. and customer scripts. instance. operating system command and shell scripts based upon those commands. If all of your recovery actions are of one type. PSL—PATROL Script Language functions or scripts comprising PSL functions OS—operating system commands or shell scripts using operating system commands To Specify Recovery Action Command Type 1 Access the Alert Settings . you should specify that command type for all PATROL objects. C Click on the Recovery Action Command tab. or parameter. Command Types PATROL KM for Event Management supports PATROL Script Language commands. you must specify a command type. The AS_CHANGESPRING application class contains a sample PATROL command type.

The Recovery Action Command Type settings are described in Table 45. Chapter 7 Establish Notification and Manage Alerts 211 .Recovery Action Command Type tab dialog box as shown in Figure 46.Defining Recovery Action Command Type PATROL Configuration Manager displays the Alert Settings . Figure 46 Alert Settings Dialog Box – Recovery Action Command Type Tab 2 Choose the PATROL objects for which you want to define the recovery action command type by “Adding Objects” on page 196. 3 Set up override period by “Setting Override Periods” on page 198. 4 Choose the Alert status for which you want to specify the recovery action command type.

pl. or custom commands. you must reference the recovery action program or script in certain ways.Defining Recovery Actions Table 45 Field Recovery Action Command Type Properties Description select the status of objects that require the recovery action command The following status types are supported: I I I Select Status 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. 212 PATROL Configuration Manager User Guide . 5 Click OK. AS_EVS_RA_CMD_GENERIC. NOTE For PATROL to execute the recovery actions. Use PSL for PSL commands. Command Types Recovery actions can be written in PSL. Based upon the programming language and command type. OS. see “Defining Recovery Action Command Type” on page 210. located in the PATROL PSL directory. To designate the command type. The PATROL KM for Event Management contains a sample recovery action script. Defining Recovery Actions Use the Alert Settings dialog box–Recovery Action Commands tab to specify a script or program that performs recovery procedures pertaining to the selected PATROL objects with an Alert status. Allow Recovery Actions check box must be selected on the Alert Action tab. PATROL Configuration Manager saves the Recovery Action Command Type settings and closes the dialog box.

you should have completed the following tasks: I Enable Alert Actions to perform recovery action commands.Recovery Action Commands tab. B Choose Event Management => Alert Settings. You can use environment variables. “Using PATROL KM for Event Management. Custom I You must specify the absolute path for the recovery command when you are specifying a custom command type. Create and test a recovery action script. Chapter 7 Establish Notification and Manage Alerts 213 . or you must specify the absolute path to the command. right-click on an agent for which you want to set up notifications such as emails or pages. C Click on the Recovery Action Command tab. enter the absolute path to the file on the agent. See “Using Notification Scripts” and “Testing Notification Scripts” in Chapter 3. Specify the recovery action command type rule arsCmdType. I I To Specify Recovery Action Scripts or Programs 1 Access the Alert Settings . Before You Begin Before specifying a recovery action script. I Operating System I The command must be in the path. click Edit to enter a multi-line PSL script. If you are entering the PSL text. A In the Agent tree view.Defining Recovery Actions PSL I If you are specifying a PSL script file.” in PATROL Knowledge Module for Event Management User Guide. PATROL Configuration Manager displays the Alert Settings . See “Defining Recovery Action Command Type” on page 210.Recovery Action Commands tab dialog box as shown in Figure 47. See “Setting Up Notification for PATROL Objects in Alert” on page 201.

4 Choose the Alert status for which you want the recovery action to run and define the recovery action. The Recovery Action Command settings are described in Table 46. 214 PATROL Configuration Manager User Guide . 3 Set up override period by “Setting Override Periods” on page 198.Defining Recovery Actions Figure 47 Alert Settings Dialog Box – Recovery Action Commands Tab 2 Choose the PATROL objects for which you want to define recovery actions by “Adding Objects” on page 196.

enter the absolute path to the file on the agent. You must specify the absolute path for the recovery command when you are specifying a custom command type. See “Defining Recovery Action Command Type” on page 210. Chapter 7 Establish Notification and Manage Alerts 215 . If you are entering the PSL text. Set the command type. See “Setting Up Notification for PATROL Objects in Alert” on page 201. PATROL Configuration Manager saves the Recovery Action Commands settings and closes the dialog box. Operating System Command The command must be in the path. or you must specify the absolute path to the command. I 5 Click OK. Ensure you set the following values if you are using recovery actions: I Enable Alert Actions to perform recovery action commands. You can use environment variables.Defining Recovery Actions Table 46 Field Recovery Action Command Properties Description select the status of objects that require the recovery action command The following status types are supported: I I I Select Status 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. click Edit to enter a multi-line PSL script.

B Choose Event Management => Alert Settings. right-click on an agent for which you want to set up notifications such as emails or pages.Notification Targets tab dialog box as shown in Figure 48.Notification Targets tab. you can control I I I I I I who receives notifications (notification targets) when and why or under what conditions a notification is issued how they receive notification: email. 216 PATROL Configuration Manager User Guide . page. To Designate Notification Targets 1 Access the Alert Settings . C Click on the Notification Targets tab. Using the configuration manager.Notification Configuration and Management Notification Configuration and Management PATROL Configuration Manager enables you to establish and manage notification issued by PATROL KM for Event Management. PATROL Configuration Manager displays the Alert Settings . You should set up specific targets to ensure that the proper people are notified when alerts occur. or other (notification commands) what system information the notification messages provide (reword notification messages) where the notifications messages are managed and sent from when notifications should not be sent Designating Who Receives Notifications Use the Alert Settings dialog box – Notification Targets tab to define the notification targets for selected objects. A In the Agent tree view.

Chapter 7 Establish Notification and Manage Alerts 217 . The Notification Targets settings are described in Table 47. 4 Designate who will receive the notification. what type of alert will cause the notification. 3 Set up override period by “Setting Override Periods” on page 198.Designating Who Receives Notifications Figure 48 Alert Settings Dialog Box – Notification Targets Tab 2 Choose the PATROL objects for which you want to set up a notification targets by “Adding Objects” on page 196. what type of notifications they will receive.

5 Click OK. Target Notification Types select the target notification types for the selected objects The following local and remote notification types are supported: I I I I I 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. PATROL Configuration Manager saves the Notification Targets settings and closes the dialog box.Designating Type of Notification Sent Table 47 Setting Notification Targets Properties Description select the notification type from the following values: I I I I Notification Type Email Pager Custom Trouble Ticket Ensure that your notification server is configured to perform the selected Notification Type. if you want to send pages. 218 PATROL Configuration Manager User Guide . Enter Targets specify the notification targets for the selected objects and notification types Multiple targets are separated by commas. Designating Type of Notification Sent The PATROL KM for Event Management provides sample notification scripts that call command-line utilities to initiate notification (such as e-mail and page). the paging software must be installed and configured. For example. The Notification Command tab of PATROL Configuration Manager allows you to associate various types of notification such as email or page with specific PATROL objects.

PATROL Configuration Manager displays the Alert Settings . right-click on an agent for which you want to set up notifications such as emails or pages. B Choose Event Management => Alert Settings.Notification Command tab dialog box as shown in Figure 49.” of PATROL Knowledge Module for Event Management User Guide. application classes.Designating Type of Notification Sent EXAMPLE A system administrator (SA) sets up pager notifications for all CPU-related PATROL objects because they are mission critical. I To Designate in the Notification Command Tab the Type of Notification Sent 1 Access the Alert Settings . If you are going to notify individuals by pages. C Click on the Notification Command tab. The PATROL KM for Event management contains sample notification scripts located in the PATROL PSL directory. The SA sets up email notification for all printer-related PATROL objects because printing is not a mission critical aspect of the business. see “Configuration Tasks” in Chapter 3. Before You Begin I You must have edited the platform-specific sample scripts provided with PATROL KM for Event Management. A In the Agent tree view. The notification command is typically set at the root (/) object level so that it applies to all PATROL objects. Scripts For more information about the scripts. instances. “Using the PATROL KM for Event Management. and parameters with an ALERT status. any requirements for using them. Chapter 7 Establish Notification and Manage Alerts 219 .Notification Command Tab. their locations. you must install and configure that software. and any edits or customizations required. for example.

3 Specify a script or program to issue notification by email. or other communication method. The notification command properties are in Table 48. paging. 220 PATROL Configuration Manager User Guide . If you want to use the same script for all PATROL objects. select the root (/).Designating Type of Notification Sent Figure 49 Alert Settings Dialog Box – Notification Command Tab 2 Choose the PATROL object to which you want to associate a notification script.

PATROL Configuration Manager saves the notification command settings and closes the dialog box. and you want to send the e-mail to multiple targets. This setting is stored in the rule alertSystem and can be specific for each PATROL object. Chapter 7 Establish Notification and Manage Alerts 221 . For a second parameter. you could choose to not set up any notification. If you are using blat to send e-mail.Determining from Where Notifications Are Sent and Managed Table 48 Field Notification Command Properties 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. However. you must use command-line arguments. most operating systems have command size limitations or there are special characters that cause the command to fail. EXAMPLE You can set up notifications to be sent locally for one parameter. When you call a shell script or a batch program you can pass command-line arguments. Enter Notification Command Call command using Event Management environment variables only defines if the command is called with command-line arguments Environmental variables are always available. 4 Click OK. You can set up notifications to be sent from I I the local machine on which the alerts occur a notification server or not send them at all. you could setup events to be forwarded to a notification server that sends the notification. For a third parameter. Determining from Where Notifications Are Sent and Managed Use the Alert Settings dialog box–Notification System tab to specify from where or if at all notification is performed for the selected PATROL objects.

NOTE You should only select a specific host when you are creating a rule for a notification server.Determining from Where Notifications Are Sent and Managed Types of Notification System Notification targets (for example. None PATROL Configuration Manager does not send for the selected PATROL objects. fail-over to the backup notification server is automatically performed. If the primary notification server is unavailable. the network connection. Remote Send alerts to a notification server. notification failures have no impact on other systems. Some disadvantages to using the Local option are I I Notification scripts and procedures are required on each computer. the remote notification server). 222 PATROL Configuration Manager User Guide . who is paged or e-mailed) must be maintained for each computer. Local notification is potentially more reliable since it requires fewer intermediate components (for example. Using Remote. allows for centralized notification and simplifies maintenance of notification settings and procedures. Most systems are unable to perform paging locally. Using the Local option. A disadvantage is that the failure of a notification server affects many systems. Local Notification is performed by the PATROL Agent that is doing the monitoring. Local and Remote PATROL Configuration Manager performs both local and remote notification. You can specify a primary and a backup notification server.

Chapter 7 Establish Notification and Manage Alerts 223 .Notification System tab dialog box as shown in Figure 50. see “Deciding Where to Place Notification Rules” in Chapter 3. PATROL Configuration Manager displays the Alert Settings . “Using PATROL KM for Event Management. To Determine What Computer Manages and Sends Notifications 1 Access the Alert Settings . A In the Agent tree view. C Click on the Notification System tab.Determining from Where Notifications Are Sent and Managed Deciding Which Notification System to Use For information about which notification system you should use to send notifications. right-click on an agent for which you want to set up notifications such as emails or pages.”in PATROL Knowledge Module for Event Management User Guide. B Choose Event Management => Alert Settings.Notification System tab.

Determining from Where Notifications Are Sent and Managed Figure 50 Alert Settings Dialog Box – Notification System Tab 2 Choose the PATROL objects for which you want to set up a notification system by “Adding Objects” on page 196. 4 Specify the Alert status and notification system from where the notifications are managed and sent. 224 PATROL Configuration Manager User Guide . 3 Set up override period by “Setting Override Periods” on page 198. The Notification System settings are described in Table 49.

trouble tickets. PATROL Configuration Manager saves the Notification System settings and closes the dialog box. or other custom notification system. You can either reword the default message that is used for all notification messages or build your own custom. Rewording Notification Messages Use the Alert Settings dialog box–Alert Messages tab to reword alert messages and their subject lines PATROL objects. However. “Using PATROL KM for Event Management. see “Deciding Where to Place Notification Rules” in Chapter 3. REMOTE NONE local notification is performed for the selected objects remote notification is performed for the selected objects both LOCAL and REMOTE notification notification is not performed for the selected PATROL objects 5 Click OK. For more information. Chapter 7 Establish Notification and Manage Alerts 225 . BMC Software recommends that you reword messages at the remote agent because this practice reduces the number of rules on the notification server and makes it easier to properly send messages to an enterprise console.Rewording Notification Messages Table 49 Setting Notification System Properties Description select the object status for the alert settings The following options are supported: I ANY_STATUS I INFORMATION I WARNING I ALARM Select Action Type LOCAL REMOTE LOCAL.”in PATROL Knowledge Module for Event Management User Guide. Where to Reword Notification Messages You can reword messages at the notification server or at the remote agent. alert message for a specific object to be issued by E-mail. pages.

By default. The message is truncated. it is set to 1. Table 50 Platform UNIX Windows AS/400 (using native SNDDST mail utility) OpenVMS Notification Subject Line and Message Length Limits by Platform Subject Length Limit Message Length Limit 100 characters No known limit 44 characters No known limit 2035 characters 5000 characters Action If Limit is Exceeded The message is truncated. verify that the message length is within the limitations noted in Table 50. Custom.”in PATROL Knowledge Module for Event Management User Guide. 226 PATROL Configuration Manager User Guide .Rewording Notification Messages Including Subject Line Only If you want the notification message to include only a subject line and no message body. During message creation. For information about editing notification scripts. “Using PATROL KM for Event Management. you must edit the notification script and change the value of the Send_Body variable to 0. The message is truncated. This feature allows you to provide precise. detailed notifications that inform the recipient of the exact system status. Message Length Limitations When you reword messages. PATROL replaces the variables with the actual values from the PATROL object that are associated with the selected state. 80 characters 255 characters The message is not sent. PATROL Configuration Manager provides a list of message variable text at the bottom of the Alert Settings dialog box–Alert Messages tab. which indicates that the message body is included in the notification message. see “Using Notification Scripts” and “Testing Notification Scripts” in Chapter 3. Dynamic Messages Customized messages are built out of a combination of regular text and Alert Message variables.

The Alert Messages settings are described in Table 51. PATROL Configuration Manager displays the Alert Settings .Alert Messages tab. A In the Agent tree view. Chapter 7 Establish Notification and Manage Alerts 227 . B Choose Event Management => Alert Settings. Figure 51 Alert Settings Dialog Box – Alert Messages Tab 2 Choose the PATROL objects whose Alert Messages you want to reword by “Adding Objects” on page 196.Rewording Notification Messages To Reword Messages Sent When an Alert Occurs 1 Access the Alert Settings . C Click on the Alert Messages tab. 3 Set up override period by “Setting Override Periods” on page 198. 4 Specify the Alert status and construct a new message for the specified Alert status.Alert Messages tab dialog box as shown in Figure 51. right-click on an agent for which you want to set up notifications such as emails or pages.

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. However. The text in the bottom pane is read only and has nothing to do with your new message. very detailed notification. you can copy variables from the bottom and paste them in the Enter Custom Message Text field to use in your message. 5 Click OK. Blend them with text to create an easily comprehensible. Table 52 Variable %HOSTNAME% %IPADDRESS% %TCP_PORT% %UDP_PORT% %APPCLASS% Alert Message Variables 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 228 PATROL Configuration Manager User Guide . Table 51 Field Select message type(s) to reword Alert Message Properties Description select the message type that you want to reword for the selected objects The following message types are supported: I I I I 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 Table 52 describes the message variables available for creating custom alert messages. see “Message Variables” on page 228.Message Variables For information about how to construct a message using Alert Message variables and some sample messages. PATROL Configuration Manager saves the Alert Messages settings and closes the dialog box.

%LAST10TP% the overall time period. in minutes.WARN. %APPINSTANCE% %ICON_NAME% %PARENT_INSTANCE% %PARAMETER_NAME% %PARAMETER_STATUS% %PARAMETER_VALUE% %DATE% %TIME% %TIMEZONE% %LAST10% %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. Jan 01. between the first and last %LAST10TS% values. in minutes.Message Variables Table 52 Variable Alert Message Variables Description application instance name instance icon name parent instance name parameter name parameter status (ALARM. %EVENT_ID% %USERDEFINED% %EVENT_TYPE% %EVENT_STATUS% %OS_TYPE% %ALARM_MIN% %ALARM_MAX% %CUSTOM_ID1% 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 “Assigning Custom Identifiers to PATROL Objects” on page 206. The %LAST10TS% values are in seconds since 00:00:00 GMT.OK) 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). %CUSTOM_ID2% the custom identifier assigned to object See “Assigning Custom Identifiers to PATROL Objects” on page 206. Chapter 7 Establish Notification and Manage Alerts 229 . of the %LAST10% The %LAST10TP% is the difference. 1970.

which provide ease of use and error checking. The advantage of PATROL KM for Event Management lies in that it supports disabling notifications with menu commands and dialog boxes. or other notification. which is sent as an email.4.54%) Disabling Notification You can disable notification in either PATROL KM for Event Management or PATROL Configuration Manager.55% CPU (Ave CPU=76. The Oracle server PROD1 on glamis is consuming 99.05.02 and Later %AGENT_VERSION% %EVENT_CATALOG% %EVENT_CLASS% %EVENT_STATUS% %EVENT_SEVERITY% %EVENT_TYPE% %NOTIFY_EVENT_ID% %NOTIFY_EVENT_TYPE% %NOTIFY_EVENT_STATUS% Variables Only Available from a Notification Server Sample Message The following combination of variables and text in the Enter Custom Message Text field The Oracle server %APPINSTANCE% on %HOSTNAME% is consuming %PARAMETER_VALUE%% CPU (Ave CPU=%AVE10%%) yields the following message. The advantage of PATROL Configuration Manager lies in its ability to distribute the rule changes quickly and uniformly throughout the enterprise. page.Disabling Notification Table 52 Variable Alert Message Variables Description 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 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 Variables Available with the PATROL KM for Event Management 2. 230 PATROL Configuration Manager User Guide . The most efficient method of disabling notifications involves using both products and thus taking advantage of both products strengths.

“Using the PATROL KM for Event Management. To Disable Notification for Specific PATROL Objects To disable notification for certain PATROL objects. you can make the change on one agent and then deploy the changes to all of your agents using the PATROL Configuration Manager. EXAMPLE To disable notification for all parameters in the NT_CPU application class. For more information about disabling notifications using PATROL KM for Event Management.Disabling Notification Using PATROL KM for Event Management If you use the PATROL KM for Event Management to make these changes. “of PATROL Knowledge Module for Event Management User Guide. You can accomplish this by performing one of the following tasks: I I I adjusting the thresholds deactivating threshold ranges deactivating parameters Chapter 7 Establish Notification and Manage Alerts 231 . To Disable Notification at the Notification Server To disable notification at the notification server. you can set the alertSystem rule to NONE and then set it to LOCAL for those parameters for which you want to receive notifications. use the following rule on the remote agent generating events: /AS/EVENTSPRING/NT_CPU/arsAction =0. set the arsAction rule to 0 only for that application class. see “Disabling Notification” in Chapter 3. Editing. review your emails (or pages) and begin adjusting the parameter settings so that the alerts that are not desired stop coming. Using PATROL Configuration Manager Performing the following tasks in PATROL Configuration Manager involve editing rules. For information about how to edit rules. To Limit Notifications by Adjusting Parameter Settings If you are receiving too many notifications. see “Creating. and Managing Rules” on page 125. such as an application class.

and the notification system is a remote notification server. EXAMPLE If you do not want a remote agent to generate notify events. alerts are forwarded to the notification server during defined blackout periods. Type of Blackout Notification Server 232 PATROL Configuration Manager User Guide . Blackout periods can be defined locally at the system where the alert occurs and at the notification server. and they can be applied to most PATROL objects. Types of Blackout Periods Blackout periods apply to notification. If the blackout period is defined at the notification server. About Blackout Periods Blackout periods are set to prevent notification from taking place during a specified time period even if an alert condition occurs. alerts are not forwarded from the originating managed system to the remote notification server during a defined blackout period. Multiple blackout times per day can be established as well as blackouts that span multiple days.Stopping Notification For Specific Periods (Notification Blackouts) To Override Rules You can also limit notification by overriding a rule. It is blacked out by the notification server. Table 53 Local Types of Notification Blackouts Description If a blackout is defined locally. you can disable the arsAction rule on that remote agent. Stopping Notification For Specific Periods (Notification Blackouts) Use the Alert Settings dialog box–Notification Blackouts tab to specify periods when you do not want notification to be performed. but the notification server does not perform notification even though an alert is received. Table 53 lists the types and describes their behavior.

B Choose Event Management => Alert Settings.Stopping Notification For Specific Periods (Notification Blackouts) To Set Notification Blackout Periods 1 Access the Alert Settings . PATROL Configuration Manager displays the Alert Settings . C Click on the Notification Blackout tab.Notification Blackout tab dialog box as shown in Figure 52. right-click on an agent for which you want to set up notifications such as emails or pages. A In the Agent tree view. Figure 52 Alert Settings Dialog Box – Notification Blackouts Tab The Notification Blackout settings are described in Table 54.Notification Blackout tab. Chapter 7 Establish Notification and Manage Alerts 233 .

blackouts are schedule to reoccur on a weekly basis 234 PATROL Configuration Manager User Guide . PATROL Configuration Manager displays Period dialog box as shown in Figure 53. and seconds) at which the blackout period ends the days on which the blackout period occurs.Stopping Notification For Specific Periods (Notification Blackouts) Table 54 Setting Notification Blackout Properties 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 Selected Blackout Periods Add Periods Remove Periods 2 Choose the PATROL objects for which you want to set up a notification blackout by “Adding Objects” on page 196. Figure 53 Blackout Period Selection Dialog Box 4 Specify the period of time for which notification will not be sent when a selected PATROL object goes into an alert. minutes. minutes. Table 55 Field Start Time End Time Blackout Days Blackout Period Selection Properties Description the time (expressed in hours. The Notification Blackout settings are described in Table 55. 3 Click Add Periods. and seconds) at which the blackout period begins the time (expressed in hours.

The What If feature simulates a PATROL installation and reports on the success or failure of the notifications as you have defined them within PATROL Configuration Manager. Figure 54 shows a whatif rule in the agent backup folder. If the backup folder of the selected agent or the target notification server contains a whatif RuleSet (whatif. RuleSet Used for Testing What If tests are performed by PATROL Configuration Manager using the most recent agent backup configuration in the agent’s backup folder. Chapter 7 Establish Notification and Manage Alerts 235 . Notification Tests PATROL Configuration Manager allows you to test the notifications that you have established without actually having to apply them to an agent. PATROL Configuration Manager saves the Notification Blackout settings and closes the dialog box.Notification Tests EXAMPLE To set a blackout from Friday at 19:00 pm until Sunday at 9:00 requires you to create three blackout periods within PATROL Configuration Manager and merge them as you create each one: 1st Period Blackout Start Time -->19:00:00 Blackout Stop Time --> 23:59:59 Blackout Days-->Fri 2nd Period Blackout Start Time -->00:00:00 Blackout Stop Time --> 23:59:59 Blackout Days-->Sat 3rd Period Blackout Start Time -->00:00:00 Blackout Stop Time --> 09:00:00 Blackout Days-->Sun 5 Click OK. the whatif RuleSet is used for the simulation.cfg).

configure the agent as desired. you can determine if you have configured the notification rules correctly. With the test results. The test determines which rules are triggered when a parameter enters a specified state.Limitations Figure 54 What If RuleSet What If RuleSet Limitations You can only test the notification properties of one parameter at a time. 236 PATROL Configuration Manager User Guide . You must save all agents that you have added. the What If feature will not test notification set up for any new agents whose configuration has not been saved. If you do not. I To Simulate Sending Notifications 1 In the Agent tree view. Testing Notifications Use the What If? feature to test or simulate PATROL KM for Event Management configurations as they pertain to notification rules. PATROL Configuration Manager displays the What If dialog box as shown Figure 55. right-click an agent for which you want to test notifications such as emails or pages. 2 Choose Event Management => What If. such as ALARM or WARN. PATROL Configuration Manager prompts you to save the agent. Then perform a get on the agent to obtain the latest configuration and store it in backup folder. Before You Begin I Before using the What If feature to test your notification rules. If you add a new agent and attempt to perform What If before saving the agent.

Table 56 Field Parameter What If Properties Description specify a parameter to use for the What If simulation Click Browse to access the Object Selection dialog box. choose day on which you want to run the test The value defaults to the current day. This option is used for testing blackout periods The value defaults to the time at which the What If menu command is selected. Status Day choose the parameter status that you want to test with for the What If simulation. Time choose the time that you want the test to simulate. 4 Specify an Alert status and the time at which you want the test to be performed for the selected parameter. The What If settings are described in Table 56.Testing Notifications Figure 55 What If Dialog Box 3 Choose the parameter by clicking Browse and using the Object Selection dialog box. Chapter 7 Establish Notification and Manage Alerts 237 . 5 Click OK. PATROL Configuration Manager performs the What If simulation and returns the results in the WhatIf Results dialog box–Results tab as shown Figure 56. For instructions on how to choose an object by “Adding Objects” on page 196.

238 PATROL Configuration Manager User Guide . 7 To view the results in an online report. The Results tab displays each rule executed during the simulation in the order it was executed. choose Report tab.Testing Notifications Figure 56 What If Results Dialog Box – Results Tab 6 In the Results tab. view the execution of the rules. The What If dialog box–Report tab shows a text version of the What If report as shown Figure 57.

2 Navigate to the location where you want to save the file and type in the name. 3 Click Save.Testing Notifications Figure 57 What If Results Dialog Box – Report Tab To Save WhatIf Results in a Report 1 After completing step 1 through step 6 on page 238. click Save Report. 5 Click OK to exit the search dialog box. click Close. PATROL Configuration Manager saves the report to the file and displays the report in the Report Viewer. 4 When you are done viewing the results online. Chapter 7 Establish Notification and Manage Alerts 239 . PATROL Configuration Manager displays the Save dialog box.

Testing Notifications 240 PATROL Configuration Manager User Guide .

. . . . . . . . . Retrieve. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Turning Off Alarm Ranges. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Features and Limitations . . . . . . . . . . . . . KM Migration. . . . . . . . . . . . . . . . . . . . . . . . . Loading the AS_CHANGESPRING KM . . . . . . . . . . . . . Getting Global Poll Times . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Getting Localized Parameters . . . . . . . . . Import PATROL Console Configuration Files. . . . . . . Location and File Name of RuleSets Created by AS_CHANGESPRING KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Naming Convention of RuleSets Created by AS_CHANGESPRING KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating a Default RuleSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . and Import Information from the PATROL Agent and KMs. . . . . . . . . . . . . . . . . . . . . . . . . . . . Importing the Converted Data into PATROL Configuration Manager . . . . . . . . . . . . . . Convert. . . . Getting All Parameters . . . . . . . . . . . . . . . . . . . . 242 242 242 242 243 244 245 246 246 246 247 247 247 249 250 251 251 253 254 255 256 257 258 Chapter 8 Move PATROL Information into PATROL Configuration Manager 241 . . . . . . . . . . . Converting PATROL Console Desktop Settings to . . . . . . . . Accessing the KM Commands and InfoBoxes . . . . . . . . Make New RuleSets Available to PATROL Configuration Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .ini Files . . . . . . . . . . . . . . . . . . . . . . . . . Converting Parameter Overrides to RuleSets . . . . . . . . . . . . . . . . . . . . . . . . . . . . AS_CHANGESPRING KM. . . . . . . . . . . . . . . Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Getting Global Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . The following topics are discussed: Overview . . . . . . . . . . . . .Chapter 8 Move PATROL Information into PATROL Configuration Manager 8 This chapter describes how to convert and import information that has traditionally been stored and managed on the PATROL Agent and PATROL Console into the PATROL Configuration Manager. . . . . . . . Transferring this information requires the use of the AS_CHANGESPRING Knowledge Module. . . . . . . . . . . . Updating the PATROL Object List . Creating RuleSet from Comma-Separated Value Files . . . . . . . . .

the AS_CHANGESPRING KM requires the PATROL Knowledge Module for Event Management to be installed and loaded on the PATROL Agent. 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. Requirements To function properly. 242 PATROL Configuration Manager User Guide . PATROL Configuration Manager includes the following tools for converting PATROL data into PATROL Configuration Manager information: I I 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.Overview Overview PATROL Configuration Manager includes tools that help you get your PATROL environment into PATROL Configuration Manager. the KMs that you use with the AS_CHANGESPRING KM must be loaded on the PATROL Agent and active. Features and Limitations The AS_CHANGESPRING KM has the following features and limitations: I I I I 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.

NOTE The AS_CHANGESPRING.km) from the drop-down list box. The Load KMs dialog box displays a list of available .kml files.km on all of the computers listed under PATROLMainMap in the tree view.km. choose File => Load KM. Before You Begin Start the PATROL Console in Developer mode and connect to the PATROL Agent that you want to get configuration information from. PATROL loads the AS_CHANGESPRING. follow the instructions that apply to your console.kml files.km files instead (equivalent to application classes) by changing the filter. NOTE Do not commit the AS_CHANGESPRING.km files instead (equivalent to application classes) by selecting KM Files (*. choose File => Load KM. You only need to load the KM in the PATROL Developer Console to use the AS_CHANGESPRING. The Load KMs dialog box displays a list of available . you must first load the KM on the PATROL Developer Console. To Load KMs from the PATROL Console for UNIX 1 From the PATROL Console for UNIX menu bar. and click Open. Display . 2 Select the AS_CHANGESPRING.Loading the AS_CHANGESPRING KM Loading the AS_CHANGESPRING KM Before you can begin using the AS_CHANGESPRING KM. Chapter 8 Move PATROL Information into PATROL Configuration Manager 243 . In this task. See “Installation” on page 19 for more information. Display . To Load KMs from the PATROL Console for Microsoft Windows 1 From the PATROL Console for Microsoft Windows menu bar.km file.km to the connected agents.km is installed with PATROL Configuration Manager in the utils subdirectory of the installation directory.

right-click an application class or parameter icon and choose InfoBox from the pop-up menu. You only need to load the KM in the PATROL Developer Console to use the AS_CHANGESPRING. right-click a computer or With the middle mouse button. that contains KM-specific commands. 244 PATROL Configuration Manager User Guide . 2 Select the AS_CHANGESPRING.Accessing the KM Commands and InfoBoxes NOTE The AS_CHANGESPRING. PATROL loads the AS_CHANGESPRING. To access InfoBoxes In either the Desktop tree tab or the work area. See “Installation” on page 19 for more information.km.km file.km to the connected agents. Table 57 Console PATROL Console for Microsoft Windows Accessing KM Commands and InfoBoxes To access menu commands In either the Desktop tree tab or work area. Accessing the KM Commands and InfoBoxes Table 57 provides information about how to access KM commands and InfoBoxes from the PATROL Consoles. PATROL Console for UNIX In the work area. right-click a computer or application icon and choose KM Commands from the pop-up menu. Figure 58 shows the AS_CHANGESPRING menu commands in the PATROL Console for Microsoft Windows.km on all of the computers to which your console is connected. and click Open. click an application icon to display a pop-up menu application class or parameter icon. NOTE Do not commit the AS_CHANGESPRING.km is installed with PATROL Configuration Manager in the utils subdirectory of the installation directory.

Convert. and Import Information from the PATROL Agent and KMs Figure 58 AS_CHANGESPRING Menu Commands Retrieve. Convert. and Import Information from the PATROL Agent and KMs The AS_CHANGESPRING Knowledge Module converts PATROL Agent settings into PATROL Configuration Manager settings and RuleSets. you can perform following command task: I I I I I I I I “Getting Localized Parameters” on page 247 “Getting Global Parameters” on page 249 “Getting Global Poll Times” on page 250 “Creating a Default RuleSet” on page 251 “Updating the PATROL Object List” on page 251 “Creating RuleSet from Comma-Separated Value Files” on page 253 “Converting Parameter Overrides to RuleSets” on page 254 “Turning Off Alarm Ranges” on page 255 Chapter 8 Move PATROL Information into PATROL Configuration Manager 245 . With this knowledge module.Retrieve.

cfg Location and File Name of RuleSets Created by AS_CHANGESPRING KM When you create a RuleSet using the AS_CHANGESPRING KM features. the knowledge module writes the RuleSet to a configuration file.KM Migration KM Migration The AS_CHANGESPRING KM provides a means by which you can migrate customizations to KMs. This KM identifies all the localized thresholds running on a PATROL Agent and creates a RuleSet equivalent to the thresholds. The PATROL Console System Output Window (SOW) displays the location and name of the RuleSet as shown in Figure 59. Figure 59 RuleSet File Name Output 246 PATROL Configuration Manager User Guide . you must record the localized settings and reapply them to the new KMs. when you migrate a KM. You can take this new RuleSet and apply it to a new KM to migrate your localized thresholds. Naming Convention of RuleSets Created by AS_CHANGESPRING KM The configuration file has the following naming convention: host_port_localizedParams. Once you have retrieved the thresholds and saved them as rules. you have the RuleSets to reuse with each new version of the KM. Normally.

the configuration manger can manage the RuleSet and apply it to other agents. access the KM Command menu for the AS_CHANGESPRING application instance and choose Get All Parameters => Create RuleSet. Getting Localized Parameters The Get Localized Parameters command creates a RuleSet for all localized parameters running on a managed system. The name and location of the RuleSet are printed to the system output window. including collector parameters. it places the newly created RuleSet on the agent. Chapter 8 Move PATROL Information into PATROL Configuration Manager 247 . PATROL creates a PATROL Configuration Manager RuleSet file that you can apply to many agents. To Store in PATROL Configuration Database You can also store the RuleSet information in the PATROL Agent configuration database on the selected agent instead of creating an external configuration file. You can add these settings to the local RuleSet for the agent in PATROL Configuration Manager. The advantage of creating the RuleSet in the PATROL configuration database on the agent is that you do not have to move files around. Getting All Parameters The Get All Parameters command creates a RuleSet for all parameters. For PATROL Configuration Manager to be able to access the RuleSet. it must reside in the RuleSets directory of PATROL Configuration Manager. After it is the RuleSets directory. running on a managed system.Make New RuleSets Available to PATROL Configuration Manager Make New RuleSets Available to PATROL Configuration Manager When you create a RuleSet using the AS_CHANGESPRING KM. You can add these localized settings to the local RuleSet for the agent in PATROL Configuration Manager. You can save it to the agent and then perform a Get on an agent and create a RuleSet from the backup folder without having to move a file from one computer to another. To Create a RuleSet with All Parameters From the PATROL Console.

You can save it to the agent and then perform a Get on an agent and create a RuleSet from the backup folder without having to move a file from one computer to another. access the KM Command popup menu for the AS_CHANGESPRING application instance and choose Event Management => Parameter Settings => Thresholds. The name and location of the RuleSet are printed to the system output window. To Store in PATROL Configuration Database You can also store the RuleSet information in the PATROL Agent configuration database on the selected agent instead of creating an external configuration file. PATROL creates a PATROL Configuration Manager RuleSet file that you can apply to many agents. The advantage of creating the RuleSet in the PATROL configuration database on the agent is that you do not have to move files around.Getting Localized Parameters To Create a RuleSet From the PATROL Console. 248 PATROL Configuration Manager User Guide .

The name and location of the RuleSet are printed to the system output window as shown in Figure 59 on page 246. With these commands you can create RuleSets for all of your thresholds and manage them with PATROL Configuration Manager. Figure 60 Select the Knowledge Modules Dialog Box Chapter 8 Move PATROL Information into PATROL Configuration Manager 249 . PATROL displays the Select Knowledge Module(s) dialog box as shown in Figure 60.Getting Global Parameters Getting Global Parameters The Get Global Parameters commands create a RuleSet for all of your global thresholds. PATROL creates a PATROL Configuration Manager RuleSet file that you can apply to many agents. To Create a RuleSet For All Knowledge Modules Create a RuleSet for all knowledge modules by choosing Get Global Parameters => Create a Ruleset => All Knowledge Modules. To Create a RuleSet For Select Knowledge Modules Create a RuleSet for select knowledge modules by choosing Get Global Parameters => Create a Ruleset => Select Knowledge Modules. Choose the KMs you want to include and click Accept.

To Store in PATROL Configuration Database For Selected Knowledge Modules 1 Save the RuleSet information in the PATROL Agent configuration database on the selected agent instead of creating an external configuration file by choosing Get Global Parameters => Store in PATROL Configuration DB => Select Knowledge Modules. Getting Global Poll Times The Get Global Polltimes commands create a RuleSet for all of your global polltimes. PATROL displays Select the Knowledge Modules dialog box as shown in Figure 60 on page 249. The name and location of the RuleSet are printed to the system output window after you execute the command.Getting Global Poll Times To Store in PATROL Configuration Database For All Knowledge Modules Save the RuleSet information in the PATROL Agent configuration database on the selected agent instead of creating an external configuration file by choosing Get Global Parameters => Store in PATROL Configuration DB => All Knowledge Modules. 2 Choose the knowledge module that you want to include and click Accept. To Create a RuleSet For All Knowledge Modules Create a RuleSet for poll times by choosing Get Global Polltimes => Create Ruleset => All Knowledge Modules. 2 Choose the KMs you want to include and click Accept. With these commands you can create RuleSets for all of your poll times and manage them with PATROL Configuration Manager. To Create a RuleSet For Select Knowledge Modules 1 Create a RuleSet for selected KMs poll times by choosing Get Global Polltimes => Create Ruleset => Select Knowledge Modules. 250 PATROL Configuration Manager User Guide . PATROL creates a PATROL Configuration Manager RuleSet file that you can apply to many agents. PATROL displays the Select the Knowledge Modules dialog box as shown in Figure 60 on page 249.

and since pconfig only shows you what changed and not all settings. PATROL Configuration Manager does not have dynamic connections to the PATROL Agent.default file as a RuleSet. Chapter 8 Move PATROL Information into PATROL Configuration Manager 251 . However. PATROL Configuration Manager uses pconfig.cfg Updating the PATROL Object List Creates files that define PATROL objects for PATROL Configuration Manager. Figure 59 on page 246 shows an example of a RuleSet file name in the PATROL Console System Output window. 2 Choose the KMs that you want to include and click Accept. Creating a Default RuleSet PATROL Configuration Manager shows you what is different from your PATROL Agent config. you may want to manage your config.Creating a Default RuleSet To Store in PATROL Configuration Database For All Knowledge Modules Save the RuleSet information in the PATROL Agent configuration database on the selected agent instead of creating an external configuration file by choosing Get Global Polltimes => Store in PATROL Configuration DB => All Knowledge Modules. PATROL displays Select the Knowledge Modules dialog box as shown in Figure 60 on page 249. creating a RuleSet from the config.default file allows you to see everything that is set on the agent. When you create Event Management rules using PATROL Configuration Manager. and you choose the command to add an object. To Store in PATROL Configuration Database For Select Knowledge Modules 1 Save the RuleSet information in the PATROL Agent configuration database on the selected agent instead of creating an external configuration file by choosing Get Global Polltimes => Store in PATROL Configuration DB => Select Knowledge Modules. the Add Object list contains a static list of PATROL objects that is created from files installed with PATROL Configuration Manager.default file. This command creates the following file on the PATROL Agent: Default_Config_RuleSet.

NOTE The output directory must exist on the PATROL Agent or the command fails.def file. there is a file that defines the associated parameters and a file that defines the associated instances. The key file is called application_classes.def file. move them to the <install_dir>\patrol directory on the PATROL Configuration Manager system. 252 PATROL Configuration Manager User Guide .sid (instances) The Create files for patrol_dir command opens the Create List dialog box as shown in Figure 61 on page 252: Figure 61 Create List Dialog Box Use the Create List dialog box to specify the output directory for the patrol_dir files.Updating the PATROL Object List 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.prm (parameters) NT_CPU. For example. the following files define the parameters and instances for NT_CPU: I I NT_CPU.def which defines all the application classes that are available in the PATROL Configuration Manager event management commands. The results of the command are printed to the system output window. if NT_CPU is an entry in application_classes. After you create the new files. For each application class listed in the application_classes.

and create a RuleSet for the new settings using the Create Ruleset from CSV File command.prm and . 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. NOTE The Create Ruleset from CSV File command requires input in the same format as the PATROL KM for Event Management CSV report format. Specify the location of the CSV file on the PATROL Agent. Creating RuleSet from Comma-Separated Value Files The Create Ruleset from CSV (comma separated values) File command converts a specifically formatted CSV file into a PATROL Configuration Manager RuleSet. you can copy it to the PATROL Configuration Manager RuleSets directory and apply it to PATROL Agents. The configuration file is created in the same directory as the other configuration files. Chapter 8 Move PATROL Information into PATROL Configuration Manager 253 .def file and then copying all the new .def file to the existing application_classes. When you copy the files. edit the CSV file using Microsoft Excel or a text editor. You can create a CSV file with the PATROL KM for Event Management.Creating RuleSet from Comma-Separated Value Files You can merge the new files with the existing object definitions by copying the entries in the new application_classes.cfg After you create the RuleSet from the CSV file. and it has the following naming convention: host_port_ThresholdRuleSet. replace any identical files with the new files because the new files more accurately reflect your environment. The Create Ruleset from CSV File command opens the Get File dialog box as shown in Figure 62: Figure 62 Get File Dialog Box Use the Get File dialog box to specify the CSV file that you are using as input.sid files to the <install_dir>\patrol directory.

254 PATROL Configuration Manager User Guide .Converting Parameter Overrides to RuleSets Converting Parameter Overrides to RuleSets The Convert Overrides to EVS commands delete operator overrides and create PATROL KM for Event Management rules for all of your operator overrides. 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. the command creates a PATROL Configuration Manager RuleSet file that you can apply to many agents. Figure 59 on page 246 shows an example of a RuleSet file name in the PATROL Console System Output window. WARNING The operator overrides are removed from the agent. The configuration file has the following naming convention: host_port_overrideParams. 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: I I Convert Overrides to EVS => Create Ruleset Convert Overrides to EVS => Store in PATROL’s Configuration DB To Create a RuleSet If you choose to create a RuleSet. The name and location of the RuleSet are printed to the system output window after you execute the command. To Store in PATROL Configuration Database You can also store the RuleSet information in the PATROL Agent configuration database on the selected agent instead of creating an external configuration file.cfg When you create a RuleSet.

Turning Off Alarm Ranges

Turning 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 create 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:
I I I

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’s Configuration DB => All Knowledge Modules Turn Off Alarm Ranges => Create a Ruleset =>Store in PATROL’s Configuration DB => Select Knowledge Modules

I

To Create a RuleSet For All Knowledge Modules
If you choose 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 59 on page 246 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.

To Create a RuleSet For Select Knowledge Modules
This command is the same as the Turn Off Alarm Ranges => Create a Ruleset => All Knowledge Modules command, but you can choose the KMs you want to include. Figure 60 on page 249 shows the Select the Knowledge Modules dialog box.

Chapter 8

Move PATROL Information into PATROL Configuration Manager

255

Import PATROL Console Configuration Files

To Store in PATROL Configuration Database For 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.

To Store in PATROL Configuration Database For 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 choose the KMs you want to include. Figure 60 on page 249 shows the Select the Knowledge Modules dialog box.

Import PATROL Console Configuration Files
You can import PATROL Console desktop configuration files into PATROL Configuration Manager. You achieve this result by converting the PATROL Console desktop files to PATROL Configuration Manager agent.ini and group.ini files. Then you copy 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 converts only PATROL Console desktop files from the PATROL Console for Windows and the PATROL Console for UNIX. The PATROL Central consoles do not use desktop files.

Conversion Guidelines
The csmi utility converts the PATROL Console desktops files into PATROL Configuration Manager .ini files using the following guidelines:
I

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.

I

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

256

PATROL Configuration Manager User Guide

Converting PATROL Console Desktop Settings to .ini Files

Converting PATROL Console Desktop Settings to .ini Files
Convert your PATROL Console desktop configuration into .ini files.

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 1 Open a command prompt. 2 Change to the utils directory in PATROL Configuration Manager installation
directory.
I I

(UNIX) – cd /opt/bmc/pconfmgr (Windows) – cd C:\Program Files\BMC Software\pconfmgr\utils

3 Start the csmi utility with the following command:
I I

(UNIX) – csmi.csh (Windows)– csmi.bat

4 Enter the full path of your PATROL cache directory, or press Enter to accept the
default.

5 Enter the most frequently used Agent port number, or press enter to accept the
default value (3181).

6 Enter the most frequently used protocol (UDP/TCP) for connecting to the
PATROL Agent, or press enter to accept the default value (TCP).

7 The csmi utility converts your PATROL desktop configuration files into the
following files:
I I

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 257. 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.
Chapter 8 Move PATROL Information into PATROL Configuration Manager 257

Importing the Converted Data into PATROL Configuration Manager

Importing the Converted Data into PATROL Configuration Manager
Import converted data in the form of .ini files into the PATROL Configuration Manager.

Before You Begin
Exit PATROL Configuration Manager before you import the converted PATROL Console desktop settings.

To Import the Converted Data into PATROL Configuration Manager
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. 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.

258

PATROL Configuration Manager User Guide

Chapter

9
260 260 260 261 263 264 267 268 268

9

Command Line Interface
This chapter discusses the PATROL Configuration Manager command line interface (CLI). It describes how to access the CLI, lists and defines CLI options, and provides some sample scripts. This chapter presents the following topics: Features of the PATROL Configuration Manager CLI Utility . . . . . . . . . . . . . . . . . . Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Location. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Command Line Interface (CLI) Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Script File Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Handling. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Sample Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Scheduling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Chapter 9

Command Line Interface

259

Features of the PATROL Configuration Manager CLI Utility

Features of the PATROL Configuration Manager CLI Utility
The PATROL Configuration Manager Command Line Interface (CLI) is provided for you to perform some configuration management tasks by non-interactive methods such as scripts and batch files. The command line interface provides a subset of the GUI functionality. The tasks supported by the CLI include
I I I

distributing RuleSets to groups and agents distributing license files to groups and agents generating reports

Dependencies
To use the PATROL Configuration Manager CLI, you must
I I

have agent and group information in the respective initialization file stored user credentials in the Secure Key Store, if the agents require authentication

Location
Table 58 lists the path and filename of the CLI on Windows and UNIX platforms. Table 58
Operating System Windows UNIX

PATROL Configuration Manager CLI Path and File Name
Filename PCM.cmd PCM.sh Path %BMC_ROOT%\pconfmgr\ $BMC_ROOT/pconfmgr/

260

PATROL Configuration Manager User Guide

Table 59 UNIX Windows Location of the pcm_cli_allow_unattended_login Script Path $BMC_ROOT/pconfmgr/bin/OS %BMC_ROOT%\pconfmgr\bin\Windows-x86 Operating System 2 Type the script name and press Enter. Unattended Login Mode To Run in Unattended Login Mode 1 Navigate to the platform-specific bin directory for PATROL Configuration Manager. The stanza consists of an encrypted password and a reference to the key material file required to open the Secure Key Store.Authentication Authentication To generate reports and distribute configurations to an agent that requires authentication.sh pcm_cli_allow_unattended_login. Chapter 9 Command Line Interface 261 . Table 60 UNIX Windows pcm_cli_allow_unattended_login Script per Platform Script Filename pcm_cli_allow_unattended_login. For more information about authentication. Table 60 lists the script for each platform. Default Login Mode For security reasons. A similar script is available for UNIX systems. Figure 63 on page 262 provides an example of the command for computers running the Windows operating system. the PCM policy.cmd Operating System The script installs the password stanza in the policy. does not contain a password stanza and thus defaults to attended login mode. Table 59 lists the location for each platforms. PATROL Configuration Manager must access the Secure Key Store and retrieve the user name and password for the agent. which is installed during the installation of PATROL Configuration Manager. see the PATROL Security User Guide.

cmd” “C:\Program Files\BMC Software\pconfmgr\security\pcm_cli.exe" C:\Program Files\BMC Software\common\security\config_v3.reg” TRUE “C:\Program Files\BMC Software\common\security\config_v3.txt Please enter the SKS password:* 262 PATROL Configuration Manager User Guide .exe" “C:\Program Files\BMC Software\common\security\bin_v3.0\policy_install. you can restrict the permissions on the key material file to read only for one user name. the execution of the batch script pauses until the password is provided from STDIN.cmd ”C:\Program Files\BMC Software\common\security\config_v3. which masks the password. NOTE To prevent unauthorized access of the Secure Key Store.Authentication Figure 63 Example of pmc_cli_allow_unattended_login. you can use the Interactive password prompt to access the Secure Key Store.0\pcm_cli\keystore" Additional Security Considerations Any computer that stores a password (encrypted or decrypted) and keyfile on it is susceptible to an attack. Provide physical security for the system such as restricting user access to the system.0\Windowsx86\SecMngr. Figure 64 provides an example of an a script running in attended login mode.exe” "Patrol\SecurityPolicy_v3.0\PtRegCheck. Figure 64 Example of pcmcli Interacting with a Policy in Running Attended Mode pcmcli -f mypcmscript. Attended Login Mode If unattended login mode is unavailable or undesirable. under which all batch operations are performed. In attended login mode.0\PtRegDelete.

d/SecurityPolicy_v3. you must provide a fully qualified security policy file name such as -P /etc/patrol. Table 61 Option -P PATROL Configuration Manager CLI Options and Arguments (part 1 of 2) Argument policy_name Description designates the Security Policy to be used during authentication operations I For Windows.ext -P policy_name -f filename Option Table 61 describes the options and their arguments.ext) and the policy argument will be platform-specific.0\pcm_cli” For UNIX. you must provide a fully qualified registry path such as -P “SOFTWARE\BMC Software\Patrol\ SecurityPolicy_v3.0/ pcm_cli. Figure 65 PATROL Configuration Manager CLI Syntax pcm. see “Script File Options” on page 264.Command Line Interface (CLI) Options Command Line Interface (CLI) Options The PATROL Configuration Manager CLI performs two primary functions: I passing authentication information process a script file that contains commands regarding RuleSet / License distribution and report generation I Syntax Figure 65 displays its basic syntax. Chapter 9 Command Line Interface 263 .plc I -d # turns the debug option on or off 0–off 1–on -f filename references the script file that contains the PATROL Configuration Manager CLI commands For information about the script file syntax. The CLI utility’s extension (represented by the variable .

Syntax Figure 66 displays the basic file syntax.Script File Options Table 61 Option -help PATROL Configuration Manager CLI Options and Arguments (part 2 of 2) Argument command Description displays usage information about PATROL Configuration Manager Commands for which help is available for scripts include apply license report add_agent add_group config_sec -v display version information about the utility Script File Options The script file contains all the commands to perform configuration tasks. Figure 66 PATROL Configuration Manager CLI Script File Syntax command_1 -option_1 -argument_1 command_2 -option_2 -argument_2 command_N -option_N -argument_N 264 PATROL Configuration Manager User Guide .

1. the agent is added to the root node. -g -a -ol -pa -ba -cg -pt RuleSet GroupName AgentName apply RuleSet to a group or subgroup apply RuleSet to an agent overwrite existing localized settings purge the agent of all configuration changes before applying the current RuleSet write the current agent configuration to a backup RuleSet apply ApplyOnApply rules in the specified group apply ApplyOnAppy rules in the parent tree groups patha and name of the Rule set relative to the RuleSets directory adds an agent This command is used to add agents.2 3. -app RuleSetName (Optional) -auth -ba -cg -host -name -ol -pa -pg -port -proto -pt -sec Security Level Parent Group Port Protocol Host name Display name use authentication for configuration purposes back up agents before applying rules or RuleSets apply ApplyOnNew items in the current group host name display name (the default is the host name) overwrite the current localized settings purge the agent of all configuration changes before applying parent group port (default : 3181) protocol (TCP or UDP) (Default: TCP) apply ApplyOnNew items in the parent tree groups security level (0. Table 62 Command apply PATROL Configuration Manager CLI File Options (part 1 of 3) Option Argument Description applies the specified RuleSet(s) to a group or an agent This command is used to distribute RuleSets.Script File Options Options Table 62 describes the commands. and their corresponding arguments. or 4) (Default 0) apply ApplyOnNew rules to an agent add agent Chapter 9 Command Line Interface 265 . their options. Either a Group or an agent name must be provided. If the group name is not specified.

Script File Options Table 62 Command add_group PATROL Configuration Manager CLI File Options (part 2 of 3) Option Argument Description adds a group This command is used to add groups. If a sub-group is to be added. the License argument must include the fully qualified path. -a -d -r Remove security configuration Agent name agent name Default credentials This command is used to remove the security configured for the agent. -g -pg Group name the group name which needs to be added security configuration. -g -a GroupName AgentName License apply license to a group or subgroup apply license to an agent fully qualified patha and name of the license file Parent group name the parent group to which the new group needs to be added config_sec license 266 PATROL Configuration Manager User Guide . This command is used to add information pertaining to the security configuration of the agent. sends the specified license file to a group or an agent If the license file is not in the current working path. Either a group or an agent name must be provided. you must specify the parent group hierarchy for the subgroup.

organizes it into a report. The default report format is text (*. -csv -htm -xml FileName save report in comma-separated value formatb (*. -g -a -os -ic -km -ac -ai -pi -ub GroupName AgentName generate a report for this group or subgroup generate a report for this agent collect operating system and agent information collect installed component information collect preloaded and active knowledge module information collect application class information collect application class instance information collect parameter information extract report information from backup configuration files This option reduces the time required to generate a report but may provide stale information. and formats the report according to your specification Either a group or an agent name must be provided. Chapter 9 Command Line Interface 267 . This option can only be used with -os and -km options. without extension a b If a path contains spaces or blanks.csv) save report in HyperText Markup Language formatb (*.Error Handling Table 62 Command report PATROL Configuration Manager CLI File Options (part 3 of 3) Option Argument Description gathers requested information.htm) save report in eXtensible Markup Language formatb (*.xml) fully qualified patha and name of the report output file. Error Handling An error in any of the commands contained within the script causes the entire script to abort.txt). the path must be enclosed in quotes (“ “). The CLI returns an error code of 1.

log OUTPUT=$TMP_DIR/dailyreport cat > $SCRIPT << EOF report –km –ac –ai –pi –g Production –pi –htm $OUTPUT EOF PATH=$JAVA_HOME/bin:$PATH $PCM_DIR/PCM.4. UNIX To Define a PATROL Configuration Manager Report in a Script File 1 Open a text editor and create a script similar to the one in Figure 67. This sample script addresses the task on both UNIX (Solaris) and Windows platforms. filenames.d/security_policy_v3. Do not attempt to implement them as written.sh –P /etc/patrol. 268 PATROL Configuration Manager User Guide .Sample Scripts Sample Scripts This section provides some sample scripts that demonstrate some possible ways in which the PATROL Configuration Manager CLI can be employed.plc –f $SCRIPT > $LOG 2>&1 2 Test the script to ensure that it produces the desired results. report data and so forth.0/pcm_cli. Figure 67 Generate a Report by Using PATROL Configuration Manager CLI on Solaris #!/bin/sh JAVA_HOME=/usr/j2re1.cli LOG=$TMP_DIR/dailyreport. Scheduling To schedule PATROL Configuration Manager reports to run at a designated time requires creating the script file and then entering the command into an operating specific job schedule. NOTE Everything about these samples is system and/or platform-specific: directory names. The scripts are provided as models from which you should extrapolate.2_07 PCM_DIR=/opt/bmc/pconfmgr TMP_DIR=/tmp SCRIPT=$TMP_DIR/dailyreport.

Scheduling To Schedule a Script to Run Add an entry to the crontab that will run the report at a desired time. and run the Add Scheduled Task wizard.sh Windows To Define a PATROL Configuration Manager Report in a Script File 1 Open a text editor and create a script (*. select the Scheduled Tasks applet. To Schedule a Script to Run in Windows Navigate to the Control Pane.0\pcm_cli" -f %SCRIPT% > %LOG% 2>&1 2 Test the script to ensure that it produces the desired results. The entry displayed in Figure 68 runs the report every day at 3:15 a. Add a task that calls the script file (*.m.cmd) that you created with the desired frequency.cli PCM.cmd -P "SOFTWARE\BMC Software\PATROL\SecurityPolicy_v3. Chapter 9 Command Line Interface 269 . Figure 68 Schedule a Report on UNIX – crontab Entry 15 3 * * * $HOME/dailyreport.log set OUTPUT=%TEMP%\dailyreport echo report -km -ac -ai -pi -g Production -pi -htm %OUTPUT% > %TEMP%\dailyreport. Figure 69 Generate a Report by Using PATROL Configuration Manager CLI on Windows set SCRIPT=%TEMP%\dailyreport.cmd) similar to the one in Figure 69.cli set LOG=%TEMP%\dailyreport.

Scheduling 270 PATROL Configuration Manager User Guide .

. . . . . . . . . . . . .Appendix A A Configuration Settings This appendix describes the directories. 272 Configuration Settings Changed Using the File => Configure Command. . . . and settings used by the PATROL Configuration Manager component.ini File . . . . . files. . . 272 Configuration Settings Changed by Editing the PCM. . . . . . . . . . . . . . . . . . . . . . . . . . . . . Overview . . 273 Appendix A Configuration Settings 271 . . . . . . . . . . . . . . . . . . . . . . . . . .

Configuration Settings Changed Using the File => Configure Command The following configuration settings are changed using the File => Configure command on the Menu bar. NOTE Prior to performing an upgrade.ini at installation.ini file. and some configuration values are changed by editing the PCM. Some configuration values are changed using the File => Configure command. defaulted to PCM. All configuration values are stored in the PATROL Configuration Manager initialization file.ini file. I I I I I I I I I I I I I I I I I 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 272 PATROL Configuration Manager User Guide .Overview Overview PATROL Configuration Manager configuration values are stored in the PCM. backup the entire PATROL Configuration Manager installation directory.

ini file. Table 63 Variable PATROL Configuration Manager Configuration Variables (part 1 of 8) Type setting setting Description indicates whether the ApplyOnNew feature is on Default Value true applyonnew_active autosave_enabled immediately saves agents.ini false and groups. NOTE Some of the configuration variables will not be in the PCM. and other support libraries install_dir/bin/platform Appendix A Configuration Settings 273 .ini File Table 63 describes the configuration settings that can be changed by editing the PCM.ini File Configuration Settings Changed by Editing the PCM.Configuration Settings Changed by Editing the PCM. and you need to create the variable to set the configuration value.ini when a change is made to either’s respective data true = save automatically false = save changes only when the user initiates a save through the menu command backup_before_apply setting indicates if the agent configuration is backed up before new RuleSets are applied directory that contains agent configuration backups maximum number of virtual backup folders true backup_dir backup_folder_groups backup_folder_min directory setting setting install_dir/rulesets/PCM/ backup 20 minimum number of agents in 20 a virtual backup folder before creating a new virtual backup folder indicates if agent configurations that are identical to the most recent agent configuration backup are saved false backup_identical_confi gurations setting backups_saved bin_dir setting directory maximum number of backups 5 to save for an agent directory containing the backend. security.ini file.

Configuration Settings Changed by Editing the PCM.ini File Table 63 Variable PATROL Configuration Manager Configuration Variables (part 2 of 8) Type directory setting Description directory that contains comments for RuleSets determines the level of debug messages sent to the Debug Window. for a range of values. PCM. see debuglevel determines whether PATROL false Configuration Manager displays a window with debug information specifies the number of connection attempts or PATROL pings the Agent Discovery wizard sends in a single burst during discovery specifies the number of milliseconds that the Agent Discovery wizard waits between sending connection attempt or PATROL ping bursts during discovery instructs the Agent Discovery wizard to ignore the time out value until after a TCP/IP connection is made file that contains PATROL Configuration Manager error messages directory containing the Extended Security System binaries directory containing the Extended Security System JNI jar file 254 debugwindow setting discovery_max_burst_p setting ackets discovery_burst_delay setting 20 discovery_tcp_ignore_c setting onnect_timeout false errorfile file install_dir/PCM.err.err ess_bin_dir directory ess_jar_path directory 274 PATROL Configuration Manager User Guide . valid values are 1 = Critical Error 2 = Error 3 = Warning 4 = Info 5 = Detail 6 = Trace 7 = Verbose Default Value install_dir/comments 2 comments_dir debuglevel debugloglevel setting determines the level of debug 2 messages sent to the error file.

ini) the directory where PATROL Configuration Manager is installed install_dir/ini ini_dir directory install_dir directory install_dir keep_report_data setting false determines whether temporary report files are saved when PATROL Configuration Manager exits. ruleset_dir/PCM/local 1 local_dir lock_check_timer directory setting locking_retry_wait setting specifies the number of milliseconds that PATROL Configuration Manager waits when attempting to lock a file Valid values range from 1 to 10. Appendix A Configuration Settings 275 . true indicates that the files are saved directory that contains the localized agent RuleSets determines how often (in seconds) to check for agent and group locks and update the lock information in PATROL Configuration Manager Valid values range from 0 to 250.” set this variable to true to force Java clean up unused memory and file descriptors directory in which help files are stored install_dir/help garbage_collect_after_p setting config help_dir images_dir directory directory directory that contains images install_dir/images used in the PATROL Configuration Manager interface directory that contains information about all configured agents (agents.Configuration Settings Changed by Editing the PCM.ini File Table 63 Variable evs_menu PATROL Configuration Manager Configuration Variables (part 3 of 8) Type setting Description Default Value indicates if the Event true Management menu is included on the Agent short cut menu If jobs start to fail with an error false message “Too many open files.ini) and groups (groups.

ini determines the maximum number of characters in a full file path (Windows Only) maximum number of lines displayed in the Status window number of lines in status buffer before truncating to maximum number of lines in Status Window 2 max_ini_backups setting max_path_length setting 256 message_max_lines setting 150 message_truncate_lines setting 50 PATROL Configuration file Manager initialization file install_dir/PCM. groups.ini. and rulealiases.ini the file that contains these variables that define application defaults such as directory and file locations and PATROL Configuration Manager settings directory that contains a static list of PATROL objects install_dir/patrol patrol_dir directory 276 PATROL Configuration Manager User Guide .ini.Configuration Settings Changed by Editing the PCM.ini File Table 63 Variable PATROL Configuration Manager Configuration Variables (part 4 of 8) Type setting Description specifies the number of times PATROL Configuration Manager attempts to lock a file file that contains a log of all operations performed against agents install_dir/PCM.ini.cfg file can transfer to an agent 500 max_config_file_lines setting max_folder_length setting determines maximum number 200 of characters in folder directory name (Windows Only) determines the maximum number of backups of ini files that will be retained for the following ini files: PCM.log Default Value locking_max_retries logfile file max_agents_per_report setting _thread 10 determines the maximum number of agents with which a single report process communicates determines the maximum number of lines that a single . agents.

Default Value 0 pconfig_debug_mode pconfig_local_port setting randomly-assigned port number 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. you can use one . When the pconfig_local_port variable is specified. If single threading all agent operations is an issue. PATROL Configuration Manager single threads all agent operations.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. pconfig_use_strict setting enable or disable the usage of the pconfig +strict option.ini File Table 63 Variable PATROL Configuration Manager Configuration Variables (part 5 of 8) Type setting Description defines the debug level for pconfig Valid values range from 0 (no debugging info) to 65535 (full trace).Configuration Settings Changed by Editing the PCM. which enforces stringent rule variable naming guidelines true pexec_args setting determines whether additional yes arguments can be passed to the pcm_pexec utility sets pcm_exec in debug mode false and instructs the utility to write input to a temporary file specifies the timeout in seconds for pcm_pexec operations such as reporting and real-time object selection 300 pexec_debug_mode setting pexec_timeout setting Appendix A Configuration Settings 277 .

various versions of the agent have various limitations 1020 setting 278 PATROL Configuration Manager User Guide . Default Value pexec_trace_mode queue_dir report_local_overwrite directory setting contains all rules to be applied install_dir/rulesets/PCM/ queue creates a report that lists all the false global rules that have been overwritten by local rules The report is generated before a set of rules is applied to an agent or group reports_dir rt_servers directory setting directory in which reports are stored stores the last RT Server locator string used by the Agent Discovery Wizard contains all RuleSet subfolders and files the maximum number of matches returned by the RuleSet search If the search returns more that the default number.ini of the last RuleSet search criteria maximum number of characters that can make-up a rule value.ini File Table 63 Variable PATROL Configuration Manager Configuration Variables (part 6 of 8) Type setting Description enables the full trace mode in the pexec API and turns on trace in the PSL functions of the reporting library The value for full trace mode is 65535.Configuration Settings Changed by Editing the PCM. PATROL Configuration Manager opens a dialog box that tell you. install_dir/reports tcp:localhost:2059 ruleset_dir ruleset_max_search_ results directory setting install_dir/rulesets 5000 ruleset_search_items_ file ruleval_max_length file contains the persistent settings ini_dir/ruleset_search. this value should correspond with the limit of the PATROL Agent receiving the value.

threads_delay setting the number of milliseconds PATROL Configuration Manager waits before starting a new thread after a thread is freed 1000 threads_max setting 20 the maximum number of threads used to perform RuleSet operations like simultaneous apply operations the file that contains the tooltips that are displayed when a user’s mouse is positioned on a rule file that contains custom tooltips that are displayed when a user’s mouse is positioned on a rule Adds to or overrides definitions in the tips_file. search_sleep_delay search_sleep_interval setting 2 seconds how often. together with search_sleep_interval is used to limit CPU usage during long searches.ini File Table 63 Variable PATROL Configuration Manager Configuration Variables (part 7 of 8) Type setting Description Default Value how long. that PATROL Configuration Manager sleeps for search_sleep_delay milliseconds This setting. that 100 milliseconds PATROL Configuration Manager sleeps after searching for search_sleep_interval seconds This setting. in seconds. together with search_sleep_delay is used to limit CPU usage during long searches. in milliseconds.tip tlog_dir tooltips_activate directory setting directory where the change install_dir/rulesets/PCM/tlog history for each agent is stored determines whether PATROL Configuration Manager displays tooltips. install_dir/rules.tip tips_file file tips_file_custom file install_dir/rules_custom.Configuration Settings Changed by Editing the PCM. true indicates that tooltips are displayed false Appendix A Configuration Settings 279 .

Configuration Settings Changed by Editing the PCM.ini File Table 63 Variable PATROL Configuration Manager Configuration Variables (part 8 of 8) Type setting Description Default Value specifies the maximum 5 number of transactions to save in the transaction log directory in which utilities are install_dir/utils installed transactions_saved utils_dir directory 280 PATROL Configuration Manager User Guide .

(Concatenation) Match the special character c. then any one character. For example. \n (new-line character) and \\ (single backslash). Match any character. for example.c matches a. For example. then c. Match the occurrence of regular expression b followed by the occurrence of regular expression c. Note that a\. \b (word boundary). a. ^abc matches abc only if it is at the beginning of a line. $ Match the following characters at the end of a line.c matches a. Appendix B Supported Regular Expressions 281 . then a dot. For example. for example. There are also character class shortcuts. where c is any character that has special meaning. abc$ matches abc only if it is at the end of a line. where b is not a special character. \B (non-word boundary). Table 64 Example b bc \c Supported Regular Expressions (part 1 of 3) Description Match any character b. Table 64 lists the regular expression features that are supported by PATROL Configuration Manager. ^ Match the following characters at the beginning of a line. then c. and \W (non-alpha-numeric). \w (alpha-numeric). .Appendix B B 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.

Ranges are only valid if the LC_COLLATE category is set to the C locale. xx. [0-9a-z].Table 64 Example [s] Supported Regular Expressions (part 2 of 3) Description Match a sequence of characters (must be a non-empty set). and xxxxx r{m. [?. matches any string with either a question mark.3} matches the following strings: a. The maximum number of occurrences is matched. [A-Z]. a{1. The regular expression r{m} matches exactly m occurrences. a dot. Ranges may be specified as m-n. If the LC_COLLATE category is not set to the C locale. as well as aaaa. because it contains one occurrence. [^s] r* Match strings that do not contain the characters in the set. The longest left-most match is returned. and so on. a star. -. (r) Specifies the regular expression r is used for grouping. Consider anchoring the end of the string to limit the upper-bound match count. Without an anchor to the right. ]. 282 PATROL Configuration Manager User Guide . The longest left-most match is returned. a(1. For example. r+ Match one or more successive occurrences of the regular expression r. x? matches x.. or a string containing any combination of the three. Since the regular expression looks for one to three occurrences of a at any point in the string. For example. and [?.n} Match any number of m through n successive occurrences of the regular expression r.*] The last example.} matches at least m occurrences. [a-zA-Z].3}$ or a{1.3}[b-z]. for example. it also matches four occurrences of a. aaaaa. r? Match zero or one occurrence of the regular expression r. this regular expression matches a string containing more than one occurrence. aa. and r{m. For example. aaa. The ( and ) are ignored. The characters ^. Match zero or more successive occurrences of the regular expression r. and [ cannot be included in the set. the effect of using the range notation is unspecified.*].

For example. All character classes specified in the current locale are recognized. (abc)|(xyz) matches any item with abc or xyz. [^[:alnum:]] is not supported. as listed in the LC_CTYPE category in the current locale. The expression is invalid if less than n sub expressions precede the \n. Imbedding a character class into another character class is not supported. Examples I ^(. For example. Character classes A character class expression represents the set of characters belonging to a character class.*)\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 I I I The limit of nine back-references to sub expressions is based on the need to have a single digit identifier. | The regular expression OR operator allows for more than one regular expression to match. The character n must be a digit between 1 to 9 that defines how many previous sub expressions are matched. The following character class expressions are supported: I I I I I I I I I [:alnum:] [:cntrl:] [:lower:] [:space: [:alpha:] [:digit:] [:upper:] [:blank:] [:punct:] Appendix B Supported Regular Expressions 283 . A character class expression is expressed as a character class name enclosed within bracket-colon ([: :]) delimiters. or both.Table 64 Example \n Supported Regular Expressions (part 3 of 3) Description The back-reference expression \n matches the same (possibly empty) string of characters matched by a sub expression enclosed between ( and ) preceding \n.

284 PATROL Configuration Manager User Guide .

. . . . . . . . . . . . . . . . . . . 290 Rule Value Length Too Long . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288 PATROL Configuration Manager Does Not Start on UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291 PATROL Configuration Manager Labels Missing . . . . . . . . . . . . . . . . . . . . . . . . . . . 292 PATROL Configuration Manager Does Not Start on Windows with Abnormal Termination Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289 KM Parameters Are Not in the Object Selection List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Appendix C Troubleshooting and Frequently Asked Questions C This appendix provides common troubleshooting tasks and answers to frequently asked questions (FAQs) for the PATROL Configuration Manager. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286 NT_CPU Polltime Changes Are Not Working . 287 PATROL Configuration Manager Does Not Start on Windows . . . . . . . . . . 294 Frequently Asked Questions . . . . . . The following topics are discovered: Troubleshooting . . . . . 296 What Is the Purpose of the DELVAR Operation?. . . . . . . . . . . . . . . . . . . . . . . 295 How Do I Move PATROL Configuration Manager from UNIX to Windows? . . . . . . . . . 293 Reporting Generates Infinite Loop Error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296 Appendix C Troubleshooting and Frequently Asked Questions 285 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Troubleshooting Troubleshooting The following table lists 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 Page 287 288 289 290 291 292 293 286 PATROL Configuration Manager User Guide .

it is now associated with NT_CPU_CONTAINER. Since PATROL Configuration Manager is retrieving the information from NT_CPU.xx.xx "/AS/EVENTSPRING/PARAM_SETTINGS/POLLTIMES/NT_CPU/__ANYINST__/CPUProcessorColl/in terval" = { REPLACE = "600" }.8. The CPUProcessorColl is no longer associated with NT_CPU.xx and Later "/AS/EVENTSPRING/PARAM_SETTINGS/POLLTIMES/NT_CPU_CONTAINER/NT_CPU_CONTAINER/CPUP rocessorColl/interval" = { REPLACE = "600" }.8. it cannot be added through PATROL Configuration Manager. Solution This problem is related to agents running the NT OS KM. Appendix C Troubleshooting and Frequently Asked Questions 287 . In this version of the NT_OS KM 3.NT_CPU Polltime Changes Are Not Working 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. NT_OS KM Versions 3.8. the entry has to be manually added. One of the following entries is necessary depending on the KM version: NT_OS KM Versions Earlier than 3.

Windows asks for a user name/password before it connects to the remote resource. do one of the following: I Map a shared drive to the location Access that remote machine with a UNC path so Windows prompts for the user name/password and connect. PATROL Configuration Manager accesses the files since Windows previously authenticated the remote computer.PATROL Configuration Manager Does Not Start on Windows 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 PCM. Usually. access is denied by the operating system and PATROL Configuration Manager cannot read the file. when trying to map a shared drive or going directly to the remote computer files with UNC. Instead. To correct this. only there is no way to provide the share user name/password when PATROL Configuration Manager tries to access the resources.bat file you receive the following error: Unable to read file \\<host>\$c\Program Files\BMC Software\pconfmgr\ini\groups. After you connect one time. Accessing files from PATROL Configuration Manager is subject to the same restrictions. I 288 PATROL Configuration Manager User Guide .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.

Appendix C Troubleshooting and Frequently Asked Questions 289 .profile. Set and export the environment variable JAVA_COMPILER=off in the user . Solution Install the required version of Java for your operating system. The directory location of the java executable or Add the directory location of the java executable or link to link is not in the $PATH environment variable. The Java Compiler is running an older version The Java compiler is not required for PATROL of the java compiler.profile of the user account. Configuration Manager. See “System Requirements” on page 18 for Java version requirements for PATROL Configuration Manager. Solutions Explanation Java is not installed on the system.PATROL Configuration Manager Does Not Start on UNIX PATROL Configuration Manager Does Not Start on UNIX Problem There are several reasons why PATROL Configuration Manager does not start on a UNIX platform. the $PATH environment variable set in the .

Solution You can manually edit the files that create the items in the Add Object list. See “Updating the PATROL Object List” on page 251 for more information about adding PATROL objects to the PATROL Configuration Manager object selection dialog boxes. So when you are creating Event Management rules using PATROL Configuration Manager. the Add Object list contains a static list of PATROL objects that created from files installed with PATROL Configuration Manager.KM Parameters Are Not in the Object Selection List KM Parameters Are Not in the Object Selection List Problem PATROL Configuration Manager does not have a dynamic connection to the PATROL Agent. 290 PATROL Configuration Manager User Guide . and you choose the command to add an object.

If the agent configuration variable is for a PATROL Agent earlier than version 3. but you lose all the information that is trimmed.x and earlier do not support more than 1. Appendix C Troubleshooting and Frequently Asked Questions 291 . PATROL Agent 3.5 or later. Figure 70 Rule Value Length Dialog Box Solution PATROL Configuration Manager opens this dialog box when the agent configuration variable contains more than 1. If the agent configuration variable is for a PATROL Agent version 3.020 characters.020 characters for an agent configuration variable.5.Rule Value Length Too Long Rule Value Length Too Long Problem When you create a rule the Rule Value Length dialog box opens as shown in Figure 70.00 and later does not have this limitation on the agent configuration variable. However.00.020 characters. PATROL Agent 3. you have the following options: I click Yes This trims the agent configuration variable to 1.5.4. I click Cancel This cancels the operation and you can edit the rule to fit into the 1.020 length restriction. click No.

slide the very bottom slide all the way to the right. 292 PATROL Configuration Manager User Guide .Modify Color window. 7 Click OK. 8 Click OK on the Style Manager . 4 Choose the black square or the one on the far right. To change the colors of your terminal windows on CDE 1 From the system console. 9 Save your changes and exit CDE. find the Defaults section. Solution You may need to change the color preferences in CDE. choose the Style Manager icon from the CDE Control Bar. 5 Click Modify. The New square in the top-left corner of the window changes to white.Color dialog box. 6 In the Style Manager . 2 Choose the Color Pallet. 3 In the Style Manager .Color dialog box. You see at least four colored squares.PATROL Configuration Manager Labels Missing PATROL Configuration Manager Labels Missing Problem Labels in PATROL Configuration Manager do not show up on UNIX.

exe. Appendix C Troubleshooting and Frequently Asked Questions 293 . If you find a shortcut to a font file in the Fonts folder.. line 256 abnormal program termination Solution This is a generic Java error and not specific to PATROL Configuration Manager. This problem has happened with the following font: johnny-b.PATROL Configuration Manager Does Not Start on Windows with Abnormal Termination Errors PATROL Configuration Manager Does Not Start on Windows with Abnormal Termination Errors Problem When starting PATROL Configuration Manager.ttf To see if this font is present. you must view the fonts from a command prompt. This happens when a bad font is installed in the Windows Fonts directory. If the Fonts folder in Windows is set up incorrectly./src/share/native/sun/awt/font/fontmanager/fontobjects/fontObject. This problem can also be caused by non-font files in the Fonts folder../. and reboot the computer.cpp./.. the following error is returned: PCM. Do this for every shortcut you find in Fonts folder. If the font is present delete it. Shortcuts to font files in other locations cause problems in the Fonts folder. file . it can cause system-wide problems that affect javaw.jar Assertion failed: offset < fFileSize. locate the font file it is pointing to and copy that font to the Fonts folder. The Fonts folder should only contain regular font files. and delete the shortcut.

” in the PATROL Agent Reference Manual. “Managing Performance. PatrolAgent-W-EUSER: PSL script `Linux Command'. you must tune your agent by editing the following agent tuning variables: /AgentSetup/AgentTuning/pslInstructionMax /AgentSetup/AgentTuning/pslInstructionPeriod For information about these variables.Reporting Generates Infinite Loop Error Reporting Generates Infinite Loop Error Problem When generating a report on agents with many instances and parameters. PATROL may experience an error and write the following message to the PATROL system output window. 294 PATROL Configuration Manager User Guide . see Appendix H.executed 7000044 instructions Solution To solve this problem. 'hostname' may be in an infinite loop . 'hostname'.

Frequently Asked Questions 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 296 296 Appendix C Troubleshooting and Frequently Asked Questions 295 .

/ini . ensure there is a backup copy of the agent configuration variable. you want to delete the agent configuration variable called /AgentSetup/testvariable on the PATROL Agent using PATROL Configuration Manager. What Is the Purpose of the DELVAR Operation? The DELVAR operation in PATROL Configuration Manager deletes the agent configuration variable on the PATROL Agent. 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. From PATROL Configuration Manager. For example. 296 PATROL Configuration Manager User Guide ./patrol ./rulesets NOTE Do not copy any binaries or ini files that contain path information because the format is different between Windows and UNIX.How Do I Move PATROL Configuration Manager from UNIX to Windows? 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: I I I . you edit the same agent configuration variable and change the operation to DELVAR and click OK. The DELVAR operation is actually a short cut for deleting the value of the variable and replacing it with a null value.

PATROL offers built-in queries in the Quick Query command on the Tools menu from the PATROL Console main menu bar. depending on the configuration of a console preference. Queries can be saved. No distinctions are made between Microsoft operating systems such as Windows Servers. The console server uses access control lists to restrict access to objects in the COS namespace. and recovery action. agent configuration. and Windows NT. such as disconnecting and reconnecting computers. See also Quick Query. or changed. A 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. Agent Query A PATROL Console feature that constructs SQL-like statements for querying PATROL Agents connected to the console. An alarm state for an object can be indicated by a flashing icon. alert range A range of values that serve as thresholds for a warning state or an alarm state. Glossary 297 . the names of all Microsoft Windows products are referred to as Microsoft Windows or simply Windows. See also warning. 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. added. Windows 2000.A B C D E F G H I J K L M N O P Q R S T U V W X Y Z Glossary Note: In this glossary. reissued. or event manager activities. alert A PATROL object changing status. A PATROL Console can be assigned access rights to perform console. For example. An alert condition is typically caused by a parameter exceeding a threshold. agent namespace See PATROL Agent namespace. See also border action. Agent Query produces a tabular report that contains information about requested objects and can be used to perform object management activities. border range. Ok to Alarm. Alert range values cannot fall outside of set border range values.

application discovery rules. See also application check cycle. 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. and simple discovery. The application class includes rules for discovering processes and files by using simple process and file matching or PSL commands. application discovery. Each time the PATROL Agent process cache is refreshed. also. The associated data is accessed by double-clicking the data point. application account An account that you define at KM setup and that you can change for an application class or instance. PSL discovery can include prediscovery rules as well as discovery rules. which is represented by a user-specified character (the default is an asterisk) in PATROL 3. prediscovery. 298 PATROL Configuration Manager User Guide .x and earlier or by a set bitmap in PATROL Central 7. Attributes assigned to this class will be inherited by all computer classes known to PATROL. See also parameter. annotated data point A specially marked point on a parameter graph that provides detailed information about a parameter at a particular moment. application discovery is triggered. See also application check cycle. The rules describe how a PATROL Agent can detect instances of the application on a computer. An application account is commonly used to connect to an RDBMS on a server where the database resides or to run SQL commands.A B C D E F G H I J K L M N O P Q R S T U V W X Y Z ALL_COMPUTERS class The highest-level computer class in PATROL. the representation of the class as a container (UNIX) or folder (Windows) on the PATROL Console. See also application discovery. application check cycle The interval at which application discovery occurs. which is periodically updated. PSL discovery. prediscovery. Application definition information is checked against the information in the PATROL Agent process cache. PSL discovery. There are two types of application discovery: simple and PSL.x. See also class. application class The object class to which an application instance belongs. PSL discovery. application discovery rules 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. prediscovery. and simple discovery. application discovery rules. PATROL Agent process cache. an icon appears on the PATROL interface. You can use the developer functionality of a PATROL Console to add or change application classes. See also class and computer class. When an instance is discovered. process cache refresh. and simple discovery. application discovery A PATROL Agent procedure carried out at preset intervals on each monitored computer to discover application instances.

The PATROL Agent continues to monitor the application instances by running parameter commands and recovery actions. application state The condition of an application class or an application instance. computer instance. application instance. The command is identified by the naming convention %command_name. after a warning or alarm has occurred a specified number of times. built-in command An internal command available from the PATROL Agent that monitors and manages functions such as resetting the state of an object. border actions can be initiated. menu command. See also global level and local level. refreshing parameters. See also application class and instance.A B C D E F G H I J K L M N O P Q R S T U V W X Y Z application filter A feature used from the PATROL Console to hide all instances of selected application classes for a particular computer. See also border range. 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. Computers and applications can have attributes such as command type. application instance 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 built-in macro variable. Border actions can be initiated immediately when the parameter returns a value outside the border range. parameter. See also border action. PATROL setup command. InfoBox command. however. and echoing text. Glossary 299 . command type. An instance inherits attributes from a class. B border action A command or recovery action associated with a parameter border range and initiated when that range has been breached. and alarm. or parameter) and that you can use to monitor and manage that object. or after all other recovery actions have failed. An application class or instance icon can also show additional conditions. and thresholds. state change action. Parameters can have attributes such as scheduling. an attribute defined at the instance level overrides inherited attributes. application class. An attribute can be defined globally for all instances of a class or locally for a particular computer or application instance. warning. The most common application states are OK. When a border range is breached. See also computer state and parameter state. or environment variable. attribute A characteristic that is assigned to a PATROL object (computer class.

PATROL Agent arguments include names of KMs to load and port numbers for agent-console connection. 300 PATROL Configuration Manager User Guide . See also built-in command. See also consumer parameter. or launch recovery actions. setup commands. The developer functionality of a PATROL Console can be used to add or change command types. a parameter recovery action. a setup command. InfoBox commands. PATROL Console arguments include connection mode (developer or operator). parameter data collection and recovery actions. command type The designation assigned to a command according to its manner of execution. C chart A plot of parameter data values made by the PATROL Console Charting Server. It is commonly used to add or change commands (menu commands. command line argument An option for starting a PATROL Agent or a PATROL Console at the operating system command line. See also multigraph container and PATROL Console Charting Server. This attribute must be defined for a parameter command. the attributes are then inherited by instances of the class.A B C D E F G H I J K L M N O P Q R S T U V W X Y Z built-in macro variable An internal variable created and maintained by PATROL for use in built-in commands and PSL. command text editor The component that provides basic text editing functions for a PATROL Console. computer class. user ID to start the PATROL Console. and state change actions). or a state change action. charting server See PATROL Console Charting Server. See also application class. The naming convention for the variable is %{variable_name}. The PATROL Agent provides two command types: operating system (OS) and PSL. and names of the files to use. command line interface See PATROL Command Line Interface (CLI). collector parameter A type of parameter that contains instructions for gathering values for consumer parameters to display. and event class. names of KMs to load. class The object classification in PATROL where global attributes can be defined. PATROL KMs provide additional command types. an InfoBox command. An instance belongs to a computer class or an application class. A collector parameter does not display any value. a menu command. issue alarms. and standard parameter. parameter.

events. and alarm. an Add Managed System wizard. computer class The basic object class to which computer instances of the same type belong. PATROL Agent See PATROL Agent configuration file. customizations.A B C D E F G H I J K L M N O P Q R S T U V W X Y Z commit The process of saving to PATROL Agent computers the changes that have been made to a KM by using a PATROL Console. The mode can be developer or operator and is a property of the Add Host dialog box (PATROL 3. a PATROL Console with developer functionality can add or change computer classes. Console modules can collect data. The main computer states are OK. subscribe to events. console module A program that extends the functionality of PATROL Central or PATROL Web Central. and RS6000. or other connecting method. warning. HP. authenticate users. computer instance A computer that is running in an environment managed by PATROL and that is represented by an icon on the PATROL interface. PATROL provides computer classes for all supported computers and operating systems. configuration file.x and earlier). Glossary 301 . void because a connection cannot be established. output messages pending. See also state. A PATROL user can disable a PATROL Console’s ability to commit KM changes. KM See KM configuration file. console server A server through which PATROL Central and PATROL Web Central communicate with managed systems. communications. See also PATROL Console. Examples include Solaris. and security. The connection mode is a global (console-wide) property that can be overridden for a computer instance. views. A console server handles requests. access Knowledge Module functions. computer state The condition of a computer. connection mode The mode in which the PATROL Console is connected to the PATROL Agent. A computer instance contains the information and attributes of the computer class that it belongs to. configuration file. and perform security-related functions. and void because a connection was previously established but now is broken. See also instance. OSF1. data. A computer icon can show additional conditions that include no output messages pending.

See also object hierarchy and PATROL Console Charting Server. You can drag and drop an object into and out of a container icon. a file that stores your desktop layout. Once a container is defined. custom view A grid-like view that can be created in PATROL Central or PATROL Web Central to show userselected information. D deactivate a parameter To stop running a parameter for selected computer or application instances. customize a KM To modify properties or attributes locally or globally. parameter. and your PATROL Console user accounts for monitored objects. deactivate an application class To stop monitoring an application class and all of its instances on selected computer instances. applications. However. In PATROL Consoles for Microsoft Windows environments. the KMs that you loaded. See also application filter and deactivate a parameter. it has alarm definitions and can run recovery actions.x. however. the computers that you monitor. 302 PATROL Configuration Manager User Guide . desktop files always have a .A B C D E F G H I J K L M N O P Q R S T U V W X Y Z consumer parameter A type of parameter that displays a value that was gathered by a collector parameter. a container is referred to as a folder. You can create multiple desktop files for any number of PATROL Consoles. objects from one computer cannot be dropped inside another computer. See also global level and local level. A deactivated parameter can be reactivated at any time. A deactivated application class can be reactivated at any time. and parameters—in a distributed environment. By default. In Windows. A consumer parameter never issues commands and is not scheduled for execution. and standard parameter. See also collector parameter. That is. desktop file In PATROL 3.x and earlier. 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. See also desktop template file. a container icon found within a container icon assumes the variable settings of the container in which it is displayed. See also snooze an alarm and suspend a parameter.dt extension. Desktop files are replaced by management profiles in PATROL 7. the object hierarchy applies at each level of the container. customize a parameter See override a parameter. container A custom object that you can create to hold any other objects that you select—such as computers. 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.

distribution CD or tape A CD or tape that contains a copy of one or more BMC Software products and includes software and documentation (user guides and online help systems). disable a KM To temporarily or permanently block an application or KM from loading and to block the PATROL Agent from using that KM. See also PATROL Console. E environment variable A variable used to specify settings. See also KM tree. The default is that no KMs are disabled.km extension. Glossary 303 . application classes. By default. The types of events forwarded by the agent are governed by a persistent filter for each event manager connected to a PATROL Agent. Each PATROL Console user can apply a template to selected computers on the desktop. and delete locally loaded Knowledge Modules and commit these changes to selected PATROL Agent computers. Most KMs are composed of individual application files with a . event The occurrence of a change. Events are captured by the PATROL Agent. but the PATROL Agent stops using the KM to collect parameter data and run recovery actions. the connection of a console to an agent. computer instances. 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. See also desktop file. disable an application. Desktop tree A feature of PATROL for Microsoft Windows only. application class. One of the views of folders available with PATROL for Microsoft Windows environments. the Desktop tree displays the object hierarchy. See also preloaded KM. computer instance. or a state change in a monitored object (computer class.A B C D E F G H I J K L M N O P Q R S T U V W X Y Z desktop template file In PATROL 3. desktop template files always have a . and unload a KM. and parameters. When a KM is disabled (added to the disabled list) in the agent configuration file. You can create multiple desktop template files for any number of PATROL Consoles. such as the program search path for the environment in which PATROL runs. You can set environment variables for computer classes. or parameter). static KM. such as the appearance of a task icon. the launch of a recovery action.x and earlier. a file that stores information about the desktop setup of one computer. and forwarded to an event manager (PEM) if an event manager is connected. discovery See application discovery. application instance. the KM files are not deleted from the PATROL Agent computers. application instances.dtm extension. stored in an event repository file. create.

PATROL provides a Standard Event Catalog that contains predefined Standard Event Classes for all computer classes and application classes. modified. When the maximum number of events is reached and a new event is stored. such as the PEM. You can enter commands at any time from the PATROL Event Manager Details window. A command can be one of three types: escalation. PATROL provides a number of event classes in the Standard Event Catalog. event escalation period A period during which the severity of an event is increased as a result of the event’s persistence. or deleted within an event manager (PEM) by the end of the escalation period. and event notification command. See also event acknowledgment command. See also event class and Standard Event Catalog. You can add. See also parameter history repository. closed. event escalation command A command that is triggered by the PATROL Agent when an event is not acknowledged. event catalog A collection of event classes associated with a particular application. Event classes are stored in event catalogs and can be added. Escalation actions are part of escalation command definitions for event classes and can be triggered only by the PATROL Agent. or deleted only from a PATROL Console in the developer mode. such as worst application and registered application. See also event acknowledgment command. notification. event escalation period. event history repository A circular file where events are stored by the PATROL Agent and accessed by an event manager. event escalation command. The file resides on the PATROL Agent computer and retains a limited number of events. 304 PATROL Configuration Manager User Guide . the oldest event is removed in a cyclical fashion. or acknowledgment. The commands are specified for the event class that the event is associated with. and delete an application event catalog only from a PATROL Console in the developer mode. See also event catalog and Standard Event Catalog. Event Diary The part of an event manager (PEM) where you can store or change comments about any event in the event log. and event notification command.A B C D E F G H I J K L M N O P Q R S T U V W X Y Z event acknowledgment command A command that is triggered by the PATROL Agent when an event is acknowledged in an event manager (PEM). event class A category of events that you can create according to how you want the events to be handled by an event manager and what actions you want to be taken when the event occurs. See also event escalation command. customize. event class command A command that is run by the PATROL Agent when certain events occur and that is used in conjunction with an event manager (PEM). See also event escalation command and event notification command.

application See application filter. persistent See persistent filter. event view filter See view filter. alarm. filter. event-driven scheduling A kind of scheduling that starts a parameter when certain conditions are met. G global channel A single dedicated connection through which PATROL monitors and manages a specific program or operating system. Glossary 305 . See also PATROL Event Manager (PEM). event type The PATROL-provided category for an event according to a filtering mechanism in an event manager. F filter. global level In PATROL hierarchy. The PATROL Agent maintains this connection to minimize the consumption of program or operating system resources. filter. event notification command A command that is triggered by the PATROL Agent when an event is logged into an event manager (PEM). PATROL Consoles in an operator mode view expert advice in the PATROL Event Manager. See also local level. Expert advice is defined in the Event Properties dialog box in a PATROL Console in the developer mode. state change. event view See view filter. See also periodic scheduling. expert advice Comments about or instructions for dealing with PATROL events as reported by the agent.A B C D E F G H I J K L M N O P Q R S T U V W X Y Z event manager A graphical user interface for monitoring and managing events. The event manager can be used with or without the PATROL Console. and response. An object at the local level inherits characteristics (properties) and attributes from the global level. warning. error. Event types include information. See also event acknowledgment command and event escalation command. the level at which object properties and attributes are defined for all instances of an object or class.

history Parameter and event values that are collected and stored on each monitored computer. history span The combined settings for a parameter’s history retention level and history retention period. the number of days that history is stored (retention period) must be set. or an application instance. history repository 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). History retention can be set for all parameters of a computer class. or the PATROL Agent. an application class. See also history retention level and history retention period.” For example. 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. history retention period The number of days that parameter values are stored in the history database before they are automatically purged by PATROL. The size and location of parameter history files are specified through either the PATROL Console or the PATROL Agent. See also history retention period. See also message retries. such as the PEM.A B C D E F G H I J K L M N O P Q R S T U V W X Y Z H heartbeat A periodic message sent between communicating objects to inform each object that the other is still “alive. The period can be inherited from the next higher level in the object hierarchy or set at the local level. history retention level The specified level (global or local) where the parameter history retention period for an object is set. The longer the interval. and reconnect polling. message time-out. If the history retention level is local. Parameter values are stored in binary files for a specified period of time. the lower the network traffic. When the number of storage days is reached. a computer instance. 306 PATROL Configuration Manager User Guide . heartbeat interval The interval (in seconds) at which heartbeat messages are sent. those values are removed in a cyclical fashion. the PATROL Console checks to see whether the PATROL Agent is still running. The period can be specified at the class (global) or instance (local) level. size and location of event history files are specified through an event manager. events are stored in circular log files until the maximum size is reached.

J K KM See Knowledge Module (KM). a parameter is suspended or resumed. KM configuration file A file in which the characteristics of a KM are defined through KM menu commands during KM installation and setup (if setup is required). you must modify the persistent filter setting in the PATROL Agent configuration file. See also Knowledge Module (KM). The default setting for PATROL is to prevent this type of event from being stored in the event repository. application instance. Typical information events occur when a parameter is activated or deactivated. To store and display this type of event. See also Knowledge Module (KM) and PATROL Agent configuration file. such as the version number of an RDBMS and whether the object is online or offline.A B C D E F G H I J K L M N O P Q R S T U V W X Y Z I InfoBox A dialog box that contains a static list of fields and displays current information about an object. Only a PATROL Console in the developer mode can be used to add or change commands. See also application discovery. and computer instance. An application instance is discovered by PATROL. Commands are run when the InfoBox is opened. KM Migrator See PATROL KM Migrator. or application discovery is run. instance A computer or discovered application that is running in an environment managed by PATROL. KM package See Knowledge Module package. KM list A list of KMs used by a PATROL Agent or PATROL Console. A computer instance is a monitored computer that has been added to the PATROL Console. See also Knowledge Module (KM). information event Any event that is not a state change or an error. Glossary 307 . Information can be manually updated if the InfoBox remains open for a period of time. An instance has all the attributes of the class that it belongs to. PATROL provides a number of commands for obtaining and displaying object information in an InfoBox.

PATROL Console. the PATROL Agent loads the KM files that are listed in its configuration file and that reside on the PATROL Agent computer. application classes. KM configuration file.km extension. L load applications Same as load KMs. and for the options available on object pop-up menus. load KMs. The KM tree displays computer classes.) Properties and attributes of a customized instance override those defined for the class to which the instance belongs. When a PATROL Console connects to the PATROL Agent. and commit KM changes to specified PATROL Agent computers. 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. A PATROL Console in operator mode can only view the KM tree. KM Migrator. and PATROL Knowledge Module Deployment Server Manager (PATROL KMDS Manager). After configuration and during startup. 308 PATROL Configuration Manager User Guide . only a PATROL Console in the developer mode can change KM properties and attributes. KMs are loaded by a PATROL Agent and a PATROL Console. See also commit. A KM file can contain the actual instructions for monitoring objects or simply a list of KMs to load. (In PATROL Consoles for Microsoft Windows environments. Knowledge Module (KM) A set of files from which a PATROL Agent receives information about resources running on a monitored computer. See also Knowledge Module (KM). load KMs To place KM files into memory for execution. The package file has a .pkg file extension. Most KMs are composed of application files with a . KM packages are created by using a PATROL Console in the developer mode. See also Knowledge Module (KM) and version arbitration. for parameters that are run under those applications.A B C D E F G H I J K L M N O P Q R S T U V W X Y Z KM tree A feature of PATROL for Microsoft Windows only. KMs provide information for the way monitored computers are represented in the PATROL interface. PATROL Knowledge Module Deployment Server (PATROL KMDS). save knowledge for all of its future sessions. One of two views of folders available in Windows. knowledge hierarchy The rules by which objects inherit or are assigned attributes. classes of objects are represented in the Computer Classes and Application Classes sets of folders on the KM tree. for the discovery of application instances and the way they are represented. A PATROL Console in the developer mode can change KM knowledge for its current session. the KM versions that the agent executes depend on whether the console has developer or operator functionality. and their customized instances in the knowledge hierarchy and also displays the Standard Event Catalog. See also Desktop tree and Knowledge Module (KM). KM list. KM tree.

message time-out A feature of UDP only. management profile A user profile for PATROL Central and PATROL Web Central that is stored by the console server. An object (instance) at the local level inherits properties and attributes that are defined globally. See also global level. your current view of the PATROL environment. M managed object Any object that PATROL manages. master agent See PATROL SNMP Master Agent. heartbeat interval. See also global level and local level. managed system A system—usually a computer on which a PATROL Agent is running—that is added (connected) to a PATROL Console to be monitored and managed by PATROL and that is represented by an icon on the PATROL interface. Management profiles replace desktop files and session files that were used in PATROL 3. information about systems that you are currently managing.A B C D E F G H I J K L M N O P Q R S T U V W X Y Z local history The history (stored parameter values) for an object or instance. When properties and attributes are customized locally for an individual instance. the level of a computer instance or an application instance. The number of message retries multiplied by message time-out is the Glossary 309 . See object. The number of message retries multiplied by message time-out (in seconds) is the approximate time allowed for a connection verification. The number of times that the PATROL Console will resend a message to the PATROL Agent. The greater the number of message retries. local history retention period The length of time set by the user during which stored parameter values for an object or instance are retained. and reconnect polling. the more time the PATROL Console will give the PATROL Agent to respond before deciding that the agent connection is down and timing out. and console layout information for PATROL Central. message time-out. they override inherited attributes. 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.x and earlier. A management profile is similar to a session file and contains information about custom views. Knowledge Module information. See also heartbeat. local level In PATROL hierarchy. message retries A feature of UDP only.

See also object. and shortcuts. system output window. and object window. parameter icons. menu commands. state change actions. setup commands. custom containers (folders). object icon. See also response window. and object icon. computer instance. and pop-up windows. See also class. O object A computer class. The object window is displayed when you double-click the object icon. heartbeat interval. object class A computer class or application class. object. object hierarchy The structure of object levels in PATROL. or container (folder) in an environment managed by PATROL. multigraph container A custom object into which you can drop parameter objects to be plotted as charts. See also heartbeat. See also application instance. object hierarchy.A B C D E F G H I J K L M N O P Q R S T U V W X Y Z approximate time allowed for a connection verification. Objects have properties and are assigned attributes (command types. 310 PATROL Configuration Manager User Guide . InfoBox commands. parameter. and reconnect polling. message retries. On the PATROL interface. object window An open object container (folder) that may contain application class icons. computers contain application folders (containers) representing a loaded KM. See also object class. and object hierarchy. application instance icons. object icon A graphic that represents a computer instance. and task output window. message window A window that displays command output and error messages from the PATROL Console graphical user interface. and environment variables). computer instance. application instance. N notification An action in response to a PATROL event. parameters. and application instances contain parameters. parameter. Parameter objects use data collection commands to obtain values from classes and instances. trouble tickets. application instance. application class. application class. See also PATROL Console Charting Server. or container (folder) in an environment managed by PATROL. and object window. Notifications can include pages. object. application folders contain one or more application instances. object hierarchy. emails.

they periodically use data collection commands to obtain data on a system resource and then parse. In the PATROL Agent's configuration file. and suspended. See history repository. P parameter The monitoring element of PATROL. Parameters can display data in various formats. the suspended state is shown in the label—for Glossary 311 . and alarm. or an SNMP console. such as numeric. and Boolean. the PATROL Agent notifies the PATROL Console and runs any recovery actions associated with the parameter. and store that data on the computer that is running the PATROL Agent. operating system account An account that is set up at installation to grant the PATROL Agent access to a computer. Parameters are run by the PATROL Agent. The PATROL Agent configuration specifies a default operating system account. The most common parameter states are OK. See also PATROL roles.x. process. In PATROL 7. You must be granted specific permissions by a PATROL Administrator through the PATROL User Roles file in order to override parameters. and parameters. parameter history repository Also known as parameter history file. See also PATROL Console. parameter cache The memory location where current parameter data is kept. which can be changed.x and earlier. Override a parameter is replaced by customize a parameter in PATROL 7. override a parameter To disable or change the behavior of a local PATROL application parameter. text. stoplight. Parameter data can be accessed from a PATROL Console. offline. commands. warning. a parameter icon can show additional conditions that include no history. the maximum number of data points that can be stored. See also parameter history repository and parameter state. PATROLVIEW.x. and the interval (in seconds) for emptying the cache. Operating system commands executed by the PATROL Agent and PATROL Console use this account.A B C D E F G H I J K L M N O P Q R S T U V W X Y Z operator mode 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. you can set the size of the cache. parameter override See override a parameter. parameter state The condition of a parameter. Parameters have thresholds and can trigger warnings and alarms. The changes to the parameter are local to the managed system running the parameter and are stored in the agent configuration database. If the value returned by the parameter triggers a warning or an alarm. In PATROL 3.

and SNMP consoles. PATROL Agent The core component of PATROL architecture. The agent process cache is updated periodically. and how events trigger SNMP traps. a stand-alone event manager (PEM). PATROL provides default variable values that can be customized. PATROLVIEW. when a parameter is deactivated. eliminating the need to develop code to collect this data. MyParam (suspended)—rather than in the icon. PATROL Agent namespace A memory array that contains an internal representation of the PATROL object hierarchy. PATROL Agent configuration file A file in which you can define the characteristics of the PATROL Agent by setting PATROL Agent configuration variables. See also KM configuration file. the PATROL Agent is configured by the pconfig utility. See also state.A B C D E F G H I J K L M N O P Q R S T U V W X Y Z example. or the xpconfig utility. PATROL Agent process cache refresh A periodic process of the PATROL Agent that issues a platform-dependent system query to obtain a list of the active processes. 312 PATROL Configuration Manager User Guide . This data is used to update the PATROL Agent process cache. The agent is used to monitor and manage host computers and can communicate with the PATROL Console. Configuration variables determine such characteristics as how errors are handled. wpconfig. A parameter can also be deactivated. pconfig. which KMs are loaded and how. See also PATROL SNMP Master Agent. Values in the agent namespace are available to PSL scripts. it is configured by the xpconfig utility for UNIX or the wpconfig utility for Windows. how SNMP support is configured. The graphical user interface used to install and run the PATROL Agent. PATROL Agent process cache A snapshot of the operating system process table on a monitored computer. such as application discovery and parameter execution. no icon is displayed. PATROL Agent Manager A feature of PATROL for Microsoft Windows only. PATROL Agent run queue A time-ordered schedule of actions. PATROL Agent configuration variable. and xpconfig. PATROL Agent configuration variable The means by which the characteristics of a PATROL Agent are defined. See also PSL run queue. You can edit the configuration file by using the pconfig utility. from a graphical user interface. to be carried out by the PATROL Agent. the wpconfig utility. From the command line. See also PATROL Agent configuration file.

execute PSL functions. PATROL Event Manager (PEM) 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. and area plots. It also interacts with the PATROL Agent and runs commands and tasks on each monitored computer. customize. 3-D bar charts. Charts and graphs are created by dragging and dropping various parameters into a multigraph container (folder) and plotting the results into a chart. The PATROL Console displays all of the monitored computer instances and application instances as icons. including line graphs. Charts can be viewed through the PATROL Console and printed to a local printer or PostScript file. See also event manager. or delete event classes and commands in the Standard Event Catalog. PATROL Console Charting Server A PATROL function that creates charts and graphs of actual values returned by more than one parameter. See also developer mode and operator mode. 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. The PATROL EM consolidates alerts from different vendors and different geographical locations into a single display for fast identification and resolution of potential problems. and parameters and can view expert advice but not customize or create KMs. A PATROL Console with developer functionality can monitor and manage computer instances. It works with the PATROL Agent and user-specified filters to provide a customized view of events.A B C D E F G H I J K L M N O P Q R S T U V W X Y Z PATROL 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. you can monitor the state of PATROL Agents remotely. and parameters. PATROL History Loader KM 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. application instances. Glossary 313 . application instances. and delete locally loaded Knowledge Modules and commit these changes to selected PATROL Agent computers. and define expert advice. and query and control events. Parameter data is plotted either in real time or from history sets and can be presented in a number of chart styles. and parameters. add. PATROL Console The graphical user interface from which you launch commands and manage the environment monitored by PATROL. modify. PATROL Enterprise Manager (PATROL EM) An event management system that gathers. translates. A PATROL Console with operator functionality can monitor and manage computer instances. create. With the CLI. and prioritizes messages from the managed systems in an enterprise and displays them as alerts in a single console. pie charts. The CLI is used in place of the PATROL Console when memory and performance constraints exist. commands. filters. You can access the PEM from the PATROL Console or use it as a stand-alone facility.

PATROL SNMP Master Agent The agent through which a PATROL Agent interacts with an SNMP agent and SNMP manager. commands. When a user tries to start a PATROL Console with developer functionality. If the user is not in the group. a PATROL Console with operator functionality is started instead. recovery actions. PSL is used for writing application discovery procedures. PATROL KMDS Manager See PATROL Knowledge Module Deployment Server Manager (PATROL KMDS Manager). The PATROL Master Agent configuration file contains the community name and port number for all agents in such a multiple-agent architecture. parameters. PATROL KM Migrator A PATROL utility used to propagate KM user customizations to newly released versions of PATROL Knowledge Modules.A B C D E F G H I J K L M N O P Q R S T U V W X Y Z PATROLVIEW Formerly PATROLVIEW or PATROLINK.x and earlier. See also ptrldev. patroldev In PATROL 3.x and earlier. 314 PATROL Configuration Manager User Guide . a set of permissions that grant or remove the ability of a PATROL Console or PATROL Agent to perform certain functions. PATROL KMDS See PATROL Knowledge Module Deployment Server (PATROL KMDS). and tasks for monitored computers within the PATROL environment. A repository for storage of PATROL KMs and changes to those KMs. 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. PATROL checks whether the user is in the patroldev group. PATROL Script Language (PSL) 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. PATROL roles are defined in the PATROL User Roles file. PATROL Knowledge Module Deployment Server (PATROL KMDS) The change and version control tool for KMs. PATROL roles In PATROL 3. which is read when the console starts. a domain group that can be set up by a Windows system administrator to restrict user access to a PATROL Developer Console. PATROL Knowledge Module Deployment Server Manager (PATROL KMDS Manager) The graphical interface for the PATROL KMDS that can be used to manage and deploy or distribute KM changes in the production environment.

PSL See PATROL Script Language (PSL). disable a KM and static KM. the PATROL Agent runs the discovery script. PEM See PATROL Event Manager (PEM). and xpconfig. the menu is accessed by right-clicking the object. 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). See also disable an application. property A characteristic or attribute of an object. Prediscovery helps reduce PATROL Agent processing requirements. PSL Compiler A PATROL utility that compiles PSL scripts into a binary byte code that can be executed by the PSL virtual machine. See also event-driven scheduling. periodic scheduling A kind of scheduling that starts a parameter at a certain time and reruns the parameter at certain intervals. such as its icon. process cache refresh See PATROL Agent process cache refresh. The PSL Compiler can also be used to check a PSL script for syntax errors. See also PATROL Agent configuration file. preloaded KM A KM that is loaded by the PATROL Agent at startup and run as long as the agent runs. wpconfig. polling cycle The schedule on which a parameter starts running and the intervals at which it reruns. PATROL Agent configuration variable. pop-up menu The menu of commands for a monitored object. the cycle is expressed in seconds. See also event-driven scheduling and periodic scheduling. If the results are affirmative. persistent filter A filter maintained by the PATROL Agent for each PATROL Console or event manager that connects to it. Glossary 315 .A B C D E F G H I J K L M N O P Q R S T U V W X Y Z pconfig The command line utility for setting PATROL Agent configuration variables. prediscovery 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.

See also patroldev. and parameters that are in a warning or alarm state.x and earlier.x and earlier) and can also be run as a command-line utility. application instances. Q Quick Query In PATROL 3. ptrldev In PATROL 3.A B C D E F G H I J K L M N O P Q R S T U V W X Y Z The compiler is embedded in the PATROL Agent and PATROL Console (PATROL 3. See also Agent Query. 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. recovery action A procedure that attempts to fix a problem that caused a warning or alarm condition. PSL discovery A type of application discovery in which the discovery rules are defined by using PSL. When the PSL Profiler is enabled. 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. you can query the agent regularly about all computer instances. PSL Debugger A PATROL Console utility that is used to debug PSL scripts. PSL run queue A queue of the currently executing PSL processes. heartbeat interval. message time-out. The PSL debugger is accessed through a computer's pop-up menu. message retries. 316 PATROL Configuration Manager User Guide . The PSL run queue is used to distribute processing time between PSL processes in a round-robin fashion. The longer the interval. R reconnect polling The time interval (in seconds) at which the PATROL Console will try to reconnect to a PATROL Agent that has dropped the previous connection. a form of patroldev that can be used in environments that support domain names no larger than eight characters. the lower the network traffic. the PATROL Agent starts accumulating and recording profile statistics.x and earlier. PSL discovery can consist of prediscovery and discovery PSL scripts. For example. See also heartbeat. PSL Profiler A PATROL utility that is used to tune the CPU usage and minimize child processes or file operations of a newly created KM.

session file In PATROL 3. PATROL provides some setup commands for computer classes. Only a PATROL Console with developer functionality can add or change setup commands. the sort method for outputting system process IDs).x. and the session-1. a setup command can initialize an application log file to prepare it for monitoring. Self-polling avoids the overhead of frequently starting external processes to collect a monitored value. rule An individual configuration item or variable. A session file includes the session-1.x and earlier. any of the files that are saved when changes are made and saved during the current PATROL Console session. Refreshing does not reset the polling cycle but gathers a new data point between polling cycles. 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. which contains user preferences. For example. Session files are replaced by management profiles in PATROL 7. run queue See PATROL Agent run queue. RuleSet A collection of rules or configuration items. reporting filter 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.x.prefs file. Refresh parameter is also called “update” in PATROL 7. Glossary 317 . which contains changes to KMs loaded on your console.km file. 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. regardless of their polling cycle. S self-polling parameter A standard parameter that starts a process that runs indefinitely. See also system output window and task output window. A self-polling parameter differs from most other parameters that run scripts for a short time and then terminate until the next poll time. response window An input and output display for many KM menu commands that provides a customizable layout of the information (for example.A B C D E F G H I J K L M N O P Q R S T U V W X Y Z refresh parameter An action that forces the PATROL Agent to run one or more parameters immediately.

During the user-set snooze period. Standard Event Catalog A PATROL-provided collection of predefined event classes for all computer classes and application classes. The most common states are OK. all events can be translated to SNMP traps and forwarded to SNMP managers. state The condition of an object (computer instance. SNMP trap A condition which. See also event catalog and event class. 318 PATROL Configuration Manager User Guide . See also deactivate a parameter and suspend a parameter. you must use a PATROL Console with developer functionality. See also application state. modify. Object icons can show additional conditions. consumer parameter. parameter state. and state change action. results in an SNMP agent issuing a trap message to other SNMP agents and clients. and parameter. and alarm. standard parameter A type of parameter that collects and displays data and can also execute commands. or parameter) monitored by PATROL. the parameter continues to run commands and recovery actions. A standard parameter is like a collector parameter and consumer parameter combined. computer state. when satisfied. snooze an alarm To temporarily suspend an alarm so that a parameter does not exhibit an alarm state. or delete event classes and commands in the Standard Event Catalog. and the parameter icon appears to be in an OK state. To add. See also collector parameter.A B C D E F G H I J K L M N O P Q R S T U V W X Y Z shortcut An alias or copy of an object icon in the PATROL hierarchy. Simple Network Management Protocol (SNMP) A communications protocol that is supported by the PATROL Agent. startup command See setup command. SNMP allows network management systems to access PATROL Agents and allows PATROL Agents to monitor and manage SNMP devices. Within the PATROL Agent. simple discovery A type of application discovery that uses simple pattern matching for identifying and monitoring files and processes. application instance. SNMP See Simple Network Management Protocol (SNMP). warning.

a task icon is displayed for each running task. the instance icon displays a yellow triangle for Windows. stoplight A parameter output style that displays OK. not the computer on which the agent is running. Once loaded by the agent. executes on the computer on which the console is running. yellow. See also state Boolean. T task A command or group of commands that can execute on one object or several objects simultaneously. on a traffic light. When the system output window contains unread messages in PATROL 3. suspend a parameter To stop running a parameter for selected computers or application instances. a static KM is never unloaded but continues to run as long as the agent runs. respectively. Parameters with this output style can have alerts (warning and alarm) and recovery actions. You can suspend a parameter from its pop-up menu. static KM 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. Parameters with this output style can have alerts (warning and alarm) and recovery actions. it displays a blue screen with white text. Glossary 319 . A task runs in the background and is not part of the PATROL Agent run queue. The action. for UNIX. and initiated by the PATROL Console when the console is notified by the PATROL Agent that a monitored object has changed state. Numeric data output for the monitored object can be displayed as a graph. even if all PATROL Consoles with a registered interest disconnect from the PATROL Agent. The window also displays error messages. Numeric data output for the monitored object can be displayed as a graph. If the PATROL Agent stops. static KMs will not be reloaded. See also stoplight. and alarm states as green. and so forth. A suspended parameter can be resumed at any time.x and earlier. See also deactivate a parameter and snooze an alarm. See also disable an application. and red lights. maintained.A B C D E F G H I J K L M N O P Q R S T U V W X Y Z state Boolean 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. state change action An action that is stored. 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. commit status messages. warning. system output window A message window that displays the output of commands and tasks that the PATROL Console or the PATROL Agent execute on an instance. or command. disable a KM and preloaded KM.

and static KM. user preferences The PATROL Console settings that designate the account that you want to use to connect to monitored host computers.x and earlier. To prevent the PATROL Agent computer from collecting parameter data and running recovery actions for a KM. By default. and reapplied to host computers. collect parameter data. Views can be created. then it will not be unloaded. a connectionless network protocol that allows the PATROL Console to connect to many agents simultaneously. KM versions from PATROL Consoles with developer functionality are loaded rather than PATROL Agent KM versions. and the PATROL Agent will continue to run the KM.A B C D E F G H I J K L M N O P Q R S T U V W X Y Z task output window A window that contains command output generated by a task (for example.x and earlier. TCP requires an open file for each connection. The KM files are not deleted from the directories on the PATROL Console or the PATROL Agent computers. A PATROL Console with either developer or operator functionality can change user preferences. a KM menu command or a parameter warning or alarm). specify the event cache size. threshold A point or points that define a range of values. and indicate whether startup and shutdown commands are enabled. and the number of files that a process can have open is generally limited. which usually appears in the PATROL interface or main window but may appear in an appropriate object window. U unload a KM To delete a KM from a PATROL Console session in order to stop monitoring the KM-defined objects on all computers. and PATROL Agent KM versions are loaded rather than KM versions from PATROL Consoles with operator functionality. If a KM has been flagged as static. determine certain window and icon display characteristics. and run recovery actions until no connected console has the KM loaded. disable a KM. User Datagram Protocol (UDP) In PATROL 3. disable the KM. outside of which a parameter is considered to be in a warning or alarm range. disable the commit process for a console with developer functionality. prevent a console with developer functionality from downloading its version of a KM to a PATROL Agent upon connection. the KM version comparison that PATROL makes when a PATROL Console connects to a PATROL Agent. 320 PATROL Configuration Manager User Guide . preloaded KM. See also disable an application. While executing. stored. V version arbitration In PATROL 3. each task has its own icon. view filter A filter that can be created in an event manager (PEM) and that screens events forwarded from PATROL Agents.

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z W warning An indication that a parameter has returned a value that falls within the warning range. See also PATROL Agent configuration file and PATROL Agent configuration variable. The graphical user interface utility for setting PATROL Agent configuration variables. The graphical user interface utility for setting PATROL Agent configuration variables. See also alarm. 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. 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. X xpconfig A feature of PATROL for UNIX only. See also PATROL Agent configuration file and PATROL Agent configuration variable. wpconfig A feature of PATROL for Microsoft Windows only. Y Z Glossary 321 .

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 322 PATROL Configuration Manager User Guide .

definition 17 delete 82 discovery method 76 discovery results 76 discovery type 76 find within configuration manager 84 finding LinkedRuleSets assigned to 98 locating backup configuration 98 locking 96 organize into groups 81 purge configuration 88 reinitialize 86 reload configuration 87 restart 86 restore configuration 147 restore configuration to default values 88 search for within configuration manager 84 setting default values 73 stop 85 update PATROL license 93 agent configurations compare 123 agent repository 19 agent_default_seclevel 273 agents add multiple using PATROL ping 78 add multiple using RT Server 76 alarm range 1 define 179 threshold 171 turn off 255 alarm range 2 171 define 179 turn off 255 alarm state 171 Alarm1 and Alarm2 alert ranges 171 alert 201 manage 201 resend 203 set up notification for 201 settings 195 suppress false alerts at restart 205 Alert Messages variables 227 alert settings 189 requirement of PATROL KM for Event Management 19 alertSystem 222 application class monitor 209 application class name 229 application instance name 230 apply RuleSet after all other RuleSets 155 RuleSet to new agents 152 ApplyOnApply 148 activate 155 order of operation 115 scope 149 storage 149 ApplyOnNew 148 activate 151. 152 deactivate 151 precedence 149 scope 149 storage 149 applyonnew_active 273 arsAction 210 323 .A B C D E F G H I J K L M N O P Q R S T U V W X Y Z Symbols /AgentSetup/pconfigRequiresAuthentication 59 /AS/EVENTSPRING/PARAM_SETTINGS/STATUSFLA GS/paramSettingsStatusFlag 190 A activating autosave for agent and group data 61 statically linked RuleSets 151 active 242 add agent 74 multiple agents using PATROL ping 78 multiple agents using RT Server 76 PATROL object 196 adding agent 74 missing Rule Alias 167 agent add 74 autosaving data 61 backup configuration 145 change default account 89 configuration.

default 17 B Backup 141 backup configuration of agent 145 configuration settings 52 initialization (. contacting 2 border range define 179 threshold 171 C change PATROL default account 89 ChangeSpring.ini) file 33 backup agent configurations 20 backup configuration locating for agent 98 backup files location of 40 backup RuleSet definition 40 format 40 naming convention 40 backup ruleset path 40 324 PATROL Configuration Manager User Guide .A B C D E F G H I J K L M N O P Q R S T U V W X Y Z AS_CHANGESPRING 211 convert parameter overrides to RuleSets 254 create default RuleSet 251 create RuleSet from CSV file 253 features 242 get all parameters 247 get global parameters 249 get global poll times 250 get localized parameters 247 limitation 242 load 243 requirements 242 RuleSet location 246 RuleSet naming convention 246 turn off alarm range 255 AS_CHANGESPRING KM 185. 274 autosave activating 61 autosave_enabled 274 autosaved_enabled 95 backup_before_apply 274 backup_dir 40. 275 communicate 278 compare agent configurations 123 RuleSet 123 RuleSets 123 components PATROL Configuration Manager 19 config.ini 272 colors changing in GUI 63 commands Custom Identifiers 207 Recovery Action Command 213 Recovery Action Command Type 211 Send Reset On Init 205 comment file definition 44 format 44 naming convention 44 path 44 comment files location of 44 comments_dir 44. 242 AS_CHANGESPRING.km 243 assign custom identifier to PATROL objects 207 RuleSets to agents 122 authenticate_agent_configuration 273 authenticate_agent_configuration_check 274 authentication 70 dependencies 72 generating report 71 report 102 retrieving objects from agents 71 setting default 59 success or failure 59 usage 71 using secure pconfig 71 authentication credentials 91 authreq 92.ini files 60 backups_saved 275 batch program 222 bin_dir 275 blackout difference from override 191 notification 233 blackout period 235 blackouts 189 BMC Software. 274 backup_folder_groups 274 backup_folder_min 274 backup_identical_configurations 275 backups number of .

251 Create Ruleset for config.bat 257 csmi. 230 customer support 3 customizing GUI 64 D database PATROL Configuration 16 date of alert 230 deactivating statically linked RuleSets 151 debuglevel 275 debugloglevel 275 debugwindow 275 default initialization (. 114 statically linked RuleSet 17 transaction log 38 delete agent 82 group 83 rule 133 RuleSet 121 designate RuleSet to update automatically 156 325 .ini) file 33 define border and alarm ranges 179 poll time 180 recovery action command 213 recovery action type 211 report 104 defining Rule Alias 164 definition 170 backup RuleSet 40 comment file 44 configuration 17.csh 257 custom identifier 208. 253 csmi 242. definition 17 configuration file create new 34 import PATROL Console 256 open 34 configuration settings backup 52 GUI 62 transaction 54 virtual backup folder 55 configuration values 272 configuration variable backup_dir 40 comments_dir 44 definition 17 errorfile 48 images_dir 43 ini_dir 36 local_dir 49 logfile 47 paramSettingStatusFlag 190 queue_dir 42 ruleset_dir 37 tlog_dir 39 configurations compare 123 convert parameter override to RuleSet 254 PATROL Console Desktop settings to ini files 257 Convert Overrides to EVS 245. 114 Rule Alias 114 RuleSet 16.A B C D E F G H I J K L M N O P Q R S T U V W X Y Z configuration backup 145 default 17 definition 17. 114 get 142 get with defaults 142 locating backup for agent 98 order of operation 115 PATROL database 16 purge 146 restore 147 share among users 66 variable. 254 copy rule 128 RuleSet 117 RuleSet folder 117 CPU usage 280 create default RuleSet 251 group 81 local RuleSet 139 rule 126 RuleSet 118 RuleSet folder 118 RuleSet from CSV file 253 RuleSet from existing RuleSet 119 Create a RuleSet 248 Create a Ruleset with all parameters 247 Create files for patrol_dir 245. 256 csmi. 114 configuration variable 17 error files 48 image files 43 localization file 49 log files 46 queue file 42 rule 16.default 245 Create Ruleset from CSV File 245.

open 34 default configuration 17 error 48 image 43 initialization See configuration file localization 49 log 46 queue 42 report. storage 48 image.A B C D E F G H I J K L M N O P Q R S T U V W X Y Z desktop files 256 disable notification 231 discover agents using PATROL ping 78 agents using RT Server 76 discover agents results 76 discovery 210 discovery method for agents 76 PATROL ping 76 RT server 76 discovery_burst_delay 275 discovery_max_burst_packets 275 discovery_tcp_ignore_connect_timeout 275 documentation PATROL Security User Guide 91 duplicate rule 128 F failover 66 file comment 44 configuration. storage 42 RuleSet. storage 49 log. storage 36 localized RuleSet. 276 ess_bin_dir 276 ess_jar_path 276 establish threshold 174 event catalog 231 event class 231 event ID 230 event id 231 Event Management 189 Event Management rules 131 event severity 231 event status 231 event type 231 evs_menu 276 G garbage_collect_after_pconfig 276 generate report 104 326 PATROL Configuration Manager User Guide . storage 38 find agent within configuration manager 84 agents using PATROL ping 78 agents using RT Server 76 rule in PATROL Configuration Manager 133 firewall 278 fonts changing in GUI 63 format backup RuleSet 40 comment file 44 error file 48 image files 43 localization file 49 log file 46 queue file 42 report 101 transaction log 38 variable name 127 full discovery 210 E edit rule 129 RuleSet 121. storage 46 number of . storage 44 error. save to 108 files backup. storage 43 initialization.ini backups 60 queue. storage 37 transaction. new 34 configuration. 140 e-mail 222 enable recovery action 210 error file format 48 naming convention 48 path 48 error files definition 48 location of 48 error messages 276 errorfile 48. storage 40 comment.

276 import PATROL Console configuration file 256 RuleSet into PATROL Configuration Manager 186 InfoBoxes 244 ini file backup 33 default 33 ini files convert PATROL Console Desktop settings to 257 ini_dir 36. 22 initialization file See configuration file initialization files location of 36 number of backups 60 install_dir 276 instance icon name 230 J job status diagnostics 29 viewer 28 job status information dialog box 28 log file 29 K keep_report_data 276 km plug-in 20 KM Commands 244 knowledge module AS_CHANGESPRING 242 migration 246 plug-in 20 H help_dir 276 hostname 229 L LinkedRuleSet precedence 149 scope 149 LinkedRuleSets 148 activate 151 assign 156 deactivate 151 finding associations with agents 161 storage 149 listening port 229 Load 243 load AS_CHANGESPRING 243 local 140 local notification 226 local_dir 49. 276 GUI changing colors/fonts 63 configuration settings 62 controls 22 PATROL Configuration Manager 19.A B C D E F G H I J K L M N O P Q R S T U V W X Y Z get all parameters 247 configuration 142 configuration with defaults 142 global parameters 249 global poll times 250 localized parameters 247 Get Global Parameters 245. default 58 localized RuleSet files location of 49 I image files definition 43 format 43 location of 43 naming convention 43 path 43 images_dir 43. 82 organize agents 81 properties 82 groups.ini 36. 250 Get Localized Parameters 245 graphical user interface PATROL Configuration Manager 22 group autosaving data 61 create 81 delete 83 locking 96 naming convention 81. 276 localization file definition 49 format 49 naming convention 49 path 49 localized rules reporting. 249 Get Global Polltimes 245. 276 init 206 initialization file backup 33 default 33 327 .

assign custom identifiers to 207 PATROL. types of 223 targets 217 test 236 test limitations 237 type 219 notification type 20. add 196 PATROL.A B C D E F G H I J K L M N O P Q R S T U V W X Y Z locate agent within configuration manager 84 agents using PATROL ping 78 agents using RT Server 76 rule in PATROL Configuration Manager 133 location of RuleSets created by AS_CHANGESPRING 246 lock RuleSet 122 lock_check_timer 276 locking agent and groups 96 locking_max_retries 277 locking_retry_wait 277 locks status of 97 types of 96 log transaction 38 log file format 46 naming convention 46 path 46 viewing from job status 29 log files definition 46 location of 46 logfile 47. 82 image files 43 localization file 49 log file 46 pconfig variable 127 queue file 42 RuleSets created by AS_CHANGESPRING 246 transaction log 38 new configuration file 34 new rule 126 notification blackout 233 command 219 disable 231 message length limitations 227 message variables 229 message. 277 knowledge module 246 monitor application class 209 move RuleSet 117 RuleSet folder 117 N naming convention backup RuleSet 40 comment file 44 error file 48 for a RuleSet created by AS_CHANGESPRING 246 group 81. 92 managed systems 19 max_agents_per_report_thread 277 max_config_file_lines 277 max_folder_length 277 max_ini_backups 277 max_path_length 277 maximum folders 55 memory allocation change on UNIX 102 change on Windows 103 memory usage report 102 message custom and dynamic 227 length limitations 227 reword notification 226 variables 229 message rewording 189 message_max_lines 277 message_truncate_lines 277 migration O object 20 PATROL. 219 M manage alert 201 notifications from 222 Secure KeyStore password 91. remove 198 update list of PATROL 251 update PATROL 191 objects PATROL 191 328 PATROL Configuration Manager User Guide . custom and dynamic 227 message. reword 226 prerequisites 190 rules stored as pconfig variables 189 set up for alerts 201 set up order 193 stop for a specific period 233 system 222 system.

216 PATROL object list. update list of 191 objects 191 objects. 22 GUI controls 22 import RuleSet into 186 329 . assign customer identifiers to 207 PATROL Configuration Database 16 PATROL Configuration Manager components 19 customizing GUI 64 graphical user interface 19. 220 purge agent configuration 88 automated task 141 configuration 146 P parameter get all 247 get global 249 get global poll times 250 get localized 247 poll time 173 retrieve settings and save as RuleSets 184 threshold 170 parameter alert ranges alarm1 171 alarm2 171 border 171 parameter name 230 parameter settings requirement of PATROL KM for Event Management 19 parameter settings stored as 184 parameter status 230 parameter timestamps 230 parameter value 230 parameter values 230 paramSettingStatusFlag configuration variable 190 parent instance name 230 password remove from Secure KeyStore 93 store in Secure KeyStore 92 password management secure keystore 91 path 214.A B C D E F G H I J K L M N O P Q R S T U V W X Y Z open configuration file 34 operations 127 order of operation ApplyOnApply 115 configuration 115 rule 115 RuleSet 115 originating event 231 override difference from blackout 191 PATROL Configuration Manager initialization file 277 PATROL default account change 89 PATROL Documentation PATROL Security User Guide 91 PATROL KM for Event Management 19 requirement 19 PATROL license update 93 PATROL objects 278 PATROL ping discovery method 76 patrol_dir 278 pconfig 16 pconfig_debug_mode 278 pconfig_local_port 278 pconfig_use_strict 278 permissions report 103 pexec_args 278 pexec_debug_mode 278 pexec_timeout 278 pexec_trace_mode 279 plug-ins knowledge module 20 poll time 173 get global 250 set 180 polling time 203 precedence ApplyOnNew 149 LinkedRuleSets 149 rule or km value 190 predefined Rule Aliases 164 pre-discovery 210 prerequisites notification 190 print report 104 product support 3 properties group 82 PSL 213. update 251 object.

20 330 PATROL Configuration Manager User Guide . stored as pconfig variables 189 order of operation 115 precedence over KM values 190 protect using local RuleSets 137 search for in PATROL Configuration Manager 134 Rule Alias add missing 167 defining 164 definition 114 missing 166 predefined 164 storage 164 view missing 166 rules 131 rules and RuleSets 20 rules repository 19. group PATROL object 198 report authentication 102 define 104 format 101 generate 104 limitations 101 memory usage 102 permissions 103 printing 104 save to file 108 source of information 100 view online 107 report_local_overwrite 279 reporting localized rules setting default 58 reports_dir 279 requirement PATROL KM for Event Management 19 requirements AS_CHANGESPRING 242 resend 203.A B C D E F G H I J K L M N O P Q R S T U V W X Y Z Q queue file definition 42 format 42 naming convention 42 path 42 queue files location of 42 queue_dir 42. agent group See delete. 205 alert 203 restart agent 86 restore configuration 147 retrieve parameter settings to save as RuleSets 184 reword 229 notification message 226 RT server discovery method 76 locator string 77 rt_servers 279 rule benefits 115 copy 128 create 126 definition 16. 279 R recover action define command 213 recovery action 216 define type 211 enable 210 scope of command and types 211 recovery actions 203 register agent 74 multiple agents using PATROL ping 78 multiple agents using RT Server 76 reinitialize agent 86 reload agent configuration 87 remote notification 226 remove agent See delete. 114 delete 133 duplicate 128 edit 129 locate in PATROL Configuration Manager 133 notification.

customer 3 suppress false alerts at restart 205 S save parameter settings as RuleSet 185 report to file 108 scope ApplyOnApply 149 ApplyOnNew 149 LinkedRuleSets 149 recovery action commands and types 211 T targets 219 notification 217 331 . 92 security 70 security level default 70 dependencies 71 storage 70 security levels 70 set notification 201 poll time 180 precedence for rule or km value 190 setting defaults agent 73 setting number of backup . 279 ruleset_max_search_results 279 ruleset_search_items_file 279 RuleSets compare 123 local 137 location created by AS_CHANGESPRING 246 naming convention created by AS_CHANGESPRING 246 save Backup before applying 52 ruleval_max_length 279 script 221 search rule in PATROL Configuration Manager 133 search for agents using PATROL ping 78 agents using RT Server 76 search_sleep_delay 280 search_sleep_interval 280 seclevel 70 Secure KeyStore 91 password 91.A B C D E F G H I J K L M N O P Q R S T U V W X Y Z RuleSet 184 apply after all other RuleSets 155 apply to new agents 152 assign to agents 122 backup 40 benefits 115 compare 123 convert parameter overrides to 254 copy 117 create 118 create default 251 create from CSV file 253 create from existing RuleSet 119 create local 139 definition 16. 276. 92 statically linked rule sets rule sets statically linked 114 status 203 stop agent 85 notification 233 storage ApplyOnApply 149 ApplyOnNew 149 LinkedRuleSets 149 Rule Alias 164 support.ini files 60 settings alert 195 share configuration of PATROL Configuration Manager 66 RuleSet 122 shell script 222 simulate 237 single thread 278 specifying individual agent 74 sslcmd 91. 114 delete 121 edit 121 edit local 140 import into PATROL Configuration Manager 186 local. characteristics 137 lock 122 move 117 naming convention of AS_CHANGESPRING 246 order of operation 115 protect rule using local 137 save parameter settings as 185 share 122 update automatically 156 RuleSet files location of 37 RuleSet folder copy 117 create 118 move 117 ruleset_dir 37.

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
task automated purge 141 technical support 3 test notification 236 threads_delay 280 threads_max 280 threshold 170, 171 alarm range 1 171 alarm range 2 171 border range 171 definition 170 establish 174 time of alert 230 time zone 230 tips_file 280 tips_file_custom 280 tlog_dir 39, 280 tooltips_activate 280 transaction configuration settings 54 transaction files location of 38 transaction history 20 transaction log definition 38 format 38 naming convention 38 path 38 transactions_saved 281 turn off alarm range 255 Turn Off Alarm Ranges 245, 255 variables 127, 229 Alert Messages 227 version 231 view online report 107 viewing log file from job status 29 virtual backup folder configuration settings 55

W
warning state 171 What If 189 whatif.cfg 236

U
update PATROL license 93 PATROL object list 191, 251 user credentials 91 user interface 19 username remove from Secure KeyStore 93 store in Secure KeyStore 92 utility security 91, 92 utils_dir 281

V
values 127 variable configuration, definition 17 name format 127 paramSettingStatusFlag 190

332

PATROL Configuration Manager User Guide

Third-Party Product Terms
The following terms apply to third-party products that are included with or in a BMC Software product as described in the BMC Software, Inc., License Agreement that is applicable to the product.

The Apache Software License, Version 1.1
This product includes the Apache software product found at (http://www.apache.org/), and the Apache software product is distributed to us pursuant to the following terms and conditions: Copyright (c) 1999 – 2003 The Apache Software Foundation. All rights reserved. 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. The end-user documentation included with the redistribution if any, must include the following acknowledgement: "This product includes software developed by the Apache Software Foundation (http://www.apache.org/)." Alternately, this acknowlegement may appear in the software itself, if and wherever such third-party acknowlegements normally appear. 4. The names "Xerces", and "Apache Software Foundation" must not be used to endorse or promote products derived from this software without prior written permission. For written permission, please contact apache@apache.org. 5. Products derived from this software may not be called "Apache", nor may "Apache" appear in their name without prior written permission of the Apache Group. THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Apache Software License, Version 2.0
This product includes the Apache software product found at http:/ / apache.org , and the Apache software product is distributed to us pursuant to the following terms and conditions: Copyright (c) 2000-2004 The Apache Software Foundation. All rights reserved. TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, nonexclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer

the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.

The Artistic License
Preamble
The intent of this document is to state the conditions under which a Package may be copied, such that the Copyright Holder maintains some semblance of artistic control over the development of the package, while giving the users of the package the right to use and distribute the Package in a more-or-less customary fashion, plus the right to make reasonable modifications.

Definitions
"Package" refers to the collection of files distributed by the Copyright Holder, and derivatives of that collection of files created through textual modification. "Standard Version" refers to such a Package if it has not been modified, or has been modified in accordance with the wishes of the Copyright Holder as specified below. "Copyright Holder" is whoever is named in the copyright or copyrights for the package. "You" is you, if you're thinking about copying or distributing this Package. "Reasonable copying fee" is whatever you can justify on the basis of media cost, duplication charges, time of people involved, and so on. (You will not be required to justify it to the Copyright Holder, but only to the computing community at large as a market that must bear the fee.) "Freely Available" means that no fee is charged for the item itself, though there may be fees involved in handling the item. It also means that recipients of the item may redistribute it under the same conditions they received it. 1. You may make and give away verbatim copies of the source form of the Standard Version of this Package without restriction, provided that you duplicate all of the original copyright notices and associated disclaimers. 2. You may apply bug fixes, portability fixes and other modifications derived from the Public Domain or from the Copyright Holder. A Package modified in such a way shall still be considered the Standard Version. 3. You may otherwise modify your copy of this Package in any way, provided that you insert a prominent notice in each changed file stating how and when you changed that file, and provided that you do at least ONE of the following:

a. place your modifications in the Public Domain or otherwise make them Freely Available, such as by posting said modifications to Usenet or an equivalent medium, or placing the modifications on a major archive site such as uunet.uu.net, or by allowing the Copyright Holder to include your modifications in the Standard Version of the Package. b. use the modified Package only within your corporation or organization. c. rename any non-standard executables so the names do not conflict with standard executables, which must also be provided, and provide a separate manual page for each non-standard executable that clearly documents how it differs from the Standard Version. d. make other distribution arrangements with the Copyright Holder. 4. You may distribute the programs of this Package in object code or executable form, provided that you do at least ONE of the following: a. distribute a Standard Version of the executables and library files, together with instructions (in the manual page or equivalent) on where to get the Standard Version. b. accompany the distribution with the machine-readable source of the Package with your modifications. c. give non-standard executables non-standard names, and clearly document the differences in manual pages (or equivalent), together with instructions on where to get the Standard Version. d. make other distribution arrangements with the Copyright Holder. 5. You may charge a reasonable copying fee for any distribution of this Package. You may charge any fee you choose for support of this Package. You may not charge a fee for this Package itself. However, you may distribute this Package in aggregate with other (possibly commercial) programs as part of a larger (possibly commercial) software distribution provided that you do not advertise this Package as a product of your own. You may embed this Package's interpreter within an executable of yours (by linking); this shall be construed as a mere form of aggregation, provided that the complete Standard Version of the interpreter is so embedded. 6. The scripts and library files supplied as input to or produced as output from the programs of this Package do not automatically fall under the copyright of this Package, but belong to whomever generated them, and may be sold commercially, and may be aggregated with this Package. If such scripts or library files are aggregated with this Package via the so-called "undump" or "unexec" methods of producing a binary executable image, then distribution of such an image shall neither be construed as a distribution of this Package nor shall it fall under the restrictions of Paragraphs 3 and 4, provided that you do not represent such an executable image as a Standard Version of this Package. 7. C subroutines (or comparably compiled subroutines in other languages) supplied by you and linked into this Package in order to emulate subroutines and variables of the language defined by this Package shall not be considered part of this Package, but are the equivalent of input as in Paragraph 6, provided these subroutines do not change the language in any way that would cause it to fail the regression tests for the language. 8. Aggregation of this Package with a commercial distribution is always permitted provided that the use of this Package is embedded; that is, when no overt attempt is made to make this Package's interfaces visible to the end user of the commercial distribution. Such use shall not be construed as a distribution of this Package. 9. The name of the Copyright Holder may not be used to endorse or promote products derived from this software without specific prior written permission. 10. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.

Bzip2 License
Copyright (C) 1996-2002 Julian R Seward. All rights reserved. 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required. 3. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software. 4. The name of the author may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Sun Microsystems, Inc. Binary Code License Agreement
1. LICENSE TO USE. Sun grants you a non-exclusive and non-transferable license for the internal use only of the accompanying software and documentation and any error corrections provided by Sun (collectively "Software"), by the number of users and the class of computer hardware for which the corresponding fee has been paid. 2. RESTRICTIONS. Software is confidential and copyrighted. Title to Software and all associated intellectual property rights is retained by Sun and/or its licensors. Except as specifically authorized in any Supplemental License Terms, you may not make copies of Software, other than a single copy of Software for archival purposes. Unless enforcement is prohibited by applicable law, you may not modify, decompile, or reverse engineer Software. Licensee acknowledges that Licensed Software is not designed or intended for use in the design, construction, operation or maintenance of any nuclear facility. Sun Microsystems, Inc. disclaims any express or implied warranty of fitness for such uses. No right, title or interest in or to any trademark, service mark, logo or trade name of Sun or its licensors is granted under this Agreement. 3. LIMITED WARRANTY. Sun warrants to you that for a period of ninety (90) days from the date of purchase, as evidenced by a copy of the receipt, the media on which Software is furnished (if any) will be free of defects in materials and workmanship under normal use. Except for the foregoing, Software is provided "AS IS". Your exclusive remedy and Sun's entire liability under this limited warranty will be at Sun's option to replace Software media or refund the fee paid for Software. 4. DISCLAIMER OF WARRANTY. UNLESS SPECIFIED IN THIS AGREEMENT, ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT THESE DISCLAIMERS ARE HELD TO BE LEGALLY INVALID. 5. LIMITATION OF LIABILITY. TO THE EXTENT NOT PROHIBITED BY LAW, IN NO EVENT WILL SUN OR ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR SPECIAL, INDIRECT, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER CAUSED REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF OR RELATED TO THE USE OF OR INABILITY TO USE SOFTWARE, EVEN IF SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. In no event will Sun's liability to you, whether in contract, tort (including negligence), or otherwise, exceed the amount paid by you for Software under this Agreement. The foregoing limitations will apply even if the above stated warranty fails of its essential purpose. 6. Termination. This Agreement is effective until terminated. You may terminate this Agreement at any time by destroying all copies of Software. This Agreement will terminate immediately without notice from Sun if you fail to comply with any provision of this Agreement. Upon Termination, you must destroy all copies of Software. 7. Export Regulations. All Software and technical data delivered under this Agreement are subject to US export control laws and may be subject to export or import regulations in other countries. You agree to comply strictly with all such laws and regulations and acknowledge that you have the responsibility to obtain such licenses to export, re-export, or import as may be required after delivery to you. 8. U.S. Government Restricted Rights. If Software is being acquired by or on behalf of the U.S. Government or by a U.S. Government prime contractor or subcontractor (at any tier), then the Government's rights in Software and accompanying documentation will be only as set forth in this Agreement; this is in accordance with 48 CFR 227.7201 through 227.7202-4 (for Department of Defense (DOD) acquisitions) and with 48 CFR 2.101 and 12.212 (for non-DOD acquisitions). 9. Governing Law. Any action related to this Agreement will be governed by California law and controlling U.S. federal law. No choice of law rules of any jurisdiction will apply. 10. Severability. If any provision of this Agreement is held to be unenforceable, this Agreement will remain in effect with the provision omitted, unless omission would frustrate the intent of the parties, in which case this Agreement will immediately terminate. 11. Integration. This Agreement is the entire agreement between you and Sun relating to its subject matter. It supersedes all prior or contemporaneous oral or written communications, proposals, representations and warranties and prevails over any conflicting or additional terms of any quote, order, acknowledgment, or other communication between the parties relating to its subject matter during the term of this Agreement. No modification of this Agreement will be binding, unless in writing and signed by an authorized representative of each party. JAVA(TM) INTERFACE CLASSES JAVA API FOR XML-BASED RPC API CLASS FILES, VERSION 1.1 SUPPLEMENTAL LICENSE TERMS These supplemental license terms ("Supplemental Terms") add to or modify the terms of the Binary Code License Agreement (collectively, the "Agreement"). Capitalized terms not defined in these Supplemental Terms shall have the same meanings ascribed to them in the Agreement. These Supplemental Terms shall supersede any inconsistent or conflicting terms in the Agreement, or in any license contained within the Software. 1. Software Internal Use and Development License Grant. Subject to the terms and conditions of this Agreement, including, but not limited to Section 3 (Java(TM) Technology Restrictions) of these Supplemental Terms, Sun grants you a non-exclusive, non-transferable, limited license to reproduce internally and use internally the binary form of the Software, complete and unmodified, for the sole purpose of designing, developing and testing your Java applets and applications ("Programs"). 2. License to Distribute Software. In addition to the license granted in Section 1 (Software Internal Use and Development License Grant) of these Supplemental Terms, subject to the terms and conditions of this Agreement, including but not limited to Section 3 (Java Technology Restrictions), Sun grants you a non-exclusive, non-transferable, limited license to reproduce and distribute the Software in binary form only, provided that you (i) distribute the Software complete and unmodified and only bundled as part of your Programs, (ii) do not distribute additional software intended to replace any component(s) of the Software, (iii) do not remove or alter any proprietary legends or notices contained in the Software, (iv) only distribute the Software subject to a license agreement that protects Sun's interests consistent with the terms contained in this Agreement, and (v) agree to defend and indemnify Sun and its licensors from and against any damages, costs, liabilities, settlement amounts and/or expenses 3. Java Technology Restrictions. You may not modify the Java Platform Interface ("JPI", identified as classes contained within the "java" package or any subpackages of the "java" package), by creating additional classes within the JPI or otherwise causing the addition to or modification of the classes in the JPI. In the event that you create an additional class and associated API(s) which (i) extends the functionality of the Java Platform, and (ii) is exposed to third party software developers for the purpose of developing additional software which invokes such additional API, you must promptly publish broadly an accurate specification for such API for free use by all developers. You may not create, or authorize your licensees to create additional classes, interfaces, or subpackages that are in any way identified as "java", "javax", "sun" or similar convention as specified by Sun in any naming convention designation. 4. Trademarks and Logos. You acknowledge and agree as between you and Sun that Sun owns the SUN, SOLARIS, JAVA, JINI, FORTE, and iPLANET trademarks and all SUN, SOLARIS, JAVA, JINI, FORTE, and iPLANET-related trademarks, service marks, logos and other brand designations ("Sun Marks"), and you agree to comply with the Sun Trademark and Logo Usage Requirements currently located at http://www.sun.com/policies/trademarks. Any use you make of the Sun Marks inures to Sun's benefit. 5. Source Code. Software may contain source code that is provided solely for reference purposes pursuant to the terms of this Agreement. Source code may not be redistributed unless expressly provided for in this Agreement.

6. Termination for Infringement. Either party may terminate this Agreement immediately should any Software become, or in either party's opinion be likely to become, the subject of a claim of infringement of any intellectual property right. For inquiries please contact: Sun Microsystems, Inc. 4150 Network Circle, Santa Clara, California 95054 (LFI# 136499/Form ID# 011801)

Notes

*65068* *65068* *65068* *65068* *65068* .

Sign up to vote on this title
UsefulNot useful