FPE 2010のForefront管理シェルで使用できるコマンドレット (Set-FseRealtimeFilter) について

スポンサーリンク

Forefront Protection 2010 for Exchange Server (FPE 2010) のForefront管理シェルは、PowerShellを用いたコマンドラインインタフェースです。

Forefront管理シェルは、FPE 2010の管理を目的として様々なコマンドレットが用意されていますが、 オンライン上では説明のみで詳細なコマンド オプション情報については公開されていないようです。

このヘルプ情報について、オンライン上で日本語として確認したいと思い、本ブログ上で纏めたいと思います (内容については「Get-Help」コマンドレットの-Fullオプションを用いて実行した結果を編集したものとなります)。

この記事では、「Set-FseRealtimeFilter」コマンドレットについて記載します (他のコマンドレットについては、「FPE 2010のForefront管理シェルで使用できるコマンドレットについて」を参照)。

■名前

Set-FseRealtimeFilter

■概要

フィルター リストをリアルタイム スキャンで使用できるように構成します。

■構文

Set-FseRealtimeFilter -File -List <string> [-Action <RealtimeFilterActionEnum>]
     [-Enabled <Boolean>] [-Order <int>] [-Quarantine <Boolean>]
     [-SuppressFilterNotifications <Boolean>] [<CommonParameters>]

Set-FseRealtimeFilter -List <string> –SenderDomain
     [-Action <RealtimeFilterActionEnum>] [-Enabled <Boolean>]
     [-Quarantine <Boolean>] [-SuppressFilterNotifications <Boolean>]
     [<CommonParameters>]

Set-FseRealtimeFilter -List <string> -Subject [-Action <RealtimeFilterActionEnum>]
     [-Enabled <Boolean>] [-Quarantine <Boolean>]
     [-SuppressFilterNotifications <Boolean>] [<CommonParameters>]

■説明

フィルター リストをリアルタイム スキャンで使用できるように構成します。New-FseFilterListで作成された新しいフィルター リストはすべて、リアルタイム スキャンに自動的に関連付けられます。

次の3種類のフィルター リストを使用できます。ファイル フィルター リスト、件名フィルター リスト、および送信者ドメイン フィルター リスト。それぞれ個別のパラメーター セット (-File、-Subject、および -SenderDomain) を各パラメーターの前に使用して構成します。フィルター名は各フィルターの種類内で一意です。

既定では、新しいフィルターには、次のプロパティが設定されています。

  • File filters: -Enabled $false -Action Delete -Quarantine $true
  • 送信者ドメイン フィルターと件名フィルター: -Enabled $false -Action SkipDetect -Quarantine $true

■パラメーター

-Action <RealtimeFilterActionEnum>
アイテムがフィルター リストの条件に一致した場合に実行されるアクションを指定します。省略可能です。指定可能な値は SkipDetect、Purge、およびDelete (ファイル フィルター リストのみ) です。

“SkipDetect”は、一致が検出された場合、レコードは保持されるがメッセージは通常どおり配信可能であることを意味します。

“Purge”は、メール システムからメッセージを削除します。検疫が有効になっていない場合、メッセージを復元できなくなります。

“Delete”は、メッセージから添付ファイルを削除し、代わりに削除テキストを挿入します。

フィルター リストが作成されると、既定値が割り当てられます。ファイル フィルター リストの場合、既定値は”Delete”です。件名リストおよび送信者ドメイン リストの場合、既定値は”SkipDetect”です。Set-FseRealtimeFilterに値を指定しなかった場合、既定の設定が維持されます。

必須false
位置named
既定値
パイプライン入力を許可するtrue (ByValue, ByPropertyName)
ワイルドカード文字を許可するfalse

-Enabled <Boolean>
フィルター リストを有効または無効にします。省略可能です。指定可能な値は$falseおよび$trueです。値を指定しなかった場合、現在の設定が維持されます。フィルター リストが作成されると、既定で値$falseが割り当てられます。

必須false
位置named
既定値
パイプライン入力を許可するtrue (ByValue, ByPropertyName)
ワイルドカード文字を許可するfalse

-File [<SwitchParameter>]
構成中のファイル フィルター リストであることを示すパラメーター セットです。必須です。いずれか1つのパラメーター セットを選択する必要があります。-File、-SenderDomain、または -Subjectです。

必須true
位置named
既定値
パイプライン入力を許可するfalse
ワイルドカード文字を許可するfalse

