Enterprise Vault™ Setting up File System Archiving (FSA)

Last Published:
Product(s): Enterprise Vault (14.0)
  1. About this guide
    1.  
      Introducing this guide
    2. Where to get more information about Enterprise Vault
      1.  
        Enterprise Vault training modules
  2. 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
      1.  
        About internet shortcuts
      2.  
        About placeholder shortcuts
      3.  
        About folder shortcuts
      4.  
        About pass-through recall for placeholder shortcuts
    9.  
      About the FSA Agent
    10.  
      About retention folders
    11.  
      About FSA Reporting
    12.  
      About FSAUtility
  3. Steps to configure File System Archiving
    1.  
      Steps to configure File System Archiving
  4. 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
      1.  
        About the ReFS and CSVFS file systems and FSA
      2.  
        About Dynamic Access Control and FSA
      3.  
        About archiving Windows Server 2012 and later deduplicated files with FSA
    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
  5. 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
  6. 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
  7. 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
      1.  
        Configuring Celerra/VNX pass-through behavior for placeholder shortcuts
      2.  
        The format of the Web Access application URL in the Celerra/VNX fs_dhsm command
      3.  
        Configuring the Data Mover HTTP server to use SSL
      4.  
        Example commands to prepare 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
  8. 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
  9. 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
  10. 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
  11. 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
      1.  
        Tips for creating FSA policy archiving rules
      2.  
        About excluding specific Mac and Windows file types from archiving
      3.  
        FSA shortcut creation options
      4.  
        Notes on FSA shortcut creation
    6.  
      About options for archiving files that have explicit permissions, and files under DAC
  12. 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
  13. 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
      1.  
        Deleting a target folder from FSA
      2.  
        Deleting a target volume from FSA
      3.  
        Deleting a target file server from FSA
  14. 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
  15. Configuring and managing retention folders
    1. Configuring retention folders
      1.  
        Creating a retention folder policy
      2.  
        Adding a target folder with a retention folder policy from the Administration Console
      3.  
        About controlling whether FSA recreates deleted or moved retention folders
      4.  
        About testing the effects of a retention folder configuration
    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
  16. 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
  17. Configuring file system filtering
    1.  
      About custom filters for File System Archiving
    2.  
      Configuring file system filters
    3.  
      About file system filter reports
  18. 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
      1.  
        Using FSA backup mode to prevent file recalls
      2.  
        Prohibiting a program from recalling files that FSA has archived
      3.  
        Preventing file recalls on Celerra/VNX
  19. 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
  20. 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
      1.  
        FSA Agent service permissions required by the Vault Service account
      2.  
        Enterprise Vault installation folder permissions required by the Vault Service account
      3.  
        File server registry hive permissions required by the Vault Service account
    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 setting up File System Archiving

Very briefly, setting up File System Archiving involves the following tasks:

  • Preparing the file server as necessary, and then adding it as a target file server. You must install the Enterprise Vault FSA Agent on a Windows file server on which you want to leave placeholder shortcuts, or collect data for FSA Reporting.

  • Creating volume policies to define how and what to archive from target volumes. Optionally you can also create folder policies, to override the volume policies for specific target folders.

  • Adding the target volumes, and assigning the volume policies.

  • Adding target folders, and assigning the parent volume policy or a folder policy. You can define an archive point for each folder that you want to associate with a separate archive. A folder with an archive point forms the top of an archive. Files from the folder and its subfolders are stored in the same archive.

  • Configuring other features as required, such as retention folders, and FSA Reporting.

  • Configuring the File System Archiving tasks to schedule archiving and associated activities, and to determine the mode in which the archiving is to run.

Table: Controlling File System Archiving from the Administration Console shows the properties of the Enterprise Vault Administration Console containers that you can use to control File System Archiving.

Table: Controlling File System Archiving from the Administration Console

Item

Properties

Target file server

(under Targets\File Servers)

  • Whether to archive the file server.

  • Configuration settings for pass-through recall for placeholder shortcuts.

  • Configuration settings for deletion of archived files on placeholder deletion.

  • Configuration settings for FSA Reporting.

Target Volume

(under Targets\File Servers\<server>)

  • Whether to archive the volume.

  • The File System Archiving task that is to process the volume.

  • The File System Archiving policy to apply when processing the volume.

  • For NTFS volumes, whether to enable pass-through recall for placeholder shortcuts on this volume.

A target volume is processed according to the File System Archiving task schedule, but can be processed manually by using the Run Now option.

Target Folder

(under Targets\File Servers\<server>\<volume>)

  • Whether to archive the folder.

  • Whether to archive the subfolders of the folder.

  • The FSA policy to apply when processing the folder.

  • The location of archive points, which mark a folder that forms the top of an archive.

Volume policy

(under Policies\File)

Each target volume is assigned a volume policy, which defines the following:

  • For NTFS volumes, whether to use quotas.

  • The type of shortcut to leave, if the archiving rules specify that a shortcut is to be created.

  • For placeholder shortcuts:

    • Whether to delete archived files on placeholder deletion.

    • Whether to delete placeholders for the items that are deleted from archives.

  • The retention category or retention plan to use for archived files.

  • The archiving rules to apply. These rules determine which files to archive, and when to create shortcuts.

  • Whether to archive files that have explicit permissions, and files that are under Dynamic Access Control. These files are subject to a change in permissions when archived.

Folder policy

(under Policies\File)

Folder policies are optional. Use them when you want to override the volume policy for specific folders.

A folder policy defines the following:

  • The type of shortcut to leave, if the archiving rules specify that a shortcut is to be created.

  • For placeholder shortcuts:

    • Whether to delete archived files on placeholder deletion.

    • Whether to delete placeholders for the items that are deleted from archives.

  • The retention category or retention plan to use for archived files.

  • The archiving rules to apply. These rules determine which files to archive, and when to create shortcuts.

  • Whether to archive files that have explicit permissions, and files that are under Dynamic Access Control. These files are subject to a change in permissions when archived.

File System Archiving Task

(under Enterprise Vault Servers\<server>\Tasks)

Processes target volumes and folders. The task properties define the following:

  • Whether to run in report mode or normal mode.

  • Schedule settings, including the option for Run Now.

  • Settings to control generation of normal and pruning reports.

  • Synchronization schedule.

  • Pruning options and schedule.