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.1.1, 10.2, 10.2.01, 10.3 or 10.3.0.1 primary server

Step-1: HTTPS requirement

The default NetBackup IT Analytics configuration is HTTP Port 80 between the Data Collector and the Portal and between the User's Web Browser to the NetBackup IT Analytics Web Portal. If HTTPS is required, then follow the steps detailed in Chapter 5: Configure SSL. Once SSL is set up, continue with Step-2: Add Data Collector in the NetBackup IT Analytics Portal. Alternatively, if you are just configuring with HTTP, continue with Step-2: Add Data Collector in the NetBackup IT Analytics Portal.

See “Configure SSL”.

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

Once logged in to the Portal:

Select Admin > Data Collection > Collector Administration.
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.

Table: Field description

Field	Description
Collector Name*	The collector name cannot include a space and is case sensitive. The names should 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.

Some older NetBackup releases came bundled with NetBackup IT Analytics Data Collector software that leveraged a .key file rather than a .json file. The configuration steps are slightly different depending on the file type required to configure the Data Collector. Listed below is a table that shows what versions of the NetBackup IT Analytics Data Collector binaries are installed on which versions of NetBackup. This table is also applicable to NetBackup Appliances and Flex Appliances. By checking the NetBackup version installed on the appliance, you can determine whether to use a .key or a .json file, when configuring the Data Collector.

Table: Reference for .key and .json usage

NetBackup version	NetBackup IT Analytics Data Collector version installed on NetBackup	.key or .json file to be used
10.1.1	11.1.50	.key
10.2	11.2.00	.key
10.2.0.1	11.2.00	.key
10.3	11.2.05	.key
10.3.0.1	11.2.05	.key
10.4	11.3.02	.json
10.4.0.1 (or later)	11.3.04 (or later)	.json
10.5	11.4.03	.json
11.0	11.5.04 (or later)	.json

To download the .key file:

Login to the Portal and go to Admin > Collector Administration.
Select the Data Collector you just created, as described in Step-2: Add Data Collector in the NetBackup IT Analytics Portal.
Click Edit.
Select Key File.
Note the following information:
- Name of the Data Collector (as it appears on the Portal)
- Passcode of the Data Collector (as configured on the Portal)
- Data receiver URL (generated while creating the Data Collector on the Portal)
Note:
The host name in data receiver URL, executed from the NetBackup primary, must resolve to the Portal server's IP address.
Click Generate.
Following message, which indicates that a .key file has been created is displayed. This file is required when you configure and register all Data Collector versions of 11.2 and earlier.
Note the .key file path.

If your Data Collector version is 11.3 or higher, you must download the .json file from the Portal.

The .key or the .json file needs to be downloaded and copied to the NetBackup primary server, when you manually configure the Data Collector.

For a NetBackup Server, proceed to Step 2A: Configure the NetBackup IT Analytics Data Collector manually for NetBackup .
For a NetBackup Appliance or NetBackup Flex Appliance proceed to Step-2B: Configure Data Collector for NetBackup Appliances (including Flex appliance).
For a NetBackup deployment on Kubernetes, proceed to Step-2C: Configure Data Collector for NetBackup deployment on Kubernetes.

Step 2A: Configure the NetBackup IT Analytics Data Collector manually for NetBackup

This section details the steps required to manually configure the Data Collector using a .key file. This configuration requires editing a response file to configure the distributed Data Collector, installed by default on the non-clustered NetBackup primary. The Veritas NetBackup primary server installation will deploy NetBackup IT Analytics Data Collector binaries automatically on Windows ( C:\Program Files\Veritas\AnalyticsCollector) and Linux (/usr/openv/analyticscollector).

The NetBackup IT Analytics Portal must be already installed in your data center and a Data Collector entry must be added via the Collector Administration screen of the portal for each NetBackup primary server before you perform this configuration.

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

To configure the Data Collector manually on Windows using .key file:

Create a response file as a batch script responsefile.cmd with the contents shown. These are the responses to the user input required to configure the Data Collector. A sample response file is also available in the installer media in x64\ITA_DC\responsefile.cmd.

SET DATACOLLECTOR_NAME=name_of_the_data_collector 
SET DATACOLLECTOR_PASSCODE=passcode_for_the_data_collector 
SET DATARECEIVER_URL=data_receiver_URL 
SET DATACOLLECTOR_KEY_FILE_PATH=path_to_the_key_file 
SET HTTP_PROXY_CONF=N 
SET PROXY_HTTP_URL= 
SET PROXY_HTTP_PORT= 
SET PROXY_HTTPS_URL= 
SET PROXY_HTTPS_PORT= 
SET PROXY_USERID= 
SET PROXY_PASSWORD= 
SET PROXY_NOT_FOR=

