Symantec Enterprise Vault™Technical Note

Backing up Enterprise Vault

8.0 and later

Symantec Information Foundation™

Symantec Enterprise Vault: Backing up Enterprise Vault

Legal NoticeCopyright © 2008 Symantec Corporation. All rights reserved.

Symantec, the Symantec Logo, VERITAS, andEnterpriseVault are trademarks or registeredtrademarks of Symantec Corporation or its affiliates in the U.S. and other countries. Othernames may be trademarks of their respective owners.

The product described in this document is distributed under licenses restricting its use,copying, distribution, and decompilation/reverse engineering. No part of this documentmay be reproduced in any form by any means without prior written authorization ofSymantec Corporation and its licensors, if any.

THEDOCUMENTATIONISPROVIDED"ASIS"ANDALLEXPRESSORIMPLIEDCONDITIONS,REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT,ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TOBELEGALLYINVALID.SYMANTECCORPORATIONSHALLNOTBELIABLEFORINCIDENTALOR CONSEQUENTIAL DAMAGES IN CONNECTION WITH THE FURNISHING,PERFORMANCE, OR USE OF THIS DOCUMENTATION. THE INFORMATION CONTAINEDIN THIS DOCUMENTATION IS SUBJECT TO CHANGE WITHOUT NOTICE.

The Licensed Software andDocumentation are deemed to be commercial computer softwareas defined in FAR12.212 and subject to restricted rights as defined in FARSection 52.227-19"Commercial Computer Software - Restricted Rights" and DFARS 227.7202, "Rights inCommercial Computer Software or Commercial Computer Software Documentation", asapplicable, and any successor regulations. Any use, modification, reproduction release,performance, display or disclosure of the Licensed Software andDocumentation by theU.S.Government shall be solely in accordance with the terms of this Agreement.

Symantec Corporation20330 Stevens Creek Blvd.Cupertino, CA 95014

http://www.symantec.com

Backing up Enterprise Vault

This document includes the following topics:

■ About Enterprise Vault backups

■ Enterprise Vault backup mode

■ Backing up Enterprise Vault data

■ SQL stored procedure

■ Backup mode cmdlets

■ Using PowerShell cmdlets in backup scripts

About Enterprise Vault backups

Note:Thisdocument containsupdated informationaboutEnterpriseVault backups,and replaces the chapter calledBackingupEnterpriseVault in theAdministrator’sGuide.

Enterprise Vault requires an effective backup strategy to prevent data loss, andto provide a means for recovery in the event of a system failure. When you planthis strategy, remember that Enterprise Vault components can be distributedacross multiple systems. The resources on which Enterprise Vault depends maybe remote from Enterprise Vault services and tasks.

This document describes:

■ Enterprise Vault’s backup mode which lets you place vault stores and indexlocations in backup mode while you take backups.

■ The databases you must back up.

■ The data locations and index locations you must back up.

■ A SQL stored procedure, which you can use to back up your Enterprise Vaultdatabases.

■ Theuse of EnterpriseVault’s backupmodePowerShell cmdlets in your backupscripts.

If yourEnterpriseVault system is in a clustered environment, refer to the followingdocument on the Symantec support web site:

http://entsupport.symantec.com/docs/285839

The document provides supplementary information on performing backups ofEnterpriseVault systems that are clusteredusingVCSorMicrosoft server clusters.

Enterprise Vault backup modeEnterprise Vault lets you place vault stores and index locations in backup modefor the duration of a data backup. Enterprise Vault does not write any data intovault store partitions or index locations while they are in backupmode. However,services to users are maintained while vault stores and index locations are inbackupmode.Users can continue to search, and retrieve items from their archives.

You can set backup mode on vault stores and index locations in the EnterpriseVault administration console. You can also use PowerShell cmdlets in theEnterprise Vault Management Shell to set, clear, and report on vault store andindex location backup mode.

See “Backup mode cmdlets” on page 8.

To manage backup mode on vault stores and index locations, your user accountmust be assigned the storage administrator role.

