Veritas Enterprise Vault™ PowerShell Cmdlets
Clear-IndexLocationBackupMode
Clear-IndexLocationBackupMode decrements the backup mode count on one indexing location, on all the indexing locations associated with a server, or on all the indexing locations in a site.
Enterprise Vault maintains a count of backup mode requests for each indexing location. For example, if you use concurrent backup scripts in your environment, the backup mode count can be higher than 1. Backup mode is not cleared until the backup mode count reduces to 0.
Clear-IndexLocationBackupMode is provided by Symantec.EnterpriseVault.PowerShell.Snapin.dll, which is loaded by the Enterprise Vault Management Shell.
Clear-IndexLocationBackupMode [-EVServerName] <String> [[-IndexRootPath] <String>] [-EVSiteName <String>] [-ForceClearBackupMode <Boolean>] [-SuppressConfirm] [<CommonParameters>]
Clear-IndexLocationBackupMode [-EntryId <String>] [-ForceClearBackupMode <Boolean>] [-SuppressConfirm] [<CommonParameters>]
Table: Clear-IndexLocationBackupMode parameters
Parameter | Description |
|---|---|
-EVServerName (required) | The Enterprise Vault server that owns the indexing locations. You must provide this parameter if you specify a site or indexing location by name rather than ID. This allows Clear-IndexLocationBackupMode to find the ID of the site or indexing location. |
-IndexRootPath | The root path of an indexing location. |
-EVSiteName | The name of the site. |
-EntryId | The ID of the indexing location, service, server, or site. |
-ForceClearBackupMode | Use -ForceClearBackupMode:$true to forcibly clear backup mode. Clear-IndexLocationBackupMode then ignores the existing backup mode count and sets it to 0. |
-SuppressConfirm | Use -SuppressConfirm to suppress the prompt for confirmation when you use -ForceClearBackupMode:$true. This parameter is only available when you use -ForceClearBackupMode:$true. |
Clear-IndexLocationBackupMode EVServer-Win2k3
Decrements the backup mode count on all the indexing locations associated with server EVServer-Win2k3.
Clear-IndexLocationBackupMode EVServer-Win2k3 -ForceClearBackupMode:$true
Forcibly clears backup mode from all the indexing locations associated with server EVServer-Win2k3. Clear-IndexLocationBackupMode ignores the existing backup mode count and sets it to 0. In this example, Windows PowerShell prompts for confirmation before it executes the cmdlet.
Clear-IndexLocationBackupMode EVServer-Win2k3 -ForceClearBackupMode:$true -SuppressConfirm
Forcibly clears backup mode from all the indexing locations associated with server EVServer-Win2k3. Clear-IndexLocationBackupMode ignores the existing backup mode count and sets it to 0. In this example, Windows PowerShell does not prompt for confirmation before it executes the cmdlet.
Clear-IndexLocationBackupMode EVServer-Win2k3 -IndexRootPath f:\indexing\index0
Decrements the backup mode count on indexing location f:\indexing\index0.
Clear-IndexLocationBackupMode EVServer-Win2k3 -EVSiteName Site1
Decrements the backup mode count on all indexing locations in Site1.
Clear-IndexLocationBackupMode -EntryId 1F3...Domain.local
Decrements the backup mode count on the object that has the specified ID. The ID can be that of an indexing location, a server, or a site.
If you specify the ID of an indexing location, backup mode is decremented on that indexing location.
If you specify the ID of a server or a site, backup mode is decremented on the indexing locations associated with the server, or in the site.
There is a confirmation message on completion.