Invoke-WSManAction

リファレンス

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

リソース URI とセレクターによって指定されたオブジェクトに対してアクションを呼び出します。

構文

Invoke-WSManAction
      [-Action] <String>
      [-ConnectionURI <Uri>]
      [-FilePath <String>]
      [-OptionSet <Hashtable>]
      [[-SelectorSet] <Hashtable>]
      [-SessionOption <SessionOption>]
      [-ValueSet <Hashtable>]
      [-ResourceURI] <Uri>
      [-Credential <PSCredential>]
      [-Authentication <AuthenticationMechanism>]
      [-CertificateThumbprint <String>]
      [<CommonParameters>]

Invoke-WSManAction
      [-Action] <String>
      [-ApplicationName <String>]
      [-ComputerName <String>]
      [-FilePath <String>]
      [-OptionSet <Hashtable>]
      [-Port <Int32>]
      [[-SelectorSet] <Hashtable>]
      [-SessionOption <SessionOption>]
      [-UseSSL]
      [-ValueSet <Hashtable>]
      [-ResourceURI] <Uri>
      [-Credential <PSCredential>]
      [-Authentication <AuthenticationMechanism>]
      [-CertificateThumbprint <String>]
      [<CommonParameters>]

説明

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

Invoke-WSManAction は、RESOURCE_URIで指定されたオブジェクトに対してアクションを実行します。ここで、パラメーターはキーと値のペアで指定されます。

このコマンドレットは、WSMan 接続/トランスポート層を使用してアクションを実行します。

例

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

Invoke-WSManAction -Action StartService -ResourceURI wmicimv2/win32_service  -SelectorSet @{name="spooler"} -Authentication default

xsi         : http://www.w3.org/2001/XMLSchema-instance
p           : http://schemas.microsoft.com/wbem/wsman/1/wmi/root/cimv2/Win32_Service
cim         : http://schemas.dmtf.org/wbem/wscim/1/common
lang        : en-US
ReturnValue : 0

このコマンドは、スプーラーサービスに対応するWin32_Service WMI クラスインスタンスの StartService メソッドを呼び出します。

戻り値は、アクションが成功したかどうかを示します。この場合、戻り値 0 は成功を示します。戻り値 5 は、サービスが既に開始されていることを示します。

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

Invoke-WSManAction -Action StopService -ResourceURI wmicimv2/Win32_Service -SelectorSet @{Name="spooler"} -FilePath:input.xml -Authentication default

xsi         : http://www.w3.org/2001/XMLSchema-instance
p           : http://schemas.microsoft.com/wbem/wsman/1/wmi/root/cimv2/Win32_Service
cim         : http://schemas.dmtf.org/wbem/wscim/1/common
lang        : en-US
ReturnValue : 0

このコマンドは、ファイルからの入力を使用して、スプーラーサービスで StopService メソッドを呼び出します。ファイル Input.xmlには、次の内容が含まれています。

<p:StopService_INPUT xmlns:p="http://schemas.microsoft.com/wbem/wsman/1/wmi/root/cimv2/Win32_Service" />

例 3: 指定したパラメーター値を使用してメソッドを呼び出す

