Installing Veritas NetBackup KM for PATROL

To be able to use Veritas NetBackup KM for PATROL, you will have to:

  • Ensure that requirements are met
  • Import Veritas NetBackup KM for PATROL into TrueSight
  • Create the installation package
  • Install the package

Prerequisites

System Requirements

Veritas NetBackup KM for PATROL supports the following operating systems:

Operating System Version
AIX 5.1 and higher
HP-UX 11 and higher
Linux All distributions
Oracle Solaris 8 and higher
Windows 2008 and higher

Software Requirements

Veritas NetBackup KM for PATROL supports:

Software Version
Veritas NetBackup 5 and higher
BMC PATROL Agent Any version
BMC ProactiveNet Performance Management 9.5 and higher
BMC TrueSight Operations Management 10 and higher
Java 1.8 and higher

If you are running the Veritas NetBackup KM with sudo user account, or on AIX, LINUX, or Microsoft Windows x64 managed nodes, please verify these additional software requirements:

Purpose Software Version
When running Veritas NetBackup KM with sudo user account on Solaris, HP-UX, AIX or Linux managed nodes Sudo (superuser do) 1.6.7 or later
When running Veritas NetBackup KM on AIX managed nodes Default ncargs value for processing bpdbjobs output may not be sufficient. Check this attribute using: lsattr -EH -l sys0 | grep ncargs. If the value is below 16, increase it using: chdev -l sys0 -a ncargs=16 Any
When running Veritas NetBackup KM on Linux managed nodes Korn shell binary (/bin/ksh). Alternatively a soft link from /bin/ksh to /bin/bash will be needed. Any
When running Veritas NetBackup KM on Microsoft Windows x64 managed nodes Reg.exe patch KB948698 Any

Security Requirements

A user account with administrative privileges must be configured in BMC PATROL or BMC TrueSight Operations Management to read and execute Veritas NetBackup application programs and access file systems. Depending on the operating systems used, several options will be available.

The following user accounts can be used:

  • On Unix platforms:

    • a root user
    • a non-root user, such as patrol, that has sudo privileges on Veritas NetBackup to execute application programs and access file systems
    • a non-root account, such as patrol, configured in Veritas NetBackup application to administer the Veritas NetBackup application.
  • On Windows platforms:

    • an administrator user
    • a non-administrator account, such as patrol, configured in Veritas NetBackup application to administer the Veritas NetBackup application. Refer to the Veritas NetBackup System Administrator’s Guide for details on how to set up this type of account.
  • Users added to NBU_Admin user group in VxSS. Please make sure the credentials of this user do not expire using the utility nbac_cron.

The user login details are configured in the KM. The password is encrypted and stored in the PATROL Agent.

Access Permissions

The NetBackup KM user needs “read & execute” permission to executable and library files under the paths listed below. The Veritas NetBackup installation path INSTALL_PATH, referenced in the tables below is usually:

  • /usr/openv or /opt/VRTSnetbp (on Unix)
  • C:\Program Files\Veritas (on Microsoft Windows).

Here are the executable and library files accessed by the NetBackup KM User:

UNIX Microsoft Windows
INSTALL_PATH/netbackup INSTALL_PATH\NetBackup
INSTALL_PATH/netbackup/bin INSTALL_PATH\NetBackup\bin
INSTALL_PATH/netbackup/bin/admincmd INSTALL_PATH\NetBackup\bin\admincmd
INSTALL_PATH/netbackup/bin/goodies INSTALL_PATH\NetBackup\bin\goodies
INSTALL_PATH/volmgr/bin INSTALL_PATH\Volmgr\bin
INSTALL_PATH/volmgr/bin/goodies INSTALL_PATH\Volmgr\bin\goodies
INSTALL_PATH/lib C:\Program Files\Common Files\VERITAS Shared
/usr/openwin/lib INSTALL_PATH\NetBackup\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)
  • cluster (in Microsoft Cluster)

The Veritas NetBackup KM for PATROL includes some scripts which should be executable by the PATROL Agent user and the NetBackup KM user. These scripts are stored under KM_HOME path, normally PATROL_HOME/lib/NBU.

To list all OS commands used by the Veritas NetBackup KM for PATROL, execute the following PSL code from the PATROL Console, using PSL Task menu, after installing and loading the KM.

