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

スポンサーリンク

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

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

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

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

■名前

Set-FsspOnDemandScan

■概要

オンデマンド スキャンの構成オプションを設定します。

■構文

Set-FsspOnDemandScan [-DocFilesAsContainers <Boolean>]
     [-EnableFileFiltering <Boolean>] [-EnableKeywordFiltering <Boolean>]
     [-EnableVirusScan <Boolean>] [-EngineUsagePolicy <EngineUsageEnum>]
     [-FileFilteringSkipScanofCompressedFiles <Boolean>]
     [-FilteringDeletionText <string>] [-MalwareDeletionText <string>]
     [-MaxContainerScanTime <int>] [-Priority <PriorityEnum>]
     [-SiteList <GenericStringList>] [-SiteScope <SelectedEnum>]
     [-SuppressMalwareNotifications <Boolean>] [-VirusAction <VirusActionEnum>]
     [-VirusQuarantine <Boolean>] [<CommonParameters>]

■説明

オンデマンド スキャンのカスタマイズを有効にします。設定できるパラメータには次のようなものがあります。ウイルス スキャンの有効化、キーワード フィルタリングの有効化、エンジンの使用ポリシー、ウイルス検出アクション、検疫などです。さらに、スキャンする対象のサイトを選択できます。

■パラメーター

-DocFilesAsContainers <Boolean>
構造化ストレージと OLE 埋め込みデータ形式 (.doc、.xls、.ppt、.shsなど) をコンテナ ファイルとして使用するファイルをスキャンするかどうかを指定します。省略可能です。指定可能な値は$falseおよび$trueです。既定値の$trueは、構造化ストレージを使用するファイルがコンテナ ファイルとしてスキャンされることを意味します。

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

-EnableFileFiltering <Boolean>
オンデマンド スキャンによるファイル フィルタリングを有効または無効にします。省略可能です。指定可能な値は$falseおよび$trueです。既定値の$trueは、定期スキャンによるファイル フィルタリングが有効になっていることを示します。

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

-EnableKeywordFiltering <Boolean>
キーワード フィルタリングを有効または無効にします。省略可能です。指定可能な値は$falseおよび$trueです。既定値の$trueは、キーワードのフィルタリングが実行されることを示します。

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

-EnableVirusScan <Boolean>
ウイルス スキャンを有効または無効にします。省略可能です。指定可能な値は$falseおよび$trueです。既定値の$trueは、オンデマンド スキャンで特定のウイルス対策エンジンを使用してウイルスをスキャンすることを示します。値を$falseに設定すると、ウイルス スキャンは無効になりますが、フィルタリングは有効のままになります。

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

-EngineUsagePolicy <EngineUsageEnum>
Forefront Protection 2010 for SharePointがファイルの内容のスキャンに使用するエンジン数を決める際に参照するインテリジェント エンジン選択ポリシーを指定します。省略可能です。使用するエンジンが多いほど、すべてのウイルスが検出される可能性が高くなります。ただし、使用するエンジンが多いほど、システム パフォーマンスへの影響も大きくなります。エンジンは、Set-FsspEngineManagementを使用して指定されます。

指定可能な値は次のとおりです。

  • All – 選択したすべてのエンジンでスキャンします。
  • Available – 選択したすべての利用可能なエンジンでスキャンします。既定値です。
  • Dynamic – 選択したエンジンの、動的に選択されるサブセットでスキャンします。
  • One – 動的に選択される1つのエンジンでスキャンします。

“All”と”Available”の相違点は次のとおりです。更新のためにエンジンをオフラインにすると、”All”の場合、そのエンジンが再開されるまでメール フローがキューに入れられ、”Available”の場合、残りのエンジンを使用してスキャンが続行されます。

注意: -EngineUsagePolicyは、以前は”Bias”と呼ばれていました。

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

