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-EVRetentionPlan
Remove-EVRetentionPlan removes the specified retention plan, if it is not in use. The cmdlet prompts you to confirm the removal of the retention plan.
You cannot remove a retention plan while you have associated it with any of the following:
An Exchange, Domino, IMAP, or SMTP Mailbox Journaling provisioning group
An FSA volume or folder policy
A public folder target
A SharePoint target or site collection
An archive to which you have assigned the retention plan through the Set-EVArchive PowerShell cmdlet
You must disassociate the retention plan from these entities and then run the appropriate provisioning or archiving task to remove the association with the target archives.
Remove-EVRetentionPlan is provided by the snap-in Symantec.EnterpriseVault.PowerShell.AdminAPI.dll.
Remove-EVRetentionPlan -SiteId <String> -Name <String> [<CommonParameters>]
Table: Remove-EVRetentionPlan parameters
Parameter | Description |
|---|---|
-SiteId (required) | The ID of the Enterprise Vault site to which the retention plan belongs. If you omit this parameter, and the cmdlet cannot determine the ID by looking in the registry, then Remove-EVRetentionPlan prompts you to enter the required ID. You can use Get-EVSite to obtain the site ID. |
-Name (required) | The name of the retention plan to remove. |
Remove-EVRetentionPlan -SiteId 13E...localdomain.com -Name "PlanForCEOs"
Removes the retention plan that is named "PlanForCEOs".
There is a confirmation message on completion.
See Get-EVRetentionPlan.
See New-EVRetentionPlan.
See Set-EVRetentionPlan.
See Set-EVArchive.
See Get-EVSite.