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
Remove-EVIndexSnapshot
Remove-EVIndexSnapshot removes the specified index snapshot of the specified Enterprise Vault index server in the specified Enterprise Vault site.
Remove-EVIndexSnapshot -SnapshotName <String> [-ForceDelete <SwitchParameter>] [-EVServerName <String>] [-Confirm <SwitchParameter>] [-WhatIf <SwitchParameter>] [<CommonParameters>]
Remove-EVIndexSnapshot -SnapshotName <String> [-ForceDelete <SwitchParameter>] -SiteId <String> [-EVServerName <String>] [-Confirm <SwitchParameter>] [-WhatIf <SwitchParameter>] [<CommonParameters>]
Remove-EVIndexSnapshot removes the specified index snapshot of the specified Enterprise Vault index server in the specified Enterprise Vault site.
Remove-EVIndexSnapshot is provided by Symantec.EnterpriseVault.PowerShell.AdminAPI.dll, which the Enterprise Vault Management Shell loads.
Table: Remove-EVIndexSnapshot parameters
Parameter | Description |
|---|---|
-SnapshotName (required) | Name of the index snapshot that you want to remove. |
-ForceDelete | Use -ForceDelete:$true to forcibly delete latest snapshot. |
-SiteId | The ID of the Enterprise Vault site from which you want to remove the specified index snapshot. If you omit this parameter, Remove-EVIndexSnapshot 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 from which you want to remove the specified index snapshot. If you omit this parameter, Remove-EVIndexSnapshot 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. |
-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> Remove-EVIndexSnapshot -SnapshotName 2afcfcef-2502-fff4-a066-f3fb165c7f08
Removes the index snapshot with name '2afcfcef-2502-fff4-a066-f3fb165c7f08' from the list of snapshots of Enterprise Vault index server on which this command is executed.
C:\PS> Remove-EVIndexSnapshot -SnapshotName 3aedcfcef-2502-fff4-a066-f3fb165c7f08 -ForceDelete:$true
Forcibly deletes '3aedcfcef-2502-fff4-a066-f3fb165c7f08' index snapshot even if it's latest index snapshot on the Enterprise Vault index server.
C:\PS> Remove-EVIndexSnapshot -SnapshotName 2afcfcef-2502-fff4-a066-f3fb165c7f08 -ServerName win12r2.domain.local
Removes the index snapshot with name '2afcfcef-2502-fff4-a066-f3fb165c7f08' from the list of snapshots of Enterprise Vault index server 'win12r2.domain.local'.
C:\PS> Remove-EVIndexSnapshot -SnapshotName 2afcfcef-2502-fff4-a066-f3fb165c7f08 -SiteId 2400222F70EEFC04AA6B63C233696BB491d10000Win12R2.domain.local -ServerName win12r2.domain.local
Removes the index snapshot with name '2afcfcef-2502-fff4-a066-f3fb165c7f08' from the list of snapshots of Enterprise Vault index server 'win12r2.domain.local' in the Enterprise Vault site '2400222F70EEFC04AA6B63C233696BB491d10000Win12R2.domain.local'.
C:\PS> Get-EVIndexSnapshot -Latest:$false | Remove-EVIndexSnapshot
Removes all index snapshots returned by the Get-EVIndexSnapshot command.
C:\PS> Get-EVIndexSnapshot | Remove-EVIndexSnapshot -ForceDelete
Forcibly deletes all index snapshots including latest index snapshot on the Enterprise Vault index server.
C:\PS> Get-EVIndexSnapshot -Latest | Remove-EVIndexSnapshot -ForceDelete
Forcibly deletes latest index snapshot on the Enterprise Vault index server.
None.
Remove-EVIndexSnapshot returns no output.