Configuring Veritas NetBackup KM

Veritas NetBackup KM monitors your Veritas NetBackup environment within a centralized management console to ensure it runs efficiently 24 hours a day. This section provides general information about the monitoring settings that can be configured via the Monitoring Studio Web console.

Accessing Veritas NetBackup KM Web Interface

Veritas NetBackup KM can be configured and used via the Monitoring Studio Web interface. This interactive Web console also facilitates live interaction with Veritas NetBackup KM nodes and provides a user-friendly environment to manage specific configuration operations.

Once the KMs are properly installed, you can access the Web console to configure your Veritas NetBackup KM monitoring environment.

Version 10.1.00 or higher of Monitoring Studio X is required.

Enter the following URL in your Web browser: https://<patrol-agent>:<patrol-agent-port+262>/

Where: <patrol-agent> is the name of the host on which the PATROL Agent runs

and <patrol-agent-port+262> is the number you obtain when you add 262 to the PATROL Agent port number. This is the port number used by default by Monitoring Studio X.

For example, if your PATROL Agent is named <MyPatrolAgent> and the PATROL Agent Port is 3181, the URL to access the Monitoring Studio X Web interface is: https://MyPatrolAgent:3443/.

To access the Veritas NetBackup KM configuration page, from the Web console, click the KMs menu and select Veritas NetBackup KM.

Veritas NetBackup KM Main Page

The Veritas NetBackup KM page provides all the necessary options to help you configure the NetBackup Nodes and KM Settings including KM Debug properties. The configuration options are also accessible from the treeview of the Web console.

Configuring NetBackup Nodes Monitoring

Veritas NetBackup KM allows you to monitor several NetBackup master and media servers, and NetBackup appliances with one PATROL Agent.

To add a new node to your monitoring environment

  1. Click KMs > Veritas NetBackup from the Web Console
  2. Click the New Node… button.

Identify the Node

Provide the following information to identify the NetBackyp Master/Media server:

Property Description
Hostname or IP Address Enter the hostname or IP address of the NetBackup Master/Media Server to be monitored. For a local host, you may enter localhost.
System Type Specify whether the NetBackup node is a UNIX/Linux or Windows system.
Node ID ID to be used to store the node configuration in the PATROL Agent configuration. This Internal ID is automatically generated based on the Hostname or IP Address provided but can be edited if needed.
Enable Monitoring Set to ON by default. Turn this property OFF to disable the monitoring of the node.
Create a Separate Device in TrueSight Set to ON by default. Turn this property OFF if you do not want the NetBackup node to appear as a separate device in TrueSight.

Configure the KM User Account

A user account with administrative privileges must be configured to read and execute Veritas NetBackup application programs and access file systems. Enter the Username and Password required to execute NetBackup commands on the NetBackup node.

NetBackup commands can be executed as a sudo user on UNIX/Linux systems. To do so, turn the Use Sudo option ON and provide the full path of the Sudo Binary File.

Configure Advanced Settings (Optional)

Monitoring mode

By default, Veritas NetBackup KM is configured to operate in Single-node Mode. In a cluster environment, i.e. active on one cluster node and passive on others, false alarms and duplicate alerts may occur. To avoid such situation, you need to switch to Multi-node Mode, if you monitor Veritas NetBackup KM from cluster nodes.

  1. Click the Single-node Mode button to switch to Multi-node Mode
  2. Select the appropriate Cluster Application and provide the Failover Group Name which is online on one cluster node and offline on the others. Leave this field blank if you previously selected Veritas Cluster File System. The Veritas NetBackup KM will then monitor the entire cluster from the active master system, which is identified by the vxdctl -c mode command. This method requires vxconfigd in enable mode with its clustered state active
  3. Click the ADD NODE button to individually add the nodes you wish to monitor. Provide the following information:
  • PATROL Agent Hostname: the host from where this node is monitored
  • Node ID: the internal ID specified for the NetBackup node
  • Cluster Node Name: the hostname defined in the selected Cluster Application.

Click the Multi-node Mode button to switch back to Single-node Mode.

NetBackup Discovery

Veritas NetBackup KM automatically discovers the application paths and the node type and the default values are set to comply with most of NetBackup systems. However, you can customize these settings to better suit your requirements. Note that modifying discovery configurations should be used with caution as it affects the monitoring functionality.

To configure the NetBackup Discovery settings, click the Automatic button to turn on the Custom mode and provide the following information:

  • NetBackup Installation Path: Provide the path to the directory where the NetBackup software is installed. By default, Veritas NetBackup KM automatically locates the NetBackup software installation directory if you have installed the solution with the default recommended settings. If you have chosen to install the solution in a custom directory, you are required to provide its location.
  • NetBackup Log Path: Provide the full path to the NetBackup Log file to be monitored. By default, Veritas NetBackup KM automatically locates the NetBackup log path based on the installation directory. For Windows events, prefix the filename with Events - (example: Events - Systems).
  • Node Type: Select the appropriate node type: media or master server. By default, Veritas NetBackup KM automatically discovers the type of node, i.e. set to Autodetect.

Click the Custom button to switch back to Automatic mode and discard all custom settings.

Monitored Components

By default, all NetBackup components are monitored with optimal configuration. However, you can disable and/or customize the monitoring of any component to better suit your requirements.

  1. Click ALL to switch to CUSTOM mode which will display the list of the monitored components. By default, all components are monitored (ON).
  2. Use the ON/OFF button to activate or deactivate the monitoring of any component in the list.
  3. The Job Monitoring properties can be fine-tuned by configuring the following properties:
