Veritas Enterprise Vault™ PowerShell Cmdlets
Set-EVClassificationPolicy
Set-EVClassificationPolicy sets or updates the properties of an existing classification policy.
Set-EVClassificationPolicy is provided by Symantec.EnterpriseVault.PowerShell.AdminAPI.dll, which is loaded by the Enterprise Vault Management Shell.
Set-EVClassificationPolicy [[-SiteId] <String>] [-Name] <String> [-Description <string>] [-DuringIndexing <Boolean>] [-DetermineRC <Boolean>] [-RCDuringDeletion <Boolean>] [-RCDuringExpiry <Boolean>] [-PreventRCDuringMove <Boolean>] [-AllowRCOnRecTypeChange <Boolean>] [<CommonParameters>]
Table: Set-EVClassificationPolicy parameters
Parameter | Description |
|---|---|
-SiteId | The ID of the Enterprise Vault site for which to set or update the classification policy details. If you omit this parameter, and the cmdlet cannot determine the ID by looking in the registry, then Set-EVClassificationPolicy prompts you to enter the required ID. You can use Get-EVSite to obtain the site ID. |
-Name (required) | The name of a specific classification policy whose properties you want to set or update. If you want to rename the policy then the new name must be unique, and it can contain up to 40 alphanumeric or space characters. |
-Description | The description to set for the classification policy. The description can contain up to 127 alphanumeric, space, or special characters. |
-DuringIndexing | Specifies whether Enterprise Vault should classify items at the point that it indexes them ($true) or not ($false). The default is $true. This setting also determines whether Enterprise Vault reclassifies items when you rebuild the indexes. |
-DetermineRC | Specifies whether to allow the classification feature to update the retention categories of items ($true) or not ($false). The default is $true. |
-RCDuringDeletion | When DetermineRC is $true, specifies whether to enable classification on user deletion ($true) or not ($false). The default is $false. You cannot set RCDuringDeletion to $true when DetermineRC is set to $false. |
-RCDuringExpiry | When DetermineRC is $true, specifies whether to enable classification on automatic expiry ($true) or not ($false). The default is $false. Note the following:
|
-PreventRCDuringMove | When DetermineRC is $true, specifies whether to prevent Enterprise Vault from updating the retention categories of archived items when users move the items from one folder to another folder that has a different retention category. The default for PreventRCDuringMove is $false. Enterprise Vault can update the retention categories of moved items, subject to site archive settings. |
-AllowRCOnRecTypeChange | For use in environments where you use the Enterprise Vault records management feature to mark selected items as records. When PreventRCDuringMove is $true (do not allow retention category updates for moved items), AllowRCOnRecTypeChange specifies whether to allow these updates in instances where moving the items will change their record type. The default for AllowRCOnRecTypeChange is $true. When PreventRCDuringMove is $false, AllowRCOnRecTypeChange has no effect. |
Set-EVClassificationPolicy -SiteId 13E...EV.example.com -Name "Classification policy" -Description "Classification example policy"
Updates the description of an existing classification policy that is named "Classification policy" in the specified Enterprise Vault site.
Set-EVClassificationPolicy -SiteId 13E...EV.example.com -Name "Classification policy" -PreventRCDuringMove $true -AllowRCOnRecTypeChange $false
Configures the specified classification policy to prevent Enterprise Vault from updating the retention categories of moved items, including when this will change the record type of the items, in those archives to which you apply the policy.
There is a confirmation message on completion.