Search <book_title>...

Enterprise Vault™ Setting up File System Archiving (FSA)

Last Published: 2021-12-06

Product(s): Enterprise Vault (14.2)

About this guide
1. Introducing this guide
2. Where to get more information about Enterprise Vault
  1. Enterprise Vault training modules
About File System Archiving
1. About File System Archiving
2. About using FSA with clustered file servers
3. About setting up File System Archiving
4. About FSA policies
5. About target volumes, folders, and archive points
6. About client access to FSA-archived items
7. About archived file permissions
8. About FSA shortcut files
9. About the FSA Agent
10. About retention folders
11. About FSA Reporting
12. About FSAUtility
Steps to configure File System Archiving
1. Steps to configure File System Archiving
Adding a Windows file server to File System Archiving
1. Adding a Windows file server to File System Archiving
2. Using FSA with the Windows Encrypting File System (EFS)
3. About archiving from Windows Server 2012 or later file servers
4. Account requirements for managing FSA with Windows file servers
5. Permissions and privileges required by the Vault Service account on Windows file servers
  1. Granting permissions to the Vault Service account if you do not install the FSA Agent
6. Configuring a file server's firewall for FSA
7. Adding a Windows file server as an archiving target
Adding a NetApp filer to File System Archiving
1. Adding a NetApp filer to File System Archiving
2. Setting the permissions for FSA on a NetApp filer
3. Adding a NetApp filer as an archiving target
Adding a NetApp C-Mode Vserver to File System Archiving
1. Adding a NetApp C-Mode Vserver to File System Archiving
2. Permissions and privileges required by the Vault Service account on NetApp C-mode Vservers
3. Granting the required permission on each Vserver
4. Configuring the FPolicy server details
5. Adding a NetApp C-Mode Vserver as an archiving target
6. Points to note about File System Archiving on NetApp C-Mode file servers
Adding a Celerra/VNX device to File System Archiving
1. Adding a Celerra/VNX device to File System Archiving
2. Preparing a Celerra/VNX device for FSA
3. Adding a Celerra/VNX device as an archiving target
4. Specifying a cache location for retrieved Celerra/VNX files
Adding a Dell EMC Unity device to File System Archiving
1. Adding a Dell EMC Unity device to File System Archiving
2. Preparing a Unity device for FSA
3. Adding the Unity device as an archiving target
Configuring FSA with clustered file servers
1. About configuring FSA with clustered file servers
2. Steps to configure FSA with clustered file servers
3. Preparing to set up FSA services in a cluster
4. Adding the Vault Service account to the non-secure VCS cluster for FSA high availability
5. Adding the virtual file server as an FSA target
6. Configuring or reconfiguring the FSA resource
7. Removing the FSA resource from all cluster groups
8. Troubleshooting the configuration of FSA with clustered file servers
  1. 'Failed to collect clustering data' error on starting FSA Cluster Configuration wizard
Installing the FSA Agent
1. About installing the FSA Agent on a Windows file server
  1. Installing the FSA Agent using the Install FSA Agent wizard
  2. Installing the FSA Agent manually
2. About FSA Agent uninstallation
3. Updating the logon credentials of the FSA Agent services
Defining volume and folder policies
1. About defining FSA volume and folder policies
2. Creating FSA volume policies and folder policies
3. About FSA volume policy and folder policy properties
4. About selecting the shortcut type for an FSA policy
  1. About choosing not to display the file size in NetApp placeholder shortcuts
5. About FSA policy archiving rules
6. About options for archiving files that have explicit permissions, and files under DAC
Configuring the deletion of archived files on placeholder deletion
1. About configuring the deletion of archived files on placeholder deletion
2. Configuring the deletion of archived files on placeholder deletion for Windows file servers and NetApp filers
3. Configuring the deletion of files on placeholder deletion for Dell EMC Celerra/VNX devices
  1. Troubleshooting the deletion of files on placeholder deletion for Dell EMC Celerra/VNX devices
Configuring target volumes, target folders, and archive points
1. About adding target volumes, target folders, and archive points for FSA
  1. About the checks for existing archives for an FSA folder path
2. Adding a target volume for FSA
3. Adding a target folder and archive points for FSA
4. About managing archive points
  1. Viewing, editing, or deleting archive points in the Administration Console
5. Archive point properties
  1. Archive point properties: General tab
  2. Archive point properties: Indexing tab
6. Effects of modifying, moving, or deleting folders
  1. Effects of modifying folders with folder policies
  2. Effects of modifying folders with archive points
7. About deleting target folders, volumes, and file servers
Configuring pass-through recall for placeholder shortcuts
1. About configuring pass-through recall for placeholder shortcuts
2. Configuring pass-through recall for a Windows file server
  1. About configuring pass-through recall for a file server cluster
  2. Registry values for pass-through recall on Windows file servers
3. Configuring pass-through recall for a NetApp filer
Configuring and managing retention folders
1. Configuring retention folders
2. About assigning a retention folder policy using the Command Line Interface (CLI)
  1. The format of the RtnFolder.exe settings file
  2. Example RtnFolder.exe commands
