Enterprise Vault™ Backing Up Enterprise Vault: Medium Environment

Last Published:
Product(s): Enterprise Vault (14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.0.1, 11.0)

Index location backup mode cmdlet syntax

The syntax is the same for all three index location backup mode cmdlets. For example:

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

The following examples show how Set-IndexLocationBackupMode is used to increment the backup mode count on index locations:

  • Set-IndexLocationBackupMode EVServer

    This command increments the backup mode count on all the index locations that are associated with server EVServer.

  • Set-IndexLocationBackupMode EVServer -IndexRootPath f:\indexing\index0

    This command increments the backup mode count on index location f:\indexing\index0.

  • Set-IndexLocationBackupMode EVServer -EVSiteName Site1

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

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

If you know the ID of the index location, site or server, you can use the following syntax to increment the backup mode count:

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

For example:

Set-IndexLocationBackupMode -EntryId 1F3C7910CD579234AB8EB207F0ECEBCE91210000EVServer.Domain1.local

This command increments the backup mode count on the object that has the specified ID. Specify the ID of an index location to increment the backup mode count on that index location. Specify the ID of a server or a site to increment the backup mode count on all its associated index locations.

Clear-IndexLocationBackupMode uses the same syntax to decrement the backup mode count on index locations. It also has an additional parameter which you can use to forcibly clear backup mode from index locations. For example:

Clear-IndexLocationBackupMode EV1 -ForceClearBackupMode 1

This command forcibly clears backup mode from all the index locations associated with server EV1. Clear-IndexLocationBackupMode ignores the existing backup mode count and sets it to 0.

Get-IndexLocationBackupMode also uses the same syntax to report current backup mode settings.