Enterprise Vault™ PowerShell Cmdlets

Last Published:
Product(s): Enterprise Vault (15.0)
  1. Enterprise Vault PowerShell cmdlet の概要
    1.  
      Enterprise Vault 管理シェルについて
    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

Submit-EVIndexingSubTask

Submit-EVIndexingSubTask cmdlet は、Type パラメータを使って指定された、Rebuild、Synchronize、Verify、Upgrade などの新しいインデックス関連のサブタスクを実行します。

表: サブタスクの種類と使用方法

サブタスクの種類

使用方法

Rebuild

インデックスボリュームを完全に再構築します。また、必要に応じて 32 ビットまたは 64 ビットのインデックスボリュームを Elasticsearch にアップグレードします。再構築中も古いインデックスボリュームは検索可能なので、ユーザーには影響しません。

Synchronize

インデックスボリュームを同期し、既知の問題を修正します。同期タスクは、以前にインデックス付けされておらず、インデックスボリュームブラウザで見つからないアイテムとして報告されているアイテムにインデックスを付けます。

Verify

インデックスボリュームがアクセス可能で健全であることを確認します。検証レベルに、Complete (詳細) 検証または Basic (基本) 検証を適用できます。Basic (基本) 検証では、インデックスボリュームの重大な問題を確認します。Complete (詳細) 検証では、重大な問題がないか調べるとともに、アイテムレベルの検証を実行して、インデックス付けされているがアーカイブにないアイテムやアーカイブされているがインデックス付けされていないアイテムについても確認します。

Upgrade

Elasticsearch インデックスボリュームを使うために、32 ビットおよび 64 ビットのインデックスボリュームを含むアーカイブをアップグレードします。アップグレード中も古いインデックスを使うことができるため、ユーザーの検索への影響はありません。メモ: インデックスボリュームをアップグレードする前に同じインデックスボリュームで同期を実行して、すでに特定済みの問題を解決してください。

ターゲットを指定するには、ArchiveIDsIndexLocationIDsIndexVolumeIDs パラメータのリストを指定します。値はそれぞれ Get-EVArchiveGet-EVIndexLocationGet-EVIndexVolume cmdlet から取得できます。必要に応じて、Name パラメータを使用して、作成するサブタスクの名前を指定できます。

次の場合はエラーが発生します。

  • インデックスの場所、アーカイブ、インデックスボリュームを指定しなかった場合

  • パラメータの無効な組み合わせを指定した場合

次の場合は警告が表示されます。

  • すでに処理中のインデックスの場所、アーカイブ、インデックスボリュームを指定した場合

  • データベースに存在しないインデックスの場所、アーカイブ、インデックスボリュームを指定した場合

  • コマンドですでに指定されているインデックスの場所、アーカイブ、インデックスボリュームを指定した場合

  • Elasticsearch タイプのインデックスの場所を指定した場合、またはインデックスボリュームが含まれていない場合。

  • 32 ビットまたは 64 ビットのインデックスボリュームがないアーカイブをアップグレードするように指定した場合。

Submit-EVIndexingSubTask は、スナップイン Symantec.EnterpriseVault.PowerShell.AdminAPI.dll によって提供されます。

構文

Submit-EVIndexingSubTask [[-SiteId] <string>] -Type {Rebuild | Synchronize | Verify | Upgrade} [-Name <String>] [-IndexLocationIDs <List<String>>] [-ArchiveIDs <List<String>>] [-IndexVolumeIDs <List<int>>] [-IgnoreFailedItems [<SwitchParameter>]] [-VerificationLevel {Basic | Complete}] [-AutoSynchronize [<SwitchParameter>]] [-IncludeContentMissingDetails [<SwitchParameter>]] [<CommonParameters>]

パラメータ

表: Rebuild のパラメータ

パラメータ

形式

説明

-SiteId

文字列

インデックスサブタスクを送信する Enterprise Vault サイトの ID。Get-EVSite を使ってサイト ID を取得することができます。

-Type (required)

INDEXING_SUBTASK_TYPE

指定可能な値: RebuildSynchronizeVerifyUpgrade

実行するインデックスサブタスクのタイプ。

-Name

文字列

インデックスサブタスクの名前。任意のカスタム名を指定できます。許可されている文字は、英数字、ハイフン (-)、アンダースコア (_)、スペース、コロン (:)、括弧 ([]) です。このパラメータを指定しない場合、cmdlet は自動的に一意の名前を生成します。

-ArchiveIDs

リスト<文字列>

インデックスサブタスクを実行するアーカイブの ID のリスト。各値は EV GUID 形式に従う必要があります。Get-EVArchive を使用して利用可能な ID のリストを取得できます。

-IndexVolumeIDs

リスト<整数>

インデックスサブタスクを実行するインデックスボリュームの ID のリスト。各値は整数型でなければなりません。Get-EVIndexVolume を使用して利用可能な ID のリストを取得できます。

