Enterprise Vault™ PowerShell Cmdlet

Last Published:
Product(s): Enterprise Vault (15.0)
  1. Enterprise Vault PowerShell Cmdlet 简介
    1.  
      关于 Enterprise Vault Management Shell
    2.  
      获取 Enterprise Vault PowerShell cmdlet 的帮助
    3.  
      PowerShell 字符串规则
    4.  
      关于使用 Import-Csv cmdlet 时导入的布尔值
    5. 从何处获取有关 Enterprise Vault 的详细信息
      1.  
        Enterprise Vault 培训模块
  2. 归档:Exchange
    1.  
      Add-EVPstComputer
    2.  
      Add-EVPstFile
    3.  
      Get-EVExchangeMailboxPolicy
    4.  
      New-EVExchangeMailboxPolicy
    5.  
      Remove-EVExchangeFolderPolicy
    6.  
      Remove-EVExchangeMailboxPolicy
    7.  
      Set-EVExchangeMailboxPolicy
  3. 归档:FSA
    1.  
      Get-EVFSAComputerSettings
    2.  
      Get-EVFSAFileServer
    3.  
      Get-EVFSAFolder
    4.  
      Get-EVFSASiteSettings
    5.  
      Get-EVFSAVolume
    6.  
      New-EVFSAFileServer
    7.  
      New-EVFSAFolder
    8.  
      New-EVFSAVolume
    9.  
      Remove-EVFSAFileServer
    10.  
      Remove-EVFSAFolder
    11.  
      Remove-EVFSAVolume
    12.  
      Set-EVFSAComputerSettings
    13.  
      Set-EVFSAFileServer
    14.  
      Set-EVFSAFolder
    15.  
      Set-EVFSASiteSettings
    16.  
      Set-EVFSAVolume
  4. 归档:Skype for Business
    1.  
      Get-EVSkypeForBusinessTarget
    2.  
      New-EVSkypeForBusinessTarget
    3.  
      Remove-EVSkypeForBusinessTarget
    4.  
      Set-EVSkypeForBusinessTarget
  5. 归档:SMTP
    1.  
      Get-EVSMTPHoldingFolder
    2.  
      Get-EVSMTPMessageTrackingLogLocation
    3.  
      Get-EVSMTPPolicy
    4.  
      Get-EVSMTPServerSettings
    5.  
      Get-EVSMTPTarget
    6.  
      New-EVSMTPPolicy
    7.  
      New-EVSMTPServerSettings
    8.  
      New-EVSMTPTarget
    9.  
      Remove-EVSMTPPolicy
    10.  
      Remove-EVSMTPTarget
    11.  
      Set-EVSMTPMessageTrackingLogLocation
    12.  
      Set-EVSMTPPolicy
    13.  
      Set-EVSMTPServerSettings
    14.  
      Set-EVSMTPTarget
    15.  
      Sync-EVSMTPServerSettings
  6. 备份
    1.  
      Get-EVIndexSnapshotLocationBackupMode
    2.  
      Set-EVIndexSnapshotLocationBackupMode
    3.  
      Clear-EVIndexSnapshotLocationBackupMode
    4.  
      Get-IndexLocationBackupMode
    5.  
      Set-IndexLocationBackupMode
    6.  
      Clear-IndexLocationBackUpMode
    7.  
      Get-VaultStoreBackupMode
    8.  
      Set-VaultStoreBackupMode
    9.  
      Clear-VaultStoreBackupMode
    10.  
      Set-EVIndexSnapshotLocation
    11.  
      Get-EVIndexSnapshotLocation
    12.  
      Remove-EVIndexSnapshotLocation
    13.  
      New-EVIndexSnapshot
    14.  
      Get-EVIndexSnapshot
    15.  
      Remove-EVIndexSnapshot
    16.  
      Restore-EVIndexSnapshot
    17.  
      Get-EVIndexSnapshotRepository
    18.  
      Remove-EVIndexSnapshotRepository
    19.  
      Export-EVIndexData
    20.  
      Import-EVIndexData
  7. 分类
    1.  
      Disable-EVClassification
    2.  
      Get-EVClassificationFCITags
    3.  
      Get-EVClassificationPolicy
    4.  
      Get-EVClassificationStatus
    5.  
      Get-EVClassificationTestMode
    6.  
      Get-EVClassificationVICTags
    7.  
      Import-EVClassificationFCIRules
    8.  
      Initialize-EVClassificationVIC
    9.  
      Set-EVClassificationVICFIPSMode
    10.  
      New-EVClassificationPolicy
    11.  
      Publish-EVClassificationFCIRules
    12.  
      Remove-EVClassificationPolicy
    13.  
      Set-EVClassificationPolicy
    14.  
      Set-EVClassificationTestMode
  8. 数据库
    1.  
      Get-EVDatabase
    2.  
      Get-EVDatabaseDetail
    3.  
      Get-EVDatabaseFileInfo
    4.  
      Get-EVStorageDatabase
    5.  
      Set-EVDatabaseDetail
    6.  
      Start-EVDatabaseUpgrade
  9. IMAP 访问
    1.  
      Get-EVIMAPUsers
    2.  
      Get-EVIMAPUserSettings
    3.  
      Set-EVIMAPServerDisabled
    4.  
      Set-EVIMAPServerEnabled
  10. 索引
    1.  
      Get-EVIndexLocation
    2.  
      Get-EVMDSStatus
    3.  
      Get-IndexServerForIndexLocation
    4.  
      New-EVMDSBuildTask
    5.  
      Set-IndexMetadataSyncLevel
    6.  
      Submit-EVIndexingSubTask
    7.  
      Get-EVIndexVolume
    8.  
      Get-EVElasticsearchIndex
  11. 记录管理
    1.  
      Export-EVNARAArchive
    2.  
      Get-EVRecordSettings
  12. 保留计划
    1.  
      Get-EVRetentionPlan
    2.  
      New-EVRetentionPlan
    3.  
      Remove-EVRetentionPlan
    4.  
      Set-EVRetentionPlan
  13. 基于角色的管理
    1.  
      Add-EVRBARoleMember
    2.  
      Get-EVRBAAzStoreXml
    3.  
      Get-EVRBARole
    4.  
      Get-EVRBARoleMember
    5.  
      Remove-EVRBARoleMember
    6.  
      Set-EVRBAAzStoreXml
  14. 站点和服务器
    1.  
      Get-EVComputers
    2.  
      Get-EVFileLocation
    3.  
      Get-EVIISWebsite
    4.  
      Get-EVServer
    5.  
      Get-EVSite
    6.  
      Get-EVSiteInfo
    7.  
      Set-EVServiceAccountPassword
  15. 任务和服务
    1.  
      Get-EVDependencyService
    2.  
      Get-EVDependencyServiceState
    3.  
      Get-EVService
    4.  
      Get-EVServiceState
    5.  
      Get-EVTask
    6.  
      Get-EVTaskState
  16. 保管库存储和归档
    1.  
      Export-EVArchive
    2.  
      Get-EVArchive
    3.  
      Get-EVArchivePermission
    4.  
      Get-EVVaultStore
    5.  
      Get-EVVaultStorePartition
    6.  
      Remove-EVArchive
    7.  
      New-EVArchive
    8.  
      Remove-EVArchivePermission
    9.  
      Set-EVArchive
    10.  
      Set-EVArchivePermission
    11.  
      Start-PartitionRollover

