Enterprise Vault™ PowerShell Cmdlet

Last Published:
Product(s): Enterprise Vault (14.1)
  1. Enterprise Vault PowerShell cmdlet の概要
    1.  
      Enterprise Vault 管理シェルについて
    2.  
      Enterprise Vault PowerShell cmdlet のヘルプの使用方法
    3.  
      PowerShell 文字列のルール
    4. 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.  
      Clear-IndexLocationBackupMode
    2.  
      Clear-VaultStoreBackupMode
    3.  
      Get-IndexLocationBackupMode
    4.  
      Get-VaultStoreBackupMode
    5.  
      Set-IndexLocationBackupMode
    6.  
      Set-VaultStoreBackupMode
  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
  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.  
      Remove-EVArchivePermission
    8.  
      Set-EVArchive
    9.  
      Set-EVArchivePermission
    10.  
      Start-PartitionRollover

Add-EVRBARoleMember

Add-EVRBARoleMember は、1 つ以上の Active Directory ユーザー、グループまたは組み込みセキュリティプリンシパルを Enterprise Vault RBA ロールの新メンバーとして追加します。

-Identity パラメータはアクセスする Enterprise Vault RBA ロールを指定します。 RBA ロールはその名前または GUID で識別できます。 パイプラインを使ってロールオブジェクトを渡すことでロールを指定することもできます。 たとえば、Get-EVRBARole を使ってロールオブジェクトを取得し、そのオブジェクトをパイプラインを介して Add-EVRBARoleMember に渡すことができます。 -Identity または -InputObject パラメータを指定しない場合は、-Identity の値を入力するように求められます。

-Members パラメータでロールに追加する新メンバーを指定します。 新メンバーはそのセキュリティ ID (SID)または SAM アカウント名で識別できます。 複数の新メンバーを指定する場合は、カンマ区切りのリストを使います。 この cmdlet には、パイプラインを介してメンバーオブジェクトを渡すことができません。 -Members パラメータを指定しない場合は、-Members の値を入力するように求められます。

Enterprise Vault ディレクトリサーバーは、-EVDirectoryServer パラメータを使って指定できます。 -EVDirectoryServer パラメータを指定しない場合に Add-EVRBARoleMember がディレクトリを判別できない場合は、Enterprise Vault ディレクトリサーバーを入力するように求められます。

この cmdlet を実行する権限は Vault サービスアカウントに制限されています。

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 表示名です。 このパラメータの受け入れ可能な値は次のとおりです。

  • セキュリティ ID (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 "ファイルサーバー管理者" -Members "fsaAdmin@example.com", "example\fsaGroup", "S-1-5-21-1529523603-1500826627-74573220-1119"

    指定した Active Directory メンバーを "ファイルサーバー管理者" という Enterprise Vault RBA ロールに追加します。

  • Add-EVRBARoleMember "File Server Administrator"

    追加するメンバーを求めて、"File Server Administrator" という Enterprise Vault RBA ロールに追加します。 パラメータ -Identity は位置決定されたパラメータ(ポジション 0)であるため、この例では指定しなくても問題ありません。

  • さらに、-EVDirectoryServer パラメータを指定して、任意の Enterprise Vault ディレクトリに接続できます。

    Add-EVRBARoleMember "ファイルサーバー管理者" -EVDirectoryServer evs2.example.com

    メンバーを追加するように求めて、-EVDirectoryServer パラメータで識別した Enterprise Vault ディレクトリ内の "ファイルサーバー管理者" という Enterprise Vault RBA ロールにメンバーを追加します。

  • -InputObject の使い方の例:

    $r = Get-EVRBARole "file server administrator"

    Add-EVRBARoleMember -InputObject $r

    追加するメンバーを求めて、現在の Enterprise Vault ディレクトリにある "File Server Administrator" という Enterprise Vault RBA ロールにそのメンバーを追加します。 パラメータ -InputObject は位置決定されたパラメータ(ポジション 0)であるため、この例では指定しなくても問題ありません。

  • 文字列のパイプ処理の例:

    "file server administrator" | Add-EVRBARoleMember

    追加するメンバーを求めて、現在の Enterprise Vault ディレクトリにある "File Server Administrator" という 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 ディレクトリも指定します。

出力

Add-EVRBARoleMember は、-PassThru パラメータを指定する場合、出力またはタイプ 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。

関連コマンドレット