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-EVExchangeMailboxPolicy

New-EVExchangeMailboxPolicy は、新しい Exchange メールボックスポリシーを作成します。

New-EVExchangeMailboxPolicy は、Veritas.EnterpriseVault.PowerShell.AdminAPI.dll スナップインから利用できます。

列挙値を使用するパラメータもあります。Exchange メールボックスポリシーの列挙値について詳しくは、get-help about_ExchMbxPolicyEnumerations と入力してください。

構文

New-EVExchangeMailboxPolicy -Name <String> [-ArchivingStrategy <ArchivingStrategyEnum>] [-LockArchivingStrategy <Boolean>] [-ArchiveItemsOlderThan <Integer>] [-ArchiveItemsOlderThanUnits <AgeUnitsEnum>] [-PercentageOfQuota <Integer>] [-MinimumArchiveAge <Integer>] [-MinimumArchiveAgeUnits <AgeUnitsEnum>] [-SizePriority <Boolean>] [-MinimumItemSizeKB <Integer>] [-ArchiveMsgsWithAttachmentsOnly <Boolean>] [-ShortcutInactivityPeriod <Integer>] [-ShortcutInactivityUnits <AgeUnitsEnum>] [-DeleteAfterArchive <Boolean>] [-LockDeleteAfterArchive <Boolean>] [-CreateShortcutAfterArchive <Boolean>] [-LockCreateShortcutAfterArchive <Boolean>] [-ArchiveUnreadItems <Boolean>] [-LockArchiveUnreadItems <Boolean>] [-OverallLock <Boolean>] [-IncludeRecipientInformation <Boolean>] [-ContentOfShortcutBody <ShortcutBodyContent Enum>] [-IncludeBanner <Boolean>] [-IncludeLinkToArchivedItem <Boolean>] [-MessageCharsToInclude <Integer>] [-DisplayAttachmentsAs <AttachmentsDisplay Enum>] [-IndexLevel <IndexingLevelEnum>] [-IndexPreviewLength <Integer>] [-CreateAttachmentPreview <Boolean>] [-IsADefaultPolicy <Boolean>] [-Description <String>] [-SiteId <String>] [-EntryId <String>] [<CommonParameters>]

パラメータ

表: New-EVExchangeMailboxPolicy パラメータ

パラメータ

説明

-Name (必須)

作成する Exchange メールボックスポリシーの名前。名前は一意である必要があり、最大 40 個の英数字記号とスペース文字を含めることができます。

-ArchivingStrategy

Exchange メールボックスポリシーのアーカイブ戦略。設定可能な列挙値は次のとおりです。

  • BasedOnAge または 0。アイテムの経過期間に基づいてアーカイブされます。これはデフォルト値です。

  • BasedOnQuota または 1。各ユーザーの Exchange メールボックスの空き容量の割合を確保するためにアーカイブされます。

  • BasedOnAgeAndQuota または 2。アーカイブ戦略はアイテムの経過日数と、各ユーザーの Exchange メールボックスの空き容量の割合維持に基づきます。タスクは最初に経過日数に基づきアーカイブを実行します。経過日数に基づくアーカイブによってメールボックスの空き容量が必要な割合にならない場合、必要な割合に達するまでアーカイブが続行されます。

-LockArchivingStrategy

Outlook でユーザーがこのポリシーのアーカイブ戦略を変更できないようにするかどうか。デフォルトは $true です。

-ArchiveItemsOlderThan

Exchange メールボックスタスクで、指定した期間に修正されなかったアイテムをアーカイブします。

-ArchiveItemsOlderThanUnits

ArchiveItemsOlderThan で使用する時間の単位。設定可能な列挙値は次のとおりです。

  • Days または 0。

  • Weeks または 1。

  • Months または 2。これはデフォルト値です。

  • Years または 3。

-PercentageOfQuota

アーカイブ戦略に基づいたクォータを実装する場合に、各ユーザーの Exchange メールボックスで確保するストレージ空き容量の割合を指定します。Exchange メールボックスタスクで、各メールボックスのストレージ空き容量が指定した割合に達するまで、アイテムをアーカイブします。

デフォルト値は 10 です。

-MinimumArchiveAge

アーカイブするアイテムの最小経過期間。

デフォルト値は 2 です。

-MinimumArchiveAgeUnits

MinimumArchiveAge で使用する時間の単位。設定可能な列挙値は次のとおりです。

  • Days または 0。

  • Weeks または 1。これはデフォルト値です。

  • Months または 2。

  • Years または 3。

-SizePriority

Exchange メールボックスタスクで、MinimumItemSizeKB より大きいアイテムを優先するかどうか。デフォルトは $false です。

-MinimumItemSizeKB

Exchange メールボックスタスクで、このサイズ (KB) より大きいアイテムを優先します。デフォルトのサイズは 10240 です。

-ArchiveMsgsWithAttachmentsOnly

添付ファイルが存在する場合にのみメールボックスのアイテムをアーカイブするかどうか。デフォルトは $false です。

-ShortcutInactivityPeriod

指定した期間を経過したショートカットを削除します。デフォルト値は 0 です。

-ShortcutInactivityUnits

ShortcutInactivityPeriod で使用する時間の単位。設定可能な列挙値は次のとおりです。

  • Days または 0。これはデフォルト値です。

  • Weeks または 1。

  • Months または 2。

  • Years または 3。

