Invoke-WmiMethod

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 を参照してください。

Type:Object[]
Aliases:Args
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AsJob

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

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

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

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Authentication

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

  • -1: 変更なし
  • 0: 既定値
  • 1: なし (認証は実行されません)。
  • 2: 接続 (認証は、クライアントがアプリケーションとの関係を確立した場合にのみ実行されます)。
  • 3: 呼び出し (認証は、アプリケーションが要求を受信したときに、各呼び出しの開始時にのみ実行されます)。
  • 4: パケット (クライアントから受信したすべてのデータに対して認証が実行されます)。
  • 5: PacketIntegrity (クライアントとアプリケーションの間で転送されるすべてのデータが認証され、検証されます)。
  • 6: PacketPrivacy (他の認証レベルのプロパティが使用され、すべてのデータが暗号化されます)。
Type:AuthenticationLevel
Accepted values:Default, None, Connect, Call, Packet, PacketIntegrity, PacketPrivacy, Unchanged
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Authority

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Class

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

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ComputerName

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

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

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

Type:String[]
Aliases:Cn
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

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

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

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

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EnableAllPrivileges

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Impersonation

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

  • 0: Default (既定の偽装レベルのローカル レジストリを読み取ります。通常は [偽装] に3設定されます)。
  • 1: 匿名 (呼び出し元の資格情報を非表示にします)。
  • 2: 識別 (オブジェクトが呼び出し元の資格情報のクエリを実行できるようにします)。
  • 3: 偽装 (オブジェクトが呼び出し元の資格情報を使用できるようにします)。
  • 4: デリゲート (他のオブジェクトが呼び出し元の資格情報を使用することをオブジェクトに許可します)。
Type:ImpersonationLevel
Accepted values:Default, Anonymous, Identify, Impersonate, Delegate
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

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

Type:ManagementObject
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Locale

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

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

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Namespace

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

Type:String
Aliases:NS
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Path

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

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ThrottleLimit

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

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

None

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

出力

None

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

メモ

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

  • iwmi