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

New-EVRetentionPlan

New-EVRetentionPlan は、Enterprise Vault サイトに対し保持計画を作成します。

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

構文

New-EVRetentionPlan -SiteId <String> -Name <String> -Description <String> -RetentionCategory <String> [-OverrideRetention [<SwitchParameter>]] [-ClassificationPolicy <String>] [-FolderXmlPath <String>] [-DisableStorageExpiry [<SwitchParameter>]] [<CommonParameters>]

New-EVRetentionPlan -SiteId <String> -Name <String> -Description <String> -RetentionCategory <String> [-OverrideRetention [<SwitchParameter>]] [-ClassificationPolicy <String>] [-FolderXml <String>] [-DisableStorageExpiry [<SwitchParameter>]] [<CommonParameters>]

パラメータ

表: New-EVRetentionPlan パラメータ

パラメータ

説明

-SiteId (必須)

保持計画詳細を作成する Enterprise Vault サイトの ID。このパラメータを省略して、cmdlet がレジストリ内を検索して ID を特定できない場合、New-EVRetentionPlan によって必要な ID を入力するためのメッセージが表示されます。

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

-Name (必須)

保持計画の名前。名前は一意である必要があり、最大 40 個の英数字記号とスペース文字を含めることができます。

-Description (必須)

保持計画の説明。説明は、最大 127 個の英数字、スペース、または特殊文字を含めることができます。

-RetentionCategory (必須)

保持計画と関連付ける保持カテゴリの名前。

-OverrideRetention

このパラメータを追加すると、影響を受けるアイテムの現在の保持カテゴリが、この計画に関連付けられている保持カテゴリで上書きされます。

メモ:

分類ルールによってアイテムの保持カテゴリを更新できるようにする分類ポリシーに計画が関連付けられている場合には、このパラメータを省略してください。この場合、Enterprise Vault は分類ルールによって適用される保持カテゴリに従ってアイテムが期限切れになります。

-ClassificationPolicy

保持計画と関連付ける分類ポリシーの名前。これを指定すると、Enterprise Vault は分類ポリシーで指定されたルールに従って、この保持計画を持つすべてのアーカイブ済みアイテムの分類に送信し、タグ付けします。

メモ:

Enterprise Vault 保持機能のライセンスをインストールする必要がある場合、または既存のライセンスが期限切れになった場合、分類はテストモードで動作します。分類機能は、分類タグとその他の変更をアーカイブ済みアイテムに適用する代わりに、計画された変更をリストするレポートを生成します。

-FolderXmlPath

1 つ以上の保持フォルダのプロパティを定義する XML ファイルのパス。保持フォルダと必要な XML ファイルの準備方法のガイドラインについて詳しくは、『管理者ガイド』を参照してください。

Enterprise Vault にはサンプルの XML ファイル RetentionFoldersSample.xml が用意されています。必要に応じて、このファイルをコピーしたり修正したりできます。このファイルは、Enterprise Vault インストールフォルダ (例: C:\Program Files (x86)\Enterprise Vault\Modules\EnterpriseVault) の Modules\EnterpriseVault サブフォルダにあります。

分類機能によって各アイテムの保持カテゴリを更新できるようにする分類ポリシーにこの保持計画を関連付けている場合は、保持フォルダについて ExpiryItem (Folder ではなく) に設定する必要があります。

絶対パス、相対パス、または UNC パスを入力します。空白文字を含む場合は引用符で囲みます。

-FolderXml

このパラメータは、-FolderXmlPath パラメータと同じ機能を実行します。ただし、この場合は、保持フォルダのプロパティを外部ファイルで定義するのではなく、パラメータに追加する XML 文字列で定義します。

