Search <book_title>...

NetBackup IT Analytics Help

Last Published: 2025-03-04

Product(s): NetBackup IT Analytics (11.5)

Step-7: Configure Data Collector

For a NetBackup Server 10.4 or greater, proceed to Step-7A: Configure Data Collector for NetBackup 10.4 or later from its Web UI.
For earlier versions of NetBackup, proceed to Step-7B: Configure NetBackup IT Analytics Data Collector manually for earlier versions of NetBackup.
For a NetBackup Appliance or NetBackup Flex Appliance proceed to Step-7C: Configure Data Collector for NetBackup Appliances (including Flex appliance) .
For a NetBackup deployment on Kubernetes, proceed to Step-7D: Configure NetBackup IT Analytics for NetBackup deployment on Kubernetes

Step-7A: Configure Data Collector for NetBackup 10.4 or later from its 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.

Step-7B: Configure NetBackup IT Analytics Data Collector manually for earlier versions of 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-3: Add Data Collector on 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=

Update the value for each field with appropriate data. A sample response file is also available in the installer media in x64\ITA_DC\responsefile.cmd.

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  SUCCESSFUL.
Note:
If there is a version mismatch of aptare.jar between the Data Collector and the Portal, execution of the checkinstall.bat command starts an auto-update of the Data Collector.

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

Create a response file with the contents shown. 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=

Update the value for each field with appropriate data. A sample response file is available on the install media and from /usr/openv/analyticscollector/installer/responsefile.sample on the primary server.

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  SUCCESSFUL.
Note:
If there is a version mismatch of aptare.jar between the Data Collector and the Portal, execution of the checkinstall.bat command starts an auto-update of the Data Collector.

Step-7C: 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>
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 the  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 the  <your-collector-name>.key file to /mnt/nbdata/analyticscollector  inside the NetBackup primary host or container.
Exit from the container and copy the <your-collector-name>.json  inside the NetBackup primary host or container.
In case if the data-receiver is configured with self-signed certificate (https), user must add the certificate in the Data Collector.
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 SUCCESSFUL.
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 WatchDog is running (pid: 13312). 
IT Analytics MetaDataCollector is stopped.
IT Analytics EventDataCollector is stopped.
IT Analytics DataCollector process is running (pid: 13461).
IT Analytics On-demand process is running (pid: 13463).

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

Step-7D: Configure NetBackup IT Analytics 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>
```
Collect <your-collector-name>.key 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 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 if 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:

Open the responsefile.sample and add the following parameters:

COLLECTOR_REGISTRATION_PATH=<path to the .json file> 
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 SUCCESSFUL.
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 WatchDog is running (pid: 13312).
IT Analytics MetaDataCollector is stopped.
IT Analytics EventDataCollector is stopped.
IT Analytics DataCollector process is running (pid: 13461).
IT Analytics On-demand process is running (pid: 13463).
IT Analytics Message Relay Server process is running (pid: 13471)

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