Invoke-Command

Invoke-Command [-ScriptBlock] <scriptblock> [[-ComputerName] <string[]>] [-ApplicationName <string>] [-AsJob] [-Authentication {<Default> | <Basic> | <Negotiate> | <NegotiateWithImplicitCredential> | <Credssp> | <Digest> | <Kerberos>}] [-CertificateThumbprint <string>] [-ConfigurationName <string>] [-Credential <PSCredential>] [-HideComputerName] [-JobName <string>] [-Port <int>] [-SessionOption <PSSessionOption>] [-ThrottleLimit <int>] [-UseSSL] [-ArgumentList <Object[]>] [-InputObject <psobject>] [<CommonParameters>]

Invoke-Command [-FilePath] <string> [[-ComputerName] <string[]>] [-ApplicationName <string>] [-AsJob] [-Authentication {<Default> | <Basic> | <Negotiate> | <NegotiateWithImplicitCredential> | <Credssp> | <Digest> | <Kerberos>}] [-ConfigurationName <string>] [-Credential <PSCredential>] [-HideComputerName] [-JobName <string>] [-Port <int>] [-SessionOption <PSSessionOption>] [-ThrottleLimit <int>] [-UseSSL] [-ArgumentList <Object[]>] [-InputObject <psobject>] [<CommonParameters>]

Invoke-Command [-FilePath] <string> [[-Session] <PSSession[]>] [-AsJob] [-HideComputerName] [-JobName <string>] [-ThrottleLimit <int>] [-ArgumentList <Object[]>] [-InputObject <psobject>] [<CommonParameters>]

Invoke-Command [-FilePath] <string> [[-ConnectionURI] <Uri[]>] [-AllowRedirection] [-AsJob] [-Authentication {<Default> | <Basic> | <Negotiate> | <NegotiateWithImplicitCredential> | <Credssp> | <Digest> | <Kerberos>}] [-ConfigurationName <string>] [-Credential <PSCredential>] [-HideComputerName] [-JobName <string>] [-SessionOption <PSSessionOption>] [-ThrottleLimit <int>] [-ArgumentList <Object[]>] [-InputObject <psobject>] [<CommonParameters>]

Invoke-Command [-ScriptBlock] <scriptblock> [-ArgumentList <Object[]>] [-InputObject <psobject>] [<CommonParameters>]

Invoke-Command [-ScriptBlock] <scriptblock> [[-Session] <PSSession[]>] [-AsJob] [-HideComputerName] [-JobName <string>] [-ThrottleLimit <int>] [-ArgumentList <Object[]>] [-InputObject <psobject>] [<CommonParameters>]

Invoke-Command [-ScriptBlock] <scriptblock> [[-ConnectionURI] <Uri[]>] [-AllowRedirection] [-AsJob] [-Authentication {<Default> | <Basic> | <Negotiate> | <NegotiateWithImplicitCredential> | <Credssp> | <Digest> | <Kerberos>}] [-CertificateThumbprint <string>] [-ConfigurationName <string>] [-Credential <PSCredential>] [-HideComputerName] [-JobName <string>] [-SessionOption <PSSessionOption>] [-ThrottleLimit <int>] [-ArgumentList <Object[]>] [-InputObject <psobject>] [<CommonParameters>]

C:\PS>invoke-command -filepath c:\scripts\test.ps1 -computerName Server01

Disks: C:, D:, E:
Status: Warning, Normal, Normal

説明
-----------
このコマンドは、Server01 コンピューターで Test.ps1 スクリプトを実行します。

このコマンドは FilePath パラメーターを使用して、ローカル コンピューターにあるスクリプトを指定します。このスクリプトはリモート コンピューターで実行され、結果はローカル コンピューターに返されます。

C:\PS>invoke-command -computername server01 -credential domain01\user01 -scriptblock {get-culture}

説明
-----------
このコマンドは、Server01 リモート コンピューターで Get-Culture コマンドを実行します。

このコマンドは、ComputerName パラメーターを使用してコンピューター名を指定し、Credential パラメーターを使用してコマンドの実行権限のあるユーザー "Domain01\User01" のセキュリティ コンテキストでコマンドを実行します。また、ScriptBlock パラメーターを使用して、リモート コンピューターで実行するコマンドを指定します。

応答として、Windows PowerShell は、User01 アカウントのパスワードと認証方法を要求するダイアログ ボックスを表示します。その後、Server01 コンピューターでコマンドを実行して、その結果を返します。