Export-EVNARAArchive

Export-EVNARAArchive 仅从指定归档导出已由 Enterprise Vault 标记为永久记录的项目。可以将导出操作限制为位于指定日期范围内和/或与指定搜索条件匹配的记录。默认情况下,此 cmdlet 仅会导出以前未导出过的永久记录。但是,您可以选择导出以前已导出的记录以及新记录。

Export-EVNARAArchive 适用于您已选择要实施记录管理的 Capstone 方法的环境中使用。Capstone 的要求之一是定期将永久记录传输到美国国家档案馆。除了导出批量记录以外,Export-EVNARAArchive 还创建一个逗号分隔值 (.csv) 格式的负载文件,您可以将其与项目一起发送给国家档案馆。对于此 cmdlet 已成功导出的每个项目,该负载文件会提供以下信息:

  • 已导出项目的文件名。如果项目导出为 PST 格式,则负载文件会显示 PST 文件的名称。

  • 记录 ID。

  • 标题。如果为邮件,则为主题行;如果为其他项目,则为原始文件名。

  • 描述,派生自项目的索引内容。

    默认情况下,Enterprise Vault 会为每个项目的全部内容编制索引,并将前 128 个字符作为搜索结果中显示的预览字符串。这就是在负载文件中显示的字符串。但是,您可以在站点或归档级别配置索引设置,增加预览字符长度或切换为摘要索引,即不为项目内容编制索引。对这些设置的所有更改都将反映在该负载文件中显示的描述里。

  • 项目的创建人。

  • 项目的创建日期。

  • 如果将项目仅导出为 PST,则项目将位于 PST 文件夹结构中。

