Veritas Enterprise Vault™ Classification using the Veritas Information Classifier
- About this guide
- Preparing Enterprise Vault for classification
- Setting up Veritas Information Classifier policies
- Defining and applying Enterprise Vault classification policies
- About Enterprise Vault classification policies
- Defining classification policies
- About the PowerShell cmdlets for working with classification policies
- Associating classification policies with retention plans
- About the PowerShell cmdlets for working with retention plans
- Applying retention plans to your Enterprise Vault archives
- Running classification in test mode
- Appendix A. Enterprise Vault properties for use in custom field searches
- About the Enterprise Vault properties
- System properties
- Attachment properties
- Custom Enterprise Vault properties
- Custom Enterprise Vault properties for File System Archiving items
- Custom Enterprise Vault properties for SharePoint items
- Custom Enterprise Vault properties for Compliance Accelerator-processed items
- Custom properties for use by policy management software
- Custom properties for Enterprise Vault SMTP Archiving
- Appendix B. PowerShell cmdlets for use with classification
- About the classification cmdlets
- Disable-EVClassification
- Get-EVClassificationPolicy
- Get-EVClassificationStatus
- Get-EVClassificationTestMode
- Get-EVClassificationVICTags
- Initialize-EVClassificationVIC
- New-EVClassificationPolicy
- Remove-EVClassificationPolicy
- Set-EVClassificationPolicy
- Set-EVClassificationTestMode
- Appendix C. Classification cache folder
- Appendix D. Migrating from FCI classification to the Veritas Information Classifier
- Appendix E. Monitoring and troubleshooting
Set-EVClassificationPolicy
Set-EVClassificationPolicy sets or updates the properties of an existing Enterprise Vault 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 site for which to set or update the Enterprise Vault 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 Enterprise Vault 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 Enterprise Vault 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 perform actions that could potentially update these retention categories. For example, users may move archived items between folders to which you have applied different retention categories, or change the retention categories of items in Enterprise Vault Search, if permitted. Both actions can cause the retention categories of the items to change, potentially overriding the retention categories that the classification feature has set. The default for PreventRCDuringMove is $false. Enterprise Vault allows user actions to update the retention categories of 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 (prevent user actions from updating retention categories), AllowRCOnRecTypeChange specifies whether to allow these updates in instances where this also causes the record types of the items to change. 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 Enterprise Vault 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 Enterprise Vault classification policy to prevent user actions from updating the retention categories of items, including when this will change their record type, in those archives to which you apply the policy.
There is a confirmation message on completion.