To configure the Data Collector manually on Windows using .json file, create the below batch script. A sample response file is also available in the installer media in x64\ITA_DC\responsefile.cmd.

SET DATACOLLECTOR_REGISTRATION_FILE_PATH=path of .json 
SET HTTP_PROXY_CONF=N 
SET PROXY_HTTP_URL= 
SET PROXY_HTTP_PORT= 
SET PROXY_HTTPS_URL= 
SET PROXY_HTTPS_PORT= 
SET PROXY_USERID= 
SET PROXY_PASSWORD= 
SET PROXY_NOT_FOR=

Update the value for each field with appropriate data.

Run the command shown:

"C:\ProgramData\Veritas\NetBackup IT Analytics\DC\configure.cmd" 

\RESPFILE:response_file_path \INSTALL_TYPE:CONFIG

Validate the Data Collector integration with NetBackup IT Analytics by going to C:\Program Files\Veritas\analyticscollector\mbs\bin\ and running this command: checkinstall.bat.
If the Data Collector is configured with the 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.

To configure the Data Collector manually on Linux using .key file:

Create a response file with the contents shown. A sample response file is available on the install media and from /usr/openv/analyticscollector/installer/responsefile.sample on the primary server. These are the responses to the user input required to configure the Data Collector:

COLLECTOR_NAME=name_of_the_data_collector 
COLLECTOR_PASSCODE=passcode_for_the_data_collector 
DR_URL=data_receiver_URL 
COLLECTOR_KEY_PATH=path_to_the_key_file 
HTTP_PROXY_CONF=N 
HTTP_PROXY_ADDRESS= 
HTTP_PROXY_PORT= 
HTTPS_PROXY_ADDRESS= 
HTTPS_PROXY_PORT= 
PROXY_USERNAME= 
PROXY_PASSWORD= 
PROXY_EXCLUDE=

To configure the Data Collector manually on Linux using .json file, create a responsefile as below. A sample response file is available on the install media and from /usr/openv/analyticscollector/installer/responsefile.sample on the primary server.

COLLECTOR_REGISTRATION_PATH=<path-to-registration-file-downloaded-from-portal-including-filename>
HTTP_PROXY_CONF=N
HTTP_PROXY_ADDRESS=
HTTP_PROXY_PORT=
HTTPS_PROXY_ADDRESS=
HTTPS_PROXY_PORT=
PROXY_USERNAME=
PROXY_PASSWORD=
PROXY_EXCLUDE=

Update the value for each field with appropriate data.

Run the command:

/usr/openv/analyticscollector/installer/dc_installer.sh -c responsefile_path

Validate the Data Collector integration with NetBackup IT Analytics by navigating to /usr/openv/analyticscollector/mbs/bin/ and running ./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.

Step-2B: Configure Data Collector for NetBackup Appliances (including Flex appliance)

You can configure a Data Collector on the primary server pod using the following steps. From NetBackup version 10.3 Cloud Scale release, Data Collector on primary server pod is supported. The below steps to configure the Data Collector on a primary server must be performed as a root user. On a Flex appliance, connect to the primary server pod first and then switch to the root user using sudo. On a NetBackup Appliance, access shell by creating NetBackup CLI user.

To configure NetBackup IT Analytics for NetBackup deployment:

Create a DNS server entry in such a way that IP of the Portal must be resolvable to a single FQDN. IP of the NetBackup IT Analytics Portal must be resolved to:
```
itanalyticsagent.<yourdomain> 
```
Note the following:
- If the Portal URL is itanalyticsportal.<yourdomain>, then ensure to add the DNS entries for the following hostnames: itanalyticsagent.<yourdomain>
- If the Portal URL is aptareportal.<yourdomain>, then ensure to add the DNS entries for the following hostnames: aptareagent.<yourdomain>
The above default values are based on the initial NetBackup IT Analytics Portal version installed.
Depending upon the Data Collector version, collect the <your-collector-name>.key or <your-collector-name>.json  file for the new Data Collector by accessing the Portal link and creating a collector. Copy it to the host machine from where NetBackup primary is deployed.
For more information, refer to  Data Collector Encryption section in NetBackup IT Analytics User Guide.
Create a new folder analyticscollector at persisted location (for example, /mnt/nbdata/) using the following commands:
```
cd "/mnt/nbdata/" 
mkdir analyticscollector 
```
Copy <your-collector-name>.key or <your-collector-name>.json  file to /mnt/nbdata/analyticscollector inside the NetBackup primary host or container.
In case the data-receiver is configured with self-signed certificate (https), user must add the certificate in the Data Collector.
See Configure the Data Collector to trust the certificate section in the NetBackup IT Analytics Administrator Guide.
Connect to the NetBackup primary host or the container.