C:\PS>$s = new-pssession -computername server02 -credential domain01\user01

C:\PS> invoke-command -session $s -scriptblock {get-culture}

説明
-----------
この例では、Server02 リモート コンピューターのセッション (固定接続) で同じ "Get-Culture" コマンドを実行します。通常、セッションは、リモート コンピューターで一連のコマンドを実行する場合にのみ作成します。

最初のコマンドは、New-PSSession コマンドレットを使用して Server02 リモート コンピューターでセッションを作成します。次に、そのセッションを $s 変数に保存します。

2 番目のコマンドは、Invoke-Command コマンドレットを使用して、Server02 上で Get-Culture コマンドを実行します。このコマンドは、Session パラメーターを使用して、$s 変数に保存されたセッションを指定します。

応答として、Windows PowerShell は Server02 コンピューター上のセッションでコマンドを実行します。

C:\PS>invoke-command -computername Server02 -scriptblock {$p = get-process powershell}

C:\PS> invoke-command -computername Server02 -scriptblock {$p.virtualmemorysize}
C:\PS>

C:\PS> $s = new-pssession -computername Server02
C:\PS> invoke-command -session $s -scriptblock {$p = get-process powershell}
C:\PS> invoke-command -session $s -scriptblock {$p.virtualmemorysize}
17930240

説明
-----------
この例は、Invoke-Command の ComputerName パラメーターと Session パラメーターを使用した結果を比較しています。また、同じデータを共有する一連のコマンドを実行するためにセッションを使用する方法を示しています。

最初の 2 つのコマンドは、Invoke-Command の ComputerName パラメーターを使用して、Server02 リモート コンピューター上でコマンドを実行します。最初のコマンドは、Get-Process コマンドを使用して、リモート コンピューターの PowerShell プロセスを取得して $p 変数に保存します。2 番目のコマンドは、PowerShell プロセスの VirtualMemorySize プロパティの値を取得します。

最初のコマンドは成功しますが、2 番目のコマンドは失敗します。ComputerName パラメーターが使用された場合、Windows PowerShell はコマンドを実行するためにのみ接続を作成するからです。コマンドが完了すると、接続を閉じます。$p 変数は 1 つの接続に作成されていますが、2 番目のコマンド用に作成された接続には存在しません。

この問題を解決するには、リモート コンピューターにセッション (持続的な接続) を作成し、そのセッションで両方の関連コマンドを実行します。

3 番目のコマンドは、New-PSSession コマンドレットを使用して Server02 コンピューターでセッションを作成します。次に、そのセッションを $s 変数に保存します。4 番目と 5 番目のコマンドは、最初のセットで使用した一連のコマンドを繰り返しますが、この場合、Invoke-Command コマンドは Session パラメーターを使用して、同じセッションで両方のコマンドを実行します

この場合、同じセッションで両方のコマンドが実行されるため、コマンドは正常に実行され、$p の値は後で使用できるように $s セッションでアクティブのままになります。

C:\PS>$command = { get-eventlog -log "windows powershell" | where {$_.message -like "*certificate*"} }

C:\PS> invoke-command -computername S1, S2 -scriptblock $command

説明
-----------
この例は、ローカル変数に保存するコマンドの入力方法を示しています。

ローカル変数にコマンド全体が保存されている場合、その変数を ScriptBlock パラメーターの値として指定することができます。ローカル変数の値を送信するために "param" キーワードまたは ArgumentList 変数を使用する必要はありません。

最初のコマンドは、Get-Eventlog コマンドを $command 変数に保存します。コマンドはスクリプト ブロックとして書式設定されます。

2 番目のコマンドは、Invoke-Command コマンドレットを使用して、S1 および S2 リモート コンピューターで $command のコマンドを実行します。

C:\PS>invoke-command -computername server01, server02, TST-0143, localhost -configurationname MySession.PowerShell -scriptblock {get-eventlog "windows powershell"}

説明
-----------
この例は、Invoke-Command コマンドレットを使用して、複数のコンピューター上で単一のコマンドを実行する方法を示しています。

このコマンドは、ComputerName パラメーターを使用してコンピューターを指定します。コンピューター名はコンマ区切り一覧で指定します。コンピューターの一覧には、ローカル コンピューターを表す "localhost" 値が含まれます。

