<book_title> を検索 ...

Enterprise Vault™ PowerShell Cmdlets

Last Published: 2024-03-04

Product(s): Enterprise Vault (15.0)

Get-EVRetentionPlan

Get-EVRetentionPlan は、Enterprise Vault サイトで設定されるすべての保持計画の一覧を返します。返された保持計画の一覧を説明、保持カテゴリ、上書き保持フラグ、分類ポリシー別にフィルタ処理できます。

特定の保持計画とこの計画で定義した保持フォルダ情報のプロパティを返すこともできます。保持フォルダについて詳しくは、『管理者ガイド』を参照してください。

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

構文

Get-EVRetentionPlan [-SiteId <String>] [-Name <String>] [-Description <String>] [-RetentionCategory <String>] [-OverrideRetention [<SwitchParameter>]] [-ClassificationPolicy <String>] [<CommonParameters>]

パラメータ

表: Get-EVRetentionPlan パラメータ

パラメータ	説明
-SiteId	保持計画詳細を返す Enterprise Vault サイトの ID。このパラメータを省略して、cmdlet がレジストリ内を検索して ID を特定できない場合、Get-EVRetentionPlan によって必要な ID を入力するためのメッセージが表示されます。 Get-EVSite を使用して、サイト ID を取得することができます。
-Name	プロパティを返す特定の保持計画の名前。
-Description	返された計画の一覧をフィルタ処理する保持計画説明。
-RetentionCategory	返された保持計画の一覧をフィルタ処理する保持カテゴリの名前。
-OverrideRetention	指定されている場合、上書き保持フラグを設定した保持計画のみを返します。このフラグは Enterprise Vault に、保持計画で設定した保持カテゴリに従って、各アイテムを期限切れにするように指示します。この保持カテゴリは、アイテムの個々の保持カテゴリを上書きします。
-ClassificationPolicy	返された保持計画の一覧をフィルタ処理する分類ポリシーの名前。

例

Get-EVRetentionPlan
Enterprise Vault サイトで設定されているすべての保持計画の一覧を返します。サイト ID が指定されていないため、cmdlet はまずその ID をレジストリ内で検索し、ID が見つからなかった場合は、それを入力するためのメッセージが表示されます。
Get-EVRetentionPlan -SiteId 13E...localdomain.com
指定した Enterprise Vault サイトで設定されるすべての保持計画の一覧を返します。
Get-EVRetentionPlan -SiteId 13E...localdomain.com -Name ManagersPlan
"ManagersPlan" という名前の保持計画のプロパティを返します。
Get-EVRetentionPlan -SiteId 13E...localdomain.com -Description RetentionPlanForManagers
返された保持計画の一覧を "RetentionPlanForManagers" の説明を含むものに制限します。
Get-EVRetentionPlan -SiteId 13E...localdomain.com -RetentionCategory 3years
返された保持計画の一覧を「3years」という保持カテゴリを含むものに制限します。
Get-EVRetentionPlan -OverrideRetention
返された保持計画の一覧を上書き保持フラグを指定したものに制限します。
Get-EVRetentionPlan -ClassificationPolicy "Managers CP"
返された保持計画の一覧を "Managers CP" という分類ポリシー名を含むものに制限します。
Get-EVRetentionPlan -ClassificationPolicy ""
返された保持計画の一覧を分類ポリシーが指定されていない保持計画に制限します。

Get-EVRetentionPlan -Name "ManagersPlan" |select -expand Folders | Format-Table

「ManagersPlan」保持計画で定義されている保持フォルダの情報を返します。次に例を示します。

FolderPath     FolderName RetentionCategory Expiry                Inheritance Language
----------     ---------- ----------------- ------                ----------- --------
\Business      Business   2-year            Folder ThisFolderAndAllSubfolders       en
\Business\2018 2018       5-year              Item ThisFolderAndAllSubfolders       en
\Business\2020 2020       2-year            Folder ThisFolderAndAllSubfolders       en
\Inbox         Inbox      1-year              Item             ThisFolderOnly       en
\Inbox\Finance Finance    2-year            Folder ThisFolderAndAllSubfolders       en
\Inbox\Legal   Legal      5-year              Item             ThisFolderOnly       en

この保持計画の OverrideRetention 設定と ClassificationPolicy 設定では、Expiry (有効期限) の値を有効にするかどうかを決定します。

Get-EVRetentionPlan -Name "ManagersPlanWithAlternateLanguage" |select -expand Folders | Format-Table

「ManagersPlanWithAlternateLanguage」保持計画で定義されている保持フォルダの情報を返します。次に例を示します。

FolderPath          FolderName RetentionCategory Expiry                Inheritance Language
----------          ---------- ----------------- ------                ----------- ---------
\Business           Business   2-year            Folder ThisFolderAndAllSubfolders        en
\Forretning         Forretning 2-year            Folder ThisFolderAndAllSubfolders     da-DK
\Business\Legal     Legal      5-year              Item ThisFolderAndAllSubfolders        en
\Forretning\Gyldige Gyldige    5-year              Item ThisFolderAndAllSubfolders     da-DK

保持計画は、デンマーク語 (da-DK) では別のフォルダ名で作成されました。この場合のデフォルト言語は英語 (en) です。

Get-EVRetentionPlan -Name "ManagersPlan" |select -expand FolderXml
「ManagersPlan」保持計画の保持フォルダの情報を XML 形式で返します。
Get-EVRetentionPlan -Name "ManagersPlan" |select -expand FolderXml | Out-File c:\retention_plan_folders.xml
「ManagersPlan」保持計画の保持フォルダの情報を c:\retention_plan_folders.xml ファイルにエクスポートします。このファイルを編集して、Set-EVRetentionPlan cmdlet で保持フォルダ情報を再送信できます。

出力

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

表: Get-EVRetentionPlan プロパティ

名前	種類	説明
Name	文字列	保持計画の名前。
Description	文字列	保持計画の説明。
RetentionCategory	文字列	保持計画と関連付けられている保持カテゴリの名前。
OverrideRetention	SwitchParameter	この保持計画に上書き保持フラグを指定したかどうか。
ClassificationPolicy	文字列	保持計画と関連付けられている分類ポリシーの名前。
HasFolders	Boolean	保持計画で、保持フォルダを定義するかどうか。true に設定すると、Folders および FolderXml プロパティに保持フォルダの情報が含まれます。 Folders プロパティには、Format-Table を使用してフォーマットできる表形式の情報が含まれます。 FolderXml プロパティには、ファイルに出力できる XML 形式の情報が含まれます。このファイルを編集して、Set-EVRetentionPlan cmdlet で保持フォルダ情報を再送信できます。
DisableStorageExpiry	SwitchParameter	保持フォルダに問題があるすべてのアーカイブで、ストレージの有効期限を無効にするように選択したかどうか。

保持計画を使用できない場合、または cmdlet によって指定の条件と一致する計画が見つからない場合は、適切なエラーメッセージが出力されます。