Register-CimIndicationEvent

Modul:

CimCmdlets Module

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

Syntax

ClassNameComputerSet (Výchozí)

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

Tato rutina je dostupná jenom na platformě Windows.

Cmdlet Register-CimIndicationEvent se přihlásí k odběru indikací pomocí názvu třídy indikace nebo výrazu dotazu. Použijte parametr SourceIdentifier zadejte název 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 spustí událost při každém spuštění procesu.

$event = @{
    ClassName = 'Win32_ProcessStartTrace'
    SourceIdentifier = 'ProcessStarted'
}
Register-CimIndicationEvent @event
Get-Event -SourceIdentifier "ProcessStarted"

Rutina Get-Event získá události s předplatným ProcessStarted. Další informace naleznete v tématu Get-Event.

Poznámka:

V tomto příkladu musíte spustit PowerShell jako správce.

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 akce, který používá proměnnou $Event 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"
}
$event = @{
    ClassName = 'Win32_ProcessStartTrace'
    SourceIdentifier = 'ProcessStarted'
    Action = $action
}
Register-CimIndicationEvent @event

Další informace naleznete v tématu Win32_ProcessStartTrace.

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

Tento příklad odebírá události 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 poté systém spustí místní Get-Event pro načtení událostí.

$event = @{
    ClassName = 'Win32_ProcessStartTrace'
    SourceIdentifier = 'ProcessStarted'
    ComputerName = 'Server01'
}
Register-CimIndicationEvent @event
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 skriptblock.

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.

Vlastnosti parametru

Typ:	ScriptBlock
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	1
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-CimSession

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

Vlastnosti parametru

Typ:	CimSession
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

ClassNameSessionSet

Position:	Named
Povinné:	True
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

QueryExpressionSessionSet

Position:	Named
Povinné:	True
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	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.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

ClassNameComputerSet

Position:	0
Povinné:	True
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

ClassNameSessionSet

Position:	0
Povinné:	True
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	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.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False
Aliasy:	Čína, Název serveru

Sady parametrů

ClassNameComputerSet

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

QueryExpressionComputerSet

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-Forward

Označuje, že události související s předplatným jsou přesměrovány do relace na 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.

Vlastnosti parametru

Typ:	SwitchParameter
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-MaxTriggerCount

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

Vlastnosti parametru

Typ:	Int32
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	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 předplatnému.

Vlastnosti parametru

Typ:	PSObject
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-Namespace

Určuje oblast jmen 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ů.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-OperationTimeoutSec

Určuje dobu, po kterou cmdlet č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, selhání sítě, která trvala více než hodnota parametru OperationTimeoutSec, není možné obnovit, protože operace na serveru vyprší, než se klient může znovu připojit.

Vlastnosti parametru

Typ:	UInt32
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False
Aliasy:	OT

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	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 \, je nutné tyto znaky escapovat použitím znakem zpětného lomítka. Pokud zadaná hodnota používá operátor WQL LIKE, musíte uvozit následující znaky tak, že je uzavřete do hranatých závorek []: procenta %, podtržítka _nebo otevření hranaté závorky [.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

QueryExpressionSessionSet

Position:	0
Povinné:	True
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

QueryExpressionComputerSet

Position:	0
Povinné:	True
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-QueryDialect

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

Vlastnosti parametru

Typ:	String
Default value:	WQL
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

QueryExpressionSessionSet

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

QueryExpressionComputerSet

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	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 objeví v hodnotě vlastnosti SourceIdentifier objektu odběratele a všech objektů událostí přidružených k tomuto odběru.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	1
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	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.

Vlastnosti parametru

Typ:	SwitchParameter
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

CommonParameters

Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters.

Vstupy

None

Do tohoto cmdletu nemůžete předávat objekty.

Výstupy

Object

Tato rutina vrátí objekt EventSubscription.

Poznámky

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

• Windows:
  • rcie

Tento cmdlet je dostupný pouze na platformách Windows.

Související odkazy

• Příkaz Get-Event
• Remove-Event
• Odregistruj-Akci
• Write-Host
• Get-CimSession
• New-CimSession
• about_WQL