Search <book_title>...

Enterprise Vault™ PowerShell Cmdlets

Last Published: 2019-02-06

Product(s): Enterprise Vault (12.4)

Get-EVRetentionPlan

Get-EVRetentionPlan returns a list of all the retention plans that are configured in an Enterprise Vault site. You can filter the list of returned retention plans by description, retention category, override retention flag, and classification policy.

You can also return the properties of a specific retention plan and any retention folder information that you have defined in the plan. For more information on retention folders, see the Administrator's Guide.

Get-EVRetentionPlan is provided by the snap-in Symantec.EnterpriseVault.PowerShell.AdminAPI.dll.

Syntax

Get-EVRetentionPlan [-SiteId <String>] [-Name <String>] [-Description <String>] [-RetentionCategory <String>] [-OverrideRetention [<SwitchParameter>]] [-ClassificationPolicy <String>] [<CommonParameters>]

Parameters

Table: Get-EVRetentionPlan parameters

Parameter	Description
-SiteId	The ID of the Enterprise Vault site for which to return the retention plan details. If you omit this parameter, and the cmdlet cannot determine the ID by looking in the registry, then Get-EVRetentionPlan prompts you to enter the required ID. You can use Get-EVSite to obtain the site ID.
-Name	The name of a specific retention plan whose properties you want to return.
-Description	The retention plan description with which to filter the list of returned plans.
-RetentionCategory	The name of a retention category with which to filter the list of returned retention plans.
-OverrideRetention	If specified, return only those retention plans for which you have set the override retention flag. This flag instructs Enterprise Vault to expire each item according to the retention category that you have set with the retention plan. This retention category overrides the item's individual retention category.
-ClassificationPolicy	The name of a classification policy with which to filter the list of returned retention plans.

Examples

Get-EVRetentionPlan
Returns a list of all the retention plans that are configured in the Enterprise Vault site. As no site ID is specified, the cmdlet first looks for it in the registry and then, if it cannot find the ID there, prompts you for it.
Get-EVRetentionPlan -SiteId 13E...localdomain.com
Returns a list of all the retention plans that are configured in the specified Enterprise Vault site.
Get-EVRetentionPlan -SiteId 13E...localdomain.com -Name ManagersPlan
Returns the properties of the retention plan that is named "ManagersPlan".
Get-EVRetentionPlan -SiteId 13E...localdomain.com -Description RetentionPlanForManagers
Restricts the list of returned retention plans to those that have a description of "RetentionPlanForManagers".
Get-EVRetentionPlan -SiteId 13E...localdomain.com -RetentionCategory 3years
Restricts the list of returned retention plans to those that have a retention category of "3years".
Get-EVRetentionPlan -OverrideRetention
Restricts the list of returned retention plans to those for which you have set the override retention flag.
Get-EVRetentionPlan -ClassificationPolicy "Managers CP"
Restricts the list of returned retention plans to those that have a classification policy name of "Managers CP".
Get-EVRetentionPlan -ClassificationPolicy ""
Restricts the list of returned retention plans to those for which no classification policy has been specified.

Get-EVRetentionPlan -Name "ManagersPlan" |select -expand Folders | Format-Table

Returns the retention folder information that is defined in the "ManagersPlan" retention plan. For example:

FolderPath     FolderName RetentionCategory Expiry                Inheritance Language
----------     ---------- ----------------- ------                ----------- --------
\Business      Business   2-year            Folder ThisFolderAndAllSubfolders       en
\Business\2018 2018       5-year              Item ThisFolderAndAllSubfolders       en
\Business\2020 2020       2-year            Folder ThisFolderAndAllSubfolders       en
\Inbox         Inbox      1-year              Item             ThisFolderOnly       en
\Inbox\Finance Finance    2-year            Folder ThisFolderAndAllSubfolders       en
\Inbox\Legal   Legal      5-year              Item             ThisFolderOnly       en

The OverrideRetention and ClassificationPolicy settings for this retention plan determine whether the Expiry values are effective.

Get-EVRetentionPlan -Name "ManagersPlanWithAlternateLanguage" |select -expand Folders | Format-Table

Returns the retention folder information that is defined in the "ManagersPlanWithAlternateLanguage" retention plan. For example:

FolderPath          FolderName RetentionCategory Expiry                Inheritance Language
----------          ---------- ----------------- ------                ----------- ---------
\Business           Business   2-year            Folder ThisFolderAndAllSubfolders        en
\Forretning         Forretning 2-year            Folder ThisFolderAndAllSubfolders     da-DK
\Business\Legal     Legal      5-year              Item ThisFolderAndAllSubfolders        en
\Forretning\Gyldige Gyldige    5-year              Item ThisFolderAndAllSubfolders     da-DK

The retention plan was created with alternative folder names in Danish (da-DK). The default language in this case is English (en).

Get-EVRetentionPlan -Name "ManagersPlan" |select -expand FolderXml
Returns the retention folder information for the "ManagersPlan" retention plan in XML format.
Get-EVRetentionPlan -Name "ManagersPlan" |select -expand FolderXml | Out-File c:\retention_plan_folders.xml
Exports the retention folder information for the "ManagersPlan" retention plan to the file c:\retention_plan_folders.xml. You can edit this file and then resubmit the retention folder information with the Set-EVRetentionPlan cmdlet.

Output

Table: Get-EVRetentionPlan properties lists the properties that are available.

Table: Get-EVRetentionPlan properties

Name	Type	Description
Name	String	The name of the retention plan.
Description	String	The description of the retention plan.
RetentionCategory	String	The name of the retention category that is associated with the retention plan.
OverrideRetention	SwitchParameter	Whether you have specified the override retention flag for this retention plan.
ClassificationPolicy	String	The name of the classification policy that is associated with the retention plan.
HasFolders	Boolean	Whether the retention plan defines any retention folders. If true, the Folders and FolderXml properties contain information about the retention folders. The Folders property contains the information as tabulated text, which you can format using Format-Table. The FolderXml property contains the information as XML, which you can output to a file. You can edit this file and then resubmit the retention folder information with the Set-EVRetentionPlan cmdlet.
DisableStorageExpiry	SwitchParameter	Whether you have chosen to disable Storage Expiry in any archive that has retention folder issues.

If no retention plans are available, or if the cmdlet cannot find any plans that match the specified criteria, then it outputs a suitable error message.

Related cmdlets