Veritas Enterprise Vault™ PowerShell Cmdlets
New-EVClassificationPolicy
New-EVClassificationPolicy creates a classification policy for an Enterprise Vault site.
New-EVClassificationPolicy is provided by Symantec.EnterpriseVault.PowerShell.AdminAPI.dll, which is loaded by the Enterprise Vault Management Shell.
New-EVClassificationPolicy [[-SiteId] <String>] [-Name] <String> [-Description <string>] [-DuringIndexing <Boolean>] [-DetermineRC <Boolean>] [-RCDuringDeletion <Boolean>] [-RCDuringExpiry <Boolean>] [-PreventRCDuringMove <Boolean>] [-AllowRCOnRecTypeChange <Boolean>] [<CommonParameters>]
Table: New-EVClassificationPolicy parameters
Parameter | Description |
|---|---|
-SiteId | The ID of the Enterprise Vault site for which to create the classification policy. If you omit this parameter, and the cmdlet cannot determine the ID by looking in the registry, then New-EVClassificationPolicy prompts you to enter the required ID. You can use Get-EVSite to obtain the site ID. |
-Name (required) | The name of the classification policy. The 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. |
New-EVClassificationPolicy -SiteId 13E...EV.example.com -Name "Classification policy" -Description "Classification policy created using PowerShell"
Creates a classification policy that is named "Classification policy" in the specified Enterprise Vault site. The new policy has the description "Classification policy created using PowerShell".
New-EVClassificationPolicy -Name "Classification policy" -DuringIndexing $true -DetermineRC $false
Creates a classification policy that is named "Classification policy". This policy does classify items during indexing but does not use classification to determine their retention categories.
New-EVClassificationPolicy -Name "Classification policy" -PreventRCDuringMove $true
Creates a classification policy to classify items during indexing and allow the classification feature to update the retention categories of items. This policy prevents Enterprise Vault from updating the retention categories of moved items in those archives to which you apply the classification policy, except when this will change the record type of the items.
This cmdlet returns an object of type Symantec.EnterpriseVault.Admin.ClassificationPolicy, which has the following properties.
Table: New-EVClassificationPolicy properties
Name | Type | Description |
|---|---|---|
Name | String | The name of the classification policy. |
EntryId | String | The directory entry ID of the classification policy. |
IsADefaultPolicy | Boolean | Whether the classification policy is a default policy. |
DuringIndexing | Boolean | Whether to classify items during indexing, and reclassify them during an index rebuild. |
DetermineRC | Boolean | Whether classification is used to determine the retention category. |
RCDuringDeletion | Boolean | Whether items are classified during user deletion. |
RCDuringExpiry | Boolean | Whether items are classified during automatic expiry. |
PreventRCDuringMove | Boolean | 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. |
AllowRCOnRecTypeChange | Boolean | Whether to allow retention category updates for moved items when this will change their record type (for example, from Temporary to Permanent). |
Description | String | The description of the classification policy. |
SiteId | String | The site ID to which the classification policy belongs. |
Identity | Number | The identity number of the classification policy. |