Properties Description
Monitoring Duration for OK Status jobs Enter the number of hours/days a job with an OK status will be monitored.
Monitoring Duration for Suspicious Status jobs Enter the number of hours/days a job with an Suspicisous status will be monitored.
Monitoring Duration for Failure Status jobs Enter the number of hours/days a job with a Failure status will be monitored.
Keep Monitoring Active Jobs Indefinitely Turn ON to endlessly monitor active jobs.
Ignore Inactive Jobs Initially Turn ON if you want the inactive jobs not to be created in the initial discovery cycle. Initially discovering and monitoring inactive jobs may have impact on performance.
Ignore Alerting for Child Jobs Turn ON if you do not want to be notified when a job failure occurs on child jobs.

Remote Connection settings

When you configure the monitoring of a remote host, you may want to specify the time after which the connection to the remote node will timeout or the maximum number of simultaneous connections allowed to the remote node:

  • In the Connection Timeout field, enter the number of seconds after which the connection to the remote node will timeout
  • In the Maximum Connections field, enter the maximum number of simultaneous connections allowed to the remote node.

Important: Changing the values for these properties may impact the performance of your monitoring environment.

NetBackup KM Temp Paths

The default NetBackup KM temporary directory paths can be manually specified to better suit your requirements.

Click the DEFAULT button to switch to the CUSTOM mode and provide the following information:

  • Remote Temp Directory Path: Provide the path to the directory where the temporary files are saved on remote nodes. Default is /var/tmp (on UNIX/Linux) or C:\Windows\Temp (on Windows).
  • Local Temp Directory Path: Provide the path to the directory where the temporary files are saved on the PATROL Agent node (Default is <PATROL_HOME>/lib/NBU/tmp where PATROL_HOME is the PATROL Agent installation path)
Warning: Invalid paths may affect monitoring functionality.

Click the CUSTOM button to switch back to the DEFAULT mode and reset all path to their default settings.

KM Debug

If you suspect that the KM is not performing as expected, you can generate a KM Status Report by clicking the KM STATUS… button. This report provides details about the monitoring configuration of the KM and can be downloaded and forwarded to Sentry Software Support if required.

When you encounter an issue and wish to report it to Sentry Software, you will be asked to enable the Debug mode and provide the debug log to the Sentry Software Support team:

  1. Turn ON the Debug Mode to display the list of objects. By default, all objects will be turned ON.
  2. Turn OFF the objects you do not want to include in the log.
  3. In the Disable Debug Mode Automatically After field, enter the duration after which the debug mode will be turned off.
  4. In the Debug Directory Path field, indicate where the debug file must be stored (by default: <PATROL_HOME>/lib/NBU/debug). The debug folder must have at least 10MB of available disk space and read, write and execute permissions for both the PATROL Agent user and the Veritas NetBackup KM login user.

During debug logging, the debug log files can be listed and viewed in the Debug Files section. Click REFRESH to see the latest debug log files. These files can be deleted selectively or all at once by clicking DELETE ALL.

The Debug Mode can be turned OFF manually anytime. When the debug mode is turned off (manually or automatically), a compressed file is then created under <PATROL_HOME>/log/. This file is listed in the Compressed Debug Files for Support section.

KM Settings

The KM Settings page enables you to define the configuration mode and the Java Settings for Veritas NetBackup KM for PATROL.

Configuration Mode

Veritas NetBackup KM can either be used with the Monitoring Studio Web console (Classic Mode) or BMC TrueSight Operations Management (CMA Mode). When the KM is used with BMC TrueSight, operation settings cannot be customized via the Web interface. To force the configuration from the Web console, turn the Force Classic Configuration Mode option ON.

Java Settings

To operate properly, Veritas NetBackup KM requires that Java 1.8.00 or higher and a Java Runtime Environment (JRE) are installed on the same system that runs the PATROL Agent.

The Java Settings page displays information about the JRE currently in use and a list of all the JREs installed on the monitored system. You can also configure the following options to fine-tune the Java properties:

Options Description
Automatically Select Appropriate JRE To let Veritas NetBackup KM automatically find and use the most compatible JRE upon the initial discovery that occurs when the PATROL Agent and Veritas NetBackup KM start.
Execute the JVM as an Alternate User By default, the Java process is launched with the same credentials as the PATROL Agent. If the PATROL Agent’s default account does not have sufficient privileges to perform the operations required by the Java Collection Hub, another user account can be provided.
Java Minimum Heap Size To customize the minimum size (in MB) of the Java Hub Heap Memory according to your environment requirements. By default, the minimum size is set to 128 MB.
Java Maximum Heap Size To customize the maximum size (in MB) of the Java Hub Heap Memory according to your environment requirements. By default, the maximum size is set to 512 MB.
Disable JRE Pre-Validation By default, Veritas NetBackup KM checks that the selected JRE meets the requirements. However, you can disable this option to bypass the compatibility check. Use this option only if you are certain that the provided JRE is compatible even if the compatibility check fails. An unsuitable JRE will prevent Veritas NetBackup KM to operate properly.
JVM Arguments To provide arbitrary arguments to the java -jar … command line that Veritas NetBackup KM uses to launch the Java Collection Hub in the Command line options field.

The JVM needs to be restarted for your new settings to be taken in account.


You can export Veritas NetBackup KM configuration as a pconfig file (.CFG) that can be imported into a TrueSight CMA policy. All the Agents using the policy will therefore be able to monitor the same NetBackup nodes.

storage netbackup km patrol