Export (0) Print
Expand All

Remove-CimInstance

Updated: June 3, 2013

Applies To: Windows Server 2012

Remove-CimInstance

Removes a CIM instance from a computer.

Syntax

Parameter Set: CimInstanceComputerSet
Remove-CimInstance [-InputObject] <CimInstance> [-ComputerName <String[]> ] [-OperationTimeoutSec <UInt32> ] [-ResourceUri <Uri> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: CimInstanceSessionSet
Remove-CimInstance [-InputObject] <CimInstance> -CimSession <CimSession[]> [-OperationTimeoutSec <UInt32> ] [-ResourceUri <Uri> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: QueryComputerSet
Remove-CimInstance [-Query] <String> [[-Namespace] <String> ] [-ComputerName <String[]> ] [-OperationTimeoutSec <UInt32> ] [-QueryDialect <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: QuerySessionSet
Remove-CimInstance [-Query] <String> [[-Namespace] <String> ] -CimSession <CimSession[]> [-OperationTimeoutSec <UInt32> ] [-QueryDialect <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Remove-CimInstance cmdlet removes a CIM instance from a CIM server.

You can specify the CIM instance to remove by using either a CIM instance object retrieved by the Get-CimInstance cmdlet, or by specifying a query.

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.

Parameters

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


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

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) or a NetBIOS name.

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.


Aliases

CN,ServerName

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-InputObject<CimInstance>

Specifies a CIM instance object to be removed from the CIM server.
Note: The input object passed to the cmdlet is not changed, only the instance in the CIM server is removed.


Aliases

CimInstance

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue)

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.


Aliases

none

Required?

false

Position?

2

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 of this parameter 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.


Aliases

OT

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. 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 ([).


Aliases

none

Required?

true

Position?

1

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 or CQL.

The default value is WQL.


Aliases

none

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:

http://schemas.microsoft.com/wbem/wsman/1/wmi/root/cimv2/Win32_LogicalDisk
http://intel.com/wbem/wscim/1/amt-schema/1/AMT_GeneralSettings

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • None

    This cmdlet accepts no input objects.


Outputs

The output type is the type of the objects that the cmdlet emits.

  • None

    This cmdlet produces no outputs.


Examples

Example 1: Remove the CIM instance

This command removes the CIM instances that start with the character string testvar from the class named Win32_Environment using the Query parameter.


PS C:\> Remove-CimInstance -Query 'Select * from Win32_Environment where name LIKE "testvar%"

Example 2: Remove the CIM instance using CIM instance object

This set of commands retrieves the CIM instance objects filtered by the Query parameter and stores them in variable named $var using the Get-CimInstance cmdlet. The contents of the variable are then passed to the Remove-CimInstance cmdlet, which removes the CIM instances.


 

PS C:\> calc.exe

 

PS C:\> $var = Get-CimInstance -Query 'Select * from Win32_Process where name LIKE "calc%"'

 

PS C:\> Remove-CimInstance –InputObject $var

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft