Invoke-WSManAction

Invoke-WSManAction [-ApplicationName <string>] [-ComputerName <string>] [-Credential <PSCredential>] [-Credential <PSCredential>] [-Credential <PSCredential>] [-Credential <PSCredential>] [-Credential <PSCredential>] [-Credential <PSCredential>] [-Credential <PSCredential>] [-Credential <PSCredential>] [-Credential <PSCredential>] [-Port <int>] [-Port <int>] [-Port <int>] [-Port <int>] [-Port <int>] [-Port <int>] [-Port <int>] [-Port <int>] [-Port <int>] [-UseSSL] [-ResourceURI] <Uri> [-Action] <string> [-Authentication <AuthenticationMechanism>] [-FilePath <File>] [-OptionSet <hashtable>] [-SelectorSet <hashtable>] [-SessionOption <hashtable>] [-ValueSet <hashtable>] [<CommonParameters>]

Invoke-WSManAction [-ConnectionURI <Uri>] [-ResourceURI] <Uri> [-Action] <string> [-Authentication <AuthenticationMechanism>] [-FilePath <File>] [-OptionSet <hashtable>] [-SelectorSet <hashtable>] [-SessionOption <hashtable>] [-ValueSet <hashtable>] [<CommonParameters>]

Invoke-WSManAction は、パラメーターがキーと値のペアによって指定されている RESOURCE_URI で指定されたオブジェクトに処理を実行します。

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

-Action <string>

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

必須	true
位置	2
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-ApplicationName <string>

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

次にその例を示します。

http://server01:8080/WSMAN

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

必須	false
位置	named
既定値	wsman
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-Authentication <AuthenticationMechanism>

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

- Basic: Basic は、ユーザー名およびパスワードがクリアテキストでサーバーまたはプロキシに送信されるスキームです。

- Default: WS-Management プロトコルによって実装された認証方法を使用します。これが既定値です。

- Digest: Digest は、サーバーで指定されたデータ文字列をチャレンジで使用するチャレンジ/レスポンススキームです。

- Kerberos: クライアントコンピューターとサーバーは、Kerberos 証明書を使用して手動で認証されます。

- Negotiate: Negotiate は、認証で使用するスキームを特定するために、サーバーまたはプロキシとネゴシエートするチャレンジ/レスポンススキームです。たとえば、このパラメーター値を指定すると、Kerberos プロトコルと NTLM のどちらが使用されるかを特定するネゴシエーションを行うことができます。

- CredSSP: 資格情報のセキュリティサービスプロバイダー (CredSSP) 認証を使用します。この認証では、ユーザーが資格情報を委任できます。このオプションは、1 台のリモートコンピューターで実行していても、データを他のリモートコンピューターから収集したり、追加のコマンドを他のリモートコンピューターで実行したりするコマンド用に設計されています。

注意: CredSSP により、ユーザーの資格情報がローカルコンピューターからリモートコンピューターに委任されます。これを実行すると、リモート操作のセキュリティリスクが増します。リモートコンピューターのセキュリティが低下している場合に、そのリモートコンピューターに資格情報を渡すと、それを使用してネットワークセッションを制御できます。

必須	false
位置	named
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-ComputerName <string>

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

必須	false
位置	named
既定値	localhost
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-ConnectionURI <Uri>

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

次の文字列は、このパラメーターの正しい形式の値です。

http://Server01:8080/WSMAN

URI は完全修飾名でなければなりません。

必須	false
位置	named
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-Credential <PSCredential>

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

必須	false
位置	named
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-FilePath <File>

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

invoke-wsmanaction -action stopservice -resourceuri wmicimv2/Win32_Service -SelectorSet @{Name="spooler"} -FilePath:c:\input.xml -authentication default

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

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

必須	false
位置	named
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-OptionSet <hashtable>

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

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

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

必須	false
位置	named
既定値
パイプライン入力を許可する	true (ByValue, ByPropertyName)
ワイルドカード文字を許可する	false

-Port <int>

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

必須	false
位置	named
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-ResourceURI <Uri>

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

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

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

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

必須	true
位置	1
既定値
パイプライン入力を許可する	true (ByValue, ByPropertyName)
ワイルドカード文字を許可する	false

-SelectorSet <hashtable>

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

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

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

必須	false
位置	named
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-SessionOption <hashtable>

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

必須	false
位置	named
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-UseSSL

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

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

必須	false
位置	named
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-ValueSet <hashtable>

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

必須	false
位置	named
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

<CommonParameters>

このコマンドレットは、次の共通パラメーターをサポートします: -Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable。Ô”¼š¤Ë¤Ä¤¤¤Æ¤Ï¡¢次を参照してください: about_Commonparameters.

入力値の型は、コマンドレットへのパイプが可能なオブジェクトの型です。戻り値の型は、コマンドレットによって返されるオブジェクトの型です。

入力

なし

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

出力

なし

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

C:\PS>invoke-wsmanaction -action startservice -resourceuri wmicimv2/win32_service  -selectorset @{name="spooler"} -authentication default

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

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

戻り値は、処理が成功したかどうかを示します。この場合、戻り値 0 は成功を表します。戻り値 5 は、サービスが既に開始していることを示します。

C:\PS>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           : https://schemas.microsoft.com/wbem/wsman/1/wmi/root/cimv2/Win32_Service
cim         : https://schemas.dmtf.org/wbem/wscim/1/common
lang        : en-US
ReturnValue : 0

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

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

戻り値は、処理が成功したかどうかを示します。この場合、戻り値 0 は成功を表します。戻り値 5 は、サービスが既に開始していることを示します。

C:\PS>invoke-wsmanaction -action create -resourceuri wmicimv2/win32_process -valueset @{commandline="notepad.exe";currentdirectory="C:\"}

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

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

C:\PS>invoke-wsmanaction -action startservice -resourceuri wmicimv2/win32_service  -selectorset @{name="spooler"} -computername server01 -authentication default

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

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

戻り値は、処理が成功したかどうかを示します。この場合、戻り値 0 は成功を表します。戻り値 5 は、サービスが既に開始していることを示します。