foreach var (grep("^/Runtime/NBU/.*CommandControls/",pconfig("LIST")))
{
  ctl=get(var);
  opt=ntharg(grep("Option",ctl),"2-"," =");
  nsa=ntharg(grep("NoSudoAttempt",ctl),"2-"," =");
  sua=ntharg(grep("SingleUserAttempt",ctl),"2-"," =");
  typ=ntharg(grep("CommandType",ctl),"2-"," =");
  cmd=nthargf(grep("CommandText",ctl),"2-","=","=");
  if(osp=="") { osp=trim(nthargf(grep("OSPlatform",ctl),"2-","=","="), " "); }
  fields=lines(ntharg(var,"1-","/"));
  old_host=host;
  host=(fields == 5)? ntharg(var,"3","/") : "localhost";
  if(host!=old_host)
  {
    if((osp!="WINDOWS") && sudoers) { printf("\n\nCommands used with sudo:\n%s",sort(sudoers)); }
    printf("\n\nOn %s:\n\n", host);
    i=0; sudoers=""; osp="";
  }
  if((typ == "")||(typ == "OS"))
  {
    met="";
    if(opt == "NoLogin") { met = "(run as patrol user)"; }
    elsif(nsa == "YES") { met = "(run as configured user without sudo)"; }
    elsif(sua == "YES") { met = "(run as supplied user - used in menu)"; }
  else
  {
    scmd=cmd;
    s=index(scmd,"%sudo");
    if(s) { scmd=replace(substr(scmd,s,length(scmd)),"%sudo",""); }
    sudoers=union(sudoers,ntharg(ntharg(scmd,1,">|"),"1-"," "," "));
  }
  printf("(%2d) %-30s %-40s: %s\n",i++,ntharg(var,fields,"/"),met,cmd);
  }
}
if((osp!="WINDOWS") && sudoers) { printf("\n\nCommands used with sudo:\n%s",sort(sudoers)); }
Paths and Files Accessed by PATROL Agent User
Unix Microsoft Windows
INSTALL_PATH/netbackup/db INSTALL_PATH\NetBackup\db
INSTALL_PATH/volmgr/database INSTALL_PATH\Volmgr\database
INSTALL_PATH/var INSTALL_PATH\NetBackup\var
INSTALL_PATH/netbackup/db/error/daily_messages.log INSTALL_PATH\NetBackup\db\error\log_<timestamp>
/var/adm/messages (on Solaris)
/var/adm/syslog/syslog.log (on HP-UX)
/var/log/messages (on Linux)

On Windows platforms the Veritas NetBackup installation is identified by checking the Microsoft Windows Registry: HKEY_LOCAL_MACHINE\SOFTWARE\Veritas\NetBackup\

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 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 NetBackup commands and OS commands listed in above.

