Enterprise Vault™ PowerShell Cmdlets
- Introducing the Enterprise Vault PowerShell cmdlets
- Archiving: Exchange
- Archiving: FSA
- Archiving: Skype for Business
- Archiving: SMTP
- Backup
- Classification
- Databases
- IMAP access
- Indexing
- Records management
- Retention plans
- Roles-based administration
- Sites and servers
- Tasks and services
- Vault stores and archives
Set-EVClassificationPolicy
Set-EVClassificationPolicy sets or updates the properties of an existing Enterprise Vault classification policy.
Set-EVClassificationPolicy is provided by the snap-in Symantec.EnterpriseVault.PowerShell.AdminAPI.dll
.
Set-EVClassificationPolicy [[-SiteId] <String>] [-Name] <String> [-Description <String>] [-DuringArchivingIndexing <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. |
-DuringArchivingIndexing | Specifies whether Enterprise Vault should classify items during archiving/indexing ($true) or not ($false). The default is $true. This setting also determines whether Enterprise Vault reclassifies items when you rebuild the indexes. Note that if you have chosen to archive classified items to smart partitions, reclassifying the items does not cause them to move from one smart partition to another. These items remain on the smart partition to which Enterprise Vault originally archived them. For example, suppose that you have associated the classification tag "PII" with one smart partition and the tag "Credit-Card" with another smart partition. An item that Enterprise Vault archived to the partition that is associated with the "PII" tag remains on this partition, even if Enterprise Vault subsequently reclassifies the item with the "Credit-Card" tag. |
-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.