-IgnoreFailedItems

SwitchParameter

デフォルト値: $false

このパラメータは、Type が Upgrade または Rebuild と指定されている場合にのみ指定できます。指定した場合、cmdlet はエラーを無視してサブタスクを完了します。指定しない場合、デフォルトで cmdlet は、エラーが発生した場合にユーザーの操作が完了するまで待機します。

表: Synchronize のパラメータ

パラメータ

形式

説明

-SiteId

文字列

インデックスサブタスクを送信する Enterprise Vault サイトの ID。Get-EVSite を使ってサイト ID を取得することができます。

-Type (required)

INDEXING_SUBTASK_TYPE

指定可能な値: RebuildSynchronizeVerifyUpgrade

実行するインデックスサブタスクのタイプ。

-Name

文字列

インデックスサブタスクの名前。任意のカスタム名を指定できます。許可されている文字は、英数字、ハイフン (-)、アンダースコア (_)、スペース、コロン (:)、括弧 ([]) です。このパラメータを指定しない場合、cmdlet は自動的に一意の名前を生成します。

-IndexVolumeIDs

リスト<整数>

インデックスサブタスクを実行するインデックスボリュームの ID のリスト。各値は整数型でなければなりません。Get-EVIndexVolume を使用して利用可能な ID のリストを取得できます。

表: Verify のパラメータ

パラメータ

形式

説明

-SiteId

文字列

インデックスサブタスクを送信する Enterprise Vault サイトの ID。Get-EVSite を使ってサイト ID を取得することができます。

-Type (required)

INDEXING_SUBTASK_TYPE

指定可能な値: RebuildSynchronizeVerifyUpgrade

実行するインデックスサブタスクのタイプ。

-Name

文字列

インデックスサブタスクの名前。任意のカスタム名を指定できます。許可されている文字は、英数字、ハイフン (-)、アンダースコア (_)、スペース、コロン (:)、括弧 ([]) です。このパラメータを指定しない場合、cmdlet は自動的に一意の名前を生成します。

-IndexLocationIDs

リスト<文字列>

インデックスサブタスクを実行するインデックスの場所の ID のリスト。各値は EV GUID 形式に従う必要があります。Get-EVIndexLocation を使用して利用可能な ID のリストを取得できます。

-ArchiveIDs

リスト<文字列>

インデックスサブタスクを実行するアーカイブの ID のリスト。各値は EV GUID 形式に従う必要があります。Get-EVArchive を使用して利用可能な ID のリストを取得できます。

-IndexVolumeIDs

リスト<整数>

インデックスサブタスクを実行するインデックスボリュームの ID のリスト。各値は整数型でなければなりません。Get-EVIndexVolume を使用して利用可能な ID のリストを取得できます。

-VerificationLevel

VERIFICATION_LEVEL

指定可能な値: Complete、Basic

アーカイブ、インデックスボリューム、インデックスの場所に適用する検証レベルの種類。検証レベルは、Complete または Basic のいずれかにする必要があります。Complete (詳細) 検証レベルでは、インデックスボリュームがアクセス可能で健全であることを確認し、インデックスボリュームのアイテムレベルの検証を完了します。これにより、アーカイブに存在するがインデックス付けされていないアイテム、およびインデックス付けされているがアーカイブに存在していないアイテムが確認されます。Basic (基本) 検証レベルでは、インデックスボリュームがアクセス可能で健全であることを確認します。

-AutoSynchronize

SwitchParameter

指定した場合、エラーが発生したインデックスボリュームごとに同期タスクが自動的に作成されます。Type が Verify と指定されており、検証レベルが Complete に設定されている場合にのみ指定できます。

-IncludeContentMissingDetails

SwitchParameter

コンテンツが欠落している各項目を個別にログに記録するかどうかを指定します。Type が Verify と指定されており、検証レベルが Complete に設定されている場合にのみ指定できます。

表: アップグレードのパラメータ

パラメータ

形式

説明

-SiteId

文字列

インデックスサブタスクを送信する Enterprise Vault サイトの ID。Get-EVSite を使ってサイト ID を取得することができます。

-Type (必須)

INDEXING_SUBTASK_TYPE

指定可能な値: RebuildSynchronizeVerifyUpgrade

実行するインデックスサブタスクのタイプ。

-Name

文字列

インデックスサブタスクの名前。任意のカスタム名を指定できます。許可されている文字は、英数字、ハイフン (-)、アンダースコア (_)、スペース、コロン (:)、括弧 ([]) です。このパラメータを指定しない場合、cmdlet は自動的に一意の名前を生成します。

-ArchiveIDs

リスト<文字列>

インデックスサブタスクを実行するアーカイブの ID のリスト。各値は EV GUID 形式に従う必要があります。Get-EVArchive を使用して利用可能な ID のリストを取得できます。

