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

Add-EVRBARoleMember

Add-EVRBARoleMember 将一个或多个 Active Directory 用户、组或内置安全主体作为 Enterprise Vault RBA 角色的新成员添加。

-Identity 参数可指定要访问的 Enterprise Vault RBA 角色。您可以按名称或 GUID 标识 RBA 角色。还可以经管道传输角色对象指定角色。例如,您可以使用 Get-EVRBARole 检索角色对象,然后经管道将对象传递至 Add-EVRBARoleMember。如果未指定 -Identity-InputObject 参数,则系统会提示您输入 -Identity 值。

-Members 参数可指定要添加至角色的新成员。您可以按安全标识符 (SID) 或 SAM 帐户名称标识新成员。如果指定多个新成员,请使用逗号分隔的列表。无法通过管道将成员对象传递至此 cmdlet。如果未指定 -Members 参数,则系统会提示您输入 -Members 值。

您可以使用 -EVDirectoryServer 参数指定 Enterprise Vault 目录服务器。如果未使用 -EVDirectoryServer 参数,并且 Add-EVRBARoleMember 无法确定服务器,则系统会提示您输入 Enterprise Vault 目录服务器。

Vault Service 帐户和 RBAC Cmdlet 管理员角色的成员可以执行此 cmdlet。只有 Vault Service 帐户可以将成员添加到 RBAC Cmdlet 管理员角色。

Add-EVRBARoleMember 由管理单元 Symantec.EnterpriseVault.PowerShell.AdminAPI.dll 提供。

语法

Add-EVRBARoleMember [-Identity] <String> [-Members] <String[]> -EVDirectoryServer <String> [-PassThru <Switch>] [-Confirm <Switch>] [-WhatIf <Switch>] [<CommonParameters>]

Add-EVRBARoleMember [-InputObject] <Symantec.EnterpriseVault.Admin.EVRbaRole> [-Members] <String[]> -EVDirectoryServer <String> [-PassThru <Switch>] [-Confirm <Switch>] [-WhatIf <Switch>] [<CommonParameters>]

参数

表:Add-EVRBARoleMember 参数

参数

描述

-Identity (必填)

按名称或 GUID 指定 Enterprise Vault RBA 角色。

-InputObject (必填)

指定 Enterprise Vault RBA 角色对象。

该参数将通过管道获取此对象,或您可以将该参数设置为对象实例。

-Members (必填)

以逗号分隔的列表形式指定要添加至角色的 Active Directory 用户、组或内置安全主体的集合。

要确定每个对象,请使用以下属性值之一。请注意,括号中的标识符是 LDAP 显示名称。该参数的可接受值为:

  • 安全标识符 (objectSid)

  • SAM 帐户名称 (sAMAccountName)

以下示例显示如何指定此参数。在本示例中,使用 SAM 帐户名称属性指定了一个用户和组,使用其 SID 属性指定了另一名用户。

-Members "fsaAdmin@example.com", "NT AUTHORITY\This Organization", "S-1-5-21-1529523603-1500826627-74573220-1119"

不能向此参数提供对象。不能通过管道将对象传送至此参数。

-EVDirectoryServer (必填)

指定目录服务器的主机名、完全限定域名或 Enterprise Vault DNS 别名。请注意,虽然需要此参数,但如果可以,cmdlet 将自动确定。

-PassThru

返回代表所使用的角色的对象。默认情况下,此 cmdlet 不生成任何输出。

-Confirm

运行 cmdlet 之前,系统会提示您进行确认。

-WhatIf

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

示例
  • Add-EVRBARoleMember -Identity "File Server Administrator" -Members "fsaAdmin@example.com", "example\fsaGroup", "S-1-5-21-1529523603-1500826627-74573220-1119"

    向名为“文件服务器管理员”的 Enterprise Vault RBA 角色添加指定的 Active Directory 成员。

  • Add-EVRBARoleMember "File Server Administrator"

    提示指定要添加的成员,并将其添加至名为“文件服务器管理员”的 Enterprise Vault RBA 角色。请注意,参数 -Identity 是已定位参数(在位置 0),因此本示例适用于未指定该参数的情况。

  • 另外,可指定 -EVDirectoryServer 参数用于连接所需的 Enterprise Vault 目录:

    Add-EVRBARoleMember "File Server Administrator" -EVDirectoryServer evs2.example.com

    提示指定要添加的成员,并将其添加至由 -EVDirectoryServer 参数确定的 Enterprise Vault 目录中名为“文件服务器管理员”的 Enterprise Vault RBA 角色。

  • -InputObject 用法示例:

    $r = Get-EVRBARole "file server administrator"

    Add-EVRBARoleMember -InputObject $r

    提示指定要添加的成员,并将其添加至当前 Enterprise Vault 目录中名为“文件服务器管理员”的 Enterprise Vault RBA 角色。请注意,参数 -InputObject 是已定位参数(在位置 0),因此本示例适用于未指定该参数的情况。

  • 字符串管道示例:

    "file server administrator" | Add-EVRBARoleMember

    提示指定要添加的成员,并将其添加至当前 Enterprise Vault 目录中名为“文件服务器管理员”的 Enterprise Vault RBA 角色。

  • EVRbaRole 管道示例:

    Get-EVRBARole "file server administrator" -EVDirectoryServer evs2.example.com | Add-EVRBARoleMember -Members "fsaAdmin1", "fsaAdmin2" -EVDirectoryServer evs2.example.com

    将从 Get-EVRBARole cmdlet 获得的 EVRbaRole 对象用管道传输至 Add-EVRBARoleMember cmdlet,并为该角色添加指定成员。另请注意,参数 -EVDirectoryServer 可指定供每个 cmdlet 使用的 Enterprise Vault 目录。

输出

如果指定了 -PassThru 参数,Add-EVRBARoleMember 既不返回输出,也不返回修改后的 Symantec.EnterpriseVault.Admin.EVRbaRole 类型的对象。Symantec.EnterpriseVault.Admin.EVRbaRole 包含以下属性。

表:Symantec.EnterpriseVault.Admin.EVRbaRole 属性

名称

类型

描述

Name

字符串

Enterprise Vault RBA 角色的名称。

RoleGuid

字符串

Enterprise Vault RBA 角色的 GUID。

TaskLinkDescription

字符串

相关 TaskLink 的说明。

TaskLinkGuid

字符串

相关 TaskLink 的 GUID。

相关的 cmdlet