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

Once logged in to the Portal:

1. Select Admin > Data Collection > Collector Administration.
2. Click Add Collector.

To download the .key file:

1. Login to the Portal and go to Admin > Collector Administration.
2. Select the Data Collector you just created, as described in Step-2: Add Data Collector in the NetBackup IT Analytics Portal.
3. Click Edit.
4. Select Key File.
5. 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.

6. 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.

7. Note the .key file path.

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

1. 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=

2. Update the value for each field with appropriate data.
3. Run the command shown:

   "C:\ProgramData\Veritas\NetBackup IT Analytics\DC\configure.cmd" 
   
   \RESPFILE:response_file_path \INSTALL_TYPE:CONFIG 

4. 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:

1. 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=

2. Update the value for each field with appropriate data.
3. Run the command:

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

4. 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.

To configure NetBackup IT Analytics for NetBackup deployment:

1. 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.

2. 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.

3. Create a new folder analyticscollector at persisted location (for example, /mnt/nbdata/) using the following commands:

   cd "/mnt/nbdata/" 
   mkdir analyticscollector 

4. Copy <your-collector-name>.key or <your-collector-name>.json  file to /mnt/nbdata/analyticscollector inside the NetBackup primary host or container.
5. 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.

6. Connect to the NetBackup primary host or the container.
7. 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=

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

9. 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).
   

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