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

Get-EVArchive

Get-EVArchive 返回 Enterprise Vault 站点中的某些或所有归档的列表。可以筛选此列表以显示以下内容:

  • 直接或者通过 Active Directory 组成员资格返回且指定用户具有各种权限的归档。

  • 其名称与指定名称完全匹配的归档。

  • 包括归档索引详细信息以及常规归档详细信息。

可以根据一系列归档属性进一步筛选列表。例如,可以选择仅列出指定用户有权删除已归档项目的归档,或仅列出法定保留的归档。

Get-EVArchive 由管理单元 Symantec.EnterpriseVault.PowerShell.Snapin.dll 提供。

语法

Get-EVArchive [[-User] <String>] [-Server <String>] [-DeleteProtected <Boolean>] [-DeleteExpiredItems <Boolean>] [-OnHold <Boolean>] [-Permissions <String>] [-IncludeDetails <Boolean>] [<CommonParameters>]

Get-EVArchive [-ArchiveName <String>] [-Server <String>] [-DeleteProtected <Boolean>] [-DeleteExpiredItems <Boolean>] [-OnHold <Boolean>] [-IncludeDetails <Boolean>] [<CommonParameters>]

参数

表:Get-EVArchive 参数

参数

描述

-User(如果使用“语法”部分中的第一个参数集,则为必填)

标识要检索归档列表的用户。输入用户的 Windows 登录名、用户主体名称或 Domino 用户 ID。例如:user@domain.comdomain\user

-ArchiveName

指定要为其检索详细信息的归档的名称。

-Server

标识要检索归档列表的 Enterprise Vault 服务器。例如:localhostevserver.domain.com

如果忽略此参数,则该 cmdlet 会在注册表中进行查找以标识 Enterprise Vault Directory Service 计算机。

-DeleteProtected

根据用户是否可以手动删除归档中的项目来筛选归档列表。设置为 $false 将列出用户可以手动删除项目的归档,设置为 $true 将列出用户无法删除项目的归档。

-DeleteExpiredItems

根据 Enterprise Vault 是否可以自动删除保留期限已过期的归档项目来筛选归档列表。设置为 $false 将列出 Enterprise Vault 不会删除过期项目的归档,设置为 $true 将列出会删除过期项目的归档。

-OnHold

根据归档的法定保留状态来筛选归档列表。设置为 $false 将列出用户和/或 Enterprise Vault 可以删除项目的归档,设置为 $true 将列出法定保留的归档。

法定保留相当于 DeleteProtected 设置为 $trueDeleteExpiredItems 设置为 $false

-Permissions

根据用户对归档的权限来筛选归档列表。将权限指定为 r(表示读取)、w(表示写入)和 d(表示删除)的组合;例如,rwrwd。空值 () 表示任意权限。如果未指定,则默认权限为 d(删除)。

只有当您还指定了 -User 参数时,才能设置此参数。

-IncludeDetails

确定是否应在输出中包含归档的更多索引详细信息。这些详细信息包括以下属性:

  • VaultStoreName

  • IndexerName

  • IndexServerGroup

  • IndexVolumes

  • IndexedItems

  • BeingProcessed

设置为 $false 则不包括更多详细信息,设置为 $true 则包括更多详细信息。

示例
  • Get-EVArchive

    列出 Enterprise Vault 站点中的所有归档。

  • Get-EVArchive -DeleteProtected $false

    筛选 Enterprise Vault 站点中的归档的列表,以仅显示用户可在其中手动删除项目的归档。

  • Get-EVArchive -User Domain\User

    列出用户 Domain\User 在其中具有删除权限的归档。

  • Get-EVArchive -User user@domain -DeleteProtected $false -DeleteExpiredItems $false -Permissions rw

    列出用户 user@domain.com 具有读取和写入权限的归档。Get-EVArchive 对列表进行筛选,以仅显示用户可以手动删除项目但 Enterprise Vault 不能自动删除过期项目的归档。

  • Get-EVArchive -User Domain\User -OnHold $false | format-table -auto

    列出用户 Domain\User 具有删除权限的归档。Get-EVArchive 从列表中排除合法保留的所有归档,并将输出写入到 format-table

  • Get-EVArchive -ArchiveName msmith | format-table -auto

    列出名为“msmith”的归档。

  • Get-EVArchive | where-object {$_.ArchiveName -ilike "*journal*"}

    列出其名称包含不区分大小写的字符串“journal”的归档。

  • Get-EVArchive -IncludeDetails $true

    列出 Enterprise Vault 站点中的所有归档以及每个归档的索引详细信息。

  • Get-EVArchive -IncludeDetails $true | Where IndexServerGroup -ilike "*TempGroup1*"

    列出 IndexServerGroup 包含字符串“TempGroup1”的所有归档

  • Get-EVArchive -User 'Domain\User' -IncludeDetails $true | Where IndexedItems -GT 10

    列出“Domain\User”拥有删除权限、且已编制索引的项目总数超过 10 条的所有归档。

输出

表:Get-EVArchive 属性列出了可用的属性。

表:Get-EVArchive 属性

名称

类型

描述

ArchiveId

字符串

指定用户具有其访问权限的归档的 ID。

ArchiveName

字符串

指定用户具有其访问权限的归档的名称。

ArchiveType

EV_STG_API_​ARCHIVE_TYPE

Enterprise Vault 归档类型枚举。可能值如下所述:

  • ARCHIVE_TYPE_DOMINO_JOURNAL

  • ARCHIVE_TYPE_DOMINO_MAILBOX

  • ARCHIVE_TYPE_FILE_SYSTEM

  • ARCHIVE_TYPE_INTERNETMAIL

  • ARCHIVE_TYPE_JOURNAL

  • ARCHIVE_TYPE_MAILBOX

  • ARCHIVE_TYPE_PUBLIC_FOLDER

  • ARCHIVE_TYPE_SHARED

  • ARCHIVE_TYPE_SHAREPOINT

  • ARCHIVE_TYPE_SMTP

DeleteExpiredItems

EV_STG_API_​EXPIRE_ITEMS

Enterprise Vault 过期项目枚举。可能值如下所述:

  • DONT_EXPIRE_ITEMS

  • EXPIRE_ITEMS

DeleteProtected

布尔值

指示用户是能够 ($false) 还是不能够 ($true) 从归档中手动删除项目。

OnHold

布尔值

指示归档是包含 ($true) 还是不包含 ($false) 法定保留的归档。

Status

EV_STG_API_​STATUS

Enterprise Vault 归档状态枚举。可能值如下所述:

  • STS_AVAILABLE

  • STS_INBACKUPMODE

  • STS_TEMPORARILY_UNAVAILABLE

  • STS_UNAVAILABLE

RetentionPlanName

字符串

已将其应用于归档的保留计划的名称。

VaultStoreName

字符串

该归档所在的保管库存储的名称。

IndexerName

字符串

与此归档关联的索引服务器 (Indexer) 的名称。

IndexServerGroup

字符串

与此归档关联的索引服务器组的名称。如果关联的索引服务器不是任何索引服务器组的一部分,则该值将为“未分组的服务器”。

IndexVolumes

整数

此归档中创建的索引卷的总数。

IndexedItems

整数

此归档中已编制索引的项目的总数。

BeingProcessed

布尔值

指示此归档或其任何索引卷与某个任务关联 ($true) 或不关联 ($false)。

相关的 cmdlet