Search <book_title>...

Enterprise Vault™ PowerShell Cmdlet

Last Published: 2024-03-04

Product(s): Enterprise Vault (15.0)

Set-EVRetentionPlan

Set-EVRetentionPlan 设置或更新现有保留计划的属性，例如其说明和关联的保留类别、分类策略以及保留文件夹。

如果更改任何保留计划设置，必须运行相应配置任务或重新启动相应归档任务以将更改应用于目标归档。例如，如果已将保留计划与 SMTP 目标归档关联，则必须重新启动 SMTP 归档任务。在 Exchange 环境中，必须重新启动 Exchange 邮箱归档任务并同步邮箱。

Set-EVRetentionPlan 由管理单元 Symantec.EnterpriseVault.PowerShell.AdminAPI.dll 提供。

语法

Set-EVRetentionPlan -SiteId <String> -Name <String> [-Description <String>] [-RetentionCategory <String>] [-OverrideRetention [<SwitchParameter>]] [-ClassificationPolicy <String>] [-FolderXmlPath <String>] [-DisableStorageExpiry [<SwitchParameter>]] [<CommonParameters>]

Set-EVRetentionPlan -SiteId <String> -Name <String> [-Description <String>] [-RetentionCategory <String>] [-OverrideRetention [<SwitchParameter>]] [-ClassificationPolicy <String>] [-FolderXml <String>] [-DisableStorageExpiry [<SwitchParameter>]] [<CommonParameters>]

参数

表：Set-EVRetentionPlan 参数

