Enterprise Vault™ Managing Retention

Last Published:
Product(s): Enterprise Vault (14.1, 14.0, 12.5, 12.4, 12.3)

About the PowerShell cmdlets for working with retention plans

Enterprise Vault comes with a number of PowerShell cmdlets with which you can create or modify retention plans. These cmdlets perform the same function as the equivalent facilities in the Administration Console.

Table: PowerShell cmdlets for creating or modifying retention plans

Cmdlet

Description

Get-EVRetentionPlan

Returns a list of all the retention plans that you have configured in an Enterprise Vault site. You can filter the list by various properties, including the classification policies that you have associated with the plans.

You can also return the properties of a specific retention plan and any retention folder information that you have defined in the plan.

New-EVRetentionPlan

Creates a retention plan.

Remove-EVRetentionPlan

Removes the specified retention plan, if it is not in use.

Set-EVRetentionPlan

Sets or updates the properties of an existing retention plan, such as its associated retention category, classification policy, and retention folders.

See the PowerShell Cmdlets guide for more information on these cmdlets.