Register-CimIndicationEvent

模块:

CimCmdlets

使用筛选器表达式或查询表达式订阅指示。

语法

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>]

说明

此 cmdlet 仅在 Windows 平台上可用。

cmdlet Register-CimIndicationEvent 使用指示类名或查询表达式订阅指示。 使用 SourceIdentifier 参数为订阅指定名称。

此 cmdlet 返回 EventSubscription 对象。 可以使用此对象取消订阅。

示例

示例 1：注册类生成的事件

此示例订阅由名为 Win32_ProcessStartTrace 的类生成的事件。 只要进程启动，此类就会引发一个事件。

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

cmdlet Get-Event 使用 ProcessStarted 订阅获取事件。 有关详细信息，请参阅 Get-Event。

注意

对于此示例，必须以管理员身份运行 PowerShell。

示例 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

指定处理事件的命令。 此参数指定的命令在引发事件时运行，而不是将事件发送到事件队列。 将命令括在大括号 ({}) 以创建脚本块。

使用 Action 指定的脚本块可以包含 $Event、$EventSubscriber、$Sender$SourceEventArgs、 和 $SourceArgs 自动变量，这些变量向 Action 脚本块提供有关事件的信息。 有关详细信息，请参阅 关于自动变量。

Type:	ScriptBlock
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CimSession

使用指定的 CIM 会话运行命令。 输入包含 CIM 会话的变量，或创建或获取 CIM 会话的命令，例如 New-CimSession 或 Get-CimSession cmdlet。 有关详细信息，请参阅 about_CimSession。

Type:	CimSession
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ClassName

指定要订阅的指示类。 可以使用 Tab 自动补全来浏览类列表，因为 PowerShell 从本地 WMI 服务器获取类列表，以提供类名称的列表。

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ComputerName

指定要运行 CIM 操作的计算机的名称。 可以指定完全限定的域名 (FQDN) 、NetBIOS 名称或 IP 地址。

如果指定此参数，则 cmdlet 将使用 WsMan 协议创建与指定计算机的临时会话。 如果不指定此参数，cmdlet 将使用组件对象模型 (COM) 在本地系统上执行操作。

如果在同一台计算机上执行多个操作，请使用 CIM 会话进行连接以提高性能。

Type:	String
Aliases:	CN, ServerName
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Forward

指示订阅的事件转发到本地计算机上的会话。 如果要在远程计算机或远程会话中注册事件，可使用此参数。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-MaxTriggerCount

用于指示在指定时间触发后应自动注销订阅服务器的参数。 如果值等于或小于零，则无需注销即可触发事件的次数没有限制。

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-MessageData

指定要与此事件订阅关联的任何其他数据。 此参数的值显示在与此订阅关联的所有事件的 MessageData 属性中。

Type:	PSObject
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Namespace

指定 CIM 操作的命名空间。 默认命名空间为 root/cimv2。 可以使用 Tab 自动补全来浏览命名空间列表，因为 PowerShell 从本地 WMI 服务器获取命名空间列表以提供命名空间列表。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-OperationTimeoutSec

指定 cmdlet 等待计算机响应的时间。 默认情况下，此参数的值为 0，这意味着 cmdlet 使用服务器的默认超时值。

如果将 OperationTimeoutSec 参数设置为小于 3 分钟的可靠连接重试超时值，则持续超过 OperationTimeoutSec 参数值的网络故障不可恢复，因为服务器上的操作在客户端重新连接之前超时。

Type:	UInt32
Aliases:	OT
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Query

指定要在 CIM 服务器上运行的查询。 如果指定的值包含双引号 "、单引号 '或反斜杠 \，则必须将这些字符作为反斜杠字符的前缀来转义这些字符。 如果指定的值使用 WQL LIKE 运算符，则必须通过将以下字符括在方括号 []中来转义：百分比 %、下划线 _或左方括号 [。

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-QueryDialect

指定用于 Query 参数的 查询 语言。 此参数的可接受值为： WQL 或 CQL。 默认值为 WQL。

Type:	String
Position:	Named
Default value:	WQL
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SourceIdentifier

指定订阅的名称。 指定的名称在当前会话中必须是唯一的。 默认值为 PowerShell 分配的 GUID。 此值显示在订阅者对象的 SourceIdentifier 属性的值以及与此订阅关联的所有事件对象的值中。

Type:	String
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SupportEvent

指示隐藏事件订阅。 在当前订阅是更复杂的事件注册机制的一部分并且不应单独发现时，可使用此参数。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

输入

None

不能通过管道将对象传递给此 cmdlet。

输出

Object

此 cmdlet 返回 EventSubscription 对象。

备注

PowerShell 包含以下别名 Register-CimIndicationEvent：

• Windows:
  • rcie

此 cmdlet 仅在 Windows 平台上可用。

相关链接

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