Veritas Enterprise Vault™ PowerShell Cmdlets
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.
New-EVRetentionPlan [-SiteId <String>] [-Name <String>] [-Description <String>] [-RetentionCategory <String>] [-OverrideRetention [<SwitchParameter>]] [-ClassificationPolicy <String>] [<CommonParameters>]
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 to override the current retention categories of the affected items with the retention category associated with this plan. Note: This flag does not take effect if there is an associated classification policy that allows the classification rules to update the retention category 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. |
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.
Enterprise Vault expires the affected items according to the "5 years" retention category rather than their individual retention categories. However, this is not the case if the "Managers CP" classification policy allows the classification rules to update the retention categories of the items. In this instance, Enterprise Vault expires the items according to the retention categories that the classification rules apply to them.
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. If specified, this flag causes Enterprise Vault to override the current retention categories of the affected items with the retention category associated with this plan. Note: This flag does not take effect if there is an associated classification policy that allows the classification rules to update the retention category of items. In this case, Enterprise Vault expires the items according to the retention categories that the classification rules apply to them. |
ClassificationPolicy | String | The name of a classification policy with which the retention plan is associated. 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. |
See Get-EVRetentionPlan.
See Set-EVRetentionPlan.
See Get-EVSite.