3. Managing retention folders
  1. Disabling the archiving of retention folders for an FSA target
  2. Assigning a different retention folder policy to a target folder
Configuring and running FSA tasks
1. About configuring and running FSA tasks
2. Adding a File System Archiving task
3. Scheduling a File System Archiving task
4. Setting the FSA folder permissions synchronization schedule
5. Scheduling the deletion of archived files on placeholder deletion for Dell EMC Celerra/VNX
6. Configuring FSA version pruning
7. Using Run Now to process FSA targets manually
  1. Processing an FSA target volume manually
  2. Running a File System Archiving task manually
8. About File System Archiving task reports
9. About scheduling storage expiry for FSA
Configuring file system filtering
1. About custom filters for File System Archiving
2. Configuring file system filters
3. About file system filter reports
Managing the file servers
1. About managing the target file servers
2. About backing up the target file servers
3. About virus-checking the target file servers
4. About changing the placeholder recall rate settings
  1. Changing the placeholder recall rate settings for a Windows file server
  2. Changing the placeholder recall rate settings for a NetApp file server
5. About preventing unwanted file recalls from placeholder shortcuts
PowerShell cmdlets for File System Archiving
1. About the PowerShell cmdlets for File System Archiving
2. Running the File System Archiving cmdlets
3. Creating PowerShell scripts using File System Archiving cmdlets
4. File System Archiving cmdlets error handling
Appendix A. Permissions and privileges required for the Vault Service account on Windows file servers
1. About the permissions and privileges required for the Vault Service account on Windows file servers
2. Group membership requirements for the Vault Service account
3. DCOM permissions required by the Vault Service account
4. WMI control permissions required by the Vault Service account
5. Local security user rights required by the Vault Service account
6. Permissions required by the Vault Service account for the FSA Agent
7. Permissions required by the Vault Service account to support the FSA resource on clustered file servers
8. FSA target share and folder permissions required by the Vault Service account

About configuring the deletion of archived files on placeholder deletion

If you choose to leave placeholder shortcuts, you can configure Enterprise Vault to delete archived files when their placeholders are deleted. You must configure some settings for the file server, and apply an archiving policy with the appropriate settings.

Use these settings to configure the deletion of archived files on placeholder deletion:

In the Site Properties dialog box for the Enterprise Vault site, on the Archive Settings tab, select Users can delete items from their archives.
In the Archive Properties dialog box, on the Advanced tab, select Allow deletion of archived items and of this archive.
In the Volume Policy Properties dialog box, on the Shortcuts tab, select Delete archived file when placeholder is deleted.
In the Folder Policy Properties dialog box, on the Shortcuts tab, select Delete archived file when placeholder is deleted.

Note that if you move placeholders to a different location, the archiving policy that applies to the destination location determines whether the archived files are deleted on placeholder deletion.

For Windows file servers and NetApp filers, Enterprise Vault maintains a cache of the "Delete archived file when placeholder is deleted" policy settings. This cache holds the policy setting for each local target volume and target folder, including retention folders. For Windows file servers the cache is located on the file server. For NetApp filers the cache is located on the Enterprise Vault server. The location is not configurable.

When a placeholder is deleted on a Windows file server or a NetApp filer, Enterprise Vault does as follows:

Identifies the parent target folder that is closest to the folder from which the placeholder was deleted.
Obtains from the cache the value of the "Delete archived file when placeholder is deleted" setting that applies to the target folder.
Uses the value from the cache to determine whether to delete the archived file. If the cache value specifies deletion, Enterprise Vault immediately deletes the archived file.

If Enterprise Vault is unable to identify the parent target folder for a deleted placeholder, it logs an error in the event log. It does not delete the archived file.

Note:

Enterprise Vault updates the cache every hour by default. A delay of up to an hour may therefore occur before Enterprise Vault's deletion behavior reflects a change to this policy setting.

See Configuring the deletion of archived files on placeholder deletion for Windows file servers and NetApp filers.

For Celerra/VNX devices Enterprise Vault uses a different mechanism:

To configure archived file deletion with Celerra/VNX you must configure a target volume whose share points to the root of the file system. The "Delete archived file when placeholder is deleted" policy setting that applies to this root volume determines this policy setting for all of the file system's archived files. The root volume's policy setting overrides any "Delete archived file when placeholder is deleted" policy setting that you apply to any other target volumes or target folders in the same file system.
For Celerra/VNX placeholders, Enterprise Vault does not use a cache. When a Celerra/VNX placeholder is deleted, Enterprise Vault examines the value of the "Delete archived file when placeholder is deleted" setting for the policy that applies to the Celerra/VNX target root volume.
You must enable FileMover logging on the Celerra/VNX device. Enterprise Vault uses the Celerra/VNX FileMover log's records of deleted placeholders to determine which archived files to delete.
The deletion of the archived Celerra/VNX files does not occur immediately upon placeholder deletion. Deletion from the Celerra/VNX takes place daily according to the schedule that is specified in the properties of the File System Archiving task.

See Configuring the deletion of files on placeholder deletion for Dell EMC Celerra/VNX devices.