Enterprise Vault™ PowerShell Cmdlet

Last Published:
Product(s): Enterprise Vault (14.4)
  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
  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
  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

Submit-EVIndexingSubTask

Submit-EVIndexingSubTask cmdlet 会提交新的索引相关子任务,如使用 Type 参数指定的 Rebuild、Synchronize、Verify 和 Upgrade。

表:子任务类型和用法

子任务类型

用法

Rebuild

完整地重建索引卷。如有必要,它还可将 32 位和 64 位索引卷升级到 Elasticsearch。旧的索引卷在重建期间保持为可搜索的,以避免对用户产生任何影响。

Synchronize

同步索引卷并修复已知问题。“同步”任务会尝试为先前未编制索引且在索引卷浏览器中报告为缺失项目的项目编制索引。

Verify

检查索引卷是否可访问且运行良好。验证级别可分为 Complete 验证或 Basic 验证。Basic 验证会检查索引卷中是否存在严重问题。Complete 验证会检查是否存在严重问题,并且还会运行项目级的验证,以检查是否存在已编制索引但未在归档中的项目,以及已归档但未编制索引的项目。

Upgrade

将具有 32 位和 64 位索引卷的归档升级为使用 Elasticsearch 索引卷。升级期间,先前的索引仍可用,以便不影响用户搜索。请注意:在升级索引卷之前,请对同一索引卷执行 Synchronize 以便修复已发现的问题。

您需要通过引用 ArchiveIDsIndexLocationIDs 和/或 IndexVolumeIDs 参数列表来指定目标,这些值可以分别从 Get-EVArchiveGet-EVIndexLocationGet-EVIndexVolume cmdlet 中检索。也可以通过使用 Name 参数,指定要创建的子任务的名称。

发生以下情况时,将出现错误:

  • 如果您未引用索引位置、归档和/或索引卷。

  • 如果您引用参数的无效组合。

发生以下情况时,将出现警告:

  • 如果您指定已在处理的索引位置、归档和/或索引卷。

  • 如果数据库中不存在指定的索引位置、归档和/或索引卷。

  • 如果指定的索引位置、归档和/或索引卷在命令中已引用。

  • 如果您指定了Elasticsearch 类型的索引位置,或者该位置不包含任何索引卷。

  • 如果您指定了要升级的归档,但归档中没有 32 位或 64 位索引卷。

Submit-EVIndexingSubTask 由管理单元 Symantec.EnterpriseVault.PowerShell.AdminAPI.dll 提供。

语法

Submit-EVIndexingSubTask [[-SiteId] <string>] -Type {Rebuild | Synchronize | Verify | Upgrade} [-Name <String>] [-IndexLocationIDs <List<String>>] [-ArchiveIDs <List<String>>] [-IndexVolumeIDs <List<int>>] [-IgnoreFailedItems [<SwitchParameter>]] [-VerificationLevel {Basic | Complete}] [-AutoSynchronize [<SwitchParameter>]] [-IncludeContentMissingDetails [<SwitchParameter>]] [<CommonParameters>]

参数

表:Rebuild 参数

参数

类型

描述

-SiteId

字符串

您要为其提交索引子任务的 Enterprise Vault 站点的 ID。您可以使用 Get-EVSite 获取站点 ID。

-Type (required)

INDEXING_SUBTASK_TYPE

可能的值:RebuildSynchronizeVerifyUpgrade

要执行的索引子任务的类型。

-Name

字符串

索引子任务的名称。您可以提供任何自定义名称,其中允许的字符是字母数字字符、连字符 (-)、下划线 (_)、空格、冒号 (:)、括号 ([])。如果您没有指定此参数,那么 cmdlet 将自动生成一个唯一的名字。

-ArchiveIDs

List<String>

要执行索引子任务的归档的 ID 列表。每个值必须遵循 EV GUID 格式。可以使用 Get-EVArchive 获取可用 ID 的列表。

-IndexVolumeIDs

List<int>

要执行索引子任务的索引卷 ID 列表。每个值必须是整数类型。可以使用 Get-EVIndexVolume 获取可用 ID 的列表。

