Register-CimIndicationEvent

構文

Register-CimIndicationEvent
        [-Namespace <String>]
        [-ClassName] <String>
        [-OperationTimeoutSec <UInt32>]
        [-ComputerName <String>]
        [[-SourceIdentifier] <String>]
        [[-Action] <ScriptBlock>]
        [-MessageData <PSObject>]
        [-SupportEvent]
        [-Forward]
        [-MaxTriggerCount <Int32>]
        [<CommonParameters>]

Register-CimIndicationEvent
        [-Namespace <String>]
        [-ClassName] <String>
        [-OperationTimeoutSec <UInt32>]
        -CimSession <CimSession>
        [[-SourceIdentifier] <String>]
        [[-Action] <ScriptBlock>]
        [-MessageData <PSObject>]
        [-SupportEvent]
        [-Forward]
        [-MaxTriggerCount <Int32>]
        [<CommonParameters>]

Register-CimIndicationEvent
        [-Namespace <String>]
        [-Query] <String>
        [-QueryDialect <String>]
        [-OperationTimeoutSec <UInt32>]
        -CimSession <CimSession>
        [[-SourceIdentifier] <String>]
        [[-Action] <ScriptBlock>]
        [-MessageData <PSObject>]
        [-SupportEvent]
        [-Forward]
        [-MaxTriggerCount <Int32>]
        [<CommonParameters>]

Register-CimIndicationEvent
        [-Namespace <String>]
        [-Query] <String>
        [-QueryDialect <String>]
        [-OperationTimeoutSec <UInt32>]
        [-ComputerName <String>]
        [[-SourceIdentifier] <String>]
        [[-Action] <ScriptBlock>]
        [-MessageData <PSObject>]
        [-SupportEvent]
        [-Forward]
        [-MaxTriggerCount <Int32>]
        [<CommonParameters>]

説明

このコマンドレットは、Windows プラットフォームでのみ使用できます。

Register-CimIndicationEvent コマンドレットは、表示クラス名またはクエリ式を使用して、インジケーターをサブスクライブします。 SourceIdentifier パラメーターを使用して、サブスクリプションに名前を付けます。

このコマンドレットは、 EventSubscription オブジェクトを返します。 このオブジェクトを使用して、サブスクリプションを取り消すことができます。

例

例 1: クラスによって生成されたイベントを登録する

この例では、 Win32_ProcessStartTrace という名前のクラスによって生成されたイベントをサブスクライブします。 プロセスが開始されるたびに、このクラスによってイベントが発生します。

Register-CimIndicationEvent -ClassName 'Win32_ProcessStartTrace' -SourceIdentifier "ProcessStarted"
Get-Event -SourceIdentifier "ProcessStarted"

Get-Event コマンドレットは、ProcessStarted サブスクリプションを含むイベントを取得します。 詳細については、「 Get-Event」を参照してください。

例 2: クエリを使用してイベントを登録する

この例では、クエリを使用して、 Win32_LocalTimeという名前のクラスのインスタンスに変更が発生するたびに生成されたイベントをサブスクライブします。

$query = "SELECT * FROM CIM_InstModification WHERE TargetInstance ISA 'Win32_LocalTime'"
Register-CimIndicationEvent -Query $query -SourceIdentifier "Timer"

例 3: イベントが到着したときにスクリプトを実行する

この例では、イベントに応答してアクションを使用する方法を示します。 変数 $action は、 Action のスクリプト ブロックを保持します。このブロックは、 $event 変数を使用して CIM から受信したイベントにアクセスします。

$action = {
  $name = $event.SourceEventArgs.NewEvent.ProcessName
  $id = $event.SourceEventArgs.NewEvent.ProcessId
  Write-Host -Object "New Process Started : Name = $name
 ID = $id"
}
Register-CimIndicationEvent -ClassName 'Win32_ProcessStartTrace' -SourceIdentifier "ProcessStarted" -Action $action

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

例 4: リモート コンピューターにイベントを登録する

この例では、 Server01 という名前のリモート コンピューター上のイベントをサブスクライブします。 CIM サーバーから受信したイベントは、現在の PowerShell セッションのイベント キューに格納され、ローカル Get-Event を実行してイベントを取得します。

Register-CimIndicationEvent -ClassName 'Win32_ProcessStartTrace' -SourceIdentifier "ProcessStarted" -ComputerName Server01
Get-Event -SourceIdentifier "ProcessStarted"

パラメーター

-Action

-CimSession

-ClassName

-ComputerName

-Forward

-MaxTriggerCount

-MessageData

-Namespace

-OperationTimeoutSec

-Query

-QueryDialect

-SourceIdentifier

-SupportEvent

入力

None

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

出力

Object

このコマンドレットは、 EventSubscription オブジェクトを返します。

メモ

PowerShell には、 Register-CimIndicationEventの次のエイリアスが含まれています。

• Windows:
  • rcie

このコマンドレットは、Windows プラットフォームでのみ使用できます。

関連リンク

• Get-Event
• Remove-Event
• Unregister-Event
• Write-Host
• Get-CimSession
• New-CimSession