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

スポンサーリンク

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

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

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

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

■名前

Start-FsspOnDemandScan

■概要

オンデマンド スキャンを開始します。

■構文

Start-FsspOnDemandScan [-ApplicationName <string>]
     [-EnableFileFiltering <Boolean>] [-EnableKeywordFiltering <Boolean>]
     [-EnableVirusScan <Boolean>] [-EngineUsagePolicy <EngineUsageEnum>]
     [-FilteringDeletionText <string>] [-MalwareDeletionText <string>]
     [-SiteList <string[]>] [-SiteScope <SelectedEnum>]
     [-VirusAction <VirusActionEnum>] [-VirusQuarantine <Boolean>]
     [<CommonParameters>]

■説明

オンデマンド スキャンを開始します。このコマンドレットを正常に実行するには、オンデマンド スキャンの状態がSTOPPEDでなければなりません。オンデマンド スキャンの状態を取得するには、次のコマンドレットを実行します。

 Get-FsspOnDemandScan -Status 

既定では、オンデマンド スキャンは、Set-FsspOnDemandScanで指定した設定を使用して開始されます。このコマンドレットで類似の名前付きパラメータを使用して、これらの設定の一部を一時的に上書きできます。上書きを指定すると、オンデマンド スキャンでそれらの値を使用して実行構成が作成されます。指定不可の値または指定を省略した値については、Set-FsspOnDemandScanでの設定値が使用されます。

注意: Set-FsspOnDemandScanで指定した設定が、Start-FsspOnDemandScanで指定した設定に置き換えられることはありません。

■パラメーター

-ApplicationName <string>
現時点では、このパラメータは使用されていません。

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

-EnableFileFiltering <Boolean>
オンデマンド スキャンによるファイル フィルタリングを有効にします。省略可能です。既定では、Set-FsspOnDemandScanで設定された値がオンデマンド スキャンで使用されます。このパラメータでは、その値を上書きできます。指定可能な値は$falseおよび$trueです。値$trueは、オンデマンド スキャンによるファイル フィルタリングが有効であることを示します。

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

-EnableKeywordFiltering <Boolean>
オンデマンド スキャンによるキーワード フィルタリングを有効にします。省略可能です。既定では、Set-FsspOnDemandScanで設定された値がオンデマンド スキャンで使用されます。このパラメータでは、その値を上書きできます。指定可能な値は$falseおよび$trueです。値$trueは、オンデマンド スキャンによるキーワード フィルタリングが有効であることを示します。

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

-EnableVirusScan <Boolean>
オンデマンド スキャンでウイルスをスキャンするかどうかを示します。省略可能です。既定では、Set-FsspOnDemandScanで設定された値がオンデマンド スキャンで使用されます。このパラメータでは、その値を上書きできます。指定可能な値は$falseおよび$trueです。値$trueは、オンデマンド スキャンによるウイルス スキャンが有効であることを示します (スキャンは、Set-FsspOnDemandScanで最後に設定されたウイルス対策エンジンを使用して実行されます)。値を$falseに設定すると、ウイルス スキャンは無効になりますが、ファイル フィルタリングまたはヘッダー フィルタリングは有効のままにできます。

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

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

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

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

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

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

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

-FilteringDeletionText <string>
フィルタと一致したために削除されたファイルの内容の置き換えに使用されるテキストを指定します。省略可能です。既定では、Set-FsspOnDemandScanで設定された値がオンデマンド スキャンで使用されます。このパラメータでは、その値を上書きできます。既定の削除テキストでは、ファイルが削除されたことが受信者に通知され、ファイル名および一致したフィルタ名が示されます。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

-VirusAction <VirusActionEnum>
ウイルスが検出されたときに実行するアクションを示します。省略可能です。既定では、Set-FsspOnDemandScanで設定された値がオンデマンド スキャンで使用されます。このパラメータでは、その値を上書きできます。指定可能な値はSkipDetect (既定値)、CleanおよびDeleteです。

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

-VirusQuarantine <Boolean>
ウイルスが検出されたときにファイルを検疫するかどうかを示します。省略可能です。指定可能な値は$falseおよび$trueです。既定では、Set-FsspOnDemandScanで設定された値がオンデマンド スキャンで使用されます。このパラメータでは、その値を上書きできます。既定値の$trueは、ファイルが感染した場合に、検疫することを示します。

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

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

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

■入力

■出力

■メモ

■例

例1

 Start-FsspOnDemandScan 

例1:説明

Set-FsspOnDemandScanで指定した設定を使用してオンデマンド スキャンを開始します。このコマンドを正常に実行するには、オンデマンド スキャンの現在の状態がSTOPPEDである必要があります。

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

例2

 Start-FsspOnDemandScan -SiteScope Selected -SiteList site1, site2, site3 

例2:説明

Set-FsspOnDemandScanで指定した設定のほとんどを使用してオンデマンド スキャンを開始します。ただし、スキャンを3つの特定のサイトに制限するために、SiteScopeおよびSiteListの設定が上書きされます。このコマンドを正常に実行するには、オンデマンド スキャンの現在の状態がSTOPPEDである必要があります。

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

■関連するリンク

  • Get-FsspOnDemandScan
  • Set-FsspOnDemandScan
  • Stop-FsspOnDemandScan
  • Suspend-FsspOnDemandScan
  • Resume-FsspOnDemandScan

[参考]