Search <book_title>...

Enterprise Vault™ PowerShell Cmdlet

Last Published: 2023-03-05

Product(s): Enterprise Vault (14.4)

New-EVRetentionPlan

New-EVRetentionPlan 会为 Enterprise Vault 站点创建保留计划。

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

语法

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

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

参数

表：New-EVRetentionPlan 参数

参数	说明
-SiteId（必填）	要为其创建保留计划的 Enterprise Vault 站点的 ID。如果省略此参数，则 cmdlet 将无法通过查找注册表来确定 ID，因此 New-EVRetentionPlan 随后会提示您输入所需的 ID。您可以使用 Get-EVSite 获取站点 ID。
-Name（必填）	保留计划的名称。名称必须唯一，而且最多可以包含 40 个字母数字或空格字符。
-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	添加此参数以“在具有保留文件夹问题的任何归档中禁用存储过期”。

示例

New-EVRetentionPlan -SiteId 13E...localdomain.com -Name "Projects Retention Plan" -Description "Plan created for managing projects" -RetentionCategory "5 years"
在指定的 Enterprise Vault 站点中创建名为“项目保留计划”的保留计划。新计划的描述为“为管理项目创建的计划”，保留类别为“5 年”。
New-EVRetentionPlan -Name "Projects Retention Plan" -Description "Plan created for managing projects" -RetentionCategory "5 years" -OverrideRetention -ClassificationPolicy "Managers CP"
使用指定的描述和保留类别创建保留计划。由于未指定站点 ID，cmdlet 会首先在注册表中查找站点 ID，如果找不到，则会提示您输入。
当手动删除了项目或项目自动过期时，5 years 保留类别会覆盖项目当前的保留类别。但是，如果 Managers CP 分类策略允许分类更新单个项目的保留类别，则有必要省略 -OverrideRetention 参数。Enterprise Vault 会根据分类规则应用于项目的保留类别使项目过期。
Get-EVRetentionPlan -Name "Existing Retention Plan" | New-EVRetentionPlan -Name "New Retention Plan" -RetentionCategory "1 year"
将现有保留计划的所有设置传递到新的保留计划。新计划的保留类别为 1 year，而非您为现有计划设置的保留类别。
New-EVRetentionPlan -Name "Projects Retention Plan" -Description "Plan for adding retention folders" -RetentionCategory "5 years" -FolderXmlPath "c:\My XML Files\folders.xml" -DisableStorageExpiry
所创建保留计划中的指定 XML 文件 folders.xml 将定义一个或多个保留文件夹的属性。您在 XML 文件中针对这些文件夹定义的保留设置会覆盖与该计划关联的“5 years”保留类别。此命令还会在任何具有保留文件夹问题的归档中禁用“存储过期”。
New-EVRetentionPlan -Name "Projects Retention Plan" -Description "Plan for New Projects" -RetentionCategory "5 years" -FolderXml "<?xml version=`"1.0`" encoding=`"utf-16`"?><RetentionFolderRoot><RetentionFolder Name=`"Documents`" RetentionCategory=`"5 years`" Expiry=`"Folder`" Inheritance=`"ThisFolderAndAllSubfolders`"/></RetentionFolder></RetentionFolderRoot>"
创建具有指定的名称、说明和保留类别的保留计划，并且将其与保留文件夹 Documents 相关联。您可以使用以下命令返回该计划的保留文件夹信息：
Get-EVRetentionPlan -Name "Projects Retention Plan" | select -expand Folders | sort FolderPath | ft -AutoSize
此命令会生成以下输出：
```
FolderPath    FolderName    RetentionCategory    Expiry                   Inheritance
----------    ----------    -----------------    ------                   -----------
\Documents    Documents     5 years              Folder    ThisFolderAndAllSubfolders
```
New-EVRetentionPlan -Name "New Projects Plan" -Description "Plan for New Projects" -RetentionCategory "5 years" -FolderXml "<?xml version=`"1.0`" encoding=`"utf-16`"?><RetentionFolderRoot><Languages><Language>da-DK</Language><Language>zh-cn</Language></Languages><RetentionFolder Name=`"Documents`" RetentionCategory=`"5 years`" Expiry=`"Folder`" Inheritance=`"ThisFolderAndAllSubfolders`"><Name lang="da-DK">Dokumenter</Name><Name lang="Zh-CN">文件</Name></RetentionFolder></RetentionFolderRoot>"
执行与上述示例中的命令相同的功能，另外也为常用丹麦语或简体中文的用户提供该保留文件夹名称的语言变体。

输出

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

表：New-EVRetentionPlan 属性

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