Important Update: Cohesity Products Documentation
All Cohesity product documentation are now managed via the Cohesity Docs Portal: https://docs.cohesity.com/HomePage/Content/home.htm. Some documentation available here may not reflect the latest information or may no longer be accessible.
Arctera Insight Information Governance Administrator's Guide
- Section I. Getting started
- Introduction to Arctera Insight Information Governance administration
- Configuring Information Governance global settings
- About Information Governance licensing
- SQLite WAL mode
- Configuring SMTP server settings
- About scanning and event monitoring
- Monitoring Indexer Node Storage Utilization
- About filtering certain accounts, IP addresses, and paths
- About archiving data
- About Information Governance integration with Data Loss Prevention (DLP)
- Importing sensitive files information through CSV
- Configuring advanced analytics
- About open shares
- About user risk score
- Configuring file groups
- Configuring Workspace data owner policy
- Configuring Management Console settings
- About bulk assignment of custodians
- Configuring Watchlist settings
- Configuring Metadata Framework
- Proof of concept
- Section II. Configuring Information Governance
- Configuring Information Governance product users
- Configuring Information Governance product servers
- About Information Governance product servers
- Adding a new Information Governance server
- Managing Information Governance product servers
- Viewing Information Governance server details
- About node templates
- Adding Portal role to a Information Governance server
- Adding Classification Server role to a Information Governance server
- Assigning Classification Server to a Collector
- Associating a Classification Server pool to a Collector
- Viewing in-progress scans
- Configuring Information Governance services
- Configuring advanced settings
- Monitoring Information Governance jobs
- Rotating the encryption keys
- Viewing Information Governance server statistics
- About automated alerts for patches and upgrades
- Deploying upgrades and patches remotely
- Using the Upload Manager utility
- About migrating storage devices across Indexers
- Viewing the status of a remote installation
- Configuring saved credentials
- Configuring directory service domains
- About directory domain scans
- Adding a directory service domain to Information Governance
- Managing directory service domains
- Fetching users and groups data from NIS+ scanner
- Configuring attributes for advanced analytics
- Deleting directory service domains
- Scheduling scans
- Configuring business unit mappings
- Importing additional attributes for users and user groups
- Configuring containers
- Server Pools
- Section III. Configuring native file systems in Information Governance
- Configuring clustered NetApp file server monitoring
- About configuring a clustered NetApp file server
- About configuring FPolicy in Cluster-Mode
- Pre-requisites for configuring clustered NetApp file servers
- Credentials required for configuring a clustered NetApp file server
- Preparing a non-administrator local user on the clustered NetApp filer
- Preparing a non-administrator domain user on a NetApp cluster for Information Governance
- Persistent Store
- Preparing Information Governance for FPolicy in NetApp Cluster-Mode
- Preparing the ONTAP cluster for FPolicy
- About configuring secure communication between Information Governance and cluster-mode NetApp devices
- Enabling export of NFS shares on a NetApp Cluster-Mode file server
- Enabling SSL support for Cluster Mode NetApp auditing
- Configuring EMC Celerra or VNX monitoring
- Configuring EMC Isilon monitoring
- About configuring EMC Isilon filers
- Prerequisites for configuration of Isilon or Unity VSA file server monitoring
- Credentials required for configuring an EMC Isilon cluster
- Configuring audit settings on EMC Isilon cluster using OneFS GUI console
- Configuring audit settings on EMC Isilon cluster using the OneFS CLI
- Configuring Isilon audit settings for performance improvement
- Preparing Arctera Insight Information Governance to receive event notifications from an EMC Isilon or Unity VSA cluster
- Creating a non-administrator user for an EMC Isilon cluster
- Utilizing access zone's SmartConnect Zone/Alias mappings
- Purging the audit logs in an Isilon filer
- Configuring EMC Unity VSA file servers
- Configuring Hitachi NAS file server monitoring
- Configuring Windows File Server monitoring
- Configuring Arctera File System (VxFS) file server monitoring
- Configuring monitoring of a generic device
- Managing file servers
- About configuring filers
- Viewing configured filers
- Adding filers
- Add/Edit NetApp cluster file server options
- Add/Edit EMC Celerra filer options
- Add/Edit EMC Isilon file server options
- Add/Edit EMC Unity VSA file server options
- Add/Edit Windows File Server options
- Add/Edit Arctera File System server options
- Add/Edit a generic storage device options
- Add/Edit Hitachi NAS file server options
- Custom schedule options
- Editing filer configuration
- Deleting filers
- Viewing performance statistics for file servers
- About disabled shares
- Adding shares
- Managing shares
- Editing share configuration
- Deleting shares
- About configuring a DFS target
- Adding a configuration attribute for devices
- Configuring a DFS target
- About the DFS utility
- Running the DFS utility
- Importing DFS mapping
- Renaming storage devices
- Configuring clustered NetApp file server monitoring
- Section IV. Configuring SharePoint data sources
- Configuring monitoring of SharePoint web applications
- About SharePoint server monitoring
- Credentials required for configuring SharePoint servers
- Configuring a web application policy
- About the Information Governance web service for SharePoint
- Viewing configured SharePoint data sources
- Adding web applications
- Editing web applications
- Deleting web applications
- Adding site collections
- Managing site collections
- Removing a configured web application
- Configuring monitoring of SharePoint Online accounts
- About SharePoint Online account monitoring
- Configuring user with minimum privileges in Microsoft 365
- Creating an application in the Microsoft Azure portal
- Configuring application without user impersonation for Microsoft 365
- Adding SharePoint Online accounts
- Managing a SharePoint Online account
- Adding site collections to SharePoint Online accounts
- Managing site collections
- Configuring monitoring of SharePoint web applications
- Section V. Configuring cloud data sources
- Configuring monitoring of Box accounts
- Configuring OneDrive account monitoring
- Configuring Azure Netapp Files Device
- Managing cloud sources
- Section VI. Configuring Object Storage Sources
- Section VII. Health and monitoring
- Section VIII. Alerts and policies
- Configuring policies
- About Information Governance policies
- Managing policies
- Create Data Activity Trigger policy options
- Create User Activity Deviation policy options
- Create Real-time Data Activity Policy options
- Create Real-time Permitted User-based Activity Policy options
- Create Real-time Restricted User-based Activity Policy options
- Create Real-time Sensitive Data Activity policy options
- Managing alerts
- Configuring policies
- Section IX. Remediation
- Configuring remediation settings
- Section X. Reference
- Appendix A. Information Governance best practices
- Appendix B. Migrating Information Governance components
- Appendix C. Backing up and restoring data
- Appendix D. Arctera Information Governance health checks
- About Information Governance health checks
- Services checks
- Deployment details checks
- Generic checks
- Information Governance Management Server checks
- Information Governance Indexer checks
- Information Governance Collector checks
- Information Governance Windows File Server checks
- Information Governance SharePoint checks
- Classification server health checks
- Information Governance self service portal server health checks
- About Information Governance health checks
- Appendix E. Command File Reference
- Appendix F. Arctera Information Governance jobs
- Appendix G. Troubleshooting
- About general troubleshooting procedures
- About the Health Audit report
- Location of Information Governance logs
- Downloading Information Governance logs
- Migrating the data directory to a new location
- Troubleshooting FPolicy issues on NetApp devices
- Troubleshooting EMC Celera or VNX configuration issues
- Troubleshooting EMC Isilon configuration issues
- Troubleshooting SharePoint configuration issues
- Troubleshooting Hitachi NAS configuration issues
- Troubleshooting installation of Tesseract software
- Troubleshooting RHEL 9 upgrade issue
- Troubleshooting CyberArk Password Manager Configuration Issues
Viewing and managing the status of an operation
You can track and manage the progress of the operations that are initiated from the Information Governance Management Console. You can perform the following tasks from the Action Status page.
Create a bulk remediation request using a CSV file.
View the progress of an operation.
Cancel an ongoing operation.
Re-run a completed or canceled operation.
Delete a completed or canceled operation.
Note:
The Cancel and Re-run options are not supported for Delete Files action.
To create a bulk remediation request using a CSV file,
- Click Settings on the top ribbon and click Remediation > Action Status in the left pane.
- Click Create bulk remediation request using CSV file.
- If you are creating a request for the first time, click Download CSV template and save it on your machine.
- Open the file on your local machine and enter the required information in the prescribed format.
- Save the file and navigate back to Information Governance
- Select the desired action from the available options.
- Click Browse, select the saved file from your local machine and click Upload..
Note:
he maximum file size allowed for upload is 5 MB.
- Click OK on the success pop-up.
- Click Close to complete the process.
A new bulk action request using a CSV file will be created. You can view the newly created request under Remediation > Action Status.
Note:
The maximum allowed file size for upload is 5 MB.
You can also perform bulk remediation using the API.
The Bulk Remediation API provides a set of endpoints to automate large-scale file remediation actions such as deleting files, setting or removing Microsoft Information Protection (MIP) labels, archiving files, and applying custom actions.
This API is designed to process bulk operations using CSV input, enabling efficient handling of high-volume data governance and compliance tasks. Authentication is required, and rate limiting is enforced to ensure system stability.
To authenticate and get the API key, use the following login endpoint: /api?function=LOGIN&username=<USERNAME>&domain=<DOMAIN>&password=<PASSWORD>&format=json
Endpoint: POST /api/bulkRemediation?function=BulkRemediationAction&actionName=DELETE_FILES
Required Query Parameters:
function = BulkRemediationAction
actionName = DELETE_FILES
MATRIX_AUTH = API key (use as API Key header)
Request Body (Form-Data):
file = CSV file to be uploaded
Response: {"success": "Successfully created the bulk action request using CSV with workflow ID: {Workflow_id}"}
Endpoint: POST /api/bulkRemediation?function=BulkRemediationAction&actionName=SET_MIP_LABELS
Required Query Parameters:
function = BulkRemediationAction
actionName = SET_MIP_LABELS
labelName = Name of the MIP label
justificationMessage = Reason for applying label
MATRIX_AUTH = API key
Request Body (Form-Data): file = CSV file to be uploaded
Response: {"success": "Successfully created the bulk action request using CSV with workflow ID: {Workflow_id}"}
Endpoint: POST /api/bulkRemediation?function=BulkRemediationAction&actionName=REMOVE_MIP_LABELS
Required Query Parameters:
function = BulkRemediationAction
actionName = REMOVE_MIP_LABELS
justificationMessage = Reason for removal
MATRIX_AUTH = API key
Request Body (Form-Data): file = CSV file to be uploaded
Response: {"success": "Successfully created the bulk action request using CSV with workflow ID: {Workflow_id}"}
Endpoint: POST /api/bulkRemediation?function=BulkRemediationAction&actionName=ARCHIVE
Required Query Parameters:
function = BulkRemediationAction
actionName = ARCHIVE
retentionCategory = Retention category name
retentionOption = e.g., Create Shortcut
indexPropertyEnabled = true or false (optional)
MATRIX_AUTH = API key
Request Body (Form-Data):
file = CSV file to be uploaded
indexProperties = JSON array (only if indexPropertyEnabled is true)
Example indexProperties JSON:
[ {"type": "STRING", "set": "text", "name": "text name", "value": "text value"}, {"type": "INT", "set": "integer", "name": "integer name", "value": "10"}, {"type": "DATE", "set": "date", "name": "date name", "value": "2025-02-07T00:00Z"} ]
Response: {"success": "Successfully created the bulk action request using CSV with workflow ID: {Workflow_id}"}
Endpoint: POST /api/bulkRemediation?function=BulkRemediationAction&actionName=CUSTOM_ACTION
Required Query Parameters:
function = BulkRemediationAction
actionName = CUSTOM_ACTION
customActionId = ID of the custom action
MATRIX_AUTH = API key
Request Body (Form-Data): file = CSV file to be uploaded
Response: {"success": "Successfully created the bulk action request using CSV with workflow ID: {Workflow_id}"}
The API enforces throttling: users can trigger only one request per minute. Requests exceeding this limit will not be processed.
/api?function=LOGIN&username=administrator&domain=happy&password=C1@ssifyData&format=json
/api/bulkRemediation?function=BulkRemediationAction&actionName=DELETE_FILES
/api/bulkRemediation?function=BulkRemediationAction&actionName=ARCHIVE&retentionCategory=DIIntegrationRetentionCategory&retentionOption=Create Shortcut&indexPropertyEnabled=true
/api/bulkRemediation?function=BulkRemediationAction&actionName=SET_MIP_LABELS&labelName=Azure_AIP_Sensitive_Label&justificationMessage=Azure AIP Sensitive Label
/api/bulkRemediation?function=BulkRemediationAction&actionName=REMOVE_MIP_LABELS&justificationMessage=Azure AIP Sensitive Label
/api/bulkRemediation?function=BulkRemediationAction&actionName=CUSTOM_ACTION&customActionId=1
You can view the progress of the following types of operations:
Archive operations using Enterprise Vault.
Permission remediation operations.
Remediation operation using custom actions.
Deletion of stale, inactive, or orphan files and folders.
The Action Status page displays the following information:
The unique identification number of the operation.
The system-generated name for the triggered operation indicating its origin.
The type of the operation. For Enterprise Vault operations, the type is specified as EV. For permission remediation operations, the type is PR. For custom action operations, the type is CUSTOM. For delete action operations, the type is DELETE FILES.
The time when the user triggered the operation from the Management Console.
The user who triggered the operation.
The time when the destination server starts processing the triggered request. The destination server is an external server which is responsible for the actual execution of an operation that is triggered from the Information Governance Management Console. For example, in the case of an archive operation, the destination server is the Enterprise Vault server.
The time when the destination server completes processing the request.
The time it takes to complete the operation.
The status of the operation.
In case of archive operation using Enterprise Vault, the custom index property, including the classification tags applied to the files that are being archived.
Note:
Only some columns are displayed in the default view. You can view the other columns by selecting them from the column header drop-down.
The Details for Action panel shows you the step-by-step break-down of the selected operation.
To view the status of an operation
- In the Management Console navigate to Settings > Action Status. The Action Status page displays the details of recently triggered operations.
- Use the check box filter to display the operations based on their Type or Status. Additionally, you can use the search facility to display the operations based on their attributes such as Origin, Type, or Status.
- Click the Origin of the selected operation to view granular details of an operation. Alternatively, click the Select Action drop-down, and select View.
- The details of the selected operation are displayed in the Details for Action panel.
- Use the check box filter to display the operations based on the attributes such as: Status or Filer. Additionally, you can use the search facility to display the details based on attributes such as Path or Status.
You can cancel an operation that is in progress. Cancelling an operation, pauses all the activities of the operation. You can re-run a canceled operation later.
To cancel an ongoing operation
- In the Management Console, navigate to Settings > Action Status. The Action Status page displays the details of recently triggered operations.
- Use the check box filter to display the operations based on their Type or Status. Additionally, you can use the dynamic filter to display the operations based on their attributes such as Origin , Type, or Status.
- Click Select Action for the operation you want to cancel.
- Click Cancel.
You can re-run a canceled or a completed operation.
To re-run a canceled or a completed operation
- In the Management Console navigate to Setting > Action Status. The Action Status page displays the details of recently triggered operations.
- Use the check box filter to display the operations based on their Type or Status.
- Click Select Action for the operation you want to re-run.
- Select Run Again.
- Select any of the following:
All - To run all the sub-steps for the operation.
Unsuccessful - To run all the failed sub-steps for the operation.
Note:
For a permission remediation or custom action-related operation that is canceled, the option to run the unsuccessful steps again is not available.
You can delete an operation that is canceled or completed.
To delete a canceled or a completed operation
- In the Management Console navigate to Setting > Action Status. The Action Status page displays the details of recently triggered operations.
- Use the check box filter to display the operations based on their Type or Status.
- Click Select Action for the operation you want to delete.
- Select Delete.