Navigate to /usr/openv/analyticscollector/installer/ location and perform the following.

Open the responsefile.sample and add the following parameters:

If the Data Collector is lower than 11.3, create the response file with the following contents.

COLLECTOR_NAME=<your-collector-name>
COLLECTOR_PASSCODE=<your-password>
DR_URL=<http>/<https>://itanalyticsagent.<yourdomain> 
COLLECTOR_KEY_PATH=<path to your-collector-name.key> 
HTTP_PROXY_CONF=N 
HTTP_PROXY_ADDRESS=
HTTP_PROXY_PORT=
HTTPS_PROXY_ADDRESS= 
HTTPS_PROXY_PORT= 
PROXY_USERNAME= 
PROXY_PASSWORD= 
PROXY_EXCLUDE=

If the Data Collector version is 11.3 or later, create the response file with the following contents.

COLLECTOR_REGISTRATION_PATH=<path to .json file> 
HTTP_PROXY_CONF=N 
HTTP_PROXY_ADDRESS=
HTTP_PROXY_PORT=
HTTPS_PROXY_ADDRESS=
HTTPS_PROXY_PORT=
PROXY_USERNAME=
PROXY_PASSWORD=
PROXY_EXCLUDE=

Configure the Data Collector with the NetBackup IT Analytics Portal as follows.
Note:
If the Data Collector installed is of a lower version than the Portal, wait for the Data Collector auto-upgrade to finish before you proceed.
For NetBackup Appliance version 5.3 or later:
- Run the following command as a NetBackup CLI user:
```
/usr/openv/analyticscollector/installer/dc_installer.sh -c /usr/openv/analyticscollector/installer/responsefile.sample
```
- To verify the Data Collector integration with NetBackup IT Analytics Portal, run:
```
/usr/openv/analyticscollector/mbs/bin/checkinstall.sh
```
For NetBackup Appliance version 5.1.1:
- Run the following command as a NetBackup CLI user:
```
sudo /usr/openv/analyticscollector/installer/dc_installer.sh -c /usr/openv/analyticscollector/installer/responsefile.sample
```
- To verify the Data Collector integration with NetBackup IT Analytics Portal, run:
```
sudo /usr/openv/analyticscollector/mbs/bin/checkinstall.sh
```
If you are on Flex Appliance:
- Connect to the primary server container and then switch to root user using sudo and run:
```
/usr/openv/analyticscollector/installer/dc_installer.sh -c /usr/openv/analyticscollector/installer/responsefile.sample
```
- To verify the Data Collector integration with NetBackup IT Analytics Portal, run:
```
/usr/openv/analyticscollector/mbs/bin/checkinstall.sh 
```
If the Data Collector is configured with the Portal, it will display SUCCESS.
Note:
If there is a version mismatch of aptare.jar between Data Collector and Portal, execution of checkinstall.sh command will trigger an auto-update of the Data Collector. If the Data Collector can communicate with the NetBackup IT Analytics Portal, the response is shown as SUCCESS.

Check the Data Collector services status by running the following command and ensure that the following Data Collector services are up and running:

/usr/openv/analyticscollector/mbs/bin/aptare_agent status

Output of the above command:

IT Analytics Zookeeper Server is running (pid: 16137). 
IT Analytics Kafka Server is running (pid: 16145). 
IT Analytics WatchDog is running (pid: 7225). 
IT Analytics MetaDataCollector is stopped.
IT Analytics EventDataCollector is stopped.
IT Analytics DataCollector process is running (pid: 7365).
IT Analytics On-demand process is running (pid: 7361).
IT Analytics Message Relay Server process is running (pid: 7366).

For more information about the Data Collector policy, see NetBackup IT Analytics User Guide.

Step-2C: Configure Data Collector for NetBackup deployment on Kubernetes

