Search <book_title>...

Veritas Enterprise Vault™ PowerShell Cmdlets

Last Published: 2017-08-10

Product(s): Enterprise Vault (12.2)

New-EVRetentionPlan

New-EVRetentionPlan creates a retention plan for an Enterprise Vault site.

New-EVRetentionPlan is provided by Symantec.EnterpriseVault.PowerShell.AdminAPI.dll, which is loaded by the Enterprise Vault Management Shell.

Syntax

New-EVRetentionPlan -SiteId <String> -Name <String> -Description <String> -RetentionCategory <String> [-OverrideRetention [<SwitchParameter>]] [-ClassificationPolicy <String>] [-FolderXmlPath <String>] [-DisableStorageExpiry [<SwitchParameter>]] [<CommonParameters>]

New-EVRetentionPlan -SiteId <String> -Name <String> -Description <String> -RetentionCategory <String> [-OverrideRetention [<SwitchParameter>]] [-ClassificationPolicy <String>] [-FolderXml <String>] [-DisableStorageExpiry [<SwitchParameter>]] [<CommonParameters>]

Parameters

Table: New-EVRetentionPlan parameters

Parameter	Description
-SiteId (required)	The ID of the Enterprise Vault site for which to create the retention plan. If you omit this parameter, and the cmdlet cannot determine the ID by looking in the registry, then New-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. The name must be unique, and it can contain up to 40 alphanumeric or space characters.
-Description (required)	The description of the retention plan. The description can contain up to 127 alphanumeric, space, or special characters.
-RetentionCategory (required)	The name of a retention category with which to associate the retention plan.
-OverrideRetention	Add this parameter to override the current retention categories of the affected items with the retention category that is associated with this plan. Note: Omit this parameter if you have also associated the plan with a classification policy that allows the classification rules to update the retention categories of items. In this case, Enterprise Vault expires the items according to the retention categories that the classification rules apply to them.
-ClassificationPolicy	The name of a classification policy with which to associate the retention plan. If specified, Enterprise Vault sends for classification all the archived items that have this retention plan and tags them according to the rules specified in the classification policy. Note: Classification operates in test mode if you have yet to install a license for the Enterprise Vault retention feature, or the existing license has expired. Instead of applying classification tags and other changes to the archived items, the classification feature generates a report that lists the planned changes.
-FolderXmlPath	The path to an XML file that defines the properties of one or more retention folders. For more information on retention folders and guidelines on how to prepare the required XML file, see the Administrator's Guide. Enterprise Vault comes with a sample XML file, `RetentionFoldersSample.xml`, which you can copy and modify as required. The file is in the `Modules\EnterpriseVault` subfolder of the Enterprise Vault installation folder (for example, `C:\Program Files (x86)\Enterprise Vault\Modules\EnterpriseVault`). If you have associated this retention plan with a classification policy that allows the classification feature to update the retention categories of individual items, the retention folders must have an Expiry setting of Item (not Folder). Type an absolute, relative, or UNC path, and enclose it in quotation marks if it contains space characters.
-FolderXml	This parameter performs the same function as the -FolderXmlPath parameter. However, in this case you define the retention folder properties in an XML string that you append to the parameter, instead of defining them in an external file. Use a backtick character (') to escape the quotation marks in this string.
-DisableStorageExpiry	Add this parameter to disable Storage Expiry in any archive that has retention folder issues.

Examples

New-EVRetentionPlan -SiteId 13E...localdomain.com -Name "Projects Retention Plan" -Description "Plan created for managing projects" -RetentionCategory "5 years"
Creates a retention plan that is named "Projects Retention Plan" in the specified Enterprise Vault site. The new plan has the description "Plan created for managing projects" and the retention category "5 years".
New-EVRetentionPlan -Name "Projects Retention Plan" -Description "Plan created for managing projects" -RetentionCategory "5 years" -OverrideRetention -ClassificationPolicy "Managers CP"
Creates a retention plan with the specified description and retention category. 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.
When items are manually deleted or automatically expired, the "5 years" retention category overrides the current retention categories of the items. However, if the "Managers CP" classification policy allows classification to update the retention categories of individual items, it is necessary to omit the -OverrideRetention parameter. Enterprise Vault expires the items according to the retention categories that the classification rules apply to them.
Get-EVRetentionPlan -Name "Existing Retention Plan" | New-EVRetentionPlan -Name "New Retention Plan" -RetentionCategory "1 year"
Pipes all the settings of an existing retention plan to a new one. The new plan has the retention category "1 year" rather than the retention category that you set for the existing plan.
New-EVRetentionPlan -Name "Projects Retention Plan" -Description "Plan for adding retention folders" -RetentionCategory "5 years" -FolderXmlPath "c:\My XML Files\folders.xml" -DisableStorageExpiry
Creates a retention plan in which the specified XML file, folders.xml, defines the properties of one or more retention folders. The retention settings that you define for these folders in the XML file override the "5 years" retention category that you associate with the plan. The command also disables Storage Expiry in any archive that has retention folder issues.
New-EVRetentionPlan -Name "Projects Retention Plan" -Description "Plan for New Projects" -RetentionCategory "5 years" -FolderXml "<?xml version='"1.0'" encoding='"utf-16'"?><RetentionFolderRoot><RetentionFolder Name='"Documents'" RetentionCategory='"5 years'" Expiry='"Folder'" Inheritance='"ThisFolderAndAllSubfolders'"/></RetentionFolder></RetentionFolderRoot>"
Creates a retention plan with the specified name, description, and retention category, and associates with it the retention folder "Documents". You can use the following command to return the retention folder information for the plan:
Get-EVRetentionPlan -Name "Projects Retention Plan" | select -expand Folders | sort FolderPath | ft -AutoSize
This command produces the following output:
```
FolderPath    FolderName    RetentionCategory    Expiry                   Inheritance
----------    ----------    -----------------    ------                   -----------
\Documents    Documents     5 years              Folder    ThisFolderAndAllSubfolders
```

Output

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

Table: New-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 a classification policy with which the retention plan is associated.
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.
DisableStorageExpiry	SwitchParameter	Whether you have chosen to disable Storage Expiry in any archive that has retention folder issues.

Related cmdlets