Ransomware attackers specifically target and attempt to destroy backup systems to increase the probability of payment. Hardening your system is critical. Please ensure you have reviewed your platform security using the Security Hardening Checklist
Cohesity

COHESITY Documentation

Explore our documentation to get started, discover products & new features, access troubleshooting guides, register sources, platforms support.

Products
Data Security Alliance
Visit Cohesity.com
Demos
Support
Blogs
Developers
Partner Portals
Cohesity Community
© 2026 Cohesity, Inc. All Rights Reserved.
Terms of Use|
Privacy Policy|
Legal|
  1. Home
  2. IT Analytics Help
  3. Section IV. End user
  4. Manage and monitor data collection
  5. Add/Edit Data Collectors

Add/Edit Data Collectors

To enable the Data Collector server to pass data to the Portal server, a corresponding Data Collector must be created in the Portal, along with Data Collector policies for each of the vendor-specific enterprise objects. Data Collector policies are specific to the type of data that is being collected; however, multiple types of policies often can be combined within one Data Collector.

The first step is to create a Data Collector. Once created, you can add policies to it. Often one Portal Data Collector is sufficient for adding Data Collector policies for a variety of enterprise objects such as backup servers, arrays, and switches.

See Upgrade Data Collectors.

To add a Data Collector

  1. Select Admin > Data Collection > Collector Administration. The list of currently configured Portal Data Collectors is displayed. If a Data Collector has already been created, rather than creating a new Data Collector, you may want to add your collection policies to an existing Data Collector.
  2. Click Add Collector.

    See “To Edit a Data Collector”.

To Edit a Data Collector

  1. Search for Collector by name. Search returns results at the folder level and within the folder.

    See Navigating with search.

    Alternatively, select Admin > Data Collection > Collector Administration to browse for a collector. A list of currently configured Portal Data Collectors is displayed.

  2. Select a Data Collector from the list.
  3. Click Edit.
  4. Enter or modify fields as necessary.
  5. Click Generate Registration File.

Table: Field description

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. You can specify from one to 128 characters in your passcode.

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

Generate Registration File

This creates a registration file required for asymmetric encryption, also known as public-key cryptography. This provides additional security when data is collected.

Click to generate the registration file and download it to your local system. This is required for new installations and optional for upgrade scenarios.

When generating a new registration file, for example if a registration file is lost or data has been corrupted the following applies:

  • Generating a registration file disables all Data Collector policies associated with the collector and invalidates their credentials.

  • For each policy associated with the collector, you must re-enter all credentials and re-enable the policy.

See Data Collector encryption.

The Edit Collector pop-up displays Generate Registration File, Generate Key, or both depending on the collector configuration.

The conditions when the Edit Collector pop-up will display Generate Registration File, Generate Key, or both are described below:

  • When the Data Collector version configured on the Portal is less than or equal to 11.2.04, the Edit Collector pop-up will display Generate Key. This will generate the .key file when clicked.

  • When the Data Collector version configured on the Portal is greater than 11.2.04, the Edit Collector pop-up will display Generate Registration File. This will generate the .json file.

  • When the Data Collector is not configured on the Portal and its version is unknown, the Edit Collector pop-up will display Key File and Registration File options.

    You will observe this typically when a new Data Collector is added on the Portal. Select the Key File if the Data Collector installer version is 11.2.xx or lower. Select Registration File when the Collector installer version is 11.3.xx or higher, or when registration needs to be performed using the NBU Web UI.

Note:

See Generate key file to configure Data Collector v11.2.xx or lower for steps to generate key file from a newly created Data Collector.

Edit IT Analytics Data Collector credentials

The following table provides the steps you need to follow when you change the Data Collector credentials, such as Collector Name and Passcode. These steps are essential to establish the Data Collector connectivity with theIT Analytics Portal and seamless data collection.

Follow the steps provided in the table after you:

  1. Search for Collector by name on the Portal. Search returns results at the folder level and within the folder.

    See Navigating with search.

    Alternatively, select Admin > Data Collection > Collector Administration to browse for a collector. A list of currently configured Portal Data Collectors is displayed.

  2. Select a Data Collector from the list.
  3. Click Edit.
  4. Click Change on the Edit Collector pop-up.

    A warning message is displayed that indicates the impact of making edits to the Data Collector name and passcode. Click OK and proceed to the next steps.

Table: Edit IT Analytics Data Collector credentials

Task

Procedure

Remarks

Change only Passcode

  1. Change the Passcode value.

  2. Click OK to save the changes.

  3. Update the new passcode value in mbs/conf/collector.properties file in plain text on the Data Collector server.

  4. Run updateconfig.bat

  5. Start the Aptare Agent.

This does not require generating a new registration file.

Change only Collector Name

  1. Change the Collector Name value.

  2. Click Generate Registration File and note the .json file path.

  3. Click OK to save the changes.

    A new registration file (.json file) gets downloaded.

  4. Run reconfigureDC.bat/sh <.json file path> on the Data Collector server.

This change generates and downloads a new registration file.

Change both Collector Name and Passcode

  1. Change the Collector Name and Passcode values.

  2. Click Generate Registration File and note the .json file path.

  3. Click OK to save the changes.

    A new registration file (.json file) gets downloaded.

  4. Run reconfigureDC.bat/sh <.json file path> on the Data Collector server.

This change generates and downloads a new registration file.

Feedback

Was this page helpful?
Previous

About validation and status

Next

Generate key file to configure Data Collector v11.2.xx or lower

Feedback

Was this page helpful?