You can configure Data Collector on the primary server. Following are the steps for respective configurations. From NetBackup version 10.3 Cloud Scale release, Data Collector on primary server is supported. The following steps to configure the NetBackup IT Analytics Data Collector need to be performed as root user. Connect to the primary server pod and then switch to root user using sudo.

To configure NetBackup IT Analytics for NetBackup deployment:

Create a DNS server entry in such a way that IP of the NetBackup IT Analytics Portal must be resolvable to a single FQDN. IP of the NetBackup IT Analytics Portal must be resolved to:
```
itanalyticsagent.<yourdomain>
```
Note the following:
- If the Portal URL is itanalyticsportal.<yourdomain>, then ensure to add the DNS entries for the following hostnames:
```
itanalyticsagent.<yourdomain> 
```
- If the Portal URL is aptareportal.<yourdomain>, then ensure to add the DNS entries for the following hostnames:
```
aptareagent.<yourdomain>
```
Depending upon the Data Collector version, collect <your-collector-name>.key or <your-collector-name>.json file for the new Data Collector by accessing the Portal link and creating a collector and copy it to the host machine from where Kubernetes cluster is accessed. For more information, see Data Collector Encryption section in NetBackup IT AnalyticsUser Guide.
Copy the <your-collector-name>.key or <your-collector-name>.json file to /mnt/nbdata/analyticscollector inside the NetBackup primary pod using the command:
```
kubectl cp <keyfile-name> <namespace>/<primary-pod-name>:/mnt/nbdata/analyticscollector
```
In case the data-receiver is configured with self-signed certificate (https), you must add the certificate in the data collector.

Execute the following command on the primary server pod:

kubectl exec -it -n <namespace> <primaryServer-pod-name> -- bash

Navigate to /usr/openv/analyticscollector/installer/ location and perform the following:

If the Portal version is lower than 11.3, create the response file with the following contents.

COLLECTOR_NAME=<your-collector-name>
COLLECTOR_PASSCODE=<your-password>
DR_URL=<http>/<https>://itanalyticsagent.<yourdomain>
COLLECTOR_KEY_PATH=<path to your-collector-name.key>
HTTP_PROXY_CONF=N
HTTP_PROXY_ADDRESS=
HTTP_PROXY_PORT=
HTTPS_PROXY_ADDRESS=
HTTPS_PROXY_PORT=
PROXY_USERNAME=
PROXY_PASSWORD=
PROXY_EXCLUDE=

If the Portal version is 11.3 or later, create the response file with the following contents.

COLLECTOR_REGISTRATION_PATH=<keyfile path>
HTTP_PROXY_CONF=N
HTTP_PROXY_ADDRESS=
HTTP_PROXY_PORT=
HTTPS_PROXY_ADDRESS=
HTTPS_PROXY_PORT=
PROXY_USERNAME=
PROXY_PASSWORD=
PROXY_EXCLUDE=

Run  this  command to configure Data Collector with Portal.

/usr/openv/analyticscollector/installer/dc_installer.sh -c /usr/openv/analyticscollector/installer/responsefile.sample

Validate Data Collector integration with NetBackup IT Analytics by performing the following:
- Go to usr/openv/analyticscollector/mbs/bin/.
- Run the command:
```
./checkinstall.sh 
```
If Data Collector is configured with the Portal, it will display as SUCCESS.
Note:
If there is a version mismatch of aptare.jar between Data Collector and Portal, execution of checkinstall.sh command will trigger an auto-update of the Data Collector.

Check the Data Collector services status by running the following command and ensure that the following Data Collector services are up and running:

/usr/openv/analyticscollector/mbs/bin/aptare_agent status

Output of the above command:

IT Analytics Zookeeper Server is running (pid: 16137).
IT Analytics Kafka Server is running (pid: 16145).
IT Analytics WatchDog is running (pid: 7225).
IT Analytics MetaDataCollector is stopped.
IT Analytics EventDataCollector is stopped.
IT Analytics DataCollector process is running (pid: 7365).
IT Analytics On-demand process is running (pid: 7361).
IT Analytics Message Relay Server process is running (pid: 7366)

Step-5: Verify the 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-6: 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.

Step-7: Configure the data collection policy

Please refer to Chapter 3: Configure a Veritas NetBackup Data Collector Policy . Once the Data Collection Policy configuration is complete, continue to Step-8.

See “Configure a Veritas NetBackup Data Collector Policy”.

Step-8: 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.