Search <book_title>...

Enterprise Vault™ PowerShell Cmdlet

Last Published: 2023-03-05

Product(s): Enterprise Vault (14.4)

Get-EVRetentionPlan

Get-EVRetentionPlan 会返回在 Enterprise Vault 站点中配置的所有保留计划的列表。您可以按描述、保留类别、替代保留标志和分类策略筛选返回的保留计划列表。

您还可以返回特定保留计划的属性以及在该计划中定义的任何保留文件夹信息。有关保留文件夹的详细信息，请参见“管理指南”。

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

语法

Get-EVRetentionPlan [-SiteId <String>] [-Name <String>] [-Description <String>] [-RetentionCategory <String>] [-OverrideRetention [<SwitchParameter>]] [-ClassificationPolicy <String>] [<CommonParameters>]

参数

表：Get-EVRetentionPlan 参数

参数	说明
-SiteId	要为其返回保留计划详细信息的 Enterprise Vault 站点的 ID。如果忽略此参数，则 cmdlet 将无法通过查找注册表来确定 ID，因此 Get-EVRetentionPlan 随后会提示您输入所需的 ID。您可以使用 Get-EVSite 获取站点 ID。
-Name	要返回其属性的特定保留计划的名称。
-Description	要根据其筛选返回的计划列表的保留计划描述。
-RetentionCategory	要根据其筛选返回的保留计划列表的保留类别的名称。
-OverrideRetention	如果指定此设置，则仅返回已为其设置替代保留标志的保留计划。此标志指示 Enterprise Vault 根据在保留计划中设置的保留类别使每个项目过期。此保留类别会替代项目各自的保留类别。
-ClassificationPolicy	用于筛选返回的保留计划列表的分类策略名称。

示例

Get-EVRetentionPlan
返回在 Enterprise Vault 站点中配置的所有保留计划的列表。由于未指定站点 ID，cmdlet 会首先在注册表中查找站点 ID，如果找不到，则会提示您输入。
Get-EVRetentionPlan -SiteId 13E...localdomain.com
返回在指定的 Enterprise Vault 站点中配置的所有保留计划的列表。
Get-EVRetentionPlan -SiteId 13E...localdomain.com -Name ManagersPlan
返回名为“ManagersPlan”的保留计划的属性。
Get-EVRetentionPlan -SiteId 13E...localdomain.com -Description RetentionPlanForManagers
将返回的保留计划列表限制为具有“RetentionPlanForManagers”描述的保留计划。
Get-EVRetentionPlan -SiteId 13E...localdomain.com -RetentionCategory 3years
将返回的保留计划列表限制为“3 年”保留类别的保留计划。
Get-EVRetentionPlan -OverrideRetention
将返回的保留计划列表限制为已为其设置替代保留标志的保留计划。
Get-EVRetentionPlan -ClassificationPolicy "Managers CP"
将返回的保留计划列表限制为具有“Managers CP”分类策略名称的保留计划。
Get-EVRetentionPlan -ClassificationPolicy ""
将返回的保留计划列表限制为尚未指定分类策略的计划。

Get-EVRetentionPlan -Name "ManagersPlan" |select -expand Folders | Format-Table

返回在 ManagersPlan 保留计划中定义的保留文件夹信息。例如：

FolderPath     FolderName RetentionCategory Expiry                Inheritance Language
----------     ---------- ----------------- ------                ----------- --------
\Business      Business   2-year            Folder ThisFolderAndAllSubfolders       en
\Business\2018 2018       5-year              Item ThisFolderAndAllSubfolders       en
\Business\2020 2020       2-year            Folder ThisFolderAndAllSubfolders       en
\Inbox         Inbox      1-year              Item             ThisFolderOnly       en
\Inbox\Finance Finance    2-year            Folder ThisFolderAndAllSubfolders       en
\Inbox\Legal   Legal      5-year              Item             ThisFolderOnly       en

此保留计划的 OverrideRetention 和 ClassificationPolicy 设置确定“过期”值是否有效。

Get-EVRetentionPlan -Name "ManagersPlanWithAlternateLanguage" |select -expand Folders | Format-Table

返回“ManagersPlanWithAlternateLanguage”保留计划中定义的保留文件夹信息。例如：

FolderPath          FolderName RetentionCategory Expiry                Inheritance Language
----------          ---------- ----------------- ------                ----------- ---------
\Business           Business   2-year            Folder ThisFolderAndAllSubfolders        en
\Forretning         Forretning 2-year            Folder ThisFolderAndAllSubfolders     da-DK
\Business\Legal     Legal      5-year              Item ThisFolderAndAllSubfolders        en
\Forretning\Gyldige Gyldige    5-year              Item ThisFolderAndAllSubfolders     da-DK

已使用备用文件夹名称创建此保留计划（丹麦语 (da-DK)）。这种情况下，默认语言为英语 (en)。

Get-EVRetentionPlan -Name "ManagersPlan" |select -expand FolderXml
采用 XML 格式返回 ManagersPlan 保留计划的保留文件夹信息。
Get-EVRetentionPlan -Name "ManagersPlan" |select -expand FolderXml | Out-File c:\retention_plan_folders.xml
将 ManagersPlan 保留计划的保留文件夹信息导出到文件 c:\retention_plan_folders.xml。您可以编辑此文件，然后使用 Set-EVRetentionPlan cmdlet 重新提交保留文件夹信息。

输出

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

表：Get-EVRetentionPlan 属性

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

如果没有可用的保留计划，或者该 cmdlet 找不到与指定条件匹配的任何计划，则会输出相应的错误消息。