Search <book_title>...

Enterprise Vault™ Setting up File System Archiving (FSA)

Last Published: 2021-03-23

Product(s): Enterprise Vault (14.1)

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 4.3 device to File System Archiving
1. Adding a Dell EMC Unity 4.3 device to File System Archiving
2. Preparing a Unity device for FSA
3. Adding the Unity 4.3 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

Adding the virtual file server as an FSA target

We recommend that you add the virtual file server as a target file server for FSA, rather than adding the individual cluster nodes as targets.

To add a virtual file server as an FSA target

If you intend to install the FSA Agent in step 6, then if the cluster nodes' firewalls are on, ensure that the firewalls are suitably configured.
See Configuring a file server's firewall for FSA.
Alternatively, install the FSA Agent manually on each node in the cluster. You can perform the manual installation of the FSA Agent before or after you add the target file server.
See Installing the FSA Agent manually.
Start the Enterprise Vault Administration Console. If you want to install the FSA Agent or to add an FSA Resource to the cluster group during this procedure, you must run the Administration Console with an account that is a member of the local Administrators group on each file server node. If you want to add an FSA Resource you must also use an account that has Full Control permission on the FSA Cluster folder of the Enterprise Vault server. The FSA Cluster folder is a subfolder of the Utilities folder under the Enterprise Vault installation folder. For example:
C:\Program Files (x86)\Enterprise Vault\Utilities\FSA Cluster
In the left pane of the Enterprise Vault Administration Console, expand the Enterprise Vault site until the Targets container is visible.
Expand the Targets container.
Right-click the File Server container and on the shortcut menu, click New and then File Server. The New File Server wizard starts.
Enter the name of the virtual file server.
Select the option to install the FSA Agent on the file server, unless you plan to install the FSA Agent manually. If you choose to install the FSA Agent, the wizard prompts you for the Vault Service account password. The wizard then installs the FSA Agent services on each node. After the services are installed, the wizard sets the services' logon credentials to use the Vault Service account, and then starts the services on each node.
To add an FSA resource to the cluster group now, click Configure FSA Cluster to launch the FSA Cluster Configuration wizard. Alternatively you can run the FSA Cluster Configuration wizard later, if you prefer.
The FSA Cluster Configuration wizard takes you through the steps to add the FSA resource to the set of resources that comprise a cluster resource group or service group. It also enables you to configure the FSA resource for high availability, if required. If you configure the FSA resource for high availability you can then monitor the FSA services and, if there is a problem with the node on which they are running, automatically move them to a working node in the cluster.
See Configuring or reconfiguring the FSA resource.
On the final screen of the FSA Cluster Configuration wizard, click View log to view details of the configuration changes in FSACluster.log. When the FSA Cluster Configuration wizard finishes, it returns you to the New File Server wizard.
The final screens of the New File Server wizard vary, depending on whether you have already configured the FSA Reporting database:
- If you have not configured FSA Reporting, the wizard displays a message that begins "FSA Reporting is not configured". It then skips to the final wizard page. You can configure FSA Reporting when the wizard has finished, if required.
  See About FSA Reporting.
- If you have configured FSA Reporting, the New File Server wizard asks you if you want to enable data collection for FSA Reporting. If you choose to enable data collection the wizard then gives you the option to configure a non-default data collection schedule for the file server. You can perform these tasks later, if you want. For more details, see the help on the wizard pages.
When the FSA Agent installation is complete, you can configure the file server's properties and add target volumes as required.
Note that if you configure pass-through recall for a file server cluster, all the cluster nodes must use identical pass-through recall settings.
See About configuring pass-through recall for a file server cluster.