Preview only show first 10 pages with watermark. For full document please download

Emc Networker Km 2.5.00 User Guide

   EMBED


Share

Transcript

PATROL® Knowledge Module® for Legato NetWorker by OTL Software ® User Guide Version 2.4 Document Revision 2 May 20, 2010 Copyright © 2010 OTL Software Limited, 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. Legato NetWorker is a registered trademark of LEGATO Software, a division of EMC Corporation. All other third party logos and product/trade names are registered trademarks or trademarks of their respective companies. THE USE AND CONTENTS OF THIS DOCUMENTATION ARE GOVERNED BY THE SOFTWARE LICENSE AGREEMENT FOUND AT http://www.otl.co.nz/km/OTL_KM_Software_Licence_Agreement.pdf. Restricted Rights Legend Use, duplication, or disclosure by the U.S. Government is subject to restrictions set forth in FAR Section 52.227-14 Alt. III (g)(3), FAR Section 52.227-19, DFARS 252.227-7014 (b), or DFARS 227.7202, as amended from time to time. Send any contract notices to OTL Software Limited. Contacting OTL Software Postal Address OTL Software Limited P O Box 68300 Newton Auckland 1145 New Zealand Telephone +64 9 373 9920 Web Site Address http://www.otl.co.nz Fax +64 9 303 9129 E-mail [email protected] Help Desk +64 9 303 9120 E-mail (Help Desk) [email protected] Customer Support You can obtain technical support by using the Support page on the OTL Software web site or by contacting Customer Support by telephone or e-mail. To expedite your inquiry, please see “Before Contacting OTL Software,” below. Support Web Site You can obtain technical support from OTL Software 24 hours a day, seven days a week by accessing the technical support web site at http://www.otl.co.nz/support. From this site, you can: • • • read overview about support services and programs that OTL Software offers log a support call online check OTL Software contact information, including e-mail addresses, fax numbers, and telephone numbers To ensure you have the latest version of the KM, visit the web site at http://www.otl.co.nz/km/latest_versions.asp. Support via Telephone or E-mail If you need technical support, you can contact OTL Software by calling +64 9 303 9120 or by faxing +64 9 303 9129. You can also contact the OTL Software Helpdesk via e-mail at [email protected]. For other contact methods, please refer to the OTL Software Web site at http://www.otl.co.nz/support. Before Contacting OTL Software Before you contact OTL Software, please have the following information available so that a technical support analyst can begin working on your problem immediately: • KM product information: — product name — product version — license serial number • monitored application information: — Legato NetWorker type — Legato NetWorker version — Legato NetWorker server type (Server / Storage Node) • operating system information: — machine type — operating system type, version, and service pack or patch details — system hardware configuration • PATROL information: — PATROL Agent version — PATROL Console version and platform details • sequence of events leading to the problem • commands and options needed to reproduce the problem • messages received: — product error messages — messages from monitored application — messages in PATROL Console system output window (SOW) OTL Software’s Legato NetWorker KM for PATROL - User Guide iii iv OTL Software’s Legato NetWorker KM for PATROL - User Guide Contents Contents Chapter 1 Product Components and Capabilities Overview of NSR KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2 Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2 Objectives of the KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3 Product Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7 Application Classes and Icons . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7 Hierarchical Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-10 Accessing KM Commands and InfoBoxes . . . . . . . . . . . . . . . . . 1-12 Accessing Online Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-13 Printing Online Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-14 Impact on Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-15 CPU and Memory Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-15 Network Traffic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-15 Where to Go from Here . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-16 Chapter 2 Preparing to Install Installation Checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2 System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3 Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4 Changes to BMC PATROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6 Additional Software Requirements . . . . . . . . . . . . . . . . . . . . . . . 2-7 Security Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-8 Disk Space Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-13 Where to Go from Here . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-14 Chapter 3 Installation Installation Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2 Installation Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3 OTL Software Ltd., Confidential and Proprietary Information Contents v Installing the KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-5 Where to Go from Here . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-14 Chapter 4 Loading and Configuring Loading the KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-2 Preparing to Load the KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-2 Loading the KM on PATROL Console . . . . . . . . . . . . . . . . . . . .4-2 Loading the KM on PATROL Central . . . . . . . . . . . . . . . . . . . . .4-4 Loading the KM on BMC Portal . . . . . . . . . . . . . . . . . . . . . . . . .4-6 Licensing the KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-7 Configuring the KM User Account . . . . . . . . . . . . . . . . . . . . . . .4-9 Verifying Application Discovery . . . . . . . . . . . . . . . . . . . . . . . . .4-10 Checking the Instance Limits . . . . . . . . . . . . . . . . . . . . . . . . . . .4-12 Checking the Initial Setup of the KM . . . . . . . . . . . . . . . . . . . . .4-13 Configuring PATROL Agent to Preload the KM . . . . . . . . . . . .4-15 Restarting PATROL Agent and PATROL Console . . . . . . . . . . .4-15 Unloading the KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-16 Unloading the KM from the PATROL Agent . . . . . . . . . . . . . . .4-16 Unloading the KM from PATROL Console . . . . . . . . . . . . . . . .4-17 Unloading the KM from PATROL Central Console . . . . . . . . . .4-18 Where to Go from Here . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-18 Chapter 5 Working with the KM Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-2 Customizing the KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-3 Managed Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-4 Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-7 Daemons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-11 Index Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-15 Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-17 Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-23 Save Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-30 Pending Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-37 Jukeboxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-42 Standalone Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-51 Volume Pools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-56 Working with Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-71 Refreshing Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-71 Displaying Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-73 Customizing Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-73 OTL Software Ltd., Confidential and Proprietary Information vi OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Upgrading the Platform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-73 Getting Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-74 Debugging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-74 KM Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-74 Technical Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-74 Where to Go from Here . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-75 Appendix A KM Commands KM Command Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-3 Appendix B InfoBoxes Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B-2 InfoBox Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B-3 Appendix C Parameter Definitions and Defaults Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .C-1 Column Heading Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . .C-2 Abbreviations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .C-3 Appendix D Troubleshooting Glossary Index OTL Software Ltd., Confidential and Proprietary Information Contents vii OTL Software Ltd., Confidential and Proprietary Information viii OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Figures Figures Figure 1-1 Figure 3-1 Figure 4-1 Figure 4-2 Figure 4-3 Figure 4-4 Figure 4-5 Figure 4-6 Figure 4-7 Figure 4-8 Figure 5-1 Figure 5-2 Figure 5-3 Figure 5-4 Figure 5-5 Figure 5-6 Figure 5-7 Figure 5-8 Figure 5-9 Figure 5-10 Figure 5-11 Figure 5-12 Figure 5-13 Figure 5-14 Figure 5-15 Figure 5-16 Figure 5-17 Application Class Hierarchy of NSR KM . . . . . . . . . . . . . . . . . 1-10 Installation Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2 NSR KM Setup Instance & Menus on PATROL Console . . . . . 4-3 NSR KM Setup Instance and Menus on PATROL Central Console 4-5 License Configuration dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8 Remote Authentication Configuration dialog . . . . . . . . . . . . . . . 4-8 Login Configuration dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9 NSR KM Console View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-11 NSR KM Default Instance Limits . . . . . . . . . . . . . . . . . . . . . . . . 4-12 NSR KM Preloading dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15 Failover Mode Configuration dialog . . . . . . . . . . . . . . . . . . . . . 5-4 Node Status Configuration dialog . . . . . . . . . . . . . . . . . . . . . . . . 5-5 Client Configuration dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7 Client Status Configuration dialog . . . . . . . . . . . . . . . . . . . . . . . 5-9 Daemon Configuration dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-11 Daemon Status Configuration dialog . . . . . . . . . . . . . . . . . . . . . 5-13 Database Configuration dialog . . . . . . . . . . . . . . . . . . . . . . . . . . 5-15 Log Configuration dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-17 Log Filter Configuration dialog . . . . . . . . . . . . . . . . . . . . . . . . . 5-19 Log Alert Acknowledgement Configuration dialog . . . . . . . . . . 5-22 Group Configuration dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-23 Group Backup Restriction Window dialog . . . . . . . . . . . . . . . . . 5-24 Group Status Configuration dialog . . . . . . . . . . . . . . . . . . . . . . . 5-26 Group Client Configuration dialog . . . . . . . . . . . . . . . . . . . . . . . 5-28 Save Group Filter Configuration dialog . . . . . . . . . . . . . . . . . . . 5-30 Save Group Status Configuration dialog . . . . . . . . . . . . . . . . . . 5-32 Save Group Date/Time Format Configuration dialog . . . . . . . . . 5-34 OTL Software Ltd., Confidential and Proprietary Information Figures ix Figure 5-18 Figure 5-19 Figure 5-20 Figure 5-21 Figure 5-22 Figure 5-23 Figure 5-24 Figure 5-25 Figure 5-26 Figure 5-27 Figure 5-28 Figure 5-29 Figure 5-30 Figure 5-31 Figure 5-32 SaveSet Error Event Contents Configuration dialog . . . . . . . . . .5-36 Pending Request Filter Configuration dialog . . . . . . . . . . . . . . .5-37 Pending Request Status Configuration dialog . . . . . . . . . . . . . . .5-38 Pending Request Date/Time Format Configuration dialog . . . . .5-40 Jukebox Configuration dialog . . . . . . . . . . . . . . . . . . . . . . . . . . .5-42 Jukebox Status Configuration dialog . . . . . . . . . . . . . . . . . . . . . .5-44 Jukebox Device Configuration dialog . . . . . . . . . . . . . . . . . . . . .5-46 Jukebox Device Status Configuration dialog . . . . . . . . . . . . . . .5-48 Standalone Device Configuration dialog . . . . . . . . . . . . . . . . . . .5-51 Standalone Device Status Configuration dialog . . . . . . . . . . . . .5-53 Volume Pool Configuration dialog . . . . . . . . . . . . . . . . . . . . . . .5-56 Server/Storage Node Administration sub-menu . . . . . . . . . . . . .5-59 Log Alert Acknowledgement sub-menu . . . . . . . . . . . . . . . . . . .5-60 Standalone Device Administration sub-menu . . . . . . . . . . . . . . .5-62 NSR KM Debug Configuration dialog . . . . . . . . . . . . . . . . . . . .5-65 OTL Software Ltd., Confidential and Proprietary Information x OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Tables Tables Table 1-1 Table 1-2 Table 1-3 Table 2-1 Table 2-2 Table 2-3 Table 2-4 Table 2-5 Table 2-6 Table 3-1 Table 3-2 Table 3-3 Table 3-4 Table 3-5 Table 3-6 Table 3-7 Table 5-1 Application class icons and functions . . . . . . . . . . . . . . . . . . . . 1-7 Accessing KM Commands and InfoBoxes for NSR KM . . . . . . 1-12 Accessing Online Help for NSR KM. . . . . . . . . . . . . . . . . . . . . . 1-13 Installation checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2 Supported Operating Systems . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3 Required Software for NSR KM . . . . . . . . . . . . . . . . . . . . . . . . 2-4 Additional Software Requirements for NSR KM . . . . . . . . . . . . 2-7 Executable and Library File Paths Accessed by NSR KM User . 2-9 Paths and Files Accessed by PATROL Agent User . . . . . . . . . . . 2-10 Contents of the Distribution File . . . . . . . . . . . . . . . . . . . . . . . . 3-5 Unix Platform Installation Files and Extraction Paths. . . . . . . . 3-7 MS Windows Platform Installation Files and Extraction Paths. 3-8 Uninstallation from the PATROL Agent . . . . . . . . . . . . . . . . . . 3-10 Uninstallation from PATROL Console . . . . . . . . . . . . . . . . . . . 3-11 Uninstallation from the PATROL Central Console Server . . . . . 3-12 Uninstallation from the PATROL Central Web Server . . . . . . . . 3-13 NSR KM Object Debug Switch Association . . . . . . . . . . . . . . . 5-66 OTL Software Ltd., Confidential and Proprietary Information Tables xi OTL Software Ltd., Confidential and Proprietary Information xii OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide About... About this Guide This guide contains detailed information about the functionality of applications, commands, and parameters provided by OTL Software’s Legato NetWorker® Knowledge Module® for PATROL®. It also contains instructions for loading and configuration. This guide is intended for backup administrators, system administrators, operators and anyone who monitors backup systems. Use this guide with the appropriate PATROL user guide for your console, which describes how to use PATROL to perform typical tasks. Note This guide assumes that you are familiar with your host operating system and Legato NetWorker. You should know how to perform a basic set of actions in a window environment, such as choosing menu commands and dragging and dropping icons. Note For simplicity throughout this guide, this Knowledge Module (KM) is often referred to as NSR KM and Legato NetWorker may be referred to as NetWorker. OTL Software Ltd., Confidential and Proprietary Information About this Guide xiii How This Guide Is Organized This manual is organized as follows: Chapter Title Purpose 1 “Product Components and Capabilities” Provides an overview of the features and components of the KM 2 “Preparing to Install” Provides pre-installation instructions and system requirements 3 “Installation” Provides step-by-step instructions for installing, upgrading and uninstalling the KM 4 “Loading and Configuring” Provides instructions for loading and configuring the KM 5 “Working with the KM” Describes and explains tasks performed when using the KM Appendix A “KM Commands” Describes and explains all KM commands Appendix B “InfoBoxes” Describes and explains all KM infoBoxes Appendix C “Parameter Definitions and Defaults” Describes and explains all KM parameters Appendix D “Troubleshooting” Provides troubleshooting tips Glossary “Glossary” Explains all glossary terms used in this guide Index “Index” Lists index entries OTL Software Ltd., Confidential and Proprietary Information xiv OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Related Documentation Online Help You can access Online Help for OTL Software’s Legato NetWorker KM for PATROL through the PATROL Console Help menu. Release Notes Version-specific Release Notes for OTL Software’s Legato NetWorker KM for PATROL accompanies the product as a PDF document. It provides up-to-date information including: • • • • new features and changes included in this version updates to the installation instructions last-minute product information any known issues and “workarounds” for this version PATROL® Product Documentation PATROL product documentation is available in both hardcopy and online publications. The PATROL Product and Documentation CD contains all PATROL manuals and guides. For a complete list, refer to the contents of the CD. Below is a list of PATROL manuals and guides related to the NSR KM. • • • • • • • • • • PATROL for Unix Getting Started PATROL Console for Unix User Guide PATROL for Microsoft Windows Servers Getting Started PATROL Console for Microsoft Windows User Guide (Volumes 1, 2 & 3) PATROL Central Operator - Microsoft Windows Edition Getting Started PATROL Central Operator - Web Edition Getting Started PATROL Console Server and RTserver Getting Started PATROL Infrastructure Planning Guide PATROL Installation Reference Manual PATROL Installation Workflows OTL Software Ltd., Confidential and Proprietary Information About this Guide xv Each PATROL Console and each KM come with an extensive online help facility that is available through the PATROL Console Help menu option. The online documentation contains reference information about PATROL Console features and options and about KM parameters. Conventions This guide includes special elements called notes, warnings, examples, and tips: Note Notes provide additional information about the current subject. Warning Warnings alert you to situations that can cause problems, such as the loss of data, if you do not follow the instructions carefully. Example An example clarifies a concept discussed in text. Tip A tip provides useful information that may improve product performance or make procedures easier to follow. Other conventions used in this guide are detailed below: • File names, directories and paths appear in this boldface type. • In instructions, this boldface type highlights commands to be entered or options to be selected. • The name of an icon (or an instance) appears in this typeface. OTL Software Ltd., Confidential and Proprietary Information xvi OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide • All syntax and operating system terms appear in this typeface, usually on a separate line • Text or characters to be entered by the user appear in quotes in “this typeface”. For example: Type “[default]” means that the user must also type the square brackets, but not the quotation marks. • Third party utilities appear in this typeface, such as xpconfig. The symbol => connects items in a menu sequence. For example, Actions => Create Test instructs you to choose the Create Test command from the Actions menu. » This symbol denotes a one-step instruction. In syntax, path names, or system messages, italic text represents a variable, as shown in the following examples: The table is not available. The data is held in system/instance/file_name. In syntax, the following additional conventions apply: • A vertical bar ( | ) separating items indicates that you must choose one item. In the following example, you would choose a, b, or c: a|b|c • An ellipsis ( . . . ) indicates that you can repeat the preceding item or items as many times as necessary. • Square brackets ( [ ] ) around an item indicate that the item is optional. OTL Software Ltd., Confidential and Proprietary Information About this Guide xvii The following table shows equivalent mouse buttons for Unix users and Microsoft Windows users: Unix Button MS Windows Button MB1 left mouse button Click this button on an icon or menu command to select that icon or command. Click MB1 on a command button to initiate action. Double-click an icon to open its container. MB2 not applicable Click this button on an icon to display the InfoBox for the icon Description Note: To simulate MB2 on a two-button mouse, simultaneously press the two buttons (MB1 and MB3). MB3 right mouse button Click this button on an icon to display its pop-up menu. Note This guide contains detailed procedures for using OTL Software’s Legato NetWorker KM for PATROL with PATROL Console for Unix and PATROL Console for MS Windows. When instructions for the two consoles differ, this is indicated by headings such as “On PATROL Console for Unix” or “On PATROL Console for MS Windows”. OTL Software Ltd., Confidential and Proprietary Information xviii OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide 1 Product Components and Capabilities 1 This chapter provides a brief overview of OTL Software’s Legato NetWorker® Knowledge Module® for PATROL®. It covers the following topics: Overview of NSR KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2 Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2 Product Architecture. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7 Application Classes and Icons . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7 Hierarchical Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-10 KM Commands, InfoBoxes and Help . . . . . . . . . . . . . . . . . . . . . . . . 1-12 Accessing KM Commands and InfoBoxes . . . . . . . . . . . . . . . . . 1-12 Accessing Online Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-13 Printing Online Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-14 Impact on Resources. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-15 CPU and Memory Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-15 Network Traffic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-15 Where to Go from Here . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-16 OTL Software Ltd., Confidential and Proprietary Information Product Components and Capabilities 1-1 Overview of NSR KM A Knowledge Module is a set of files that contain knowledge in the form of command descriptions, application, parameters, and recovery actions that PATROL® can use to monitor an application such as Legato NetWorker®. The parameters in OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® allow you to analyse Legato NetWorker application activity quickly and easily. It collects all data associated with Legato NetWorker activity over time. You can clearly identify peaks, troughs and trends in the performance of backup resources. Legato NetWorker KM for PATROL (or NSR KM) helps you ensure that your Legato NetWorker installations run efficiently 24 hours a day by enabling you to detect problems, optimize systems, analyse trends, plan capacity and manage multiple hosts simultaneously. Features Key features of OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® include: • Centralized monitoring of all storage nodes and clients through the server • Monitoring the health of the Legato NetWorker application and its daemons • Monitoring index database space utilization • Monitoring successful backups of index database • Monitoring log files and scanning for any alerts • Monitoring successful backups of every backup group and group client • Monitoring backup save groups and alerting to any failures OTL Software Ltd., Confidential and Proprietary Information 1-2 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide • Checking for any media pending request on all servers/storage nodes • Monitoring the status and throughput of every backup device • Monitoring the size, duration, and performance of each backup save group • Monitoring the number of volume in each volume pool, their space utilization, and current volume status Objectives of the KM The aim of the Legato NetWorker KM for PATROL is to ensure the availability, maximum performance, and integrity of your backup servers, thereby protecting associated data sets. This section summarizes how the NSR KM is designed to achieve these goals within each area of the Legato NetWorker application. For information on how the default configuration of the NSR KM can be customised to better suit your environment, refer to “Customizing the KM” on page 5-3. Otherwise the KM will run as a standard installation as described below. Note The NSR KM defines certain parameters to trigger alerts in suspicious or critical circumstances, while others simply gather information for display. Any of the display parameters with a graphical output may also be configured to trigger alerts. Information on modifying parameters can be found in PATROL documentation. Also refer to “Appendix C: Parameter Definitions and Defaults”. Monitoring the Legato NetWorker Server/Storage Node Legato NetWorker KM for PATROL monitors Legato NetWorker servers and storage nodes. The following items are checked regularly and alerts are triggered in suspicious or critical circumstances: • • the working status of the server/storage node KM login and licensing details for the server/storage node OTL Software Ltd., Confidential and Proprietary Information Product Components and Capabilities 1-3 Other server/storage node information is available through the infobox. Monitoring Legato NetWorker Clients Legato NetWorker KM for PATROL monitors all remote clients configured on the server/storage node. The working status of each client is checked regularly and alerts are triggered in suspicious or critical circumstances. Other client information is available through the infobox and display parameters. Monitoring Server/Storage Node Daemons Legato NetWorker KM for PATROL monitors the “NetWorker Server Daemon” or “NetWorker Storage Node Daemon” as appropriate for the managed node. The working status of the daemon is checked regularly and an alert is triggered in suspicious or critical circumstances. CPU and memory usage data is gathered and may be monitored to trigger alerts if required. Other daemon information is available through the infobox. Monitoring Index Databases Legato NetWorker KM for PATROL monitors the Legato NetWorker index databases. Space utilization of each database is checked regularly and alerts are triggered in suspicious or critical circumstances. Other database information, including statistics of the last successful backup, is available through the infoboxes and/or display parameters. Monitoring Log Files Legato NetWorker KM for PATROL detects all standard Legato NetWorker log files, which can be enabled for monitoring. The following items are checked regularly and alerts are triggered in suspicious or critical circumstances: • • errors in the monitored log files space utilization of any monitored log file and its file system Details of logged messages are available in text parameters, and other log information is available through infoboxes and/or display parameters. OTL Software Ltd., Confidential and Proprietary Information 1-4 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Monitoring Groups and Group Clients Legato NetWorker KM for PATROL monitors all backup groups and their group clients. The working status of each group is checked regularly and an alert is triggered in suspicious or critical circumstances. Other data is available in infoboxes and/or display or text parameters, including: • • • details of the groups and their group clients statistics of the last full and incremental backups file systems included for each group client Monitoring Backup Activities Legato NetWorker KM for PATROL monitors all save groups initiated from the server for the first 24 hours. Unless the save group completes successfully (without errors), the NSR KM will continue to monitor it for 3 days from the start time. The following items are checked regularly and alerts are triggered in suspicious or critical circumstances: • • • the working status of each save group any errors logged during a save group any pending or failed savesets for a save group Other save group data is available in infoboxes and/or display or text parameters, including: • • • • details of the save group, such as start, end, duration, size, number of files, savesets, group, schedule percentage completed compared with the last similar save group the throughput of the save group all messages produced during the save group OTL Software Ltd., Confidential and Proprietary Information Product Components and Capabilities 1-5 Monitoring Pending Requests Legato NetWorker KM for PATROL monitors all pending requests when they occur for any backup or restore save group initiated by the server. These pending requests may exist on a remote storage node. The amount of time elapsed for a pending request is checked regularly and an alert is triggered in suspicious or critical circumstances. Other data is available in infoboxes and/or display or text parameters, including: • the details of the pending request, such as volume name, volume pool, storage node name, request time Monitoring Jukeboxes and Devices Legato NetWorker KM for PATROL monitors all local and remote backup and restore devices (storage devices) configured on the server/storage node. For all devices listed, the working status is checked regularly and alerts are triggered in suspicious or critical circumstances: • • • jukeboxes jukebox devices standalone devices Other data is available in infoboxes and/or display or text parameters, including throughput, type and server/storage node name. Monitoring Volume Pools Legato NetWorker KM for PATROL monitors all volume pools configured on the server/storage node. The following items are checked regularly and alerts are triggered in suspicious or critical circumstances: • • the space utilization of total volume pool space as percentage of all volumes, the number of full, active and available volumes Other data is available in infoboxes and/or display or text parameters. OTL Software Ltd., Confidential and Proprietary Information 1-6 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Product Architecture Application Classes and Icons Table 1-1 shows the icon and label for each application class, and a brief description of its function including their parent/child application classes and object/component names. Note All application classes with their names ending _CONTAINER are created as parent instances to contain all child component instances. These container instances are instantiated only when there is a child instance to be created. Table 1-1 Icon Application class icons and functions Application Class Instance Label Function NSR_SERVER Legato NetWorker Serves as a container representing the entire Legato NetWorker application. Note: If the instance is labelled NSR_SETUP, the KM is awaiting KM License details and / or Login Details Displays information on the server or storage node. Parent of: NSR_CLIENT_CONTAINER, NSR_DAEMON_CONTAINER, NSR_DATABASE_CONTAINER, NSR_LOG_CONTAINER, NSR_JOB_CONTAINER, NSR_MOUNT_CONTAINER, NSR_POLICY_CONTAINER, NSR_LIBRARY_CONTAINER, NSR_DEVICE_CONTAINER, and NSR_POOL_CONTAINER Object: Server Component: Server NSR_CLIENT_CONTAINER Clients Displays Legato NetWorker client information. NSR_CLIENT Child of: NSR_SERVER Object: Client Component: Client OTL Software Ltd., Confidential and Proprietary Information Product Components and Capabilities 1-7 Table 1-1 Icon Application class icons and functions Application Class Instance Label Function NSR_DAEMON_CONTAINER Daemons Displays Legato NetWorker application daemon information. NSR_DAEMON Child of: NSR_SERVER Object: Daemon Component: Daemon NSR_DATABASE_CONTAINER Databases NSR_DATABASE Displays Legato NetWorker index database information. Child of: NSR_SERVER Object: Database Component: Database NSR_LOG_CONTAINER Logs NSR_LOG Displays Legato NetWorker log file information. Child of: NSR_SERVER Object: Log Component: Log NSR_POLICY_CONTAINER Groups NSR_POLICY Displays Legato NetWorker group information. Child of: NSR_SERVER Parent of: NSR_PCLIENT Object: Backup Component: Group NSR_PCLIENT Displays Legato NetWorker group client information. Child of: NSR_POLICY Object: Backup Component: Group NSR_JOB_CONTAINER Save Groups Displays Legato NetWorker save group information. NSR_JOB @ Child of: NSR_SERVER Object: Backup Component: Save Group NSR_MOUNT_CONTAINER Pending Requests NSR_MOUNT on Displays Legato NetWorker media pending request information on all servers/storage nodes. Child of: NSR_SERVER Object: Backup Component: Pending Request OTL Software Ltd., Confidential and Proprietary Information 1-8 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Table 1-1 Icon Application class icons and functions Application Class Instance Label Function NSR_LIBRARY_CONTAINER Jukeboxes NSR_LIBRARY : Displays Legato NetWorker jukebox information on all servers/storage nodes. Child of: NSR_SERVER Parent of: NSR_LDEVICE Object: Device Component: Jukebox NSR_LDEVICE Displays Legato NetWorker jukebox device information on all jukeboxes. Child of: NSR_LIBRARY Object: Device Component: Jukebox NSR_DEVICE_CONTAINER Standalone Devices NSR_DEVICE : Displays Legato NetWorker standalone device information on all servers/storage nodes. Child of: NSR_SERVER Object: Device Component: Device NSR_POOL_CONTAINER Volume Pools Displays Legato NetWorker volume pool information. NSR_POOL Child of: NSR_SERVER Object: Pool Component: Volume Pool OTL Software Ltd., Confidential and Proprietary Information Product Components and Capabilities 1-9 Hierarchical Structure OTL Software’s Legato NetWorker KM for PATROL is organized in groups of application classes. Figure 1-1 on page 1-10 shows the hierarchy of NSR KM application classes described in Table 1-1. Figure 1-1 Application Class Hierarchy of NSR KM OTL Software Ltd., Confidential and Proprietary Information 1-10 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Note The top level icon for NSR KM is a single instance of the NSR_SERVER application class, labelled Legato NetWorker, which represents the Legato NetWorker server or storage node. Only one installed version of Legato NetWorker will be monitored. Automatic discovery will initially detect the primary installation of Legato NetWorker on the server or storage node. By double-clicking the Legato NetWorker icon, you will find the parameters that monitor the Legato NetWorker server or storage node system. In addition to these parameters, there will be other container instances, which contain related application instances. Example Within the container instance labelled Groups, you will find one icon for each discovered group. By double-clicking a group instance, you will find an icon for each group client configured on that group. If the KM is configured to failover automatically on a VCS cluster environment, the main container instance, Legato NetWorker will be instantiated in offline state on the standby system where the relevant service group is OFFLINE. OTL Software Ltd., Confidential and Proprietary Information Product Components and Capabilities 1-11 KM Commands, InfoBoxes and Help A PATROL Knowledge Module (KM) can be viewed using various PATROL Consoles. Due to the environment in which these consoles run, each one uses different methods to display and access information in the KM. This section provides instructions on how to access the KM Commands and InfoBoxes, and how to access the Online Help for the KM using each of the consoles. Accessing KM Commands and InfoBoxes The KM commands for Legato NetWorker KM for PATROL allow you to: • • • configure the NSR KM manage your NSR KM from PATROL view reports about the NSR KM in your environment NSR KM uses InfoBoxes to provide attributes specific to your Legato NetWorker environment. InfoBoxes are tables of attributes viewable through InfoBox commands. NSR KM uses name space variables and parameters to set InfoBoxes. They are available from the icon for each application class instance. Table 1-2 provides information about how to access KM commands and InfoBoxes in the various PATROL Consoles. Table 1-2 Accessing KM Commands and InfoBoxes for NSR KM Console Type To access KM Commands To access InfoBoxes PATROL Central Console PATROL Console for MS Windows Right-click the instance icon to display its pop-up menu and then choose KM Commands Right-click the instance icon to display its pop-up menu and then choose InfoBox PATROL Console for Unix Click MB3 on the instance icon. Click MB2 on the instance icon. OTL Software Ltd., Confidential and Proprietary Information 1-12 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Accessing Online Help Online Help provides detailed instructions about how to use NSR KM, as well as reference information about all of the application classes and parameters. Each of the PATROL Consoles uses a different method for accessing the Help. Table provides information about how to access Help on each console. Note If you are trying to access Help from a Unix console, you may want to refer to the PATROL Installation Guide for specific instructions on how to install and set up a browser in the Unix environment. Table 1-3 Accessing Online Help for NSR KM To access product help To access application class help To access parameter help PATROL Central Consoles -  Right-click the instance icon to display its pop-up menu, then choose Help  Right-click the parameter icon to display its pop-up menu, then choose Help PATROL Console for MS Windows  Select Help => Help Topics from the console menu bar, expand the book PATROL Knowledge Modules, and select Legato NetWorker KM for PATROL  Double-click the application class in the KM tab of the console. Then click the Help tab and Show Help in the Application Properties dialog box  Right-click the parameter icon, and choose Help On from the pop-up menu Console  Double-click the parameter icon, and click the ? icon or Help button in the parameter display window  Double-click the parameter in the KM tab of the console, and click the Help tab and Show Help in the Properties dialog box PATROL Console for Unix  From the console menu bar, choose Help On => Knowledge Modules  Choose Attributes => Application Classes and double-click MB1 on the instance name. Then click Show Help in the Application Definition dialog box  Click MB2 on the parameter icon, and click Help On OTL Software Ltd., Confidential and Proprietary Information Product Components and Capabilities 1-13 Printing Online Help The following tasks describe how to print online Help from a Microsoft Windows or Unix platform: To Print Help from a Microsoft Windows Platform Note Microsoft Windows-based applications contain WinHelp systems that feature a Print button in each topic window. 1. From the Contents tab of the Help system, select a topic. 2. In the topic window, click Print. The Print dialog box for your default printer appears. 3. If desired, modify the settings. 4. Click OK. To Print Help from a Unix Platform Note Unix-based applications feature browser-hosted Help (NetHelp) that does not feature a print option. 1. Navigate to the HTML file that corresponds to the set of topics that you want to print. These HTML files are located in the $PATROL_HOME directory in lib/help/nsr_km/. 2. Double-click the icon to open the file that you want to print. 3. Choose File => Print from the browser menu. OTL Software Ltd., Confidential and Proprietary Information 1-14 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Impact on Resources This section describes • • CPU and memory usage of the KM Network traffic generated by the KM CPU and Memory Usage CPU and memory usage will depend on the size and complexity of your environment and your NSR KM configuration. As you increase data collection frequency or add functionality through customisation, your CPU and memory usage will increase. When monitoring a standard installation of Legato NetWorker using NSR KM, the PATROL Agent will consume between 5MBytes and 10MBytes of additional system memory. An enterprise installation of Legato NetWorker Server with multiple Storage Nodes, Clients, Jukeboxes, and Standalone Devices can consume more memory (as per other KMs used by the PATROL Agent). The memory usage of NSR KM can be reduced by: • • • disabling unwanted component instances from monitoring increasing the collector scheduling interval reducing the instance limits for Legato NetWorker components Network Traffic Under normal conditions, the NSR KM generates minimal network traffic. The amount of network traffic that it generates depends on the number of PATROL Consoles that are connected to the PATROL Agent and the frequency of data collection. OTL Software Ltd., Confidential and Proprietary Information Product Components and Capabilities 1-15 Where to Go from Here The following table suggests topics that you should read next. If you want information on... See... System requirements for the NSR KM “Chapter 2: Preparing to Install” How to install or upgrade the NSR KM “Chapter 3: Installation” How to load the NSR KM and configure it for you environment “Chapter 4: Loading and Configuring” How to monitor Legato NetWorker using this KM “Chapter 5: Working with the KM” OTL Software Ltd., Confidential and Proprietary Information 1-16 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide 2 Preparing to Install 2 This chapter provides pre-installation instructions for OTL Software’s Legato NetWorker® Knowledge Module® for PATROL®. It covers the following topics: Installation Checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2 System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3 Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4 Changes to Legato NetWorker. . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5 Changes to BMC PATROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6 Additional Software Requirements . . . . . . . . . . . . . . . . . . . . . . . 2-7 Security Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-8 Disk Space Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-13 License Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-14 Where to Go from Here . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-14 OTL Software Ltd., Confidential and Proprietary Information Preparing to Install 2-1 Installation Checklist To ensure a successful installation or upgrade of OTL Software’s Legato NetWorker KM for PATROL, ensure that you have completed every task listed in the Installation Checklist presented in Table 2-1. Table 2-1 Installation checklist Completed? Requirement Before Installation System Requirements (page 2-3) • meet the operating system requirements Software Requirements (page 2-3) • meet all Legato NetWorker application requirements • meet all BMC PATROL requirements Security Requirements (page 2-8) • meet all security requirements Disk Space Requirements (page 2-13) • meet the minimum disk space requirements License Requirements (page 2-14) • obtain a valid KM license to run NSR KM During Installation Uninstalling the KM (page 3-9) • uninstall any previous versions of the KM Extracting the Distribution File (page 3-5) • create a temporary directory on your hard drive • save the NSR KM distribution file to the temporary directory Installing the KM (page 3-5) • download installation files to PATROL Agents and PATROL Consoles • extract installation files After Installation Loading the KM (page 4-2) • load the NSR KM to the PATROL Console • verify the NSR KM discovery Configuring the KM (page 4-7) • enter the NSR KM license details • enter the NSR KM login details • preload the KM on to the PATROL Agent • verify the NSR KM data collection OTL Software Ltd., Confidential and Proprietary Information 2-2 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide System Requirements The following table contains the list of operating systems and their versions supported by OTL Software’s Legato NetWorker KM for PATROL. Table 2-2 Supported Operating Systems Operating System Sun® Operating System Version TM microsystems Solaris HP-UX 2.6, 7, 8, 9, 10 11.00, 11i (11.11) IBM® AIXTM 5.1, 5.2, 5.3 Microsoft® Windows NT™ 4.0 (SP 6x), 2000 (SP 2), 2003 Windows® Note Version 2.4 of OTL Software’s Legato NetWorker KM for PATROL may support other versions of operating systems, but versions not listed here have not been tested by OTL Software Limited. Note If the operating system is upgraded (or downgraded) at a later date, you will need to reload commands for the Legato NetWorker KM for PATROL. Refer to “Upgrading the Platform” on page 5-73. OTL Software Ltd., Confidential and Proprietary Information Preparing to Install 2-3 Software Requirements The following table contains list of required software and their versions supported by OTL Software’s Legato NetWorker KM for PATROL Table 2-3 Required Software for NSR KM Software Version Legato NetWorker Power Edition, Network Edition, Workgroup Edition or Business Edition 6.1.x, 6.2, 7.0, 7.1.x, 7.2.x, 7.3.x, 7.4.x BMC PATROL Agent 3.4.20, 3.5.x, 3.6.x BMC PATROL Console 3.4.x, 3.5.x, 7.x BMC Portal with BMC Performance Manager Portal 2.3.x, 2.4.x, 2.5.x, 2.6.x Note Version 2.4 of OTL Software’s Legato NetWorker KM for PATROL does not support Legato NetWorker versions before 6.1 and PATROL Agent versions before 3.4. Note Version 2.4 of OTL Software’s Legato NetWorker KM for PATROL may support other versions of Legato NetWorker and/or BMC PATROL, but any version not listed has not been tested by OTL Software Limited. Note If the version of Legato NetWorker is upgraded (or downgraded) at a later date, you will need to reload commands for the Legato NetWorker KM for PATROL. Refer to “Upgrading the Platform” on page 5-73. OTL Software Ltd., Confidential and Proprietary Information 2-4 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Changes to Legato NetWorker It is recommended to set-up a save group log file on all managed systems on Unix platforms. This file can be used by the NSR KM to collect save group information efficiently. The save group log file can be configured in Legato NetWorker using the steps below. 1. Open the Legato NetWorker Administrator GUI, and select Customize => Notifications 2. Select View => Details to see all details of a notification 3. Click on Create and fill out the form as below: Name: NSR KM savegroup logging Comment: Required notification for NSR KM Action: cat >> /nsr/logs/savegrp.log Event: Savegroup Priority: Info, Warning, Critical, Emergency, Notice, Waiting, Alert 4. Click on Apply Note The NSR KM will process the contents of Legato NetWorker messages file (/nsr/logs/messages) in the absence of above save group log file (/nsr/logs/savegrp.log). Note The above save group log file set-up is not required on Windows managed nodes because it is one of the standard Legato NetWorker log files. Note The NSR KM will not maintain or recycle this save group log file. It is recommended to recycle the save group log file regularly. OTL Software Ltd., Confidential and Proprietary Information Preparing to Install 2-5 Changes to BMC PATROL To improve the performance of the NSR KM, the PATROL Agent tuning variable “/AgentSetup/AgentTuning/pslInstructionMax” should be increased to at least 5,000,000. This applies for all Legato NetWorker servers and storage nodes where the KM is installed. This adjustment will allow the KM data collectors to execute without incurring an internal scheduling delay. This PATROL Agent tuning variable can be updated using wpconfig (on Microsoft Windows) or xpconfig (on Unix). Alternatively, you can use the following single line PSL command through the PATROL Console OS> prompt to update this tuning variable. %PSL v="/AgentSetup/AgentTuning/pslInstructionMax"; if(get(v)<5000000){pconfig("REPLACE",v,5000000);} Note In large Legato NetWorker systems, the value of 5,000,000 for the tuning variable “pslInstructionMax” may still be insufficient. In such situations, error messages will appear on the PATROL Console System Output Window (SOW) reporting that some NSR KM data collectors are in an infinite loop. In this case you can set the tuning variable to zero to disable this functionality. The KM stores all configuration information in the PATROL Agent configuration database (pconfig), under paths /NSR and /NSR_License. PATROL Agent user (default: patrol) should be able to read and write to these pconfig variables at anytime. If Access Control List (ACL) is used to control which users are authorized to connect to a PATROL Agent, please ensure that the mode for PATROL Agent user includes “C” in the PATROL Agent variable “/AgentSetup/accessControlList”. Please refer the PATROL Agent Reference Manual for more details. OTL Software Ltd., Confidential and Proprietary Information 2-6 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Note You cannot copy or distribute these KM configuration variables between managed nodes, because they may not have the same value for each managed node. For example, the KM user login details may not be the same for all managed nodes. Also some of these variables, like installation paths, are set automatically during the initial discovery. Additional Software Requirements The following table contains a list of additional software requirements of OTL Software’s Legato NetWorker KM for PATROL: Table 2-4 Additional Software Requirements for NSR KM Purpose Software Version When running NSR KM with sudo user account on Solaris, HP-UX and AIX managed nodes Sudo (superuser do) 1.6.7 or later When running NSR KM on MS Windows NT managed nodes MS Windows Scripting Host MS Windows Management Instrumentation (WMI) Core 5.6 or later 1.5 or later OTL Software Ltd., Confidential and Proprietary Information Preparing to Install 2-7 Security Requirements By default, Legato NetWorker is installed and run as the root user (on Unix) or as administrator user (on Microsoft Windows). Legato NetWorker KM for PATROL needs to be run as a user account with administrative privileges to read and execute Legato NetWorker application programs and file systems. Login details of this user are configured in the NSR KM during the KM configuration. The password is stored in the PATROL Agent in a DES encrypted format. Warning The encrypted password can be viewed by any user who has access to the PATROL Agent configuration variables (pconfig). This user could then execute PSL statements using the encrypted password through the PATROL Console. This can be prevented by setting up an appropriate Access Control List (ACL) for users. Please refer to the PATROL Agent Reference Manual for details on how to set up an ACL. One of the following user accounts can be used for configuring the login details of the KM: 1. root user (Unix) or administrator user (Microsoft Windows) 2. a non-root user, such as patrol, with sudo privileges on Legato NetWorker to execute application programs and access the file systems (Unix only) 3. a non-root (Unix) or non-administrator (Microsoft Windows) account, such as patrol, configured in Legato NetWorker application to administor the Legato NetWorker application Note Refer to the Legato NetWorker System Administrator’s Guide for details on how to set up this type of account. OTL Software Ltd., Confidential and Proprietary Information 2-8 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Access Permissions The NSR KM user needs “read & execute” permission to executable and library files under the paths listed below. The Legato NetWorker installation path INSTALL_PATH, referenced in Table 2-5 and Table 2-6, is normally /nsr ot /opt/networker (on Unix) or C:\Program Files\nsr (on MS Windows). Table 2-5 Executable and Library File Paths Accessed by NSR KM User Unix Microsoft Windows INSTALL_PATH/bin INSTALL_PATH\bin INSTALL_PATH/lib /usr/bin /usr/sbin /usr/sbin/nsr /usr/lib/nsr /etc/LGTOuscsi Note If the KM enabled to failover in a VCS Cluster environment, the KM user need execute permissions to the VCS command: /opt/VRTSvcs/bin/hagrp To list all OS commands used by the NSR KM, execute the following PSL code from the PATROL Console, using “PSL Task” menu, after installing and loading the KM. foreach var (grep("^/NSR/CommandControls/",pconfig("LIST"))) { ctl=pconfig("GET", var); typ=ntharg(grep("CommandType",ctl),"2-"," ="); cmd=nthargf(grep("CommandText",ctl),"2-","=","="); if(typ == "OS") { printf("(%2d) %-25s: %s\n",i++,ntharg(var,"3","/"),cmd); } } OTL Software Ltd., Confidential and Proprietary Information Preparing to Install 2-9 The PATROL Agent user (normally patrol) needs “read & execute” permission to following paths and files: Table 2-6 Paths and Files Accessed by PATROL Agent User Unix Microsoft Windows INSTALL_PATH/res INSTALL_PATH\res INSTALL_PATH/index INSTALL_PATH\index INSTALL_PATH/mm INSTALL_PATH\mm INSTALL_PATH/logs/daemon.log INSTALL_PATH\logs\daemon.log INSTALL_PATH/logs/messages INSTALL_PATH\logs\messages INSTALL_PATH/logs/summary INSTALL_PATH\logs\summary INSTALL_PATH/lic/logs/lgtomd.log INSTALL_PATH\logs\savegrp.log /var/adm/messages (on Solaris) /var/adm/syslog/syslog.log (on HP-UX) Note To access files under above paths the relevant user needs “read & execute” permission to all parent directories. Warning If a monitored log file cannot be read by the PATROL Agent user, it will be copied to KM_HOME path using the configured KM login account, and processed by the PATROL Agent user. On completion, the copied log file will be removed. This may increase the file system usage under KM_HOME temporarily during this activity. On Windows platforms the Legato NetWorker installation is identified by checking the Windows Registry. Depending on whether you are using a 32/64-bit OS and/or 32/64-bit Application, the Registry entries are stored in different locations: “HKEY_LOCAL_MACHINE\SOFTWARE\Legato\NetWorker\” and “HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Legato\NetWo rker\”. OTL Software Ltd., Confidential and Proprietary Information 2-10 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Sudo User for Operating System Access If a non-root user with sudo privileges is preferred as the NSR KM user, configure the account as a sudoer through the visudo utility using code appropriate for your platform as detailed below. This user should be able to execute NetWorker commands and OS commands listed in Table 2-5 on page 2-9. The code below also applies to all non-root users who may execute NSR KM administration and report menu commands using their sudo privileges. The NSR KM accepts any non-root user with the following sudo configuration in the sudoers file. Please replace user1, user2, user3 with appropriate KM user name. The Legato NetWorker installation path INSTALL_PATH, referenced below is normally /nsr or /opt/networker and PATROL_HOME is the path where the PATROL Agent is installed (including the target, like /opt/bmc/Patrol3/Solaris29-sun4/). On Solaris: User_Alias NSRKMUSERS = user1, user2, user3 Defaults:NSRKMUSERS !lecture,!authenticate,\ env_keep+="LD_LIBRARY_PATH INSTALL_PATH KM_HOME \ KM_TEMP",env_reset NSRKMUSERS ALL=/bin/*,/sbin/*,/usr/bin/*,/usr/sbin/*,\ /usr/sbin/nsr/*,/etc/LGTOuscsi/*\ INSTALL_PATH/bin/*,\ PATROL_HOME/lib/NSR/*,PATROL_HOME/bin/* On HP-UX: User_Alias NSRKMUSERS = user1, user2, user3 Defaults:NSRKMUSERS !lecture,!authenticate,\ env_keep+="SHLIB_PATH INSTALL_PATH KM_HOME \ KM_TEMP",env_reset NSRKMUSERS ALL=/bin/*,/sbin/*,/usr/bin/*,/usr/sbin/*,\ /usr/sbin/nsr/*,/etc/LGTOuscsi/*\ INSTALL_PATH/bin/*,\ PATROL_HOME/lib/NSR/*,PATROL_HOME/bin/* OTL Software Ltd., Confidential and Proprietary Information Preparing to Install 2-11 On AIX: User_Alias NSRKMUSERS = user1, user2, user3 Defaults:NSRKMUSERS !lecture,!authenticate,\ env_keep+="LIBPATH INSTALL_PATH KM_HOME \ KM_TEMP",env_reset NSRKMUSERS ALL=/bin/*,/sbin/*,/usr/bin/*,/usr/sbin/*,\ /usr/sbin/nsr/*,/etc/LGTOuscsi/*\ INSTALL_PATH/bin/*,\ PATROL_HOME/lib/NSR/*,PATROL_HOME/bin/* Warning This non-root sudo user configured in the KM will be able to execute root equivalent commands by opening a shell window. To prevent this, ensure this user is only used within the KM and not made public for general use. Warning Entering the non-root sudo user with ‘Use Sudo’ option selected in to the KM login configuration dialog, before updating the sudoers file, will generate sudo errors. Also if the sudo user is configured differently, the KM may run sudo commands using incorrect sudo settings, which will expose the sudo user password. OTL Software Ltd., Confidential and Proprietary Information 2-12 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Disk Space Requirements OTL Software’s Legato NetWorker KM for PATROL requires approximately: • • • • 1.2 MBytes disk space on each monitored PATROL Agent system 2.3 MBytes disk space on each PATROL Console system 400 KBytes disk space on each PATROL Central Console Server system 1 MBytes disk space on each PATROL Central Web Server system The NSR KM is installed under the PATROL installation path. When monitoring a standard installation of Legato NetWorker using NSR KM, the PATROL Agent will generate approximately 250 KBytes of history data per day. An enterprise installation of Legato NetWorker on a server with multiple storage nodes, clients, jukeboxes, and standalone devices will generate more history data (as per other KMs used by the PATROL Agent). These history data files are recycled by PATROL depending on the PATROL Agent history retention period. During NSR KM data collection, it will use a temporary folder (KM_HOME/tmp) to store some temporary files. These temporary files are removed at the end of the data collection cycle. Required space under this file system depends on the complexity of the Legato NetWorker environment. If the available space for this folder is less than 10 MBytes, it can be changed to a different file system, which has sufficient disk space. This can be achieved by replacing the temporary folder, KM_HOME/tmp, with a soft link pointing to a different file system, like /tmp. This new temporary folder should have read, write and execute permissions for both PATROL Agent user and the NSR KM login user. OTL Software Ltd., Confidential and Proprietary Information Preparing to Install 2-13 License Requirements You must obtain a valid license key to run OTL Software’s Legato NetWorker KM for PATROL. Evaluation or permanent license keys can be obtained from your local reseller or from OTL Software Limited. If you have not yet installed a permanent license key and want to do so, contact your local reseller or visit OTL Software’s web site at http://www.otl.co.nz. If you are upgrading the NSR KM from version 1.x to 2.4, a new set of license keys will be required. Please check that all required license keys are delivered with the product. Where to Go from Here The following table suggests topics that you should read next. If you want information on... See... How to install or upgrade the NSR KM “Chapter 3: Installation” How to load the NSR KM and configure it for your environment “Chapter 4: Loading and Configuring” How to monitor Legato NetWorker using this KM “Chapter 5: Working with the KM” OTL Software Ltd., Confidential and Proprietary Information 2-14 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide 3 Installation 3 This chapter provides instructions for installing OTL Software’s Legato NetWorker® Knowledge Module® for PATROL®. It covers the following topics: Installation Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2 Installation Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3 Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4 Installing the KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5 Uninstalling the KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-9 Where to Go from Here . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-15 OTL Software Ltd., Confidential and Proprietary Information Installation 3-1 Installation Workflow Figure 3-1 illustrates the workflow to be followed during installation of OTL Software’s Legato NetWorker KM for PATROL on each PATROL Agent and PATROL Console system using the NSR KM. Figure 3-1 Installation Workflow Copy the NSR KM Distribution file to a temporary folder, and extract the contents Download the installation file to the PATROL_HOME path on the PATROL Agent and PATROL Console systems First time installation? No Backup PATROL installation folders Yes Extract the content of the installation file from the PATROL_HOME directory Remove all NSR KM files installed previously Load the NSR KM from the PATROL Console and verify the discovery Configure NSR KM License details and Login details, verify the KM data collection and preload the KM OTL Software Ltd., Confidential and Proprietary Information 3-2 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Installation Guidelines Follow these guidelines to ensure successful installation of OTL Software’s Legato NetWorker KM for PATROL: • Install the NSR KM on each Legato NetWorker server or storage node to be monitored, and on each PATROL Console. Note the KM should not be installed on Legato NetWorker clients. • Install NSR KM under PATROL installation path (%PATROL_HOME% on Microsoft Windows systems and $PATROL_HOME on Unix systems). • It is recommended that the installation file is extracted by the PATROL user on the PATROL Agent system. Note The PATROL Developer Console menu command Commit KM cannot be used for installing the NSR KM to any PATROL Agent. The Commit KM command will not copy NSR KM scripts, which are operating system dependant. These scripts are stored under the KM_HOME path (PATROL_HOME/lib/NSR) on the PATROL Agent system. OTL Software Ltd., Confidential and Proprietary Information Installation 3-3 Procedures This section provides instructions to install, upgrade or uninstall OTL Software’s Legato NetWorker KM for PATROL on Microsoft Windows and Unix platforms. OTL Software recommends that: • if you are upgrading from an older version of NSR KM, backup the PATROL Agent and PATROL Console installation paths Note When upgrading from version 1.x, all previous NSR KM configuration data stored in the PATROL Agent configuration database (pconfig) will be removed. • before deploying the NSR KM to a production environment, it should be installed, configured and tested in a test environment • all components of the NSR KM included in the installation file should be installed • all KM files should be loaded using the NSR_LOAD.kml file Note Many of the files have interdependency so a full installation eliminates errors and enables monitoring of all components. OTL Software Ltd., Confidential and Proprietary Information 3-4 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Installing the KM This section describes steps required to install or upgrade the Legato NetWorker KM for PATROL. Preparing to Install or Upgrade 1. Check all prerequisites listed in “Chapter 2: Preparing to Install” have been met. 2. Extract the contents of the distribution file to a temporary folder. This distribution file can be obtained as a Microsoft Windows zip file (nsr.zip) or as a compressed tar file (nsr.tar.Z). Zip files can be extracted using WinZip application or PKUNZIP command (Microsoft Windows platforms) or uncompress and tar commands (Unix platforms). Table 3-1 describes the contents of the NSR KM distribution file. Table 3-1 Contents of the Distribution File File Description nsr_ug24.pdf User Guide nsr_rn.pdf Release Notes nsr_r24_agent.tar Unix PATROL Agent installation file nsragt24.exe MS Windows PATROL Agent installation file nsr_r24_console.tar PATROL Console for Unix installation file nsrcon24.exe PATROL Console for MS Windows installation file nsrconserver24.tar PATROL Central Console Server for Unix installation file nsrcs24.exe PATROL Central Console Server for Windows installation file nsrwebserver24.tar PATROL Central Web Server for Unix installation file nsrws24.exe PATROL Central Web Server for Windows installation file OTL Software Ltd., Confidential and Proprietary Information Installation 3-5 Table 3-1 Contents of the Distribution File File Description otl-nsr-solution-2.4.xx.par BMC Portal PAR file otl-nsr-express-solution-2.4 .xx.par BMC Portal PAR file for integrating static components only 3. Read the Release Notes, and confirm all requirement for this release have been met. 4. If you are upgrading the NSR KM, please follow the steps described under “Uninstalling the KM” on page 3-9 to uninstall the old version of the KM before attempting to install the new version. OTL Software Ltd., Confidential and Proprietary Information 3-6 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Installing the KM on a Unix Platform 1. Copy or ftp appropriate installation files under the paths for the relevant systems as shown in Table 3-2. Table 3-2 Unix Platform Installation Files and Extraction Paths File Path nsr_r24_agent.tar $PATROL_HOME/ on monitored servers and storage nodes for Legato NetWorker for Unix Example: /opt/bmc/Patrol3/ or /opt/bmc/Patrol3/Solaris29-sun4/ nsr_r24_console.tar $PATROL_HOME/ on PATROL Console for Unix Example: /opt/bmc/Patrol3/ or /opt/bmc/Patrol3/Solaris29-sun4/ nsrconserver24.tar $PATROL_ROOT/ on PATROL Central Console Server for Unix Example: /opt/bmc/Patrol7/ nsrwebserver24.tar $BMC_ROOT/webcentral/ on PATROL Central Web Server for Unix Example: /opt/bmc/webcentral/ 2. Extract the contents of the installation .tar file as PATROL user, using: tar xvf 3. Remove the installation .tar file copied in Step 1. OTL Software Ltd., Confidential and Proprietary Information Installation 3-7 Installing the KM on a Microsoft Windows Platform 1. Copy or ftp appropriate installation files to a temporary folder (such as C:\temp\) on the relevant system. 2. Double-click the file and extract the contents of the self-extracting files to relevant paths as shown in Table 3-3 Table 3-3 MS Windows Platform Installation Files and Extraction Paths File Path nsragt24.exe %PATROL_HOME%\ on monitored servers and storage nodes for Legato NetWorker for Microsoft Windows Example: C:\Program Files\BMC Software\Patrol3\ nsrcon24.exe %PATROL_HOME%\ on PATROL Console for MS Windows Example: C:\Program Files\BMC Software\Patrol3\ nsrcs24.exe %PATROL_ROOT%\ on PATROL Central Console Server for Windows Example: C:\Program Files\BMC Software\Patrol7\ nsrws24.exe %BMC_ROOT%\WebCentral\ on PATROL Central Web Server for Windows Example: C:\Program Files\BMC Software\WebCentral\ 3. Remove the self-extracting installation file copied in Step 1. Installing or Upgrading the PAR file on BMC Portal The PAR file enables BMC Portal to retrieve the KM data from the PATROL Agent. 1. Log on to the BMC Portal with portal credentials, and select the Portal tab. 2. Under Tasks in the navigation pane, select Performance Managers. OTL Software Ltd., Confidential and Proprietary Information 3-8 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide 3. Click Upload 4. Click Browse and then select the PAR file extracted under the temporary folder on the local system. For complete integration select otl-nsr-solution-2.4.xx.par and for static components only integration (without Save Group or Pending Request integration) select otl-nsr-express-solution-2.4.xx.par. 5. Click Upload. Note If you are upgrading the PAR file on BMC Portal, the initial Status of the newly uploaded PAR solution on Portal is “Unpublished“. To push-out the new version to effect the upgrade process, select the checkbox next to the new version PAR solution on Portal, and click Publish. Uninstalling the KM This section describes steps for uninstalling the Legato NetWorker KM for PATROL. The KM is uninstalled when upgrading the NSR KM from an older version, or if the NSR KM is no longer required for monitoring the Legato NetWorker application. The steps required for uninstalling depend on the type of installation: • For PATROL Agent and PATROL Console, “uninstallation” involves unloading the KM and then removing the files. • For PATROL Central Console, the KM is uninstalled by unloading. • For PATROL Central Console Server or PATROL Central Web Server, the KM is uninstalled by removing the files. OTL Software Ltd., Confidential and Proprietary Information Installation 3-9 Uninstalling the KM from the PATROL Agent 1. Unload the NSR KM by removing it from the list of preloaded KMs. If the current version of the NSR KM is 2.x, you can use the KM command Configuration => Preloading from the Legato NetWorker instance to unload the KM. Alternatively, use the utility wpconfig (on MS Windows) or xpconfig (on Unix) to remove NSR_LOAD.kml from the PATROL Agent configuration variable “/AgentSetup/preloadedKMs”. 2. Restart the PATROL Agent. 3. Remove all NSR KM files listed in Table 3-4 under the paths for PATROL Home (PATROL_HOME) and PATROL Cache (PATROL_CACHE). Note There may be more than one PATROL Cache directory depending on how PATROL has been set up in your installation. Users can set up a local Cache directory to override the global setting. 4. Repeat the above steps on every PATROL Agent system where the NSR KM is installed. Table 3-4 Uninstallation from the PATROL Agent File Types to Delete Path relative to PATROL_HOME Unix Microsoft Windows PSL Library Files lib/psl/NSR_*.* lib\psl\NSR_*.* KM & Catalog Files lib/knowledge/NSR_*.* lib\knowledge\NSR_*.* Archive Files lib/archive/NSR_*.* lib\archive\NSR_*.* Other Files & Folders NSR/* NSR NSR_*.* lib/NSR/* lib/NSR lib/NSR_*.* NSR\*.* NSR NSR_*.* lib\NSR\*.* lib\NSR lib\NSR_*.* OTL Software Ltd., Confidential and Proprietary Information 3-10 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Uninstalling the KM from the PATROL Console 1. Unload the NSR KM by removing all the application classes from the list of loaded application classes. All NSR KM application classes start with “NSR_”. On PATROL Console for Unix: A. From the PATROL Console main window choose Attributes => Application Classes... B. Select a NSR KM application class and choose Edit => Delete. C. Repeat for all classes. D. Select File => Save Configuration to save the modified list of loaded KMs as the PATROL Console user preference. On PATROL Console for Microsoft Windows: A. From the PATROL Console tree view choose the KM tab and expand the folder Application Classes. B. Right-click on a NSR KM application class and choose Delete. C. Repeat for all classes. D. Select File => Save Configuration to save the modified list of loaded KMs as the PATROL Console user preference. 2. Remove all NSR KM files listed in Table 3-5 under the paths for PATROL Home (PATROL_HOME) and PATROL Cache (PATROL_CACHE). Note There may be more than one PATROL Cache directory depending on how PATROL has been setup in your installation. Users can set up a local Cache directory to override the global setting. Table 3-5 Uninstallation from PATROL Console File Types to Delete Path relative to PATROL_HOME Unix Microsoft Windows PSL Library Files lib/psl/NSR_*.* lib\psl\NSR_*.* KM & Catalog Files lib/knowledge/NSR_*.* lib\knowledge\NSR_*.* OTL Software Ltd., Confidential and Proprietary Information Installation 3-11 Table 3-5 Uninstallation from PATROL Console File Types to Delete Path relative to PATROL_HOME Unix Microsoft Windows Archive Files lib/archive/NSR_*.* lib\archive\NSR_*.* Icon & Image Files lib/images/NSR_*.* lib/images/nsr_*.* lib\images\nsr_*.* Online Help Files & Folders lib/help/nsr_*.* lib/help/nsr_km/*.* lib/help/nsr_km lib/help/km_help_nsr_km lib\help\nsr_*.* lib\help\nsr_km\*.* lib\help\nsr_km lib\help\km_help_nsr_km 3. Repeat above steps on every PATROL Console system where the NSR KM is installed. Uninstalling the KM from PATROL Central Console 1. Unload the NSR KM by removing all the application classes from the list of loaded application classes. All NSR KM application classes start with “NSR_”. A. Right-click on the PATROL Main Map and choose Unload Knowledge Modules... B. Select the managed systems where the NSR KM is to be unloaded, and click Next>. C. Select all NSR KM application classes, click Next> and Finish. 2. Repeat the above steps on every PATROL Central Console where the NSR KM is installed. OTL Software Ltd., Confidential and Proprietary Information 3-12 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Uninstalling the KM from the PATROL Central Console Server 1. Remove all NSR KM files listed in Table 3-6 under the PATROL Central Console Server installation path (PATROL_ROOT). Table 3-6 Uninstallation from the PATROL Central Console Server File Types to Delete Path for PATROL Central Console Server Unix Microsoft Windows Online Help Files lib/knowledge/nsr_*/lib/help /EN_USA/nsr_km.chm lib\knowledge\nsr_*\lib\help \EN_USA\nsr_km.chm Icon & Image Files & Folders lib/knowledge/nsr_*/*.* lib/knowledge/nsr_* lib\knowledge\nsr_*\*.* lib\knowledge\nsr_* 2. Repeat above steps on every PATROL Central Console Server system where the NSR KM is installed. Uninstalling the KM from the PATROL Central Web Server 1. Remove all NSR KM files listed in Table 3-7 under the PATROL Central Web Server installation path ($BMC_ROOT/webcentral on Unix and %BMC_ROOT%\WebCentral on Microsoft Windows). Table 3-7 Uninstallation from the PATROL Central Web Server File Types to Delete Path for PATROL Central Web Server Unix Microsoft Windows Online Help Files help_services/nsr_km*.jar km_services/html/default/lib/help /EN_USA/nsr_km*.jar help_services\nsr_km*.jar km_services\html\default\lib\help \EN_USA\nsr_km*.jar 2. Repeat above steps on every PATROL Central Web Server system where the NSR KM is installed. OTL Software Ltd., Confidential and Proprietary Information Installation 3-13 Uninstalling the PAR File from the BMC Portal Note If you are upgrading the PAR file on BMC Portal, skip the uninstallation procedures outlined below and follow the upgrade steps in “Installing or Upgrading the PAR file on BMC Portal” on page 3-8. 1. Remove all elements using the NSR KM PAR file from the BMC Portal Infrastructure. 2. Log on to the BMC Portal with portal credentials, and select the Portal tab. 3. Under Tasks in the navigation pane, select Performance Managers. 4. Check the check-box next to the NSR KM solution from the list. 5. Click Delete. OTL Software Ltd., Confidential and Proprietary Information 3-14 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Deleting PATROL Agent Configuration Variables Note If you are uninstalling the KM to upgrade from an older version of NSR KM, you do not have to follow the steps below. The new version of the KM will upgrade the configuration details during the initial KM discovery. 1. Remove all PATROL Agent configuration variables created by the NSR KM. These variables are stored under configuration paths NSR and NSR_License. They can be removed using wpconfig (on MS Windows) or xpconfig (on Unix). Alternatively, you can use the following single line PSL command through the PATROL Console OS> prompt to remove NSR KM configuration variables. The Legato NetWorker KM for PATROL should be uninstalled on the PATROL Console before attempting the following PSL command: %PSL foreach var(grep("^/NSR[/_]",pconfig("LIST"))) { pconfig("DELETE", var); } 2. Repeat the above step on every PATROL Agent system where the NSR KM has been loaded. Where to Go from Here The following table suggests topics that you should read next. If you want information on... See... How to load the NSR KM and configure it for your environment “Chapter 4: Loading and Configuring” How to monitor Legato NetWorker using this KM “Chapter 5: Working with the KM” OTL Software Ltd., Confidential and Proprietary Information Installation 3-15 OTL Software Ltd., Confidential and Proprietary Information 3-16 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide 4 Loading and Configuring 4 This chapter provides instructions for loading and configuring OTL Software’s Legato NetWorker® Knowledge Module® for PATROL®. It covers the following topics: Loading the KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2 Preparing to Load the KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2 Loading the KM on PATROL Console . . . . . . . . . . . . . . . . . . . . 4-2 Loading the KM on PATROL Central . . . . . . . . . . . . . . . . . . . . . 4-4 Loading the KM on BMC Portal . . . . . . . . . . . . . . . . . . . . . . . . . 4-6 Configuring the KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7 Licensing the KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7 Configuring the KM User Account . . . . . . . . . . . . . . . . . . . . . . . 4-9 Verifying Application Discovery . . . . . . . . . . . . . . . . . . . . . . . . . 4-10 Checking the Instance Limits. . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12 Checking the Initial Setup of the KM . . . . . . . . . . . . . . . . . . . . . 4-13 Configuring PATROL Agent to Preload the KM. . . . . . . . . . . . . 4-15 Restarting PATROL Agent and PATROL Console . . . . . . . . . . . 4-15 Unloading the KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16 Unloading the KM from the PATROL Agent . . . . . . . . . . . . . . . 4-16 Unloading the KM from PATROL Console. . . . . . . . . . . . . . . . . 4-17 Unloading the KM from PATROL Central Console . . . . . . . . . . 4-18 Where to Go from Here . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18 OTL Software Ltd., Confidential and Proprietary Information Loading and Configuring 4-1 Loading the KM This section provides instructions to load OTL Software’s Legato NetWorker KM for PATROL on Microsoft Windows and Unix platforms. Before you load the NSR KM, you must install the KM on PATROL Console and PATROL Agent systems, following the instructions in “Chapter 3: Installation”. Preparing to Load the KM 1. Start the PATROL Console and update the connection to all PATROL Agent systems where the NSR KM is installed. 2. Check the value of the PATROL Agent tuning variable, “/AgentSetup/AgentTuning/pslInstructionMax”, and if necessary, increase it as described in “Changes to BMC PATROL” on page 2-6. Loading the KM on PATROL Console 1. From the PATROL Console menu bar, choose File => Load KM... 2. Select the NSR_LOAD.kml file, and click Open or OK. The NSR KM will be loaded to the PATROL Console, and all connected PATROL Agents will start discovering the Legato NetWorker environment. If the automatic discovery successfully finds the Legato NetWorker server/storage node installation, NSR_SETUP instance will be instantiated, as shown in Figure 4-1. Note This automatic discovery may take up to 5 minutes to instantiate the NSR_SETUP instance. Look for any error messages on the PATROL Console System Output Window (SOW) during the initial discovery. OTL Software Ltd., Confidential and Proprietary Information 4-2 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Figure 4-1 NSR KM Setup Instance & Menus on PATROL Console 3. Select File => Save Configuration to save the new list of loaded KMs as the PATROL Console user preference. 4. Repeat the above steps on each PATROL Console. OTL Software Ltd., Confidential and Proprietary Information Loading and Configuring 4-3 Loading the KM on PATROL Central 1. Right click on the PATROL Main Map, and choose Load Knowledge Modules... A wizard box will display a list of all managed systems. 2. Select the managed systems where the NSR KM is to be loaded, and click Next>. The wizard will display a list of all available .kml files for the managed systems you selected. 3. Select the NSR_LOAD.kml file for each managed system, click Next> and Finish. Note If you cannot find the NSR_LOAD.kml file in the wizard list for any system you selected, then the KM has not been installed on that system. Check that you have followed the instructions in “Installing the KM” on page 3-5. The NSR KM will be loaded to the PATROL Central Console Server, and all connected selected managed systems will start discovering the Legato NetWorker environment. If the automatic discovery successfully finds the Legato NetWorker server/storage node installation, the NSR_SETUP instance will be instantiated, as shown in Figure 4-2. Note This automatic discovery may take up to 5 minutes to instantiate NSR_SETUP instance. 4. Repeat the above steps for each PATROL Central Management Profile where NSR KM is to be unloaded. OTL Software Ltd., Confidential and Proprietary Information 4-4 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Figure 4-2 NSR KM Setup Instance and Menus on PATROL Central Console OTL Software Ltd., Confidential and Proprietary Information Loading and Configuring 4-5 Loading the KM on BMC Portal 1. Login to BMC Portal with appropriate credentials to add infrastructure elements. 2. Click on Configure tab. 3. Under Tasks, select Elements to open the Elements page. 4. Click in Add. 5. Select Infrastructure Element, and click Next. 6. Select appropriate RSM, and click Next. 7. Enter the label for the element, select PATROL Integration, and click Next. 8. Select/create a group name, and click Next. 9. Select appropriate method to discover the PATROL Agent hosts, and click Next. 10. Fill the required details for discovering the PATROL Agents, and click Commit. OTL Software Ltd., Confidential and Proprietary Information 4-6 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Configuring the KM This section provides instructions to configure OTL Software’s Legato NetWorker KM for PATROL. These instructions should be followed on all PATROL Agent systems where NSR KM is installed. Before you can configure the NSR KM, the KM must be loaded on the PATROL Console and the NSR_SETUP instance should be displayed as shown in Figure 4-1 or Figure 4-2. Note This version of the NSR KM cannot be configured from BMC Portal. Use PATROL Console or PATROL Central Console to access the KM configuration menus (KM commands) described below.. Licensing the KM Please read “License Requirements” on page 2-14 for details on obtaining NSR KM license keys. Note On PATROL Agents running on MS Windows platforms, the user logged on the PATROL Console should be able to execute the binaries under KM_HOME path (PATROL_HOME\NSR). 1. From the NSR_SETUP instance, select the KM command Configuration => License and select whether to enable or disable remote authentication. 2. If the remote authentication is disabled, a dialog for entering licensing details will be displayed, as shown in Figure 4-3. Enter the license details exactly as supplied in the respective fields and click OK. If the license information entered is valid, an acknowledgement will be displayed. OTL Software Ltd., Confidential and Proprietary Information Loading and Configuring 4-7 Figure 4-3 License Configuration dialog 3. If the remote authentication is enabled, a dialog for entering remote PATROL Agent details will be displayed, as shown in Figure 4-4. Enter the remote managed node details and click OK. If the remote authentication details are valid, an acknowledgement will be displayed. Figure 4-4 Remote Authentication Configuration dialog OTL Software Ltd., Confidential and Proprietary Information 4-8 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Note The remote authenication method requires a nominated system running NSR KM installed with a license file stored under the KM_HOME path. Please contact OTL Software to obtain the license file. Note If the KM license details are invalid or have expired, the parameter NSRLicenseStatus will be set to alert. Configuring the KM User Account Please refer to “Security Requirements” on page 2-8 for details about NSR KM user account and privileges. 1. From the NSR_SETUP instance, select the KM command Configuration => Login. The Login Configuration dialog will be displayed, as shown in Figure 4-5. Figure 4-5 Login Configuration dialog 2. Enter the login details for the operating system and click OK. OTL Software Ltd., Confidential and Proprietary Information Loading and Configuring 4-9 If the default Agent account is used, tick the checkbox Use Agent Default Account in the above Login Configuration dialog Note When the default Agent option is selected, the NSR KM uses the configured Agent account details and values entered in Username and Password fields on the Login Configuration dialog are ignored. On Unix platforms, this option can also be combined either with or without Sudo option If a sudo user account is used, tick the checkbox Use Sudo and verify the sudo binary file path by clicking on Sudo Binary File in the above Login Configuration dialog. Note This sudo user should be configured as described on page 2-11. Note An acknowledgement is displayed when the login information has been loaded, but this is not a confirmation that the details are valid. If the user name or password is invalid, the NSRLoginStatus parameter will be set to “suspicious state” after the next data collection. Warning If login information for the operating system changes, the details must be updated using this dialog. OTL Software Ltd., Confidential and Proprietary Information 4-10 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Verifying Application Discovery 1. In the next full discovery cycle of the Legato NetWorker KM for PATROL (following successful KM licensing and user account configuration), the label of the main container instance will change from NSR_SETUP to Legato NetWorker. This new instance is shown in Figure 4-6. Note Legato NetWorker KM for PATROL discovery can be forced by selecting the KM command Force Discovery from NSR_SETUP. Figure 4-6 NSR KM Console View 2. After this full discovery cycle, all NSR KM collectors will start executing, and other NSR KM application class instances will be instantiated. The initial data collection may take some time (up to half an hour) depending on the complexity of your environment. Figure 4-6 shows the final PATROL Console view. OTL Software Ltd., Confidential and Proprietary Information Loading and Configuring 4-11 Note Legato NetWorker KM for PATROL data collection can be forced by selecting the KM command Refresh Parameters from the Legato NetWorker icon. Note If Legato NetWorker is configured in a VCS cluster (Unix only), select the KM command Configuration => Failover Mode, and enable the NSR KM to failover with the appropriate VCS service group. OTL Software Ltd., Confidential and Proprietary Information 4-12 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Checking the Instance Limits 1. Check the default values for the maximum number of instances for each application class of the NSR KM and determine whether they suit your environment. These values can be viewed and modified on the Legato NetWorker instance using the KM command Configuration => Instance Limits. Figure 4-7 shows the response dialog with the default values. Figure 4-7 NSR KM Default Instance Limits OTL Software Ltd., Confidential and Proprietary Information Loading and Configuring 4-13 2. Select OK if any instance limit is altered. If the new instance limits are loaded successfully, an acknowledgement will be displayed. Warning Increasing the maximum number of application instances may impact the performance of the KM. Tip To revert to the default setting for a particular application class, blank out the relevant field and click OK. Checking the Initial Setup of the KM 1. Check whether the discovered files and directory paths are correct, using the KM command Configuration => Paths from the Legato NetWorker instance. 2. Check whether the discovered Node Type is correct using the KM command Configuration => Node Type from the Legato NetWorker instance. 3. Check the InfoBoxes and Parameters of all the NSR KM instances and verify that they are set correctly. 4. Under each container instance, open all detail parameters (text parameters with names in the format NSRDetails), and check for error messages. 5. Check the new values of parameters NSRLoginStatus and NSRLicenseStatus set after completion of all data collection. If either is not in OK state, open the annotation point to determine the cause of the error. OTL Software Ltd., Confidential and Proprietary Information 4-14 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide 6. After the KM has been running for at least an hour, run the KM command Configuration => KM Status from the Legato NetWorker instance. A report is displayed, detailing information on the managed system and licensing limits. Check through the report for any warnings or alarms. Note If any errors are found during any of the above steps (including any incorrect data in Infoboxes or any warnings or alarms in the KM Status report), determine the cause(s) and take steps to resolve these errors. You may need to refer to “Chapter 5: Working with the KM”, or contact Technical Support at OTL Software, attaching the KM Status report. Note If you are evaluating the KM and wish to purchase a license, send the KM Status report to OTL Software to obtain your licence key. Tip To save the KM Status report as a task window, click Save As Task. This task window can then be printed or saved as a text file. OTL Software Ltd., Confidential and Proprietary Information Loading and Configuring 4-15 Configuring PATROL Agent to Preload the KM 1. In order to enable Legato NetWorker KM for PATROL to operate all the time, without a PATROL Console connection, the KM should be added to the PATROL Agent configuration variable “/AgentSetup/preloadedKMs”. This can be achieved on the Legato NetWorker instance by using the KM command Configuration => Preloading. The KM Preloading dialog will be displayed, as shown in Figure 4-8. Figure 4-8 NSR KM Preloading dialog 2. Select Add to add the KM to the list of preloaded KMs. If the NSR KM is successfully added to the list, an acknowledgement will be displayed. Note The same KM command is used to remove the NSR KM from the preloaded KMs list. Restarting PATROL Agent and PATROL Console It should not be necessary to re-start the PATROL Agent and/or PATROL Console. However, it is a good practice to confirm that OTL Software’s Legato NetWorker KM for PATROL operates correctly after a restart of PATROL Agent and/or PATROL Console. In addition, the PATROL Agent restart will force all KM discoveries and data collections to start immediately. OTL Software Ltd., Confidential and Proprietary Information 4-16 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Unloading the KM This section describes the procedures for unloading (not uninstalling) the NSR KM from the PATROL Agent, PATROL Console or PATROL Central Console. The intention is that this section is only used if you no longer want to use some parts of the KM, though there may be circumstances where you may wish to fully unload the KM without uninstalling the files. Note If you want to completely uninstall the KM, please follow the instructions under “Uninstalling the KM” on page 3-9. If you are attempting to unload the KM in order to upgrade to a later version, please follow the instructions under “Installing the KM” on page 3-5. When the NSR KM is unloaded from a PATROL Agent, PATROL stops monitoring the Legato NetWorker application on that system when there is no connection to a PATROL Console with NSR KM loaded. When the NSR KM is unloaded from PATROL Console, the PATROL Console stops displaying and monitoring the Legato NetWorker application on any PATROL Console connected system. Unloading the KM from the PATROL Agent 1. Remove the NSR KM from the list of preloaded KMs using the KM command Configuration => Preloading from the Legato NetWorker instance. Alternatively, using the utility wpconfig (on MS Windows) or xpconfig (on Unix), remove NSR_LOAD.kml from the PATROL Agent configuration variable “/AgentSetup/preloadedKMs”. 2. Restart the PATROL Agent. 3. Repeat these steps on every PATROL Agent system (managed node) where the NSR KM is to be unloaded. OTL Software Ltd., Confidential and Proprietary Information Loading and Configuring 4-17 Note The NSR KM cannot be partially unloaded from the PATROL Agent using the above steps. If you need to unload some parts of the KM from the PATROL Agent, refer to the PATROL Agent Reference Manual. Unloading the KM from PATROL Console Application classes are unloaded individually. This allows for a partial unloading of the KM to enable it to run as a reduced installation. Follow the steps below to unload the NSR KM completely or partially. 1. Remove the unwanted NSR KM application classes from the list of loaded application classes, as required. All NSR KM application classes start with “NSR_”. On PATROL Console for Unix: A. From the PATROL Console main window choose Attributes => Application Classes... B. Select a NSR KM application class to be removed and choose Edit => Delete. C. Repeat for all classes to be removed. On PATROL Console for MS Windows: A. From the PATROL Console tree view choose the KM tab and expand the folder Application Classes. B. Right-click on a NSR KM application class to be removed and choose Delete. C. Repeat for all classes to be removed. 2. Select File => Save Configuration to save the modified list of loaded application classes as the PATROL Console user preference. 3. Repeat these steps on every PATROL Console system where the NSR KM is to be unloaded. OTL Software Ltd., Confidential and Proprietary Information 4-18 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Unloading the KM from PATROL Central Console A KM can be unloaded for particular managed systems or for all systems across the monitored environment. Application classes may be unloaded individually, or by selecting all classes at once. This allows for a partial unloading of the KM to enable it to run as a reduced installation on some or all of the managed systems. Follow the steps below to completely or partially unload the NSR KM from some or all of the managed systems. 1. Right click on the PATROL Main Map, and choose Unload Knowledge Modules... 2. Select the managed systems where the NSR KM is to be unloaded, and click Next>. A list is displayed showing all the loaded application classes on each of the selected managed systems. All NSR KM application classes start with “NSR_”. 3. Select the NSR KM application classes to be removed for the appropriate managed systems, click Next> and Finish. 4. Repeat the above steps for each PATROL Central Management Profile where the NSR KM is to be unloaded. Where to Go from Here The following table suggests topics that you should read next.. If you want information on... See... How to monitor Legato NetWorker using this KM “Chapter 5: Working with the KM” OTL Software Ltd., Confidential and Proprietary Information Loading and Configuring 4-19 OTL Software Ltd., Confidential and Proprietary Information 4-20 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide 5 Working with the KM 5 This chapter introduces basic tasks in OTL Software’s Legato NetWorker® Knowledge Module® for PATROL®. The following topics are discussed: Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2 Customizing the KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3 Managed Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4 Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7 Daemons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-11 Index Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-15 Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-17 Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-23 Save Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-30 Pending Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-37 Jukeboxes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-42 Standalone Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-51 Volume Pools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-56 Operating the KM. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-58 Generating Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-64 Debugging the KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-65 Working with Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-71 Upgrading the Platform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-73 Getting Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-74 Where to Go from Here . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-75 OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-1 Overview The default behavior of the Legato NetWorker KM for PATROL is outlined in “Objectives of the KM” on page 1-3. Each area of the Legato NetWorker application is addressed to summarize the critical information monitored by the NSR KM. You can either use default configuration, as described in the objectives, or you can customize areas of the KM to better suit the demands of your environment. After loading the NSR KM, a PATROL Classic Console (Developer or Operator) or a PATROL Central Console can be used to make changes as described in “Customizing the KM” on page 5-3. Default NSR KM parameter settings can also be customized. Information on modifying parameters can be found in PATROL documentation. Also refer to “Appendix C: Parameter Definitions and Defaults”. Administrative options and acknowledgement of alerts occurring for save groups, processes and error messages on log files are described in this chapter, in “Operating the KM” on page 5-58. Reports are listed in “Generating Reports” on page 5-64. For a complete listing of all KM commands, including all the configuration options, refer to “Appendix A: KM Commands”. Infobox items are listed and described in “Appendix B: InfoBoxes”. If you experience any problems or unexpected behavior when using the NSR KM, refer to “Appendix D: Troubleshooting”. You may be required to activate the “debugging” feature to record information which may help to identify and resolve any problems. This feature is described in “Debugging the KM” on page 5-65. Note If the KM has not been loaded, refer to “Chapter 4: Loading and Configuring” for procedures on loading the KM. OTL Software Ltd., Confidential and Proprietary Information 5-2 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Customizing the KM Legato NetWorker KM for PATROL can be customized and optimized to suit your Legato NetWorker application environment. This section describes all KM commands available for customizing the NSR KM. These customization menus are accessed from the knowledge module command sub-menu Configuration => from each application instance. Most of these customization menus can be accessed either from the parent container level or from the child instance level. If a customization menu is accessed from the container instance and you make a change, you then have the option to apply this change to all child instances which appear under the selected container in PATROL Console instance topology. If a customization menu is accessed from the child instance, it will only modify the configuration applicable for that instance. Note In the absence of a child instance level configuration, the KM will search for any modified configuration through its topological parent path. If no customized configurations found, the KM will use the default configuration. Tip If a menu command is named Configuration => Client(s), it means that the menu command is available as Configuration => Clients from the parent container instance (client container instance) and Configuration => Client from the child instance (individual client instance). OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-3 Managed Node Customizing Failover Mode Figure 5-1 Failover Mode Configuration dialog The default configuration for KM failover mode is shown in the Failover Mode Configuration dialog in Figure 5-1. If the NSR KM is installed in a VCS clustered Legato NetWorker environment, using this dialog the KM also can be configured to failover with relevant VCS service group responsible for failing over Legato NetWorker application. If enabled, the Legato NetWorker instance on the OFFLINE system will appear in offline state and stop monitoring the Legato NetWorker on that managed node until the Legato NetWorker application fails over. Note The KM failover supports only VCS clusters. Note If NSR KM fails to find a system where the selected service group is ONLINE, it will start monitoring the Legato NetWorker environment from all managed nodes. The Failover Mode Configuration dialog is accessed from the Legato NetWorker instance using the KM command Configuration => Failover Mode. OTL Software Ltd., Confidential and Proprietary Information 5-4 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Customizing Node Status Figure 5-2 Node Status Configuration dialog The default configuration for monitored daemon names for determining the Server/Storage Node status on a Unix platform is shown in the Node Status Configuration dialog in Figure 5-2. The parameter NSRNodeStatus monitors availability of all configured daemons in the above filter. If any configured daemon is not running, this parameter will be set to “failure” (Alarm) state. As a result of this, several recovery actions are initiated. If any command run by Legato NetWorker KM for PATROL returns a server/storage node error message, this parameter will be set to “suspicious” (Warning) state. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-5 The Node Status Configuration dialog is accessed from the Legato NetWorker instance using the KM command Configuration => Node Status. Daemons can be added or removed from the list. Multiple daemons may be entered at the same time, using a comma (,) as a separator. Tip To revert to the shipped default list of monitored daemons (as shown above), type “[default]” as a new daemon for the list and click Update. Note If the NSR_SERVER discovery fails to recognize the node type, it can be configured from the Legato NetWorker instance using the KM command Configuration => Node Type. OTL Software Ltd., Confidential and Proprietary Information 5-6 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Clients Customizing Monitored Clients Figure 5-3 Client Configuration dialog By default, the Legato NetWorker KM for PATROL monitors all clients configured on the server, as shown in the Client Configuration dialog in Figure 5-3. The [ALL] entry ensures that all clients found on a PATROL discovery are instantiated and monitored. This dialog is accessed from the client container instance (labelled Clients) using the KM command Configuration => Clients. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-7 A client can be specifically enabled or disabled for monitoring by adding a new entry to the configuration in the global dialog above, or by accessing the dialog from the particular client instance (using the KM command Configuration => Client). The advantage of specifically listing a client in the configuration is that the client will be instantiated, and therefore monitored, even if it is not automatically discovered. Note Disabled client instances will be instantiated in an OFFLINE state, and their parameters will not be set. Tip To revert to the default client monitoring configuration (as shown above), access this dialog from the client container instance (labelled Clients), type “[default]” as the name of a client for a new entry and click Update. OTL Software Ltd., Confidential and Proprietary Information 5-8 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Customizing Client Status Figure 5-4 Client Status Configuration dialog The Legato NetWorker KM for PATROL checks the state of each monitored client to set the value of parameter NSRClientState. The value of this state parameter is used to determine the value of the status parameter NSRClientStatus according to the client status mapping rule. The default configuration of this mapping rule is displayed in the Client Status Configuration dialog in Figure 5-4. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-9 Note States (or conditional states) considered to indicate “failure” in the state parameter are mapped using the Alarm Filter to a value of 2=Failure in the status parameter. Then states (or conditional states) considered to be “suspicious” are mapped using the Warning Filter to a value of 1=Suspicious in the status parameter. The standard settings for the status parameter are as follows: 0 (OK) is set to OK; 1 (Suspicious) is set to Warning; 2 (Failure) is set to Alarm. To access the Client Status Configuration dialog, use the KM command Configuration => Client(s) Status. The mapping rule can be customized individually for each client instance, or for all clients at once by accessing the dialog from the client container instance (labelled Clients). The Client Status Configuration dialog can be used to add or remove states for either filter. A time condition may be applied for a particular state when added to either filter. Example You may wish to add a state rule to the Warning Filter to warn when the connection has been in unknown status for more than two hours. Select -1 (Unknown) from the State drop-down list, select the Condition > and enter 120 Minutes. Click Update and the following will appear as a new entry in the Warning Filter: “-1 (Unknown) >120 minutes”. Tip To revert to the default client status mapping rule for either filter, select [default] from the list of states and click Update. If you revert to default settings in this dialog when accessed from the client instance level, the settings will revert to those configured at the container or parent instance level. To reset to the shipped default settings (as shown above), access this dialog from the client container instance level. From this level you will also have the option to reset the configuration of any modified child instances. OTL Software Ltd., Confidential and Proprietary Information 5-10 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Daemons Customizing Monitored Daemons Figure 5-5 Daemon Configuration dialog The Legato NetWorker KM for PATROL can monitor all daemons of the Legato NetWorker application, but the default configuration for a Server node is shown in the Daemon Configuration dialog in Figure 5-5. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-11 All listed daemons are instantiated even if they are not automatically discovered. Only those marked as “enabled” are monitored by default; those marked as “disabled” are instantiated in an OFFLINE state. The [ALL] entry line covers any other discovered daemons, ensuring they are also instantiated but disabled from monitoring. The Daemon Configuration dialog above is accessed from the daemon container instance (labelled Daemons) using the KM command Configuration => Daemons. Daemons can be enabled or disabled for monitoring from this dialog, or a new daemon entry can be added to the configuration. The Daemon Configuration dialog can also be accessed from a particular daemon instance using the KM command Configuration => Daemon. When this dialog is used to enable or disable a daemon, the daemon will appear as a specific entry in the main configuration at the container level. Note Disabled daemon instances will be instantiated in an OFFLINE state, and their parameters will not be set. Tip To revert to the default daemon monitoring configuration (as shown above), access this dialog from the daemon container instance (labelled Daemons), type “[default]” as the name of a daemon for a new entry, and click Update. OTL Software Ltd., Confidential and Proprietary Information 5-12 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Customizing Daemon Status Figure 5-6 Daemon Status Configuration dialog The Legato NetWorker KM for PATROL checks the status of each monitored daemon, to set the value of parameter NSRDaemonState. The value of this state parameter is used to determine the value of the status parameter NSRDaemonStatus according to the daemon status mapping rule. The default configuration of this mapping rule is displayed in the Daemon Status Configuration dialog in Figure 5-6. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-13 Note States (or conditional states) considered to indicate “failure” in the state parameter are mapped using the Alarm Filter to a value of 2=Failure in the status parameter. Then states (or conditional states) considered to be “suspicious” are mapped using the Warning Filter to a value of 1=Suspicious in the status parameter. The standard settings for the status parameter are as follows: 0 (OK) is set to OK; 1 (Suspicious) is set to Warning; 2 (Failure) is set to Alarm. To access the Daemon Status Configuration dialog, use the KM command Configuration => Daemon(s) Status. The mapping rule can be customized individually for each daemon instance, or for all daemons at once by accessing the dialog from the daemon container instance (labelled Daemons). The Daemon Status Configuration dialog can be used to add or remove states for either filter. A time condition may be applied for a particular state when added to either filter. Example You may wish to add a state rule to the Warning Filter to warn when a daemon has been waiting for more than two hours. Select 2 (Waiting) from the State drop-down list, select the Condition > and enter 120 Minutes. Click Update and the following will appear as a new entry in the Warning Filter: “2 (Waiting) >120 minutes”. Tip To revert to the default daemon status mapping rule for either filter, select [default] from the list of states and click Update. If you revert to default settings in this dialog when accessed from the daemon instance level, the settings will revert to those configured at the container or parent instance level. To reset to the shipped default settings (as shown above), access this dialog from the daemon container instance level. From this level you will also have the option to reset the configuration of any modified child instances. OTL Software Ltd., Confidential and Proprietary Information 5-14 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Index Databases Customizing Monitored Index Databases Figure 5-7 Database Configuration dialog The default configuration for monitored index databases is displayed in the Database Configuration dialog in Figure 5-7. This dialog is accessed from the database container instance (labelled Databases), using the KM command Configuration => Databases. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-15 The Legato NetWorker KM for PATROL can monitor all Legato NetWorker databases, but the default configuration is to only monitor the databases listed. These databases are instantiated and therefore monitored even if they are not automatically discovered. The [ALL] entry line covers any other discovered databases, ensuring they are instantiated but disabled from monitoring. Databases can be enabled or disabled for monitoring in this dialog, or a new database entry can be added to the configuration. The Database Configuration dialog can also be accessed from a particular database instance using the KM command Configuration => Database. When this dialog is used to enable or disable a database, the database will appear as a specific entry in the main configuration at the container level. Note Disabled database instances will be instantiated in an OFFLINE state, and their parameters will not be set. Tip To revert to the default index database monitoring configuration as shown above, access this dialog from the database container instance (labelled Databases), type “[default]” as the name of a database for a new entry, and click Update. OTL Software Ltd., Confidential and Proprietary Information 5-16 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Log Files Customizing Monitored Log Files Figure 5-8 Log Configuration dialog The default configuration for the Legato NetWorker KM for PATROL to monitor the Legato NetWorker log files and the system log file, as displayed in the Log Configuration dialog in Figure 5-8. This dialog is accessed from the log container instance (labelled Logs), using the KM command Configuration => Logs. The listed log files are always instantiated, and therefore monitored, even if they are not automatically discovered. The [ALL] entry line covers any other discovered Legato NetWorker server/storage node log files under the INSTALL_PATH/logs (files in the format *.log), ensuring they are instantiated but disabled from monitoring. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-17 Note On AIX and NT platforms, there is no ASCII format system log file to monitor, so the default is for the KM to monitor only the daily messages file. Note Disabled log file instances will be instantiated in an OFFLINE state, and their parameters will not be set. A log file can be enabled (or disabled) for monitoring by adding a new entry to the configuration in the global dialog above, or by accessing the dialog from the particular log instance (using the KM command Configuration => Log). When this dialog is used to enable (or disable) a log file, the log file will appear as a specific entry in the main configuration at the container level. Note If you enable a log file for monitoring, you must specifically configure the log filter with appropriate expressions. Refer to “Customizing Log Error Filter” on page 5-19 for more information. Tip To revert to the default log file monitoring configuration as shown above, access this dialog from the log container instance (labelled Logs), type “[default]” as the name of a log file for a new entry, and click Update. The NSR KM scans log files by reading the new log entries since the last data collection cycle. The NSR KM imposes a limit on the amount of data that may be scanned per log file during each data collection cycle. By default, this Log Scan Limit is set at 5KBytes, but can be modified using the KM command Configuration => Log(s) Scan Limit. Warning Increasing the Log Scan Limit may affect the performance of the data collector (NSRLogCollector). OTL Software Ltd., Confidential and Proprietary Information 5-18 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Customizing Log Error Filter Figure 5-9 Log Filter Configuration dialog The Legato NetWorker KM for PATROL checks for particular error expressions in the log data scanned in each data collection cycle and written to NSRLogText. When any of these expressions is detected, the message containing the expression will be written to one of the text parameters NSRLogAlarmText or NSRLogWarningText, as appropriate. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-19 These expressions and their severity are determined according to the mapping of error expressions in the log filter configuration. The default mapping is displayed in the Log Filter Configuration dialog in Figure 5-9. This default configuration does not include any “excluded” expressions, but the functionality exists to customize the filter if another unwanted message is selected. Note For an explanation of the possible error messages in the log files, refer to the Legato NetWorker System Administrator’s Guide and the Legato NetWorker Error Message Guide. Note Messages containing expressions considered to be “suspicious” in the NSRLogText parameter are mapped using the Warning Filter to be written to the parameter NSRLogWarningText. This increments the value of parameter NSRLogWarningCount, which is automatically set to warning if the value is 1 or above. Similarly, messages containing expressions considered to indicate “failure” are mapped using the Alarm Filter to be written to NSRLogAlarmText, which in turn increments NSRLogAlarmCount causing it to alarm at a value of 1 or above. Messages containing expressions listed in either filter and also containing an “excluded” expression for that filter, are ignored. Note The regular expressions in the log filter are case-sensitive. To access the Log Filter Configuration dialog, use the KM command Configuration => Log(s) Filter. The mapping of the error expressions can be customized individually for a log file instance, or for all log files at once by accessing the dialog from the log container instance (labelled Logs). OTL Software Ltd., Confidential and Proprietary Information 5-20 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Expressions can be added or removed from each filter. The radio button Include is highlighted by default when adding a new expression. The functionality to “exclude” one or more expressions can be used on either filter to exclude certain messages from the warning or alarm parameters, which have already been detected using the “include” expressions. Example To avoid alarms occurring for messages concerning a particular client (otlsol01), enter the client name as an expression in the Alarm Filter, select the Expression Type as Exclude, and click Update. The following will appear as an entry in the Alarm Filter: “exclude:otlsol01”. Instead you could limit the exclusion to a particular expression already listed by using standard wildcard syntax, such as “warning .∗ otlsol01”. Since the default configuration for logs in the NSR KM is to only monitor the Legato NetWorker progress and completion messages files and the system log file, the default log filter is configured accordingly. If you enable any additional log files for monitoring (described in “Customizing Monitored Log Files” on page 5-17), you will need to customize the log filter by adding appropriate expressions for those log files. This can be done at either the parent or child level. Tip To revert to the default settings for either filter, type “[default]” as a new error expression for that filter, and click Update. If you revert to the default when accessed from the log instance level, the settings will revert to the parent or container instance level. To revert to the shipped default settings (as shown above), access this dialog from the log container instance. From this level you will also have the option to reset the configuration of any modified child instances. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-21 Customizing Log Alert Acknowledgement Figure 5-10 Log Alert Acknowledgement Configuration dialog By default, the Legato NetWorker KM for PATROL automatically acknowledges previous log alerts when it detects new errors. Figure 5-10 shows the default settings in the Log Alert Acknowledgement Configuration dialog. This dialog can be accessed using the KM command Configuration => Log(s) Alert Acknowledgement. The method of log alert acknowledgement can be changed for individual log file instances or for all log files at once at the log container instance level (labelled Logs). Warning For the manual acknowledgement method, if log alerts are not acknowledged regularly, the size of the parameters NSRLogAlarmText and NSRLogWarningText will increase cumulatively. This increase in size may affect performance of the KM and the PATROL Agent. OTL Software Ltd., Confidential and Proprietary Information 5-22 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Groups Customizing Monitored Groups Figure 5-11 Group Configuration dialog By default, the Legato NetWorker KM for PATROL monitors all groups configured on the server. This is shown in the Group Configuration dialog in Figure 5-11. The [ALL] entry ensures that all groups found on a PATROL discovery are instantiated and monitored. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-23 Note This configuration directly impacts what save group instances are instantiated and monitored by the NSR KM. Only save groups that belong to group instances, which are configured to be monitored through Group Configuration dialog in Figure 5-11, will in turn be instantiated under Save Groups container and be monitored. By default, NSR KM monitors all groups and thus save groups configured on the server. Tip To disable this direct relationship between monitored groups configuration and monitored save groups instances, run the following PSL through PATROL Console: %PSL pconfig("REPLACE","/NSR/FilterJobByPolicy", false); This dialog is accessed from the group container instance (labelled Groups) using the KM command Configuration => Groups. A group can be specifically enabled or disabled for monitoring by adding a new entry to the configuration in the global dialog above, or by accessing the dialog from the particular group instance (using the KM command Configuration => Group. The advantage of specifically listing a group in the configuration is that the group will be instantiated, and therefore monitored, even if it is not automatically discovered. Note Disabled group instances will be instantiated in an OFFLINE state, and their parameters will not be set. Tip To revert to the default group monitoring configuration (as shown above), access this dialog from the group container instance (labelled Groups), type “[default]” as the name of a group for a new entry and click Update. OTL Software Ltd., Confidential and Proprietary Information 5-24 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Customizing Group Backup Restriction Figure 5-12 Group Backup Restriction Window dialog A restriction window can be configured for group backups using the KM command Configuration => Group (s) Backup Restriction. By default, the restriction window is disabled, as shown in the Group Backup Restriction Window dialog in Figure 5-12. When the restriction window is enabled, if there is any backup activity during the specified period, the parameter NSRGroupState will be set to the value 2 (Running in Restricted Window). According to the default group status mapping rule (described on page 5-26) this will trigger an alarm on the parameter NSRGroupStatus. The restriction window can be customized individually for each group instance, or for all groups at once by accessing the dialog from the group container instance (labelled Groups). OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-25 Note If changes have already been made at the group instance level, you can reset the individual settings to a global configuration by accessing the dialog from the container instance; when closing the dialog after updating for a new customisation at this level, you will have the option to reset individual configurations. Customizing Group Status Figure 5-13 Group Status Configuration dialog OTL Software Ltd., Confidential and Proprietary Information 5-26 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide The Legato NetWorker KM for PATROL checks the state of each monitored group, to set the value of parameter NSRGroupState. The value of this state parameter is used to determine the value of the status parameter NSRGroupStatus according to the group status mapping rule. The default configuration of this mapping rule is displayed in the Group Status Configuration dialog in Figure 5-13. Note States (or conditional states) considered to indicate “failure” in the state parameter are mapped using the Alarm Filter to a value of 2=Failure in the status parameter. Then states (or conditional states) considered to be “suspicious” are mapped using the Warning Filter to a value of 1=Suspicious in the status parameter. The standard settings for the status parameter are as follows: 0 (OK) is set to OK; 1 (Suspicious) is set to Warning; 2 (Failure) is set to Alarm. To access the Group Status Configuration dialog, use the KM command Configuration => Group(s) Status. The mapping rule can be customized individually for each group instance, or for all groups at once by accessing the dialog from the group container instance (labelled Groups). The Group Status Configuration dialog can be used to add or remove states for either filter. A time condition may be applied for a particular state when added to either filter. Example You may wish to amend the rule that appears in the default Warning Filter (in Figure 5-13) to warn when a backup has been running on a group for more than two hours, rather than the default of ten hours. Select 1 (Running) from the State drop-down list, select the Condition > and enter 120 Minutes. Click Update and the following will appear as a new entry in the Warning Filter: “1 (Running) >120 minutes”. The original rule “1 (Running) >600 minutes” can be removed by selecting the entry line and clicking Update. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-27 Tip To revert to the default group status mapping rule for either filter, select [default] from the list of states and click Update. If you revert to default settings in this dialog when accessed from the group instance level, the settings will revert to those configured at the container or parent instance level. To reset to the shipped default settings (as shown above), access this dialog from the group container instance level. From this level you will also have the option to reset the configuration of any modified child instances. Customizing Monitored Group Clients Figure 5-14 Group Client Configuration dialog OTL Software Ltd., Confidential and Proprietary Information 5-28 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide By default, the Legato NetWorker KM for PATROL monitors all group clients of each monitored group, as shown in the Group Client Configuration dialog in Figure 5-14. The [ALL] entry ensures that all group clients found on a PATROL discovery are instantiated and monitored. This dialog can be accessed from each group instance using the KM command Configuration => Group Clients. A group client can be specifically enabled or disabled for monitoring by adding a new entry to the configuration in the global dialog above, or by accessing the dialog from the particular group client instance (using the KM command Configuration => Group Client). The advantage of specifically listing a group client in the configuration is that the group client will be instantiated, and therefore monitored, even if it is not automatically discovered. Note Disabled group client instances will be instantiated in an OFFLINE state, and their parameters will not be set. Tip To revert to the default group client monitoring configuration (as shown above) for a particular group, access this dialog from the group instance, type “[default]” as the name of a group client for a new entry and click Update. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-29 Save Groups Customizing Monitored Save Groups Figure 5-15 Save Group Filter Configuration dialog By default, the Legato NetWorker KM for PATROL monitors all scheduled save groups that completed successfully for 1day and any other scheduled save group for 3days, as shown in the Save Group Filter Configuration dialog in Figure 5-15. Note Any cutomization on monitored groups configuration directly impacts what save group instances are instantiated and monitored by the NSR KM. Only save groups that belong to group instances, which are configured to be monitored through Group Configuration dialog in Figure 5-11, will in turn be instantiated and monitored. By default, NSR KM monitors all groups and thus save groups, which meet the save group filter conditions configured through Save Group Filter Configuration dialog in Figure 5-15. OTL Software Ltd., Confidential and Proprietary Information 5-30 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Tip To disable this direct relationship between monitored groups configuration and monitored save groups instances to ensure all scheduled save groups are instantiated and monitored by NSR KM, run the following PSL through PATROL Console: %PSL pconfig("REPLACE","/NSR/FilterJobByPolicy", false); The status of a save group refers to the value of parameter NSRSaveGrpStatus, which is determined by the state of the job (from the parameter NSRSaveGrpState) and the save group status mapping rule (described in “Customizing Save Group Status” on page 5-32). The age of a save group, calculated from the save group start time, is used to determine whether a save group is older than the appropriate period for monitoring. Save Groups that started within that period will be instantiated and monitored. Note Older save groups will not be instantiated and will therefore not appear on the PATROL Console. For a save group already instantiated, the age will be recalculated at the next data collection cycle; if it is then older than the appropriate period for monitoring, it will be destroyed from the PATROL Console. The specified periods for save group monitoring can be viewed and customized using the KM command Configuration => Save Groups, accessed from the save group container instance (labelled Save Groups). Note If a period for monitoring is decreased, any applicable save group older than the new period will be destroyed on the next data collection cycle. If a period is increased, a full data collection must be forced to ensure all applicable save groups are instantiated. Use the KM command Force Full Collection from the Save Groups container instance, or if the Save Groups container instance is not instantiated, the PATROL Agent needs to be restarted. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-31 Note All active save groups are exempted from ageing, by default. I.e. save groups which are in one of the active states (In Progress, or In Progress/Errors) are always monitored. Customizing Save Group Status Figure 5-16 Save Group Status Configuration dialog OTL Software Ltd., Confidential and Proprietary Information 5-32 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide The Legato NetWorker KM for PATROL checks the state of each monitored save group to set the value of the parameter NSRSaveGrpState. The value of this state parameter is used to determine the value of the status parameter NSRSaveGrpStatus according to the save group status mapping rule. The default configuration of this mapping rule is displayed in Figure 5-16.bb Note States (or conditional states) considered to indicate “failure” in the state parameter are mapped using the Alarm Filter to a value of 2=Failure in the status parameter. Then states (or conditional states) considered to be “suspicious” are mapped using the Warning Filter to a value of 1=Suspicious in the status parameter. The standard settings for the status parameter are as follows: 0 (OK) is set to OK; 1 (Suspicious) is set to Warning; 2 (Failure) is set to Alarm. This mapping rule applies for all monitored save groups. Access the Save Group Status Configuration dialog from the save group container instance (labelled Save Groups), using the KM command Configuration => Save Groups Status. This dialog can be used to add or remove states for either filter. A time condition may also be applied for a particular state when added to either filter. Example You may wish to amend the rule that appears in the default Warning Filter (in Figure 5-16) to warn when a save group has been in progress for more than 10 hours, rather than the default of 5 hours. Select 1 (In Progress) from the State drop-down list, select the Condition > and enter 600 Minutes. Click Update and the following will appear as a new entry in the Warning Filter: “1 (In Progress) >600 minutes”. The original rule “1 (In Progress) >300 minutes” can be removed by selecting the entry line and clicking Update. Tip To revert to the shipped default for either filter in the save group status mapping rule (as shown in Figure 5-16 above), select [default] from the list of states and click Update. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-33 Customizing Save Group Date/Time Format Figure 5-17 Save Group Date/Time Format Configuration dialog The Legato NetWorker KM for PATROL uses Legato NetWorker commands to determine the date and time of each save group (used for calculating the elapsed time since the save group was initiated). Depending on your local system time zone and date/time format, the application may return a different date/time format. OTL Software Ltd., Confidential and Proprietary Information 5-34 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide The date/time format and time zone are specified in the Save Group Date/Time Format Configuration dialog. This dialog can be modified from the save group container instance (labelled Save Groups) using the KM command Configuration => Save Groups Date/Time Format. The default configuration is displayed in Figure 5-17. Note This dialog sets the configuration for all save groups. It is only available at the container level, not for individual save group instances. Tip To revert to the default settings, blank out the Date/Time field and/or the Time Zone field and click OK. Note If the Time Zone field displays as an empty field (as in the dialog above), then the default is the local time zone on the managed node. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-35 Customizing SaveSet Error Event Contents Figure 5-18 SaveSet Error Event Contents Configuration dialog Standard SaveSet error event will report only the save group name and the completion status. Additional error details can be included by using this configuration menu. By default, only failed clients details are included in SaveSet error events that are triggered from NSRSaveSetErrorFound parameter (as shown above in Figure 5-18). However, the following SaveSet error event contents options are available. • • • • The None option - no failed client or suspicious SaveSet details will be reported in SaveSet error events. The Client Details option - reports failed client details. The SaveSet Details - reports suspicious SaveSet details. The Both option - reports on both failed client and suspicious SaveSet details. Warning Sending failed client &/or suspicious SaveSet details in SaveSet error events may potentially contain vast amount of data. All adverse impacts of such huge event contents should be considered when configuring the SaveSet event content option. OTL Software Ltd., Confidential and Proprietary Information 5-36 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Pending Requests Customizing Monitored Pending Requests Figure 5-19 Pending Request Filter Configuration dialog By default, the Legato NetWorker KM for PATROL monitors all pending requests for 1day as shown in the Pending Request Filter Configuration dialog in Figure 5-19. The age of a pending request, calculated from the pending request time, is used to determine whether a pending request is older than the configured period for monitoring. Requests that are not pending but started within that period will not be removed from the console. The specified periods for pending request monitoring can be viewed and customized using the KM command Configuration => Pending Requests, accessed from the pending request container instance (labelled Pending Requests). Note If a period for monitoring is decreased, any applicable pending request older than the new period will be destroyed on the next data collection cycle. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-37 Customizing Pending Request Status Figure 5-20 Pending Request Status Configuration dialog The Legato NetWorker KM for PATROL checks the state of each monitored pending request to set the value of the parameter NSRRequestState. The value of this state parameter is used to determine the value of the status parameter NSRRequestStatus according to the pending request status mapping rule. The default configuration of this mapping rule is displayed in Figure 5-20. OTL Software Ltd., Confidential and Proprietary Information 5-38 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Note States (or conditional states) considered to indicate “failure” in the state parameter are mapped using the Alarm Filter to a value of 2=Failure in the status parameter. Then states (or conditional states) considered to be “suspicious” are mapped using the Warning Filter to a value of 1=Suspicious in the status parameter. The standard settings for the status parameter are as follows: 0 (OK) is set to OK; 1 (Suspicious) is set to Warning; 2 (Failure) is set to Alarm. This mapping rule applies for all monitored pending requests. Access the Pending Request Status Configuration dialog from the pending request container instance (labelled Pending Requests), using the KM command Configuration => Pending Requests Status. This dialog can be used to add or remove states for either filter. A time condition may also be applied for a particular state when added to either filter. Example You may wish to amend the rule that appears in the default Warning Filter (in Figure 5-20) to warn when a pending request has been pending for more than 1 hour, rather than the default of alerting immediately. Select 1 (Pending) from the State drop-down list, select the Condition > and enter 60 Minutes. Click Update and the following will appear as a new entry in the Warning Filter: “1 (Pending) >60 minutes”. The original rule “1 (Pending)” can be removed by selecting the entry line and clicking Update. Tip To revert to the shipped default for either filter in the pending request status mapping rule (as shown in Figure 5-20 above), select [default] from the list of states and click Update. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-39 Customizing Pending Request Date/Time Format Figure 5-21 Pending Request Date/Time Format Configuration dialog The Legato NetWorker KM for PATROL uses Legato NetWorker commands to determine the date and time of each pending request (used for calculating the elapsed time since the pending request was issued). Depending on your local system time zone and date/time format, the application may return a different date/time format. OTL Software Ltd., Confidential and Proprietary Information 5-40 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide The date/time format and time zone are specified in the Pending Request Date/Time Format Configuration dialog. This dialog can be modified from the pending request container instance (labelled Pending Requests) using the KM command Configuration => Pending Request Date/Time Format. The default configuration is displayed in Figure 5-21. Note This dialog sets the configuration for all pending requests. It is only available at the container level, not for individual pending request instances. Tip To revert to the default settings, blank out the Date/Time field and/or the Time Zone field and click OK. Note If the Time Zone field displays as an empty field (as in the dialog above), then the default is the local time zone on the managed node. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-41 Jukeboxes Customizing Monitored Jukeboxes Figure 5-22 Jukebox Configuration dialog When installed on a Server, the default configuration of the Legato NetWorker KM for PATROL is to monitor all discovered local and remote jukeboxes. This is covered by the [ALL] entry in the default configuration on a Server, shown in the Jukebox Configuration dialog in Figure 5-22. When installed on a Storage Node, the default configuration monitors only the discovered local jukeboxes. This is covered by the [LOCAL] entry in the default configuration on a Storage Node. OTL Software Ltd., Confidential and Proprietary Information 5-42 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide This dialog is accessed from the jukebox container instance (labelled Jukeboxes) using the KM command Configuration => Jukebox(es). A jukebox can be specifically enabled or disabled for monitoring by adding a new entry to the configuration in the global dialog above, or by accessing the dialog from the particular jukebox instance (using the KM command Configuration => Jukebox). The advantage of specifically listing a jukebox in the configuration is that the jukebox will be instantiated, and therefore monitored, even if it is not automatically discovered. Note Disabled jukebox instances will be instantiated in an OFFLINE state, and their parameters will not be set. Tip To revert to the default jukebox monitoring configuration (as shown above), access this dialog from the jukebox container instance (labelled Jukeboxes), type “[default]” as the name of a jukebox for a new entry, and click Update. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-43 Customizing Jukebox Status Figure 5-23 Jukebox Status Configuration dialog The Legato NetWorker KM for PATROL checks the state of each monitored jukebox to set the parameter NSRJukeboxState. The value of this state parameter is used to determine the value of the status parameter NSRJukeboxStatus according to the jukebox status mapping rule. The default configuration of this mapping rule is displayed in the Jukebox Status Configuration dialog in Figure 5-23. OTL Software Ltd., Confidential and Proprietary Information 5-44 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Note States (or conditional states) considered to indicate “failure” in the state parameter are mapped using the Alarm Filter to a value of 2=Failure in the status parameter. Then states (or conditional states) considered to be “suspicious” are mapped using the Warning Filter to a value of 1=Suspicious in the status parameter. The standard settings for the status parameter are as follows: 0 (OK) is set to OK; 1 (Suspicious) is set to Warning; 2 (Failure) is set to Alarm. To customize the mapping rule for a particular jukebox, access the Jukebox Status Configuration dialog from that instance using the KM command Configuration => Jukebox Status. The mapping rule can also be customized for all jukeboxes at once by accessing the dialog from the jukebox container instance (labelled Jukeboxes). The Jukebox Status Configuration dialog can be used to add or remove states for either filter. A time condition may be applied for a particular state when added to either filter. Example You may wish to modify the default state rule in the Alarm Filter to set the parameter to “failure” when a jukebox has been offline (disabled) for more than two hours; otherwise it could be set to “suspicious”. Select 2 (Disabled) from the State drop-down list in the Alarm Filter, select the Condition > and enter 120 Minutes. Click Update to accept all these changes and the following will appear as new entry in the Alarm Filter: “2 (Disabled) >120 minutes”. Click Close for these changes to take effect. Tip To revert to the default jukebox status mapping rule for either filter, select [default] from the list of states and click Update. If you revert to default settings in this dialog when accessed from the jukebox instance level, the settings will revert to those configured at the container or parent instance level. To reset to the shipped default settings (as shown above), access this dialog from the jukebox container instance level. From this level you will also have the option to reset the configuration of any modified child instances. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-45 Customizing Monitored Jukebox Devices Figure 5-24 Jukebox Device Configuration dialog By default, the Legato NetWorker KM for PATROL monitors all jukebox devices of each monitored jukebox, as shown in the Jukebox Device Configuration dialog in Figure 5-24. The [ALL] entry ensures that all jukebox devices found on a monitored jukebox are instantiated and monitored. This dialog can be accessed from each jukebox instance using the KM command Configuration => Jukebox Device(s). OTL Software Ltd., Confidential and Proprietary Information 5-46 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide A jukebox device can be specifically enabled or disabled for monitoring by adding a new entry to the configuration in the jukebox dialog above, or by accessing the dialog from the particular jukebox device instance (using the KM command Configuration => Jukebox Device). The advantage of specifically listing a jukebox device in the configuration is that the jukebox device will be instantiated, and therefore monitored, even if it is not automatically discovered. Note Disabled jukebox device instances will be instantiated in an OFFLINE state, and their parameters will not be set. Tip To revert to the default jukebox device monitoring configuration (as shown above) for a particular jukebox, access this dialog from the jukebox instance, type “[default]” as the name of a jukebox device for a new entry and click Update. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-47 Customizing Jukebox Device Status Figure 5-25 Jukebox Device Status Configuration dialog The Legato NetWorker KM for PATROL checks the state of each monitored jukebox device to set the value of parameter NSRJDeviceState. The value of this state parameter is used to determine the value of the status parameter NSRJDeviceStatus according to the jukebox device status mapping rule. The default configuration of this mapping rule is displayed in the Jukebox Device Status Configuration dialog in Figure 5-25. OTL Software Ltd., Confidential and Proprietary Information 5-48 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Note States (or conditional states) considered to indicate “failure” in the state parameter are mapped using the Alarm Filter to a value of 2=Failure in the status parameter. Then states (or conditional states) considered to be “suspicious” are mapped using the Warning Filter to a value of 1=Suspicious in the status parameter. The standard settings for the status parameter are as follows: 0 (OK) is set to OK; 1 (Suspicious) is set to Warning; 2 (Failure) is set to Alarm. The Jukebox Device Status Configuration dialog can be accessed at three levels to allow the mapping rule to be customized: • individually for a particular jukebox device by accessing the dialog from the device instance, using the KM command Configuration => Jukebox Device Status • for all jukebox devices on a jukebox by accessing the dialog from the jukebox instance, using the KM command Configuration => Jukebox Devices Status • for all jukebox devices on all jukeboxes at once by accessing the dialog from the jukebox container instance (labelled Jukeboxes), using the KM command Configuration => Jukebox Devices Status The Jukebox Device Status Configuration dialog can be used to add or remove states for either filter. A time condition may be applied for a particular state when added to either filter. Example You may wish to amend the rule that appears in the default Warning Filter (in Figure 5-25) to warn when a jukebox device has been “Disabled” for more than two hours, rather than the default. Select 2 (Disabled) from the State drop-down list, select the Condition > and enter 120 Minutes. Click Update and the following will appear as a new entry in the Warning Filter: “2 (Disabled) >120 minutes”. The original rule “2 (Disabled)” can be removed by selecting the entry line and clicking Update. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-49 Tip To revert to the default jukebox device status mapping rule for either filter, select [default] from the list of states and click Update. If you revert to default settings in this dialog when accessed from the jukebox device instance level, the settings will revert to those configured at the container or parent instance level. To reset to the shipped default settings (as shown above), access this dialog from the jukebox container instance level. From this level you will also have the option to reset the configuration of any modified child instances. OTL Software Ltd., Confidential and Proprietary Information 5-50 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Standalone Devices Customizing Monitored Standalone Devices Figure 5-26 Standalone Device Configuration dialog When installed on a Server, the default configuration of the Legato NetWorker KM for PATROL is to monitor all discovered local and remote standalone devices. This is covered by the [ALL] entry in the default configuration on a Server, shown in the Standalone Device Configuration dialog in Figure 5-26. When installed on a Storage Node, the default configuration monitors only the discovered local standalone devices. This is covered by the [LOCAL] entry in the default configuration on a Storage Node. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-51 This dialog is accessed from the standalone device container instance (labelled Standalone Devices) using the KM command Configuration => Standalone Devices. A standalone device can be specifically enabled or disabled for monitoring by adding a new entry to the configuration in the global dialog above, or by accessing the dialog from the particular standalone device instance (using the KM command Configuration => Standalone Device). The advantage of specifically listing a standalone device in the configuration is that the device will be instantiated, and therefore monitored, even if it is not automatically discovered. Note Disabled standalone device instances will be instantiated in an OFFLINE state, and their parameters will not be set. Tip To revert to the default standalone device monitoring configuration (as shown above), access this dialog from the standalone device container instance (labelled Standalone Devices), type “[default]” as the name of a standalone device for a new entry, and click Update. OTL Software Ltd., Confidential and Proprietary Information 5-52 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Customizing Standalone Device Status Figure 5-27 Standalone Device Status Configuration dialog The Legato NetWorker KM for PATROL checks the state of each monitored standalone device to set the parameter NSRDeviceState. The value of this state parameter is used to determine the value of the status parameter NSRDeviceStatus according to the standalone device status mapping rule. The default configuration of this mapping rule is displayed in the Standalone Device Status Configuration dialog in Figure 5-27. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-53 Note States (or conditional states) considered to indicate “failure” in the state parameter are mapped using the Alarm Filter to a value of 2=Failure in the status parameter. Then states (or conditional states) considered to be “suspicious” are mapped using the Warning Filter to a value of 1=Suspicious in the status parameter. The standard settings for the status parameter are as follows: 0 (OK) is set to OK; 1 (Suspicious) is set to Warning; 2 (Failure) is set to Alarm. To access the Standalone Device Status Configuration dialog, use the KM command Configuration => Standalone Device(s) Status. The mapping rule can be customized individually for each standalone device instance, or for all standalone devices at once by accessing the dialog from the standalone device container instance (labelled Standalone Devices). The Standalone Device Status Configuration dialog can be used to add or remove states for either filter. A time condition may also be applied for a particular state when added to either filter. Example You may wish to amend the rule that appears in the default Warning Filter (in Figure 5-27) to warn when a standalone device has been “Disabled” for more than half an hour, rather than the default. Select 2 (Disabled) from the State drop-down list, select the Condition > and enter 120 Minutes. Click Update and the following will appear as a new entry in the Warning Filter: “2 (Disabled) >120 minutes”. The original rule “2 (Disabled)” can be removed by selecting the entry line and clicking Update. OTL Software Ltd., Confidential and Proprietary Information 5-54 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Tip To revert to the default standalone device status mapping rule for either filter, select [default] from the list of states and click Update. If you revert to default settings in this dialog when accessed from the standalone device instance level, the settings will revert to those configured at the container or parent instance level. To reset to the shipped default settings (as shown above), access this dialog from the standalone device container instance level. From this level you will also have the option to reset the configuration of any modified child instances. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-55 Volume Pools Customizing Monitored Volume Pools Figure 5-28 Volume Pool Configuration dialog By default, the Legato NetWorker KM for PATROL monitors all volume pools configured on the server/storage node. This is shown in the Volume Pool Configuration dialog in Figure 5-28. The [ALL] entry ensures that all other volume pools found on a PATROL discovery are instantiated and monitored. OTL Software Ltd., Confidential and Proprietary Information 5-56 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide This dialog is accessed from the volume pool container instance (labelled Volume Pools) using the KM command Configuration => Volume Pools. A volume pool can be specifically enabled or disabled for monitoring by adding a new entry to the configuration in the global dialog above, or by accessing the dialog from the particular volume pool instance (using the KM command Configuration => Volume Pool). The advantage of specifically listing a volume pool in the configuration is that the volume pool will be instantiated, and therefore monitored, even if it is not automatically discovered. Note Disabled volume pool instances will be instantiated in an OFFLINE state, and their parameters will not be set. Tip To revert to the default volume pool monitoring configuration (as shown above), access this dialog from the volume pool container instance (labelled Volume Pools), type “[default]” as the name of a volume pool for a new entry and click Update. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-57 Operating the KM This section describes day-to-day operational tasks of the Legato NetWorker KM for PATROL, including: • • • administrative operations generation of various application reports acknowledgement of alerts These operations can be performed using KM commands under sub-menus Administration, Reports and Acknowledgement respectively. The following points should be noted in relation to these sub-menus: • An annotation point will be added to the relevant parameter when executing any KM command available under sub-menus Administration and Acknowledgement. • When an alert is acknowledged using the KM commands available under the sub-menu Acknowledgement, it will stay acknowledged even after restarting the PATROL Agent. • All KM commands under sub-menus Administration and Reports require a privileged operating system user account to carry out the operation. Note If a KM command uses a sudo privileged user account, then the user account should match the configured PATROL Console user, specified in => Properties... under the tab Security. OTL Software Ltd., Confidential and Proprietary Information 5-58 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Administering Server/Storage Node Figure 5-29 Server/Storage Node Administration sub-menu The Legato NetWorker KM for PATROL provides secure server administration menus, which can be executed by PATROL Console users, if they have appropriate privileges. Figure 5-29 illustrates how to access the administrative KM commands available on the server or storage node from PATROL Console: • • Administration => Start Server/Storage Node Administration => Stop Server/Storage Node OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-59 Acknowledging Log Alerts When an error is detected in a monitored log file, it will appear under one of the text parameters NSRLogAlarmText or NSRLogWarningText. This will trigger an Alarm or a Warning on parameter NSRLogAlarmCount or NSRLogWarningCount, respectively. These alerts can be acknowledged automatically (by default) or manually. Refer to “Customizing Log Alert Acknowledgement” on page 5-22 to change the method of acknowledgement to manual. Tip When the method of acknowledgement is set to automatic, you can still use these menu commands to clear alerts, rather than waiting for the automatic cycle. Figure 5-30 Log Alert Acknowledgement sub-menu OTL Software Ltd., Confidential and Proprietary Information 5-60 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Figure 5-30 illustrates how to access the Log Alert Acknowledgement sub-menu from any log file instance, allowing you to view and acknowledge alerts as follows: • Use the KM command Acknowledgement => Warnings to view, select and acknowledge errors individually in the text parameter NSRLogWarningText. • Use the KM command Acknowledgement => Alarms to view, select and acknowledge errors individually in text parameter or NSRLogAlarmText. • To acknowledge all alerts (Warnings and Alarms) at once without viewing, use the KM command Acknowledgement => All. Acknowledging Save Group Alerts For a particular save group instance, if the NSRSaveGrpStatus has a value of 1=Suspicious or 2=Failure, it will be set to alert with a status of Warning or Alarm respectively. These alerts can be acknowledged using the KM command Acknowledgement => Alert from the relevant save group instance. An acknowledgement sub-menu is also available from the save group container instance (labelled Save Groups) allowing you to view and acknowledge alerts for all save groups at once as follows: • Use the KM command Acknowledgement => Warnings to view and acknowledge alerts for all save groups with a status of Warning. • Use the KM command Acknowledgement => Alarms to view and acknowledge alerts for all save groups with a status of Alarm. • To view and acknowledge all save group alerts at once (Warnings and Alarms), use the KM command Acknowledgement => All. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-61 Administering Pending Requests When a pending request appears, its parameter NSRRequestStatus is immediately set to alert (Warning or Alarm depending on the elapsed time). When a pending request appears on a standalone device, requested tape needs to be loaded in to the standalone device, and mounted. This mount operation can be performed using the KM commands from the relevant device instance as follows: • Administration => Mount Tape Figure 5-31 shows how to access the standalone device administration menus from the standalone device instance. Administering Standalone Devices Figure 5-31 Standalone Device Administration sub-menu OTL Software Ltd., Confidential and Proprietary Information 5-62 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Figure 5-31 illustrates how to access the Standalone Device Administration sub-menu from the standalone device instance. The available KM commands are: • • • • Administration => Mount Tape Administration => Unmount Tape Administration => Enable Device Administration => Disable Device When the appropriate KM command is accessed from a particular standalone device instance, the tape loaded in that standalone device can be Mounted/Unmounted or that standalone device can be Enabled/Disabled, respectively. Administering Jukebox Devices Similarly, when the appropriate KM command is accessed from a particular jukebox device instance, that device can be Enabled or Disabled, respectively. Note Administration menus for mounting or unmounting tapes on jukebox devices are not available, where mounting or unmounting tapes on devices are automatic. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-63 Generating Reports Following is a list of reports available in the Legato NetWorker KM for PATROL. • Daemons => Reports => Daemon List - lists all running Legato NetWorker daemons • Databases => Reports => Database Backup Information - reports information about the previous index database backups • Logs => Reports => Messages List - reports all recent messages logged • Pending Requests => Reports => Pending Requests - reports a list of all pending requests • => Reports => Jukebox Contents - reports the contents of the selected jukebox instance • => Reports => Volumes List - reports information on all volumes in the selected volume pool instance Tip To save the report as a task window click Save As Task. This task window can then be printed or saved as a text file. OTL Software Ltd., Confidential and Proprietary Information 5-64 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Debugging the KM This section describes the steps for enabling and disabling the debug feature for the Legato NetWorker KM for PATROL. This feature produces an output that can help you identify unexplained behavior and may be requested by OTL Software to diagnose and resolve any problems with the KM. Enable (and Disable) KM Debug Mode Step 1 Select the KM menu command Configuration => Debug from the main NSR KM container instance (labelled Legato NetWorker or NSR_SETUP). The NSR KM Debug Configuration dialog will be displayed, as shown in Figure 5-32. Figure 5-32 NSR KM Debug Configuration dialog OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-65 Step 2 Click On for the debug switch(es) you want to enable. Table 5-1 shows the application classes and collector parameters included in the debug switch for each object. Table 5-1 NSR KM Object Debug Switch Association Object Debug Switch Application Classes Collector Parameters Server NSR_SERVER NSRCreateDistribution NSRRemoveTempFiles NSRUpdateAgent Database NSR_DATABASE_CONTAINER NSR_DATABASE NSRDatabaseCollector Log NSR_LOG_CONTAINER NSR_LOG NSRLogCollector Client NSR_CLIENT_CONTAINER NSR_CLIENT NSRClientCollector Device NSR_LIBRARY_CONTAINER NSR_LIBRARY NSR_LDEVICE NSR_DEVICE_CONTAINER NSR_DEVICE NSRJukeboxCollector NSRDeviceCollector Daemon NSR_DAEMON_CONTAINER NSR_DAEMON NSRDaemonCollector Pool NSR_POOL_CONTAINER NSR_POOL NSRPoolCollector Backup NSR_POLICY_CONTAINER NSR_POLICY NSR_PCLIENT NSR_JOB_CONTAINER NSR_JOB NSR_MOUNT_CONTAINER NSR_MOUNT NSRGroupCollector NSRSaveGrpCollector NSRRequestCollector Note If debugging for an object is turned on, debugging for the following is also enabled for all application classes with that object: KM commands, InfoBoxes, recovery actions for consumer parameters, pre-discovery and discovery functions defined under an application class. OTL Software Ltd., Confidential and Proprietary Information 5-66 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Step 3 By default, all debug messages are sent to both a task window and a file or set of files, as detailed below. You may choose to select one method or the other, but the default setting of Both is recommended. • The Send to File(s) option writes all debug messages to a file or set of files in a specified debug folder on the managed system. The path of the debug folder is: • $PATROL_HOME/lib/NSR/debug on Unix systems • %PATROL_HOME%\lib\NSR\debug on MS Windows systems Warning Sending debug data to file will increase the file system usage under the above debug folder. Required space under this file system depends on the complexity of the Legato NetWorker environment. If the available space for this folder is less than 10 MBytes, it can be changed to a different file system, which has sufficient disk space. This can be achieved by replacing the debug folder with a soft link pointing to a different file system, like /tmp. This new debug folder should have read, write and execute permissions for both PATROL Agent user and the NSR KM login user. • The Send to Task Window option allows you to view the debug messages easily, as they occur. The window is labelled NSR KM Debug Output and appears on all connected PATROL Consoles. Warning If you are relying on the task window as your only output method, you should be aware that when the amount of debug data exceeds the size of the window, data will be lost from the top. To try and avoid this, set the Text Window Buffer Size to the maximum size. This setting is found in the PATROL Console menu Options => Preferences... under the tab Configuration. However, if there is an extremely high output of messages, some data may still be lost. The best way to avoid this completely is to send output to a file, as detailed above. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-67 Note Sending debug messages to task window will require PATROL Console to be connected to the PATROL Agent during the debug data collection period. Note For PATROL Central Consoles, the NSR KM Debug Output window is located in the Tasks folder under the PATROL Main Map. Step 4 Select OK to start NSR KM debugging. Debug data collection may take some time, depending on the complexity of your environment, frequency of the data collection, and dependency between other NSR KM data collectors. You can force the data collection as described in “Refreshing Parameters” on page 5-71. Note A message is sent to the PATROL Console System Output Window (SOW) when a function associated with the debug-enabled object is executed. Step 5 To stop debugging, access the NSR KM Debug Configuration dialog again, and turn off all debug switches by clicking Off as appropriate, and click OK. Note The debug switches will not be turned off automatically unless the PATROL Agent is restarted while the KM is being debugged. In this case all debug switches will be reset to Off. Warning Leaving the debug switches turned on will impact the performance of the NSR KM and the PATROL Agent. Messages will continue to be sent to the SOW and the debug output file(s) will continue to grow until all debug switches are turned off. OTL Software Ltd., Confidential and Proprietary Information 5-68 OTL Software’s Legato NetWorker® Knowledge Module® for PATROL® - User Guide Step 6 This step depends on your choice of debug output: • If you chose to only send the output to a task window, you can save the debug output as follows: A. Right-click in the window NSR KM Debug Output. B. Select Save As and enter a location to save the data. • If debug output has been sent to file(s), you will be asked if you would like to prepare the debug files for sending to OTL Software. If so, the files will be compressed into a single file to allow you to email the data easily. The name and path of the compressed file is: • • nsr_km_debug__