Forefront Protection 2010 for SharePoint (FPSP 2010) のForefront管理シェルは、PowerShellを用いたコマンドラインインタフェースです。
Forefront管理シェルは、FPSP 2010の管理を目的として様々なコマンドレットが用意されていますが、 オンライン上では説明のみで詳細なコマンド オプション情報については公開されていないようです。
このヘルプ情報について、オンライン上で日本語として確認したいと思い、本ブログ上で纏めたいと思います (内容については「Get-Help」コマンドレットの-Fullオプションを用いて実行した結果を編集したものとなります)。
この記事では、「Set-FsspScheduledFilter」コマンドレットについて記載します (他のコマンドレットについては、「FPSP 2010のForefront管理シェルで使用できるコマンドレットについて」を参照)。
■名前
Set-FsspScheduledFilter
■概要
フィルタ リストを定期スキャンで使用できるように構成します。
■構文
| Set-FsspScheduledFilter -List <string> [-Action <SPScheduledFilterActionEnum>] [-Enabled <Boolean>] [-File] [-Order <int>] [-Quarantine <Boolean>] [-SuppressFilterNotifications <Boolean>] [<CommonParameters>] Set-FsspScheduledFilter [-Keyword] -List <string> |
■説明
フィルタ リストを定期スキャンで使用できるように構成します。New-FsspFilterListで作成された新しいフィルタ リストはすべて、定期スキャンに自動的に関連付けられます。
次の2種類のフィルタ リストを使用できます。ファイル フィルタ リストとキーワード フィルタ リストです。それぞれ個別のパラメータ セット (-Fileおよび -Keyword) を各パラメータの前に使用して構成します。 フィルタ名は各フィルタの種類内で一意です。
既定では、新しいファイル フィルタとキーワード フィルタには、次のプロパティが設定されています。
- -Enabled $false
- -Action SkipDetect
- -Quarantine $true
- -MinimumUniqueHits 1 (キーワード フィルタのみ)
■パラメーター
-Action <SPScheduledFilterActionEnum>
アイテムがフィルタ リストの条件に一致した場合に実行されるアクションを指定します。省略可能です。 指定可能な値はSkipDetect (既定値) およびDeleteです。
“SkipDetect”は、一致が検出された場合、レコードは保持されるがファイルはアップロードまたはダウンロード可能であることを意味します。
“Delete”は、ファイルの内容を削除し、代わりに削除テキストを挿入します。
フィルタ リストが作成されたときに、既定で値SkipDetectが割り当てられています。Set-FsspScheduledFilterに値を指定しなかった場合、既定の設定が維持されます。
| 必須 | false |
| 位置 | named |
| 既定値 | |
| パイプライン入力を許可する | true (ByValue, ByPropertyName) |
| ワイルドカード文字を許可する | false |
-Enabled <Boolean>
フィルタ リストを有効または無効にします。省略可能です。指定可能な値は$falseおよび$trueです。値を指定しなかった場合、現在の設定が維持されます。フィルタ リストが作成されたときに、既定で値$falseが割り当てられました。
| 必須 | false |
| 位置 | named |
| 既定値 | |
| パイプライン入力を許可する | true (ByValue, ByPropertyName) |
| ワイルドカード文字を許可する | false |
-File [<SwitchParameter>]
構成中のファイル フィルタ リストであることを示すパラメータ セットです。必須です。いずれか1つのパラメータ セットを選択する必要があります。-Fileまたは -Keywordを選択します。
| 必須 | false |
| 位置 | named |
| 既定値 | |
| パイプライン入力を許可する | false |
| ワイルドカード文字を許可する | false |
-Keyword [<SwitchParameter>]
構成中のキーワード フィルタ リストであることを示すパラメータ セットです。必須です。いずれか1つのパラメータ セットを選択する必要があります。-Fileまたは -Keywordを選択します。
| 必須 | true |
| 位置 | 1 |
| 既定値 | |
| パイプライン入力を許可する | false |
| ワイルドカード文字を許可する | false |
-List <string>
構成する1つの既存のフィルタ リストの名前です。必須です。フィルタ名では、大文字と小文字が区別されます。文字列に英数字以外の文字やスペースを含める場合は、引用符で囲んでください。フィルタ名は種類内で一意です。
フィルタ リストは、New-FsspFilterListを使用して作成されます。
| 必須 | true |
| 位置 | named |
| 既定値 | |
| パイプライン入力を許可する | true (ByValue, ByPropertyName) |
| ワイルドカード文字を許可する | false |
-MinimumUniqueHits <UInt32>
アクションが起動されるために必要な一意なキーワードの最小ヒット数を指定します。省略可能です。 このパラメータは、キーワード フィルタ専用です。既定は1です。たとえば、一意なキーワードの最小ヒット数に3を設定したとします。リスト内にある”wonderful”という語はドキュメントに3回出現します。一方、リストに含まれている他の単語はまったく出現しませんでした。リストに含まれている一致項目が1つだけなので、キーワード フィルタは一致とは見なされません。
| 必須 | false |
| 位置 | named |
| 既定値 | |
| パイプライン入力を許可する | true (ByValue, 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 |
| 既定値 | |
| パイプライン入力を許可する | true (ByValue, ByPropertyName) |
| ワイルドカード文字を許可する | false |
-SuppressFilterNotifications <Boolean>
このスキャン ジョブによってこのフィルタと一致したときに通知を送信するかどうかを示します。省略可能です。指定可能な値は$falseおよび$trueです。既定値の$falseは、フィルタ通知が有効な場合は、それらが送信されることを示しす。Set-FsspNotificationで無効にされている場合、このパラメータは効力を持ちません。
| 必須 | false |
| 位置 | named |
| 既定値 | $false |
| パイプライン入力を許可する | false |
| ワイルドカード文字を許可する | false |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: Verbose、Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、OutBuffer、およびOutVariable。詳細については、「get-help about_commonparameters」と入力してヘルプを参照してください。
■入力
■出力
■メモ
■例
例1
Set-FsspScheduledFilter -File -List "List1" -Enabled $true
例1:説明
“List1” というファイル フィルタ リストを有効にします。 既定の “Delete” アクションと検出されたファイルの検疫は維持されます。
コマンドが正常に完了した場合は、何も出力されません。
例2
Set-FsspScheduledFilter -File -List "List1" -Enabled $false
例2:説明
“List1″というファイル フィルタ リストを無効にします。新しいフィルタ リストが既定で無効になっているため、このフィルタ リストが以前に有効になっていたことが想定されます。
コマンドが正常に完了した場合は、何も出力されません。
例3
Set-FsspScheduledFilter -Keyword -List "Opportunity" -Enabled $true -Action Delete
例3:説明
“Opportunity”というキーワード フィルタ リストを有効にします。アクションは”Delete”に設定されます。
コマンドが正常に完了した場合は、何も出力されません。
■関連するリンク
- Get-FsspScheduledFilter
- New-FsspFilterList
[参考]
- Forefront Protection 2010 for SharePoint : ホーム
http://www.microsoft.com/japan/forefront/protection-for-sharepoint/default.mspx - Microsoft Forefront Protection 2010 for SharePoint
http://technet.microsoft.com/ja-jp/library/cc482990.aspx - Forefront Protection 2010 for SharePoint : ホワイト ペーパー
http://www.microsoft.com/japan/forefront/protection-for-sharepoint/white-papers.mspx - Updates for Microsoft Forefront and Related Technologies
http://technet.microsoft.com/en-us/forefront/ff899332
コメント
[…] Set-FsspScheduledFilter […]