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