バッククォート文字 (`) を使用して、この文字列内の引用符をエスケープします。

-DisableStorageExpiry

保持フォルダに問題があるすべてのアーカイブでストレージの有効期限を無効にする場合に、このパラメータを追加します。

  • New-EVRetentionPlan -SiteId 13E...localdomain.com -Name "Projects Retention Plan" -Description "Plan created for managing projects" -RetentionCategory "5 years"

    指定されている Enterprise Vault サイトに "Projects Retention Plan" という名前の保持計画を作成します。新しい計画には、"Plan created for managing projects" という説明と、"5 years" という保持カテゴリがあります。

  • New-EVRetentionPlan -Name "Projects Retention Plan" -Description "Plan created for managing projects" -RetentionCategory "5 years" -OverrideRetention -ClassificationPolicy "Managers CP"

    指定された説明と保持カテゴリを含む保持計画を作成します。サイト ID が指定されていないため、cmdlet はまずその ID をレジストリ内で検索し、ID が見つからなかった場合は、それを入力するためのメッセージが表示されます。

    アイテムが手動で削除された場合、または自動的に期限切れになった場合、「5 years」の保持カテゴリによってアイテムの現在の保持カテゴリが上書きされます。ただし、「Managers CP」分類ポリシーで各アイテムの保持カテゴリを分類によって更新できるようにしている場合は、-OverrideRetention パラメータを省略する必要があります。Enterprise Vault では、分類ルールによって適用される保持カテゴリに従ってアイテムが期限切れになります。

  • Get-EVRetentionPlan -Name "Existing Retention Plan" | New-EVRetentionPlan -Name "New Retention Plan" -RetentionCategory "1 year"

    既存の保持計画のすべての設定を新しい設定にパイプします。新しい計画では、既存の計画に設定した保持カテゴリではなく、「1 year」の保持カテゴリになります。

  • New-EVRetentionPlan -Name "Projects Retention Plan" -Description "Plan for adding retention folders" -RetentionCategory "5 years" -FolderXmlPath "c:\My XML Files\folders.xml" -DisableStorageExpiry

    指定した XML ファイル folders.xml に保持計画を作成して、保持フォルダのプロパティを 1 つ以上定義します。XML ファイル内でこれらのフォルダに対して定義されている保持設定は、保持計画に関連付けられている「5 年間」の保持カテゴリを上書きします。また、このコマンドは、保持フォルダの問題があるアーカイブでストレージの有効期限を無効にします。

  • New-EVRetentionPlan -Name "Projects Retention Plan" -Description "Plan for New Projects" -RetentionCategory "5 years" -FolderXml "<?xml version=`"1.0`" encoding=`"utf-16`"?><RetentionFolderRoot><RetentionFolder Name=`"Documents`" RetentionCategory=`"5 years`" Expiry=`"Folder`" Inheritance=`"ThisFolderAndAllSubfolders`"/></RetentionFolder>​</RetentionFolderRoot>"

    指定した名前、説明、保持カテゴリで保持計画を作成して、保持フォルダ「Documents」と関連付けます。次のコマンドを使用して、計画の保持フォルダ情報を取得できます。

    Get-EVRetentionPlan -Name "Projects Retention Plan" | select -expand Folders | sort FolderPath | ft -AutoSize

    このコマンドでは、次の出力が生成されます。

    FolderPath    FolderName    RetentionCategory    Expiry                   Inheritance
    ----------    ----------    -----------------    ------                   -----------
    \Documents    Documents     5 years              Folder    ThisFolderAndAllSubfolders
  • New-EVRetentionPlan -Name "New Projects Plan" -Description "Plan for New Projects" -RetentionCategory "5 years" -FolderXml "<?xml version=`"1.0`" encoding=`"utf-16`"?><RetentionFolderRoot>​<Languages><Language>da-DK</Language><Language>zh-cn</Language>​</Languages><RetentionFolder Name=`"Documents`" RetentionCategory=`"5 years`" Expiry=`"Folder`" Inheritance=`"ThisFolderAndAllSubfolders`">​<Name lang="da-DK">Dokumenter</Name><Name lang="Zh-CN">文件</Name></RetentionFolder></RetentionFolderRoot>"

    前述の例のコマンドと同じ機能を実行しますが、通常デンマーク語または簡体字中国語を使用するユーザー向けに、保持フォルダ名の各言語バージョンも提供します。

出力

表: New-EVRetentionPlan プロパティ は、利用可能なプロパティを一覧表示します。

表: New-EVRetentionPlan プロパティ

名前

種類

説明

Name

文字列

保持計画の名前。

Description

文字列

保持計画の説明。

RetentionCategory

文字列

保持計画と関連付けられている保持カテゴリの名前。

OverrideRetention

SwitchParameter

この保持計画に上書き保持フラグを指定したかどうか。

ClassificationPolicy

文字列

保持計画が関連付けられている分類ポリシーの名前。

HasFolders

Boolean

保持計画で、保持フォルダを定義するかどうか。true に設定すると、Folders および FolderXml プロパティに保持フォルダの情報が含まれます。

Folders プロパティには、Format-Table を使用してフォーマットできる表形式の情報が含まれます。

FolderXml プロパティには、ファイルに出力できる XML 形式の情報が含まれます。

DisableStorageExpiry

SwitchParameter

保持フォルダに問題があるすべてのアーカイブで、ストレージの有効期限を無効にするように選択したかどうか。

関連 cmdlet