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-EVIndexSnapshotLocation
Remove-EVIndexSnapshotLocation removes the specified index snapshot location that was configured on the specified Enterprise Vault index server in the specified Enterprise Vault site.
Remove-EVIndexSnapshotLocation -SnapshotLocationPath <String> [-EVServerName <String>] [-ForceDelete <SwitchParameter>] [-Confirm <SwitchParameter>] [-WhatIf <SwitchParameter>] [<CommonParameters>]
Remove-EVIndexSnapshotLocation -SnapshotLocationPath <String> -SiteId <String> [-EVServerName <String>] [-ForceDelete <SwitchParameter>] [-Confirm <SwitchParameter>] [-WhatIf <SwitchParameter>] [<CommonParameters>]
Remove-EVIndexSnapshotLocation removes the specified index snapshot location that was configured on the specified Enterprise Vault index server in the specified Enterprise Vault site.
Remove-EVIndexSnapshotLocation is provided by Symantec.EnterpriseVault.PowerShell.AdminAPI.dll
, which the Enterprise Vault Management Shell loads.
Table: Get-EVIndexSnapshot parameters
Parameter | Description |
---|---|
-SnapshotLocationPath | Path of the index snapshot location that you want to remove. |
-SiteId | The ID of the Enterprise Vault site from which you want to remove the specified index snapshot locations. If you omit this parameter, Remove-EVIndexSnapshotLocation 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 locations. If you omit this parameter, Remove-EVIndexSnapshotLocation 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 | You can use this switch to forcefully delete a location. This will bypass all the validations. |
-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-EVIndexSnapshotLocation -SnapshotLocationPath c:\location1
Removes the index snapshot location with path 'c:\location1' from the Enterprise Vault index server on which this command is executed.
C:\PS> Remove-EVIndexSnapshotLocation -SnapshotLocationPath c:\location1 -ForceDelete
Removes the index snapshot location with the path 'c:\location1' from the Enterprise Vault index server on which this command is executed without running any validations.
C:\PS> Remove-EVIndexSnapshotLocation -SnapshotLocationPath c:\location1 -ServerName win12r2.domain.local
Removes the index snapshot location with path 'c:\location1' from the Enterprise Vault index server 'win12r2.domain.local'.
C:\PS> Remove-EVIndexSnapshotLocation -SnapshotLocationPath c:\location1 -SiteId 1400222F70EEFC04AA6B63C233696BB491d10000Win12R2.domain.local
Removes the index snapshot location with path 'c:\location1' from the Enterprise Vault index server in the specified Enterprise Vault site.
C:\PS> Get-EVSite | Remove-EVIndexSnapshotLocation -SnapshotLocationPath c:\location1 -EVServerName win12r2.domain.local
Removes all the index snapshot locations of all the Enterprise Vault index servers in the Enterprise Vault site returned by Get-EVSite command.
C:\PS> Get-EVComputers | Remove-EVIndexSnapshotLocation -SnapshotLocationPath c:\location1
Removes all the index snapshot locations of all the Enterprise Vault index servers returned by Get-EVComputers command.
None.
Remove-EVIndexSnapshotLocation returns no output.