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-3: Add Data Collector on 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 IT Analytics Domain you wish to associate with the Collector and your Auto-upgrade options. Please refer to the table below for additional details regarding each field.
Although the Data Collector name can be anything, Cohesity recommends that the Data Collector name be the hostname of the server the Data Collector software is installed on. In the example below, we use the Data Collector Server Name followed by "_DC".
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.
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
.jsonfile has been created. This file is required when you configure and register your Data Collector. - Click OK.
Many 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 |
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 the procedure above..
- 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
.keyfile has been created is displayed. This file is required when you configure and register all Data Collector versions of 11.2 and earlier.A message indicating that a
.keyor a.jsonfile has been created is displayed. The.keyis required when you configure and register your NetBackup IT Analytics 11.2 or earlier Data Collector. The.jsonfile is required when you configure and register your NetBackup IT Analytics 11.3 or later - Get the
.keyor.jsonfile path.Download and copy the
.keyor.jsonfile to the NetBackup primary server when you configure the Data Collector.