Invoke-CimMethod
Vyvolá metodu třídy CIM.
Syntaxe
Invoke-CimMethod
[-ClassName] <String>
[-ComputerName <String[]>]
[[-Arguments] <IDictionary>]
[-MethodName] <String>
[-Namespace <String>]
[-OperationTimeoutSec <UInt32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Invoke-CimMethod
[-ClassName] <String>
-CimSession <CimSession[]>
[[-Arguments] <IDictionary>]
[-MethodName] <String>
[-Namespace <String>]
[-OperationTimeoutSec <UInt32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Invoke-CimMethod
-ResourceUri <Uri>
[-ComputerName <String[]>]
[[-Arguments] <IDictionary>]
[-MethodName] <String>
[-Namespace <String>]
[-OperationTimeoutSec <UInt32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Invoke-CimMethod
[-ResourceUri <Uri>]
[-InputObject] <CimInstance>
-CimSession <CimSession[]>
[[-Arguments] <IDictionary>]
[-MethodName] <String>
[-OperationTimeoutSec <UInt32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Invoke-CimMethod
[-ResourceUri <Uri>]
[-InputObject] <CimInstance>
[-ComputerName <String[]>]
[[-Arguments] <IDictionary>]
[-MethodName] <String>
[-OperationTimeoutSec <UInt32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Invoke-CimMethod
-ResourceUri <Uri>
-CimSession <CimSession[]>
[[-Arguments] <IDictionary>]
[-MethodName] <String>
[-Namespace <String>]
[-OperationTimeoutSec <UInt32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Invoke-CimMethod
[-CimClass] <CimClass>
[-ComputerName <String[]>]
[[-Arguments] <IDictionary>]
[-MethodName] <String>
[-OperationTimeoutSec <UInt32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Invoke-CimMethod
[-CimClass] <CimClass>
-CimSession <CimSession[]>
[[-Arguments] <IDictionary>]
[-MethodName] <String>
[-OperationTimeoutSec <UInt32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Invoke-CimMethod
-Query <String>
[-QueryDialect <String>]
[-ComputerName <String[]>]
[[-Arguments] <IDictionary>]
[-MethodName] <String>
[-Namespace <String>]
[-OperationTimeoutSec <UInt32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Invoke-CimMethod
-Query <String>
[-QueryDialect <String>]
-CimSession <CimSession[]>
[[-Arguments] <IDictionary>]
[-MethodName] <String>
[-Namespace <String>]
[-OperationTimeoutSec <UInt32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Tato rutina je dostupná jenom na platformě Windows.
Rutina Invoke-CimMethod
vyvolá metodu třídy CIM nebo instance CIM pomocí párů name-value určených parametrem Arguments.
Pokud není zadaný parametr InputObject, rutina funguje jedním z následujících způsobů:
- Pokud není zadán parametr ComputerName ani parametr CimSession, bude tato rutina fungovat v místní relaci rozhraní WMI (Windows Management Instrumentation) pomocí relace modelu COM (Component Object Model).
- Pokud je zadán parametr ComputerName nebo parametr CimSession, bude tato rutina fungovat se serverem CIM zadaným parametrem ComputerName nebo parametrem CimSession.
Pokud je zadaný parametr InputObject, rutina funguje jedním z následujících způsobů:
- Pokud není zadán parametr ComputerName ani parametr CimSession, použije tato rutina název relace CIM nebo názvu počítače ze vstupního objektu.
- Pokud je zadán parametr ComputerName nebo parametr CimSession, použije tato rutina hodnotu parametru CimSession nebo hodnotu parametru ComputerName. Nejedná se o běžný scénář.
Příklady
Příklad 1: Vyvolání metody
Tento příklad vyvolá metodu Terminate třídy Win32_Process.
Invoke-CimMethod -Query 'select * from Win32_Process where name like "notepad%"' -MethodName "Terminate"
Příklad 2: Vyvolání metody pomocí objektu instance CIM
Tento příklad načte objekt instance CIM a uloží ho do proměnné s názvem $x
pomocí rutiny Get-CimInstance
. Obsah proměnné se pak použije jako InputObject pro rutinu Invoke-CimMethod
. Metoda GetOwner je vyvolána pro CimInstance.
$x = Get-CimInstance -Query 'Select * from Win32_Process where name like "notepad%"'
Invoke-CimMethod -InputObject $x -MethodName GetOwner
Příklad 3: Vyvolání statické metody pomocí argumentů
Tento příklad vyvolá metodu Create pojmenovanou pomocí parametru Arguments.
Invoke-CimMethod -ClassName Win32_Process -MethodName "Create" -Arguments @{
CommandLine = 'notepad.exe'; CurrentDirectory = "C:\windows\system32"
}
Příklad 4: Ověřování na straně klienta
Tento příklad provádí ověření na straně klienta pro metodu xyz předáním objektu CimClass do Invoke-CimMethod
.
$c = Get-CimClass -ClassName Win32_Process
Invoke-CimMethod -CimClass $c -MethodName "xyz" -Arguments @{CommandLine='notepad.exe'}
Parametry
-Arguments
Určuje parametry, které se mají předat volané metodě. Zadejte hodnoty tohoto parametru jako páry name-value uložené v tabulce hash. Pořadí zadaných hodnot není důležité.
Typ: | IDictionary |
Position: | 1 |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-CimClass
Určuje objekt třídy CIM, který představuje definici třídy CIM na serveru. Tento parametr použijte při vyvolání statické metody třídy.
K načtení definice třídy ze serveru můžete použít rutinu Get-CimClass
.
Použití tohoto parametru vede k lepšímu ověření schématu na straně klienta.
Typ: | CimClass |
Position: | 0 |
Default value: | None |
Vyžadováno: | True |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | 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 New-CimSession
nebo Get-CimSession
rutiny. Další informace naleznete v tématu about_CimSession.
Typ: | CimSession[] |
Position: | Named |
Default value: | None |
Vyžadováno: | True |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-ClassName
Určuje název třídy CIM, pro kterou se má operace provést. Tento parametr se používá pouze pro statické metody. 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.
Typ: | String |
Aliasy: | Class |
Position: | 0 |
Default value: | None |
Vyžadováno: | True |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | 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.
Při použití tohoto parametru rutina vytvoří dočasnou relaci se zadaným počítačem pomocí protokolu WsMan. V opačném případě rutina provede operaci na místním počítači pomocí modelu COM (Component Object Model).
Připojte se pomocí relace CIM pro zajištění lepšího výkonu při provádění více operací na stejném počítači.
Typ: | String[] |
Aliasy: | CN, ServerName |
Position: | Named |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-Confirm
Před spuštěním rutiny vás vyzve k potvrzení.
Typ: | SwitchParameter |
Aliasy: | cf |
Position: | Named |
Default value: | False |
Vyžadováno: | False |
Přijmout vstup kanálu: | False |
Přijmout zástupné znaky: | False |
-InputObject
Určuje objekt instance CIM, který se má použít jako vstup pro vyvolání metody. Tento parametr lze použít pouze k vyvolání metod instance. K vyvolání statických metod třídy použijte parametr třídy nebo parametr CimClass.
Typ: | CimInstance |
Aliasy: | CimInstance |
Position: | 0 |
Default value: | None |
Vyžadováno: | True |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-MethodName
Určuje název metody CIM, která se má vyvolat. Tento parametr je povinný a nesmí být null ani prázdný. K vyvolání statické metody třídy CIM použijte ClassName nebo parametr CimClass.
Typ: | String |
Aliasy: | Name |
Position: | 2 |
Default value: | None |
Vyžadováno: | True |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | 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ů.
Typ: | String |
Position: | Named |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-OperationTimeoutSec
Určuje dobu, po kterou rutina čeká na odpověď z počítače. Ve výchozím nastavení je hodnota 0, což znamená, že rutina používá výchozí hodnotu časového limitu pro server.
Pokud je parametr OperationTimeoutSec nastaven na hodnotu menší než výchozí časový limit opakování připojení 3 minuty, selhání sítě, která trvala více než hodnota parametru OperationTimeoutSec, se nedají obnovit.
Typ: | UInt32 |
Aliasy: | OT |
Position: | Named |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | False |
Přijmout zástupné znaky: | False |
-Query
Určuje dotaz, který se má spustit na serveru CIM. Metoda je vyvolána na instancích přijatých v důsledku dotazu. Dialekt dotazu můžete zadat pomocí parametru QueryDialect.
Pokud zadaná hodnota obsahuje dvojité uvozovky ("
), jednoduché uvozovky ('
) nebo zpětné lomítko (\
), je nutné uvozit znaky předponou zpětného lomítka (\
). Pokud zadaná hodnota používá operátor WQL LIKE, je nutné uvozit následující znaky tak, že je uzavřete do hranatých závorek ([]
): percent (%
), podtržítko (_
) nebo levá hranatá závorka ([
).
Typ: | String |
Position: | Named |
Default value: | None |
Vyžadováno: | True |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | 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 .
Typ: | String |
Position: | Named |
Default value: | WQL |
Vyžadováno: | False |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-ResourceUri
Určuje identifikátor URI (Uniform Resource Identifier) prostředku třídy prostředků nebo instance. Identifikátor URI slouží k identifikaci konkrétního typu prostředku, jako jsou disky nebo procesy, v počítači.
Identifikátor URI se skládá z předpony a cesty k prostředku. Například:
http://schemas.microsoft.com/wbem/wsman/1/wmi/root/cimv2/Win32_LogicalDisk
http://intel.com/wbem/wscim/1/amt-schema/1/AMT_GeneralSettings
Pokud tento parametr nezadáte, použije se standardní identifikátor URI prostředku DMTF http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/
a název třídy se k němu připojí.
ResourceURI lze použít pouze s relacemi CIM vytvořenými pomocí protokolu WSMan nebo při zadávání parametru ComputerName, který vytvoří relaci CIM pomocí WSManu.
Pokud zadáte tento parametr bez zadání parametru ComputerName nebo když zadáte relaci CIM vytvořenou pomocí protokolu DCOM, zobrazí se chyba. Protokol DCOM nepodporuje parametr ResourceURI.
Pokud je zadán parametr ResourceUri i parametr Filter, bude parametr filtru ignorován.
Typ: | Uri |
Position: | Named |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-WhatIf
Ukazuje, co se stane, když se rutina spustí. Rutina se nespustí.
Typ: | SwitchParameter |
Aliasy: | wi |
Position: | Named |
Default value: | False |
Vyžadováno: | False |
Přijmout vstup kanálu: | False |
Přijmout zástupné znaky: | False |
Vstupy
Do této rutiny můžete třídu CIM pipetovat.
Instanci CIM můžete do této rutiny převést.
Výstupy
Tato rutina vrátí objekt.
Poznámky
PowerShell obsahuje následující aliasy pro Invoke-CimMethod
:
- Windows:
icim
Tato rutina je dostupná jenom na platformách Windows.