-FileFilteringSkipScanofCompressedFiles <Boolean>
“SkipDetect”アクションが圧縮ファイルの種類のファイル フィルタに適用された場合の、このアクションの動作を指定します。省略可能です。Set-FsspOnDemandFilterを使用して、オンデマンド スキャン用のフィルタを構成します。指定可能な値は $false (既定値) および$trueです。

Forefront Protection 2010 for SharePointの標準機能では、ファイル フィルタを適用して、圧縮ファイルの内容がスキャンされます。圧縮ファイルの内容にファイル フィルタが適用されないようにするには、ファイル フィルタを作成し、アクションを”SkipDetect”に設定します。ただし、これが既定で機能するのは、.zipファイル、JARファイル、およびOPENXMLファイルのみです。

この機能を自己解凍実行可能ファイル (SMIME ファイル、.gzip アーカイブ ファイル、.rarアーカイブ ファイル、TARアーカイブ ファイル、およびMACBINバイナリ ファイル) でも有効にするには、このパラメータの値を$trueに設定します。その場合、アクションが”SkipDetect”に設定されているファイル フィルタにコンテナが一致するときは、これらの追加のファイルの種類内ではファイル フィルタリングが実行されません。

コマンドが連携するしくみの詳細な説明については、例を参照してください。

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

-FilteringDeletionText <string>
フィルタと一致したために削除されたファイルの内容の置き換えに使用されるテキストを指定します。省略可能です。既定の削除テキストでは、ファイルが削除されたことが受信者に通知され、ファイル名および一致したフィルタ名が示されます。

FilteringDeletionTextパラメータを使用して、キーワード置換マクロを含む、独自のカスタム テキストを入力できます。マクロは、アポストロフィで囲む必要があります (例: -FilteringDeletionText “‘%Filter%’ フィルタと一致したため、’%File%’ が削除されました”)。

削除テキストは最大8,192文字です (引用符で囲む)。

既定値: “Microsoft Forefront Protection for SharePointは、フィルタの一致を検出したため、ファイルを削除しました。ファイル名: ‘%File%’ フィルタ名: ‘%Filter%'”

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

-MalwareDeletionText <string>
“Delete”アクション中に、感染したファイルの内容を置き換えるために使用されるテキストを指定します。省略可能です。既定の削除テキストでは、ファイルが削除されたことが、ファイル名と見つかった悪意のあるソフトウェアの名前と共に通知されます。

