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 - Basic は、ユーザー名とパスワードがクリアテキストでサーバーまたはプロキシに送信されるスキームです。
Default - WS-Management プロトコルによって実装された認証方法を使用します。これが既定です。
Digest - Digest は、チャレンジにサーバー指定のデータ文字列を使用するチャレンジ応答スキームです。
Kerberos - クライアントコンピューターとサーバーは、Kerberos 証明書を使用して相互に認証します。
Negotiate - 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

リソースクラスまたはインスタンスの Uniform Resource Identifier (URI) を含めます。 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: リモートコンピューターでメソッドを呼び出す