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-EVIndexSnapshotLocationBackupMode
Clear-EVIndexSnapshotLocationBackupMode decrements the backup mode count of the specified index snapshot location or all index snapshot locations configured on the specified Enterprise Vault index server in the specified Enterprise Vault site. It also decrements the backup mode count of all index snapshot locations configured on all Enterprise Vault index servers in the specified Enterprise Vault site.
Note:
The backup mode of the index snapshot location is not cleared until the backup mode count reduces to 0.
Clear-EVIndexSnapshotLocationBackupMode [-EVServerName <String>] [-Path <String>] [-ForceClearBackupMode <SwitchParameter>] [-Confirm <SwitchParameter>] [-WhatIf <SwitchParameter>] [<CommonParameters>]
Clear-EVIndexSnapshotLocationBackupMode -SiteId <String> [-EVServerName <String>] [-Path <String>] [-ForceClearBackupMode <SwitchParameter>] [-Confirm <SwitchParameter>] [-WhatIf <SwitchParameter>] [<CommonParameters>]
Clear-EVIndexSnapshotLocationBackupMode decrements the backup mode count of the specified index snapshot location or all index snapshot locations that are configured on the specified Enterprise Vault index server in the specified Enterprise Vault site. It also decrements the backup mode count of all index snapshot locations configured on all Enterprise Vault index servers in the specified Enterprise Vault site.
The index snapshot location remains in the backup mode until the count is greater than 0.
Enterprise Vault maintains a count of the backup mode requests for each index snapshot location. For example, if you use concurrent backup scripts in your environment, the backup mode count can be higher than 1. The backup mode is not cleared until the backup mode count reduces to 0.
Clear-EVIndexSnapshotLocationBackupMode is provided by Symantec.EnterpriseVault.PowerShell.AdminAPI.dll, which the Enterprise Vault Management Shell loads.
Table: Clear-EVIndexSnapshotLocationBackupMode parameters
Parameter | Description |
|---|---|
-SiteId | The ID of the Enterprise Vault site for which you want to clear the backup mode of the index snapshot locations configured on the Enterprise Vault index servers in the specified Enterprise Vault site. If you omit this parameter, Clear-EVIndexSnapshotLocationBackupMode retrieves the SiteId from the Enterprise Vault index server specified as EVServerName parameter; otherwise, it uses the ID of the site of the Enterprise Vault index server where the command is running. You can use the Get-EVSite command to obtain the SiteId. |
-EVServerName | The name of the Enterprise Vault index server for which you want to clear the backup mode of the specified index snapshot location or all index snapshot locations. If you omit this parameter, Clear-EVIndexSnapshotLocationBackupMode uses the host name of the Enterprise Vault index server where the command is running. You can use the Get-EVComputers command to obtain the Enterprise Vault index server name. |
-Path | Path of the index snapshot location for which you want to clear the backup mode. |
-ForceClearBackupMode | Use -ForceClearBackupMode:$true to forcibly clear backup mode. Clear-EVIndexLocationBackupMode then ignores the existing backup mode count and sets it to 0. |
-Confirm | You can use the Confirm switch to suppress the confirmation prompt that appears by default when this cmdlet is run. To suppress the confirmation prompt, use the syntax -Confirm:$False. You must include a colon ( : ) in the syntax. |
-WhatIf | The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can preview the changes that would occur without applying any of those changes. You do not need to specify a value with the WhatIf switch. |
C:\PS> Clear-EVIndexSnapshotLocationBackupMode
Decrements the backup mode count of all index snapshot locations configured on the Enterprise Vault index server on which this command is executed.
C:\PS> Clear-EVIndexSnapshotLocationBackupMode -EVServerName evserver.earth.local
Decrements the backup mode count of all index snapshot locations configured on the Enterprise Vault index server 'evserver.earth.local'.
C:\PS> Clear-EVIndexSnapshotLocationBackupMode -Path e:\indexsnapshotlocation
Decrement the backup mode count of the index snapshot location 'e:\indexsnapshotlocation' configured on the Enterprise Vault index server on which this command is executed.
C:\PS> Clear-EVIndexSnapshotLocationBackupMode -EVServerName evserver.earth.local -Path e:\indexsnapshotlocation
Decrements the backup mode count of the index snapshot location 'e:\indexsnapshotlocation' configured on the Enterprise Vault index server 'evserver.earth.local'.
C:\PS> Clear-EVIndexSnapshotLocationBackupMode -SiteId 17EEC4C7A9E1E4540AE93FC7B20C6A7311d10000evserver.earth.local
Decrements the backup mode count of all index snapshot locations configured on all Enterprise Vault index servers in the Enterprise Vault site '17EEC4C7A9E1E4540AE93FC7B20C6A7311d10000evserver.earth.local'.
C:\PS> Clear-EVIndexSnapshotLocationBackupMode -SiteId 17EEC4C7A9E1E4540AE93FC7B20C6A7311d10000evserver.earth.local -EVServerName evserver.earth.local
Decrements the backup mode count of all index snapshot locations configured on the Enterprise Vault index server 'evserver.earth.local' in the Enterprise Vault site '17EEC4C7A9E1E4540AE93FC7B20C6A7311d10000evserver.earth.local'.
C:\PS> Clear-EVIndexSnapshotLocationBackupMode -SiteId 17EEC4C7A9E1E4540AE93FC7B20C6A7311d10000evserver.earth.local -EVServerName evserver.earth.local -Path e:\indexsnapshotlocation
Decrements the backup mode count of the index snapshot location 'e:\indexsnapshotlocation' configured on the Enterprise vault index server 'evserver.earth.local' in the Enterprise Vault site '17EEC4C7A9E1E4540AE93FC7B20C6A7311d10000evserver.earth.local'.
C:\PS> Get-EVSite | Clear-EVIndexSnapshotLocationBackupMode
Decrements the backup mode count of all index snapshot locations configured on all Enterprise Vault index servers in the Enterprise Vault site returned by the Get-EVSite command.
C:\PS> Get-EVComputers | Clear-EVIndexSnapshotLocationBackupMode
Decrements the backup mode count of all index snapshot locations configured on all Enterprise Vault index servers returned by the Get-EVComputers command.
C:\PS> Get-EVIndexSnapshotLocation | Clear-EVIndexSnapshotLocationBackupMode
Decrements the backup mode count of all index snapshot locations returned by the Get-EVIndexSnapshotLocation command.
C:\PS> Get-EVIndexSnapshotLocation -OnlyActive | Clear-EVIndexSnapshotLocationBackupMode
Decrements the backup mode count of the active index snapshot location returned by the Get-EVIndexSnapshotLocation command.
C:\PS> Get-EVComputers | Clear-EVIndexSnapshotLocationBackupMode -ForceClearBackupMode
Forcibly clears the backup mode of all index snapshot locations configured on all Enterprise Vault index servers returned by the Get-EVComputers command.
None.
Clear-EVIndexSnapshotLocationBackupMode returns no output.