このコマンドは、Windows PowerShell の代替セッション構成の指定には ConfigurationName パラメーターを、コマンドの指定には ScriptBlock パラメーターをそれぞれ使用します。

この例で、スクリプト ブロック内のコマンドは、各リモート コンピューター上の Windows PowerShell イベント ログのイベントを取得します。

C:\PS>$version = invoke-command -computername (get-content machines.txt) -scriptblock {(get-host).version}

説明
-----------
このコマンドは、200 台のリモート コンピューターで実行中の Windows PowerShell ホストのバージョンを取得します。

1 つのコマンドのみが実行されているため、各コンピューターへの固定接続 (セッション) を作成する必要はありません。代わりに、このコマンドは ComputerName パラメーターを使用してコンピューターを指定します。

このコマンドは、Invoke-Command コマンドレットを使用して Get-Host コマンドを実行します。また、ドット表記を使用して、Windows PowerShell ホストの Version プロパティを取得します。

このコマンドは、Get-Content コマンドレットを使用して Machine.txt ファイル (コンピューター名のファイル) の内容を取得し、コンピューターを指定します。

これらのコマンドは同期して (一度に 1 つずつ) 実行されます。コマンドが完了すると、すべてのコンピューターからのコマンドの出力が変数 $version に保存されます。出力には、データの生成元のコンピューター名が含まれています。

C:\PS>$s = new-pssession -computername Server01, Server02

C:\PS> invoke-command -session $s -scriptblock {get-eventlog system} -AsJob

Id   Name    State      HasMoreData   Location           Command
---  ----    -----      -----         -----------        --------             -------
1    Job1    Running    True          Server01,Server02  get-eventlog system


C:\PS> $j = Get-Job

C:\PS> $j | format-list -property *

HasMoreData   : True
StatusMessage :
Location      : Server01,Server02
Command       : get-eventlog system
JobStateInfo  : Running
Finished      : System.Threading.ManualResetEvent
InstanceId    : e124bb59-8cb2-498b-a0d2-2e07d4e030ca
Id            : 1
Name          : Job1
ChildJobs     : {Job2, Job3}
Output        : {}
Error         : {}
Progress      : {}
Verbose       : {}
Debug         : {}
Warning       : {}
StateChanged  :

C:\PS> $results = $j | Receive-Job

説明
-----------
これらのコマンドは、2 台のリモート コンピューターでバックグラウンド ジョブを実行します。Invoke-Command コマンドは AsJob パラメーターを使用するため、コマンドはリモート コンピューターで実行しますが、実際にはジョブはローカル コンピューターに存在し、結果はローカル コンピューターに送信されます。

最初のコマンドは、New-PSSession コマンドレットを使用して、Server01 リモート コンピューターと Server02 リモート コンピューターでセッションを作成します。

2 番目のコマンドは、Invoke-Command コマンドレットを使用して、各セッションでバックグラウンド ジョブを実行します。また、AsJob パラメーターを使用して、バックグラウンド ジョブとしてコマンドを実行します。このコマンドは、2 台のリモート コンピューター上でそれぞれ実行されるジョブに対応する 2 つの子ジョブ オブジェクトを含むジョブ オブジェクトを返します。

3 番目のコマンドは、Get-Job コマンドレットを使用して、$j 変数にジョブ オブジェクトを保存します。

4 番目のコマンドは、パイプライン演算子 (|) を使用して $j 変数の値を Format-List コマンドレットに送ります。これにより、ジョブ オブジェクトのすべてのプロパティが一覧表示されます。

5 番目のコマンドは、ジョブの結果を取得します。このコマンドは、パイプを使用して $j のジョブ オブジェクトを Receive-Job コマンドレットに渡し、その結果を $results 変数に保存します。

C:\PS>$MWFO-LOg = Microsoft-Windows-Forwarding/Operational

C:\PS> invoke-command -computername server01 -scriptblock {param($log, $num) get-eventlog -logname $log -newest $num} -ArgumentList $MWFO-log, 10

説明
-----------
この例は、リモート コンピューターで実行されるコマンドにローカル変数の値を含める方法を示しています。

最初のコマンドは、Microsoft-Windows-Forwarding/Operational イベント ログの名前を $MWFO-Log 変数に保存します。

2 番目のコマンドは、Invoke-Command コマンドレットを使用して、Server01 リモート コンピューターで Get-EventLog コマンドを実行します。このコマンドは、Server01 上の Microsoft-Windows-Forwarding/Operational イベント ログから最新のイベント 10 件を取得します。

