Search <book_title>...

NetBackup IT Analytics Data Collector Installation and Configuration Guide for Veritas NetBackup

Last Published: 2025-03-04

Product(s): NetBackup IT Analytics (11.5)

Configure Data Collector on non-clustered NetBackup 10.4 and later primary server

This section assumes you are running NetBackup 10.4 or later, on a non-clustered NetBackup primary.

Step-1: HTTPS requirement

The default NetBackup IT Analytics configuration is HTTP Port 80 between the Data Collector and the Web Portal, and between the User's Web Browser to the NetBackup IT Analytics Portal. If HTTP is not acceptable in your environment, you must configure HTTPS before proceeding. Once the Data Collection Policy configuration is complete, continue to Step-2: Add Data Collector in the NetBackup IT Analytics Portal. If HTTP is acceptable, continue with Step-2: Add Data Collector in the NetBackup IT Analytics Portal.

Step-2: Add Data Collector in the NetBackup IT Analytics Portal

To add a Data Collector

Select Admin > Data Collection > Collector Administration. The list of currently configured Portal Data Collectors is displayed. If a Data Collector has already been created, rather than creating a new Data Collector, you may want to add your collection policies to an existing Data Collector.
Click Add Collector.

On the Add Collector screen, you will need to define the Collector Name, Passcode and select the Portal Domain you wish to associate with the Data Collector and your auto-upgrade options. Please refer to the table below for additional details regarding each field.

Although you can have any name for the Data Collector, it is recommended that the Data Collector name be the hostname of the NetBackup Primary Server. In the example below, the NetBackup Primary Server Name is used followed by "_DC" as an abbreviation for Data Collector. The Enable SSL checkbox is visible only if the NetBackup IT Analytics Portal is configured for SSL.

Note:

Copy the Data Receiver URL at the bottom of the Add Collector screen. The host name in this URL, executed on the NetBackup Primary, must resolve to the NetBackup IT Analytics Portal Server's IP Address.

Table: Field description

Field	Description
Collector Name*	The collector name cannot include a space and is case sensitive. The names must match exactly as entered in the Data Collector configuration screen and the Data Collector Installer screen. Edit the unique name assigned to this Data Collector. The Data Collector will use this value for authentication purposes. Changing the Collector ID or passcode requires manual changes to the corresponding Data Collector server. Collection will break if these corresponding changes are not made.
Passcode*	Edit the passcode assigned to this Data Collector. It can be any character sequence. Unlike other system passwords (which are encrypted and then saved) this Data Collector passcode is not encrypted prior to saving in the database and may appear as clear case in certain files. It simply is intended as a "handshake" identification between the Data Collector and the policy. Changing the Collector ID or passcode requires manual changes to the corresponding Data Collector server. Collection will break if these corresponding changes are not made. You can use the following OS-specific special characters in the passcode. Make sure the special characters you include are supported on the OS where the Data Collector is installed. You can specify from one to 128 characters in your passcode. Linux: !@#%^* Windows: !@#$%^&*()
Short Notes	Descriptive notes associated with this Data Collector.
Enable SSL	Both secure (SSL) and non-secure Data Collectors can send data to the same Portal. Check this box to select the secure communication protocol (https) that the Data Collector will use. This check box will not appear in the dialog box if SSL is not enabled in your environment. The Portal data receiver must be listening for https traffic; for example: https://agent.mycollector.com
Auto-upgrade aptare.jar	Indicate if you want this configuration file upgraded automatically. This part of the Data Collector is responsible for event and metadata processing threads. The .jar file contains the processing and parsing logic for data collection. The latest versions can be downloaded automatically and applied to the collector during upgrades. It is recommended that this setting be set to Yes.
Auto-upgrade Upgrade Manager	Indicate if you want this configuration bundle upgraded automatically. This Data Collector component is responsible for managing Data Collector upgrades. The latest versions can be downloaded automatically and applied to the collector during upgrades. It is recommended that this setting be set to Yes.

Click OK. You will now be presented with the following message, indicating that a .json file has been created. This file is required when you configure and register your data collector.

Click OK. Copy the .json file to the NetBackup Primary Server.

Step-3: Configure the Data Collector from the NetBackup Web UI

The Data Collector reports NetBackup information to NetBackup IT Analytics or to Veritas Alta View. The Data Collector is installed along with a NetBackup installation or upgrade.

For NetBackup 10.4 or higher, you can register their Data Collector directly from the NetBackup Web UI by adding a .json file.

To register the Data Collector from the NetBackup Web UI:

On the top right corner within the NetBackup Web UI, click the Cog icon and select Data Collector Registration.
Click Register with Veritas NetBackup IT Analytics.
Click Choose file to select the registration file (JSON) that you have created earlier.
If required, click the Proxy server option to specify Proxy server settings.
Click Register.

To validate the Data Collector communication with the Portal, go to /usr/openv/analyticscollector/mbs/bin/ and run ./checkinstall.sh. If the Data Collector is able to communicate with the NetBackup IT Analytics Portal, the response is displayed as SUCCESS.

Note:

The host name in data receiver URL, executed from the NetBackup Primary, must resolve to the Portal server's IP Address.

If the agent URL is is enabled with SSL and is created with self-signed certificate, ensure that you follow the steps in the Test and troubleshoot SSL configurations.

See Test and troubleshoot SSL configurations.

Step-4: Verify the Data Collector is online from the portal

Login to the NetBackup IT Analytics Portal.
Go to Admin > Data Collection > Collector Administration and verify whether the Data Collector is ONLINE.

Step-5: Confirm the Data collector is updated

On the NetBackup IT Analytics Portal, go to Admin > Data Collection > Collector Updates and select the Data Collector for which the component needs to be upgraded. Version must match the required versions and there should be no version displayed in red text.

Step-6: Configure the data collection policy

Please refer to Chapter 3: Configuring NetBackup Collection Policies. Once the Data Collection Policy configuration is complete, continue to Step-7.

See “Installing the Data Collector software”.

Step-7: Confirm that the NetBackup data collection policy is collecting data

Select Collector Administration and confirm that the Policy State column is showing Collecting, for the Veritas NetBackup collection policy, or has a green check mark under the Status column, indicating a successful collection. Note that you may need to Refresh the screen for several minutes.