Veritas Enterprise Vault™ PowerShell Cmdlets
Set-EVRetentionPlan
Set-EVRetentionPlan sets or updates the properties of an existing retention plan.
Set-EVRetentionPlan is provided by Symantec.EnterpriseVault.PowerShell.AdminAPI.dll, which is loaded by the Enterprise Vault Management Shell.
Set-EVRetentionPlan [-SiteId <string>] [-Name <string>] [-Description <string>] [-RetentionCategory <string>] [-OverrideRetention [<SwitchParameter>]] [-ClassificationPolicy <String>] [<CommonParameters>]
Table: Set-EVRetentionPlan parameters
Parameter | Description |
|---|---|
-SiteId (required) | The ID of the Enterprise Vault site for which to set or update the retention plan details. If you omit this parameter, and the cmdlet cannot determine the ID by looking in the registry, then Set-EVRetentionPlan prompts you to enter the required ID. You can use Get-EVSite to obtain the site ID. |
-Name (required) | The name of a specific retention plan whose properties you want to set or update. |
-Description | The description to set for the retention plan. The description can contain up to 127 alphanumeric, space, or special characters. |
-RetentionCategory | 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. |
Set-EVRetentionPlan -SiteId 13E...localdomain.com -Name "Projects Retention Plan" -Description "Plan created for managing projects" -RetentionCategory "5 years"
Updates the properties of an existing retention plan, "Projects Retention Plan", in the specified Enterprise Vault site. The plan has the description "Plan created for managing projects" and the retention category "5 years".
Set-EVRetentionPlan -Name "Projects Retention Plan" -ClassificationPolicy CP
Updates the classification policy property of the specified retention plan.
Set-EVRetentionPlan -Name "Projects Retention Plan" -ClassificationPolicy CP -OverrideRetention
Sets the override retention flag for the specified retention plan. When items are manually deleted or automatically expired, the retention category that you have set with the plan overrides their current retention categories. Note that this flag does not take effect if the "CP" classification policy 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.
Set-EVRetentionPlan -SiteId 13E9...localdomain.com -Name "Projects Retention Plan" -Description "Plan updated for managing projects" -RetentionCategory "6 years" -OverrideRetention -ClassificationPolicy CP2
Updates the properties of an existing retention plan that is named "Projects Retention Plan" in the specified Enterprise Vault site. The plan has the description "Plan updated for managing projects" and the retention category "6 years".
Set-EVRetentionPlan -SiteId 13E...localdomain.com -Name "Projects Retention Plan" -ClassificationPolicy ''
Removes the previously-applied classification policy so that classification no longer occurs.
Table: Set-EVRetentionPlan properties lists the properties that are available.
Table: Set-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 New-EVRetentionPlan.
See Get-EVSite.