このコマンドは "param" キーワードを使用して、2 つの変数 $log と $num を作成します。これらの変数は、Get-EventLog コマンドでプレースホルダーとして使用されます。これらのプレースホルダーの名前は、値を提供するローカル変数の名前に一致する必要はなく、任意の名前を使用できます。

ArgumentList パラメーターの値は、引数一覧の値を指定する 2 つの異なる方法を示します。$log プレースホルダーの値は $MFWO-Log 変数です。この変数は最初のコマンドで定義されます。$num 変数の値は 10 です。

コマンドがリモート コンピューターに送信される前に、変数は指定された値で置換されます。

C:\PS>invoke-command -computername S1, S2 -scriptblock {get-process powershell} 

PSComputerName    Handles  NPM(K)    PM(K)      WS(K) VM(M)   CPU(s)     Id   ProcessName
--------------    -------  ------    -----      ----- -----   ------     --   -----------
S1                575      15        45100      40988   200     4.68     1392 powershell
S2                777      14        35100      30988   150     3.68     67   powershell


C:\PS> invoke-command -computername S1, S2 -scriptblock {get-process powershell} -HideComputerName

Handles  NPM(K)    PM(K)      WS(K) VM(M)   CPU(s)     Id   ProcessName
-------  ------    -----      ----- -----   ------     --   -----------
575      15        45100      40988   200     4.68     1392 powershell
777      14        35100      30988   150     3.68     67   powershell

説明
-----------
この例は、Invoke-Command の HideComputerName パラメーターを使用した結果を示しています。

最初の 2 つのコマンドは、Invoke-Command コマンドレットを使用して、PowerShell プロセスに対して Get-Process コマンドを実行します。最初のコマンドの出力には、コマンドが実行されたコンピューターの名前を格納した PsComputerName プロパティが含まれています。HideComputerName パラメーターを使用する 2 番目のコマンドの出力には、PsComputerName 列は含まれていません。

HideComputerName パラメーターを使用すると、オブジェクトは変更されません。影響を受けるいずれかのオブジェクトの PsComputerName プロパティを表示するために、Format コマンドレットを使用することもできます。

C:\PS>invoke-command -comp (get-content servers.txt) -filepath c:\scripts\sample.ps1 -argumentlist Process, Service

説明
-----------
この例では、Invoke-Command コマンドレットを使用して、Servers.txt ファイルに示されているすべてのコンピューター上で Sample.ps1 スクリプトを実行します。このコマンドは、FilePath パラメーターを使用してスクリプト ファイルを指定します。このコマンドを使用すると、スクリプト ファイルがリモート コンピューターにアクセスできない場合でも、リモート コンピューターでスクリプトを実行することができます。

このコマンドを送信すると、Sample.ps1 ファイルの内容がスクリプト ブロックにコピーされ、スクリプト ブロックが各リモート コンピューターで実行されます。この手順は、ScriptBlock パラメーターを使用してスクリプトの内容を送信した場合と同じです。

C:\PS>$LiveCred = Get-Credential

C:\PS> Invoke-Command -ConfigurationName Microsoft.Exchange `
         -ConnectionUri https://ps.exchangelabs.com/powershell `
         -Credential $LiveCred  -Authentication Basic `
         -scriptblock {Invoke-Command {Set-Mailbox dan -DisplayName "Dan Park"}

説明
-----------
この例は、URI (インターネット アドレス) によって識別されるリモート コンピューターでコマンドを実行する方法を示しています。この例では、リモートの Exchange サーバーで Set-Mailbox コマンドを実行します。コマンドのバッククォート文字 (`) は、Windows PowerShell の連結文字です。

最初のコマンドは、Get-Credential コマンドレットを使用して、Windows Live ID の資格情報を $LiveCred 変数に保存します。資格情報ダイアログ ボックスが表示されたら、Windows Live ID の資格情報を入力します。

2 番目のコマンドは、Invoke-Command コマンドレットを使用して Set-Mailbox コマンドを実行します。このコマンドは、ConfigurationName パラメーターを使用して、Microsoft.Exchange セッション構成を使用したセッションでコマンドを実行するように指定します。ConnectionURI パラメーターは、Exchange サーバーのエンドポイントの URL を指定します。

