Forefront Protection 2010 for Exchange Server (FPE 2010) のForefront管理シェルは、PowerShellを用いたコマンドラインインタフェースです。
Forefront管理シェルは、FPE 2010の管理を目的として様々なコマンドレットが用意されていますが、 オンライン上では説明のみで詳細なコマンド オプション情報については公開されていないようです。
このヘルプ情報について、オンライン上で日本語として確認したいと思い、本ブログ上で纏めたいと思います (内容については「Get-Help」コマンドレットの-Fullオプションを用いて実行した結果を編集したものとなります)。
この記事では、「Remove-FseIncident」コマンドレットについて記載します (他のコマンドレットについては、「FPE 2010のForefront管理シェルで使用できるコマンドレットについて」を参照)。
■名前
Remove-FseIncident
■概要
インシデント データベースからアイテムを削除します。
■構文
Remove-FseIncident -All [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-FseIncident -Id <string[]> [-Confirm] [-WhatIf] [<CommonParameters>] |
■説明
インシデント データベースからレコードを削除します。このデータベースには、Microsoft Forefront Protection 2010 for Exchange Serverによって検出されたすべてのインシデントを表すレコード (メタデータ) が含まれています。各インシデントは一意なインシデントIDによって識別されます。インシデント アイテムに関するデータを表示するには、Get-FseIncidentコマンドレットを使用します。インシデント データベースのオプションを変更するには、Set-FseIncidentOptionsを使用します。
-All (すべてのアイテムを削除) または -Id (削除するアイテムを指定) のどちらかのパラメーターを指定する必要があります。
■パラメーター
-All [<SwitchParameter>]
すべてのインシデント アイテムを削除します。必須 (このパラメーターまたは -Idパラメーターを指定する必要があります)。
必須 | true |
位置 | named |
既定値 | |
パイプライン入力を許可する | false |
ワイルドカード文字を許可する | false |
-Id <string[]>
インシデント データベースから削除するアイテムのIDが格納された配列です。必須 (このパラメーターまたは -Allパラメーターを指定する必要があります)。
各値を引用符と中かっこで囲みます。例:
Remove-FseIncident -Id "{b6025b58-70e6-4b0c-b519-94953bef7860}"
少数のファイルを分離するためには、Get-FseIncidentコマンドレットと適切なフィルターを使用することをお勧めします。次に、パイプを使用してその結果セットを Remove-FseIncidentコマンドレットに送ることができます。パイプ処理により、ID自体と共に -Idパラメーターが提供されるため、パイプ処理を使用するときに指定しないでください。例:
Get-FseIncident -Filter "Subject = Evil" | Remove-FseIncident
必須 | true |
位置 | named |
既定値 | |
パイプライン入力を許可する | true (ByPropertyName) |
ワイルドカード文字を許可する | false |
-Confirm [<SwitchParameter>]
コマンドを実行する前に確認メッセージを表示します。
必須 | false |
位置 | named |
既定値 | |
パイプライン入力を許可する | false |
ワイルドカード文字を許可する | false |
-WhatIf [<SwitchParameter>]
実際にコマンドを実行せずに、コマンドを実行すると何が起きるかを出力します。
必須 | false |
位置 | named |
既定値 | |
パイプライン入力を許可する | false |
ワイルドカード文字を許可する | false |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: Verbose、Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、OutBuffer、およびOutVariable。詳細については、「get-help about_commonparameters」と入力してヘルプを参照してください。
■入力
■出力
■メモ
■例
例1
Remove-FseIncident -All
例1:出力結果
There is no output if the command completes successfully. |
例1:説明
インシデント データベースからすべてのレコードを削除します。
例2
Get-FseIncident -count 1 | Remove-FseIncident
例2:出力結果
There is no output if the command completes successfully. |
例2:説明
データベース内の最初のインシデントを取得して削除します。-Idパラメーターは、パイプ処理によって自動的に指定される点に注意してください。
例3
Remove-FseIncident -Id "{b6025b58-70e6-4b0c-b519-94953bef7860}"
例3:出力結果
There is no output if the command completes successfully. |
例3:説明
特定のアイテムを削除します。
例4
Get-FseIncident -filter "State = cleaned" | Remove-FseIncident
例4:出力結果
There is no output if the command completes successfully. |
例4:説明
インシデント データベース内で、クリーニング済みであることを示すフラグが設定されているアイテムをすべて削除します。-Idパラメーターは、パイプ処理によって自動的に指定される点に注意してください。
■関連するリンク
- Get-FseIncident
- Get-FseIncidentOptions
- Set-FseIncidentOptions
[参考]
- Forefront Protection 2010 for Exchange Server : ホーム
http://www.microsoft.com/japan/forefront/protection-for-exchange/default.mspx - Microsoft Forefront Protection 2010 for Exchange Server
http://technet.microsoft.com/ja-jp/library/cc482977.aspx - Forefront Protection 2010 for Exchange Server : ホワイト ペーパー
http://www.microsoft.com/japan/forefront/protection-for-exchange/white-papers.mspx - Updates for Microsoft Forefront and Related Technologies
http://technet.microsoft.com/en-us/forefront/ff899332
コメント
[…] Remove-FseIncident […]