In the administration console, you can set and clear vault store backup mode inthe following places:

■ The context menu on the Enterprise Vault site

■ The context menu on any vault store group

■ The context menu on any vault store

You can set and clear index location backup mode in the following places:

■ The context menu on the Enterprise Vault site

■ The context menu on any Enterprise Vault server

■ The index service properties page

When you set and clear backup mode on index locations and vault stores, eventsare written to the Enterprise Vault event log. The indexing service also writes an

Backing up Enterprise VaultEnterprise Vault backup mode

4

eventwhen it starts, if any indexing locations are in backupmode. This event listsall the indexing locations that are in backup mode.

The following examples show how to use backup mode in the administrationconsole. The first example is a procedure to set backupmode on all the vault storesin a vault store group. The second example is a procedure to find the currentbackup mode settings for index locations on a server called2003SRV.domain1.local.

To set backup mode on all the vault stores in a vault store group

1 In the left pane of the administration console, expand the VaultStoreGroupcontainer.

2 Right-click the vault store group whose vault stores you want to place inbackup mode, and click Set State > Set Backup Mode on all Vault Stores.

The Backup Mode column in the right pane now shows that backup mode is seton all the vault stores in the vault store group.

To see the current backup mode settings for index locations, and to change thesesettings

1 In the left pane of the administration console, browse to Enterprise VaultServers > 2003SRV.domain1.local > Services.

2 In the right pane, right-click Enterprise Vault Indexing Service and clickProperties.

3 Click the Index Locations tab.

4 The Backup Mode column shows the current backup mode settings for allthe index locations on the server. You can change the setting for any of theselocations.

Backing up Enterprise Vault dataYou must back up the following Enterprise Vault data and databases:

■ Enterprise Vault system databases

■ Fingerprint databases

■ Vault store partitions and vault store databases

■ Index locations

5Backing up Enterprise VaultBacking up Enterprise Vault data

Enterprise Vault system databasesTo make a complete Enterprise Vault system backup, you must back up all thefollowing system databases if you have them:

■ EnterpriseVaultDirectory

■ EnterpriseVaultMonitoring

■ EnterpriseVaultAudit

■ EnterpriseVaultFSAReporting

The EnterpriseVaultAudit and EnterpriseVaultFSAReporting are present onlyif you have configured Enterprise Vault’s auditing and FSA reporting features.

Note: Every Enterprise Vault server must also have a complete system and filebackup.This backupmust include the registry because all EnterpriseVault servicesstore information in the registry. You should consider taking this system and filebackup at the same time you back up the Enterprise Vault system databases.

Fingerprint databasesEach vault store group usually has a fingerprint database which holds the datathat enables Enterprise Vault single instance storage.

Each fingerprint database is called EVVSG_vaultstoregroup_n_m, wherevaultstoregroup is the name of the vault store group with its spaces removed. nandm are internally generated integers.

You should also set backup mode on the corresponding vault store group, andback up all its vault stores at the same time you back up the fingerprint database.

See “Enterprise Vault backup mode” on page 4.

Vault store partitions and vault store databasesEach vault store has a databasewhich is called EVvaultstore_n, where vaultstoreis the name of the vault store with its spaces removed, and n is an internallygenerated integer.

You should back up the vault store databases at the same you as you back up thevault store partitions.

Before you back up the vault store databases and vault store partitions, you shouldplace the vault stores in backup mode.

See “Enterprise Vault backup mode” on page 4.

Backing up Enterprise VaultBacking up Enterprise Vault data

6

Index locationsEachEnterpriseVault indexing service can store its indexes inmultiple locations,and you must back up all these locations. The index locations are listed on theIndex Locations tab of the Enterprise Vault Indexing Service properties page.

The following procedure shows how to find the index locations you need to backup on a server called 2003SRV.domain1.local.

Note: To find a complete list of all the index locations to back up, you mustcomplete this procedure on all the Enterprise Vault servers that run an indexingservice.

To find a complete list of the index locations you must back up

