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

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

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

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

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

■名前

Set-FseTransportFilter

■概要

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

■構文

Set-FseTransportFilter [-AllowedSender] -List <string> [-Enabled <Boolean>]
[-SkipFiltering <SkipFilteringEnum[]>] [<CommonParameters>]

Set-FseTransportFilter [-File] [[-Keyword]] -List <string>
[-Action <TransportActionEnum>] [-Enabled <Boolean>]
[-IdentifyIn <IdentifyEnum[]>] [-Order <int>] [-Quarantine <boolean>]
[-SuppressFilterNotifications <Boolean>] [<CommonParameters>]

Set-FseTransportFilter [-Keyword] -List <string> [-Action <TransportActionEnum>]
[-Enabled <Boolean>] [-IdentifyIn <IdentifyEnum[]>]
[-InboundDirection <Boolean>] [-InternalDirection <Boolean>]
[-MinimumUniqueHits <int>] [-OutboundDirection <Boolean>]
[-Quarantine <boolean>] [-SuppressFilterNotifications <Boolean>]
[<CommonParameters>]

Set-FseTransportFilter [-SenderDomain] [[-Keyword]] -List <string>
[-Action <TransportActionEnum>] [-Enabled <Boolean>]
[-IdentifyIn <IdentifyEnum[]>] [-Quarantine <boolean>]
[-SuppressFilterNotifications <Boolean>] [<CommonParameters>]

Set-FseTransportFilter [-Subject] -List <string> [-Action <TransportActionEnum>]
[-Enabled <Boolean>] [-IdentifyIn <IdentifyEnum[]>] [-Quarantine <boolean>]
[-SuppressFilterNotifications <Boolean>] [<CommonParameters>]

■説明

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

次の5種類のフィルターリストを使用できます。

許可された送信者リスト
ファイルフィルターリスト
キーワードフィルターリスト
件名フィルターリスト
送信者ドメインフィルターリスト

それぞれ個別のパラメーターセット (-AllowedSender、-File、-Keyword、-Subject、および -SenderDomain) を各パラメーターの前に使用して構成します。フィルター名は各フィルターの種類内で一意です。

既定では、新しいフィルターには、トランスポートスキャン用の次のプロパティが設定されています。

ファイルフィルター: -Enabled $false -Action Delete -Quarantine $true -IdentifyIn Subject
キーワードフィルター: -Enabled $false -Action Identify -Quarantine $true -IdentifyIn Subject -MinimumUniqueHits 1 -InboundDirection $true -OutboundDirection $true -InternalDirection $true
送信者ドメインフィルターと件名フィルター: -Enabled $false -Action Identify -Quarantine $true -IdentifyIn Subject
許可された送信者: -Enabled $false -Action <none – アクションは許可された送信者リストに適用されません> -Quarantine $true -SkipFiltering File,Subject,SenderDomain,Keyword

■パラメーター

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

注意: -Actionパラメーターは、-AllowedSenderリストと共には使用されません。

“SkipDetect” (すべてのフィルターリスト) は、一致が検出された場合、レコードは保持されるがメッセージは通常どおり配信可能であることを意味します。

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

“Delete” (キーワードフィルターリストでは使用されない) は、メッセージから添付ファイルを削除し、代わりに削除テキストを挿入します。

“Identify” (すべてのフィルターリスト) は、検出されたメッセージの件名またはメッセージヘッダー (-IdentifyInパラメーターで指定) に、カスタマイズ可能な単語またはフレーズ (タグテキスト) でタグを付加できるように指定します。タグテキストが含まれるメッセージは、(特定のメールボックスへのルーティングや、Microsoft Forefront Protection 2010 for Exchange Server管理コンソールで指定されているその他の目的などの) 特別な処理のために後で識別できます。-IdentifyInパラメーターを使用すると、次の3つの識別アクションを設定できます。

件名で識別 (Subject)
メッセージヘッダーで識別 (MessageHeader)
件名とメッセージヘッダーで識別 (Subject,MessageHeader)

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

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

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

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

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

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

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

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

-IdentifyIn <IdentifyEnum[]>
アクション”Identify”が選択されている場合にタグを付加する場所を指定します。省略可能です。指定可能な値はSubject (メッセージの件名にタグテキストを配置します) とMessageHeader (メッセージのヘッダーにタグテキストを配置します) です。両方の場所にタグテキストを配置するには、両方の値を配列として入力します。つまり、「”Subject”, “MessageHeader”」と入力します。既定値は”Subject”です。

タグテキストは、Set-FseTransportScanコマンドレットの -TagTextSubjectパラメーターと -TagTextHeaderパラメーターを使用して設定します。

注意: -IdentifyInパラメーターは、-AllowedSenderリストと共には使用されません。

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

-InboundDirection <Boolean>
組織外から送信されたメッセージがこのフィルターリストでスキャンされるように指定します。指定可能な値は$falseおよび$trueです。既定値の$trueは、受信メッセージがスキャンされることを示します。このパラメーターは、-Keywordパラメーターセットと併用する場合のみ使用できます。

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

-InternalDirection <Boolean>
組織内で送信されたメッセージがこのフィルターリストでスキャンされるように指定します。指定可能な値は$falseおよび$trueです。既定値の$trueは、内部メッセージがスキャンされることを示します。このパラメーターは、-Keywordパラメーターセットと併用する場合のみ使用できます。

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

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

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

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

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

-MinimumUniqueHits <int>
アクションが起動されるために必要な一意なキーワードの最小ヒット数を指定します。省略可能です。既定は 1 です。たとえば、一意なキーワードの最小ヒット数に3を設定したとします。フィルタリング対象のキーワードのリスト内にある”wonderful”という単語はドキュメントに3回出現します。一方、リストに含まれている他の単語はまったく出現しませんでした。リストに含まれている一致アイテムが1つだけなので、条件を満たしません。このパラメーターは、-Keywordパラメーターセットと併用する場合のみ使用できます。

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

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

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

-OutboundDirection <Boolean>
組織から外部に送信されたメッセージがこのフィルターリストでスキャンされるように指定します。指定可能な値は$falseおよび$trueです。既定値の$trueは、送信メッセージがスキャンされることを示します。このパラメーターは、-Keywordパラメーターセットと併用する場合のみ使用できます。

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

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

注意: -Quarantineパラメーターは、-AllowedSenderリストと共には使用されません。

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

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

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

-SkipFiltering <SkipFilteringEnum[]>
スキップするフィルタリングの種類を示します。省略可能です。指定可能な値は File、Keyword、および Content (件名および送信者ドメインフィルタリングを含む) です。複数の種類は配列として入力されます (例: 「File, Keyword」)。このパラメーターを使用すると、特定の種類のフィルタリングを無視できます。ただし、マルウェアスキャンには影響しません。

注意: -SkipFilteringパラメーターは必ず -AllowedSenderパラメーターセットと共に使用します。つまり、指定した送信者リストに対して、特定の種類のフィルタリングをスキップできます。

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

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

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

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

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

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

■入力

■出力

■メモ