資格情報パラメーターは、$LiveCred 変数に保存されている Windows Live の資格情報を指定します。AuthenticationMechanism パラメーターは、基本認証の使用を指定します。ScriptBlock パラメーターは、コマンドが含まれるスクリプト ブロックを指定します。

C:\PS>$max = New-PSSessionOption -MaximumRedirection 1

C:\PS> Invoke-Command -ConnectionUri https://ps.exchangelabs.com/powershell `
         -scriptblock {Invoke-Command {Get-Mailbox dan} `
         -AllowRedirection -SessionOption $max

説明
-----------
この例は、AllowRedirection パラメーターと SessionOption パラメーターを使用して、リモートのコマンドで URI リダイレクトを管理する方法を示しています。

最初のコマンドは New-PSSessionOption コマンドレットを使用して、$max 変数に保存する PSSessionOpption オブジェクトを作成します。このコマンドは MaximumRedirection パラメーターを使用して、PSSessionOption オブジェクトの MaximumConnectionRedirectionCount プロパティを 1 に設定します。

2 番目のコマンドは、Invoke-Command コマンドレットを使用して、Microsoft Exchange Server を実行しているリモート サーバーで Get-Mailbox コマンドを実行します。このコマンドは、AllowRedirection パラメーターを使用して、代替エンドポイントへ接続をリダイレクトするための明示的な許可を提供します。また、SessionOption パラメーターを使用して、$max 変数内のセッション オブジェクトも指定します。

その結果、ConnectionURI パラメーターによって指定されたリモート コンピューターがリダイレクト メッセージを返すと Windows PowerShell は接続をリダイレクトしますが、新しい接続先が別のリダイレクト メッセージを返すとリダイレクト回数の値が 1 を超え、Invoke-Command によって未終了エラーが返されます。

C:\PS>$so = New-PSSessionOption -SkipCACheck

PS C:\> invoke-command $s { get-hotfix } -SessionOption $so -credential server01\user01

説明
-----------
この例は、SessionOption パラメーターの作成方法と使用方法を示しています。

最初のコマンドは、New-PSSessionOption コマンドレットを使用してセッションのオプションを作成します。このコマンドは、結果の SessionOption オブジェクトを $so パラメーターに保存します。

2 番目のコマンドは、Invoke-Command コマンドレットを使用して、リモートから Get-Hotfix コマンドを実行します。SessionOption パラメーターの値は、$so 変数の SessionOption オブジェクトです。

C:\PS>enable-wsmanCredSSP -delegate server02

C:\PS> connect-wsman Server02

C:\PS> set-item wsman:\server02*\service\auth\credSSP -value $true

C:\PS> $s = new-pssession server02

C:\PS> invoke-command -session $s -script {get-item \\Net03\Scripts\LogFiles.ps1} -authentication credssp -credential domain01\admin01

説明
-----------
この例は、リモート セッション内からネットワーク共有にアクセスする方法を示しています。

このコマンドを使用するには、ローカル コンピューターのクライアント設定とリモート コンピューターのサービス設定で CredSSP 委任を有効にする必要があります。この例のコマンドを実行するには、ローカル コンピューターとリモート コンピューターで Administrators グループのメンバーであることが必要です。

最初のコマンドは Enable-WSManCredSSP コマンドレットを使用して、Server01 ローカル コンピューターから Server02 リモート コンピューターへの CredSSP 委任を有効にします。これによってローカル コンピューターに CredSSP クライアント設定が構成されます。

2 番目のコマンドは、Connect-WSMan コマンドレットを使用して Server02 コンピューターに接続します。この操作によって、Server02 コンピューターのノードがローカル コンピューターの WSMan: ドライブに追加されるので、Server02 コンピューターで WS-Management の設定の表示と変更が可能になります。

3 番目のコマンドは、Set-Item コマンドレットを使用して Server02 コンピューターの Service ノードの CredSSP 項目の値を True に変更します。この操作によって、リモート コンピューターのサービス設定で CredSSP が有効になります。

4 番目のコマンドは、New-PSSession コマンドレットを使用して Server02 コンピューターで PSSession セッションを作成します。PSSession は $s 変数に保存されます。

5 番目のコマンドは、Invoke-Command コマンドレットを使用して $s のセッションで Get-Item コマンドを実行し、Net03\Scripts ネットワーク共有からスクリプトを取得します。このコマンドは Credential パラメーターを使用し、CredSSP という値と共に Authentication パラメーターを使用します。