1 In the left pane of the administration console, browse to Enterprise VaultServers > 2003SRV.domain1.local > Services.

2 In the right pane, right-click Enterprise Vault Indexing Service and clickProperties.

3 Click the Index Locations tab and note the index locations that you mustback up.

Before you back up index locations, you should place them in backup mode.

See “Enterprise Vault backup mode” on page 4.

SQL stored procedureThis section describes two SQL scripts which you should run to update theEnterprise Vault directory database, and to create a SQL stored procedure andview which you can then call from your backup scripts to back up all yourEnterpriseVault databases. You candownload these two scripts from the followingpage on the Symantec support web site:

http://entsupport.symantec.com/docs/316647

To update the Enterprise Vault directory database, and create the new view andSQL stored procedure:

■ Run view_VaultStoreBackup.sql on the Enterprise Vault directory databaseon your SQL server. This creates a new view in the directory database, calledview_VaultStoreBackup which contains details of all the Enterprise Vaultdatabases that must be backed up.

7Backing up Enterprise VaultSQL stored procedure

■ Run aspa_BackupEVDatabases.sql. on your SQL server. This creates a SQLstored procedure called aspa_BackupEVDatabases, which you can call fromyour backup scripts to back up your Enterprise Vault databases.

Backup mode cmdletsEnterprise Vault provides a set of PowerShell cmdlets which you can use to setand 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-backupscript to set backup mode on index locations and vault stores before the backupis taken. After the backup has completed, use the cmdlets in a post-backup scriptto clear backup mode when the backup has completed.

To run PowerShell cmdlets directly, first run the Enterprise Vault ManagementShell

◆ Click Start >Programs >EnterpriseVault >EnterpriseVaultManagementShell.

PowerShell opens and loads the EnterpriseVault snap-inwhichmakes the backupmode cmdlets available in the shell.

The Enterprise Vault Management Shell provides the following backup modecmdlets:

DescriptionCmdlet

Reports the current backup mode settingson index locations.

Get-IndexLocationBackupMode

Sets backup mode on index locations.Set-IndexLocationBackupMode

Clears backup mode from index locations.Clear-IndexLocationBackUpMode

Reports the current backup mode settingson vault stores.

Get-VaultStoreBackupMode

Sets backup mode on vault stores.Set-VaultStoreBackupMode

Clears backup mode from vault stores.Clear-VaultStoreBackupMode

Backing up Enterprise VaultBackup mode cmdlets

8

Help is available for all the cmdlets. For example, the following command showsthe detailed help for Clear-VaultStoreBackupMode:

Get-Help Clear-VaultStoreBackupMode -detailed

Index location cmdletsThe syntax is the same for all three index location backup mode cmdlets. Forexample:

Set-IndexLocationBackupMode [-EVServerName] <String> [[-IndexRootPath]

<String>] [-EVSiteName <String>] [<CommonParameters>]

The following examples show how Set-IndexLocationBackupMode is used to setbackup mode on index locations:

■ Set-IndexLocationBackupMode EVServer-Win2k3

This command sets backupmode on all the index locations that are associatedwith server EVServer-Win2k3.

■ Set-IndexLocationBackupMode EVServer-Win2k3 -IndexRootPath

f:\indexing\index0

This command sets backup mode on index location f:\indexing\index0.

■ Set-IndexLocationBackupMode EVServer-Win2k3 -EVSiteName Site1

This command sets backup mode on all the index locations in Site1.

In all cases, you must specify the name of the server that owns the index locationor site so the cmdlet can find its ID.

If you know the ID of the index location, site or server, you can use the followingsyntax to set backup mode:

Set-IndexLocationBackupMode [-EntryId <String>] [<CommonParameters>]

For example:

Set-IndexLocationBackupMode -EntryId

1F3C7910CD579234AB8EB207F0ECEBCE912100002003SRV.Domain1.local

This command sets backup mode on the object that has the specified ID. Specifythe ID of an index location to set backup mode on that index location. Specify theID of a server or a site to set backup mode on all its associated index locations.

