Compartir a través de


Register-CimIndicationEvent

Se suscribe a indicaciones mediante una expresión de filtro o una expresión de consulta.

Sintaxis

ClassNameComputerSet (valor predeterminado)

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

ClassNameSessionSet

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

QueryExpressionSessionSet

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

QueryExpressionComputerSet

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

Description

El cmdlet Register-CimIndicationEvent se suscribe a las indicaciones mediante un nombre de clase de indicación o una expresión de consulta. Usa el parámetro SourceIdentifier para asignar un nombre a la suscripción.

Este cmdlet devuelve un objeto eventSubscription . Puede usar este objeto para cancelar la suscripción.

Ejemplos

Ejemplo 1: Registrar los eventos generados por una clase

Este conjunto de comandos se suscribe a los eventos generados por la clase denominada Win32_ProcessStartTrace que genera un evento cada vez que se inicia un proceso y obtiene los eventos con la suscripción ProcessStarted mediante el cmdlet Get-Event. Para obtener más información, consulte Get-Event.

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

Nota:

En este ejemplo, debe ejecutar PowerShell como administrador.

Ejemplo 2: Registrar los eventos mediante una consulta

Este conjunto de comandos usa una consulta para suscribirse a un evento generado siempre que haya un cambio en la instancia de una clase denominada Win32_LocalTime.

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

Ejemplo 3: Ejecutar un script cuando llegue el evento

Este conjunto de comandos muestra cómo usar una acción en respuesta a un evento. La variable $action contiene el bloque de script para Action, que usa la variable $event para acceder al evento recibido de 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

Para obtener más información, vea Win32_ProcessStartTrace.

Ejemplo 4: Registrar los eventos en un equipo remoto

Este conjunto de comandos se suscribe a eventos en un equipo remoto denominado Server01. Los eventos recibidos del servidor CIM se almacenan en la cola de eventos en la sesión actual de PowerShell y, a continuación, ejecutan un Get-Event local para recuperar los eventos.

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

Parámetros

-Action

Especifica los comandos que controlan los eventos.

Los comandos especificados por este parámetro se ejecutan cuando se genera un evento, en lugar de enviar el evento a la cola de eventos. Incluya los comandos entre llaves ( { } ) para crear un bloque de script.

El bloque de script especificado con Action puede incluir el $Event, $EventSubscriber, $Sender, $SourceEventArgsy $SourceArgs variables automáticas, que proporcionan información sobre el evento al bloque de script Action. Para obtener más información, vea Acerca de las variables automáticas.

Propiedades de parámetro

Tipo:ScriptBlock
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:1
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-CimSession

Ejecuta el comando mediante la sesión CIM especificada. Escriba una variable que contenga la sesión CIM o un comando que cree o obtenga la sesión CIM, como los cmdlets New-CimSession o Get-CimSession. Para obtener más información, vea [about_CimSessions].

Propiedades de parámetro

Tipo:CimSession
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

ClassNameSessionSet
Posición:Named
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False
QueryExpressionSessionSet
Posición:Named
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-ClassName

Especifica a qué clase de indicación se está usted suscribiendo. Puede utilizar el autocompletado de tabulaciones para examinar la lista de clases, ya que PowerShell obtiene una lista de clases del servidor WMI local para proporcionar una lista de nombres de clases.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

ClassNameComputerSet
Posición:0
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False
ClassNameSessionSet
Posición:0
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-ComputerName

Especifica el nombre del equipo en el que desea ejecutar la operación CIM. Puede especificar un nombre de dominio completo (FQDN), un nombre NetBIOS o una dirección IP.

Si especifica este parámetro, el cmdlet crea una sesión temporal en el equipo especificado mediante el protocolo WsMan. Si no especifica este parámetro, el cmdlet realiza la operación en el sistema local mediante el modelo de objetos componentes (COM).

Si se realizan varias operaciones en el mismo equipo, conéctese mediante una sesión CIM para mejorar el rendimiento.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:CN, NombreDelServidor

Conjuntos de parámetros

ClassNameComputerSet
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False
QueryExpressionComputerSet
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Forward

Indica que los eventos de la suscripción se reenvían a la sesión en el equipo local. Use este parámetro cuando se registren eventos en un equipo remoto o en una sesión remota.

Propiedades de parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-MaxTriggerCount

Parámetro para indicar que el suscriptor debe darse de baja automáticamente después de activarse un número especificado de veces. Si el valor es igual o menor que cero, no hay ningún límite en el número de veces que se puede desencadenar el evento sin que se anule el registro.

Propiedades de parámetro

Tipo:Int32
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-MessageData

Especifica los datos adicionales que se van a asociar a esta suscripción de eventos. El valor de este parámetro aparece en la propiedad MessageData de todos los eventos asociados a esta suscripción.

Propiedades de parámetro

Tipo:PSObject
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Namespace

Especifica el espacio de nombres para la operación CIM. El espacio de nombres predeterminado es root/cimv2. Puede usar la finalización de tabulación para examinar la lista de espacios de nombres, ya que PowerShell obtiene una lista de espacios de nombres del servidor WMI local para proporcionar la lista de espacios de nombres.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-OperationTimeoutSec

Especifica la cantidad de tiempo que el cmdlet espera una respuesta del equipo. De forma predeterminada, el valor de este parámetro es 0, lo que significa que el cmdlet usa el valor de tiempo de espera predeterminado para el servidor.

Si el parámetro OperationTimeoutSec se establece en un valor menor que el tiempo de espera de reintento de conexión sólido de 3 minutos, los errores de red que duran más que el valor del parámetro OperationTimeoutSec no se pueden recuperar, ya que la operación en el servidor agota el tiempo de espera antes de que el cliente pueda volver a conectarse.

Propiedades de parámetro

Tipo:UInt32
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:OT

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Query

Especifica una consulta que se va a ejecutar en el servidor CIM. Si el valor especificado contiene comillas dobles ", comillas simples ' o una barra diagonal inversa \, debe preceder esos caracteres anteponiéndoles el carácter de barra diagonal inversa. Si el valor especificado utiliza el operador LIKE de WQL, debe agregar caracteres de escape a los siguientes caracteres encerrándolos entre corchetes []: porcentaje %, subrayado _ o corchete de apertura [.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

QueryExpressionSessionSet
Posición:0
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False
QueryExpressionComputerSet
Posición:0
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-QueryDialect

Especifica el lenguaje de consulta usado para el parámetro de consulta Consulta. Los valores aceptables para este parámetro son: WQL o CQL. El valor predeterminado es WQL.

Propiedades de parámetro

Tipo:String
Valor predeterminado:WQL
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

QueryExpressionSessionSet
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False
QueryExpressionComputerSet
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-SourceIdentifier

Especifica un nombre para la suscripción. El nombre que especifique debe ser único en la sesión actual. El valor predeterminado es un GUID que Asigna PowerShell. Este valor aparece en el valor del propiedad SourceIdentifier del objeto de suscriptor y de todos los objetos de evento asociados a esta suscripción.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:1
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-SupportEvent

Indica que la suscripción de eventos está oculta. Use este parámetro cuando la suscripción actual forme parte de un mecanismo de registro de eventos más complejo y no se debe detectar de forma independiente.

Propiedades de parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

CommonParameters

Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, vea about_CommonParameters.

Entradas

None

Este cmdlet no acepta objetos de entrada.

Salidas

Object

Este cmdlet genera un objeto EventSubscription.