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

Get-EVArchive

Get-EVArchive は Enterprise Vault サイト内の一部またはすべてのアーカイブの一覧を返します。この一覧をフィルタ処理して次を示すようにすることができます。

  • 指定したユーザーがさまざまな権限を直接保有、または Active Directory グループのメンバーシップを介して保有しているアーカイブ

  • 指定した名前と完全に一致する名前のアーカイブ

  • アーカイブインデックスの詳細と通常のアーカイブの詳細を含めます。

さまざまなアーカイブプロパティによって一覧をさらにフィルタ処理できます。たとえば、指定したユーザーがアーカイブ済みアイテムを削除する権限を持っているアーカイブのみ、またはリーガルホールドの状態であるアーカイブのみを一覧表示するように選択できます。

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

構文

Get-EVArchive [[-User] <String>] [-Server <String>] [-DeleteProtected <Boolean>] [-DeleteExpiredItems <Boolean>] [-OnHold <Boolean>] [-Permissions <String>] [-IncludeDetails <Boolean>] [<CommonParameters>]

Get-EVArchive [-ArchiveName <String>] [-Server <String>] [-DeleteProtected <Boolean>] [-DeleteExpiredItems <Boolean>] [-OnHold <Boolean>] [-IncludeDetails <Boolean>] [<CommonParameters>]

パラメータ

表: Get-EVArchive パラメータ

パラメータ

説明

-User (構文セクションで設定した最初のパラメータを使う場合に必須)

アーカイブ一覧の取得対象のユーザーを指定します。ユーザーの Windows ログオン名、ユーザープリンシパル名、または Domino ユーザー ID を入力します。例: user@domain.comdomain\user

-ArchiveName

詳細を取り込む対象のアーカイブの名前を指定します。

-Server

アーカイブ一覧を取り込む対象の Enterprise Vault サーバーを識別します。例: localhostevserver.domain.com

このパラメータを省略すると、cmdlet はレジストリを調べて、Enterprise Vault Directory Service コンピュータを識別します。

-DeleteProtected

アーカイブ内のアイテムを手動で削除できるかどうかに応じて、アーカイブ一覧をフィルタ処理します。ユーザーがアイテムを手動で削除できるアーカイブを一覧表示するには、$false に設定します。アイテムを削除できないアーカイブを一覧表示するには、$true に設定します。

-DeleteExpiredItems

保持期間が切れているアーカイブ済みアイテムを Enterprise Vault が自動的に削除できるかどうかに応じて、アーカイブ一覧をフィルタ処理します。Enterprise Vault が期限切れアイテムを削除しないアーカイブを一覧表示するには、$false に設定します。そのようなアイテムを削除するアーカイブを一覧表示するには、$true に設定します。

-OnHold

アーカイブのリーガルホールドの状態に応じてアーカイブ一覧をフィルタ処理します。ユーザーと Enterprise Vault のいずれかまたは両方がアイテムを削除できるアーカイブを一覧表示するには、$false に設定します。リーガルホールドの状態のアーカイブを一覧表示するには、$true に設定します。

リーガルホールドは DeleteProtected$true に設定した場合および DeleteExpiredItems$false に設定した場合と同じです。

-Permissions

アーカイブに対するユーザーの権限に応じてアーカイブ一覧をフィルタ処理します。権限を r (読み取り)、w (書き込み)、d (削除) の組み合わせとして指定します (rwrwd など)。空白の値 () は任意の権限を示します。指定されていない場合、デフォルトの権限は d (削除) です。

このパラメータは、-User パラメータも指定した場合にのみ設定できます。

-IncludeDetails

アーカイブの追加インデックスの詳細を出力に含めるかどうかを決定します。これらの詳細には、次のプロパティが含まれます。

  • VaultStoreName

  • IndexerName

  • IndexServerGroup

  • IndexVolumes

  • IndexedItems

  • BeingProcessed

