Set-CimInstance

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

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

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

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

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.

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.

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

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"}

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

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

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.

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

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

$instance = @{
    Query = 'Select * from Win32_Environment where name LIKE "testvar%"'
    Property = @{VariableValue="abcd"}
    Confirm = $true
}
Set-CimInstance @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.

$instance = @{
    ClassName = 'Win32_Environment'
    Property = @{
        Name="testvar"
        UserName="___domain\user"
    }
    Key = 'Name', 'UserName'
    ClientOnly = $true
}
$x = New-CimInstance @instance
Set-CimInstance -CimInstance $x -Property @{VariableValue="somevalue"} -PassThru

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

By default, this cmdlet returns no output.

When you use the PassThru parameter, this cmdlet returns the modified CIM instance object.

PowerShell includes the following aliases for Set-CimInstance:

• Windows:
  • scim

This cmdlet is only available on Windows platforms.