MalwareDeletionTextパラメータを使用して、キーワード置換マクロを含む、独自のカスタム テキストを入力できます。マクロは、アポストロフィで囲む必要があります (例: -MalwareDeletionText “このファイルはウイルスに感染しています: ‘%File%’ マルウェア名: ‘%Malware%'”)。

削除テキストは最大8,192文字です (引用符で囲む)。

既定値: “Microsoft Forefront Protection for SharePoint は、ファイルの感染を検出したため、ファイルを削除しました。ファイル名: ‘%File%’ マルウェア名: ‘%Malware%'”。

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

-MaxContainerScanTime <int>
圧縮された添付ファイルのスキャン時にオンデマンド スキャンがタイムアウトになるまでの時間を秒単位で指定します。省略可能です。有効な値の範囲は、60~86400秒です (境界を含む)。既定値は600です。

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

-Priority <PriorityEnum>
オンデマンド スキャンの CPU 優先度を示します。省略可能です。指定可能な値はNormal (既定値)、BelowNormal、およびLowです。設定をBelowNormalまたはLowに変更することで、サーバー リソースへの需要が高いときに重要なジョブの優先度を高くすることができます。

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

-SiteList <GenericStringList>
-SiteScopeが”Selected”に設定されている場合にスキャンされるサイトを示します。省略可能です。複数のアイテムを配列として入力します。以下は、選択したサイトを示すリストの例です。

 $SitesToScan = site1,site3,site6
Set-FsspOnDemandScan -SiteScope Selected -SiteList $SitesToScan 

注意: ホスト名を使用する必要があります。IPアドレスの使用はサポートされていません。

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

-SiteScope <SelectedEnum>
スキャンするサイトの範囲を指定します。省略可能です。指定可能な値はAll (既定値)、None、およびSelectedです。”Selected”を選択する場合は、-SiteListパラメータを使用してスキャンするサイトを示してください。”None”を指定すると、サイトはスキャンされません。

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

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

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

-VirusAction <VirusActionEnum>
ウイルスが検出されたときに実行するアクションを示します。省略可能です。指定可能な値はSkipDetect (既定値)、CleanおよびDeleteです。

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

-VirusQuarantine <Boolean>
ウイルスが検出されたときにファイルを検疫するかどうかを示します。省略可能です。指定可能な値は$falseおよび$trueです。 既定値の$trueは、ファイルが感染した場合に、検疫することを示します。

注意: ファイルは、指定されている -VirusActionに関係なく検疫できます。

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

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

■入力

■出力

■メモ

■例

例1

 Set-FsspOnDemandScan -EngineUsagePolicy All 

例1:説明

エンジン使用ポリシーを”All”に変更して、選択したすべてのエンジンが毎回のスキャンで使用されるように指定します。エンジンの選択は、Set-FsspEngineManagementコマンドレットを使用して行うことに注意してください。

コマンドが正常に完了した場合は、何も出力されません。

例2

 Set-FsspOnDemandScan -MalwareDeletionText &quot; The '%Malware%' malicious software was found in the file named '%File%'.&quot; -FilteringDeletionText &quot;The '%File%' file was found to match the '%Filter%' filter.&quot; 

例2:説明

両方の削除テキスト項目の古い値は、指定した値に変更されます。

コマンドが正常に完了した場合は、何も出力されません。

例3

New-FsspFilterList -File -List &quot;RahRah&quot; -Item &quot;*.rar&quot;
New-FsspFilterList -File -List &quot;Ghi&quot; -Item &quot;ghi.exe&quot;
Set-FsspOnDemandFilter -File -List &quot;RahRah&quot; -Action SkipDetect -Enabled $true
Set-FsspOnDemandFilter -File -List &quot;Ghi&quot; -Action Delete -Enabled $true
Set-FsspOnDemandScan -FileFilteringSkipScanOfCompressedFiles $false -VirusAction &quot;Delete&quot;

例3:説明

.rarファイルをフィルタリングする場合の例です。”Innocent.rar”という.rarファイルを想定します。これには、次の3つのファイルが含まれます。

  • eicar.com
  • abc.def
  • ghi.exe

“RahRah”という名前のフィルタを設定し、”.rar”という拡張子を持つすべてのファイルを見つけ出します。一致した場合は、フィルタが、”SkipDetect”のアクションでオンデマンド スキャンに割り当てられます。

“Ghi”という名前のフィルタを設定し、”ghi.exe”という名前のすべてのファイルを見つけ出します。一致した場合は、フィルタが、”Delete”のアクションでオンデマンド スキャンに割り当てられます。

-FileFilteringSkipScanOfCompressedFilesパラメータが$falseに設定されています。これは既定値であるため、明示的に設定する必要はありません。

Innocent.rarのスキャン結果は次のとおりです。

  1. “*.rar”で捕捉されますが、アクションはSkipDetectであるため、単なる通知です。
  2. 内容に対するウイルス スキャンが実施されます。Eicar.comは、設定されているウイルス アクションであるため削除されます。
  3. 内容はファイル フィルタの対象です。そのため、”ghi.exe”は削除されます。

ここでは、-FileFilteringSkipScanOfCompressedFilesパラメータが$trueに設定されていると仮定します。

結果3.を除き、すべてがまったく同じです。現在は、次のようになっています。内容は、ファイル フィルタの対象ではありません。そのため、”ghi.exe”は削除されません。

コマンドが正常に完了した場合は、何も出力されません。

■関連するリンク

  • Get-FsspOnDemandScan
  • Start-FsspOnDemandScan
  • Stop-FsspOnDemandScan
  • Suspend-FsspOnDemandScan
  • Resume-FsspOnDemandScan

[参考]