-IgnoreFailedItems

SwitchParameter

默认值:$false

只有当 Type 是 Upgrade 或 Rebuild 时,才能指定此参数。如果已指定,cmdlet 会忽略任何错误并完成子任务。否则,默认情况下,如果出现错误,cmdlet 会等待用户交互来完成任务。

表:Synchronize 参数

参数

类型

描述

-SiteId

字符串

您要为其提交索引子任务的 Enterprise Vault 站点的 ID。您可以使用 Get-EVSite 获取站点 ID。

-Type (required)

INDEXING_SUBTASK_TYPE

可能的值:RebuildSynchronizeVerifyUpgrade

要执行的索引子任务的类型。

-Name

字符串

索引子任务的名称。您可以提供任何自定义名称,其中允许的字符是字母数字字符、连字符 (-)、下划线 (_)、空格、冒号 (:)、括号 ([])。如果您没有指定此参数,cmdlet 将自动生成一个唯一的名字。

-IndexVolumeIDs

List<int>

要执行索引子任务的索引卷 ID 列表。每个值必须是整数类型。可以使用 Get-EVIndexVolume 获取可用 ID 的列表。

表:Verify 参数

参数

类型

描述

-SiteId

字符串

您要为其提交索引子任务的 Enterprise Vault 站点的 ID。您可以使用 Get-EVSite 获取站点 ID。

-Type (required)

INDEXING_SUBTASK_TYPE

可能的值:RebuildSynchronizeVerifyUpgrade

要执行的索引子任务的类型。

-Name

字符串

索引子任务的名称。您可以提供任何自定义名称,其中允许的字符是字母数字字符、连字符 (-)、下划线 (_)、空格、冒号 (:)、括号 ([])。如果您没有指定此参数,那么 cmdlet 将自动生成一个唯一的名字。

-IndexLocationIDs

List<String>

要执行索引子任务的索引位置 ID 列表。每个值必须遵循 EV GUID 格式。可以使用 Get-EVIndexLocation 获取可用 ID 的列表。

-ArchiveIDs

List<String>

要执行索引子任务的归档的 ID 列表。每个值必须遵循 EV GUID 格式。可以使用 Get-EVArchive 获取可用 ID 的列表。

-IndexVolumeIDs

List<int>

要执行索引子任务的索引卷 ID 列表。每个值必须是整数类型。可以使用 Get-EVIndexVolume 获取可用 ID 的列表。

-VerificationLevel

VERIFICATION_LEVEL

可能的值:Complete、Basic。

要应用于归档、索引卷或索引位置的验证级别类型。验证级别应是 Complete 或 Basic。Complete 验证级别检查索引卷是否可访问且运行良好,并完成索引卷的项目级别验证。这样可识别归档中存在的但未编制索引的项目,以及已编制索引但不再位于归档中的项目。Basic 验证级别检查索引卷是否可访问且运行良好。

-AutoSynchronize

SwitchParameter

如果指定,则会为每个存在错误的索引卷自动创建一个同步任务。只有当 Type 为 Verify 且验证级别被设置为 Complete 时,才能指定。

-IncludeContentMissingDetails

SwitchParameter

指定是否要对每个缺少内容的项目进行单独记录。只有当 Type 为 Verify 且验证级别被设置为 Complete 时,才能指定。

表:Upgrade 参数

参数

类型

描述

-SiteId

字符串

您要为其提交索引子任务的 Enterprise Vault 站点的 ID。您可以使用 Get-EVSite 获取站点 ID。

-Type (必需)

INDEXING_SUBTASK_TYPE

可能的值:RebuildSynchronizeVerifyUpgrade

要执行的索引子任务的类型。

-Name

字符串

索引子任务的名称。您可以提供任何自定义名称,其中允许的字符是字母数字字符、连字符 (-)、下划线 (_)、空格、冒号 (:)、括号 ([])。如果您没有指定此参数,那么 cmdlet 将自动生成一个唯一的名字。

-ArchiveIDs

List<String>

要执行索引子任务的归档的 ID 列表。每个值必须遵循 EV GUID 格式。可以使用 Get-EVArchive 获取可用 ID 的列表。

