NetBackup IT Analytics Data Collector Installation and Configuration Guide for Cohesity NetBackup
- Introduction
- Configure a NetBackup IT Analytics Distributed Data Collector on a NetBackup Primary Server
- Overview
- Configure Data Collector on non-clustered NetBackup 10.4 and later primary server
- Configuration workflow for NetBackup 10.1.1, 10.2, 10.2.01, 10.3 or 10.3.0.1 on a non-clustered NetBackup primary server
- Configure Data Collector on non-clustered NetBackup 10.1.1, 10.2, 10.2.01, 10.3 or 10.3.0.1 primary server
- Configuration workflow for NetBackup versions lower than 10.1.1
- Configure Data Collector on NetBackup primary with version lower than 10.1.1
- Configure a Veritas NetBackup Data Collector Policy
- Veritas NetBackup Data Collector policy configuration prerequisites
- Prerequisites for collection from Cohesity NetBackup deployed on Kubernetes clusters
- Create NetBackup Data Collector Role, Service Account, and API Key
- Add a Veritas NetBackup Data Collector policy
- Add/Edit NetBackup Primary Servers within the Data Collector policy
- Configuring file analytics in NetBackup Data Collector policy
- Installing the Data Collector software
- Introduction
- Considerations to install Data Collector on non-English systems
- Install Data Collector Software on Windows
- Install Data Collector software on Linux
- Configure Data Collector manually for Cohesity NetBackup
- Install Data Collector binaries on Windows (without configuration)
- Install Data Collector binaries on Linux host (without configuration)
- Override default Java Heap memory (XMX) value for Data Collector utilities
- Configure SSL
- SSL/TLS certificate configuration
- SSL implementation overview
- Obtain an SSL certificate
- Update the web server configuration to enable SSL on the Portal server
- Enable / Disable SSL for a Data Collector
- Enable / Disable SSL for emailed reports
- Test and troubleshoot SSL configurations
- Keystore file locations on the Data Collector server
- Import a certificate into the Data Collector Java keystore
- Keystore on the portal server
- Add a virtual interface to a Linux server
- Add a virtual / secondary IP address on Windows
- Centralized Data Collector for NetBackup - Prerequisites, Installation, and Configuration
- Overview
- Step-1: Choose operating system and complete prerequisites
- Step-2: HTTPS requirement
- Step-3: Add Data Collector on NetBackup IT Analytics Portal
- Step-4: Create NetBackup Data Collector Role, Service Account, and API Key
- Step-5: SSH/WMI
- Step-6: Install the Data Collector
- Step-7: Configure Data Collector
- Step-8: Verify the Data Collector is online from the Portal
- Step-9: Confirm that the Data Collector is updated
- Step-10: Configure the data collection policy
- Step-11: Confirm that the NetBackup data collection policy is collecting data
- Upgrading Data Collector Locally
- Overview
- Verification of upgrade bundle available on Data Collector server
- Upgrade the Upgrade Manager component
- Upgrade the Data Collector component which is the aptare.jar file
- Upgrade the Upgrade Manager and Data Collector components together
- Upgrade logs and upgrade related database views
- Resolve file lock issue on Windows host during Data Collector upgrade
- Clustering Data Collectors with VCS and Veritas NetBackup (RHEL)
- Clustering Data Collectors with VCS and Veritas NetBackup (Windows)
- Install and configure NetBackup IT Analytics Data Collector on MSCS environment
- Data Collector Policy Migration
- Pre-Installation setup for Veritas NetBackup appliance
- Pre-installation setup for Veritas Flex Appliance
- Data Collector Troubleshooting
- Resolving Data Collectors connections issues - Linux specific
- Resolving Data Collectors connections issues - Windows specific
- Portal upgrade performance issues
- Configuring web proxy updates
- Host resources troubleshooting
- Host resources: Check the status of the WMI proxy server
- Host resources: Post-Installation verification
- Host resources: Check host connectivity using standard SSH
- Host resources: Check host connectivity
- Host resources: Check host connectivity using Host Resource Configuration file
- Host resources: Generating host resource configuration files
- Host resources: Check the execution of a command on a remote server
- Host resources Data Collection
- Host resources: Collection in stand-alone mode
- Configuring parameters for SSH
- Identifying Windows file system access errors (File Analytics)
- Collect from remote shares (File Analytics)
- Adding a certificate to the Java keystore
- Override default Java Heap memory (XMX) value for Data Collector utilities
- Appendix A. Configure Appliances
- Appendix B. Load historic events
- Introduction
- Load Commvault Simpana events
- Load EMC Avamar events
- Load EMC NetWorker events
- Load HP Data Protector events
- Load IBM Spectrum Protect (TSM) events
- Load Oracle Recovery Manager (RMAN) events
- Load Veeam Backup & Replication events
- Load Veritas NetBackup events
- Load Veritas Backup Exec events
- Corrections in duplication of clients
- Cohesity
- Dell EMC NetWorker Backup & Recovery
- Appendix C. Firewall configuration: Default ports
- Appendix D. CRON Expressions for Policy and Report Schedules
- Appendix E. Maintenance Scenarios for Message Relay Server Certificate Generation
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) .
The Data Collector reports NetBackup information to NetBackup IT Analytics or to Cohesity 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 Cohesity 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.
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 Cohesity 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.cmdwith 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 inx64\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.jarbetween 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.sampleon 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.jarbetween the Data Collector and the Portal, execution of the checkinstall.bat command starts an auto-update of the Data Collector.
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>.keyor<your-collector-name>.jsonfile 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
analyticscollectorat persisted location (for example,/mnt/nbdata/) using the following commands:cd "/mnt/nbdata/" mkdir analyticscollector
- Copy the
<your-collector-name>.keyfile to/mnt/nbdata/analyticscollectorinside the NetBackup primary host or container. - Exit from the container and copy the
<your-collector-name>.jsoninside 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.sampleand 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.jarbetween 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.
For more information about the Data Collector policy, see NetBackup IT Analytics User Guide.