<book_title> を検索 ...

Enterprise Vault™ PowerShell Cmdlets

Last Published: 2024-03-04

Product(s): Enterprise Vault (15.0)

Set-EVRetentionPlan

Set-EVRetentionPlan は、説明、関連付けられた保持カテゴリ、分類ポリシー、保持フォルダなど、既存の保持計画のプロパティを設定または更新します。

保持計画の設定を変更する場合は、適切なプロビジョニングタスクを実行するか、または対象のアーカイブに変更を適用するために適切なアーカイブタスクを再起動する必要があります。たとえば、保持計画を SMTP ターゲットのアーカイブに関連付けた場合は、SMTP アーカイブタスクを再起動する必要があります。Exchange 環境では、Exchange メールボックスアーカイブタスクを再起動し、メールボックスの同期も行う必要があります。

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

構文

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

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

パラメータ

表: Set-EVRetentionPlan パラメータ

パラメータ	説明
-SiteId (必須)	保持計画の詳細を設定または更新する Enterprise Vault サイトの ID。このパラメータを省略して、cmdlet がレジストリ内を検索して ID を特定できない場合、Set-EVRetentionPlan によって必要な ID を入力するためのメッセージが表示されます。 Get-EVSite を使用して、サイト ID を取得することができます。
-Name (必須)	設定または更新対象のプロパティを持つ特定の保持計画の名前。
-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` サブフォルダにあります。分類機能によって各アイテムの保持カテゴリを更新できるようにする分類ポリシーにこの保持計画を関連付けている場合は、保持フォルダについて Expiry を Item (Folder ではなく) に設定する必要があります。絶対パス、相対パス、または UNC パスを入力します。空白文字を含む場合は引用符で囲みます。
-FolderXml	このパラメータは、-FolderXmlPath パラメータと同じ機能を実行します。ただし、この場合は、保持フォルダのプロパティを外部ファイルで定義するのではなく、パラメータに追加する XML 文字列で定義します。新しい保持フォルダを作成することも、既存の保持フォルダを更新または削除することもできます。バッククォート文字 (`) を使用して、この文字列内の引用符をエスケープします。
-DisableStorageExpiry	保持フォルダに問題があるすべてのアーカイブでストレージの有効期限を無効にする場合に、このパラメータを追加します。

例

