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

Set-EVArchivePermission

Set-EVArchivePermission 用于授予或拒绝某个用户或组的对指定归档的访问权限,可授予或拒绝的访问权限类型如下。

表:访问权限类型

访问权限

可授予的权限

Read

读取归档中的所有项目,以及从归档中还原项目。

Write

将项目保存到归档中,以及从归档中检索项目。具有此访问权限的用户还可以控制归档中的文件夹。例如,他们可以重命名文件夹,还可以更改对文件夹的权限。

Delete

从归档中删除项目。要允许用户从归档中删除项目,必须授予用户对归档的删除权限,选中站点设置“用户可从其归档中删除项目”,并使用 Set-EVArchive-DeleteProtected 设置为 $false

请注意下列事项:

  • 要管理指定类型的归档,运行 cmdlet 的用户必须具有基于角色的相应管理权限。例如,要管理 Exchange 邮箱归档,用户必须具有“可以管理 Exchange 邮箱归档”这一基于角色的管理权限。

  • 您可以使用此 cmdlet 设置拥有 Active Directory 或 Domino Directory 帐户的用户的访问权限。请注意,Domino 用户仅对 Domino 邮箱归档具有访问权限。要添加 Domino 用户,您需要安装 Notes 客户端,并在 Enterprise Vault 服务器上配置 Domino 域。

  • 此 cmdlet 仅会授予或拒绝手动设置的权限。您无法使用此 cmdlet 更改自动设置的权限。

  • 此 cmdlet 会将指定权限添加到用户或组现有的归档权限中,而不会覆盖现有权限。例如,如果用户或组已具有对指定归档的读取权限,而您指定了 -Grant Write,那么,Enterprise Vault 将授予用户或组对指定归档的读取和写入权限。

  • 对于给定的访问权限类型,-Grant-Deny 参数互斥,这意味着设置其中一项即会清除另一项。例如,如果用户或组已拒绝对指定归档的读取权限,而您指定了 -Grant Read,那么,该 cmdlet 会对相应用户或组授予读取访问权限。

  • -Deny 中指定的值的优先级高于 -Grant 中指定的值。例如:

    • 如果您将访问权限类型指定为 -Grant All -Deny Delete,则该 cmdlet 会对相应用户或组授予读取和写入权限,但会拒绝用于从归档中删除项目的权限。

    • 如果您将访问权限类型指定为 -Grant Delete -Deny All,那么,即使您已选择允许用户或组使用 -Grant Delete 从归档中删除项目,Enterprise Vault 也会拒绝相应用户或组对归档的所有访问权限。

  • 如果归档已标记为删除,此 cmdlet 不会更新权限信息。

  • 此 cmdlet 的作用与在“归档属性”对话框的“权限”选项卡中选中用户对应的复选框相同。

Set-EVArchivePermission 由管理单元 Symantec.EnterpriseVault.PowerShell.Snapin.dll 提供。

语法

Set-EVArchivePermission [-ArchiveId] <String> [-Trustee] <String> [-Grant <AccessRight[]> {Read | Write | Delete | All}] [-Deny <AccessRight[]> {Read | Write | Delete | All}] [-WhatIf] [-Confirm] [<CommonParameters>]

参数

表:Set-EVArchivePermission 参数

参数

说明

-ArchiveId(必填)

指定要为其设置访问权限的归档的 ID。可以使用 Get-EVArchive 获取所需 ID。

-Trustee(必填)

要对其添加或更新指定归档访问权限的用户或组的帐户名称。

对于 Active Directory 帐户,用以下任何格式键入值:

  • domain\user

  • domain\group

  • hostname\localuser

  • hostname\localgroup

对于 Domino 帐户,用以下任何格式键入值:

  • user/org

  • group/org

  • CN=user/O=org

  • group (org)

  • */org

  • */orgunit/org.例如,*/abc/DominoOrg

-Grant

要授予用户或组的对指定归档的访问权限:Read、Write 或 Delete。将访问权限类型指定为“All”可对用户或组授予所有类型的访问权限。

可以使用英文逗号分隔的方式指定多个访问权限类型;例如,-Grant Read,Write

-Deny

要拒绝用户或组的对指定归档的访问权限:Read、Write 或 Delete。将访问权限类型指定为“All”可对用户或组拒绝所有类型的访问权限。

