Forefront Protection 2010 for Exchange Server (FPE 2010) のForefront管理シェルは、PowerShellを用いたコマンドラインインタフェースです。
Forefront管理シェルは、FPE 2010の管理を目的として様々なコマンドレットが用意されていますが、 オンライン上では説明のみで詳細なコマンド オプション情報については公開されていないようです。
このヘルプ情報について、オンライン上で日本語として確認したいと思い、本ブログ上で纏めたいと思います (内容については「Get-Help」コマンドレットの-Fullオプションを用いて実行した結果を編集したものとなります)。
この記事では、「Remove-FseQuarantine」コマンドレットについて記載します (他のコマンドレットについては、「FPE 2010のForefront管理シェルで使用できるコマンドレットについて」を参照)。
■名前
Remove-FseQuarantine
■概要
検疫からアイテムを削除します。
■構文
Remove-FseQuarantine -All [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-FseQuarantine -Id <string[]> [-Force] [-Confirm] [-WhatIf] |
■説明
検疫済みのアイテムを記述したメタデータ レコードとアイテム自体を検疫から削除します。検疫からアイテムを配信するには、Send-FseQuarantineを使用します。検疫内のアイテムをディスクに保存するには、Export-FseQuarantineを使用します。検疫内のアイテムに関するデータを表示するには、Get-FseQuarantineを使用します。
-All (すべてのアイテムを削除) または -Id (削除するアイテムを指定) のどちらかのパラメーターを指定する必要があります。
■パラメーター
-All [<SwitchParameter>]
検疫済みのすべてのアイテムを削除します。必須 (このパラメーターまたは -Id パラメーターを指定する必要があります)。
必須 | true |
位置 | named |
既定値 | |
パイプライン入力を許可する | false |
ワイルドカード文字を許可する | false |
-Force [<SwitchParameter>]
警告メッセージを制御します。省略可能です。-Forceを指定して、コマンドレットが、ユーザーに警告せずに実行を継続するように強制します。-Forceを指定した場合、Windows PowerShellはこのコマンドの確認を求めません。このパラメーターは、スクリプトの作成を許可するために提供されています。
必須 | false |
位置 | named |
既定値 | |
パイプライン入力を許可する | false |
ワイルドカード文字を許可する | false |
-Id <string[]>
検疫から削除するアイテムを指定します。必須 (このパラメーターまたは -Allパラメーターを指定する必要があります)。複数のアイテムを配列として入力します。これらのIDは、検疫データベース内で指定します。各値を引用符と中かっこで囲みます。例:
Remove-FseQuarantine -Id "{b6025b58-70e6-4b0c-b519-94953bef7860}"
少数のファイルを分離するためには、Get-FseQuarantineコマンドレットと適切なフィルターを使用することをお勧めします。次に、パイプを使用してその結果セットをRemove-FseQuarantineコマンドレットに送ることができます。パイプ処理により、ID自体と共に -Idパラメーターが提供されるため、パイプ処理を使用するときに指定しないでください。例:
Get-FseQuarantine -Filter "Subject = Evil" | Remove-FseQuarantine
無効なIDを指定すると、コマンドレットによって後続のIDの処理が続行されます。
必須 | true |
位置 | named |
既定値 | |
パイプライン入力を許可する | true (ByPropertyName) |
ワイルドカード文字を許可する | false |
-Cached <switch>
コマンドを実行する前に確認メッセージを表示します。
必須 | 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-FseQuarantine -All
例1:出力結果
There is no output if the command completes successfully. |
例1:説明
検疫済みのすべてのアイテムを削除します。
例2
Remove-FseQuarantine -Id "{E83480CA-47DB-4D26-9110-7170C2688EA3}"
例2:出力結果
There is no output if the command completes successfully. |
例2:説明
最後にキャッシュされたデータから、サーバーの稼動状態を返します。
注意: 2つのイベントのみを示します。
例3
Get-FseQuarantine -filter "Sender = fred@contoso.com" | Remove-FseQuarantine
例3:出力結果
There is no output if the command completes successfully. |
例3:説明
Get-FseQuarantineを使用して、送信者が”fred@contoso.com”である検疫済みのアイテムを取得します。これらのアイテムはRemove-FseQuarantineにパイプ処理され、削除されます。パイプ処理が使用されたため、-Idパラメーターが自動的に指定されました。
■関連するリンク
- Export-FseQuarantine
- Get-FseQuarantine
- Send-FseQuarantine
- Get-FseQuarantineOptions
- Set-FseQuarantineOptions
[参考]
- 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-FseQuarantine […]