Set-CimInstance

Syntax

Set-CimInstance
   [-ComputerName <String[]>]
   [-ResourceUri <Uri>]
   [-OperationTimeoutSec <UInt32>]
   [-InputObject] <CimInstance>
   [-Property <IDictionary>]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CimInstance
   -CimSession <CimSession[]>
   [-ResourceUri <Uri>]
   [-OperationTimeoutSec <UInt32>]
   [-InputObject] <CimInstance>
   [-Property <IDictionary>]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CimInstance
   -CimSession <CimSession[]>
   [-Namespace <String>]
   [-OperationTimeoutSec <UInt32>]
   [-Query] <String>
   [-QueryDialect <String>]
   -Property <IDictionary>
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CimInstance
   [-ComputerName <String[]>]
   [-Namespace <String>]
   [-OperationTimeoutSec <UInt32>]
   [-Query] <String>
   [-QueryDialect <String>]
   -Property <IDictionary>
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

This cmdlet is only available on the Windows platform.

This cmdlet modifies a CIM instance on a CIM server.

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. This is not very common.

Examples

Example 1: Set the CIM instance

This example sets the value of the VariableValue property to abcd using the Query parameter. You can modify instances matching a Windows Management Instrumentation Query Language (WQL) query.

Set-CimInstance -Query 'Select * from Win32_Environment where name LIKE "testvar%"' -Property @{VariableValue="abcd"}

Example 2: Set the CIM instance property using pipeline

This example retrieves the CIM instance object filtered by the Query parameter using the Get-CimInstance cmdlet. The Set-CimInstance cmdlet modifies the value of VariableValue property to abcd.

Get-CimInstance -Query 'Select * from Win32_Environment where name LIKE "testvar%"' |
  Set-CimInstance -Property @{VariableValue="abcd"}

Example 3: Set the CIM instance property using input object

$x = Get-CimInstance -Query 'Select * from Win32_Environment where Name="testvar"'
Set-CimInstance -InputObject $x -Property @{VariableValue="somevalue"} -PassThru

This example retrieves the CIM instance objects filtered by the Query parameter in to a variable $x using Get-CimInstance, and then passes the contents of the variable to the Set-CimInstance cmdlet. Set-CimInstance then modifies the VariableValue property to somevalue. Because the Passthru parameter is used, This example returns a modified CIM instance object.

Example 4: Set the CIM instance property

This example retrieves the CIM instance object that is specified in the Query parameter into a variable $x using the Get-CimInstance cmdlet, and changes the VariableValue property value of the object to change. The CIM instance object is then saved using the Set-CimInstance cmdlet. Because the Passthru parameter is used, This example returns a modified CIM instance object.

$x = Get-CimInstance -Query 'Select * from Win32_Environment where name="testvar"'
$x.VariableValue = "Change"
Set-CimInstance -CimInstance $x -PassThru

Example 5: Show the list of CIM instances to modify using WhatIf

This example uses the common parameter WhatIf to specify that the modification should not be done, but only output what would happen if it were done.

Set-CimInstance -Query 'Select * from Win32_Environment where name LIKE "testvar%"' -Property @{VariableValue="abcd"} -WhatIf

Example 6: Set the CIM instance after confirmation from the user

This example uses the common parameter Confirm to specify that the modification should be done only after confirmation from the user.

Set-CimInstance -Query 'Select * from Win32_Environment where name LIKE "testvar%"' -Property @{VariableValue="abcd"} -Confirm

Example 7: Set the created CIM instance

This example creates a CIM instance with the specified properties using the New-CimInstance cmdlet, and retrieves its contents in to a variable $x. The variable is then passed to the Set-CimInstance cmdlet, which modifies the value of VariableValue property to somevalue. Because the Passthru parameter is used, This example returns a modified CIM instance object.

$x = New-CimInstance -ClassName Win32_Environment -Property @{Name="testvar";UserName="domain\user"} -Keys Name,UserName -ClientOnly
Set-CimInstance -CimInstance $x -Property @{VariableValue="somevalue"} -PassThru

Parameters

-CimSession

-ComputerName

-Confirm

-InputObject

-Namespace

-OperationTimeoutSec

-PassThru

-Property

-Query

-QueryDialect

-ResourceUri

-WhatIf

Inputs

CimInstance

Outputs

CimInstance

When the Passthru parameter is specified, this cmdlet returns a modified CIM instance object.

Related Links

• Get-CimInstance
• New-CimInstance
• Remove-CimInstance