可以使用英文逗号分隔的方式指定多个访问权限类型;例如,-Deny Read,Write

-WhatIf

显示如果 cmdlet 运行会发生的情况。cmdlet 没有实际运行。

-Confirm

运行 cmdlet 之前,系统会提示您进行确认。要取消确认提示信息,请使用语法 -Confirm:$False。必须在语法中包括冒号 (:)。

示例
  • Set-EVArchivePermission -ArchiveId 19D...EVServer1 -Trustee EXAMPLE\msmith -Grant read

    授予用户“EXAMPLE\msmith”对 ID 为“19D...EVServer1”的归档的读取访问权限。

  • Get-EVArchive -ArchiveName msmith | Set-EVArchivePermission -Trustee EXAMPLE\msmith -Deny d

    通过管道将取自 Get-EVArchive 的归档 ID 传输到 Set-EVArchivePermission,并拒绝 Windows 用户“EXAMPLE\msmith”对归档“msmith”的删除权限。

  • Get-EVArchive -ArchiveName dsmith | Set-EVArchivePermission -Trustee dsmith/DominoOrg -Deny d

    通过管道将取自 Get-EVArchive 的归档 ID 传输到 Set-EVArchivePermission,并拒绝 Domino Directory“DominoOrg”中的 Domino 用户“dsmith”对 Domino 邮箱归档“dsmith”的删除权限。

  • Get-EVArchive -ArchiveName msmith | Set-EVArchivePermission -Trustee Example\Supervisors -Grant All -Deny R, W

    警告:您在 Grant 和 Deny 参数中指定了相同的参数。Deny 参数中指定的权限的优先级更高。该 cmdlet 将添加权限“Deny: R, W”。

    确认 是否要继续? [Y] 是 [N] 否 [S] 挂起 [?] 帮助 (默认值为“Y”): Y

    系统将显示警告,然后提示进行确认以继续。如果选择“是”,该命令会授予组“EXAMPLE\Supervisors”对归档 “msmith”的删除访问权限,并拒绝相应的读取和写入访问权限。

  • Get-EVArchive -ArchiveName msmith | Set-EVArchivePermission -Trustee EXAMPLE\Supervisors -Grant Delete -Deny All -Confirm:$false

    会显示警告,然后拒绝组“EXAMPLE\Supervisors”对归档“msmith”的读取、写入和删除访问权限,但不提示进行确认。

  • Get-EVArchive -ArchiveName msmith | Get-EVArchivePermission | ForEach-Object { Set-EVArchivePermission -ArchiveId 19D...EVServer1 -Trustee $_.Trustee -Grant $_.ManualGranted -Deny $_.ManualDenied }

    通过管道传输取自 Get-EVArchive 的归档 ID 以及取自 Get-EVArchivePermission 的访问权限列表,并将针对归档“msmith”授予的访问权限复制到 ID 为“19D...EVServer1”的归档。

输出

Set-EVArchivePermission 用于返回 EnterpriseVault.Admin.ArchivePermissionEntry 类型的对象,其中包含以下属性。

表:Set-EVArchivePermission 属性

名称

类型

说明

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

TrusteeId

字符串

用户或组的唯一标识 ID。对于 Active Directory 帐户,该 cmdlet 将显示安全标识符 (SID);而对于 Domino Directory 帐户,该 cmdlet 将显示 UNID。

Trustee

字符串

用户或组的帐户名称。

TrusteeSource

TrusteeSource

用户或组的帐户所在的目录服务。“Windows”表示 Active Directory,而“Domino”表示 Domino Directory。

TrusteeType

TrusteeType

Enterprise Vault 受信者类型枚举。可能值如下:

  • User

  • Group

  • Wildcard

  • Unknown

  • DeletedUser

ManualGranted

AccessRight[]

手动授予的访问权限级别:Read、Write 或 Delete。

ManualDenied

AccessRight[]

手动拒绝的访问权限级别:Read、Write 或 Delete。

AutoGranted

AccessRight[]

自动授予的访问权限级别:Read、Write 或 Delete。

AutoDenied

AccessRight[]

自动拒绝的访问权限级别:Read、Write 或 Delete。

相关的 cmdlet