Enterprise Vault™ Backing Up Enterprise Vault: Medium Environment
- Backing up Enterprise Vault: Medium environment
- About this document
- About Enterprise Vault backup functionality
- About Enterprise Vault safety copies
- Choosing when to remove Enterprise Vault safety copies
- Checking that the partition has been backed up before Enterprise Vault removes safety copies
- Using the archive attribute to determine whether a partition has been backed up
- Using the trigger file mechanism to determine whether a partition has been backed up
- About Enterprise Vault backup mode
- About Enterprise Vault safety copies
- Backup tools and supporting components
- Medium-sized Enterprise Vault environment
- Enterprise Vault backup schedules
- Component backups
About backup mode cmdlets
Enterprise Vault provides a set of PowerShell cmdlets which you can use to set and clear backup mode on the following:
Vault stores
Vault store groups
Index locations
You can run these cmdlets directly in the Enterprise Vault Management Shell, and use them in your backup scripts. For example, use the cmdlets in a pre-backup script to set backup mode on index locations and vault stores before the backup is taken. After the backup has completed, use the cmdlets in a post-backup script to clear backup mode.
For each index location and vault store, Enterprise Vault maintains a count of the number of set requests and clear requests, to support the use of concurrent backup scripts. Enterprise Vault increments the count by 1 on each request to set backup mode, and decrements the count by 1 on each request to clear backup mode.
When you use concurrent backup scripts, Enterprise Vault does not clear backup mode from a vault store or an index location until all the scripts that have set backup mode, have also cleared backup mode.
Note:
When you use the Administration Console to clear backup mode from an index location or vault store, Enterprise Vault ignores the backup mode count and forcibly clears backup mode.
To run PowerShell cmdlets directly, first run the Enterprise Vault Management Shell
- Start the Enterprise Vault Management Shell.
PowerShell opens and loads the Enterprise Vault snap-in which makes the backup mode cmdlets available in the shell.
The Enterprise Vault Management Shell provides the following backup mode cmdlets:
Get-IndexLocationBackupMode | Reports the current backup mode settings on index locations. |
Set-IndexLocationBackupMode | Increments the backup mode count on index locations. |
Clear-IndexLocationBackUpMode | Decrements the backup mode count on index locations. |
Get-VaultStoreBackupMode | Reports the current backup mode settings on vault stores. |
Set-VaultStoreBackupMode | Increments the backup mode count on vault stores. |
Clear-VaultStoreBackupMode | Decrements the backup mode count on vault stores. |
Help is available for all the cmdlets. For example, the following command shows the detailed Help for Clear-VaultStoreBackupMode:
Get-Help Clear-VaultStoreBackupMode -detailed
You can also generate PowerShell backup mode commands that are based on the configuration of your environment and ready for use in your backup scripts.
See Generating PowerShell backup commands for your environment.