Register-WmiEvent

Register-WmiEvent
    [-Class] <String>
    [[-SourceIdentifier] <String>]
    [[-Action] <ScriptBlock>]
    [-Namespace <String>]
    [-Credential <PSCredential>]
    [-ComputerName <String>]
    [-Timeout <Int64>]
    [-MessageData <PSObject>]
    [-SupportEvent]
    [-Forward]
    [-MaxTriggerCount <Int32>]
    [<CommonParameters>]

Register-WmiEvent
    [-Query] <String>
    [[-SourceIdentifier] <String>]
    [[-Action] <ScriptBlock>]
    [-Namespace <String>]
    [-Credential <PSCredential>]
    [-ComputerName <String>]
    [-Timeout <Int64>]
    [-MessageData <PSObject>]
    [-SupportEvent]
    [-Forward]
    [-MaxTriggerCount <Int32>]
    [<CommonParameters>]

Register-WmiEvent コマンドレットは、ローカル コンピューターまたはリモート コンピューター上の Windows Management Instrumentation (WMI) イベントをサブスクライブします。

サブスクライブされた WMI イベントが発生すると、イベントがリモート コンピューターで発生した場合でも、ローカル セッションのイベント キューに追加されます。 イベント キュー内のイベントを取得するには、Get-Event コマンドレットを使用します。

Register-WmiEvent のパラメーターを使用して、リモート コンピューター上のイベントをサブスクライブしたり、キュー内のイベントを識別するのに役立つイベントのプロパティ値を指定したりできます。 Action パラメーターを使用して、サブスクライブされたイベントが発生したときに実行するアクションを指定することもできます。

イベントをサブスクライブすると、イベント サブスクライバーがセッションに追加されます。 セッションでイベント サブスクライバーを取得するには、Get-EventSubscriber コマンドレットを使用します。 サブスクリプションを取り消すには、セッションからイベント サブスクライバーを削除する Unregister-Event コマンドレットを使用します。

Windows PowerShell 3.0 を導入した新しい Common Information Model (CIM) コマンドレットは、WMI コマンドレットと同じタスクを実行します。 CIM コマンドレットは、WS-Management (WSMan) 標準と CIM 標準に準拠しています。これにより、コマンドレットは同じ手法を使用して、Windows オペレーティング システムを実行するコンピューターと他のオペレーティング システムを実行するコンピューターを管理できます。 Register-WmiEventを使用する代わりに、Register-CimIndicationEvent コマンドレットの使用を検討してください。

PS C:\> Register-WmiEvent -Class 'Win32_ProcessStartTrace' -SourceIdentifier "ProcessStarted"

このコマンドは、Win32_ProcessStartTrace クラスによって生成されたイベントをサブスクライブします。 このクラスは、プロセスが開始されるたびにイベントを発生させます。

PS C:\> Register-WmiEvent -Query "select * from __instancecreationevent within 5 where targetinstance isa 'win32_process'" -SourceIdentifier "WMIProcess" -MessageData "Test 01" -TimeOut 500

このコマンドでは、クエリを使用してインスタンス作成イベントWin32_processサブスクライブします。

PS C:\> $action = { Get-History | where { $_.commandline -like "*start-process*" } | export-cliXml "commandHistory.clixml" }
PS C:\> Register-WmiEvent -Class 'Win32_ProcessStartTrace' -SourceIdentifier "ProcessStarted" -Action $action
Id    Name            State      HasMoreData   Location  Command
--    ----            -----      -----------   --------  -------
1     ProcessStarted  NotStarted False                   get-history | where {...

この例では、アクションを使用してイベントに応答する方法を示します。 この場合、プロセスが開始されると、現在のセッション内の Start-Process コマンドが XML ファイルに書き込まれます。

Action パラメーターを使用すると、Register-WmiEvent は、イベント アクションを表すバックグラウンド ジョブを返します。 Get-Job や Receive-Job などの Job コマンドレットを使用して、イベント ジョブを管理できます。

詳細については、「about_Jobs」を参照してください。

PS C:\> Register-WmiEvent -Class 'Win32_ProcessStartTrace' -SourceIdentifier "Start" -Computername Server01
PS C:\> Get-Event -SourceIdentifier "Start"

この例では、Server01 リモート コンピューター上のイベントを登録します。

WMI はイベントをローカル コンピューターに返し、現在のセッションのイベント キューに格納します。 イベントを取得するには、Get-Event コマンド ローカルで実行します。

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。

このコマンドレットにオブジェクトをパイプすることはできません。

このコマンドレットは出力を生成しません。

• Windows Vista 以降のバージョンの Windows オペレーティング システムでこのコマンドレットを使用するには、[管理者として実行] オプションを使用して Windows PowerShell を起動します。

  イベント、イベント サブスクリプション、およびイベント キューは、現在のセッションにのみ存在します。 現在のセッションを閉じると、イベント キューは破棄され、イベント サブスクリプションは取り消されます。