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:

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, and the command to set backup mode on the site's index 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, and the command to clear backup mode from the site's index locations.

Transform-Backup.ps1 is in the Templates folder beneath the Enterprise Vault installation folder (normally C:\Program Files\Enterprise Vault\Reports\Templates or C:\Program Files (x86)\Enterprise Vault\Reports\Templates on 64-bit systems.

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. Click Start > Programs > Enterprise Vault > Enterprise Vault Management Shell to run 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. If you closed the Enterprise Vault Management Shell, click Start > Programs > Enterprise Vault > Enterprise Vault Management Shell.

  2. Change directory to the Reports\Template 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.