Invoke-CimMethod

リファレンス

モジュール:: CimCmdlets

CIM クラスのメソッドを呼び出します。

構文

Invoke-CimMethod
      [-ClassName] <String>
      [-ComputerName <String[]>]
      [[-Arguments] <IDictionary>]
      [-MethodName] <String>
      [-Namespace <String>]
      [-OperationTimeoutSec <UInt32>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-CimMethod
      [-ClassName] <String>
      -CimSession <CimSession[]>
      [[-Arguments] <IDictionary>]
      [-MethodName] <String>
      [-Namespace <String>]
      [-OperationTimeoutSec <UInt32>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-CimMethod
      -ResourceUri <Uri>
      [-ComputerName <String[]>]
      [[-Arguments] <IDictionary>]
      [-MethodName] <String>
      [-Namespace <String>]
      [-OperationTimeoutSec <UInt32>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-CimMethod
      [-ResourceUri <Uri>]
      [-InputObject] <CimInstance>
      -CimSession <CimSession[]>
      [[-Arguments] <IDictionary>]
      [-MethodName] <String>
      [-OperationTimeoutSec <UInt32>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-CimMethod
      [-ResourceUri <Uri>]
      [-InputObject] <CimInstance>
      [-ComputerName <String[]>]
      [[-Arguments] <IDictionary>]
      [-MethodName] <String>
      [-OperationTimeoutSec <UInt32>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-CimMethod
      -ResourceUri <Uri>
      -CimSession <CimSession[]>
      [[-Arguments] <IDictionary>]
      [-MethodName] <String>
      [-Namespace <String>]
      [-OperationTimeoutSec <UInt32>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-CimMethod
      [-CimClass] <CimClass>
      [-ComputerName <String[]>]
      [[-Arguments] <IDictionary>]
      [-MethodName] <String>
      [-OperationTimeoutSec <UInt32>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-CimMethod
      [-CimClass] <CimClass>
      -CimSession <CimSession[]>
      [[-Arguments] <IDictionary>]
      [-MethodName] <String>
      [-OperationTimeoutSec <UInt32>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-CimMethod
      -Query <String>
      [-QueryDialect <String>]
      [-ComputerName <String[]>]
      [[-Arguments] <IDictionary>]
      [-MethodName] <String>
      [-Namespace <String>]
      [-OperationTimeoutSec <UInt32>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-CimMethod
      -Query <String>
      [-QueryDialect <String>]
      -CimSession <CimSession[]>
      [[-Arguments] <IDictionary>]
      [-MethodName] <String>
      [-Namespace <String>]
      [-OperationTimeoutSec <UInt32>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

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

Invoke-CimMethod コマンドレットは、Arguments パラメーターで指定された名前と値のペアを使用して、CIM クラスまたは CIM インスタンスのメソッドを呼び出します。

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

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

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

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

例

例 1: メソッドを呼び出す

この例では、Win32_Process クラスの Terminate メソッドを呼び出します。

Invoke-CimMethod -Query 'select * from Win32_Process where name like "notepad%"' -MethodName "Terminate"

例 2: CIM インスタンスオブジェクトを使用してメソッドを呼び出す

この例では、CIM インスタンスオブジェクトを取得し、Get-CimInstance コマンドレットを使用して $x という名前の変数に格納します。その後、変数の内容は、Invoke-CimMethod コマンドレットの InputObject として使用されます。 GetOwner メソッドは、CimInstance に対して呼び出されます。

$x = Get-CimInstance -Query 'Select * from Win32_Process where name like "notepad%"'
Invoke-CimMethod -InputObject $x -MethodName GetOwner

例 3: 引数を使用して静的メソッドを呼び出す

この例では、Arguments パラメーターを使用してCreate メソッドを呼び出します。

Invoke-CimMethod -ClassName Win32_Process -MethodName "Create" -Arguments @{
  CommandLine = 'notepad.exe'; CurrentDirectory = "C:\windows\system32"
}

例 4: クライアント側の検証

この例では、CimClass オブジェクトをInvoke-CimMethodに渡すことによって、xyz メソッドのクライアント側検証を実行します。

$c = Get-CimClass -ClassName Win32_Process
Invoke-CimMethod -CimClass $c -MethodName "xyz" -Arguments @{ CommandLine = 'notepad.exe' }

パラメーター

-Arguments

呼び出したメソッドに渡すパラメーターを指定します。ハッシュテーブルに格納されている名前と値のペアとして、このパラメーターの値を指定します。入力された値の順序は重要ではありません。

型:	IDictionary
配置:	1
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-CimClass

サーバー上の CIM クラス定義を表す CIM クラス・オブジェクトを指定します。クラスの静的メソッドを呼び出す場合は、このパラメーターを使用します。

Get-CimClass コマンドレットを使用して、サーバーからクラス定義を取得できます。

このパラメーターを使用すると、クライアント側のスキーマ検証が向上します。

型:	CimClass
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-CimSession

指定した CIM セッションを使用してコマンドを実行します。 CIM セッションを含む変数、または CIM セッションを作成または取得するコマンド ( New-CimSession 、 Get-CimSession コマンドレットなど) を入力します。詳細については、「 about_CimSession」を参照してください。

型:	CimSession[]
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ClassName

操作を実行する CIM クラスの名前を指定します。このパラメーターは、静的メソッドにのみ使用されます。 PowerShell はローカル WMI サーバーからクラスの一覧を取得してクラス名の一覧を提供するため、タブ補完を使用してクラスの一覧を参照できます。

型:	String
Aliases:	Class
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ComputerName

CIM 操作を実行するコンピューターの名前を指定します。完全修飾ドメイン名 (FQDN)、NetBIOS 名、または IP アドレスを指定できます。

このパラメーターを使用する場合、コマンドレットは WsMan プロトコルを使用して、指定されたコンピューターへの一時的なセッションを作成します。それ以外の場合、コマンドレットはコンポーネントオブジェクトモデル (COM) を使用してローカルコンピューターで操作を実行します。

同じコンピューターで複数の操作が実行されている場合のパフォーマンスを向上させるために、CIM セッションを使用して接続します。

型:	String[]
Aliases:	CN, ServerName
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

型:	SwitchParameter
Aliases:	cf
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-InputObject

メソッドを呼び出す入力として使用する CIM インスタンスオブジェクトを指定します。このパラメーターは、インスタンスメソッドの呼び出しにのみ使用できます。クラスの静的メソッドを呼び出すには、 Class パラメーターまたは CimClass パラメーターを使用します。

型:	CimInstance
Aliases:	CimInstance
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-MethodName

呼び出す CIM メソッドの名前を指定します。このパラメーターは必須です。Null や空にはできません。 CIM クラスの静的メソッドを呼び出すには、 ClassName または CimClass パラメーターを使用します。

型:	String
Aliases:	Name
配置:	2
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Namespace

CIM 操作の名前空間を指定します。既定の名前空間は root/cimv2 です。 PowerShell はローカル WMI サーバーから名前空間の一覧を取得して名前空間の一覧を提供するため、タブ補完を使用して名前空間の一覧を参照できます。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-OperationTimeoutSec

コマンドレットがコンピューターからの応答を待機する時間を指定します。既定では、値は 0 です。つまり、コマンドレットはサーバーの既定のタイムアウト値を使用します。

OperationTimeoutSec パラメーターが既定の接続再試行タイムアウト 3 分未満の値に設定されている場合、OperationTimeoutSec パラメーターの値を超えるネットワーク障害は復旧できません。

型:	UInt32
Aliases:	OT
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Query

CIM サーバーで実行するクエリを指定します。クエリの結果として受け取ったインスタンスに対してメソッドが呼び出されます。クエリ言語は、 QueryDialect パラメーターを使用して指定できます。

指定した値に二重引用符 (")、単一引用符 (')、または円記号 (\) が含まれている場合は、それらの文字の前に円記号 (\) を付けてエスケープする必要があります。指定した値が WQL LIKE 演算子を使用する場合は、次の文字を角かっこ ([]): パーセント (%)、アンダースコア (_)、または角かっこ ([) で囲んでエスケープする必要があります。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-QueryDialect

Query パラメーターに使用するクエリ言語を指定します。このパラメーターに使用できる値は、 WQL または CQL です。

既定値は WQL です。

型:	String
配置:	Named
規定値:	WQL
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ResourceUri

リソースクラスまたはインスタンスのリソース Uniform Resource Identifier (URI) を指定します。 URI は、ディスクやプロセスなど、コンピューター上の特定の種類のリソースを特定するために使用されます。

URI は、プレフィックスとリソースのパスで構成されます。次に例を示します。

http://schemas.microsoft.com/wbem/wsman/1/wmi/root/cimv2/Win32_LogicalDisk

http://intel.com/wbem/wscim/1/amt-schema/1/AMT_GeneralSettings

既定では、このパラメーターを指定しない場合、DMTF 標準リソース URI http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/ が使用され、クラス名が追加されます。

ResourceURI は、WSMan プロトコルを使用して作成された CIM セッション、または WSMan を使用して CIM セッションを作成する ComputerName パラメーターを指定する場合にのみ使用できます。

ComputerName パラメーターを指定せずにこのパラメーターを指定した場合、または DCOM プロトコルを使用して作成された CIM セッションを指定すると、エラーが発生します。 DCOM プロトコルは、 ResourceURI パラメーターをサポートしていません。

ResourceUri パラメーターと Filter パラメーターの両方を指定した場合、Filter パラメーターは無視されます。

型:	Uri
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-WhatIf

コマンドレットの実行時に発生する内容を示します。このコマンドレットは実行されません。

型:	SwitchParameter
Aliases:	wi
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

入力

CimClass

CIM クラスをこのコマンドレットにパイプできます。

CimInstance

CIM インスタンスをこのコマンドレットにパイプできます。

出力

PSCustomObject

このコマンドレットはオブジェクトを返します。

メモ

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

Windows:
- icim

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

次の方法で共有

Invoke-CimMethod

構文

説明

例

例 1: メソッドを呼び出す

例 2: CIM インスタンスオブジェクトを使用してメソッドを呼び出す

例 3: 引数を使用して静的メソッドを呼び出す

例 4: クライアント側の検証

パラメーター

-Arguments

-CimClass

-CimSession

-ClassName

-ComputerName

-Confirm

-InputObject

-MethodName

-Namespace

-OperationTimeoutSec

-Query

-QueryDialect

-ResourceUri

-WhatIf

入力

出力

メモ

その他のリソース

次の方法で共有

Invoke-CimMethod

構文

説明

例

例 1: メソッドを呼び出す

例 2: CIM インスタンス オブジェクトを使用してメソッドを呼び出す

例 3: 引数を使用して静的メソッドを呼び出す

例 4: クライアント側の検証

パラメーター

-Arguments

-CimClass

-CimSession

-ClassName

-ComputerName

-Confirm

-InputObject

-MethodName

-Namespace

-OperationTimeoutSec

-Query

-QueryDialect

-ResourceUri

-WhatIf

入力

出力

メモ

関連リンク

その他のリソース

例 2: CIM インスタンスオブジェクトを使用してメソッドを呼び出す