How to Check, Set or Clear backup mode on Enterprise Vault Stores, Indexes and Index Snapshot Locations in version 14.2 and later

Description

The backup of the Veritas Enterprise Vault resources can be done with any third-party backup agent like the Backup Exec Enterprise Vault agent.

During the backup of the Enterprise Vault resources with any third-party backup agent, the account used for backup must have the rights within Enterprise Vault to set and clear backup mode for Vault Stores, Vault Store Databases, Index Locations, and Index Snapshot Locations.  The rights (or Tasks) required in Enterprise Vault for this account are:

• EVT Manage Enterprise Vault Vault Stores

• EVT Manage Index Location  Backup Mode

• EVT Manage Vault Store Backup Mode

Along with the ability to toggle backup mode, prior to the backup of these resources, the backup mode must be clear for each.

In order to test both the backup mode status and the backup account's ability to set/clear backup mode, the following steps can be used.

Log in to the EV Management Shell with the ID used for the backup job and test the following commands to set/get/clear backup mode. For more information about the commands, refer to the Enterprise Vault Backup and Recovery documentation which is available online.

Enterprise Vault Store or Vault Store Group

Vault Storage: When entered as shown below, each command will prompt for:
Name: Name of the vault store or vault store group
Server: Enterprise Vault server name
Object: VaultStore or VaultStoreGroup

Get-VaultStoreBackupMode: To get the status of the vault backup mode. (marked True for Set and False for Clear.
Set-VaultStoreBackupMode: To set backup mode.
Clear-VaultStoreBackupMode: To clear backup mode.

See Figure 1 below for a command example where each variable can be viewed/obtained within the Enterprise Vault Console.  Note that in this view both the vault stores within the vault store group are not in the backup mode.

Figure 1

Enterprise Vault Index Location

If there are any Non-Elasticsearch index locations in the environment that have index data, then those must be backed up using the following commands:

Index location: When entering the following commands, the Enterprise Vault server name is prompted for
Get-IndexLocationBackupMode to get the backup mode status of the Non-Elasticsearch index location (marked True for Set and False for Clear).

• Set-IndexLocationBackupMode to set Non-Elasticsearch index location backup mode.
• Clear-IndexLocationBackupMode to clear Non-Elasticsearch index location backup mode.

See Figure 2 below for a command example where the EVServerName can be found in the Enterprise Vault Console.  In this environment, there is a combination of both Elasticsearch and Non-Elasticsearch index locations. Note that in this view all  the index locations are currently in the backup mode.

Figure 2

If Non-Elasticsearch index locations are not available and there is only Elasticsearch index location, the backup strategy differs. You are strongly recommended to take a snapshot of the index data using the Powershell commands which are specific for snapshots. For more information, see the Enterprise Vault PowerShell Cmdlets guide.
For Elasticsearch, you are recommended to take a backup of the configured index snapshot location. You are also recommended to take a backup of the index snapshot location.

Enterprise Vault Index Snapshot Location

Index Snapshot Location: Following commands can be used check, set, or clear the backup mode of the index snapshot location.

• Get-EVIndexSnapshotLocationBackupMode to get the backup mode status of the index snapshot location (marked True for Set and False for Clear).
• Set-EVIndexSnapshotLocationBackupMode to set index snapshot location backup mode.
• Clear-EVIndexSnapshotLocationBackupMode to clear index snapshot location backup mode.

See Figure 3 below for a command example. Note that in this view the index snapshot location is curently in the backup mode.

Figure 3