Register-CimIndicationEvent

  • Reference
Modul:
CimCmdlets

Přihlásí se k odběru označení pomocí výrazu filtru nebo výrazu dotazu.

Syntax

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

Description

Tato rutina je dostupná jenom na platformě Windows.

Rutina Register-CimIndicationEvent se přihlásí k odběru označení pomocí názvu třídy označení nebo výrazu dotazu. Použijte parametr SourceIdentifier s názvem předplatného.

Tato rutina vrátí objekt EventSubscription . Tento objekt můžete použít ke zrušení předplatného.

Příklady

Příklad 1: Registrace událostí vygenerovaných třídou

Tento příklad se přihlásí k odběru událostí vygenerovaných třídou s názvem Win32_ProcessStartTrace. Tato třída vyvolá událost při každém spuštění procesu.

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

Rutina Get-Event získá události s odběrem ProcessStarted . Další informace najdete v tématu Get-Event.

Poznámka:

V tomto příkladu musíte spustit PowerShell jako Správa istrator.

Příklad 2: Registrace událostí pomocí dotazu

Tento příklad používá dotaz k přihlášení k odběru události vygenerované vždy, když dojde ke změně instance třídy s názvem Win32_LocalTime.

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

Příklad 3: Spuštění skriptu při přijetí události

Tento příklad ukazuje, jak použít akci v reakci na událost. Proměnná $action obsahuje blok skriptu pro akci, který používá $event proměnnou pro přístup k události přijaté z 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

Další informace najdete v tématu Win32_ProcessStartTrace.

Příklad 4: Registrace událostí na vzdáleném počítači

Tento příklad se přihlásí k odběru událostí na vzdáleném počítači s názvem Server01. Události přijaté ze serveru CIM se ukládají do fronty událostí v aktuální relaci PowerShellu a potom spustí místní Get-Event server pro načtení událostí.

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

Parametry

-Action

Určuje příkazy, které zpracovávají události. Příkazy určené tímto parametrem se spustí při vyvolání události místo odeslání události do fronty událostí. Uzavřete příkazy do složených závorek ({}) a vytvořte blok skriptu.

Blok skriptu zadaný akcí může obsahovat $Eventproměnné , , $EventSubscriber$Sender, $SourceEventArgsa $SourceArgs automatické proměnné, které poskytují informace o události do bloku skriptu akce. Další informace naleznete v tématu o automatických proměnných.

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

-CimSession

Spustí příkaz pomocí zadané relace CIM. Zadejte proměnnou, která obsahuje relaci CIM, nebo příkaz, který vytvoří nebo získá relaci CIM, například rutinyNew-CimSession.Get-CimSession Další informace najdete v tématu about_CimSession.

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

-ClassName

Určuje indikační třídu, ke které se přihlašujete k odběru. Pomocí dokončování tabulátoru můžete procházet seznam tříd, protože PowerShell získá seznam tříd z místního serveru WMI a poskytne seznam názvů tříd.

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

-ComputerName

Určuje název počítače, na kterém chcete spustit operaci CIM. Můžete zadat plně kvalifikovaný název domény (FQDN), název NetBIOS nebo IP adresu.

Pokud zadáte tento parametr, rutina vytvoří dočasnou relaci k zadanému počítači pomocí protokolu WsMan. Pokud tento parametr nezadáte, rutina provede operaci v místním systému pomocí modelu COM (Component Object Model).

Pokud se na stejném počítači provádí více operací, připojte se pomocí relace CIM pro zajištění lepšího výkonu.

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

-Forward

Označuje, že události předplatného se přeposílají do relace v místním počítači. Tento parametr použijte při registraci událostí na vzdáleném počítači nebo ve vzdálené relaci.

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

-MaxTriggerCount

Parametr označující, že odběratel by měl být po aktivaci po uplynutí zadaných časů automaticky zrušený. Pokud je hodnota rovna nebo menší než nula, neexistuje žádné omezení počtu aktivací události bez zrušení registrace.

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

-MessageData

Určuje všechna další data, která se mají přidružit k tomuto odběru událostí. Hodnota tohoto parametru se zobrazí ve vlastnosti MessageData všech událostí přidružených k tomuto odběru.

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

-Namespace

Určuje obor názvů pro operaci CIM. Výchozí obor názvů je root/cimv2. Pomocí dokončování tabulátoru můžete procházet seznam oborů názvů, protože PowerShell získá seznam oborů názvů z místního serveru WMI a poskytne seznam oborů názvů.

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

-OperationTimeoutSec

Určuje dobu, po kterou rutina čeká na odpověď z počítače. Ve výchozím nastavení je hodnota tohoto parametru 0, což znamená, že rutina používá výchozí hodnotu časového limitu pro server.

Pokud je parametr OperationTimeoutSec nastaven na hodnotu menší než robustní časový limit opakování připojení 3 minuty, chyby sítě, které trvaly více než hodnota parametru OperationTimeoutSec, se nedají obnovit, protože operace na serveru vyprší, než se klient může znovu připojit.

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

-Query

Určuje dotaz, který se má spustit na serveru CIM. Pokud zadaná hodnota obsahuje dvojité uvozovky, jednoduché uvozovky "'nebo zpětné lomítko\, musíte uvozit tyto znaky jejich předponou znakem zpětného lomítka. Pokud zadaná hodnota používá operátor WQL LIKE, musíte uvozovat následující znaky uzavřením do hranatých závorek []: percent %, podtržítko _nebo levá hranatá závorka [.

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

-QueryDialect

Určuje dotazovací jazyk použitý pro parametr Dotazu . Přijatelné hodnoty pro tento parametr jsou: WQL nebo CQL. Výchozí hodnota je WQL.

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

-SourceIdentifier

Určuje název předplatného. Zadaný název musí být v aktuální relaci jedinečný. Výchozí hodnota je identifikátor GUID, který PowerShell přiřadí. Tato hodnota se zobrazí v hodnotě SourceIdentifier vlastnost odběratel objektu a všech objektů událostí přidružených k tomuto odběru.

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

-SupportEvent

Označuje, že odběr události je skrytý. Tento parametr použijte, pokud je aktuální odběr součástí složitějšího mechanismu registrace událostí a neměl by být zjištěn nezávisle.

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

Vstupy

None

Do této rutiny nemůžete roušit objekty.

Výstupy

Object

Tato rutina vrátí objekt EventSubscription .

Poznámky

PowerShell obsahuje následující aliasy pro Register-CimIndicationEvent:

  • Windows:
    • rcie

Tato rutina je dostupná jenom na platformách Windows.