Set-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」という保持カテゴリがあります。
Set-EVRetentionPlan -Name "Projects Retention Plan" -ClassificationPolicy CP
指定した保持計画の分類ポリシーのプロパティを更新します。
Set-EVRetentionPlan -Name "Projects Retention Plan" -ClassificationPolicy CP -OverrideRetention
指定した保持計画に上書き保持フラグを設定します。アイテムが手動で削除されるか、自動的に期限切れになる場合、計画で設定した保持カテゴリにによって現在の保持カテゴリが上書きされます。ただし、分類ポリシーで各アイテムの保持カテゴリを分類によって更新できるようにしている場合は、-OverrideRetention パラメータを省略する必要があります。Enterprise Vault では、分類ルールによって適用される保持カテゴリに従ってアイテムが期限切れになります。
Set-EVRetentionPlan -SiteId 13E9...localdomain.com -Name "Projects Retention Plan" -Description "Plan updated for managing projects" -RetentionCategory "6 years" -OverrideRetention -ClassificationPolicy CP2
指定されている Enterprise Vault サイトで「Projects Retention Plan」という名前の既存の保持計画のプロパティを更新します。この計画には、「Plan updated for managing projects」という説明と、「6 years」という保持カテゴリがあります。
Set-EVRetentionPlan -SiteId 13E...localdomain.com -Name "Projects Retention Plan" -ClassificationPolicy ''
分類が発生しないように、以前に適用した分類ポリシーを削除します。
Set-EVRetentionPlan -Name "Projects Retention Plan" -FolderXmlPath c:\RetentionFolders.xml -DisableStorageExpiry
ファイル c:\RetentionFolders.xml で定義されている保持フォルダの変更を保持計画「Projects Retention Plan」に適用します。また、このコマンドは、保持フォルダの問題があるアーカイブでストレージの有効期限を無効にします。
たとえば、次の XML で保持フォルダの設定を定義していたとします。
```
<?xml version="1.0" encoding="utf-16"?>
<RetentionFolderRoot>
  <RetentionFolder Name="Inbox" RetentionCategory="1 Year"
    Expiry="Item" Inheritance="ThisFolderOnly" />
  <RetentionFolder Name="Business" RetentionCategory="5 Years"
    Expiry="Item" Inheritance="ThisFolderOnly" />
</RetentionFolderRoot>
```
「Inbox」フォルダを削除し、「Business」フォルダの保持カテゴリを「1 Year」に変更して、「Business」フォルダのサブフォルダとして新しいフォルダ「Unit」を作成するには、次を c:\RetentionFolders.xml として保存し、上記のコマンドで送信します。
```
<?xml version="1.0" encoding="utf-16"?>
<RetentionFolderRoot>
  <RetentionFolder Name="Business" RetentionCategory="1 Year"
    Expiry="Item" Inheritance="ThisFolderOnly">
    <RetentionFolder Name="Unit" RetentionCategory="5 Years"
      Expiry="Item" Inheritance="ThisFolderAndAllSubfolders" />
  </RetentionFolder>
</RetentionFolderRoot>
```
次のコマンドを使用して、計画の保持フォルダ情報を取得できます。
Get-EVRetentionPlan -Name "New Projects Plan" | select -expand Folders | sort FolderPath | ft -AutoSize
このコマンドでは、次の出力が生成されます。
```
FolderPath       FolderName   RetentionCategory   Expiry                Inheritance
----------       ----------   -----------------   ------                -----------
\Business        Business     1 year              Item               ThisFolderOnly
\Business\Unit   Unit         5 years             Item   ThisFolderAndAllSubfolders
```
Set-EVRetentionPlan -Name "Projects Retention Plan" -FolderXml "<?xml version=`"1.0`" encoding=`"utf-16`"?><RetentionFolderRoot><RetentionFolder Name=`"Business`" RetentionCategory=`"1 Year`" Expiry=`"Item`" Inheritance=`"ThisFolderOnly`"><RetentionFolder Name=`"Unit`" RetentionCategory=`"5 Years`" Expiry=`"Item`" Inheritance=`"ThisFolderAndAllSubfolders`" /></RetentionFolder></RetentionFolderRoot>" -DisableStorageExpiry
前の例のコマンドと同じ機能を実行します。ただし、今度は、保持フォルダの変更を XML ファイルで定義するのではなく、コマンドに追加する XML 文字列で定義しています。
Set-EVRetentionPlan -Name "New Projects Plan" -FolderXmlPath C:\RetentionFolders.xml
ファイル c:\RetentionFolders.xml で定義されている保持フォルダの変更を保持計画「Projects Retention Plan」に適用します。このコマンドを使用すると、以前に作成した保持フォルダに、他の言語で別名を指定できます。たとえば、次の XML で保持フォルダの設定を定義していたとします。
```
<?xml version="1.0" encoding="utf-16"?>
<RetentionFolderRoot>
	<RetentionFolder Name="Business" RetentionCategory="1 Year"
		Expiry="Item" Inheritance="ThisFolderOnly" />
	<RetentionFolder Name="Unit" RetentionCategory="5 Years"
		Expiry="Item" Inheritance="ThisFolderOnly" />
</RetentionFolderRoot>
```
次の内容を C:\RetentionFolders.xml として保存し、前述のコマンドで送信すると、デンマーク語ユーザー用にフォルダの別名を提供することができます。
```
<?xml version="1.0" encoding="utf-16"?>
<RetentionFolderRoot>
  <Languages>
    <Language>DA-DK</Language>
  </Languages>
  <RetentionFolder Name="Business" RetentionCategory="1 Year"
    Expiry="Item" Inheritance="ThisFolderOnly">
    <Name lang="DA-DK">Forretning</Name>
  </RetentionFolder>
  <RetentionFolder Name="Unit" RetentionCategory="5 Years"
    Expiry="Item" Inheritance="ThisFolderOnly">
    <Name lang="DA-DK">Enhed</Name>
  </RetentionFolder>
</RetentionFolderRoot>
```
<Languages> ノードで、フォルダの別名を提供する言語を指定できます (デンマーク語の場合は「DA-DK」)。各 <RetentionFolder> ノード内で、フォルダの別名 (「Business」に「Forretning」、「Unit」に「Enhed」) を入力できます。
複数の言語で保持フォルダの代替名を指定する方法について詳しくは、『管理者ガイド』を参照してください。

出力

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

表: Set-EVRetentionPlan プロパティ

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