Invoke-WmiMethod

リファレンス

モジュール:: Microsoft.PowerShell.Management

WMI メソッドを呼び出します。

構文

Invoke-WmiMethod
      [-Class] <String>
      [-Name] <String>
      [-ArgumentList <Object[]>]
      [-AsJob]
      [-Impersonation <ImpersonationLevel>]
      [-Authentication <AuthenticationLevel>]
      [-Locale <String>]
      [-EnableAllPrivileges]
      [-Authority <String>]
      [-Credential <PSCredential>]
      [-ThrottleLimit <Int32>]
      [-ComputerName <String[]>]
      [-Namespace <String>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-WmiMethod
      -InputObject <ManagementObject>
      [-Name] <String>
      [-ArgumentList <Object[]>]
      [-AsJob]
      [-ThrottleLimit <Int32>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-WmiMethod
      -Path <String>
      [-Name] <String>
      [-ArgumentList <Object[]>]
      [-AsJob]
      [-Impersonation <ImpersonationLevel>]
      [-Authentication <AuthenticationLevel>]
      [-Locale <String>]
      [-EnableAllPrivileges]
      [-Authority <String>]
      [-Credential <PSCredential>]
      [-ThrottleLimit <Int32>]
      [-ComputerName <String[]>]
      [-Namespace <String>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-WmiMethod
      [-Name] <String>
      [-AsJob]
      [-Impersonation <ImpersonationLevel>]
      [-Authentication <AuthenticationLevel>]
      [-Locale <String>]
      [-EnableAllPrivileges]
      [-Authority <String>]
      [-Credential <PSCredential>]
      [-ThrottleLimit <Int32>]
      [-ComputerName <String[]>]
      [-Namespace <String>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-WmiMethod
      [-Name] <String>
      [-AsJob]
      [-Impersonation <ImpersonationLevel>]
      [-Authentication <AuthenticationLevel>]
      [-Locale <String>]
      [-EnableAllPrivileges]
      [-Authority <String>]
      [-Credential <PSCredential>]
      [-ThrottleLimit <Int32>]
      [-ComputerName <String[]>]
      [-Namespace <String>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-WmiMethod
      [-Name] <String>
      [-AsJob]
      [-Impersonation <ImpersonationLevel>]
      [-Authentication <AuthenticationLevel>]
      [-Locale <String>]
      [-EnableAllPrivileges]
      [-Authority <String>]
      [-Credential <PSCredential>]
      [-ThrottleLimit <Int32>]
      [-ComputerName <String[]>]
      [-Namespace <String>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

Invoke-WmiMethod コマンドレットは、Windows Management Instrumentation (WMI) オブジェクトのメソッドを呼び出します。

Windows PowerShell 3.0 で導入された新しい Common Information Model (CIM) コマンドレットは、WMI コマンドレットと同じタスクを実行します。 CIM コマンドレットは WS-Management (WSMan) 標準と CIM 標準に準拠しています。これにより、コマンドレットは同じ手法を使用して Windows コンピューターや他のオペレーティングシステムを実行しているコンピューターを管理できます。 Invoke-WmiMethodを使用する代わりに、Invoke-CimMethod を使用することを検討してください。

例

例 1: WMI メソッドパラメーターの必要な順序を一覧表示する

このコマンドは、必要なオブジェクトの順序を一覧表示します。

Get-WmiObject Win32_Volume |
    Get-Member -MemberType Method -Name Format |
    Select-Object -ExpandProperty Definition

System.Management.ManagementBaseObject Format(System.String FileSystem, System.Boolean QuickFormat,
 System.UInt32 ClusterSize, System.String Label, System.Boolean EnableCompression,
 System.UInt32 Version)

PowerShell 3.0 での WMI の呼び出しは他の方法とは異なり、オブジェクト値を特定の順序で入力する必要があります。

例 2: アプリケーションのインスタンスを開始する

([Wmiclass]'Win32_Process').Create.OverloadDefinitions

System.Management.ManagementBaseObject Create(System.String CommandLine, System.String CurrentDirectory,
 System.Management.ManagementObject#Win32_ProcessStartup ProcessStartupInformation)

Invoke-WmiMethod -Path Win32_Process -Name Create -ArgumentList C:\Windows\system32\notepad.exe

__GENUS          : 2
__CLASS          : __PARAMETERS
__SUPERCLASS     :
__DYNASTY        : __PARAMETERS
__RELPATH        :
__PROPERTY_COUNT : 2
__DERIVATION     : {}
__SERVER         :
__NAMESPACE      :
__PATH           :
ProcessId        : 11312
ReturnValue      : 0
PSComputerName   :

このコマンドは、Win32_Process クラスのCreate メソッドを呼び出して、メモ帳のインスタンスを開始します。

ReturnValue プロパティには0が設定され、コマンドが完了すると、ProcessId プロパティに整数 (次のプロセス ID 番号) が設定されます。

例 3: ファイルの名前を変更する

$invokeWmiMethodSplat = @{
    Path = "CIM_DataFile.Name='C:\scripts\test.txt'"
    Name = 'Rename'
    ArgumentList = 'C:\scripts\test_bu.txt'
}
Invoke-WmiMethod @invokeWmiMethodSplat

__GENUS          : 2
__CLASS          : __PARAMETERS
__SUPERCLASS     :
__DYNASTY        : __PARAMETERS
__RELPATH        :
__PROPERTY_COUNT : 1
__DERIVATION     : {}
__SERVER         :
__NAMESPACE      :
__PATH           :
ReturnValue      : 0

このコマンドは、ファイル名を変更します。 Path パラメーターを使用して、CIM_DataFile クラスのインスタンスを参照します。次に、その特定のインスタンスに対して Rename メソッドを適用します。

コマンドが完了すると、 ReturnValue プロパティに 0 が設定されます。

例 4: '-ArgumentList' を使用して値の配列を渡す

オブジェクトの配列を使用する例 $binSD 、その後に $null 値が続きます。

$acl = Get-Acl test.txt
$binSD = $acl.GetSecurityDescriptorBinaryForm()
$invokeWmiMethodSplat = @{
    Class = 'Win32_SecurityDescriptorHelper'
    Name = 'BinarySDToSDDL'
    ArgumentList = $binSD, $null
}
Invoke-WmiMethod @invokeWmiMethodSplat

パラメーター

-ArgumentList

呼び出したメソッドに渡すパラメーターを指定します。このパラメーターの値はオブジェクトの配列である必要があり、呼び出されたメソッドで必要な順序で指定する必要があります。 Invoke-CimCommand コマンドレットには、これらの制限はありません。

これらのオブジェクトを一覧表示する順序を決定するには、このトピックの最後に近い例 1 に示すように、WMI クラスで GetMethodParameters() メソッドを実行します。

重要

最初の値が複数の要素を含む配列の場合は、2 番目の値 $null が必要です。それ以外の場合は、 Unable to cast object of type 'System.Byte' to type 'System.Array'.などのエラーが生成されます。上記の例 4 を参照してください。

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

-AsJob

このコマンドレットがバックグラウンドジョブとしてコマンドを実行することを示します。完了に時間のかかるコマンドを実行するには、このパラメーターを使用します。

AsJob パラメーターを使用すると、バックグラウンドジョブを表すオブジェクトが返され、コマンドプロンプトが表示されます。ジョブが完了しても、引き続きセッションで作業できます。 Invoke-WmiMethodリモートコンピューターに対して使用すると、ジョブがローカルコンピューターに作成され、リモートコンピューターからの結果がローカルコンピューターに自動的に返されます。ジョブを管理するには、 Job 名詞 (Job コマンドレット) を含むコマンドレットを使用します。ジョブの結果を取得するには、 Receive-Job コマンドレットを使用します。

このパラメーターをリモートコンピューターで使用するには、ローカルコンピューターおよびリモートコンピューターをリモート処理用に構成する必要があります。さらに、Windows Vista 以降のバージョンの Windows で Run as administrator オプションを使用して Windows PowerShell を起動する必要があります。詳細については、「about_Remote_Requirements」を参照してください。

Windows PowerShell バックグラウンドジョブの詳細については、「 about_Jobs と about_Remote_Jobs」を参照してください。

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

-Authentication

WMI 接続に使用する認証レベルを指定します。このパラメーターの有効値は、次のとおりです。

-1: Unchanged
0: Default
1: None (認証は実行されません。
2: Connect (認証は、クライアントがアプリケーションとの関係を確立した場合にのみ実行されます)。
3: Call (認証は、アプリケーションが要求を受信したときに、各呼び出しの開始時にのみ実行されます)。
4: Packet (認証は、クライアントから受信したすべてのデータに対して実行されます)。
5: PacketIntegrity (クライアントとアプリケーションの間で転送されるすべてのデータが認証および検証されます)。
6: PacketPrivacy (他の認証レベルのプロパティが使用され、すべてのデータが暗号化されます)。

型:	AuthenticationLevel
指定可能な値:	Default, None, Connect, Call, Packet, PacketIntegrity, PacketPrivacy, Unchanged
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Authority

WMI 接続の認証に使用する機関を指定します。標準の Windows NT LAN Manager (NTLM) 認証または Kerberos 認証を指定できます。 NTLM を使用するには、機関設定を ntlmdomain:<DomainName> に設定します。ここで、 <DomainName> は有効な NTLM ドメイン名を識別します。 Kerberos を使用するには、 kerberos:<DomainName>\<ServerName>を指定します。ローカルコンピューターへの接続時に認証設定を指定することもできます。

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

-Class

静的な呼び出しメソッドが含まれている WMI クラスを指定します。

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

-ComputerName

このコマンドレットでコマンドを実行するコンピューターを、文字列配列として指定します。既定値はローカルコンピューターです。

1 台または複数のコンピューターの NetBIOS 名、IP アドレス、または完全修飾ドメイン名を入力します。ローカルコンピューターを指定するには、コンピューター名、ドット (.)、または localhostを入力します。

このパラメーターは、Windows PowerShell リモート処理に依存しません。コンピューターがリモートコマンドを実行するように構成されていない場合でも、 ComputerName パラメーターを使用できます。

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

-Confirm

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

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

-Credential

この処理を実行するアクセス許可を持つユーザーアカウントを指定します。既定値は現在のユーザーです。 User01、Domain01\User01、User@Contoso.comなどのユーザー名を入力します。または、Get-Credential コマンドレットによって返されるオブジェクトなど、PSCredential オブジェクトを入力します。ユーザー名を入力すると、パスワードの入力を促すメッセージが表示されます。

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

-EnableAllPrivileges

このコマンドレットは、コマンドが WMI 呼び出しを行う前に、現在のユーザーのすべての特権を有効にすることを示します。

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

-Impersonation

使用する偽装レベルを指定します。このパラメーターの有効値は、次のとおりです。

0: Default (既定の偽装レベルのローカルレジストリを読み取ります。通常は 3: Impersonate に設定されます)。
1: Anonymous (呼び出し元の資格情報を非表示にします)。
2: Identify (オブジェクトが呼び出し元の資格情報を照会できるようにします)。
3: Impersonate (オブジェクトが呼び出し元の資格情報を使用できるようにします)。
4: Delegate (他のオブジェクトが呼び出し元の資格情報を使用することをオブジェクトに許可します)。

型:	ImpersonationLevel
指定可能な値:	Default, Anonymous, Identify, Impersonate, Delegate
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-InputObject

入力として使用する ManagementObject オブジェクトを指定します。このパラメーターを使用すると、 Flag パラメーターと Argument パラメーターを除く他のすべてのパラメーターは無視されます。

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

-Locale

WMI オブジェクトの優先ロケールを指定します。 Locale パラメーターの値を、MS_<LCID>形式の配列として優先順序で指定します。

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

-Name

呼び出すメソッドの名前を指定します。このパラメーターは必須です。Null や空にはできません。

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

-Namespace

Class パラメーターと共に使用する場合、このパラメーターは、参照される WMI クラスまたはオブジェクトが配置されている WMI リポジトリ名前空間を指定します。

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

-Path

WMI クラスの WMI オブジェクトパス、または WMI クラスのインスタンスの WMI オブジェクトパスを指定します。指定するクラスまたはインスタンスには、 Name パラメーターで指定されたメソッドが含まれている必要があります。

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

-ThrottleLimit

同時に実行できる WMI 操作の数のスロットル値を指定します。このパラメーターは、 AsJob パラメーターと共に使用されます。スロットル制限は現在のコマンドのみに適用され、セッションまたはコンピューターには適用されません。

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

-WhatIf

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

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

入力

None

このコマンドレットは入力を受け取りません。

出力

None

このコマンドレットは出力を生成しません。

メモ

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

iwmi

次の方法で共有

Invoke-WmiMethod

構文

説明

例

例 1: WMI メソッドパラメーターの必要な順序を一覧表示する

例 2: アプリケーションのインスタンスを開始する

例 3: ファイルの名前を変更する

例 4: '-ArgumentList' を使用して値の配列を渡す

パラメーター

-ArgumentList

-AsJob

-Authentication

-Authority

-Class

-ComputerName

-Confirm

-Credential

-EnableAllPrivileges

-Impersonation

-InputObject

-Locale

-Name

-Namespace

-Path

-ThrottleLimit

-WhatIf

入力

出力

メモ

その他のリソース

次の方法で共有

Invoke-WmiMethod

構文

説明

例

例 1: WMI メソッド パラメーターの必要な順序を一覧表示する

例 2: アプリケーションのインスタンスを開始する

例 3: ファイルの名前を変更する

例 4: '-ArgumentList' を使用して値の配列を渡す

パラメーター

-ArgumentList

-AsJob

-Authentication

-Authority

-Class

-ComputerName

-Confirm

-Credential

-EnableAllPrivileges

-Impersonation

-InputObject

-Locale

-Name

-Namespace

-Path

-ThrottleLimit

-WhatIf

入力

出力

メモ

関連リンク

その他のリソース

例 1: WMI メソッドパラメーターの必要な順序を一覧表示する