Export-EVNARAArchive 由管理单元 Symantec.EnterpriseVault.PowerShell.Snapin.dll 提供。

语法

Export-EVNARAArchive [-ArchiveId] <String> [-OutputDirectory] <String> [[-StartDate] <DateTime>] [[-EndDate] <DateTime>] [[-SearchString] [<String>]] [[-IncludePreviouslyExported] [<SwitchParameter>]] [[-Format] [<ExportFormat>]] [[-MaxThreads] [<Integer>]] [-MaxPSTSizeMB <Integer>] [-Confirm:<Boolean>] [<CommonParameters>]

参数

表:Export-EVNARAArchive 参数

参数

说明

-ArchiveId(必填)

指定要从中导出项目的归档的 ID。可以使用 Get-EVArchive 获取所需 ID。

-OutputDirectory(必填)

指定 cmdlet 应在其中放置所导出项目的文件夹的路径。键入绝对、相对或 UNC 路径(最多包含 200 个字符)。如果路径中包含空格字符,则使用引号将该路径引起来。

如果指定的文件夹不存在,该 cmdlet 会尝试进行创建。

-StartDate

指定日期范围的开始日期。此 cmdlet 仅会导出该日期范围内已收到的邮件或已创建的文件系统项目。指定的日期仅适用于顶层邮件,而不适用于所包含的任何附件。例如,如果指定一个涵盖整个 2015 年的日期范围,则此 cmdlet 将忽略已在 2016 年收到但包含在 2015 年创建的附件的邮件。

以 PowerShell 可识别的格式键入开始日期,如 mm/dd/yyyyyyyy-mm-ddmmddyyyyExport-EVNARAArchive 根据您所运行的计算机的区域设置转换诸如 04/03/2016 的日期。例如,通常会在“美国英语”计算机上将此日期转换为 2016 年 4 月 3 日,在“英国英语”计算机上将此日期转换为 2016 年 3 月 4 日。

此 cmdlet 会忽略附加到日期的任何时间,而是从指定日期的开始日期工作(如果是 EndDate,则为指定日期的结束日期)。

不需要同时指定开始日期和结束日期。

-EndDate

指定日期范围的结束日期。适用于此参数的要求与适用于 StartDate 的要求相同。

-SearchString

指定用于确定要导出的选定项目的搜索查询。将忽略与搜索条件匹配,但未由 Enterprise Vault 标记为永久记录的项目。同样,如果使用 StartDateEndDate 参数指定日期范围,该 cmdlet 首先会排除不在该范围内的任何项目,然后查找与搜索查询匹配的项目。

可以使用与您在 Enterprise Vault Search 中查找特定项目时所使用查询语法相同的查询语法。例如,搜索查询 "to:mike_smith" 仅会为导出程序选择已发送给此收件人的项目。如果其中包含空格字符,则使用引号将该查询引起来。

有关查询语法的详细信息,请参见 Enterprise Vault Search 的联机帮助。

-IncludePreviouslyExported

如果已指定,将导致此导出运行过程包括在之前运行中已导出的记录,以及之前未导出的记录。

-Format

指定导出的项目所采用的格式。可能的值包括 EMLNATIVEPST,其中 EML 为默认值。要导出为 PST,必须在本地服务器以及托管指定归档的 Enterprise Vault Storage Service 的服务器上安装 Microsoft Outlook 并将其设置为默认电子邮件客户端。