参数	说明
-SiteId（必填）	要为其设置或更新保留计划详细信息的 Enterprise Vault 站点的 ID。如果省略此参数，则 cmdlet 将无法通过查找注册表来确定 ID，因此 Set-EVRetentionPlan 随后会提示您输入所需的 ID。您可以使用 Get-EVSite 获取站点 ID。
-Name（必填）	要设置或更新其属性的特定保留计划的名称。
-Description	设置保留计划的描述。说明最多可以包含 127 个字母数字、空格或特殊字符。
-RetentionCategory	要与保留计划关联的保留类别的名称。
-OverrideRetention	添加此参数以使用与此计划关联的保留类别覆盖受影响项目的当前保留类别。注意: 如果您还将此计划与允许分类规则更新项目保留类别的分类策略相关联，则省略此参数。在这种情况下，Enterprise Vault 会根据此分类规则对项目应用的保留类别使项目过期。
-ClassificationPolicy	要将其与保留计划关联起来的分类策略的名称。如果指定此设置，Enterprise Vault 会发送所有包含此保留计划的归档项目以进行分类并根据分类策略中指定的规则对其进行标记。注意: 如果已为 Enterprise Vault 保留功能安装许可证，或现有许可证已过期，则会在测试模式下进行分类。分类功能不会对已归档项目应用分类标志及其他更改，而是生成报告列出计划更改。
-FolderXmlPath	定义一个或多个保留文件夹的属性的 XML 文件的路径。您可以创建新的保留文件夹并更新或删除现有保留文件夹。有关保留文件夹的详细信息以及如何准备所需 XML 文件的指南，请参见“管理指南”。 Enterprise Vault 附带了一个示例 XML 文件 `RetentionFoldersSample.xml`，您可以根据需要复制和修改该文件。该文件位于 Enterprise Vault 安装文件夹（例如，`C:\Program Files (x86) \Enterprise Vault\Modules\EnterpriseVault`）的 `Modules\EnterpriseVault` 子文件夹中。如果您已将此保留计划与允许分类功能更新单个项目的保留类别的分类策略相关联，则保留文件夹必须有 Item（而非 Folder）的 Expiry 设置。键入绝对、相对或 UNC 路径，然后将其括在引号中（如果包含空格字符）。
-FolderXml	此参数的功能与 -FolderXmlPath 参数相同。但是，在这种情况下，您在附加到此参数的 XML 字符串中定义保留文件夹属性，而不是在外部文件中定义。您可以创建新的保留文件夹并更新或删除现有保留文件夹。反引号字符 (`) 用于转义此字符串中的引号。
-DisableStorageExpiry	添加此参数以“在具有保留文件夹问题的任何归档中禁用存储过期”。

示例

Set-EVRetentionPlan -SiteId 13E...localdomain.com -Name "Projects Retention Plan" -Description "Plan created for managing projects" -RetentionCategory "5 years"
在指定的 Enterprise Vault 站点中更新现有保留计划“项目保留计划”的属性。该计划的描述为“为管理项目创建的计划”，保留类别为“5 年”。
Set-EVRetentionPlan -Name "Projects Retention Plan" -ClassificationPolicy CP
更新指定保留计划的分类策略属性。
Set-EVRetentionPlan -Name "Projects Retention Plan" -ClassificationPolicy CP -OverrideRetention
为指定的保留计划设置替代保留标志。项目手动删除或自动过期后，在计划中设置的保留类别将替代其当前的保留类别。但是，如果分类策略允许分类更新单个项目的保留类别，则有必要省略 -OverrideRetention 参数。Enterprise Vault 会根据分类规则应用于项目的保留类别使项目过期。
Set-EVRetentionPlan -SiteId 13E9...localdomain.com -Name "Projects Retention Plan" -Description "Plan updated for managing projects" -RetentionCategory "6 years" -OverrideRetention -ClassificationPolicy CP2
在指定的 Enterprise Vault 站点中更新名为“项目保留计划”的现有保留计划的属性。该计划的描述为“为管理项目更新的计划”，保留类别为“6 年”。
Set-EVRetentionPlan -SiteId 13E...localdomain.com -Name "Projects Retention Plan" -ClassificationPolicy ''
删除先前应用的分类策略，以便不再执行分类。

Set-EVRetentionPlan -Name "Projects Retention Plan" -FolderXmlPath c:\RetentionFolders.xml -DisableStorageExpiry

将在文件 c:\RetentionFolders.xml 中定义的保留文件夹更改应用到保留计划 Projects Retention Plan 中。此命令还会在任何具有保留文件夹问题的归档中禁用“存储过期”。

例如，假设您最初使用下列 XML 定义保留文件夹设置：

<?xml version="1.0" encoding="utf-16"?>
<RetentionFolderRoot>
  <RetentionFolder Name="Inbox" RetentionCategory="1 Year"
    Expiry="Item" Inheritance="ThisFolderOnly" />
  <RetentionFolder Name="Business" RetentionCategory="5 Years"
    Expiry="Item" Inheritance="ThisFolderOnly" />
</RetentionFolderRoot>

要删除 Inbox 文件夹，请将 Business 文件夹的保留类别更改为 1 Year，并创建新文件夹 Unit，将其作为 Business 文件夹的子文件夹，将下列内容保存为 c:\RetentionFolders.xml，然后使用上述命令进行提交：

<?xml version="1.0" encoding="utf-16"?>
<RetentionFolderRoot>
  <RetentionFolder Name="Business" RetentionCategory="1 Year"
    Expiry="Item" Inheritance="ThisFolderOnly">
    <RetentionFolder Name="Unit" RetentionCategory="5 Years"
      Expiry="Item" Inheritance="ThisFolderAndAllSubfolders" />
  </RetentionFolder>
</RetentionFolderRoot>

您可以使用以下命令返回该计划的保留文件夹信息：

Get-EVRetentionPlan -Name "New Projects Plan" | select -expand Folders | sort FolderPath | ft -AutoSize

此命令会生成以下输出：

FolderPath       FolderName   RetentionCategory   Expiry                Inheritance
----------       ----------   -----------------   ------                -----------
\Business        Business     1 year              Item               ThisFolderOnly
\Business\Unit   Unit         5 years             Item   ThisFolderAndAllSubfolders

Set-EVRetentionPlan -Name "Projects Retention Plan" -FolderXml "<?xml version=`"1.0`" encoding=`"utf-16`"?><RetentionFolderRoot><RetentionFolder Name=`"Business`" RetentionCategory=`"1 Year`" Expiry=`"Item`" Inheritance=`"ThisFolderOnly`"><RetentionFolder Name=`"Unit`" RetentionCategory=`"5 Years`" Expiry=`"Item`" Inheritance=`"ThisFolderAndAllSubfolders`" /></RetentionFolder></RetentionFolderRoot>" -DisableStorageExpiry
执行与上例中的命令相同的功能。但是，现在会在附加到此命令的 XML 字符串中定义保留文件夹更改，而不是在 XML 文件中定义。
Set-EVRetentionPlan -Name "New Projects Plan" -FolderXmlPath C:\RetentionFolders.xml
将在文件 c:\RetentionFolders.xml 中定义的保留文件夹更改应用到保留计划 Projects Retention Plan 中。您可以使用此命令为以前创建的保留文件夹提供其他语言的备用名称。例如，假设您最初使用下列 XML 定义保留文件夹设置：
```
<?xml version="1.0" encoding="utf-16"?>
<RetentionFolderRoot>
	<RetentionFolder Name="Business" RetentionCategory="1 Year"
		Expiry="Item" Inheritance="ThisFolderOnly" />
	<RetentionFolder Name="Unit" RetentionCategory="5 Years"
		Expiry="Item" Inheritance="ThisFolderOnly" />
</RetentionFolderRoot>
```
将以下内容保存为 C:\RetentionFolders.xml，然后使用以上命令进行提交，便可以提供适用于丹麦语用户的备用文件夹名称：
```
<?xml version="1.0" encoding="utf-16"?>
<RetentionFolderRoot>
  <Languages>
    <Language>DA-DK</Language>
  </Languages>
  <RetentionFolder Name="Business" RetentionCategory="1 Year"
    Expiry="Item" Inheritance="ThisFolderOnly">
    <Name lang="DA-DK">Forretning</Name>
  </RetentionFolder>
  <RetentionFolder Name="Unit" RetentionCategory="5 Years"
    Expiry="Item" Inheritance="ThisFolderOnly">
    <Name lang="DA-DK">Enhed</Name>
  </RetentionFolder>
</RetentionFolderRoot>
```
<Languages> 节点指定了提供备用文件夹名称时要使用的语言（在此示例中，使用 DA-DK 表示丹麦语）。在每个 <RetentionFolder> 节点内，输入备用文件夹名称（针对 Business 输入 Forretning，针对 Unit 输入 Enhed）。
有关为保留文件夹提供多语言备用名称的详细信息，请参见“管理指南”。

输出

表：Set-EVRetentionPlan 属性会列出可用的属性。

表：Set-EVRetentionPlan 属性

名称	类型	说明
Name	字符串	保留计划的名称。
Description	字符串	保留计划的描述。
RetentionCategory	字符串	与保留计划关联的保留类别的名称。
OverrideRetention	SwitchParameter	您是否已为此保留计划指定替代保留标志。
ClassificationPolicy	字符串	与保留计划关联的分类策略的名称。
HasFolders	布尔值	该保留计划是否定义任何保留文件夹。如果为 true，则 Folders 和 FolderXml 属性包含有关保留文件夹的信息。 Folders 属性包含表格文本形式的信息，可以使用 Format-Table 设置文本格式。 FolderXml 属性包含 XML 形式的信息，可以将其输出到文件。
DisableStorageExpiry	SwitchParameter	是否已选择“在具有保留文件夹问题的任何归档中禁用存储过期”。