Enterprise Vault™ PowerShell Cmdlets
- Introducing the Enterprise Vault PowerShell cmdlets
- Archiving: Exchange
- Archiving: FSA
- Archiving: Skype for Business
- Archiving: SMTP
- Backup
- Classification
- Databases
- IMAP access
- Indexing
- Records management
- Retention plans
- Roles-based administration
- Sites and servers
- Tasks and services
- Vault stores and archives
Remove-EVIndexSnapshotRepository
Remove-EVIndexSnapshotRepository removes the specified index snapshot repository that was created on the specified Enterprise Vault index server in the specified Enterprise Vault site.
Remove-EVIndexSnapshotRepository -Name <String> [-EVServerName <String>] [-ForceDelete <SwitchParameter>] [-Confirm <SwitchParameter>] [-WhatIf <SwitchParameter>] [<CommonParameters>]
Remove-EVIndexSnapshotRepository -Name <String> -SiteId <String> [-EVServerName <String>] [-ForceDelete <SwitchParameter>] [-Confirm <SwitchParameter>] [-WhatIf <SwitchParameter>] [<CommonParameters>]
Remove-EVIndexSnapshotRepository removes the specified index snapshot repository that was created on the specified Enterprise Vault index server in the specified Enterprise Vault site.
Remove-EVIndexSnapshotRepository is provided by Symantec.EnterpriseVault.PowerShell.AdminAPI.dll
, which the Enterprise Vault Management Shell loads.
Table: Remove-EVIndexSnapshotRepository parameters
Parameter | Description |
---|---|
-Name | Name of the index snapshot repository that you want to remove. |
-SiteId | The ID of the Enterprise Vault site from which you want to remove the specified index snapshot repository. If you omit this parameter, Remove-EVIndexSnapshotRepository 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 repository. If you omit this parameter, Remove-EVIndexSnapshotRepository 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. |
-ForceDelete [<SwitchParameter>] | You can use this switch to forcefully delete a repository. This will bypass all the validations. |
-Confirm [<SwitchParameter>] | 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 [<SwitchParameter>] | 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. |
Remove-EVIndexSnapshotRepository returns no output.
C:\PS> Remove-EVIndexSnapshotRepository -Name 1afcfcef-2502-4ff4-a066-f3fb165c7f08
Removes the index snapshot repository with name 1afcfcef-2502-4ff4-a066-f3fb165c7f08 from the Enterprise Vault index server on which this command is executed.
C:\PS> Remove-EVIndexSnapshotRepository -Name 1afcfcef-2502-4ff4-a066-f3fb165c7f08 -ServerName win12r2.domain.local
Removes the index snapshot repository with name 1afcfcef-2502-4ff4-a066-f3fb165c7f08 from the Enterprise Vault index server
win12r2.domain.local
.C:\PS> Remove-EVIndexSnapshotRepository -Name 1afcfcef-2502-4ff4-a066-f3fb165c7f08 -SiteId 1400222F70EEFC04AA6B63C233696BB491d10000Win12R2.domain.local -ServerName win12r2.domain.local
Removes the index snapshot repository with name 1afcfcef-2502-4ff4-a066-f3fb165c7f08 from the Enterprise Vault index server
win12r2.domain.local
in the Enterprise Vault site 1400222F70EEFC04AA6B63C233696BB491d10000Win12R2.domain.local.C:\PS> Get-EVIndexSnapshotRepository | Remove-EVIndexSnapshotRepository
Removes all index snapshot repositories returned by the Get-EVIndexSnapshotRepository command.
C:\PS> Get-EVIndexSnapshotLocation -OnlyActive | Get-EVIndexSnapshotRepository | Remove-EVIndexSnapshotRepository
Removes all index snapshot repositories for the active index snapshot location returned by the Get-EVIndexSnapshotLocation command.