Enterprise Vault™ Backup and Recovery

Last Published:
Product(s): Enterprise Vault (14.3)
  1. About this guide
    1.  
      About backup and recovery
    2. Where to get more information about Enterprise Vault
      1.  
        Enterprise Vault training modules
  2. Backing up Enterprise Vault
    1.  
      About Enterprise Vault backups
    2.  
      About Enterprise Vault backup mode
    3. Backup of Enterprise Vault data
      1.  
        Enterprise Vault system databases backup
      2.  
        Fingerprint databases backup
      3. Vault store partitions and vault store databases backup
        1.  
          Removal of Enterprise Vault safety copies after backup
      4.  
        Backing up index locations
      5.  
        Backing up the classification policy folder
      6.  
        Backing up index snapshot locations
    4. About backup mode cmdlets
      1.  
        Index location backup mode cmdlet syntax
      2.  
        Vault store backup mode cmdlet syntax
      3.  
        Index snapshot location backup mode cmdlet syntax
    5.  
      Generating PowerShell backup commands for your environment
    6.  
      Using PowerShell cmdlets in backup scripts
  3. Enterprise Vault recovery procedures
    1.  
      About using EVSVR as part of the recovery procedure
    2. Recovering Enterprise Vault using full system backups
      1.  
        Carrying out an environment recovery procedure
    3. Recovering Enterprise Vault using data-only backups
      1.  
        Recovery procedure 1: Installing software on the servers
      2.  
        Recovery procedure 2: Restoring Enterprise Vault system databases
      3.  
        Recovery procedure 3: Renaming servers
      4.  
        Recovery procedure 4: Copy or move the Enterprise Vault data files
      5.  
        Recovery procedure 5: Clearing the directory database entries
      6.  
        Recovery procedure 6: Recreating services and tasks on the first Directory service computer
      7.  
        Recovery procedure 7: Recreating services and tasks on Enterprise Vault servers
      8.  
        Recovery procedure 8: Checking the Web Access application settings
      9.  
        Recovery procedure 9: Checking registry entries
    4.  
      Recovery of an Enterprise Vault component
    5. Recovery of Enterprise Vault in a VCS cluster
      1.  
        Recovery scenario 1: One of the cluster nodes needs rebuilding
      2.  
        Recovery scenario 2: All the cluster nodes need rebuilding
    6. Recovery of Enterprise Vault in a Windows Server failover cluster
      1.  
        Recovery scenario 1: One of the cluster nodes needs rebuilding
      2.  
        Recovery scenario 2: All the cluster nodes need rebuilding

Generating PowerShell backup commands for your environment

Enterprise Vault includes a PowerShell script called Transform-Backup.ps1, which you can use to generate PowerShell backup mode commands for your environment.

Transform-Backup.ps1 generates an HTML file that contains a set backup mode command, and a clear backup mode command for each of the following entities in your environment:

  • Enterprise Vault site (all vault stores)

  • Vault store group

  • Vault store

  • Enterprise Vault site (all index locations)

  • Enterprise Vault site (all index snapshot locations)

Note:

Enterprise Vault version 14.2 onwards, Elasticsearch is the new indexing engine. The index data backup strategy has changed. For all the Elasticsearch index locations, you must now take snapshots of the index data on the Enterprise Vault index server, instead of taking filesystem-level backup of index data.

The backup strategy for all the non-Elasticsearch index locations in your environment continues to be the same as before 14.2 and supports only filesystem-level backup.

To protect your data from accidental loss, it is strongly recommended that you:

You can use any of the commands from the HTML file that are appropriate to your backup regime.

For example, if you back up all the data associated with an entire Enterprise Vault site in one operation, your pre-backup script should include the command to set backup mode on the site's vault stores, the command to set backup mode on the site's index locations, and the command to set backup mode on the site's index snapshot locations.

When the backup operation is complete, your post-backup script should include the command to clear backup mode from the site's vault stores, the command to clear backup mode from the site's index locations, and the command to clear backup mode from the site's index snapshot locations.

Transform-Backup.ps1 is in the Templates folder beneath the Enterprise Vault installation folder (for example, C:\Program Files (x86)\Enterprise Vault\Reports\Templates).

Before you run the script, you must set the PowerShell script execution policy, to allow only signed scripts to run. You only have to do this once.

To set the PowerShell script execution policy

  1. Start the Enterprise Vault Management Shell.
  2. Run the following command:

    Set-ExecutionPolicy -executionPolicy AllSigned

When you have set the PowerShell script execution policy, you can run Transform-Backup.ps1 to generate the backup mode commands for your environment.

To run the script

  1. Start the Enterprise Vault Management Shell.
  2. Change directory to the Reports\Templates folder beneath the Enterprise Vault installation folder.
  3. Enter the following command to run the script:

    .\Transform-Backup.ps1

  4. At the following prompt:

    Do you want to run software from this untrusted publisher?

    Choose R to run the script once.

At the end of the script, the HTML file generated by Transform-Backup.ps1 opens automatically in your default web browser.