-List <string>
構成する1つの既存のフィルター リストの名前です。必須です。フィルター名では、大文字と小文字が区別されます。文字列に英数字以外の文字やスペースを含める場合は、引用符で囲んでください。フィルター名は種類内で一意です。

フィルター リストは、New-FseFilterListを使用して作成されます。

必須true
位置named
既定値
パイプライン入力を許可するtrue (ByValue, ByPropertyName)
ワイルドカード文字を許可するfalse

-Order <int>
リアルタイム スキャン時のファイル フィルター リストの適用順序を指定します。省略可能です。値は1から始まる自然数であり、最大値はありません。New-FseFilterListを使用してファイル フィルター リストを作成すると、使用可能な次の番号が自動的に割り当てられます。ファイル フィルターの順序を変更する必要がある場合は、-Orderパラメーターを使用できます。

必須false
位置named
既定値(1 greater than highest existing position)
パイプライン入力を許可するfalse
ワイルドカード文字を許可するfalse

-Quarantine <Boolean>
フィルター リストが一致したときにファイルを検疫するかどうかを示します。省略可能です。指定可能な値は$falseおよび$trueです。値$trueは、フィルター リストが作成されたときに既定で割り当てられ、フィルター リストが一致したときにファイルを検疫する必要があることを示します。値を指定しなかった場合、現在の設定が維持されます。

必須false
位置named
既定値
パイプライン入力を許可するtrue (ByValue, ByPropertyName)
ワイルドカード文字を許可するfalse

-SenderDomain [<SwitchParameter>]
構成中の送信者ドメイン フィルター リストであることを示すパラメーター セットです。必須です。いずれか1つのパラメーター セットを選択する必要があります。-File、-SenderDomain、または -Subjectです。この種類のフィルターは、メッセージ ヘッダー内の指定した送信者またはドメインをスキャンします。

必須true
位置named
既定値
パイプライン入力を許可するfalse
ワイルドカード文字を許可するfalse

-Subject [<SwitchParameter>]
構成中の件名フィルター リストであることを示すパラメーター セットです。必須です。いずれか1つのパラメーター セットを選択する必要があります。-File、-SenderDomain、または -Subjectです。この種類のフィルターは、メッセージ ヘッダー内の指定した件名の内容をスキャンします。

必須true
位置named
既定値
パイプライン入力を許可するfalse
ワイルドカード文字を許可するfalse

-SuppressFilterNotifications <Boolean>
このスキャン ジョブによってこのフィルターと一致したときに通知を送信するかどうかを示します。省略可能です。指定可能な値は$falseおよび$trueです。既定値の$falseは、フィルター通知が有効な場合は、それらが送信されることを示します。Set-FseNotificationで無効にされている場合、このパラメーターは効力を持ちません。

必須false
位置named
既定値$false
パイプライン入力を許可するfalse
ワイルドカード文字を許可するfalse

<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: VerboseDebugErrorActionErrorVariableWarningActionWarningVariableOutBuffer、およびOutVariable。詳細については、「get-help about_commonparameters」と入力してヘルプを参照してください。

■入力

■出力

■メモ

■例

例1

 Set-FseRealtimeFilter -File -List &quot;List1&quot; -Enabled $true 

例1:出力結果

There is no output if the command completes successfully.

例1:説明

“List1″というファイル フィルター リストを有効にします。既定の”Delete”アクションと検出されたファイルの検疫は維持されます。

例2

 Set-FseRealtimeFilter -File -List &quot;List1&quot; -Enabled $false 

例2:出力結果

There is no output if the command completes successfully.

例2:説明

“List1″というファイル フィルター リストを無効にします。新しいフィルター リストが既定で無効になっているため、このフィルター リストが以前に有効になっていたことが想定されます。

例3

 Set-FseRealtimeFilter -Subject -List &quot;Opportunity&quot; -Enabled $true -Action Purge 

例3:出力結果

There is no output if the command completes successfully.

例3:説明

“Opportunity”という件名フィルター リストを有効にします。アクションは”Purge”に設定されます。

例4

 Set-FseRealtimeFilter -SenderDomain -List &quot;BadSenders&quot; -Enabled $true -Action Delete -Quarantine $false 

例4:出力結果

There is no output if the command completes successfully.

例4:説明

“BadSenders”という送信者ドメイン フィルター リストを有効にします。アクションは”Delete”に設定され、フィルター条件に一致したファイルは検疫されません。

■関連するリンク

  • Get-FseRealtimeFilter

[参考]