-IgnoreFailedItems

SwitchParameter

默认值:$false

只有当 Type 是 Upgrade 或 Rebuild 时,才能指定此参数。如果已指定,cmdlet 会忽略任何错误并完成子任务。否则,默认情况下,如果出现错误,cmdlet 会等待用户交互来完成任务。

输出

输出一条消息,指示子任务已成功提交。

示例
  • Submit-EVIndexingSubTask -Type Rebuild -ArchiveIDs '111...example.com','122...example.com' -IndexVolumeIDs 123,456

    此命令创建了一个新的索引子任务来重建指定的归档和索引卷。您也可以使用 -Name 参数指定子任务的自定义名称。另外,新创建的子任务不会忽略处理过程中遇到的任何错误,并将其标记为等待用户交互。

  • Submit-EVIndexingSubTask -Type Rebuild -ArchiveIDs '111...example.com','122...example.com' -IndexVolumeIDs 123,456 -Name 'Rebuild task' -IgnoreFailedItems

    此命令创建了一个名称为“Rebuild task”的新索引子任务来重建指定的归档和索引卷。同时,新创建的子任务会忽略处理过程中遇到的任何错误,并将其标记为带错误完成。

  • Submit-EVIndexingSubTask -Type Synchronize -IndexVolumeIDs 123,456

    此命令创建了一个新的索引子任务来同步指定的索引卷。

  • Submit-EVIndexingSubTask -Type Verify -IndexLocationIDs '133...example.com', '144...example.com' -ArchiveIDs '111...example.com','122...example.com' -IndexVolumeIDs 123,456

    此命令创建了一个新的索引子任务来验证指定的索引位置、归档和索引卷。子任务的验证级别为 Complete。

  • Submit-EVIndexingSubTask -Type Verify -IndexLocationIDs '133...example.com', '144...example.com' -VerificationLevel Complete -AutoSynchronize -IncludeContentMissingDetails

    此命令创建了一个新的索引子任务来验证指定的索引位置。子任务的验证级别为 Complete。该子任务会为每个存在错误的索引卷自动创建一个同步子任务。另外,子任务中每一个缺少内容的项目都会被单独记录下来。

  • Submit-EVIndexingSubTask -Type Verify -IndexLocationIDs '133...example.com', '144...example.com' -VerificationLevel Basic

    此命令创建了一个新的索引子任务来验证指定的索引位置。子任务的验证级别为 Basic。

  • Submit-EVIndexingSubTask -Type Upgrade -ArchiveIDs '111...example.com','122...example.com'

    此命令创建了一个新的索引子任务来升级指定的归档。同时,新创建的子任务不会忽略处理过程中遇到的任何错误,并将其标记为等待用户交互。

  • Submit-EVIndexingSubTask -Type Upgrade -ArchiveIDs '111...example.com','122...example.com' -IgnoreFailedItems

    此命令创建了一个新的索引子任务来升级指定的归档。同时,新创建的子任务会忽略处理过程中遇到的任何错误,并将其标记为带错误完成。

  • $archives = Get-EVArchive | where ArchiveName -Match 'abc' Submit-EVIndexingSubTask -Type Rebuild -ArchiveIDs $archives.ArchiveId

    此脚本首先检索名称中含有“abc”字符串的归档列表,然后创建一个新的索引子任务来重建这些归档。

  • $volumes = Get-EVIndexVolume -Attributes ExtraItems,Failed,MissingItems

    Submit-EVIndexingSubTask -Type Synchronize -IndexVolumeIDs $volumes.IndexVolumeIdentity

    此脚本首先检索出失败或有额外或缺失项目的索引卷的列表。然后会创建一个新的索引子任务来同步这些索引卷。

  • $location = Get-EVIndexLocation | where IndexRootPath -eq "C:\EVStorage\Index\index7"

    Submit-EVIndexingSubTask -Type Verify -IndexLocationIDs $location.IndexRootPathEntryId -VerificationLevel Complete

    此脚本首先用指定的索引根路径检索索引位置,然后创建一个新的索引子任务来验证该索引位置。

相关的 cmdlet