NATIVE 值指示 cmdlet 以其原始格式导出每个项目:MSG 代表 Microsoft Exchange 项目、EML 代表 SMTP 项目、TXT 代表文本文件等。

使用 PST 值时,此 cmdlet 会将项目先导出为 MSG 文件,然后再将其收集在 PST 文件中。PST 文件中的文件夹结构与源归档的文件夹结构匹配。当发生下列情况之一时,cmdlet 会自动创建其他 PST 文件来托管所有已导出项目:

  • PST 文件中的项目数达到 100,000。

  • PST 文件的大小达到 -MaxPSTSizeMB 参数指定的限制。

如果项目大于 250 MB,则 cmdlet 会将其作为一个独立的 EML 文件导出,放置在 PST 文件旁边,而非先将该项目作为 MSG 文件导出,然后再将其收集在 PST 文件中。

-MaxThreads

指定要用于导出过程的最大线程数。键入一个介于 1 到 100 之间的值。默认值是 16。

减少线程数有助于最大限度地降低 Enterprise Vault 服务器资源的负载。或者,在分布式或高规范 Enterprise Vault 环境中,通过增大线程数可提高吞吐量。

-MaxPSTSizeMB

如果将项目仅导出为 PST,请为每个 PST 文件指定最大大小 (MB)。在 PST 文件达到此限制后,此 cmdlet 将为剩余项目自动创建新的 PST 文件。键入一个介于 500 到 51200 之间的值。默认值是 20480 (20 GB)。

-Confirm

指定 cmdlet 在检测到指定归档具有 32 位索引卷时是否需要确认之后再继续运行。默认情况下,cmdlet 检测到此类归档时会暂停,您必须确认是否要继续。可以精确使用语法 -Confirm:$false(必须使用冒号)来取消确认提示信息。

示例
  • Export-EVNARAArchive -ArchiveId 19D...EVServer1 -OutputDirectory c:\Temp

    从指定归档将所有永久记录导出到输出文件夹 c:\Temp

  • Export-EVNARAArchive -ArchiveId 19D...EVServer1 -OutputDirectory "c:\Exported Items" -StartDate 01/01/2010 -EndDate 02/02/2015

    将导出操作限制为位于 01/01/2010 和 02/02/2015 的日期范围内的永久记录。

  • Export-EVNARAArchive -ArchiveId 19D...EVServer1 -OutputDirectory "c:\Exported Items" -StartDate 01/01/2016

    将导出操作限制为位于 01/01/2016 和今天的日期范围内的永久记录。

  • Export-EVNARAArchive -ArchiveId 19D...EVServer1 -OutputDirectory "c:\Exported Items" -SearchString "to:mike_smith"

    仅导出已发送给 Mike Smith 的永久记录。

  • Export-EVNARAArchive -ArchiveId 19D...EVServer1 -OutputDirectory c:\Temp -IncludePreviouslyExported

    导出之前已导出的永久记录以及新建的永久记录。

  • Export-EVNARAArchive -ArchiveId 19D...EVServer1 -OutputDirectory c:\Temp -Format PST -MaxPSTSizeMB 51200

    将所有永久记录导出到一个或多个 PST 文件,每个文件最大可以为 50 GB。

  • Export-EVNARAArchive -ArchiveId 19D...EVServer1 -OutputDirectory c:\Temp -MaxThreads 100

    将 100 个线程分配给用于从指定归档导出所有永久记录的进程。

  • "19D...EVServer1","18F...EVServer2","14C...EVServer3" | Export-EVNARAArchive -OutputDirectory "c:\Exported Items"

    传递要从中导出所有永久记录的三个归档的 ID。

输出

完成时会出现确认消息。此外,cmdlet 会创建以下文件:

  • 一个逗号分隔值 (.csv) 格式的负载文件。

  • 一个名为 ExportReport_datetime.txt 的报告文件,例如 ExportReport_20160311125651.txt。该文件将显示已导出项目数并标识 cmdlet 未能导出的任何项目。如果导出由于某些原因完全失败,则该报告会指出可能的原因。

相关的 cmdlet