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.
