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

Set-EVArchivePermission

Set-EVArchivePermission を使用すると、指定したアーカイブで所定のユーザーまたはグループに以下のタイプのアクセス権限の付与または拒否を実行できます。

表: アクセスタイプ

アクセス

付与する権限

Read

アーカイブにあるすべての項目を読み取り、そこから項目を復元します。

Write

項目をアーカイブに保存して、そこから項目を取得します。このアクセス権限があるユーザーは、アーカイブにあるフォルダも管理できます。たとえば、フォルダの名前や権限を変更できます。

Delete

アーカイブからの項目の削除。アーカイブから項目を削除するのをユーザーに許可するには、ユーザーにアーカイブでの削除権限を付与してサイト設定[ユーザーはアーカイブから項目を削除できる]を選択し、Set-EVArchive を使用して -DeleteProtected$false に設定する必要があります。

次の点に注意してください。

  • コマンドレットを実行するユーザーには、指定されたタイプのアーカイブを管理するためにロールベースの管理権限が必要です。たとえば、Exchange メールボックスアーカイブを管理するには、ユーザーにはロールベースの管理権限「Can manage Exchange Mailbox Archives」が必要です。

  • このコマンドレットを使用して、Active Directory または Domino Directory アカウントのあるユーザーのアクセス権限を設定できます。Domino ユーザーは、Domino メールボックスアーカイブでのみアクセス権限を持てます。Domino ユーザーを追加するには、Notes クライアントをインストールし、Enterprise Vault サーバーで Domino ドメインを構成する必要があります。

  • このコマンドレットは、手動で設定した権限のみを付与または拒否します。このコマンドレットを使用して、自動的に設定された権限を変更することはできません。

  • コマンドレットは、アーカイブでユーザーまたはグループが持つ現在の権限に指定した権限を追加し、現在の権限を上書きしません。たとえば、指定したアーカイブにユーザーまたはグループにすでに Read アクセスがあるときに -Grant Write を指定すると、Enterprise Vault は指定したアーカイブでそのユーザーまたはグループに読み取りと書き込み両方のアクセス権限を付与します。

  • -Grant パラメータと -Deny パラメータは、特定のアクセスタイプに対して相互に排他的です。つまり、片方を設定するともう片方がクリアされます。たとえば、ユーザーまたはグループが指定したアーカイブで読み取りアクセスを拒否され、-Grant Read を指定した場合、コマンドレットはそのユーザーまたはグループに読み取りアクセス権限を付与します。

  • -Deny で指定されている値は、-Grant で指定されている値に優先します。次に例を示します。

    • アクセスタイプを -Grant All -Deny Delete として指定すると、コマンドレットは、ユーザーまたはグループに読み取りおよび書き込みアクセスを付与しますが、アーカイブから項目を削除する権限を拒否します。

    • アクセスタイプを -Grant Delete -Deny All として指定すると、Enterprise Vault は、ユーザーまたはグループが -Grant Delete を使用して、アーカイブから項目を削除することを許可するように選択した場合でも、ユーザーまたはグループにアーカイブでのすべてのアクセスに対する権限を拒否します。

  • アーカイブが削除対象としてマークされている場合、このコマンドレットは権限情報を更新しません。

  • このコマンドレットの影響は、[アーカイブのプロパティ]ダイアログボックスの[権限]タブでユーザーのチェックボックスを選択するのと同じです。

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

    ID「19D...EVServer1」のアーカイブでユーザー「EXAMPLE\msmith」の読み取りアクセス権限を付与します。

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

    Get-EVArchive から取得したアーカイブ ID を Set-EVArchivePermission にパイプ処理し、アーカイブ「msmith」で Windows ユーザー「EXAMPLE\msmith」の削除権限を拒否します。

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

    Get-EVArchive から取得したアーカイブ ID を Set-EVArchivePermission にパイプ処理し、Domino メールボックスアーカイブ「dsmith」で Domino ユーザー「dsmith」に Domino Directory「DominoOrg」の削除権限を拒否します。

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

    警告: Grant パラメータと Deny パラメータに同じ権限を設定しています。Deny パラメータで指定されている権限が優先します。コマンドレットは権限「拒否: R、W」を追加します。

    Confirm Do you want to continue? [Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y

    警告を表示し、続行の確認メッセージを表示します。[はい]を選択すると、コマンドによりグループ「EXAMPLE\Supervisors」に削除アクセス権限が付与され、アーカイブ「msmith」での読み取りおよび書き込みアクセス権限が拒否されます。

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

    警告を表示し、アーカイブ「msmith」で確認を求めずにグループ「EXAMPLE\Supervisors」の読み取り、書き込み、および削除アクセス権限を拒否します。

  • 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 アカウントの場合、コマンドレットはセキュリティ識別子 (SID) を表示し、Domino Directory アカウントの場合、コマンドレットは UNID を表示します。

Trustee

文字列

ユーザーまたはグループのアカウント名。

TrusteeSource

TrusteeSource

ユーザーまたはグループにアカウントがあるディレクトリサービス。「Windows」は Active Directory を指定し、「Domino」は Domino Directory を指定します。

TrusteeType

TrusteeType

Enterprise Vault Trustee 型の列挙。設定可能な値は次のとおりです。

  • 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。

関連コマンドレット