Veritas Enterprise Vault™ Setting up File System Archiving (FSA)

Last Published:
Product(s): Enterprise Vault (12.2)
  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. 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
  9. 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
  10. 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
  11. 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
  12. 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
  13. 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
  14. 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
  15. 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
  16. Configuring file system filtering
    1.  
      About custom filters for File System Archiving
    2.  
      Configuring file system filters
    3.  
      About file system filter reports
  17. 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
  18. 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
  19. 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

Preparing a Celerra/VNX device for FSA

This section describes how to prepare a Celerra/VNX device for File System Archiving.

The procedure includes steps to ensure that the Celerra/VNX device is configured to support alternate data streams (ADS). Enterprise Vault uses ADS to indicate archive points. If you intend to use placeholder shortcuts on the Celerra/VNX, you must also enable the FileMover functionality on the Celerra/VNX and configure an HTTP or HTTPS connection for recall requests.

Another section provides example commands for this procedure.

See Example commands to prepare a Celerra/VNX device for FSA .

If you want to configure the pass-through behavior on placeholder recall, read about the read_policy_override parameter before you proceed.

See Configuring Celerra/VNX pass-through behavior for placeholder shortcuts.

Note:

See this technical note on the Veritas Support website for troubleshooting information on the following procedure:

http://www.veritas.com/docs/000088689

Note:

A Dell EMC restriction prevents archiving from a Celerra/VNX device if the path to the files exceeds 1024 characters.

To prepare a Celerra/VNX device for FSA

  1. Log on to the Celerra/VNX Control Station.
  2. Ensure that the Celerra/VNX device is configured to support alternate data streams (ADS), which Enterprise Vault uses to indicate archive points.

    The Celerra/VNX shadow stream parameter controls support for ADS:

    • If the shadow stream parameter is set to 1, ADS support is enabled. 1 is the default value.

    • If the shadow stream parameter is set to 0, ADS is disabled.

    To determine the current value of the shadow stream parameter, enter the following command on the Celerra/VNX Network Server:

    server_param server_x -facility shadow -info stream

    Where server_x is the name of the Data Mover.

    The command returns information about the parameter, including its current value.

    If the current value is not 1, enter the following command on the Celerra/VNX Network Server:

    server_param server_x -facility shadow -modify stream -value 1

    Where server_x is the name of the Data Mover.

  3. Add a Celerra/VNX account for Enterprise Vault to use for authentication on the Celerra/VNX device, by entering the following command:

    /nas/sbin/server_user server_x -add -md5 -passwd DataMover_user_name

    Where:

    server_x is the name of the Data Mover.

    DataMover_user_name is the name of the account. This user is a Data Mover user, not a domain user.

    Note the following:

    • Specify the full path for the command, /nas/sbin/server_user.

    • You require root privileges to execute this command.

    • If the system prompts you for a User ID and a Group ID, a suitable number in both cases is 1000, unless you use this value elsewhere.

    • If the system prompts you for a home directory, press Enter to continue, without specifying a directory.

    • When the system prompts you for a password, enter a suitable password for the user account.

  4. Enable the file system for Celerra/VNX FileMover using this command syntax:

    fs_dhsm -modify fs_name -state enabled

    Where:

    fs_name is the name of the file system on the Celerra/VNX.

    Note:

    If you do not want to use placeholder shortcuts with the Celerra/VNX, you can omit steps 5 to 8.

  5. Configure the HTTP server on the Data Mover to accept Celerra/VNX FileMover API connections, by using the following command:

    server_http server_x -append dhsm -users DataMover_user_name -hosts ip_address_policy_engine

    Where:

    server_x is the name of the Data Mover.

    DataMover_user_name is the name of the Data Mover account that you want Enterprise Vault to use for authentication.

    ip_address_policy_engine is the IP address of the computer that runs the Enterprise Vault FSA task that will process the Celerra/VNX device.

    The command also tests the connectivity between the Celerra/VNX device and the Enterprise Vault server over HTTP.

    If you intend to configure FSA Reporting for the Celerra/VNX device, the Data Mover must also accept connections from the computer that acts as the FSA Reporting proxy server.

    See "Preparing a Celerra/VNX device to work with an FSA Reporting proxy server" in the Reporting guide.

  6. Run the following command to make sure that the connection is active:

    server_http server_x -service DHSM -start

    Where server_x is the name of the Data Mover.

  7. Configure an HTTP or HTTPS connection to use for recall requests, using this command syntax:

    fs_dhsm -connection fs_name -create -type http|https [-read_policy_override setting] -secondary ev_url -user user -password user_password -cgi n [-httpport|httpsport port_number]

    Where:

    fs_name is the name of the Celerra/VNX file system.

    -type specifies the connection type (http or https).

    -read_policy_override is an optional parameter to set the pass-through behavior for placeholder shortcuts.

    See Configuring Celerra/VNX pass-through behavior for placeholder shortcuts.

    ev_url is the URL of the Enterprise Vault Web Access application. The Celerra/VNX is case-sensitive, so this URL must use the correct case. You cannot include a port number in the URL.

    See The format of the Web Access application URL in the Celerra/VNX fs_dhsm command.

    user is the Vault Service account that will have access to all the archives from which files are restored.

    user_password is the password to the Vault Service account.

    -httpport or -httpsport specifies the HTTP or HTTPS port number. This parameter is required if the Web Access application uses a port other than the default port (port 80 for HTTP, or port 443 for HTTPS).

  8. If you require the Celerra/VNX Data Mover HTTP server to use the Secure Sockets Layer (SSL), configure SSL.

    See Configuring the Data Mover HTTP server to use SSL.

    Note:

    You must use SSL if you enable the following Windows security setting, either in the Windows Local Security Policy or as part of Group Policy:

    System cryptography: Use FIPS compliant algorithms for encryption, hashing, and signing

  9. Add the Vault Service account as a member of the Administrators group of the Celerra/VNX CIFS server:
    • In Windows, start Computer Management.

    • In the Computer Management console, select Action > Connect to another computer. Enter the name of the CIFS server.

    • Add the Vault Service account to the Administrators group.