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

New-EVArchive

New-EVArchive は指定した種類のアーカイブを作成します。アーカイブを作成するには、ArchiveNameArchiveTypeVaultStoreNameBillUsageTo を指定する必要があります。

次のサポート対象タイプの新しいアーカイブのみ作成できます。

  • Domino ジャーナル

  • Exchange ジャーナル

  • Exchange パブリックフォルダ

  • Shared

  • SMTP

必要に応じて、DescriptionAdminNoteRetentionPlanName およびインデックス設定を指定できます。

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

構文

New-EVArchive [-ArchiveName] <String> [-ArchiveType] { DominoJournal | ExchangeJournal | PublicFolder | Shared | SMTP} [-VaultStoreName] <String> [-BillUsageTo] <String> [-SiteId <string>] [-Description <String>] [-AdminNote <String>] [-RetentionPlanName <String>] [-IndexLevel {Brief | Full}] [-IndexPreviewLength {128 | 1000}] [-CreateAttachmentPreview <Boolean>] [<CommonParameters>]

パラメータ

表: New-EVArchive パラメータ

パラメータ

説明

-SiteId

アーカイブが作成される Enterprise Vault サイトの ID。このパラメータを省略し、cmdlet がレジストリ内を検索して ID を特定できない場合、New-EVArchive cmdlet は必要なサイト ID を入力するよう求めます。

Get-EVSite を使ってサイト ID を取得することができます。

-ArchiveName (required)

アーカイブの名前。名前には 255 文字まで入力できます。

-ArchiveType (required)

アーカイブの種類。指定可能な値は、次のとおりです。

  • DominoJournal

  • ExchangeJournal

  • PublicFolder

  • Shared

  • SMTP

-VaultStoreName (required)

アーカイブに使用するボルトストアの名前。ボルトストアには 1 つ以上のパーティションが必要です。必要なボルトストアの名前は Get-EVVaultStore cmdlet を使って取得できます。

-BillUsageTo (required)

課金を目的としてこのアーカイブを所有する Windows アカウント名を指定します。

Windows Active Directory ユーザーまたはグループのアカウント名。次のいずれかの形式で値を入力します。

  • domain\user

  • domain\group

  • hostname\localuser

  • hostname\localgroup

-Description

管理コンソールのアーカイブプロパティで表示される短い説明を提供します。この説明には 127 文字まで入力できます。

-AdminNote

管理コンソールのアーカイブプロパティで表示される管理用のメモを提供します。この値には 127 文字まで入力できます。

-RetentionPlanName

アーカイブに適用する保持計画の名前を指定します。

保持計画は、次の種類のアーカイブのみ指定できます。

  • DominoJournal

  • ExchangeJournal

  • SMTP

-IndexLevel

アーカイブのインデックスに割り当てるインデックスレベル。設定可能な列挙値は次のとおりです。

  • Brief または 0: Enterprise Vault は、アーカイブ済みアイテムのメタデータにインデックスを付けますが、コンテンツには付けません。たとえば、Enterprise Vault は送信者とアイテムの日付にインデックスを付けます。ユーザーはこれらのアイテムの内容を検索できません。

  • Full または 2: Enterprise Vault は、アーカイブ済みアイテムとその添付ファイルのメタデータとコンテンツにインデックスを付けます。ユーザーはアイテムと添付ファイルの内容を検索できます。

このパラメータが指定されていない場合、サイトの設定の値が使用されます。

-IndexPreviewLength

Enterprise Vault が検索結果に表示する各アイテムテキストの量。指定可能な値は 128 と 1000 です。

IndexLevel に Brief または 0 が指定されている場合、このパラメータは指定できません。このパラメータが指定されていない場合、サイトの設定の値が使用されます。

-CreateAttachmentPreview

添付ファイルのコンテンツのプレビューを Enterprise Vault で作成するかどうかを指定します。