-IgnoreFailedItems

SwitchParameter

デフォルト値: $false

Type が Upgrade または Rebuild と指定されている場合に指定できます。指定した場合、cmdlet はエラーを無視してサブタスクを完了します。指定しない場合、デフォルトで cmdlet は、エラーが発生した場合にユーザーの操作が完了するまで待機します。

出力

サブタスクが正常に送信されたことを示すメッセージを出力します。

  • Submit-EVIndexingSubTask -Type Rebuild -ArchiveIDs '111...example.com','122...example.com' -IndexVolumeIDs 123,456

    このコマンドは、指定されたアーカイブとインデックスボリュームを再構築する新しいインデックスサブタスクを作成します。-Name パラメータを使用して、サブタスクのカスタム名を指定することもできます。また、新しく作成されたサブタスクは、処理中に発生したエラーを無視せず、ユーザーの操作を待機中としてマークします。

  • Submit-EVIndexingSubTask -Type Rebuild -ArchiveIDs '111...example.com','122...example.com' -IndexVolumeIDs 123,456 -Name 'Rebuild task' -IgnoreFailedItems

    このコマンドは、指定されたアーカイブとインデックスボリュームを再構築する「Rebuild task」という新しいインデックスサブタスクを作成します。また、新しく作成されたサブタスクは、処理中に発生したエラーを無視し、完了 (エラーあり) としてマークします。

  • Submit-EVIndexingSubTask -Type Synchronize -IndexVolumeIDs 123,456

    このコマンドは、指定されたインデックスボリュームを同期する新しいインデックスサブタスクを作成します。

  • Submit-EVIndexingSubTask -Type Verify -IndexLocationIDs '133...example.com', '144...example.com' -ArchiveIDs '111...example.com','122...example.com' -IndexVolumeIDs 123,456

    このコマンドは、指定されたインデックスの場所、アーカイブ、インデックスボリュームを検証する新しいインデックスサブタスクを作成します。サブタスクの検証レベルは Complete (詳細) です。

  • Submit-EVIndexingSubTask -Type Verify -IndexLocationIDs '133...example.com', '144...example.com' -VerificationLevel Complete -AutoSynchronize -IncludeContentMissingDetails

    このコマンドは、指定されたインデックスの場所を検証する新しいインデックスサブタスクを作成します。サブタスクの検証レベルは Complete (詳細) です。エラーが発生したインデックスボリュームごとに同期サブタスクが自動的に作成されます。また、コンテンツが欠落しているサブタスクの各アイテムは個別にログに記録されます。

  • Submit-EVIndexingSubTask -Type Verify -IndexLocationIDs '133...example.com', '144...example.com' -VerificationLevel Basic

    このコマンドは、指定されたインデックスの場所を検証する新しいインデックスサブタスクを作成します。サブタスクの検証レベルは Basic (基本) です。

  • Submit-EVIndexingSubTask -Type Upgrade -ArchiveIDs '111...example.com','122...example.com'

    このコマンドは、指定されたアーカイブをアップグレードするための新しいインデックスサブタスクを作成します。また、新しく作成されたサブタスクは、処理中に発生したエラーを無視せず、ユーザーの操作を待機中としてマークします。

  • Submit-EVIndexingSubTask -Type Upgrade -ArchiveIDs '111...example.com','122...example.com' -IgnoreFailedItems

    このコマンドは、指定されたアーカイブをアップグレードするための新しいインデックスサブタスクを作成します。また、新しく作成されたサブタスクは、処理中に発生したエラーを無視し、完了 (エラーあり) としてマークします。

  • $archives = Get-EVArchive | where ArchiveName -Match 'abc' Submit-EVIndexingSubTask -Type Rebuild -ArchiveIDs $archives.ArchiveId

    このスクリプトは、まず名前に文字列「abc」を含むアーカイブのリストを取得し、次に、それらのアーカイブを再構築するための新しいインデックスサブタスクを作成します。

  • $volumes = Get-EVIndexVolume -Attributes ExtraItems,Failed,MissingItems

    Submit-EVIndexingSubTask -Type Synchronize -IndexVolumeIDs $volumes.IndexVolumeIdentity

    このスクリプトは、まず、障害が発生したインデックスボリュームまたは追加のアイテムや不足しているアイテムがあるインデックスボリュームのリストを取得します。次に、それらのインデックスボリュームを同期する新しいインデックスサブタスクを作成します。

  • $location = Get-EVIndexLocation | where IndexRootPath -eq "C:\EVStorage\Index\index7"

    Submit-EVIndexingSubTask -Type Verify -IndexLocationIDs $location.IndexRootPathEntryId -VerificationLevel Complete

    このスクリプトは、まず、指定されたインデックスルートパスのインデックスの場所を取得し、次にそのインデックスの場所を確認するための新しいインデックスサブタスクを作成します。

関連 cmdlet