Invoke-WSManAction -Action create -ResourceURI wmicimv2/win32_process -ValueSet @{CommandLine="notepad.exe";CurrentDirectory="C:\"}

xsi         : http://www.w3.org/2001/XMLSchema-instance
p           : http://schemas.microsoft.com/wbem/wsman/1/wmi/root/cimv2/Win32_Process
cim         : http://schemas.dmtf.org/wbem/wscim/1/common
lang        : en-US
ProcessId   : 6356
ReturnValue : 0

このコマンドは、Win32_Process クラスの Create メソッドを呼び出します。 Notepad.exe と C:\の 2 つのパラメーター値をメソッドに渡します。その結果、メモ帳を実行する新しいプロセスが作成され、新しいプロセスの現在のディレクトリが C:\に設定されます。

例 4: リモートコンピューターでメソッドを呼び出す

Invoke-WSManAction -Action StartService -ResourceURI wmicimv2/win32_service  -SelectorSet @{name="spooler"} -ComputerName server01 -Authentication default

xsi         : http://www.w3.org/2001/XMLSchema-instance
p           : http://schemas.microsoft.com/wbem/wsman/1/wmi/root/cimv2/Win32_Service
cim         : http://schemas.dmtf.org/wbem/wscim/1/common
lang        : en-US
ReturnValue : 0

このコマンドは、スプーラーサービスに対応するWin32_Service WMI クラスインスタンスの StartService メソッドを呼び出します。 ComputerName パラメーターが指定されているため、コマンドはリモート server01 コンピューターに対して実行されます。

パラメーター

-Action

ResourceURI とセレクターで指定された管理オブジェクトで実行するメソッドを指定します。

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

-ApplicationName

接続内のアプリケーション名を指定します。 ApplicationName パラメーターの既定値は WSMAN です。リモートエンドポイントの完全な識別子は、次の形式です。

<Transport>://<Server>:<Port>/<ApplicationName>

例えば：

http://server01:8080/WSMAN

セッションをホストするインターネットインフォメーションサービス (IIS) は、このエンドポイントを持つ要求を指定されたアプリケーションに転送します。この既定の設定 "WSMAN" は、ほとんどの用途に適しています。このパラメーターは、多数のコンピューターが Windows PowerShell を実行している 1 台のコンピューターへのリモート接続を確立するときに使用するように設計されています。この場合、IIS は Web Services for Management (WS-Management) をホストして効率を高めます。

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

-Authentication

サーバーで使用する認証メカニズムを指定します。使用可能な値は次のとおりです。

Basic - 基本は、ユーザー名とパスワードがクリアテキストでサーバーまたはプロキシに送信されるスキームです。
Default - WS-Management プロトコルによって実装された認証方法を使用します。これが既定値です。
Digest - ダイジェストは、チャレンジにサーバー指定のデータ文字列を使用するチャレンジ応答スキームです。
Kerberos - クライアントコンピューターとサーバーは、Kerberos 証明書を使用して相互に認証します。
Negotiate - ネゴシエートは、認証に使用するスキームを決定するためにサーバーまたはプロキシとネゴシエートするチャレンジ応答スキームです。たとえば、このパラメーター値を使用すると、ネゴシエーションで Kerberos プロトコルと NTLM のどちらを使用するかを判断できます。
CredSSP - 資格情報セキュリティサポートプロバイダー (CredSSP) 認証を使用します。これにより、ユーザーは資格情報を委任できます。このオプションは、1 台のリモートコンピューターで実行されるが、他のリモートコンピューターからデータを収集したり、他のリモートコンピューターで追加のコマンドを実行したりするコマンド用に設計されています。

注意

CredSSP は、ローカルコンピューターからリモートコンピューターにユーザーの資格情報を委任します。この方法により、リモート操作のセキュリティリスクが高まります。リモートコンピューターが侵害された場合、資格情報が渡されるときに、資格情報を使用してネットワークセッションを制御できます。

型:	AuthenticationMechanism
Aliases:	auth, am
指定可能な値:	None, Default, Digest, Negotiate, Basic, Kerberos, ClientCertificate, Credssp
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-CertificateThumbprint

このアクションを実行するアクセス許可を持つユーザーアカウントのデジタル公開キー証明書 (X509) を指定します。証明書の拇印を入力します。

証明書は、クライアント証明書ベースの認証で使用されます。これらはローカルユーザーアカウントにのみマップできます。ドメインアカウントでは機能しません。

証明書の拇印を取得するには、Windows PowerShell 証明書: ドライブの Get-Item または Get-ChildItem コマンドを使用します。

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

-ComputerName

管理操作を実行するコンピューターを指定します。値には、完全修飾ドメイン名、NetBIOS 名、または IP アドレスを指定できます。ローカルコンピューター名を使用するか、localhost を使用するか、ドット (.) を使用してローカルコンピューターを指定します。ローカルコンピューターが既定です。リモートコンピューターがユーザーとは別のドメインにある場合は、完全修飾ドメイン名を使用する必要があります。このパラメーターの値をコマンドレットにパイプできます。

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

-ConnectionURI

接続エンドポイントを指定します。この文字列の形式は次のとおりです。

<Transport>://<Server>:<Port>/<ApplicationName>

次の文字列は、このパラメーターに適切に書式設定された値です。

http://Server01:8080/WSMAN

URI は完全修飾されている必要があります。

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

-Credential

このアクションを実行するアクセス許可を持つユーザーアカウントを指定します。既定値は現在のユーザーです。 "User01"、"Domain01\User01"、User@Domain.comなどのユーザー名を入力します。または、psCredential オブジェクト (Get-Credential コマンドレットによって返されるオブジェクトなど) を入力します。ユーザー名を入力すると、パスワードの入力を求められます。

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

-FilePath

管理リソースの更新に使用するファイルのパスを指定します。 ResourceURI パラメーターと SelectorSet パラメーターを使用して、管理リソースを指定します。たとえば、次のコマンドでは FilePath パラメーターを使用します。

Invoke-WSManAction -Action StopService -ResourceUri wmicimv2/Win32_Service -SelectorSet @{Name="spooler"} -FilePath c:\input.xml -Authentication default

<p:StopService_INPUT xmlns:p="http://schemas.microsoft.com/wbem/wsman/1/wmi/root/cimv2/Win32_Service" />

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

-OptionSet

一連のスイッチをサービスに渡して、要求の性質を変更または調整します。これらは、サービス固有であるため、コマンドラインシェルで使用されるスイッチと似ています。任意の数のオプションを指定できます。

次の例は、a、b、および c パラメーターの値 1、2、3 を渡す構文を示しています。

-OptionSet @{a=1;b=2;c=3}

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

-Port

クライアントが WinRM サービスに接続するときに使用するポートを指定します。トランスポートが HTTP の場合、既定のポートは 80 です。トランスポートが HTTPS の場合、既定のポートは 443 です。トランスポートとして HTTPS を使用する場合、ComputerName パラメーターの値はサーバーの証明書共通名 (CN) と一致する必要があります。ただし、SessionOption パラメーターの一部として SkipCNCheck パラメーターが指定されている場合、サーバーの証明書の共通名は、サーバーのホスト名と一致する必要はありません。 SkipCNCheck パラメーターは、信頼できるマシンにのみ使用する必要があります。

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

-ResourceURI

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

URI は、プレフィックスとリソースへのパスで構成されます。例えば：

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

http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_NumericSensor

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

-SelectorSet

特定の管理リソースインスタンスの選択に使用される値ペアのセットを指定します。 SelectorSet は、リソースの複数のインスタンスが存在する場合に使用されます。 SelectorSet の値ハッシュテーブルである必要があります。

次の例は、このパラメーターの値を入力する方法を示しています。

-SelectorSet @{Name="WinRM";ID="yyy"}

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

-SessionOption

WS-Management セッションの拡張オプションのセットを定義します。 New-WSManSessionOption コマンドレットを使用して作成する SessionOption オブジェクトを入力します。使用できるオプションの詳細については、New-WSManSessionOptionを参照してください。

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

-UseSSL

リモートコンピューターへの接続を確立するために Secure Sockets Layer (SSL) プロトコルを使用することを指定します。既定では、SSL は使用されません。

WS-Management は、ネットワーク経由で送信されるすべての PowerShell コンテンツを暗号化します。 UseSSL パラメーターを使用すると、HTTP ではなく HTTPS の追加の保護を指定できます。接続に使用されているポートで SSL を使用できず、このパラメーターを指定すると、コマンドは失敗します。

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

-ValueSet

管理リソースの変更に役立つハッシュテーブルを指定します。管理リソースは、ResourceURI と SelectorSet パラメーター 使用して指定します。 ValueSet パラメーターの値はハッシュテーブルである必要があります。

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

入力

None

このコマンドレットにオブジェクトをパイプすることはできません。

出力

XmlElement

このコマンドレットは、操作の結果を XmlElement オブジェクトとして返します。

次の方法で共有

Invoke-WSManAction

構文

説明

例

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

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

例 3: 指定したパラメーター値を使用してメソッドを呼び出す

例 4: リモートコンピューターでメソッドを呼び出す

パラメーター

-Action

-ApplicationName

-Authentication

-CertificateThumbprint

-ComputerName

-ConnectionURI

-Credential

-FilePath

-OptionSet

-Port

-ResourceURI

-SelectorSet

-SessionOption

-UseSSL

-ValueSet

入力

出力

その他のリソース

次の方法で共有

Invoke-WSManAction

構文

説明

例

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

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

例 3: 指定したパラメーター値を使用してメソッドを呼び出す

例 4: リモート コンピューターでメソッドを呼び出す

パラメーター

-Action

-ApplicationName

-Authentication

-CertificateThumbprint

-ComputerName

-ConnectionURI

-Credential

-FilePath

-OptionSet

-Port

-ResourceURI

-SelectorSet

-SessionOption

-UseSSL

-ValueSet

入力

出力

関連リンク

その他のリソース

例 4: リモートコンピューターでメソッドを呼び出す