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

Tivoli Storage Manager Km 2.5.01 User Guide

   EMBED


Share

Transcript

PATROL® for Tivoli® Storage Manager by OTL Software User Guide Version 2.5 Document Revision 3 March 17, 2011 Copyright © 2011 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. Tivoli Storage Manager is a registered trademark of International Business Machines Corporation or Tivoli Systems Inc.. 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. The license agreement can be found in the product licensing menu as described in “Licensing the KM” on page 8 or by contacting OTL Software Limited. Restricted Rights Legenda 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 (Sales) [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 Click here to ensure you have the latest version of the OTL Software KMs. Support via Telephone or E-mail If you need technical support, you can contact OTL Software by calling +64 9 373 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: — Tivoli Storage Manager version — Tivoli Storage Manager server type (Server / Storage Agent) • operating system information: — machine type — operating system type, version, and service pack or patch details — system hardware configuration • KM Infrastructure information: — PATROL Agent version — PATROL Console version and platform details — BMC ProactiveNet Performance Management Portal 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) PATROL for Tivoli Storage Manager by OTL Software - User Guide iii iv PATROL for Tivoli Storage Manager by OTL Software - User Guide Contents Contents Chapter 1 Product Components and Capabilities Overview of the TSM KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2 Features of the KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2 Objectives of the KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3 Product Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8 Application Classes and Icons . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8 Hierarchical Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11 Menus, InfoBoxes and Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-13 Accessing Menus and InfoBoxes . . . . . . . . . . . . . . . . . . . . . . . . 1-13 Accessing Online Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-14 Printing Online Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-15 Impact on Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-16 CPU and Memory Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-16 Network Traffic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-17 Where to Go from Here . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-17 Chapter 2 Preparing to Install Installation Checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2 System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3 Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4 Changes to Tivoli Storage Manager . . . . . . . . . . . . . . . . . . . . . . 2-5 Changes to BMC PATROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5 Additional Software Requirements . . . . . . . . . . . . . . . . . . . . . . . 2-6 Security Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7 Operating System User Access . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7 Admin Interface User Access . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-11 Disk Space Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-13 License Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-14 OTL Software Ltd., Confidential and Proprietary Information Contents v Where to Go from Here . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-14 Chapter 3 Installation Installation Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-2 Installation Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-3 Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-4 Installing the KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-5 Uninstalling the KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-11 Where to Go from Here . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-16 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 ProactiveNet Performance Management Portal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-6 Configuring the KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-7 Licensing the KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-8 Configuring the KM User Accounts . . . . . . . . . . . . . . . . . . . . . .4-10 Verifying Application Discovery . . . . . . . . . . . . . . . . . . . . . . . . .4-11 Checking the Instance Limits . . . . . . . . . . . . . . . . . . . . . . . . . . .4-13 Checking the Initial Setup of the KM . . . . . . . . . . . . . . . . . . . . .4-14 Configuring PATROL Agent to Preload the KM . . . . . . . . . . . .4-16 Restarting PATROL Agent and PATROL Console . . . . . . . . . . .4-16 Unloading the KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-17 Unloading the KM from the PATROL Agent . . . . . . . . . . . . . . .4-17 Unloading the KM from PATROL Console . . . . . . . . . . . . . . . .4-18 Unloading the KM from PATROL Central Console . . . . . . . . . .4-19 Where to Go from Here . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-19 Chapter 5 Working with the KM Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-2 Customizing the KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-3 Managed Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-4 Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-8 Daemons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-12 Server Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-16 Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-18 Domains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-24 OTL Software Ltd., Confidential and Proprietary Information vi PATROL for Tivoli Storage Manager by OTL Software - User Guide Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-31 Mount Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-36 Automated Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-39 Manual Drives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-47 Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-51 Storage Pools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-54 Operating the KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-56 Generating Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-64 Debugging the KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-65 Working with Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-71 Refreshing Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-71 Displaying Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-73 Customizing Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-73 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 (Menus) Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2 Menu Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-3 Appendix B InfoBoxes Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B-2 InfoBox Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B-3 Appendix C Parameter Definitions and Defaults Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .C-1 Parameter Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .C-2 Column Heading Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . .C-2 Abbreviations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .C-3 Parameter Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .C-4 Appendix D Troubleshooting Troubleshooting Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-2 Glossary Index OTL Software Ltd., Confidential and Proprietary Information Contents vii OTL Software Ltd., Confidential and Proprietary Information viii PATROL for Tivoli Storage Manager by OTL Software - 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 4-9 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 TSM KM . . . . . . . . . . . . . . . . . 1-11 Installation Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2 TSM KM Setup Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3 TSM KM Setup Instance on PATROL Central Console . . . . . . . 4-5 TSM KM Setup Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7 License Configuration dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8 Remote Authentication Configuration dialog . . . . . . . . . . . . . . . 4-9 Login Configuration dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10 TSM KM Console View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12 TSM KM Default Instance Limits . . . . . . . . . . . . . . . . . . . . . . . 4-13 TSM KM Preloading dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16 Monitoring Mode Configuration dialog . . . . . . . . . . . . . . . . . . . 5-4 Remote PATROL Agent Configuration dialog . . . . . . . . . . . . . . 5-5 Node Status Configuration dialog . . . . . . . . . . . . . . . . . . . . . . . . 5-6 Client Configuration dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-8 Client Status Configuration dialog . . . . . . . . . . . . . . . . . . . . . . . 5-10 Daemon Configuration dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12 Daemon Status Configuration dialog . . . . . . . . . . . . . . . . . . . . . 5-14 Database Configuration dialog . . . . . . . . . . . . . . . . . . . . . . . . . . 5-16 Log Configuration dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-18 Log Filter Configuration dialog . . . . . . . . . . . . . . . . . . . . . . . . . 5-20 Log Alert Acknowledgement Configuration dialog . . . . . . . . . . 5-23 Domain Configuration dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-24 Domain Backup Restriction Configuration dialog . . . . . . . . . . . 5-26 Domain Status Configuration dialog . . . . . . . . . . . . . . . . . . . . . 5-27 Client Node Configuration dialog . . . . . . . . . . . . . . . . . . . . . . . . 5-29 Job Filter Configuration dialog . . . . . . . . . . . . . . . . . . . . . . . . . . 5-31 Job Status Configuration dialog . . . . . . . . . . . . . . . . . . . . . . . . . 5-33 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 Figure 5-33 Figure 5-34 Job Alert Acknowledgement Configuration dialog . . . . . . . . . . .5-35 Mount Request Filter Configuration dialog . . . . . . . . . . . . . . . .5-36 Mount Request Status Configuration dialog . . . . . . . . . . . . . . . .5-37 Automated Library Configuration dialog . . . . . . . . . . . . . . . . . .5-39 Automated Library Status Configuration dialog . . . . . . . . . . . . .5-41 Automated Library Drive Configuration dialog . . . . . . . . . . . . .5-43 Automated Library Drive Status Configuration dialog . . . . . . . .5-45 Manual Drive Configuration dialog . . . . . . . . . . . . . . . . . . . . . .5-47 Manual Drive Status Configuration dialog . . . . . . . . . . . . . . . . .5-49 Process Status Configuration dialog . . . . . . . . . . . . . . . . . . . . . .5-52 Storage Pool Configuration dialog . . . . . . . . . . . . . . . . . . . . . . .5-54 Server/Storage Agent Administration sub-menu . . . . . . . . . . . . .5-57 Log Alert Acknowledgement sub-menu . . . . . . . . . . . . . . . . . . .5-58 Manual Drive Administration sub-menu . . . . . . . . . . . . . . . . . . .5-60 Process Alert Acknowledgement sub-menu . . . . . . . . . . . . . . . .5-62 Process Administration sub-menu . . . . . . . . . . . . . . . . . . . . . . . .5-63 TSM KM Debug Configuration dialog . . . . . . . . . . . . . . . . . . . .5-65 OTL Software Ltd., Confidential and Proprietary Information x PATROL for Tivoli Storage Manager by OTL Software - 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 3-8 Table 5-1 Table A-1 Table B-1 Table C-1 Table D-1 Application Class Icons and Functions . . . . . . . . . . . . . . . . . . . . 1-8 Accessing Menus and InfoBoxes for TSM KM . . . . . . . . . . . . . 1-13 Accessing Online Help for TSM KM . . . . . . . . . . . . . . . . . . . . . 1-14 Installation Checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2 Supported Operating Systems . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3 Required Software for TSM KM . . . . . . . . . . . . . . . . . . . . . . . . 2-4 Additional Software Requirements for TSM KM . . . . . . . . . . . . 2-6 Executable and Library Files Accessed by TSM KM User. . . . . 2-8 Paths and Files Accessed by PATROL Agent User . . . . . . . . . . . 2-9 Contents of the Distribution File for Installation Utility . . . . . . . 3-5 Contents of the Distribution File . . . . . . . . . . . . . . . . . . . . . . . . . 3-6 Unix Platform Installation Files and Extraction Paths. . . . . . . . 3-8 MS Windows Platform Installation Files and Extraction Paths. 3-9 Uninstallation from the PATROL Agent . . . . . . . . . . . . . . . . . . 3-12 Uninstallation from PATROL Console . . . . . . . . . . . . . . . . . . . 3-13 Uninstallation from the PATROL Central Console Server . . . . . 3-14 Uninstallation from the PATROL Central Web Server . . . . . . . . 3-15 TSM KM Object Debug Switch Association. . . . . . . . . . . . . . . 5-66 Menus for TSM KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-3 InfoBox Items for TSM KM . . . . . . . . . . . . . . . . . . . . . . . . . . . .B-3 Parameters for TSM KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .C-4 Common Problems and Resolutions . . . . . . . . . . . . . . . . . . . . . D-3 OTL Software Ltd., Confidential and Proprietary Information Tables xi OTL Software Ltd., Confidential and Proprietary Information xii PATROL for Tivoli Storage Manager by OTL Software - User Guide About . . . About this Guide This guide contains detailed information about the functionality of applications, commands, and parameters provided by PATROL for Tivoli Storage Manager by OTL Software. 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 Tivoli Storage Manager. 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 is often referred to as TSM KM and Tivoli Storage Manager may be referred to as TSM. 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 (Menus)” Describes and explains all KM menus 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 PATROL for Tivoli Storage Manager by OTL Software - User Guide Related Documentation Online Help You can access Online Help for PATROL for Tivoli Storage Manager by OTL Software through the PATROL Console Help menu. Release Notes Version-specific Release Notes for PATROL for Tivoli Storage Manager by OTL Software 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 BMC ProactiveNet Performance Management 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 TSM 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 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 PATROL for Tivoli Storage Manager by OTL Software - 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 PATROL for Tivoli Storage Manager by OTL Software with PATROL Console for Unix and PATROL Console for Windows. When instructions for the two consoles differ, this is indicated by headings such as “With the PATROL Console for Unix” or “With the PATROL Console for Windows”. OTL Software Ltd., Confidential and Proprietary Information xviii PATROL for Tivoli Storage Manager by OTL Software - User Guide 1 Product Components and Capabilities 1 This chapter provides a brief overview of PATROL® for Tivoli® Storage Manager by OTL Software. It covers the following topics: Overview of the TSM KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2 Features of the KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2 Objectives of the KM. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3 Product Architecture. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8 Application Classes and Icons . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8 Hierarchical Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11 Menus, InfoBoxes and Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-13 Accessing Menus and InfoBoxes. . . . . . . . . . . . . . . . . . . . . . . . . 1-13 Accessing Online Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-14 Printing Online Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-15 Impact on Resources. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-16 CPU and Memory Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-16 Network Traffic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-17 Where to Go from Here . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-17 OTL Software Ltd., Confidential and Proprietary Information Product Components and Capabilities 1-1 Overview of the TSM KM A Knowledge Module (KM) 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 Tivoli® Storage Manager. The parameters in PATROL for Tivoli Storage Manager by OTL Software allow you to analyse Tivoli Storage Manager application activity quickly and easily. It collects all data associated with Tivoli Storage Manager activity over time. You can clearly identify peaks, troughs and trends in the performance of backup resources. PATROL for Tivoli Storage Manager helps you ensure that your Tivoli Storage Manager 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 of the KM Key features of PATROL for Tivoli Storage Manager include: • Centralized monitoring of all storage agents and clients through the server • Monitoring the health of the Tivoli Storage Manager application and its daemons • Monitoring server database space utilization • Monitoring successful backups of server database • Monitoring log files, activity log and scanning for any alerts • Monitoring successful backups of every backup domain and client node • Monitoring backup jobs and alerting to any failures OTL Software Ltd., Confidential and Proprietary Information 1-2 PATROL for Tivoli Storage Manager by OTL Software - User Guide • Monitoring TSM internal server processes • Checking for any volume mount request on all servers/storage agents • Monitoring the status and throughput of every storage device • Monitoring the size, duration, and performance of each backup job • Monitoring the number of volumes in each storage pool, their space utilization, and current volume status Objectives of the KM The aim of the PATROL for Tivoli Storage Manager is to ensure the availability, maximum performance, and integrity of your backup servers, thereby protecting associated data sets. This section summarizes how the TSM KM is designed to achieve these goals within each area of the Tivoli Storage Manager application. For information on how the default configuration of the TSM 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 TSM 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”. OTL Software Ltd., Confidential and Proprietary Information Product Components and Capabilities 1-3 Monitoring the Tivoli Storage Manager Server/Storage Agent PATROL for Tivoli Storage Manager monitors Tivoli Storage Manager servers and storage agents. The following items are checked regularly and alerts are triggered in suspicious or critical circumstances: • • the working status of the server/storage agent KM login and licensing details for the server/storage agent Other server/storage agent information is available through the infobox. Monitoring Tivoli Storage Manager Clients PATROL for Tivoli Storage Manager monitors all remote clients configured on the server/storage agent. 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 Agent Daemons PATROL for Tivoli Storage Manager monitors the “TSM Server Daemon” or “TSM Storage Agent 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 Server Databases PATROL for Tivoli Storage Manager monitors the Tivoli Storage Manager server database and server recovery log. 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. OTL Software Ltd., Confidential and Proprietary Information 1-4 PATROL for Tivoli Storage Manager by OTL Software - User Guide Monitoring Log Files PATROL for Tivoli Storage Manager monitors the server activity log and detects all standard Tivoli Storage Manager 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 activity log and 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. Monitoring Domains and Client Nodes PATROL for Tivoli Storage Manager monitors all backup domains and their client nodes. The working status of each domain 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 domains and their client nodes statistics of the last full and incremental backups file systems included and excluded for each client node Monitoring Backup and Restore Events PATROL for Tivoli Storage Manager monitors all scheduled jobs initiated from the server for the first 24 hours. A scheduled job may be for a backup, restore, archive or retrieve event. Unless the event completes successfully (without errors), the TSM 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 job any errors logged in the activity log during a job any failed objects for a job OTL Software Ltd., Confidential and Proprietary Information Product Components and Capabilities 1-5 Other event data is available in infoboxes and/or display or text parameters, including: • • • • details of the job, such as start, end, duration, size, number of objects, domain, schedule percentage completed compared with the last similar job the throughput of the job all messages produced during the job Monitoring Tivoli Storage Manager Processes PATROL for Tivoli Storage Manager monitors all executed TSM internal server processes for 3days. The working status of each process 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 throughput of the process. Monitoring Mount Requests PATROL for Tivoli Storage Manager monitors all mount requests when they occur for any backup or restore event initiated by the server. These mount requests may exist on a remote storage agent. The amount of time remaining for a mount 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 job related to the mount request the details of the mount request, such as volume name, server/storage agent name, name, drive name, request time Monitoring Libraries and Drives PATROL for Tivoli Storage Manager monitors all local and remote backup and restore devices (storage devices) configured on the server/storage agent. For all devices listed, the working status is checked regularly and alerts are triggered in suspicious or critical circumstances: • • • automated libraries automated library drives manual drives OTL Software Ltd., Confidential and Proprietary Information 1-6 PATROL for Tivoli Storage Manager by OTL Software - User Guide Other data is available in infoboxes and/or display or text parameters, including throughput, type and server/storage agent name. Monitoring Storage Pools PATROL for Tivoli Storage Manager monitors all storage pools configured on the server/storage agent. The following items are checked regularly and alerts are triggered in suspicious or critical circumstances: • • the space utilization of total volume space as percentage of all volumes, the number of full and active volumes Other data is available in infoboxes and/or display or text parameters. OTL Software Ltd., Confidential and Proprietary Information Product Components and Capabilities 1-7 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 TSM_SERVER Tivoli Storage Manager Serves as a container representing the entire Tivoli Storage Manager application. Note: If the instance is labelled TSM_SETUP, the KM is awaiting KM License details and / or Login details Displays information on the server or storage agent. Parent of: TSM_CLIENT_CONTAINER, TSM_DAEMON_CONTAINER, TSM_DATABASE_CONTAINER, TSM_LOG_CONTAINER, TSM_JOB_CONTAINER, TSM_MOUNT_CONTAINER, TSM_POLICY_CONTAINER, TSM_LIBRARY_CONTAINER, TSM_DEVICE_CONTAINER, TSM_POOL_CONTAINER and TSM_PROCESS_CONTAINER Object: Server Component: Server TSM_CLIENT_CONTAINER Clients TSM_CLIENT Displays Tivoli Storage Manager client information. Client monitoring is disabled, by default. To enable, use the Instance Limits menu. Client monitoring is disable on storage agents and in passive multi-node mode. Child of: TSM_SERVER Object: Client Component: Client OTL Software Ltd., Confidential and Proprietary Information 1-8 PATROL for Tivoli Storage Manager by OTL Software - User Guide Table 1-1 Icon Application Class Icons and Functions Application Class Instance Label Function TSM_DAEMON_CONTAINER Daemons Displays Tivoli Storage Manager application daemon information. TSM_DAEMON Child of: TSM_SERVER Object: Daemon Component: Daemon TSM_DATABASE_CONTAINER Databases TSM_DATABASE Displays Tivoli Storage Manager server database information. Child of: TSM_SERVER Object: Database Component: Database TSM_LOG_CONTAINER Logs TSM_LOG or actlog Displays Tivoli Storage Manager log file or activity log information. Child of: TSM_SERVER Object: Log Component: Log TSM_POLICY_CONTAINER Domains TSM_POLICY Displays Tivoli Storage Manager policy domain information. Child of: TSM_SERVER Parent of: TSM_PCLIENT Object: Backup Component: Domain TSM_PCLIENT Displays Tivoli Storage Manager client node information. Client node monitoring is disabled, by default. To enable, use the Instance Limits menu. Client node monitoring is disable on storage agents and in passive multi-node mode. Child of: TSM_POLICY Object: Backup Component: Domain TSM_JOB_CONTAINER Jobs TSM_JOB : @ Displays Tivoli Storage Manager backup and restore job information. Child of: TSM_SERVER Object: Backup Component: Job OTL Software Ltd., Confidential and Proprietary Information Product Components and Capabilities 1-9 Table 1-1 Icon Application Class Icons and Functions Application Class Instance Label Function TSM_MOUNT_CONTAINER Mount Requests TSM_MOUNT on : Displays Tivoli Storage Manager volume mount request information on all servers/storage agents. Child of: TSM_SERVER * see note below table Object: Backup Component: Request TSM_LIBRARY_CONTAINER Automated Libraries TSM_LIBRARY : Displays Tivoli Storage Manager automated library information on all servers/storage agents. Child of: TSM_SERVER Parent of: TSM_LDEVICE Object: Device Component: Library TSM_LDEVICE Displays Tivoli Storage Manager automated library drive information on all automated libraries. Child of: TSM_LIBRARY Object: Device Component: Library TSM_DEVICE_CONTAINER Manual Drives TSM_DEVICE : Displays Tivoli Storage Manager manual drive information on all servers/storage agents. Child of: TSM_SERVER Object: Device Component: Drive TSM_POOL_CONTAINER Storage Pools TSM_POOL Displays Tivoli Storage Manager storage pool information. Child of: TSM_SERVER Object: Pool Component: Pool TSM_PROCESS_CONTAINER Processes TSM_PROCESS @ Displays Tivoli Storage Manager process information. Child of: TSM_SERVER Object: Process Component: Process * In the naming format for a mount request instance, may be replaced with “slot ” or “entry/exit port” for an automated library. OTL Software Ltd., Confidential and Proprietary Information 1-10 PATROL for Tivoli Storage Manager by OTL Software - User Guide Hierarchical Structure PATROL for Tivoli Storage Manager by OTL Software is organized in to groups of application classes. Figure 1-1 on page 1-11 shows the hierarchy of TSM KM application classes described in Table 1-1. Figure 1-1 Application Class Hierarchy of TSM KM OTL Software Ltd., Confidential and Proprietary Information Product Components and Capabilities 1-11 Note The top level icon for TSM KM is a single instance of the TSM_SERVER application class, labelled Tivoli Storage Manager, which represents the Tivoli Storage Manager server or storage agent. Only one installed version of Tivoli Storage Manager will be monitored. Automatic discovery will initially detect the primary installation of Tivoli Storage Manager on the server or storage agent. By double-clicking the Tivoli Storage Manager icon, you will find the parameters that monitor the Tivoli Storage Manager server or storage agent system. In addition to these parameters, there will be other container instances, which contain related application instances. Example Within the container instance labelled Domains, you will find one icon for each discovered domain. By double-clicking a domain instance, you will find an icon for each client node configured on that domain. Note Client and Client Node monitoring are disabled by default. It can be enabled by increasing the instance limits, as described in “Checking the Instance Limits” on page 4-13. If the KM is configured to failover automatically on a clustered environment, only the objects required to be monitored are instantiated on the standby/passive system. OTL Software Ltd., Confidential and Proprietary Information 1-12 PATROL for Tivoli Storage Manager by OTL Software - User Guide Menus, InfoBoxes and Help A Knowledge Module (KM) can be viewed using various PATROL Consoles or BMC ProactiveNet Performance Management Portal. 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 Menus and InfoBoxes, and how to access the Online Help for the KM using each of the consoles. Accessing Menus and InfoBoxes The Menus for TSM KM allow you to: • • • • configure the KM acknowledge alerts set by the KM manage Tivoli Storage Manager application view basic reports about the Tivoli Storage Manager environment TSM KM uses InfoBoxes to provide attributes specific to your Tivoli Storage Manager environment. InfoBoxes are tables of attributes viewable through InfoBox commands. The 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 menus and InfoBoxes in the various PATROL Consoles. Table 1-2 Accessing Menus and InfoBoxes for TSM KM To access Menus To access InfoBoxes PATROL Central Console PATROL Console for 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. Console Type OTL Software Ltd., Confidential and Proprietary Information Product Components and Capabilities 1-13 Accessing Online Help Online Help provides detailed instructions about how to use TSM 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 1-3 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 TSM 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 Windows  Select Help => Help Topics from the console menu bar, expand the book PATROL Knowledge Modules, and select Tivoli Storage Manager 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  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 Console PATROL Console for Unix  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  Click MB2 on the parameter icon, and click Help On OTL Software Ltd., Confidential and Proprietary Information 1-14 PATROL for Tivoli Storage Manager by OTL Software - User Guide 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/tsm_km/. 2. Double-click MB1 on 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 Product Components and Capabilities 1-15 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 TSM 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 Tivoli Storage Manager using the TSM KM, the PATROL Agent will consume between 5MBytes and 10MBytes of additional system memory. An enterprise installation of Tivoli Storage Manager Server with multiple Storage Agents, Clients, Automated Libraries, and Manual Drives can consume more memory (as per other KMs used by the PATROL Agent). The memory usage of TSM KM can be reduced by: • • • • • disable monitoring unnecessary component instances (by using the configuration menu) disabling unwanted components (by setting their instance limits to 0) disabling unwanted collectors (by using the PATROL Configuration Manager) increasing the collector scheduling interval (by using the PATROL Configuration Manager) decreasing the instance limits to limit the number of instances created by the collectors The data collectors in TSM KM uses Tivoli Storage Manager command line interface to obtain Tivoli Storage Manager information. Most of the performance degradation is associated with these command executions and amount of data returned. It may improve the overall performance, if the regular housekeeping is followed on all Tivoli Storage Manager systems. OTL Software Ltd., Confidential and Proprietary Information 1-16 PATROL for Tivoli Storage Manager by OTL Software - User Guide Network Traffic Under normal conditions, the TSM 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. 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 TSM KM “Chapter 2: Preparing to Install” How to install or upgrade the TSM KM “Chapter 3: Installation” How to load the TSM KM and configure it for you environment “Chapter 4: Loading and Configuring” How to monitor Tivoli Storage Manager using this KM “Chapter 5: Working with the KM” OTL Software Ltd., Confidential and Proprietary Information Product Components and Capabilities 1-17 OTL Software Ltd., Confidential and Proprietary Information 1-18 PATROL for Tivoli Storage Manager by OTL Software - User Guide 2 Preparing to Install 2 This chapter provides pre-installation instructions for PATROL® for Tivoli® Storage Manager by OTL Software. It covers the following topics: Installation Checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2 System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3 Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4 Changes to Tivoli Storage Manager. . . . . . . . . . . . . . . . . . . . . . . 2-5 Changes to BMC PATROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5 Additional Software Requirements . . . . . . . . . . . . . . . . . . . . . . . 2-6 Security Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-8 Disk Space Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-14 License Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-15 Where to Go from Here . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-16 OTL Software Ltd., Confidential and Proprietary Information Preparing to Install 2-1 Installation Checklist To ensure a successful installation or upgrade of PATROL for Tivoli Storage Manager, 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 Tivoli Storage Manager application requirements • meet all BMC PATROL requirements Security Requirements (page 2-8) • meet all security requirements Disk Space Requirements (page 2-14) • meet the minimum disk space requirements License Requirements (page 2-15) • obtain a valid KM license to run TSM KM During Installation Uninstalling the KM (page 3-11) • uninstall any previous versions of the KM Extracting the Distribution File (page 3-6) • create a temporary directory on your hard drive • save the TSM 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 TSM KM to the PATROL Console • verify the TSM KM discovery Configuring the KM (page 4-7) • enter the TSM KM license details • enter the TSM KM login details • preload the KM on to the PATROL Agent • verify the TSM KM data collection OTL Software Ltd., Confidential and Proprietary Information 2-2 PATROL for Tivoli Storage Manager by OTL Software - User Guide System Requirements The following table contains the list of operating systems and their versions supported by PATROL for Tivoli Storage Manager by OTL Software. Table 2-2 Supported Operating Systems Operating System ® Operating System Version TM Sun microsystems Solaris 8, 9, 10 HP-UX 11.00, 11.11, 11iv2, 11iv3 IBM® AIXTM Red Hat® Linux® Microsoft® Windows® 5.1, 5.2, 5.3, 6.1 7.2 2003, 2008, 2008 R2 Note Version 2.4 of TSM KM 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 TSM KM. Refer to “Upgrading the Platform” on page 5-74. OTL Software Ltd., Confidential and Proprietary Information Preparing to Install 2-3 Software Requirements The following table contains a list of required software and their versions supported by PATROL for Tivoli Storage Manager by OTL Software Table 2-3 Required Software for TSM KM Software Version Tivoli® Storage Manager Server 5.1.x, 5.2.x, 5.3.x, 5.4.x, 5.5.x, 6.1.x, 6.2.x Tivoli® Storage Manager Administrative Client 5.1.x, 5.2.x, 5.3.x, 5.4.x, 5.5.x, 6.1.x, 6.2.x BMC Software PATROL Agent 3.4.20, 3.5.x, 3.6.x, 3.7.x, 3.8.x BMC Software PATROL Console 3.4.x, 3.5.x, 7.x BMC ProactiveNet Performance Management Portal with BMC Performance Manager Portal 2.3.x, 2.4.x, 2.5.x, 2.6.x, 2.7.x, 2.8.x Note Version 2.4 of TSM KM does not support Tivoli Storage Manager versions before 4.2 and PATROL Agent versions before 3.4. Note Version 2.4 of TSM KM may support other versions of Tivoli Storage Manager and/or BMC PATROL, but any version not listed has not been tested by OTL Software Limited. Note If the version of Tivoli Storage Manager is upgraded (or downgraded) at a later date, you will need to reload commands for the TSM KM. Refer to “Upgrading the Platform” on page 5-74. OTL Software Ltd., Confidential and Proprietary Information 2-4 PATROL for Tivoli Storage Manager by OTL Software - User Guide Changes to Tivoli Storage Manager PATROL for Tivoli Storage Manager requires that an administrator account be added to the Tivoli Storage Manager server for use by PATROL and the TSM KM. Refer to “Admin Interface User Access” on page 2-13. To allow this user to execute SQL SELECT queries, there should be at least 4Mbytes of temporary table storage space all the time to avoid exhausting the temporary table storage. Changes to BMC PATROL To improve the performance of the TSM KM, the PATROL Agent tuning variable “/AgentSetup/AgentTuning/pslInstructionMax” should be disabled by setting it to 0 (zero) or increased to at least 5,000,000. This applies for all Tivoli Storage Manager servers and storage agents where the KM is installed. This adjustment will allow the data collectors to execute without incurring an internal scheduling delay. This PATROL Agent tuning variable can be updated using wpconfig (on Microsoft Windows), xpconfig (on Unix) or PATROL Configuration Manager (PCM). Alternatively, you can use one of the following single line PSL command through the PATROL Console OS> prompt to update this tuning variable. To disable: %PSL pconfig("REPLACE", "/AgentSetup/AgentTuning/pslInstructionMax",0); To set to at least 5,000,000: %PSL v="/AgentSetup/AgentTuning/pslInstructionMax"; if(get(v)<5000000){pconfig("REPLACE",v,5000000);} OTL Software Ltd., Confidential and Proprietary Information Preparing to Install 2-5 Note In large Tivoli Storage Manager 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 TSM 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 /TSM and /TSM_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. 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 login user 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 PATROL for Tivoli Storage Manager: Table 2-4 Additional Software Requirements for TSM KM Purpose Software Version When running TSM KM with sudo user account on Solaris, HP-UX, AIX or Linux managed nodes Sudo (superuser do) 1.6.7 or later OTL Software Ltd., Confidential and Proprietary Information 2-6 PATROL for Tivoli Storage Manager by OTL Software - User Guide Table 2-4 Additional Software Requirements for TSM KM Purpose Software Version When running TSM KM on Linux managed nodes Korn shell binary (/bin/ksh) Any When running TSM KM on Microsoft Windows x64 managed nodes Reg.exe patch KB948698 (http://support.microsoft.com/kb/948698) Any Note The Microsoft Windows x64 Reg.exe patch, KB948698 is required to allow access to 64-bit registry keys from PATROL Agent. Access the above patch site from the managed node to obtain the correct patch for that platform. OTL Software Ltd., Confidential and Proprietary Information Preparing to Install 2-7 Security Requirements Operating System User Access By default, Tivoli Storage Manager is installed and run as the root user (on Unix) or as administrator user (on Microsoft Windows). PATROL for Tivoli Storage Manager needs to be run as a user account with administrative privileges to read and execute Tivoli Storage Manager application programs and file systems. Login details of this user are configured in the TSM 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 Tivoli Storage Manager 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 Tivoli Storage Manager application to administer the Tivoli Storage Manager application Note Refer to the Tivoli Storage Manager System Administrator’s Guide for details on how to set up this type of account. OTL Software Ltd., Confidential and Proprietary Information 2-8 PATROL for Tivoli Storage Manager by OTL Software - User Guide Access Permissions The TSM KM user needs “read & execute” permission to executable and library files under the paths listed below. The Tivoli Storage Manager installation path INSTALL_PATH, referenced in Table 2-5 and Table 2-6, is normally /usr/tivoli/tsm or /opt/tivoli/tsm (on Unix) or C:\Program Files\Tivoli\TSM (on Microsoft Windows). Table 2-5 Executable and Library Files Accessed by TSM KM User Unix Microsoft Windows INSTALL_PATH/client/ba/bin (or bin64) INSTALL_PATH\baclient INSTALL_PATH/client/admin/bin INSTALL_PATH\Server INSTALL_PATH/server/bin INSTALL_PATH\StorageAgent INSTALL_PATH/StorageAgent/bin INSTALL_PATH\Server\tsmdiag INSTALL_PATH/server/bin/tsmdiag INSTALL_PATH\StorageAgent\tsmdiag INSTALL_PATH/StorageAgent/bin/tsmdiag C:\Windows\system32 /usr/lib If the KM is enabled to failover in a clustered environment, the login user needs execute permissions to the following cluster commands: /opt/VRTSvcs/bin/hagrp (in Veritas Cluster Server) vxdctl (in Veritas Cluster File System) /usr/cluster/bin/clrg (in Oracle Solaris Cluster) The TSM KM includes some scripts which should be executable by the PATROL Agent user and the TSM KM user. These scripts are stored under KM_HOME path, normally PATROL_HOME/TSM. OTL Software Ltd., Confidential and Proprietary Information Preparing to Install 2-9 To list all OS commands used by the TSM KM, execute the following PSL code from the PATROL Console, using “PSL Task” menu, after installing and loading the KM. i=0; foreach var (grep("^/TSM/CommandControls/",pconfig("LIST"))) { ctl=pconfig("GET", var); typ=ntharg(grep("CommandType",ctl),"2-"," ="); cmd=nthargf(grep("CommandText",ctl),"2-","=","="); if((typ == "")||(typ == "OS")) { printf("(%2d) %-25s: %s\n",i++,ntharg(var,"3","/"),cmd); } } The PATROL Agent user (normally patrol) requires write permission to DSM_LOG directory and dsmerror.log file. For all other paths and files listed in Table 2-6 the PATROL Agent user needs “read & execute” permission. Table 2-6 Paths and Files Accessed by PATROL Agent User Unix Microsoft Windows DSM_DIR (INSTALL_PATH/client/ba/bin or bin64) DSM_DIR (INSTALL_PATH\baclient) DSM_LOG (KM_TEMP) DSM_LOG (KM_TEMP) DSM_DIR/dsmadmc DSM_DIR\dsmadmc.exe DSM_CONFIG (DSM_DIR/dsm.opt) DSM_CONFIG (DSM_DIR/dsm.opt) DSM_LOG/dsmerror.log DSM_LOG\dsmerror.log /var/adm/messages (on Solaris) /var/adm/syslog/syslog.log (on HP-UX) /var/log/messages (on Linux) OTL Software Ltd., Confidential and Proprietary Information 2-10 PATROL for Tivoli Storage Manager by OTL Software - User Guide Warning If a monitored log file cannot be read by the PATROL Agent user, it will 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 Tivoli Storage Manager installation is identified by checking the registry sub-keys under HKEY_LOCAL_MACHINE\SOFTWARE\IBM\ADSM\. The configured login user should have sufficient privileges to run regedit command on the managed node. Sudo User for Operating System Access If a non-root user with sudo privileges is preferred as the TSM 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 TSM 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 TSM KM administration and report menu commands using their sudo privileges. The TSM 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 Tivoli Storage Manager installation path INSTALL_PATH, referenced below is normally /usr/tivoli/tsm or /opt/tivoli/tsm and PATROL_HOME is the path where the PATROL Agent is installed (including the target, like /opt/bmc/Patrol3/Solaris29-sun4/). Warning This non-root sudo user configured in the KM will be able to execute Tivoli Storage Manager commands. To prevent unauthorized access, ensure this user is only used within the KM and not made public for general use. OTL Software Ltd., Confidential and Proprietary Information Preparing to Install 2-11 Warning Entering the non-root sudo user with ‘Use Sudo’ option selected in to the 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 may expose the sudo user password. On Solaris: User_Alias TSMKMUSERS = user1, user2, user3 Defaults:TSMKMUSERS !lecture,!authenticate,\ env_keep+="LD_LIBRARY_PATH INSTALL_PATH KM_HOME \ KM_TEMP DSM_CONFIG DSM_DIR DSM_LOG",env_reset TSMKMUSERS ALL=/bin/*,/sbin/*,/usr/bin/*,/usr/sbin/*,\ INSTALL_PATH/server/bin/*,\ INSTALL_PATH/client/ba/bin/*,\ PATROL_HOME/lib/TSM/*,PATROL_HOME/bin/* On HP-UX: User_Alias TSMKMUSERS = user1, user2, user3 Defaults:TSMKMUSERS !lecture,!authenticate,\ env_keep+="SHLIB_PATH INSTALL_PATH KM_HOME \ KM_TEMP DSM_CONFIG DSM_DIR DSM_LOG",env_reset TSMKMUSERS ALL=/bin/*,/sbin/*,/usr/bin/*,/usr/sbin/*,\ INSTALL_PATH/server/bin/*,\ INSTALL_PATH/client/ba/bin/*,\ PATROL_HOME/lib/TSM/*,PATROL_HOME/bin/* On AIX & Linux: User_Alias TSMKMUSERS = user1, user2, user3 Defaults:TSMKMUSERS !lecture,!authenticate,\ env_keep+="LIBPATH INSTALL_PATH KM_HOME \ KM_TEMP DSM_CONFIG DSM_DIR DSM_LOG",env_reset TSMKMUSERS ALL=/bin/*,/sbin/*,/usr/bin/*,/usr/sbin/*,\ INSTALL_PATH/server/bin/*,\ INSTALL_PATH/client/ba/bin/*,\ PATROL_HOME/lib/TSM/*,PATROL_HOME/bin/* OTL Software Ltd., Confidential and Proprietary Information 2-12 PATROL for Tivoli Storage Manager by OTL Software - User Guide Admin Interface User Access PATROL for Tivoli Storage Manager requires that an administrator account (standard administrator with no other privileges) be added to the Tivoli Storage Manager server for use by PATROL and the TSM KM. This account is used to query the configuration details and resource utilization of the server through the Tivoli Storage Manager Administrative Client interface (DSMADMC). No changes are made by this user on the Tivoli Storage Manager server - the TSM KM operates in “read-only” mode for normal operation. The suggested name for this DSMADMC user account is patrol and it can be created as part of the configuration procedure described in “Configuring the KM User Accounts” on page 4-10. Alternatively, the user account can be set up directly in Tivoli Storage Manager, and the details simply entered during KM configuration in the same way that the OS login details are entered. The password is stored in the PATROL Agent in a DES encrypted format. Note This DSMADMC user does not require operating system access. Therefore it is not required to be the same as the OS login account. DSMADMC command binary is executed using PATROL Agent user account. Therefore the PATROL Agent user should be able to access required paths and binaries of DSMADMC. This includes execute permission to DSM_CONFIG path and dsmadmc (or dsmadmc.exe) file and write permission to DSM_LOG path and dsmerror.log file. They included in Table 2-6 on page 2-10. 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. OTL Software Ltd., Confidential and Proprietary Information Preparing to Install 2-13 To list all DSMADMC commands used by the TSM KM, execute the following PSL code from the PATROL Console, using “PSL Task” menu, after installing and loading the KM. i=0; foreach var (grep("^/TSM/CommandControls/",pconfig("LIST"))) { ctl=pconfig("GET", var); typ=ntharg(grep("CommandType",ctl),"2-"," ="); cmd=nthargf(grep("CommandText",ctl),"2-","=","="); if(typ == "DSMADMC") { printf("(%2d) %-25s: %s\n",i++,ntharg(var,"3","/"),cmd); } } Disk Space Requirements PATROL for Tivoli Storage Manager requires approximately: • • • • 1.5 MBytes disk space on each monitored PATROL Agent system 2.5 MBytes disk space on each PATROL Console system 600 KBytes disk space on each PATROL Central Console Server system 1.4 MBytes disk space on each PATROL Central Web Server system The TSM KM is installed under the PATROL installation path. When monitoring a standard installation of Tivoli Storage Manager, the PATROL Agent will generate approximately 500 KBytes of history data per day. An enterprise installation of Tivoli Storage Manager on a server with multiple storage agents, clients, automated libraries, and manual drives 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. OTL Software Ltd., Confidential and Proprietary Information 2-14 PATROL for Tivoli Storage Manager by OTL Software - User Guide During execution, the TSM KM creates and maintains temporary files under KM_HOME, KM_TEMP and KM_DEBUG paths. By default they are all under PATROL_HOME/lib/TSM, where PATROL_HOME path is normally /opt/bmc/Patrol3/ (on Unix) or C:\Program Files (x86)\BMC Software\Patrol3\ (on Microsoft Windows). If the location of the KM_TEMP or KM_DEBUG is not suitable, it can be changed using the Configuration => Paths menu from the main instance. These folder should have read, write and execute permissions for both the PATROL Agent user and the KM login user. License Requirements PATROL for Tivoli Storage Manager is shipped with a free 30 day trial license. As soon as KM is installed and loaded to the PATROL Agent on a new managed node, the trial license will be automatically activated. The trial license gives full monitoring capability for the KM, and works only once on a managed node. If you want to purchase a permanent license key, contact your local reseller or OTL Software Limited. To generate the license key, you will need to provide a KM Status report, which can be found under the menus of the main container instance. If you are upgrading the TSM KM from a previous version to 2.4, a new set of license keys may be required. Please check that all required license keys are delivered with the product. OTL Software Ltd., Confidential and Proprietary Information Preparing to Install 2-15 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 TSM KM “Chapter 3: Installation” How to load the TSM KM and configure it for you environment “Chapter 4: Loading and Configuring” How to monitor Tivoli Storage Manager using this KM “Chapter 5: Working with the KM” OTL Software Ltd., Confidential and Proprietary Information 2-16 PATROL for Tivoli Storage Manager by OTL Software - User Guide 3 Installation 3 This chapter provides instructions for installing PATROL® for Tivoli® Storage Manager by OTL Software. 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-11 Where to Go from Here . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-16 OTL Software Ltd., Confidential and Proprietary Information Installation 3-1 Installation Workflow Figure 3-1 illustrates the workflow to be followed during installation of PATROL for Tivoli Storage Manager on each PATROL Agent (managed node) and PATROL Console system. Figure 3-1 Installation Workflow Copy the TSM 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 TSM KM files installed previously Load the TSM KM from the PATROL Console and verify the discovery Configure TSM KM License details and Login details, verify the KM data collection and preload the KM OTL Software Ltd., Confidential and Proprietary Information 3-2 PATROL for Tivoli Storage Manager by OTL Software - User Guide Installation Guidelines Follow these guidelines to ensure successful installation of PATROL for Tivoli Storage Manager: • Install the TSM KM on each Tivoli Storage Manager server or storage agent to be monitored, and on each PATROL Console. Note the KM should not be installed on Tivoli Storage Manager clients. • Install TSM KM under PATROL installation path PATROL_HOME (normally C:\Program Files (x86)\BMC Software\Patrol3 on Microsoft Windows systems and /opt/bmc/Patrol3 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 TSM KM to any PATROL Agent. The Commit KM command will not copy TSM KM scripts, which are operating system dependant. These scripts are stored under the KM_HOME path (PATROL_HOME/TSM) 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 PATROL for Tivoli Storage Manager on Microsoft Windows and Unix platforms. OTL Software recommends that: • if you are upgrading from an older version of TSM KM, backup the PATROL Agent and PATROL Console installation paths Note When upgrading from version 1.x, all previous TSM KM configuration data stored in the PATROL Agent configuration database (pconfig) will be removed. • before deploying the TSM KM to a production environment, it should be installed, configured and tested in a test environment • all components of the TSM KM included in the installation file should be installed • all KM files should be loaded using the TSM_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 PATROL for Tivoli Storage Manager by OTL Software - User Guide Installing the KM This section describes steps required to install or upgrade the PATROL for Tivoli Storage Manager. Installing the KM (Using BMC Installation Utility) 1. Check all prerequisites listed in “Chapter 2: Preparing to Install” have been met. 2. Download the latest Installation Utility from BMC EPD site and extract the contents to create bmc_products directory under a temporary directory. 3. Extract the contents of the TSM KM distribution file (tsm_km_v25xx.zip on Microsoft Windows platforms or tsm_km_v25xx.tar on Unix platforms) to the same temporary directory, created in Step 2. 4. Start the Installation Utility (setup.exe on Microsoft Windows platforms or setup.sh on Unix platforms), follow the instructions and install the required components of the KM. Table 3-1 describes the contents of the TSM KM distribution file. Table 3-1 Contents of the Distribution File for Installation Utility File Description tsmagt25xxu Unix PATROL Agent installation utility files tsmagt25xxw MS Windows PATROL Agent installation utility files tsmcon25xxu PATROL Console for Unix installation utility files tsmcon25xxw PATROL Console for Windows installation utility files tsmcs25xxu PATROL Central Console Server for Unix installation utility files tsmcs25xxw PATROL Central Console Server for MS Windows installation utility files tsmws25xx PATROL Central Web Server for Unix and PATROL Central Web Server for MS Windows installation utility files OTL Software Ltd., Confidential and Proprietary Information Installation 3-5 Table 3-1 Contents of the Distribution File for Installation Utility File Description otl-tsm-solution-2.5.xx.par BMC ProactiveNet Performance Management Portal PAR file otl-tsm-express-solution-2.5.xx.par BMC ProactiveNet Performance Management Portal PAR file for integrating static components only Preparing to Install or Upgrade (Using All in One Exe/Zip File) 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 self-extracting file (tsm.exe) or as a zip file (tsm.zip). Zip files can be extracted using WinZip application or PKUNZIP command (Microsoft Windows platforms) or unzip command (Unix platforms). Table 3-2 describes the contents of the TSM KM distribution file. Table 3-2 Contents of the Distribution File File Description tsm_ug25.pdf User Guide tsm_rn.pdf Release Notes tsm_r25_agent.tar Unix PATROL Agent installation file tsmagt25.exe MS Windows PATROL Agent installation file tsm_r25_console.tar PATROL Console for Unix installation file tsmcon25.exe PATROL Console for Windows installation file tsmconserver25.tar PATROL Central Console Server for Unix installation file tsmcs25.exe PATROL Central Console Server for MS Windows installation file tsmwebserver25.tar PATROL Central Web Server for Unix installation file tsmws25.exe PATROL Central Web Server for MS Windows installation file OTL Software Ltd., Confidential and Proprietary Information 3-6 PATROL for Tivoli Storage Manager by OTL Software - User Guide Table 3-2 Contents of the Distribution File File Description otl-tsm-solution-2.5.xx.par BMC ProactiveNet Performance Management Portal PAR file otl-tsm-express-solution-2.5.xx.par BMC ProactiveNet Performance Management Portal PAR file for integrating static components only 3. Read the Release Notes, and confirm all requirements for this release have been met. 4. If you are upgrading the TSM KM, please follow the steps described under “Uninstalling the KM” on page 3-11 to uninstall the old version of the KM before attempting to install the new version. OTL Software Ltd., Confidential and Proprietary Information Installation 3-7 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-3. Table 3-3 Unix Platform Installation Files and Extraction Paths File Path tsm_r25_agent.tar $PATROL_HOME/ on monitored servers and storage agents for Tivoli Storage Manager for Unix Example: /opt/bmc/Patrol3/ or /opt/bmc/Patrol3/Solaris29-sun4/ tsm_r25_console.tar $PATROL_HOME/ on PATROL Console for Unix Example: /opt/bmc/Patrol3/ or /opt/bmc/Patrol3/Solaris29-sun4/ tsmconserver25.tar $PATROL_ROOT/ on PATROL Central Console Server for Unix Example: /opt/bmc/Patrol7/ tsmwebserver25.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 3-8 PATROL for Tivoli Storage Manager by OTL Software - User Guide 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-4 Table 3-4 MS Windows Platform Installation Files and Extraction Paths File Path tsmagt25.exe %PATROL_HOME%\ on monitored servers and storage agents for Tivoli Storage Manager for Microsoft Windows Example: C:\Program Files\BMC Software\Patrol3\ tsmcon25.exe %PATROL_HOME%\ on PATROL Console for Windows Example: C:\Program Files\BMC Software\Patrol3\ tsmcs25.exe %PATROL_ROOT%\ on PATROL Central Console Server for MS Windows Example: C:\Program Files\BMC Software\Patrol7\ tsmws25.exe %BMC_ROOT%\WebCentral\ on PATROL Central Web Server for MS Windows Example: C:\Program Files\BMC Software\WebCentral\ 3. Remove the self-extracting installation file copied in Step 1. OTL Software Ltd., Confidential and Proprietary Information Installation 3-9 Installing or Upgrading the PAR file on BMC ProactiveNet Performance Management Portal The PAR file enables BMC ProactiveNet Performance Management Portal to retrieve the KM data from the PATROL Agent. 1. Log on to the BMC ProactiveNet Performance Management Portal with portal credentials, and select the Portal tab. 2. Under Tasks in the navigation pane, select Performance Managers. 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-tsm-solution-2.5.xx.par and for static components only integration (without Job or Mount Request integration) select otl-tsm-express-solution-2.5.xx.par. 5. Click Upload. Note If you are upgrading the PAR file on BMC ProactiveNet Performance Management 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. OTL Software Ltd., Confidential and Proprietary Information 3-10 PATROL for Tivoli Storage Manager by OTL Software - User Guide Uninstalling the KM This section describes steps for uninstalling the PATROL for Tivoli Storage Manager. The KM is uninstalled when upgrading the TSM KM from an older version, or if the TSM KM is no longer required for monitoring the Tivoli Storage Manager 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. Note If the TSM KM was installed using the Installation Utility, use the same to remove the KM files after unloading. Uninstalling the KM from the PATROL Agent 1. Unload the TSM KM by removing it from the list of preloaded KMs. If the current version of the TSM KM is 2.x, you can use the menu Configuration => Preloading from the Tivoli Storage Manager instance to unload the KM. Alternatively, use the utility wpconfig (on Microsoft Windows) or xpconfig (on Unix) to remove TSM_LOAD.kml from the PATROL Agent configuration variable “/AgentSetup/preloadedKMs”. 2. Restart the PATROL Agent. 3. Remove all TSM KM files listed in Table 3-5 under the paths for PATROL Home (PATROL_HOME) and PATROL Cache (PATROL_CACHE). OTL Software Ltd., Confidential and Proprietary Information Installation 3-11 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 TSM KM is installed. Table 3-5 Uninstallation from the PATROL Agent File Types to Delete Path relative to PATROL_HOME Unix Microsoft Windows PSL Library Files lib/psl/TSM_*.* lib\psl\TSM_*.* KM & Catalog Files lib/knowledge/TSM_*.* lib\knowledge\TSM_*.* Archive Files lib/archive/TSM_*.* lib\archive\TSM_*.* Other Files & Folders TSM/* TSM TSM_*.* lib/TSM/* lib/TSM lib/TSM_*.* TSM\*.* TSM TSM_*.* lib\TSM\*.* lib\TSM lib\TSM_*.* Uninstalling the KM from the PATROL Console 1. Unload the TSM KM by removing all the application classes from the list of loaded application classes. All TSM KM application classes start with “TSM_”. On PATROL Console for Unix: A. From the PATROL Console main window choose Attributes => Application Classes... B. Select an 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. OTL Software Ltd., Confidential and Proprietary Information 3-12 PATROL for Tivoli Storage Manager by OTL Software - User Guide 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 TSM 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 TSM KM files listed in Table 3-6 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-6 Uninstallation from PATROL Console File Types to Delete Path relative to PATROL_HOME Unix Microsoft Windows PSL Library Files lib/psl/TSM_*.* lib\psl\TSM_*.* KM & Catalog Files lib/knowledge/TSM_*.* lib\knowledge\TSM_*.* Archive Files lib/archive/TSM_*.* lib\archive\TSM_*.* Icon & Image Files lib/images/TSM_*.* lib/images/tsm_*.* lib\images\tsm_*.* Online Help Files & Folders lib/help/tsm_*.* lib/help/tsm_km/*.* lib/help/tsm_km lib/help/km_help_tsm_km lib\help\tsm_*.* lib\help\tsm_km\*.* lib\help\tsm_km lib\help\km_help_tsm_km 3. Repeat above steps on every PATROL Console system where the TSM KM is installed. OTL Software Ltd., Confidential and Proprietary Information Installation 3-13 Uninstalling the KM from PATROL Central Console 1. Unload the TSM KM by removing all the application classes from the list of loaded application classes. All TSM KM application classes start with “TSM_”. A. Right-click on the PATROL Main Map and choose Unload Knowledge Modules... B. Select the managed systems where the TSM KM is to be unloaded, and click Next>. C. Select all TSM KM application classes, click Next> and Finish. 2. Repeat the above steps on every PATROL Central Console where the TSM KM is installed. Uninstalling the KM from the PATROL Central Console Server 1. Remove all TSM KM files listed in Table 3-7 under the PATROL Central Console Server installation path (PATROL_ROOT). Table 3-7 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/tsm_*/lib/help /EN_USA/tsm_km.chm lib\knowledge\tsm_*\lib\help \EN_USA\tsm_km.chm Icon & Image Files & Folders lib/knowledge/tsm_*/*.* lib/knowledge/tsm_* lib\knowledge\tsm_*\*.* lib\knowledge\tsm_* 2. Repeat above steps on every PATROL Central Console Server system where the TSM KM is installed. OTL Software Ltd., Confidential and Proprietary Information 3-14 PATROL for Tivoli Storage Manager by OTL Software - User Guide Uninstalling the KM from the PATROL Central Web Server 1. Remove all TSM KM files listed in Table 3-8 under the PATROL Central Web Server installation path ($BMC_ROOT/webcentral on Unix and %BMC_ROOT%\WebCentral on Microsoft Windows). Table 3-8 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/tsm_km*.jar km_services/html/default/lib/help /EN_USA/tsm_km*.jar help_services\tsm_km*.jar km_services\html\default\lib\help \EN_USA\tsm_km*.jar 2. Repeat above steps on every PATROL Central Web Server system where the TSM KM is installed. Uninstalling the PAR File from the BMC ProactiveNet Performance Management Portal Note If you are upgrading the PAR file on BMC ProactiveNet Performance Management Portal, skip the uninstallation procedures outlined below and follow the upgrade steps in “Installing or Upgrading the PAR file on BMC ProactiveNet Performance Management Portal” on page 3-10. 1. Remove all elements using the TSM KM PAR file from the BMC ProactiveNet Performance Management Portal Infrastructure. 2. Log on to the BMC ProactiveNet Performance Management 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 TSM KM solution from the list. 5. Click Delete. OTL Software Ltd., Confidential and Proprietary Information Installation 3-15 Deleting PATROL Agent Configuration Variables Note If you are uninstalling the KM to upgrade from an older version of TSM KM, you do not have to follow the steps below. The new version of the KM will upgrade the configuration details during the initial discovery. 1. Remove all PATROL Agent configuration variables created by the TSM KM. These variables are stored under configuration paths TSM and TSM_License. They can be removed 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 remove TSM KM configuration variables. The TSM KM should be uninstalled on the PATROL Console before attempting the following PSL command: %PSL foreach var(grep("^/TSM[/_]",pconfig("LIST"))) { pconfig("DELETE", var); } 2. Repeat the above step on every PATROL Agent system where the TSM 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 TSM KM and configure it for you environment “Chapter 4: Loading and Configuring” How to monitor Tivoli Storage Manager using this KM “Chapter 5: Working with the KM” OTL Software Ltd., Confidential and Proprietary Information 3-16 PATROL for Tivoli Storage Manager by OTL Software - User Guide 4 Loading and Configuring 4 This chapter provides instructions for loading and configuring PATROL® for Tivoli® Storage Manager by OTL Software. 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 BPPM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6 Configuring the KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7 Licensing the KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8 Configuring the KM User Accounts . . . . . . . . . . . . . . . . . . . . . . 4-10 Verifying Application Discovery . . . . . . . . . . . . . . . . . . . . . . . . . 4-11 Checking the Instance Limits. . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13 Checking the Initial Setup of the KM . . . . . . . . . . . . . . . . . . . . . 4-14 Configuring PATROL Agent to Preload the KM. . . . . . . . . . . . . 4-16 Restarting PATROL Agent and PATROL Console . . . . . . . . . . . 4-16 Unloading the KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17 Unloading the KM from the PATROL Agent . . . . . . . . . . . . . . . 4-17 Unloading the KM from PATROL Console. . . . . . . . . . . . . . . . . 4-18 Unloading the KM from PATROL Central Console . . . . . . . . . . 4-19 Where to Go from Here . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-19 OTL Software Ltd., Confidential and Proprietary Information Loading and Configuring 4-1 Loading the KM This section provides instructions to load PATROL for Tivoli Storage Manager by OTL Software on Microsoft Windows and Unix platforms. Before you load the TSM 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 TSM 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-5. Loading the KM on PATROL Console 1. From the PATROL Console menu bar, choose File => Load KM... 2. Select the TSM_LOAD.kml file, and click Open or OK. The TSM KM will be loaded to the PATROL Console, and all connected PATROL Agents will start discovering the Tivoli Storage Manager environment. 3. The End User License Agreement will be displayed as part of the trial license activation. Please read, accept the agreement and click Continue. The 30 day trial license will be activated as soon as the agreement is accepted. If you are upgrading from an older version, you have to enter a new license key, as described in “Licensing the KM” on page 4-8, if required. OTL Software Ltd., Confidential and Proprietary Information 4-2 PATROL for Tivoli Storage Manager by OTL Software - User Guide If the automatic discovery successfully finds the Tivoli Storage Manager server/storage agent installation, the TSM_SETUP instance will be instantiated, as shown in Figure 4-1. Figure 4-1 TSM KM Setup Instance Note This automatic discovery may take up to 5 minutes to instantiate the TSM_SETUP instance. Look for any error messages on the PATROL Console System Output Window (SOW) during the initial discovery. 4. Select File => Save Configuration to save the new list of loaded KM files as the PATROL Console user preference. Follow the steps for configuring the KM, as described in “Configuring the KM” on page 4-7. Load the TSM_LOAD.kml file 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 TSM 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 TSM_LOAD.kml file for each managed system, click Next> and Finish. Note If you cannot find the TSM_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 TSM KM will be loaded to the PATROL Central Console Server, and all connected selected managed systems will start discovering the Tivoli Storage Manager environment. 4. The End User License Agreement will be displayed as part of the trial license activation. Please read, accept the agreement and click Continue. The 30 day trial license will be activated as soon as the agreement is accepted. If you are upgrading from an older version, you have to enter a new license key, as described in “Licensing the KM” on page 4-8, if required. If the automatic discovery successfully finds the Tivoli Storage Manager server/storage agent installation, the TSM_SETUP instance will be instantiated, as shown in Figure 4-2. OTL Software Ltd., Confidential and Proprietary Information 4-4 PATROL for Tivoli Storage Manager by OTL Software - User Guide Note This automatic discovery may take up to 5 minutes to instantiate the TSM_SETUP instance. Look for any error messages on the PATROL Central System Output Window (SOW) during the initial discovery. Follow the steps for configuring the KM, as described in “Configuring the KM” on page 4-7. Load the TSM_LOAD.kml file on each PATROL Central Management Profile where TSM KM is to be loaded. Figure 4-2 TSM KM Setup Instance on PATROL Central Console OTL Software Ltd., Confidential and Proprietary Information Loading and Configuring 4-5 Loading the KM on BPPM 1. Logon to BMC ProactiveNet Performance Management 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 PATROL for Tivoli Storage Manager by OTL Software - User Guide Configuring the KM This section provides instructions to configure PATROL for Tivoli Storage Manager by OTL Software. These instructions should be followed on all PATROL Agent systems where the TSM KM is installed. Before you can configure the TSM KM, the KM must be loaded on the PATROL Console and the TSM_SETUP instance should be displayed as shown in Figure 4-1 or Figure 4-2. Note This version of the TSM KM cannot be configured from BMC ProactiveNet Performance Management Portal. Use PATROL Console or PATROL Central Console to access the KM configuration menus (KM commands) described below. Figure 4-3 TSM KM Setup Menu OTL Software Ltd., Confidential and Proprietary Information Loading and Configuring 4-7 Licensing the KM Please read “License Requirements” on page 2-15 for details on obtaining TSM 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\TSM). 1. From the TSM_SETUP instance, select the menu 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-4. 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. Figure 4-4 License Configuration dialog OTL Software Ltd., Confidential and Proprietary Information 4-8 PATROL for Tivoli Storage Manager by OTL Software - User Guide 3. If the remote authentication is enabled, a dialog for entering remote PATROL Agent details will be displayed, as shown in Figure 4-5. Enter the remote managed node details and click OK. If the remote authentication details are valid, an acknowledgement will be displayed. Figure 4-5 Remote Authentication Configuration dialog Note The remote authentication method requires a nominated system running TSM 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 TSMLicenseStatus will be set to alert. OTL Software Ltd., Confidential and Proprietary Information Loading and Configuring 4-9 Configuring the KM User Accounts Please refer to “Security Requirements” on page 2-8 for details about TSM KM user accounts and privileges. 1. From the TSM_SETUP instance, select the menu Configuration => Login. The Login Configuration dialog will be displayed, as shown in Figure 4-6. Figure 4-6 Login Configuration dialog 2. Enter the login details for the operating system and click OK. If the default PATROL Agent account is used, tick the checkbox Use Agent Default Account in the above Login Configuration dialog. Note When the default PATROL Agent option is selected, the KM uses the configured PATROL 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 OTL Software Ltd., Confidential and Proprietary Information 4-10 PATROL for Tivoli Storage Manager by OTL Software - User Guide 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 TSMLoginStatus 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. Verifying Application Discovery 1. In the next full discovery cycle of the PATROL for Tivoli Storage Manager (following successful KM licensing and user account configuration), the label of the main container instance will change from TSM_SETUP to Tivoli Storage Manager. This new instance is shown in Figure 4-7. Note PATROL for Tivoli Storage Manager discovery can be forced by selecting the menu Force Discovery from TSM_SETUP. OTL Software Ltd., Confidential and Proprietary Information Loading and Configuring 4-11 Figure 4-7 TSM KM Console View 2. After this full discovery cycle, all TSM KM collectors will start executing, and other TSM KM application class instances will be instantiated. The initial data collection may take some time (up to an hour) depending on the complexity of your environment. Figure 4-7 shows the final PATROL Console view. Note PATROL for Tivoli Storage Manager data collection can be forced by selecting the menu Refresh Parameters from the Tivoli Storage Manager icon. Note If Tivoli Storage Manager server/storage agent is configured in a clustered environment, select the menu Configuration => Monitoring Mode, and enable Multi-node Mode monitoring for the TSM KM to failover the monitoring as appropriate. OTL Software Ltd., Confidential and Proprietary Information 4-12 PATROL for Tivoli Storage Manager by OTL Software - User Guide Checking the Instance Limits 1. Check the default values for the maximum number of instances for each application class of the TSM KM and determine whether they suit your environment. These values can be viewed and modified on the Tivoli Storage Manager instance using the menu Configuration => Instance Limits. Figure 4-8 shows the response dialog with the default values. Figure 4-8 TSM KM Default Instance Limits OTL Software Ltd., Confidential and Proprietary Information Loading and Configuring 4-13 Note By default, Client and Client Node monitoring are disabled by setting their instance limits to 0 (zero). To enable, set their instance limits to a suitable maximum. If you have a large client count, it may be better to monitor only the critical ones. 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 menu Configuration => Paths from the Tivoli Storage Manager instance. 2. Check whether the discovered Node Type is correct using the menu Configuration => Node Type from the Tivoli Storage Manager instance. 3. Check the InfoBoxes and Parameters of all the TSM 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 TSMDetails), and check for error messages. OTL Software Ltd., Confidential and Proprietary Information 4-14 PATROL for Tivoli Storage Manager by OTL Software - User Guide 5. Check the new values of parameters TSMLoginStatus and TSMLicenseStatus 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. 6. After the KM has been running for at least an hour, run the menu Configuration => KM Status from the Tivoli Storage Manager 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 your local reseller or OTL Software Limited 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 PATROL for Tivoli Storage Manager 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 Tivoli Storage Manager instance by using the menu Configuration => Preloading. The KM Preloading dialog will be displayed, as shown in Figure 4-9. Figure 4-9 TSM KM Preloading dialog 2. Select Add to add the KM files to the list of preloaded KMs. If the TSM KM is successfully added to the list, an acknowledgement will be displayed. Note The same menu is used to remove the TSM KM files 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 TSM KM 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 PATROL for Tivoli Storage Manager by OTL Software - User Guide Unloading the KM This section describes the procedures for unloading (not uninstalling) the TSM 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 but without uninstalling the files. Note If you want to completely uninstall the KM, please follow the instructions under “Uninstalling the KM” on page 3-11. 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 TSM KM is unloaded from a PATROL Agent, PATROL stops monitoring the Tivoli Storage Manager application on that system when there is no connection to a PATROL Console with TSM KM loaded. When the TSM KM is unloaded from PATROL Console, the PATROL Console stops displaying and monitoring the Tivoli Storage Manager application on any PATROL Console connected system. Unloading the KM from the PATROL Agent 1. Remove the TSM KM from the list of preloaded KMs, using the menu Configuration => Preloading from the Tivoli Storage Manager instance. Alternatively, using the utility wpconfig (on MS Windows) or xpconfig (on Unix), remove TSM_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 TSM KM is to be unloaded. OTL Software Ltd., Confidential and Proprietary Information Loading and Configuring 4-17 Note The TSM 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 TSM KM completely or partially. 1. Remove the unwanted TSM KM application classes from the list of loaded application classes, as required. All TSM KM application classes start with “TSM_”. With the PATROL Console for Unix: A. From the PATROL Console main window choose Attributes => Application Classes... B. Select a TSM KM application class to be removed and choose Edit => Delete. C. Repeat for all classes to be removed. With the PATROL Console for Windows: A. From the PATROL Console tree view choose the KM tab and expand the folder Application Classes. B. Right-click on a TSM 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 TSM KM is to be unloaded. OTL Software Ltd., Confidential and Proprietary Information 4-18 PATROL for Tivoli Storage Manager by OTL Software - 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 TSM 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 TSM 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 TSM KM application classes start with “TSM_”. 3. Select the TSM 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 TSM 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 Tivoli Storage Manager 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 PATROL for Tivoli Storage Manager by OTL Software - User Guide 5 Working with the KM 5 This chapter introduces basic tasks in PATROL for Tivoli Storage Manager by OTL Software. The following topics are discussed: Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2 Customizing the KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3 Managed Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4 Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9 Daemons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-13 Server Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-17 Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-19 Domains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-25 Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-32 Mount Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-37 Automated Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-40 Manual Drives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-48 Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-52 Storage Pools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-55 Operating the KM. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-57 Generating Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-65 Debugging the KM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-66 Working with Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-72 Upgrading the Platform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-74 Getting Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-75 Where to Go from Here . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-76 OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-1 Overview The default behavior of the PATROL for Tivoli Storage Manager is outlined in “Objectives of the KM” on page 1-3. Each area of the Tivoli Storage Manager application is addressed to summarize the critical information monitored by the TSM 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 TSM 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 TSM 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 jobs, processes and error messages on log files are described in this chapter, in “Operating the KM” on page 5-57. Reports are listed in “Generating Reports” on page 5-65. For a complete listing of all menus, including all the configuration options, refer to “Appendix A: KM Commands (Menus)”. Infobox items are listed and described in “Appendix B: InfoBoxes”. If you experience any problems or unexpected behavior when using the TSM 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-66. 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 PATROL for Tivoli Storage Manager by OTL Software - User Guide Customizing the KM PATROL for Tivoli Storage Manager can be customized and optimized to suit your Tivoli Storage Manager application environment. This section describes all menus available for customizing the TSM 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 customisation 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 the PATROL Console instance topology. If a customisation 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 are 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 Monitoring Mode The Monitoring Mode Configuration dialog is accessed from the Tivoli Storage Manager instance using the menu Configuration => Monitoring Mode. Figure 5-1 Monitoring Mode Configuration dialog The default configuration for KM monitoring mode is shown in the Monitoring Mode Configuration dialog in Figure 5-1.Singe-node Mode allows the KM to perform full monitoring on the selected system. If the Tivoli Storage Manager environment is installed in a cluster using Veritas Cluster Server, Veritas Cluster File System or Oracle Solaris Cluster, the TSM KM should be installed on all nodes in the cluster to enable continuous monitoring and avoid single point of failure. To avoid duplicate TSM KM alerts from multiple nodes, the KM can be configured to operate in Multi-node Mode. Using the menu in Figure 5-1, select the appropriate Clustering Application, the Failover Group Name, Monitoring Node Names and enable Remote PATROL Agent Checking. OTL Software Ltd., Confidential and Proprietary Information 5-4 PATROL for Tivoli Storage Manager by OTL Software - User Guide If Veritas Cluster File System is selected for Clustering Application, leave the Failover Group Name empty. Then the TSM KM will monitor the entire cluster from the active master system, which is identified by “vxdctl -c mode” command. This method requires vxconfigd in enable mode with its clustered state active. Remote PATROL Agent Checking will require PATROL Agent login configuration for each node, as shown in Figure 5-2. Customize the Number of Attempts and Timeout (in Seconds) to fine tune the communication. Figure 5-2 Remote PATROL Agent Configuration dialog If the Remote PATROL Agent Checking is disabled, the KM will monitor actively through active master system or on the node where failover group is online and will not check the monitoring status of the other nodes through PATROL Agent. Once configured to operate successfully in Multi-node Mode, the TSM KM will monitor in Active Multi-node Mode through the master or online node, and Passive Multi-node Mode through the others, standing by for a failover. In the Passive Multi-node Mode, the TSM KM will monitor only the Tivoli Storage Manager components, which cannot be monitored from the active node. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-5 Note If a managed node is unable to determine the system which should be in Active Multi-node Mode, it will change to Temporary Single-node Mode. It will reset as soon as it detects a system in Active Multi-node Mode. Warning If multiple managed nodes in a cluster runs in Single-node Mode or Temporary Single-node Mode, duplicate events may be triggered from shared components (clients, domains, jobs, requests, libraries, drives, storage pools and storages). Customizing Node Status The server/storage agent discovery executes the “query status” command and checks for any error expressions included in the Node Status filter. If any of these expressions is detected, the parameter TSMNodeStatus is set to alert. The default mapping of error expressions is shown in the Node Status Configuration dialog in Figure 5-3. This default configuration does not include any “excluded” expressions, but the functionality exists to customize the filter if another unwanted line is selected. Note For an explanation of the error codes in the above dialog, refer to the Tivoli Storage Manager Messages document. Note The regular expressions in the node status filter are case-sensitive. If any of the configured expressions occur, the parameter will be set to “suspicious” or “failure” state accordingly. The parameter will also be set to “suspicious” if any PATROL for Tivoli Storage Manager command fails because the DSMADMC user fails to connect to the server/storage agent. Recovery actions are initiated as a result of a state change. OTL Software Ltd., Confidential and Proprietary Information 5-6 PATROL for Tivoli Storage Manager by OTL Software - User Guide Figure 5-3 Node Status Configuration dialog These expressions can be customized in the Node Status Configuration dialog. Access this dialog from the Tivoli Storage Manager instance using the menu Configuration => Node Status. Expressions can be added or removed from this 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 to exclude certain lines from the warning or alarming, which have already been detected using the “include” expressions. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-7 Tip To revert to the shipped default filter settings for Warning and/or Alarm (as shown above), type “[default]” as a new expression for the filter and click Update. Note If the TSM_SERVER discovery fails to recognize the node type, it can be configured from the Tivoli Storage Manager instance using the menu Configuration => Node Type. OTL Software Ltd., Confidential and Proprietary Information 5-8 PATROL for Tivoli Storage Manager by OTL Software - User Guide Clients Customizing Monitored Clients Figure 5-4 Client Configuration dialog Note By default, Client monitoring are disabled by setting the instance limits to 0 (zero) as shown in Figure 4-8 on page 4-13. To enable, set the instance limits for Client Instances to a suitable maximum. If you have a large client installation, it may be better to monitor only the critical ones. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-9 Once enabled, the TSM KM monitors all clients configured on the server, as shown in the Client Configuration dialog in Figure 5-4. The [ALL] entry ensures that all clients found during PATROL discovery are instantiated and monitored. This dialog is accessed from the client container instance (labelled Clients) using the menu Configuration => Clients. 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 menu 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 the commands related to those clients will not be executed, leaving their parameters not 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-10 PATROL for Tivoli Storage Manager by OTL Software - User Guide Customizing Client Status Figure 5-5 Client Status Configuration dialog The PATROL for Tivoli Storage Manager checks the state of each monitored client to set the value of parameter TSMClientState. The value of this state parameter is used to determine the value of the status parameter TSMClientStatus 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-5. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-11 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 menu 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-12 PATROL for Tivoli Storage Manager by OTL Software - User Guide Daemons Customizing Monitored Daemons Figure 5-6 Daemon Configuration dialog The PATROL for Tivoli Storage Manager can monitor all daemons of the Tivoli Storage Manager application, but the default configuration is to only monitor either the Server Daemon or the Storage Agent Daemon as appropriate for the managed node. The default configuration for a Server node on a Unix platform is shown in the Daemon Configuration dialog in Figure 5-6. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-13 The daemons dsmserv and dsmsta are listed specifically in the default configuration to ensure they are instantiated and therefore monitored, even if they are not automatically discovered. The [ALL] entry line covers any other discovered daemons, ensuring they are instantiated but disabled from monitoring. Note The default configuration shown in the Daemon Configuration dialog in Figure 5-6 is for a UNIX platform. For Microsoft Windows, the TSM Server Daemon may be called dsmserv or dsmsvc depending on how it is started. Similarly the TSM Storage Agent Daemon may be called dsmsta or dstasvc. This is reflected in the default configuration for a Microsoft Windows platform. The Daemon Configuration dialog above is accessed from the daemon container instance (labelled Daemons) using the menu 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 menu 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 the commands related to those daemons will not be executed, leaving their parameters not 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-14 PATROL for Tivoli Storage Manager by OTL Software - User Guide Customizing Daemon Status Figure 5-7 Daemon Status Configuration dialog The PATROL for Tivoli Storage Manager checks the state of each monitored daemon, to set the value of parameter TSMDaemonState. The value of this state parameter is used to determine the value of the status parameter TSMDaemonStatus 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-7. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-15 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 menu 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-16 PATROL for Tivoli Storage Manager by OTL Software - User Guide Server Databases Customizing Monitored Server Databases Figure 5-8 Database Configuration dialog The default configuration for monitored server databases is displayed in the Database Configuration dialog in Figure 5-8. This dialog is accessed from the database container instance (labelled Databases), using the menu Configuration => Databases. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-17 These databases are automatically discovered and monitored. 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 menu 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 the commands related to those databases will not be executed, leaving their parameters not set. Tip To revert to the default server 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-18 PATROL for Tivoli Storage Manager by OTL Software - User Guide Log Files Customizing Monitored Log Files Figure 5-9 Log Configuration dialog The default configuration is for the TSM KM to monitor the daily Tivoli Storage Manager daily messages file and the system log file, as displayed in the Log Configuration dialog in Figure 5-9. This dialog is accessed from the log container instance (labelled Logs), using the menu 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 Tivoli Storage Manager server/storage agent log files under the DSM_LOG path (files in the format dsm*.log), ensuring they are instantiated but disabled from monitoring. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-19 Note On AIX and Microsoft Windows platforms, there is no ASCII format system log file to monitor, so the default is to monitor only the daily messages file. Note Disabled log instances will be instantiated in an OFFLINE state, and the commands related to those logs will not be executed, leaving their parameters not 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 menu 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 Filter” on page 5-21 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 TSM KM scans log files by reading the new log entries since the last data collection cycle. The TSM 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 menu Configuration => Log(s) Scan Limit. OTL Software Ltd., Confidential and Proprietary Information 5-20 PATROL for Tivoli Storage Manager by OTL Software - User Guide Warning Increasing the Log Scan Limit may affect the performance of the data collector (TSMLogCollector). Customizing Log Filter Figure 5-10 Log Filter Configuration dialog OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-21 The PATROL for Tivoli Storage Manager checks for particular error expressions in the log data scanned in each data collection cycle and written to TSMLogText. When any of these expressions is detected, the message containing the expression will be written to one of the text parameters TSMLogAlarmText or TSMLogWarningText, as appropriate. 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-10. 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 error codes in the above dialog, refer to the Tivoli Storage Manager Messages document. Note Messages containing expressions considered to be “suspicious” in the TSMLogText parameter are mapped using the Warning Filter to be written to the parameter TSMLogWarningText. This increments the value of parameter TSMLogWarningCount, 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 TSMLogAlarmText, which in turn increments TSMLogAlarmCount 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 menu 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-22 PATROL for Tivoli Storage Manager by OTL Software - 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 “ANR2121W” or “ANR21[0-9].W”. Since the default configuration for logs in the TSM KM is to only monitor the Server Activity Log 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-19), 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-23 Customizing Log Alert Acknowledgement Figure 5-11 Log Alert Acknowledgement Configuration dialog By default, the PATROL for Tivoli Storage Manager automatically acknowledges previous log alerts when it detects new errors. Figure 5-11 shows the default settings in the Log Alert Acknowledgement Configuration dialog. This dialog can be accessed using the menu 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 TSMLogAlarmText and TSMLogWarningText 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-24 PATROL for Tivoli Storage Manager by OTL Software - User Guide Domains Customizing Monitored Domains Figure 5-12 Domain Configuration dialog By default, the PATROL for Tivoli Storage Manager monitors all domains configured on the server. This is shown in the Domain Configuration dialog in Figure 5-12. The [ALL] entry ensures that all domains found on a PATROL discovery are instantiated and monitored. This dialog is accessed from the domain container instance (labelled Domains) using the menu Configuration => Domains. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-25 A domain 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 domain instance (using the menu Configuration => Domain. The advantage of specifically listing a domain in the configuration is that the domain will be instantiated, and therefore monitored, even if it is not automatically discovered. Note Disabled domain instances will be instantiated in an OFFLINE state, and the commands related to those domains will not be executed, leaving their parameters not set. Warning All jobs associated to disabled domains are not be monitored. Tip To revert to the default domain monitoring configuration (as shown above), access this dialog from the domain container instance (labelled Domains), type “[default]” as the name of a domain for a new entry and click Update. OTL Software Ltd., Confidential and Proprietary Information 5-26 PATROL for Tivoli Storage Manager by OTL Software - User Guide Customizing Domain Backup Restriction Figure 5-13 Domain Backup Restriction Configuration dialog A restriction window can be configured for domain backups using the menu Configuration => Domain(s) Backup Restriction. By default, the restriction window is disabled, as shown in the Domain Backup Restriction Configuration dialog in Figure 5-13. When the restriction window is enabled, if there is any backup activity during the specified period, the parameter TSMDomainState will be set to the value 2 (Running in Restricted Window). According to the default domain status mapping rule (described on page 5-28) this will trigger an alarm on the parameter TSMDomainStatus. The restriction window can be customized individually for each domain instance, or for all domains at once by accessing the dialog from the domain container instance (labelled Domains). OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-27 Note If changes have already been made at the domain 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 Domain Status Figure 5-14 Domain Status Configuration dialog OTL Software Ltd., Confidential and Proprietary Information 5-28 PATROL for Tivoli Storage Manager by OTL Software - User Guide The PATROL for Tivoli Storage Manager checks the state of each monitored domain, to set the value of parameter TSMDomainState. The value of this state parameter is used to determine the value of the status parameter TSMDomainStatus according to the domain status mapping rule. The default configuration of this mapping rule is displayed in the Domain Status Configuration dialog in Figure 5-14. 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 Domain Status Configuration dialog, use the menu Configuration => Domain(s) Status. The mapping rule can be customized individually for each domain instance, or for all domains at once by accessing the dialog from the domain container instance (labelled Domains). The Domain 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-14) to warn when a backup has been running on a domain 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-29 Tip To revert to the default domain 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 domain 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 domain container instance level. From this level you will also have the option to reset the configuration of any modified child instances. Customizing Monitored Client Nodes Figure 5-15 Client Node Configuration dialog OTL Software Ltd., Confidential and Proprietary Information 5-30 PATROL for Tivoli Storage Manager by OTL Software - User Guide Note By default, Client Node monitoring are disabled by setting the instance limits to 0 (zero) as shown in Figure 4-8 on page 4-13. To enable, set the instance limits for Client Node Instances to a suitable maximum. If you have a large client installation, it may be better to monitor only the critical ones. Once enabled, the TSM KM monitors all client nodes of each monitored domain, as shown in the Client Node Configuration dialog in Figure 5-15. The [ALL] entry ensures that all client nodes found on a PATROL discovery are instantiated and monitored. This dialog can be accessed from each domain instance using the menu Configuration => Client Node(s). A client node 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 node instance (using the menu Configuration => Client Node). The advantage of specifically listing a client node in the configuration is that the client node will be instantiated, and therefore monitored, even if it is not automatically discovered. Note Disabled client node instances will be instantiated in an OFFLINE state, and the commands related to those client nodes will not be executed, leaving their parameters not set. Tip To revert to the default client node monitoring configuration (as shown above) for a particular domain, access this dialog from the domain instance, type “[default]” as the name of a client node for a new entry and click Update. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-31 Jobs Customizing Monitored Jobs Figure 5-16 Job Filter Configuration dialog By default, the PATROL for Tivoli Storage Manager monitors all scheduled jobs that completed successfully for 1day and any other scheduled job for 3days, as shown in the Job Filter Configuration dialog in Figure 5-16. The status of a job refers to the value of parameter TSMJobStatus, which is determined by the state of the job (from the parameter TSMJobState) and the job status mapping rule (described in “Customizing Job Status” on page 5-34). OTL Software Ltd., Confidential and Proprietary Information 5-32 PATROL for Tivoli Storage Manager by OTL Software - User Guide The age of a job is calculated from the job end time, or start time, if end time is not available. This value is used to determine whether a job is older than the monitoring period. Jobs that started within that period will be instantiated and monitored. Note Older jobs will not be instantiated and will therefore not appear on the PATROL Console. For a job already instantiated, the age will be recalculated at the next data collection cycle; if it is now older than the appropriate period for monitoring, it will be removed from the PATROL Console. The specified periods for job monitoring can be viewed and customized using the menu Configuration => Jobs, accessed from the job container instance (labelled Jobs). Note If a period for monitoring is decreased, any applicable job 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 jobs are instantiated. Use the menu Force Full Collection from the Jobs container instance, or if the Jobs container instance is not instantiated, the PATROL Agent needs to be restarted. Note All active jobs are exempted from ageing, by default. i.e. jobs which are in one of the active states (Started, Started/Errors, Restarted, Restarted/Errors or Pending) are always monitored. By ticking Include Active Jobs in the above menu, this behavior can be overridden. Note During initial collection cycle (immediately after a PATROL Agent restart), active and inactive jobs are created and their status is determined. This may cause performance issues in large Tivoli Storage Manager installations, and will duplicate the alerts already triggered. To avoid this, select Ignore Inactive Jobs Initially, which will change the collector to monitor only the active jobs in the initial collection cycle. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-33 Note All jobs associated to disabled domains are not be monitored. Customizing Job Status Figure 5-17 Job Status Configuration dialog OTL Software Ltd., Confidential and Proprietary Information 5-34 PATROL for Tivoli Storage Manager by OTL Software - User Guide The PATROL for Tivoli Storage Manager checks the state of each monitored job to set the value of the parameter TSMJobState. The value of this state parameter is used to determine the value of the status parameter TSMJobStatus according to the job status mapping rule. The default configuration of this mapping rule is displayed in Figure 5-17. Note By default, Future jobs are not monitored by the TSM KM. 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 jobs. Access the Job Status Configuration dialog from the job container instance (labelled Jobs), using the menu Configuration => Jobs 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-17) to warn when a job has been pending for more than 30 minutes, rather than the default of an hours. Select 1 (Pending) from the State drop-down list, select the Condition > and enter 30 Minutes. Click Update and the following will appear as a new entry in the Warning Filter: “1 (Running) >30 minutes”. The original rule “1 (Pending) >60 minutes” can be removed by selecting the entry line and clicking Update. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-35 Tip To revert to the shipped default for either filter in the job status mapping rule (as shown in Figure 5-17 above), select [default] from the list of states and click Update. Customizing Job Alert Acknowledgement Figure 5-18 Job Alert Acknowledgement Configuration dialog By default, the alerts on parameter TSMJobStatus for completed jobs are not acknowledged. Figure 5-18 shows the default settings in the Job Alert Acknowledgement Configuration dialog. Using the menu Configuration => Jobs Alert Acknowledgement. The method of job alert acknowledgement can be automated, so the alerts on parameter TSMJobStatus for completed jobs in the previous collection cycle are acknowledged. OTL Software Ltd., Confidential and Proprietary Information 5-36 PATROL for Tivoli Storage Manager by OTL Software - User Guide Mount Requests Note Mount requests are only relevant for manual drives, where the loading of media is not automatic. Customizing Monitored Mount Requests Figure 5-19 Mount Request Filter Configuration dialog By default, the PATROL for Tivoli Storage Manager monitors all mount requests for 1day as shown in the Mount Request Filter Configuration dialog in Figure 5-19. The age of a mount request, calculated from the mount request time, is used to determine whether a mount request is older than the configured period for monitoring. Requests that are completed (not pending) but started within that period will not be removed from the console. The specified periods for mount request monitoring can be viewed and customized using the menu Configuration => Mount Requests, accessed from the mount request container instance (labelled Mount Requests). OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-37 Note If a period for monitoring is decreased, any applicable mount request older than the new period will be destroyed on the next data collection cycle. Customizing Mount Request Status Figure 5-20 Mount Request Status Configuration dialog OTL Software Ltd., Confidential and Proprietary Information 5-38 PATROL for Tivoli Storage Manager by OTL Software - User Guide The PATROL for Tivoli Storage Manager checks the state of each monitored mount request to set the value of the parameter TSMRequestState. The value of this state parameter is used to determine the value of the status parameter TSMRequestStatus according to the mount request status mapping rule. The default configuration of this mapping rule is displayed in Figure 5-20. 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 mount requests. Access the Mount Request Status Configuration dialog from the mount request container instance (labelled Mount Requests), using the menu Configuration => Mount 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 Alarm Filter (in Figure 5-20) to alarm when a mount 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 Alarm Filter: “1 (Pending) >60 minutes”. The original rule “1 (Pending) >30 minutes” can be removed by selecting the entry line and clicking Update. Tip To revert to the shipped default for either filter in the mount 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 Automated Libraries Customizing Monitored Automated Libraries Figure 5-21 Automated Library Configuration dialog When installed on a Server, the default configuration of the PATROL for Tivoli Storage Manager is to monitor all discovered local and remote automated libraries. This is covered by the [ALL] entry in the default configuration on a Server, shown in the Automated Library Configuration dialog in Figure 5-21. When installed on a Storage Agent, the default configuration monitors only the discovered local automated libraries. This is covered by the [LOCAL] entry in the default configuration on a Storage Agent. OTL Software Ltd., Confidential and Proprietary Information 5-40 PATROL for Tivoli Storage Manager by OTL Software - User Guide This dialog is accessed from the automated library container instance (labelled Automated Libraries) using the menu Configuration => Automated Libraries. An automated library 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 automated library instance (using the menu Configuration => Automated Library). The advantage of specifically listing an automated library in the configuration is that the library will be instantiated, and therefore monitored, even if it is not automatically discovered. Note Disabled automated library instances will be instantiated in an OFFLINE state, and the commands related to those automated libraries will not be executed, leaving their parameters not set. Tip To revert to the default automated library monitoring configuration (as shown above), access this dialog from the automated library container instance (labelled Automated Libraries), type “[default]” as the name of a library for a new entry, and click Update. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-41 Customizing Automated Library Status Figure 5-22 Automated Library Status Configuration dialog The PATROL for Tivoli Storage Manager checks the state of each monitored automated library to set the parameter TSMLibraryState. The value of this state parameter is used to determine the value of the status parameter TSMLibraryStatus according to the automated library status mapping rule. The default configuration of this mapping rule is displayed in the Automated Library Status Configuration dialog in Figure 5-22. OTL Software Ltd., Confidential and Proprietary Information 5-42 PATROL for Tivoli Storage Manager by OTL Software - 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 automated library, access the Automated Library Status Configuration dialog from that instance using the menu Configuration => Automated Library Status. The mapping rule can also be customized for all automated libraries at once by accessing the dialog from the automated library container instance (labelled Automated Libraries). The Automated Library 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” only when an automated library has been offline for more than two hours; otherwise it could be set to “suspicious”. Select 1 (Offline) from the current Alarm Filter list (to remove the current setting), and select 1 (Offline) from the State drop-down list in the Warning Filter. Then select 1 (Offline) 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 entries: in the Warning Filter: “1 (Offline)”; in the Alarm Filter: “1 (Offline) >120 minutes”. Click Close for these changes to take effect. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-43 Tip To revert to the default automated library 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 automated library 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 automated library container instance level. From this level you will also have the option to reset the configuration of any modified child instances. Customizing Monitored Automated Library Drives Figure 5-23 Automated Library Drive Configuration dialog OTL Software Ltd., Confidential and Proprietary Information 5-44 PATROL for Tivoli Storage Manager by OTL Software - User Guide By default, the PATROL for Tivoli Storage Manager monitors all automated library drives of each monitored automated library, as shown in the Automated Library Drive Configuration dialog in Figure 5-23. The [ALL] entry ensures that all automated library drives found on a monitored automated library are instantiated and monitored. This dialog can be accessed from each automated library instance using the menu Configuration => Automated Library Drives. A drive can be specifically enabled or disabled for monitoring by adding a new entry to the configuration in the library dialog above, or by accessing the dialog from the particular drive instance (using the menu Configuration => Automated Library Drive). The advantage of specifically listing an automated library drive in the configuration is that the drive will be instantiated, and therefore monitored, even if it is not automatically discovered. Note Disabled automated library drive instances will be instantiated in an OFFLINE state, and the commands related to those automated library drives will not be executed, leaving their parameters not set. Tip To revert to the default drive monitoring configuration (as shown above) for a particular automated library, access this dialog from the library instance, type “[default]” as the name of a drive for a new entry and click Update. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-45 Customizing Automated Library Drive Status Figure 5-24 Automated Library Drive Status Configuration dialog The PATROL for Tivoli Storage Manager checks the state of each monitored automated library drive to set the value of parameter TSMLDriveState. The value of this state parameter is used to determine the value of the status parameter TSMLDriveStatus according to the automated library drive status mapping rule. The default configuration of this mapping rule is displayed in the Automated Library Drive Status Configuration dialog in Figure 5-24. OTL Software Ltd., Confidential and Proprietary Information 5-46 PATROL for Tivoli Storage Manager by OTL Software - 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 Automated Library Drive Status Configuration dialog can be accessed at three levels to allow the mapping rule to be customized: • individually for a particular drive by accessing the dialog from the drive instance, using the menu Configuration => Automated Library Drive Status • for all drives on an automated library by accessing the dialog from the automated library instance, using the menu Configuration => Automated Library Drives Status • for all drives on all automated libraries at once by accessing the dialog from the automated library container instance (labelled Automated Libraries), using the menu Configuration => Automated Library Drives Status The Automated Library Drive 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-24) to warn when an automated library drive has been “Reserved” for more than half an hour, rather than the default of an hour. Select 4 (Reserved) from the State drop-down list, select the Condition > and enter 30 Minutes. Click Update and the following will appear as a new entry in the Warning Filter: “4 (Reserved) >30 minutes”. The original rule “4 (Reserved) >60 minutes” can be removed by selecting the entry line and clicking Update. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-47 Manual Drives Customizing Monitored Manual Drives Figure 5-25 Manual Drive Configuration dialog When installed on a Server, the default configuration of the PATROL for Tivoli Storage Manager is to monitor all discovered local and remote manual drives. This is covered by the [ALL] entry in the default configuration on a Server, shown in the Manual Drive Configuration dialog in Figure 5-25. When installed on a Storage Agent, the default configuration monitors only the discovered local manual drives. This is covered by the [LOCAL] entry in the default configuration on a Storage Agent. OTL Software Ltd., Confidential and Proprietary Information 5-48 PATROL for Tivoli Storage Manager by OTL Software - User Guide This dialog is accessed from the manual drive container instance (labelled Manual Drives) using the menu Configuration => Manual Drives. A manual drive 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 manual drive instance (using the menu Configuration => Manual Drive). The advantage of specifically listing a manual drive in the configuration is that the drive will be instantiated, and therefore monitored, even if it is not automatically discovered. Note Disabled manual drive instances will be instantiated in an OFFLINE state, and the commands related to those manual drives will not be executed, leaving their parameters not set. Tip To revert to the default manual drive monitoring configuration (as shown above), access this dialog from the manual drive container instance (labelled Manual Drives), type “[default]” as the name of a drive for a new entry, and click Update. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-49 Customizing Manual Drive Status Figure 5-26 Manual Drive Status Configuration dialog The PATROL for Tivoli Storage Manager checks the state of each monitored manual drive to set the parameter TSMDriveState. The value of this state parameter is used to determine the value of the status parameter TSMDriveStatus according to the manual drive status mapping rule. The default configuration of this mapping rule is displayed in the Manual Drive Status Configuration dialog in Figure 5-26. OTL Software Ltd., Confidential and Proprietary Information 5-50 PATROL for Tivoli Storage Manager by OTL Software - 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 access the Manual Drive Status Configuration dialog, use the menu Configuration => Manual Drive(s) Status. The mapping rule can be customized individually for each manual drive instance, or for all manual drives at once by accessing the dialog from the manual drive container instance (labelled Manual Drives). The Manual Drive 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-26) to warn when a manual drive has been “Reserved” for more than half an hour, rather than the default of an hour. Select 4 (Reserved) from the State drop-down list, select the Condition > and enter 30 Minutes. Click Update and the following will appear as a new entry in the Warning Filter: “4 (Reserved) >30 minutes”. The original rule “4 (Reserved) >60 minutes” can be removed by selecting the entry line and clicking Update. Tip To revert to the default manual drive 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 manual drive 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 manual drive 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-51 Processes Customizing Monitored Processes By default, the PATROL for Tivoli Storage Manager monitors all executed TSM internal server processes for 3days. The age of a process, calculated from the process start time, is used to determine whether a process is older than the period for monitoring. Processes that started less than 3days ago will be instantiated and monitored. Note Older processes will not be instantiated and will therefore not appear on the PATROL Console. For a process already instantiated, the age will be recalculated at the next data collection cycle; if it is now older than the period for monitoring, it will be destroyed from the PATROL Console. The period for monitoring all processes can be viewed and customized using the menu Configuration => Processes, accessed from the process container instance (labelled Processes). Note If the period for monitoring is decreased, any process older than the new period will be destroyed on the next data collection cycle. If the period is increased, a full data collection must be forced (by restarting the PATROL Agent) to ensure all the applicable processes are instantiated. OTL Software Ltd., Confidential and Proprietary Information 5-52 PATROL for Tivoli Storage Manager by OTL Software - User Guide Customizing Process Status Figure 5-27 Process Status Configuration dialog The PATROL for Tivoli Storage Manager checks the state of each monitored process to set the value of parameter TSMProcessState. The value of this state parameter is used to determine the value of the status parameter TSMProcessStatus according to the process status mapping rule. The default configuration of this mapping rule is displayed in the Process 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. Access the Process Status Configuration dialog from the process container instance (labelled Processes), using the menu Configuration => Processes Status. One mapping rule is used for all monitored processes so the configuration is not available at the child instance level. The Process 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 process has been running for more than two hours, rather than the default of ten hours. Select 0 (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: “0 (Running) >120 minutes”. The original rule “0 (Running) >600 minutes” can be removed by selecting the entry line and clicking Update. Tip To revert to the shipped default for either filter in the process status mapping rule (as shown in Figure 5-27 above), select [default] from the list of states and click Update. OTL Software Ltd., Confidential and Proprietary Information 5-54 PATROL for Tivoli Storage Manager by OTL Software - User Guide Customizing Process Alert Acknowledgement Similar to Job Alert Acknowledgement described under “Customizing Job Alert Acknowledgement” on page 5-36, process acknowledgement can also be automated using the menu Configuration => Processes Alert Acknowledgement. Storage Pools Customizing Monitored Storage Pools Figure 5-28 Storage Pool Configuration dialog OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-55 By default, the PATROL for Tivoli Storage Manager monitors all storage pools configured on the server/storage agent, as shown in the Storage Pool Configuration dialog in Figure 5-28. The [ALL] entry ensures that all storage pools found on a PATROL discovery are instantiated and monitored. This dialog is accessed from the storage pool container instance (labelled Storage Pools) using the menu Configuration => Storage Pools. A storage 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 storage pool instance (using the menu Configuration => Storage Pool). The advantage of specifically listing a storage pool in the configuration is that the storage pool will be instantiated, and therefore monitored, even if it is not automatically discovered. Note Disabled storage pool instances will be instantiated in an OFFLINE state, and the commands related to those storage pools will not be executed, leaving their parameters not set. Tip To revert to the default storage pool monitoring configuration (as shown above), access this dialog from the storage pool container instance (labelled Storage Pools), type “[default]” as the name of a storage pool for a new entry and click Update. OTL Software Ltd., Confidential and Proprietary Information 5-56 PATROL for Tivoli Storage Manager by OTL Software - User Guide Operating the KM This section describes day-to-day operational tasks of the PATROL for Tivoli Storage Manager, including: • • • administrative operations generation of various application reports acknowledgement of alerts These operations can be performed using menus 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 menu available under sub-menus Administration and Acknowledgement. • When an alert is acknowledged using the menus available under the sub-menu Acknowledgement, it will stay acknowledged even after restarting the PATROL Agent. • All menus under sub-menus Administration and Reports require a privileged operating system user account to carry out the operation. Note If a menu 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 Working with the KM 5-57 Administering Server/Storage Agent Figure 5-29 Server/Storage Agent Administration sub-menu The PATROL for Tivoli Storage Manager 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 menus available on the server or storage agent from PATROL Console: • • • • Administration => Start Server Administration => Stop Server Administration => Start Storage Agent Administration => Stop Storage Agent OTL Software Ltd., Confidential and Proprietary Information 5-58 PATROL for Tivoli Storage Manager by OTL Software - User Guide Acknowledging Log Alerts When an error is detected, it will appear under one of the text parameters TSMLogAlarmText or TSMLogWarningText. This will trigger an Alarm or a Warning on parameter TSMLogAlarmCount or TSMLogWarningCount, respectively. These alerts can be acknowledged automatically (by default) or manually. Refer to “Customizing Log Alert Acknowledgement” on page 5-24 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 Working with the KM 5-59 Figure 5-30 illustrates how to access the Log Alert Acknowledgement sub-menu from actlog or any log file instance, allowing you to view and acknowledge alerts: • Use the menu Acknowledgement => Warnings to view, select and acknowledge errors individually in the text parameter TSMLogWarningText. • Use the menu Acknowledgement => Alarms to view, select and acknowledge errors individually in text parameter or TSMLogAlarmText. • To acknowledge all alerts (Warnings and Alarms) at once without viewing, use the menu Acknowledgement => All. Acknowledging Job Alerts For a particular job instance, if the TSMJobStatus 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 menu Acknowledgement => Alert from the relevant job instance. An acknowledgement sub-menu is also available from the job container instance (labelled: Jobs) allowing you to view and acknowledge alerts for all jobs as follows: • Use the menu Acknowledgement => Warnings to view and acknowledge alerts for all jobs with a status of Warning. • Use the menu Acknowledgement => Alarms to view and acknowledge alerts for all jobs with a status of Alarm. • To view and acknowledge all job alerts at once (Warnings and Alarms), use the menu Acknowledgement => All. OTL Software Ltd., Confidential and Proprietary Information 5-60 PATROL for Tivoli Storage Manager by OTL Software - User Guide Administering Mount Requests When a mount request appears, its parameter TSMRequestTimeout is immediately set to alert (warning or alarm depending on the time remaining). While some requests will automatically continue processing once actioned, others require notification that the requested action has been performed. This notification is sent by using the menu Administration => Reply from the relevant mount request instance. A mount request can be cancelled from the relevant mount request instance, using the menu Administration => Cancel, or you can cancel all mount requests at once from the container instance (labelled: Mount Requests) using the menu Administration => Cancel All. Administering Manual Drives Figure 5-31 Manual Drive Administration sub-menu OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-61 Figure 5-31 illustrates how to access the Manual Drive Administration sub-menu from the manual drive instance. The available menus are: • • • Administration => Clean Drive Administration => Online Drive Administration => Offline Drive When the appropriate menu is accessed from a particular manual drive instance, that manual drive can be cleaned or brought Online or Offline, respectively. Administering Automated Library Drives Similarly, the same menus are available from an automated library drive instance, allowing the drive to be cleaned or brought Online or Offline, respectively. Acknowledging Process Alerts For a particular process instance, if the TSMProcessStatus 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 menu Acknowledgement => Alert from the relevant process instance. Figure 5-32 illustrates how to access the Process Alert Acknowledgement sub-menu from the process instance. OTL Software Ltd., Confidential and Proprietary Information 5-62 PATROL for Tivoli Storage Manager by OTL Software - User Guide Figure 5-32 Process Alert Acknowledgement sub-menu An acknowledgement sub-menu is also available from the process container instance (labelled: Processes) allowing you to view and acknowledge alerts for all processes as follows: • Use the menu Acknowledgement => Warnings to view and acknowledge alerts for all processes with a status of Warning. • Use the menu Acknowledgement => Alarms to view and acknowledge alerts for all processes with a status of Alarm. • To view and acknowledge all process alerts at once (Warnings and Alarms), use the menu Acknowledgement => All. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-63 Administering Processes Figure 5-33 Process Administration sub-menu Figure 5-33 illustrates how to access the Process Administration sub-menu from a process instance. A process can be cancelled using the menu Administration => Cancel Process. OTL Software Ltd., Confidential and Proprietary Information 5-64 PATROL for Tivoli Storage Manager by OTL Software - User Guide Generating Reports The following reports are available in the PATROL for Tivoli Storage Manager: • => Reports => Automated Library Contents - reports the library volume contents of the automated library instance • Daemons => Reports => Daemon List - lists all running Tivoli Storage Manager daemons • Databases => Reports => Database Backup Volume History reports server database backup volume history for the last 7 days. • => Reports => Database Volumes - reports information about server database volumes and volume copies. • => Reports => Domain Schedule - displays the schedule for the selected domain instance for the next 24 hours • Logs => Reports => Activity Log Messages - reports all messages logged today (since midnight) • Mount Requests => Reports => Mount Requests - reports a list of all pending mount requests • Processes => Reports => Active Processes - reports a list of all active processes on the managed node • => Reports => Volumes List - reports all volumes in the selected storage pool, and their states 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 Working with the KM 5-65 Debugging the KM This section describes the steps for enabling and disabling the debug feature for the PATROL for Tivoli Storage Manager. 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. To Enable (and Disable) KM Debug Mode Step 1 Select the menu Configuration => Debug from the main TSM KM container instance (labelled: Tivoli Storage Manager or TSM_SETUP). The TSM KM Debug Configuration dialog will be displayed, as shown in Figure 5-34. Figure 5-34 TSM KM Debug Configuration dialog OTL Software Ltd., Confidential and Proprietary Information 5-66 PATROL for Tivoli Storage Manager by OTL Software - User Guide 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 TSM KM Object Debug Switch Association Object Debug Switch Application Classes Collector Parameters Server TSM_SERVER TSMCreateDistribution TSMRemoveTempFiles TSMUpdateAgent Database TSM_DATABASE_CONTAINER TSM_DATABASE TSMDatabaseCollector Log TSM_LOG_CONTAINER TSM_LOG TSMLogCollector Client TSM_CLIENT_CONTAINER TSM_CLIENT TSMClientCollector Device TSM_LIBRARY_CONTAINER TSM_LIBRARY TSM_LDEVICE TSM_DEVICE_CONTAINER TSM_DEVICE TSMLibraryCollector TSMDriveCollector Daemon TSM_DAEMON_CONTAINER TSM_DAEMON TSMDaemonCollector Pool TSM_POOL_CONTAINER TSM_POOL TSMPoolCollector Backup TSM_POLICY_CONTAINER TSM_POLICY TSM_PCLIENT TSM_JOB_CONTAINER TSM_JOB TSM_MOUNT_CONTAINER TSM_MOUNT TSMDomainCollector TSMJobCollector TSMRequestCollector Process TSM_PROCESS_CONTAINER TSM_PROCESS TSMProcessCollector OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-67 Note If debugging for an object is turned on, debugging for the following is also enabled for all application classes with that object: menus, InfoBoxes, recovery actions for consumer parameters, pre-discovery and discovery functions defined under an application class. 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/TSM/debug on Unix systems • %PATROL_HOME%\lib\TSM\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 Tivoli Storage Manager 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 TSM KM login user. • The Send to Task Window option allows you to view the debug messages easily, as they occur. The window is labelled TSM KM Debug Output and appears on all connected PATROL Consoles. OTL Software Ltd., Confidential and Proprietary Information 5-68 PATROL for Tivoli Storage Manager by OTL Software - User Guide 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. 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 TSM KM Debug Output window is located in the Tasks folder under the PATROL Main Map. Step 4 Select OK to start TSM 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 TSM KM data collectors. You can force the data collection as described in “Refreshing Parameters” on page 5-72. 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 TSM KM Debug Configuration dialog again, and turn off all debug switches by clicking Off as appropriate, and click OK. OTL Software Ltd., Confidential and Proprietary Information Working with the KM 5-69 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 TSM 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. 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 TSM 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: • • tsm_km_debug__