Clear-IndexLocationBackupMode uses the same syntax to clear backup modefrom index locations. Get-IndexLocationBackupMode also uses the same syntaxto report current backup mode settings.

9Backing up Enterprise VaultBackup mode cmdlets

Vault store cmdletsThe syntax is the same for all three vault store backupmode cmdlets. For example:

Clear-VaultStoreBackupMode [-Name] <String> [-EVServerName] <String>

[-EvObjectType] <EVObjectType> [<CommonParameters>]

The following examples showhow Clear-VaultStoreBackupMode is used to clearbackup mode from vault stores and vault store groups:

■ Clear-VaultStoreBackupMode VS1 EVServer-Win2k3 VaultStore

Clears backup mode from vault store VS1.

■ Clear-VaultStoreBackupMode VSG1 EVServer-Win2k3 VaultStoreGroup

Clears backup mode from all the vault stores in vault store group VSG1.

■ Clear-VaultStoreBackupMode Site1 EVServer-Win2k3 Site

Clears backup mode from all the vault stores in Site1.

In all cases you must provide the name of the server that owns the vault storesor site, and specify the object type. These parameters allow the cmdlet to find thecorrect ID.

You must provide the parameters in the order that is shown if you omit theparameter names. However, if you provide parameter names, you can use themin any order. For example:

Clear-VaultStoreBackupMode -EVServerName EVServer-Win2k3 -EVObjectType

VaultStore -Name VS1

If you know the ID of the vault store, vault store group or site, you can use thefollowing syntax to clear backup mode:

Clear-VaultStoreBackupMode -EntryId <String> [<CommonParameters>]

For example:

Clear-VaultStoreBackupMode -EntryId

1F3C7910CD579234AB8EB207F0ECEBCE912100002003SRV.Domain1.local

This command clears backup mode from the object that has the specified ID.Specify the ID of a vault store to clear backupmode from that vault store. Specifythe ID of a vault store group or a site to clear backup mode from its associatedvault stores.

Set-VaultStoreBackupMode uses the same syntax to set backup mode on vaultstores. Get-VaultStoreBackupMode also uses the same syntax to report currentbackup mode settings.

Backing up Enterprise VaultBackup mode cmdlets

10

Using PowerShell cmdlets in backup scriptsEnterprise Vault’s backup mode PowerShell cmdlets are designed to be used tocontrol backup mode from within your backup scripts. For example, you can setbackup mode on vault stores and index locations before you take a backup, andclear backup mode again after the backup is complete.

This section describes how to use Enterprise Vault’s backup mode PowerShellcmdlets in your backup scripts.

Note: Symantec Enterprise Vault andMicrosoftWindows PowerShell 1.0must beinstalled on your server to run these cmdlets.

In your backup scripts, you can use a single command to:

■ Run a new instance of Windows PowerShell

■ Load the Symantec Enterprise Vault PowerShell snapin

■ Run the appropriate cmdlet to control backup mode

For example, you can use the following command at the start of your backupscript, or in a pre-backup script, to set backup mode before you take a backup.This command runs PowerShell and loads the Symantec Enterprise VaultPowerShell snapin, then runs the set-vaultstorebackupmode cmdlet, to setbackup mode on the vault store group called Express Vault Store Group:

powershell -psconsolefile "C:\Program Files\Enterprise

Vault\EVShell.psc1" -command "& {set-vaultstorebackupmode -name

'Express Vault Store Group' -evservername server1 -evobjecttype

vaultstoregroup}"

After your backup is complete, you should run a similar command in your scriptto clear backup mode. For example:

powershell -psconsolefile "C:\Program Files\Enterprise

Vault\EVShell.psc1" -command "& {clear-vaultstorebackupmode -name

'Express Vault Store Group' -evservername server1 -evobjecttype

vaultstoregroup}"

11Backing up Enterprise VaultUsing PowerShell cmdlets in backup scripts

Backing up Enterprise VaultUsing PowerShell cmdlets in backup scripts

12