< Back
Invoke-CimMethod
Post
NAME Invoke-CimMethod
SYNOPSIS
Invokes a method of a CIM class.
SYNTAX
Invoke-CimMethod [-ClassName] <String> [[-Arguments] <IDictionary>] [-MethodName] <String> [-ComputerName <String[]>] [-Namespace <String>]
[-OperationTimeoutSec <UInt32>] [-Confirm] [-WhatIf] [<CommonParameters>]
Invoke-CimMethod [-CimClass] <CimClass> [[-Arguments] <IDictionary>] [-MethodName] <String> [-ComputerName <String[]>] [-OperationTimeoutSec
<UInt32>] [-Confirm] [-WhatIf] [<CommonParameters>]
Invoke-CimMethod [-CimClass] <CimClass> [[-Arguments] <IDictionary>] [-MethodName] <String> [-OperationTimeoutSec <UInt32>] -CimSession
<CimSession[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Invoke-CimMethod [[-Arguments] <IDictionary>] [-MethodName] <String> [-Namespace <String>] [-OperationTimeoutSec <UInt32>] [-QueryDialect
<String>] -CimSession <CimSession[]> -Query <String> [-Confirm] [-WhatIf] [<CommonParameters>]
Invoke-CimMethod [-ClassName] <String> [[-Arguments] <IDictionary>] [-MethodName] <String> [-Namespace <String>] [-OperationTimeoutSec <UInt32>]
-CimSession <CimSession[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Invoke-CimMethod [-InputObject] <CimInstance> [[-Arguments] <IDictionary>] [-MethodName] <String> [-OperationTimeoutSec <UInt32>] [-ResourceUri
<Uri>] -CimSession <CimSession[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Invoke-CimMethod [[-Arguments] <IDictionary>] [-MethodName] <String> [-Namespace <String>] [-OperationTimeoutSec <UInt32>] -CimSession
<CimSession[]> -ResourceUri <Uri> [-Confirm] [-WhatIf] [<CommonParameters>]
Invoke-CimMethod [[-Arguments] <IDictionary>] [-MethodName] <String> [-ComputerName <String[]>] [-Namespace <String>] [-OperationTimeoutSec
<UInt32>] [-QueryDialect <String>] -Query <String> [-Confirm] [-WhatIf] [<CommonParameters>]
Invoke-CimMethod [-InputObject] <CimInstance> [[-Arguments] <IDictionary>] [-MethodName] <String> [-ComputerName <String[]>] [-OperationTimeoutSec
<UInt32>] [-ResourceUri <Uri>] [-Confirm] [-WhatIf] [<CommonParameters>]
Invoke-CimMethod [[-Arguments] <IDictionary>] [-MethodName] <String> [-ComputerName <String[]>] [-Namespace <String>] [-OperationTimeoutSec
<UInt32>] -ResourceUri <Uri> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Invoke-CimMethod cmdlet invokes a method of a Common Information Model (CIM) class or CIM instance using the name-value pairs specified by the
Arguments parameter.
If the InputObject parameter is not specified, the cmdlet works in one of the following ways:
--If neither the ComputerName parameter nor the CimSession parameter is specified, then this cmdlet works on local Windows Management
Instrumentation (WMI) using a Component Object Model (COM) session.
--If either the ComputerName parameter or the CimSession parameter is specified, then this cmdlet works against the CIM server specified by either
the ComputerName parameter or the CimSession parameter.
If the InputObject parameter is specified, the cmdlet works in one of the following ways:
--If neither the ComputerName parameter nor the CimSession parameter is specified, then this cmdlet uses the CIM session or computer name from the
input object.
--If the either the ComputerName parameter or the CimSession parameter is specified, then this cmdlet uses the either the CimSession parameter
value or ComputerName parameter value. Note: This is not very common.
PARAMETERS
-Arguments [<IDictionary>]
Specifies the parameters to pass to the called method. Specify the values for this parameter as name-value pairs, stored in a hash table. The
order of the values entered are not important.
Required? false
Position? 2
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-CimClass <CimClass>
Specifies a CIM class object that represents a CIM class definition on the server. Use this parameter when invoking a static method of a class.
You can use the Get-CimClass cmdlet to retrieve a class definition from the server.
Using this parameter results in better client side schema validations.
Required? true
Position? 1
Default value none
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-CimSession <CimSession[]>
Runs the command using the specified CIM session. Enter a variable that contains the CIM session, or a command that creates or gets the CIM
session, such as the New-CimSession or Get-CimSession cmdlets. For more information, see about_CimSessions.
Required? true
Position? named
Default value none
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-ClassName <String>
Specifies the name of the CIM class for which to perform the operation. This parameter is only used for static methods.
Note: You can use tab completion to browse the list of classes, because Windows PowerShell gets a list of classes from the local WMI server to
provide a list of class names.
Required? true
Position? 1
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ComputerName [<String[]>]
Specifies the name of the computer on which you want to run the CIM operation. You can specify a fully qualified domain name (FQDN), a NetBIOS
name, or an IP address.
If you specify this parameter, the cmdlet creates a temporary session to the specified computer using the WsMan protocol.
If you do not specify this parameter, the cmdlet performs the operation on the local computer using Component Object Model (COM).
If multiple operations are being performed on the same computer, connecting using a CIM session gives better performance.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-InputObject <CimInstance>
Specifies a CIM instance object to use as input to invoke a method.
This parameter can only be used to invoke instance methods. To invoke class static methods, use the Class parameter or the CimClass parameter.
Required? true
Position? 1
Default value none
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-MethodName <String>
Specifies the name of the CIM method to invoke. This parameter is mandatory and cannot be null or empty.
To invoke static method of a CIM class use the ClassName or the CimClass parameter.
Required? true
Position? 3
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Namespace [<String>]
Specifies the namespace for the CIM operation.
The default namespace is root/cimv2.
Note: You can use tab completion to browse the list of namespaces, because Windows PowerShell gets a list of namespaces from the local WMI
server to provide the list of namespaces.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-OperationTimeoutSec [<UInt32>]
Specifies the amount of time that the cmdlet waits for a response from the computer.
By default, the value is 0, which means that the cmdlet uses the default timeout value for the server..
If the OperationTimeoutSec parameter is set to a value less than the robust connection retry timeout of 3 minutes, network failures that last
more than the value of the OperationTimeoutSec parameter are not recoverable, because the operation on the server times out before the client
can reconnect.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Query <String>
Specifies a query to run on the CIM server. A method is invoked on the instances received as a result of the query.
You can specify the query dialect using the QueryDialect parameter.
If the value specified contains double quotes (???????), single quotes (???????), or a backslash (\\), you must escape those characters by prefixing them
with the backslash (\\) character. If the value specified uses the WQL LIKE operator, then you must escape the following characters by
enclosing them in square brackets ([]): percent (%), underscore (_), or opening square bracket ([).
Required? true
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-QueryDialect [<String>]
Specifies the query language used for the Query parameter. The acceptable values for this parameter are:
-- WQL
-- CQL
The default value is WQL.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceUri <Uri>
Specifies the resource uniform resource identifier (URI) of the resource class or instance. The URI is used to identify a specific type of
resource, such as disks or processes, on a computer.
A URI consists of a prefix and a path to a resource. For example:
HYPERLINK "http://schemas.microsoft.com/wbem/wsman ... ogicalDisk"
http://schemas.microsoft.com/wbem/wsman ... ogicalDisk
HYPERLINK "http://intel.com/wbem/wscim/1/amt-schem ... alSettings" http://intel.com/wbem/wscim/1/amt-schem ... alSettings
By default, if you do not specify this parameter, the DMTF standard resource URI http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/ is used
and the class name is appended to it.
ResourceURI can only be used with CIM sessions created using the WSMan protocol, or when specifying the ComputerName parameter, which creates
a CIM session using WSMan. If you specify this parameter without specifying the ComputerName parameter, or if you specify a CIM session
created using DCOM protocol, you will get an error, because the DCOM protocol does not support the ResourceURI parameter.
If both the ResourceURI parameter and the Filter parameter are specified, the Filter parameter is ignored.
Required? true
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
CIM class
This cmdlet accepts a CIM class as an input object.
CIM instance
This cmdlet accepts a CIM instance as an input object.
OUTPUTS
System.Management.Automation.PSCustomObject
This cmdlet returns an object.
Example 1: Invoke a method
PS C:\\>Invoke-CimMethod ????????Query ??????select * from Win32_Process where name like "notepad%"?????? ????????MethodName "Terminate"
This command invokes the method named Terminate on the CIM class named Win32_Process. The CIM class is retrieved by the query "Select * from
Win32_Process where name like ??????notepad%??????".
Example 2: Invoke a method using CIM instance object
PS C:\\>$x = Get-CimInstance -Query ??????Select * from Win32_Process where name like "notepad%"??????
PS C:\\> Invoke-CimMethod -InputObject $x -MethodName "GetOwner"
This set of commands retrieves the CIM instance object and stores it in a variable named $x using the Get-CimInstance cmdlet. The contents of the
variable are then used as the InputObject for the Invoke-CimMethod cmdlet, and the GetOwner method is invoked for the CimInstance.
Example 3: Invoke a static method
PS C:\\>Invoke-CimMethod ????????ClassName Win32_Process ????????MethodName "Create" ????????Arguments @{ Path = "notepad.exe" }
This command invokes the static method Create on the class named Win32_Process with the arguments specified by the Arguments parameter.
Example 4: Invoke a method using arguments
PS C:\\>Invoke-CimMethod -ClassName Win32_Process -MethodName "Create" -Arguments @{ CommandLine = ??????notepad.exe??????; CurrentDirectory =
"C:\\windows\\system32" }
This command invokes the method named Create using the Arguments parameter.
Example 5: Client-side validation
PS C:\\>$c = Get-CimClass ????????ClassName Win32_Process
PS C:\\> Invoke-CimMethod -CimClass $c -MethodName "xyz" ????????Arguments @{ CommandLine = ??????notepad.exe?????? }
This set of commands does client-side validation for the method named xyz by passing a CimClass object to the Invoke-CimMethod cmdlet.
RELATED LINKS
Online Version:
Get-CimClass
Get-CimInstance
Get-CimSession
New-CimSessionOption
SYNOPSIS
Invokes a method of a CIM class.
SYNTAX
Invoke-CimMethod [-ClassName] <String> [[-Arguments] <IDictionary>] [-MethodName] <String> [-ComputerName <String[]>] [-Namespace <String>]
[-OperationTimeoutSec <UInt32>] [-Confirm] [-WhatIf] [<CommonParameters>]
Invoke-CimMethod [-CimClass] <CimClass> [[-Arguments] <IDictionary>] [-MethodName] <String> [-ComputerName <String[]>] [-OperationTimeoutSec
<UInt32>] [-Confirm] [-WhatIf] [<CommonParameters>]
Invoke-CimMethod [-CimClass] <CimClass> [[-Arguments] <IDictionary>] [-MethodName] <String> [-OperationTimeoutSec <UInt32>] -CimSession
<CimSession[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Invoke-CimMethod [[-Arguments] <IDictionary>] [-MethodName] <String> [-Namespace <String>] [-OperationTimeoutSec <UInt32>] [-QueryDialect
<String>] -CimSession <CimSession[]> -Query <String> [-Confirm] [-WhatIf] [<CommonParameters>]
Invoke-CimMethod [-ClassName] <String> [[-Arguments] <IDictionary>] [-MethodName] <String> [-Namespace <String>] [-OperationTimeoutSec <UInt32>]
-CimSession <CimSession[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Invoke-CimMethod [-InputObject] <CimInstance> [[-Arguments] <IDictionary>] [-MethodName] <String> [-OperationTimeoutSec <UInt32>] [-ResourceUri
<Uri>] -CimSession <CimSession[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Invoke-CimMethod [[-Arguments] <IDictionary>] [-MethodName] <String> [-Namespace <String>] [-OperationTimeoutSec <UInt32>] -CimSession
<CimSession[]> -ResourceUri <Uri> [-Confirm] [-WhatIf] [<CommonParameters>]
Invoke-CimMethod [[-Arguments] <IDictionary>] [-MethodName] <String> [-ComputerName <String[]>] [-Namespace <String>] [-OperationTimeoutSec
<UInt32>] [-QueryDialect <String>] -Query <String> [-Confirm] [-WhatIf] [<CommonParameters>]
Invoke-CimMethod [-InputObject] <CimInstance> [[-Arguments] <IDictionary>] [-MethodName] <String> [-ComputerName <String[]>] [-OperationTimeoutSec
<UInt32>] [-ResourceUri <Uri>] [-Confirm] [-WhatIf] [<CommonParameters>]
Invoke-CimMethod [[-Arguments] <IDictionary>] [-MethodName] <String> [-ComputerName <String[]>] [-Namespace <String>] [-OperationTimeoutSec
<UInt32>] -ResourceUri <Uri> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Invoke-CimMethod cmdlet invokes a method of a Common Information Model (CIM) class or CIM instance using the name-value pairs specified by the
Arguments parameter.
If the InputObject parameter is not specified, the cmdlet works in one of the following ways:
--If neither the ComputerName parameter nor the CimSession parameter is specified, then this cmdlet works on local Windows Management
Instrumentation (WMI) using a Component Object Model (COM) session.
--If either the ComputerName parameter or the CimSession parameter is specified, then this cmdlet works against the CIM server specified by either
the ComputerName parameter or the CimSession parameter.
If the InputObject parameter is specified, the cmdlet works in one of the following ways:
--If neither the ComputerName parameter nor the CimSession parameter is specified, then this cmdlet uses the CIM session or computer name from the
input object.
--If the either the ComputerName parameter or the CimSession parameter is specified, then this cmdlet uses the either the CimSession parameter
value or ComputerName parameter value. Note: This is not very common.
PARAMETERS
-Arguments [<IDictionary>]
Specifies the parameters to pass to the called method. Specify the values for this parameter as name-value pairs, stored in a hash table. The
order of the values entered are not important.
Required? false
Position? 2
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-CimClass <CimClass>
Specifies a CIM class object that represents a CIM class definition on the server. Use this parameter when invoking a static method of a class.
You can use the Get-CimClass cmdlet to retrieve a class definition from the server.
Using this parameter results in better client side schema validations.
Required? true
Position? 1
Default value none
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-CimSession <CimSession[]>
Runs the command using the specified CIM session. Enter a variable that contains the CIM session, or a command that creates or gets the CIM
session, such as the New-CimSession or Get-CimSession cmdlets. For more information, see about_CimSessions.
Required? true
Position? named
Default value none
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-ClassName <String>
Specifies the name of the CIM class for which to perform the operation. This parameter is only used for static methods.
Note: You can use tab completion to browse the list of classes, because Windows PowerShell gets a list of classes from the local WMI server to
provide a list of class names.
Required? true
Position? 1
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ComputerName [<String[]>]
Specifies the name of the computer on which you want to run the CIM operation. You can specify a fully qualified domain name (FQDN), a NetBIOS
name, or an IP address.
If you specify this parameter, the cmdlet creates a temporary session to the specified computer using the WsMan protocol.
If you do not specify this parameter, the cmdlet performs the operation on the local computer using Component Object Model (COM).
If multiple operations are being performed on the same computer, connecting using a CIM session gives better performance.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-InputObject <CimInstance>
Specifies a CIM instance object to use as input to invoke a method.
This parameter can only be used to invoke instance methods. To invoke class static methods, use the Class parameter or the CimClass parameter.
Required? true
Position? 1
Default value none
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-MethodName <String>
Specifies the name of the CIM method to invoke. This parameter is mandatory and cannot be null or empty.
To invoke static method of a CIM class use the ClassName or the CimClass parameter.
Required? true
Position? 3
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Namespace [<String>]
Specifies the namespace for the CIM operation.
The default namespace is root/cimv2.
Note: You can use tab completion to browse the list of namespaces, because Windows PowerShell gets a list of namespaces from the local WMI
server to provide the list of namespaces.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-OperationTimeoutSec [<UInt32>]
Specifies the amount of time that the cmdlet waits for a response from the computer.
By default, the value is 0, which means that the cmdlet uses the default timeout value for the server..
If the OperationTimeoutSec parameter is set to a value less than the robust connection retry timeout of 3 minutes, network failures that last
more than the value of the OperationTimeoutSec parameter are not recoverable, because the operation on the server times out before the client
can reconnect.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Query <String>
Specifies a query to run on the CIM server. A method is invoked on the instances received as a result of the query.
You can specify the query dialect using the QueryDialect parameter.
If the value specified contains double quotes (???????), single quotes (???????), or a backslash (\\), you must escape those characters by prefixing them
with the backslash (\\) character. If the value specified uses the WQL LIKE operator, then you must escape the following characters by
enclosing them in square brackets ([]): percent (%), underscore (_), or opening square bracket ([).
Required? true
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-QueryDialect [<String>]
Specifies the query language used for the Query parameter. The acceptable values for this parameter are:
-- WQL
-- CQL
The default value is WQL.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceUri <Uri>
Specifies the resource uniform resource identifier (URI) of the resource class or instance. The URI is used to identify a specific type of
resource, such as disks or processes, on a computer.
A URI consists of a prefix and a path to a resource. For example:
HYPERLINK "http://schemas.microsoft.com/wbem/wsman ... ogicalDisk"
http://schemas.microsoft.com/wbem/wsman ... ogicalDisk
HYPERLINK "http://intel.com/wbem/wscim/1/amt-schem ... alSettings" http://intel.com/wbem/wscim/1/amt-schem ... alSettings
By default, if you do not specify this parameter, the DMTF standard resource URI http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/ is used
and the class name is appended to it.
ResourceURI can only be used with CIM sessions created using the WSMan protocol, or when specifying the ComputerName parameter, which creates
a CIM session using WSMan. If you specify this parameter without specifying the ComputerName parameter, or if you specify a CIM session
created using DCOM protocol, you will get an error, because the DCOM protocol does not support the ResourceURI parameter.
If both the ResourceURI parameter and the Filter parameter are specified, the Filter parameter is ignored.
Required? true
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
CIM class
This cmdlet accepts a CIM class as an input object.
CIM instance
This cmdlet accepts a CIM instance as an input object.
OUTPUTS
System.Management.Automation.PSCustomObject
This cmdlet returns an object.
Example 1: Invoke a method
PS C:\\>Invoke-CimMethod ????????Query ??????select * from Win32_Process where name like "notepad%"?????? ????????MethodName "Terminate"
This command invokes the method named Terminate on the CIM class named Win32_Process. The CIM class is retrieved by the query "Select * from
Win32_Process where name like ??????notepad%??????".
Example 2: Invoke a method using CIM instance object
PS C:\\>$x = Get-CimInstance -Query ??????Select * from Win32_Process where name like "notepad%"??????
PS C:\\> Invoke-CimMethod -InputObject $x -MethodName "GetOwner"
This set of commands retrieves the CIM instance object and stores it in a variable named $x using the Get-CimInstance cmdlet. The contents of the
variable are then used as the InputObject for the Invoke-CimMethod cmdlet, and the GetOwner method is invoked for the CimInstance.
Example 3: Invoke a static method
PS C:\\>Invoke-CimMethod ????????ClassName Win32_Process ????????MethodName "Create" ????????Arguments @{ Path = "notepad.exe" }
This command invokes the static method Create on the class named Win32_Process with the arguments specified by the Arguments parameter.
Example 4: Invoke a method using arguments
PS C:\\>Invoke-CimMethod -ClassName Win32_Process -MethodName "Create" -Arguments @{ CommandLine = ??????notepad.exe??????; CurrentDirectory =
"C:\\windows\\system32" }
This command invokes the method named Create using the Arguments parameter.
Example 5: Client-side validation
PS C:\\>$c = Get-CimClass ????????ClassName Win32_Process
PS C:\\> Invoke-CimMethod -CimClass $c -MethodName "xyz" ????????Arguments @{ CommandLine = ??????notepad.exe?????? }
This set of commands does client-side validation for the method named xyz by passing a CimClass object to the Invoke-CimMethod cmdlet.
RELATED LINKS
Online Version:
Get-CimClass
Get-CimInstance
Get-CimSession
New-CimSessionOption