$false に設定して追加の詳細を除外したり、$true に設定して含めたりします。

  • Get-EVArchive

    Enterprise Vault サイト内のすべてのアーカイブを一覧表示します。

  • Get-EVArchive -DeleteProtected $false

    Enterprise Vault サイト内のアーカイブの一覧をフィルタ処理して、ユーザーが手動でアイテムを削除できるアーカイブのみを表示します。

  • Get-EVArchive -User Domain\User

    ユーザー Domain\User が削除の権限を持つアーカイブを一覧表示します。

  • Get-EVArchive -User user@domain -DeleteProtected $false -DeleteExpiredItems $false -Permissions rw

    ユーザー user@domain.com が読み取り権限と書き込み権限の両方を持っているアーカイブを一覧表示します。Get-EVArchive は、ユーザーが手動でアイテムを削除でき、Enterprise Vault が期限切れアイテムを自動的に削除できないアーカイブのみを表示するようにリストをフィルタ処理します。

  • Get-EVArchive -User Domain\User -OnHold $false | format-table -auto

    ユーザー Domain\User が削除権限を持っているアーカイブを一覧表示します。Get-EVArchive は、リストからリーガルホールドの状態にあるすべてのアーカイブを除外して、出力を format-table に書き込みます。

  • Get-EVArchive -ArchiveName msmith | format-table -auto

    「msmith」という名前を持つアーカイブを一覧表示します。

  • Get-EVArchive | where-object {$_.ArchiveName -ilike "*journal*"}

    大文字と小文字を区別する文字列「journal」を含んでいる名前のアーカイブを一覧表示します。

  • Get-EVArchive -IncludeDetails $true

    Enterprise Vault サイト内のすべてのアーカイブを、各アーカイブのインデックスの詳細と共に一覧表示します。

  • Get-EVArchive -IncludeDetails $true | Where IndexServerGroup -ilike "*TempGroup1*"

    IndexServerGroup に文字列「TempGroup1」が含まれるすべてのアーカイブを一覧表示します。

  • Get-EVArchive -User 'Domain\User' -IncludeDetails $true | Where IndexedItems -GT 10

    「Domain\User」に削除権限があり、合計で 10 個を超えるアイテムがインデックス付けされているアーカイブをすべて一覧表示します。

出力

表: Get-EVArchive プロパティのリストに、利用可能なプロパティを示します。

表: Get-EVArchive プロパティ

名前

形式

説明

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

DeleteExpiredItems

EV_STG_API_​EXPIRE_ITEMS

Enterprise Vault の期限切れアイテムの列挙。指定可能な値は次のとおりです。

  • DONT_EXPIRE_ITEMS

  • EXPIRE_ITEMS

DeleteProtected

ブール値

ユーザーが手動でアイテムをアーカイブから削除できる ($false) かできないか ($true) を示します。

OnHold

ブール値

アーカイブにリーガルホールドにあるアイテムが含まれる ($true) か含まれない ($false) かを示します。

Status

EV_STG_API_​STATUS

Enterprise Vault アーカイブの状態の列挙。指定可能な値は次のとおりです。

  • STS_AVAILABLE

  • STS_INBACKUPMODE

  • STS_TEMPORARILY_UNAVAILABLE

  • STS_UNAVAILABLE

RetentionPlanName

文字列

アーカイブに適用した保持計画の名前。

VaultStoreName

文字列

このアーカイブが配置されるボルトストアの名前。

IndexerName

文字列

このアーカイブに関連付けられているインデックスサーバー (Indexer) の名前。

IndexServerGroup

文字列

このアーカイブに関連付けられているインデックスサーバーグループの名前。関連付けられたインデックスサーバーがインデックスサーバーグループの一部ではない場合、値は「Ungrouped Servers」になります。

IndexVolumes

整数

このアーカイブで作成されたインデックスボリュームの総数。

IndexedItems

整数

このアーカイブでインデックス作成されたアイテムの総数。

BeingProcessed

ブール値

このアーカイブまたはそのいずれかのインデックスボリュームがタスクに関連付けられているか ($true) 関連付けられていないか ($false) を示します。

関連 cmdlet