-DeleteAfterArchive

アーカイブにアイテムが正常に格納されたら、Enterprise Vault でメールボックスからそのアイテムを削除するかどうか。デフォルトは $true です。

-LockDeleteAfterArchive

個人用設定でユーザーが DeleteAfterArchive の設定を変更できないようにするかどうか。デフォルトは $true です。

-CreateShortcutAfterArchive

Enterprise Vault で、新しくアーカイブされたアイテムのショートカットを作成するかどうか。デフォルトは $true です。

-LockCreateShortcutAfterArchive

個人用設定でユーザーが CreateShortcutAfterArchive の設定を変更できないようにするかどうか。デフォルトは $true です。

-ArchiveUnreadItems

Enterprise Vault で、読み込まれていないアイテムをアーカイブするかどうか。

-LockArchiveUnreadItems

個人用設定でユーザーが ArchiveUnreadItems の設定を変更できないようにするかどうか。デフォルトは $true です。

-OverallLock

ユーザーが DeleteAfterArchiveCreateShortcutAfterArchiveArchiveUnreadItemsArchivingStrategy の設定を変更できないようにします。

メールボックスのアーカイブにポリシーとアーカイブ先の設定を使用するようにユーザーに強制するには、$true (デフォルト) の値を指定します。

-IncludeRecipientInformation

ショートカットに、宛先と CC の受信者の詳細を含めるかどうか。通常、ショートカットには差出人と件名の情報が含まれます。デフォルトは $true です。

-ContentOfShortcutBody

ショートカットの本文として使う内容。設定可能な列挙値は次のとおりです。

  • None または 0。Enterprise Vault は、元のメッセージ本文を含まないショートカットを生成します。

  • UseMessageBody または 1。Enterprise Vault は、元のメッセージ本文すべてを含むショートカットを生成します。メッセージテキストを Outlook 内で検索して、Outlook のプレビューペインに表示できます。Enterprise Vault は添付ファイルを含む完全なメッセージをアーカイブします。メッセージの本文を保持する場合、ショートカットの容量は本文を保持しない場合よりも大きくなります。添付ファイルがないメッセージの場合、ショートカットの容量は元のメッセージよりも少し大きくなります。

  • Customize または 2。IncludeBannerIncludeLinkToArchivedItemMessageCharsToIncludeDisplayAttachmentsAs を使用して、ショートカットの内容を厳密に制御します。Customize を指定する場合は、Languages フォルダにある適切な ShortcutText.txt ファイルを Enterprise Vault のインストール先フォルダにコピーする必要もあります。

デフォルト値は Customize です。

-IncludeBanner

ショートカットをカスタマイズする場合は、上部にある色付きのバナーをショートカットに含めるかどうかを指定します。ShortcutText.txt ファイルを編集すると、バナーに表示するテキストを修正できます。デフォルトは $false です。

-IncludeLinkToArchivedItem

ショートカットをカスタマイズする場合は、ショートカットにアーカイブ済みアイテムのリンクを含めるように選択しているかどうか。デフォルトは $false です。

MessageCharsToInclude

ショートカットをカスタマイズする場合は、ショートカットに含めるメッセージの本文部分の文字数を指定します。デフォルトは 1000 です。

-DisplayAttachmentsAs

ショートカットをカスタマイズする場合は、Enterprise Vault でショートカットに含める添付ファイル一覧の種類。設定可能な列挙値は次のとおりです。

  • None または 0。添付ファイルは、ショートカットに一覧表示されません。

  • Text または 1。各添付ファイルの件名テキストが一覧表示されます。ユーザーは完全なアーカイブ済みアイテムを開いて、添付ファイルにアクセスする必要があります。

  • Links または 2。アーカイブ済み添付ファイルのリンクの一覧が表示されます。ユーザーは個々の添付ファイルを直接開くことができます。

デフォルト値は None です。

-IndexLevel

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

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

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

デフォルト値は Full です。

-IndexPreviewLength

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

デフォルト値は 128 です。

-CreateAttachmentPreview

Enterprise Vault で、添付ファイルの内容のプレビューを作成するかどうか。このプレビューは、このリリースの Enterprise Vault では表示できません。デフォルトは $false です。

-IsADefaultPolicy

ポリシーがデフォルトのポリシーであるかどうか。デフォルトは $false です。

-Description

Exchange メールボックスポリシーの説明。説明は、最大 127 個の英数字、スペース、または特殊文字を含めることができます。

-SiteId

ポリシーが設定されている Enterprise Vault サイトのディレクトリエントリ ID。

-EntryId

ポリシーのディレクトリエントリ ID。

  • New-EVExchangeMailboxPolicy -Name "Test Policy" -Description "Test policy created using PowerShell"

    「Test Policy created using PowerShell」という説明を加えて、Test Policy という新しい Exchange メールボックスポリシーを作成します。

  • New-EVExchangeMailboxPolicy -Name "Test Policy" -ArchivingStrategy BASEDONAGE -ArchiveItemsOlderThan 3 -ArchiveItemsOlderThanUnits YEARS

    「Test Policy」という新しい Exchange メールボックスポリシーを作成します。アーカイブは経過期間に基づいて実行されます。Enterprise Vault は、3 年以上経過したアイテムをアーカイブします。

出力

なし。

関連コマンドレット