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

■入力

■出力

■メモ

■例

例1

 Set-FseTransportFilter -File -List &quot;List1&quot; -Enable $true 

例1:出力結果

There is no output if the command completes successfully.

例1:説明

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

例2

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

例2:出力結果

There is no output if the command completes successfully.

例2:説明

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

例3

 Set-FseTransportFilter -Keyword -List &quot;Banned Words&quot; -Enabled $true -Action Purge -MinimumUniqueHits 3 -InternalDirection $false 

例3:出力結果

There is no output if the command completes successfully.

例3:説明

トランスポート スキャンに対して”Banned Words”キーワード フィルター リストを有効にします。リスト内に一致する単語またはフレーズが3つ以上存在する場合、メッセージは削除されます。内部メールはフィルタリングされません。このフィルターでは、-Quarantine、-InboundDirection、および -OutboundDirectionの既定の設定が使用されます。

例4

 Set-FseTransportFilter -Keyword -list &quot;Questionable Words&quot; -Action Identify -IdentifyIn Subject, MessageHeader -OutboundDirection $false -Enabled $true 

例4:出力結果

There is no output if the command completes successfully.

例4:説明

“Questionable Words”キーワード フィルター リストを有効にしてメッセージをスキャンします。リスト内に一致するアイテムが存在する場合、件名とメッセージ ヘッダーの両方にタグ テキストが配置されます。組織外へのメッセージはスキャンされませんが、組織内へのメッセージと組織内で送信されたメッセージはスキャンされます (既定として変更されていません)。

例5

 Set-FseTransportFilter -AllowedSender -List &quot;ApprovedSenders&quot; -Enabled $true -SkipFiltering File, Keyword, Subject, SenderDomain 

例5:出力結果

There is no output if the command completes successfully.

例5:説明

“ApprovedSenders”フィルター リストを有効にします。リスト内の送信者からのメッセージに対しては、すべての種類のフィルタリングがスキップされます。

■関連するリンク

  • Get-FseTransportFilter

[参考]