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

スポンサーリンク

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

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

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

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

■名前

Set-FsspRealtimeFilter

■概要

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

■構文

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

Set-FsspRealtimeFilter -Keyword -List <string> [-Action <SPRealtimeFilterActionEnum>]
     [-Enabled <Boolean>] [-MinimumUniqueHits <UInt32>] [-Quarantine <Boolean>]
     [-SuppressFilterNotifications <Boolean>] [<CommonParameters>]

Set-FsspRealtimeFilter -List <string> -User [-Enabled <Boolean>]
     [<CommonParameters>]

■説明

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

次の3種類のフィルタ リストを使用できます。ファイル フィルタ リスト、キーワード フィルタ リスト、およびユーザー フィルタ リストです (ユーザー フィルタ リストは内部リストであり、PowerShellで管理者が直接使用するためのものではありません。) それぞれ個別のパラメータ セット (-Fileおよび -Keyword) を各パラメータの前に使用して構成します。フィルタ名は各フィルタの種類内で一意です。

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

  • -Enabled $false
  • -Action SkipDetect
  • -Quarantine $true

■パラメーター

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

“SkipDetect”は、一致が検出された場合、レコードは保持されるがファイルはアップロードまたはダウンロード可能であることを意味します。

“Suspend”は、ユーザーによるファイルのアップロードまたはダウンロードがブロックされることを意味します。

フィルタ リストが作成されると、SkipDetectの既定値が割り当てられます。Set-FsspRealtimeFilterに値を指定しなかった場合、既定の設定が維持されます。

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

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

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

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

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

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

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

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

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

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

-MinimumUniqueHits <UInt32>
アクションが起動されるために必要な一意なキーワードの最小ヒット数を指定します。省略可能です。このパラメータは、キーワード フィルタ専用です。既定は1です。たとえば、一意なキーワードの最小ヒット数に3を設定したとします。リスト内にある”wonderful”という語はドキュメントに3回出現します。一方、リストに含まれている他の単語はまったく出現しませんでした。リストに含まれている一致項目が1つだけなので、キーワード フィルタは一致とは見なされません。

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

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

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

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

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

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

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

-User [<SwitchParameter>]
Forefront Protection 2010 for SharePointリアルタイム スキャンに関連付けられていて、有効なユーザー フィルタ リストであることを示します。この種類のフィルタ リストは、ユーザー禁止一覧を作成してSharePointポータルへのユーザー アクセスを防ぐ目的でSecurity Assessment Sharing (SAS) によって使用されます。これは、Windows PowerShellで管理者が直接使用するためのものではありません。これはリアルタイム スキャンのみを表す内部パラメータです。

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

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

■入力

■出力

■メモ

■例

例1

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

例1:説明

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

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

例2

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

例2:説明

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

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

例3

 Set-FsspRealtimeFilter -Keyword -List &quot;Opportunity&quot; -Enabled $true -Action Suspend 

例3:説明

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

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

■関連するリンク

  • Get-FsspRealtimeFilter
  • New-FsspFilterList

[参考]