IndexLevel に Brief または 0 が指定されている場合、このパラメータは指定できません。このパラメータが指定されていない場合、サイトの設定の値が使用されます。

  • New-EVArchive myArchive SMTP myVaultStore example\john

    名前が「myArchive」で種類が SMTP のアーカイブを作成します。「myVaultStore」は使用されるボルトストアで、「example\john」は課金に使用される Windows アカウントです。

  • New-EVArchive myArchive Shared myVaultStore example\john -Description "Shared Archive" -AdminNote "Administrator Note"

    名前が「myArchive」で種類が Shared のアーカイブを作成します。「myVaultStore」は使用されるボルトストアで、「example\john」は課金アカウントです。また、説明は「Shared Archive」、管理者用のメモは「Administrator Note」に設定されます。

  • New-EVArchive myArchive SMTP myVaultStore example\john -Description "SMTP Archive for managers" -RetentionPlanName RetPlanForArchiveManagers

    説明が「SMTP Archive for managers」、保持計画が「RetPlanForArchiveManagers」のアーカイブを作成します。

  • New-EVArchive myArchive SMTP myVaultStore example\john -IndexLevel Brief

    アーカイブを作成し、アーカイブインデックスのインデックスレベルに Brief を割り当てます。

  • New-EVArchive myArchive DominoJournal myVaultStore example\john -IndexLevel Full -IndexPreviewLength 1000 -CreateAttachmentPreview $true

    インデックスレベルが Full、インデックスプレビューの長さが 1000 のアーカイブを作成します。また、添付ファイルのプレビューの作成を有効にします。

  • Import-Csv archives.csv | New-EVArchive

    CSV ファイルを使用して多数のアーカイブを作成します。CSV ファイルには、ArchiveName、ArchiveType、VaultStoreName、BillUsageTo などのヘッダーが必要です。必要に応じて、Description、AdminNote、RetentionPlanName などのその他のプロパティを CSV ファイルに含めることができます。

    メモ:

    Import-Csv cmdlet の既知の制限事項により、パイプライン処理で Import-Csv コマンドレットを使用すると、ブール値はパイプライン処理されず、$false と指定されます。この問題を解決するには、文字列値をインポートした後、パイプラインの次の cmdlet にパイプ処理する前に、その文字列値をブール値に変換します。Import-Csv cmdlet の使用時にインポートされるブール値についてを参照してください。

  • Import-Csv archives.csv | New-EVArchive | Set-EVArchivePermission -Trustee example\john -Grant Delete

    CSV ファイルを使用して多数のアーカイブを作成し、そのすべてのアーカイブに対する削除権限を Windows アカウント「example\john」に付与します。

  • Get-EVArchive -ArchiveName 'existing archive' -IncludeDetails $true | New-EVArchive -ArchiveName 'new archive' -BillUsageTo example\john

    既存のアーカイブのクローンを作成し、課金ユーザーを「example\john」で上書きします。

出力

New-EVArchive は、次のプロパティを持つ Symantec.EnterpriseVault.PowerShell.Commands.NewArchive 型のオブジェクトを返します。

表: New-EVArchive プロパティ

名前

形式

説明

ArchiveName

文字列

作成されたアーカイブの名前。

ArchiveDescription

文字列

作成されたアーカイブの説明。

ArchiveType

EV_STG_API_ARCHIVE_TYPE

作成されたアーカイブの種類。

ArchiveId

文字列

作成されたアーカイブの ID。

VaultStoreName

文字列

アーカイブに使用するボルトストアの名前。

VaultStoreId

文字列

アーカイブに使用するボルトストアの ID。

StorageServerName

文字列

アーカイブに使用するストレージサーバーの名前。

IndexerName

文字列

インデックス作成に使用するインデックスサーバーの名前。

IndexServerGroup

文字列

アーカイブが属するインデックスサーバーグループの名前

RetentionPlanName

文字列

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

BillUsageTo

文字列

課金を目的としてこのアーカイブを所有する Windows Active Directory アカウント。

AdminNote

文字列

作成されたアーカイブの管理者用メモ。

IndexLevel

EV_STG_API_INDEX_LEVEL

ユーザーアーカイブのインデックスレベルの設定。

IndexPreviewLength

整数

Enterprise Vault が検索結果に表示する各アイテムのテキスト量。

CreateAttachmentPreview

ブール値

添付ファイルのコンテンツのプレビューを Enterprise Vault で作成するかどうかを指定します。

関連 cmdlet