Set-CimInstance

構文

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

説明

このコマンドレットは、Windows プラットフォームでのみ使用できます。

このコマンドレットは、CIM サーバー上の CIM インスタンスを変更します。

InputObject パラメーターが指定されていない場合、コマンドレットは次のいずれかの方法で動作します。

• ComputerName パラメーターも CimSession パラメーターも指定されていない場合、このコマンドレットはコンポーネント オブジェクト モデル (COM) セッションを使用してローカル Windows Management Instrumentation (WMI) で動作します。
• ComputerName パラメーターまたは CimSession パラメーターが指定されている場合、このコマンドレットは、ComputerName パラメーターまたは CimSession パラメーターで指定された CIM サーバーに対して動作します。

InputObject パラメーターが指定されている場合、コマンドレットは次のいずれかの方法で動作します。

• ComputerName パラメーターも CimSession パラメーターも指定されていない場合、このコマンドレットは入力オブジェクトの CIM セッションまたはコンピューター名を使用します。
• ComputerName パラメーターまたは CimSession パラメーターのいずれかを指定した場合、このコマンドレットは、CimSession パラメーター値または ComputerName パラメーター値を使用します。 これはあまり一般的ではありません。

例

例 1: CIM インスタンスを設定する

次の使用例は、Query パラメーターを使用して、VariableValue プロパティの値を abcd に設定します。 Windows Management Instrumentation Query Language (WQL) クエリに一致するインスタンスを変更できます。

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

例 2: パイプラインを使用して CIM インスタンス プロパティを設定する

この例では、Get-CimInstance コマンドレットを使用して、Query パラメーターでフィルター処理された CIM インスタンス オブジェクトを取得します。 Set-CimInstance コマンドレットは、VariableValue プロパティの値を abcd に変更します。

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

例 3: 入力オブジェクトを使用して CIM インスタンス・プロパティーを設定する

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

この例では、クエリ パラメーターでフィルター処理された CIM インスタンス オブジェクトを、Get-CimInstanceを使用して$x変数に取得し、変数の内容を Set-CimInstance コマンドレットに渡します。 Set-CimInstance 次に、 VariableValue プロパティを somevalue に変更します。 Passthru パラメーターが使用されているため、この例では変更された CIM インスタンス オブジェクトを返します。

例 4: CIM インスタンス・プロパティーを設定する

この例では、Get-CimInstance コマンドレットを使用して、Query パラメーターで指定された CIM インスタンス オブジェクトを変数$xに取得し、変更するオブジェクトの VariableValue プロパティ値を変更します。 CIM インスタンス オブジェクトは、 Set-CimInstance コマンドレットを使用して保存されます。 Passthru パラメーターが使用されているため、この例では変更された CIM インスタンス オブジェクトを返します。

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

例 5: WhatIf を使用して変更する CIM インスタンスのリストを表示する

この例では、共通パラメーター WhatIf を使用して、変更を行う必要はなく、行われた場合に何が起こるかを出力するように指定します。

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

例 6: ユーザーからの確認後に CIM インスタンスを設定する

この例では、共通パラメーター Confirm を使用して、ユーザーからの確認後にのみ変更を行う必要があることを指定します。

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

例 7: 作成された CIM インスタンスを設定する

この例では、 New-CimInstance コマンドレットを使用して、指定したプロパティを持つ CIM インスタンスを作成し、その内容を変数 $xに取得します。 その後、変数が Set-CimInstance コマンドレットに渡され、 VariableValue プロパティの値が somevalue に変更されます。 Passthru パラメーターが使用されているため、この例では変更された CIM インスタンス オブジェクトを返します。

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

パラメーター

-CimSession

-ComputerName

-Confirm

-InputObject

-Namespace

-OperationTimeoutSec

-PassThru

-Property

-Query

-QueryDialect

-ResourceUri

-WhatIf

入力

CimInstance

出力

None

既定では、このコマンドレットは出力を返しません。

CimInstance

Passthru パラメーターを使用すると、このコマンドレットは変更された CIM インスタンス オブジェクトを返します。

メモ

PowerShell には、 Set-CimInstanceの次のエイリアスが含まれています。

• Windows:
  • scim

このコマンドレットは、Windows プラットフォームでのみ使用できます。

関連リンク

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