Enterprise Vault™ PowerShell Cmdlets
- Introducing the Enterprise Vault PowerShell cmdlets
- Archiving: Exchange
- Archiving: FSA
- Get-EVFSAComputerSettings
- Get-EVFSAFileServer
- Get-EVFSAFolder
- Get-EVFSASiteSettings
- Get-EVFSAVolume
- New-EVFSAFileServer
- New-EVFSAFolder
- New-EVFSAVolume
- Remove-EVFSAFileServer
- Remove-EVFSAFolder
- Remove-EVFSAVolume
- Set-EVFSAComputerSettings
- Set-EVFSAFileServer
- Set-EVFSAFolder
- Set-EVFSASiteSettings
- Set-EVFSAVolume
- Archiving: Skype for Business
- Archiving: SMTP
- Get-EVSMTPHoldingFolder
- Get-EVSMTPMessageTrackingLogLocation
- Get-EVSMTPPolicy
- Get-EVSMTPServerSettings
- Get-EVSMTPTarget
- New-EVSMTPPolicy
- New-EVSMTPServerSettings
- New-EVSMTPTarget
- Remove-EVSMTPPolicy
- Remove-EVSMTPTarget
- Set-EVSMTPMessageTrackingLogLocation
- Set-EVSMTPPolicy
- Set-EVSMTPServerSettings
- Set-EVSMTPTarget
- Sync-EVSMTPServerSettings
- Backup
- Get-EVIndexSnapshotLocationBackupMode
- Set-EVIndexSnapshotLocationBackupMode
- Clear-EVIndexSnapshotLocationBackupMode
- Get-IndexLocationBackupMode
- Set-IndexLocationBackupMode
- Clear-IndexLocationBackUpMode
- Get-VaultStoreBackupMode
- Set-VaultStoreBackupMode
- Clear-VaultStoreBackupMode
- Set-EVIndexSnapshotLocation
- Get-EVIndexSnapshotLocation
- Remove-EVIndexSnapshotLocation
- New-EVIndexSnapshot
- Get-EVIndexSnapshot
- Remove-EVIndexSnapshot
- Restore-EVIndexSnapshot
- Get-EVIndexSnapshotRepository
- Remove-EVIndexSnapshotRepository
- Classification
- Disable-EVClassification
- Get-EVClassificationFCITags
- Get-EVClassificationPolicy
- Get-EVClassificationStatus
- Get-EVClassificationTestMode
- Get-EVClassificationVICTags
- Import-EVClassificationFCIRules
- Initialize-EVClassificationVIC
- Set-EVClassificationVICFIPSMode
- New-EVClassificationPolicy
- Publish-EVClassificationFCIRules
- Remove-EVClassificationPolicy
- Set-EVClassificationPolicy
- Set-EVClassificationTestMode
- Databases
- IMAP access
- Indexing
- Records management
- Retention plans
- Roles-based administration
- Sites and servers
- Tasks and services
- Vault stores and archives
Clear-IndexLocationBackUpMode
Decrements the backup mode count of Non-Elasticsearch index location by 1. When the count reaches 0, Non-Elasticsearch index location backup mode is cleared.
Clear-IndexLocationBackupMode decrements the backup mode count on one Non-Elasticsearch index location, on all the Non-Elasticsearch index locations associated with a server, or on all the Non-Elasticsearch index locations in a site.
Enterprise Vault maintains a count of backup mode requests for each Non-Elasticsearch index 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.
Note:
Clear-IndexLocationBackupMode is not applicable for Elasticsearch index location. This command only decrements backup mode count on Non-Elasticsearch index locations.
Clear-IndexLocationBackUpMode is provided by the snap-in Symantec.EnterpriseVault.PowerShell.SnapIn.dll.
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 Non-Elasticsearch index locations. You must provide this parameter if you specify a site or Non-Elasticsearch index location by name rather than ID. This allows Clear-IndexLocationBackupMode to find the ID of the site or Non-Elasticsearch index location. |
-IndexRootPath | The root path of a Non-Elasticsearch index location. |
-EVSiteName | The name of the site. |
-EntryId | The ID of the Non-Elasticsearch index 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. |
C:\PS>Clear-IndexLocationBackupMode EVServer-Win2k3
Decrements the backup mode count on all the Non-Elasticsearch index locations associated with server EVServer-Win2k3.
C:\PS>Clear-IndexLocationBackupMode EVServer-Win2k3 -ForceClearBackupMode:$true
Forcibly clears backup mode from all the Non-Elasticsearch index 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 command.
C:\PS>Clear-IndexLocationBackupMode EVServer-Win2k3 -ForceClearBackupMode:$true -SuppressConfirm
Forcibly clears backup mode from all the Non-Elasticsearch index 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 command.
C:\PS>Clear-IndexLocationBackupMode EVServer-Win2k3 -IndexRootPath f:\indexing\index0
Decrements the backup mode count on the Non-Elasticsearch index location f:\indexing\index0.
C:\PS>Clear-IndexLocationBackupMode EVServer-Win2k3 -EVSiteName Site1
Decrements the backup mode count on all Non-Elasticsearch index locations in Site1.
C:\PS>Clear-IndexLocationBackupMode -EntryId 1F3C7910CD579234AB8EB207F0ECEBCE912100002003SRV.Domain1.local
Decrements the backup mode count on the object that has the specified ID. The ID can be that of an Non-Elasticsearch index location, a server, or a site.
If you specify the ID of a Non-Elasticsearch index location, backup mode is decremented on that index location.
If you specify the ID of a server or a site, backup mode is decremented on the Non-Elasticsearch index locations associated with the server, or in the site.
Information regarding operation success.