Installing and Uninstalling EMC NetWorker KM for PATROL

To be able to use EMC NetWorker KM for PATROL, you will have to:

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

Prerequisites

System Requirements

EMC NetWorker 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

EMC NetWorker KM for PATROL supports:

Software Version
EMC NetWorker 8 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 EMC NetWorker 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 EMC NetWorker KM with sudo user account on Solaris, HP-UX, AIX or Linux managed nodes Sudo (superuser do) 1.6.7 and higher
When running EMC NetWorker KM on Linux managed nodes Korn shell binary (/bin/ksh). Any
When running EMC NetWorker KM on Microsoft Windows x64 managed nodes Reg.exe patch KB948698 Any

Changes Required

Some changes must however be made to BMC PATROL to improve the performance of EMC NetWorker KM for PATROL. The PATROL Agent tuning variable /AgentSetup/AgentTuning/pslInstructionMax should be disabled by setting it to 0 (zero) or increased to at least 5,000,000. These settings apply to all EMC 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), xpconfig (on Unix) or PATROL Configuration Manager (PCM). Alternatively, you can use one of the following single line PSL command through the PATROL Console OS> prompt to update this tuning variable.

To disable the pslInstructionMax variable

%PSL pconfig("REPLACE","/AgentSetup/AgentTuning/pslInstructionMax",0);

To set the tuning variable to at 5,000,000

%PSL v="/AgentSetup/AgentTuning/pslInstructionMax";if(get(v)<5000000){pconfig("REPLACE",v,5000000);}

In large EMC 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 NetWorker KM data collectors are in an infinite loop. In this case you can set the tuning variable to 0 (zero) to disable this functionality.

For the Access Control List (ACL)

The KM stores all configuration information in the PATROL Agent configuration database (pconfig), under the /NSR/<node-id> and /Runtime/NSR/<node-id> paths. 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 make sure that the mode for PATROL Agent user includes “C” in the PATROL Agent variable /AgentSetup/accessControlList. Refer to the PATROL Agent Reference Manual for more details.

To support bash shell platforms when ksh is not installed

To collect EMC NetWorker stats when ksh is not installed on UNIX/Linux servers, you need to create a soft link for /bin/ksh to /bin/bash:

ln –s  /bin/bash /bin/ksh

Security Requirements

A user account with administrative privileges must be configured in BMC PATROL or BMC TrueSight Operations Management to read and execute EMC NetWorker 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 EMC NetWorker to execute application programs and access file systems
    • a non-root account, such as patrol, configured in EMC NetWorker application to administer the EMC NetWorker application.
  • On Windows platforms:

    • an administrator user
    • a non-administrator account, such as patrol, configured in EMC NetWorker application to administer the EMC NetWorker application. Refer to the EMC NetWorker System Administrator’s Guide for details on how to set up this type of account.

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

Access Permissions

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

  • /nsr or /opt/nsr or /opt/networker (on Unix)
  • C:\Program Files\nsr (on Microsoft Windows).

Here are the executable and library files accessed by the EMC NetWorker KM for PATROL 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

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)

EMC NetWorker KM for PATROL includes some scripts which should be executable by the PATROL Agent user and the NetWorker KM user. These scripts are stored under KM_HOME path, normally PATROL_HOME/lib/NSR.

To list all OS commands used by the EMC NetWorker 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/NSR/.*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/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\logs\savegrp.log
/var/adm/messages (on Solaris)
/var/adm/syslog/syslog.log (on HP-UX)

On Windows platforms the EMC NetWorker installation is identified by checking the Microsoft 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\NetWorker\”.

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 EMC NetWorker commands and OS commands listed above.

The code below also applies to all non-root users who may execute EMC NetWorker 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 EMC NetWorker installation path INSTALL_PATH, referenced below is normally /nsr,/opt/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/).

Warning: This non-root sudo user configured in the KM will be able to execute EMC NetWorker commands. To prevent unauthorized access, ensure that 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 NSRKMUSERS = user1, user2, user3
Defaults:NSRKMUSERS !lecture,!authenticate,!requiretty,\
env_keep+="PATH 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/*

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/NSR/* with the Remote Temp Directory Path, default /var/tmp/*, when monitoring remotely.

On HP-UX
User_Alias NSRKMUSERS = user1, user2, user3
Defaults:NSRKMUSERS !lecture,!authenticate,!requiretty,\
env_keep+="PATH 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/*

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/NSR/* with the Remote Temp Directory Path, default /var/tmp/*, when monitoring remotely.

On AIX & Linux
User_Alias NSRKMUSERS = user1, user2, user3
Defaults:NSRKMUSERS !lecture,!authenticate,!requiretty,\
env_keep+="PATH 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/*

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/NSR/* 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 EMC NetWorker KM for PATROL on several servers since it allows you to monitor multiple hosts from one agent.

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

Please refer to the sections below for information about the remote monitoring requirements:

JAVA

EMC NetWorker 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 as 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.

SSH/WMI Connection

An SSH (UNIX/Linux platforms) or a WMI (Windows platforms) connection is required to monitor remote EMC NetWorker servers. When using an SSH connection, the SSH host key authentication 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 EMC NetWorker 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 EMC NetWorker 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 EMC NetWorker 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 EMC NetWorker solution to be included in the package, specify its version, and click Next.

    Selecting the EMC NetWorker 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 EMC NetWorker KM for PATROL, click its action button inline and select Deploy and Install Packages.

    Installing the Package - Locating the Managed Device

  4. Select the EMC NetWorker KM for PATROL package and click Deploy and Install.

    Installing the Package - Selecting the EMC NetWorker 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.

Uninstalling EMC NetWorker KM for PATROL

To uninstall EMC NetWorker KM for PATROL:

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

    Uninstalling EMC NetWorker KM for PATROL - Managed Devices

  3. Locate the managed device on which EMC NetWorker KM for PATROL should be uninstalled, click its action button inline and select Uninstall Monitoring Solutions.

    Uninstalling EMC NetWorker KM for PATROL - Locating the Managed Device

  4. Check the EMC NetWorker KM for PATROL box and click Uninstall.

  5. Wait for EMC NetWorker KM for PATROL to be uninstalled. You can click the inline button to refresh the page and check the uninstall progress in the Deploy Status column.

Installing the TrueSight Presentation Server Component

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

  • emc-networker-3.2.00-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/emc-networker-3.2.00-tsps.zip

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

$ ./tssh componenttype update /tmp/emc-networker-3.2.00-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/mshw-tsps_20191013_002522
        Removed folder - /opt/bmc/TrueSightPServer/truesightpserver/bin/../modules/tomcat/webapps/mshw

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

        Supported plugin directory:mshw-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 EMC NetWorker KM TSPS Component is only to install on TSPS the files required by the Web UI.

There is no uninstallation procedure.

Keywords:
storage networker km patrol