The code below also applies to all non-root users who may execute NetBackup KM administration and report menu commands using their sudo privileges. The KM accepts any non-root user with the following sudo configuration in the sudoers file. Please replace user1, user2, user3 with appropriate KM user names. The Veritas NetBackup installation path INSTALL_PATH, referenced below is normally /usr/openv or /opt/VRTSnetbp 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 Veritas NetBackup commands. To prevent unauthorized access, 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 into 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 NBUKMUSERS = user1, user2, user3
Defaults:NBUKMUSERS !lecture,!authenticate,!requiretty,\
env_keep+="PATH LD_LIBRARY_PATH INSTALL_PATH KM_HOME KM_TEMP",env_reset
NBUKMUSERS ALL=/bin/*,/sbin/*,/usr/bin/*,/usr/sbin/*,\
INSTALL_PATH/netbackup/bin/*,\
INSTALL_PATH/netbackup/bin/admincmd/*,\
INSTALL_PATH/netbackup/bin/goodies/*,\
INSTALL_PATH/volmgr/bin/*,\
INSTALL_PATH/volmgr/bin/goodies/*,\
PATROL_HOME/lib/NBU/*,PATROL_HOME/bin/*

user1, user2, user3 must be replaced with username(s) used by the KM; INSTALL_PATH and PATROL_HOME with the relevant paths. PATROL_HOME paths are only required for local monitoring.

Replace PATROL_HOME/lib/NBU/ with the Remote Temp Directory Path, default /var/tmp/, when monitoring remotely.

On HP-UX
User_Alias NBUKMUSERS = user1, user2, user3
Defaults:NBUKMUSERS !lecture,!authenticate,!requiretty,\
env_keep+="PATH SHLIB_PATH INSTALL_PATH KM_HOME KM_TEMP",env_reset
NBUKMUSERS ALL=/bin/*,/sbin/*,/usr/bin/*,/usr/sbin/*,\
INSTALL_PATH/netbackup/bin/*,\
INSTALL_PATH/netbackup/bin/admincmd/*,\
INSTALL_PATH/netbackup/bin/goodies/*,\
INSTALL_PATH/volmgr/bin/*,\
INSTALL_PATH/volmgr/bin/goodies/*,\
PATROL_HOME/lib/NBU/*,PATROL_HOME/bin/*

user1, user2, user3 must be replaced with username(s) used by the KM; INSTALL_PATH and PATROL_HOME with the relevant paths. PATROL_HOME paths are only required for local monitoring.

Replace PATROL_HOME/lib/NBU/ with the Remote Temp Directory Path, default /var/tmp/, when monitoring remotely.

On AIX & Linux
User_Alias NBUKMUSERS = user1, user2, user3
Defaults:NBUKMUSERS !lecture,!authenticate,!requiretty,\
env_keep+="PATH LIBPATH INSTALL_PATH KM_HOME KM_TEMP",env_reset
NBUKMUSERS ALL=/bin/*,/sbin/*,/usr/bin/*,/usr/sbin/*,\
INSTALL_PATH/netbackup/bin/*,\
INSTALL_PATH/netbackup/bin/admincmd/*,\
INSTALL_PATH/netbackup/bin/goodies/*,\
INSTALL_PATH/volmgr/bin/*,\
INSTALL_PATH/volmgr/bin/goodies/*,\
PATROL_HOME/lib/NBU/*,PATROL_HOME/bin/*

user1, user2, user3 must be replaced with username(s) used by the KM; INSTALL_PATH and PATROL_HOME with the relevant paths. PATROL_HOME paths are only required for local monitoring.*

Replace PATROL_HOME/lib/NBU/ with the Remote Temp Directory Path, default /var/tmp/, when monitoring remotely.

Remote Monitoring Requirements

Remote monitoring is required for all servers or appliances on which no PATROL Agent can be installed. This feature is also interesting if you lack resources or time to deploy a PATROL Agent and Veritas NetBackup KM for PATROL on several servers since it allows to monitor multiple hosts from one agent.

Remote monitoring is not possible from a UNIX/Linux PATROL Agent system to a Windows-based NetBackup server.

Please refer to the sections below to find out the remote monitoring requirements:

JAVA

Veritas NetBackup KM requires Java 1.8 or higher and a Java Runtime Environment (JRE) to be installed on the same system that runs the PATROL Agent.

The KM will automatically detect the JRE path if it has been installed in the default location or under the BMC PATROL Agent installation path. If it has been installed in a different location, you will have to set JAVA_HOME for the Patrol Agent default account before starting the PATROL Agent.

You can download the Java Runtime Environment along with the KM on Sentry Software Web site.

NetBackup CLI User Account

A NetBackup CLI user is required to monitor NetBackup appliances. To create a NetBackup user account:

  1. Open an SSH session on the NetBackup appliance
  2. Log on as admin
  3. Enter the following command:

    Main > Manage > NetBackupCLI > Create UserName where UserName is the name to be used for the new user.

  4. Enter a password for this new user account

  5. A confirmation message appears stating the new user account was created successfully.

This user should have the privileges to execute NetBackup and OS commands as described in the Security Requirements section. The following sudo settings are therefore required on a NetBackup appliance:

# Added for NetBackup KM
User_Alias NBUKMUSERS = UserName
Defaults:NBUKMUSERS !lecture,!authenticate,\
env_keep+="PATH LIBPATH INSTALL_PATH KM_HOME KM_TEMP",env_reset

SSH/WMI Connection

An SSH (UNIX/Linux platforms) or a WMI (Windows platforms) connection is required to monitor remote NetBackup servers and appliances. When using an SSH connection, the SSH host key authentication, which is enabled by default on most NetBackup servers and appliances, must be disabled on the remote host.

To disable the SSH host key authentication:

  1. Open the global SSH configuration file (ssh_config) stored in the /etc/ssh/ directory on the remote host
  2. Add the line StrictHostKeyChecking no
  3. Save the file.

Importing the Monitoring Solution into TrueSight

The TrueSight Central Monitoring Repository may include the current versions of Veritas NetBackup KM for PATROL that you can use with BMC TrueSight. If the version available in the Repository does not correspond to the latest one, you will have to manually import it:

  1. Log on to the TrueSight Console
  2. From the navigation pane, select Administration > Repository
  3. Click the Installation Components tab

    Installation Components

  4. Check that the version of Veritas NetBackup KM for PATROL is actually the latest one. If not, download the latest version corresponding to your operating system (Windows or UNIX/Linux) available on Sentry’s Website

  5. Click Import
  6. Select Single solution
  7. Browse to the .zip source file

    Importing Veritas NetBackup KM for PATROL

  8. Click Import

  9. When the selected archive file is imported to the repository, click Close.

Creating the Installation Package

The installation package to deploy to managed systems can be created directly from TrueSight Presentation Server:

  1. Log on to the TrueSight Console
  2. From the navigation pane, select Administration > Repository
  3. Click the Deployable Packages tab
  4. Click Create Deployable Package
  5. Select the operating system and platform for which you want to create a package. The components available in the repository for the selected operating system and platform are displayed

    Selecting the Operation System and Platform

  6. Select the Veritas NetBackup solution to be included in the package, specify its version, and click Next

    Selecting the Veritas NetBackup KM for PATROL Solution

  7. Specify the Installation Directory and click Next

    Specifying the Installation Directory

  8. Provide the PATROL 3.x Product Directory and click Next

    Specifying the PATROL 3.x Product Directory

  9. Specify the BMC Product Startup Information and click Next

    Specifying the BMC Product Startup Information

  10. Provide the following information:

    • Name: Enter a unique name for the package
    • (Optional) Description: Enter a description of the package
    • Format: Select a file compression format for the package

    Providing the Installation Package Details

  11. Click Save

  12. Click Close. The package is now available in the Deployable Packages list.

Installing the Package

This chapter provides a step by step procedure to install a monitoring solution package:

  1. Log on to the TrueSight Console
  2. From the navigation pane, select Configuration > Managed Devices.

    Installing the Package - Managed Devices

  3. Locate the managed device on which you wish to install Veritas NetBackup KM for PATROL, click its action button inline and select Deploy and Install Packages.

    Installing the Package - Locating the Managed Device

  4. Select the Veritas NetBackup KM for PATROL package and click Deploy and Install.

    Installing the Package - Selecting the Veritas NetBackup KM for PATROL Package

  5. Wait for the installation to complete. You can click the inline button to refresh the page and check the installation progress in the Deploy Status column.

Installing the TrueSight Presentation Server Component

If you use Monitoring Studio X in TrueSight Presentation Server (TSPS) with its TSPS Component, you will need to install Veritas NetBackup KM’s TSPS Component in order to access Veritas NetBackup KM’s Web UI in TSPS.

Requirements

Versions of TrueSight Presentation Server and TrueSight Infrastructure Management must be v11.0 or higher.

At least one TrueSight Infrastructure Management component must be properly configured and running in TrueSight Presentation Server.

Monitoring Studio X KM version 10.1 or higher must be deployed on all Agents where you plan on using Veritas NetBackup KM’s Web UI.

Monitoring Studio X TSPS Component must be installed and configured in your TrueSight environment.

Installation

The installation of the Veritas NetBackup KM TSPS Component is performed on TrueSight Presentation Server (TSPS). You need to copy the installation file in a temporary location on the TSPS server itself (/tmp as in the example below):

  • veritas-netbackup-3.3.02-tsps.zip

Open a shell as the tsps user on the TSPS server, and execute the below command in the /opt/bmc/TrueSightPServer/truesightpserver/bin directory:

$ ./tssh componenttype add /tmp/veritas-netbackup-3.3.02-tsps.zip

If you are updating the Veritas NetBackup KM Component (i.e. it has already been installed on this TSPS server), you need to use the below command:

$ ./tssh componenttype update /tmp/veritas-netbackup-3.3.02-tsps.zip

Normally, TSPS will be restarted:

+-------------------------------------------------------------------------------------------+
|   BMC TrueSight Presentation Server - Command Line Interface 2018 version 11.3.01         |
|   Copyright 2014-2018. BMC Software, Inc. as an unpublished work.  All rights reserved.   |
+-------------------------------------------------------------------------------------------+


Extracting the zip content
target - /opt/bmc/TrueSightPServer/truesightpserver/bin/../componenttypes/nbu-tsps_20200207_064034
        Removed folder - /opt/bmc/TrueSightPServer/truesightpserver/bin/../modules/tomcat/webapps/nbu

        Copying war - /opt/bmc/TrueSightPServer/truesightpserver/bin/../componenttypes/nbu-tsps/app/nbu.war

        Supported plugin directory:nbu-tsps

        Restarting the server

Checking system requirements
Updated component type successfully.

Nothing else needs to be configured on TSPS (there is no Component to configure in Administration > Components). The purpose of the Veritas NetBackup KM TSPS Component is only to install on TSPS the files required by the Web UI.

There is no uninstallation procedure.

Keywords:
storage netbackup km patrol