Invoke-Command

ローカル コンピューターおよびリモート コンピューター上でコマンドを実行します。

構文

Invoke-Command
      [-ScriptBlock] <scriptblock>
      [-NoNewScope]
      [-InputObject <psobject>]
      [-ArgumentList <Object[]>]
      [<CommonParameters>]
Invoke-Command
      [[-Session] <PSSession[]>]
      [-ScriptBlock] <scriptblock>
      [-ThrottleLimit <int>]
      [-AsJob]
      [-HideComputerName]
      [-JobName <string>]
      [-RemoteDebug]
      [-InputObject <psobject>]
      [-ArgumentList <Object[]>]
      [<CommonParameters>]
Invoke-Command
      [[-Session] <PSSession[]>]
      [-FilePath] <string>
      [-ThrottleLimit <int>]
      [-AsJob]
      [-HideComputerName]
      [-JobName <string>]
      [-RemoteDebug]
      [-InputObject <psobject>]
      [-ArgumentList <Object[]>]
      [<CommonParameters>]
Invoke-Command
      [[-ComputerName] <string[]>]
      [-ScriptBlock] <scriptblock>
      [-Credential <pscredential>]
      [-Port <int>]
      [-UseSSL]
      [-ConfigurationName <string>]
      [-ApplicationName <string>]
      [-ThrottleLimit <int>]
      [-AsJob]
      [-InDisconnectedSession]
      [-SessionName <string[]>]
      [-HideComputerName]
      [-JobName <string>]
      [-SessionOption <PSSessionOption>]
      [-Authentication <AuthenticationMechanism>]
      [-EnableNetworkAccess]
      [-RemoteDebug]
      [-InputObject <psobject>]
      [-ArgumentList <Object[]>]
      [-CertificateThumbprint <string>]
      [<CommonParameters>]
Invoke-Command
      [[-ComputerName] <string[]>]
      [-FilePath] <string>
      [-Credential <pscredential>]
      [-Port <int>]
      [-UseSSL]
      [-ConfigurationName <string>]
      [-ApplicationName <string>]
      [-ThrottleLimit <int>]
      [-AsJob]
      [-InDisconnectedSession]
      [-SessionName <string[]>]
      [-HideComputerName]
      [-JobName <string>]
      [-SessionOption <PSSessionOption>]
      [-Authentication <AuthenticationMechanism>]
      [-EnableNetworkAccess]
      [-RemoteDebug]
      [-InputObject <psobject>]
      [-ArgumentList <Object[]>]
      [<CommonParameters>]
Invoke-Command
      [[-ConnectionUri] <uri[]>]
      [-ScriptBlock] <scriptblock>
      [-Credential <pscredential>]
      [-ConfigurationName <string>]
      [-ThrottleLimit <int>]
      [-AsJob]
      [-InDisconnectedSession]
      [-HideComputerName]
      [-JobName <string>]
      [-AllowRedirection]
      [-SessionOption <PSSessionOption>]
      [-Authentication <AuthenticationMechanism>]
      [-EnableNetworkAccess]
      [-RemoteDebug]
      [-InputObject <psobject>]
      [-ArgumentList <Object[]>]
      [-CertificateThumbprint <string>]
      [<CommonParameters>]
Invoke-Command
      [[-ConnectionUri] <uri[]>]
      [-FilePath] <string>
      [-Credential <pscredential>]
      [-ConfigurationName <string>]
      [-ThrottleLimit <int>]
      [-AsJob]
      [-InDisconnectedSession]
      [-HideComputerName]
      [-JobName <string>]
      [-AllowRedirection]
      [-SessionOption <PSSessionOption>]
      [-Authentication <AuthenticationMechanism>]
      [-EnableNetworkAccess]
      [-RemoteDebug]
      [-InputObject <psobject>]
      [-ArgumentList <Object[]>]
      [<CommonParameters>]
Invoke-Command
      [-VMId] <guid[]>
      [-ScriptBlock] <scriptblock>
      -Credential <pscredential>
      [-ConfigurationName <string>]
      [-ThrottleLimit <int>]
      [-AsJob]
      [-HideComputerName]
      [-RemoteDebug]
      [-InputObject <psobject>]
      [-ArgumentList <Object[]>]
      [<CommonParameters>]
Invoke-Command
      [-ScriptBlock] <scriptblock>
      -Credential <pscredential>
      -VMName <string[]>
      [-ConfigurationName <string>]
      [-ThrottleLimit <int>]
      [-AsJob]
      [-HideComputerName]
      [-RemoteDebug]
      [-InputObject <psobject>]
      [-ArgumentList <Object[]>]
      [<CommonParameters>]
Invoke-Command
      [-VMId] <guid[]>
      [-FilePath] <string>
      -Credential <pscredential>
      [-ConfigurationName <string>]
      [-ThrottleLimit <int>]
      [-AsJob]
      [-HideComputerName]
      [-RemoteDebug]
      [-InputObject <psobject>]
      [-ArgumentList <Object[]>]
      [<CommonParameters>]
Invoke-Command
      [-FilePath] <string>
      -Credential <pscredential>
      -VMName <string[]>
      [-ConfigurationName <string>]
      [-ThrottleLimit <int>]
      [-AsJob]
      [-HideComputerName]
      [-RemoteDebug]
      [-InputObject <psobject>]
      [-ArgumentList <Object[]>]
      [<CommonParameters>]
Invoke-Command
      [-ScriptBlock] <scriptblock>
      -HostName <string[]>
      [-Port <int>]
      [-AsJob]
      [-HideComputerName]
      [-JobName <string>]
      [-UserName <string>]
      [-KeyFilePath <string>]
      [-Subsystem <string>]
      [-ConnectingTimeout <int>]
      [-SSHTransport]
      [-Options <hashtable>]
      [-RemoteDebug]
      [-InputObject <psobject>]
      [-ArgumentList <Object[]>]
      [<CommonParameters>]
Invoke-Command
      [-ScriptBlock] <scriptblock>
      -ContainerId <string[]>
      [-ConfigurationName <string>]
      [-ThrottleLimit <int>]
      [-AsJob]
      [-HideComputerName]
      [-JobName <string>]
      [-RunAsAdministrator]
      [-RemoteDebug]
      [-InputObject <psobject>]
      [-ArgumentList <Object[]>]
      [<CommonParameters>]
Invoke-Command
      [-FilePath] <string>
      -ContainerId <string[]>
      [-ConfigurationName <string>]
      [-ThrottleLimit <int>]
      [-AsJob]
      [-HideComputerName]
      [-JobName <string>]
      [-RunAsAdministrator]
      [-RemoteDebug]
      [-InputObject <psobject>]
      [-ArgumentList <Object[]>]
      [<CommonParameters>]
Invoke-Command
      [-ScriptBlock] <scriptblock>
      -SSHConnection <hashtable[]>
      [-AsJob]
      [-HideComputerName]
      [-JobName <string>]
      [-RemoteDebug]
      [-InputObject <psobject>]
      [-ArgumentList <Object[]>]
      [<CommonParameters>]
Invoke-Command
      -FilePath <string>
      -HostName <string[]>
      [-AsJob]
      [-HideComputerName]
      [-UserName <string>]
      [-KeyFilePath <string>]
      [-Subsystem <string>]
      [-ConnectingTimeout <int>]
      [-SSHTransport]
      [-Options <hashtable>]
      [-RemoteDebug]
      [-InputObject <psobject>]
      [-ArgumentList <Object[]>]
      [<CommonParameters>]
Invoke-Command
      -FilePath <string>
      -SSHConnection <hashtable[]>
      [-AsJob]
      [-HideComputerName]
      [-RemoteDebug]
      [-InputObject <psobject>]
      [-ArgumentList <Object[]>]
      [<CommonParameters>]

説明

コマンドレットは Invoke-Command 、ローカル コンピューターまたはリモート コンピューターでコマンドを実行し、エラーを含むコマンドからすべての出力を返します。 1 つの Invoke-Command コマンドを使用して、複数のコンピューターでコマンドを実行できます。

リモート コンピューターで 1 つのコマンドを実行するには、ComputerName パラメーターを使用します。 データを共有する一連の関連コマンドを実行するには、 コマンドレットをNew-PSSession使用してリモート コンピューターに PSSession (永続的な接続) を作成し、 の Invoke-CommandSession パラメーターを使用して PSSession でコマンドを実行します。 切断されたセッションのコマンドを実行するには、InDisconnectedSession パラメーターを使用します。 コマンドをバックグラウンド ジョブとして実行するには、AsJob パラメーターを使用します。

また、ローカル コンピューターで をコマンドとして実行スクリプト ブロックに使用 Invoke-Command することもできます。 PowerShell は、現在のスコープの子スコープでスクリプト ブロックを直ちに実行します。

を使用して Invoke-Command リモート コンピューターでコマンドを実行する前に、「 about_Remote」を参照してください。

PowerShell 6.0 以降では、Secure Shell (SSH) を使用して、リモート コンピューターへの接続を確立し、コマンドを呼び出すことができます。 SSH はローカル コンピューターにインストールする必要があり、リモート コンピューターは PowerShell SSH エンドポイントを使用して構成する必要があります。 SSH ベースの PowerShell リモート セッションの利点は、複数のプラットフォーム (Windows、Linux、macOS) で動作することです。 SSH ベースのセッションでは、 HostName パラメーターまたは SSHConnection パラメーターを使用して、リモート コンピューターと関連する接続情報を指定します。 PowerShell SSH リモート処理を設定する方法の詳細については、「SSH 経由の PowerShell リモート処理」を参照してください。

一部のコード サンプルでは、スプラッティングを使用して行の長さを短くします。 詳細については、「 about_Splatting」を参照してください。

例 1: サーバーでスクリプトを実行する

次の使用例は、 Test.ps1 Server01 コンピューターでスクリプトを実行します。

Invoke-Command -FilePath c:\scripts\test.ps1 -ComputerName Server01

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

例 2: リモート サーバーでコマンドを実行する

次の使用例は、 Get-Culture Server01 リモート コンピューターでコマンドを実行します。

Invoke-Command -ComputerName Server01 -Credential Domain01\User01 -ScriptBlock {
    Get-Culture
}

ComputerName パラメーターは、リモート コンピューターの名前を指定します。 Credential パラメーターは、コマンドを実行するアクセス許可を持つユーザーである Domain01\User01 のセキュリティ コンテキストでコマンドを実行するために使用されます。 ScriptBlock パラメーターは、リモート コンピューターで実行するコマンドを指定します。

これに対して、PowerShell は User01 アカウントのパスワードと認証方法を要求します。 次に、Server01 コンピューターでコマンドを実行して結果を返します。

例 3: 永続的な接続でコマンドを実行する

この例では、Server02 という名前のリモート コンピューターで、永続的な接続を使用してセッションで同じ Get-Culture コマンドを実行します。

$s = New-PSSession -ComputerName Server02 -Credential Domain01\User01
Invoke-Command -Session $s -ScriptBlock { Get-Culture }

コマンドレットは New-PSSession 、Server02 リモート コンピューターにセッションを作成し、 変数に $s 保存します。 通常、セッションは、リモート コンピューターで一連のコマンドを実行する場合にのみ作成します。

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

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

例 4: セッションを使用して、データを共有する一連のコマンドを実行する

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

Invoke-Command -ComputerName Server02 -ScriptBlock { $p = Get-Process PowerShell }
Invoke-Command -ComputerName Server02 -ScriptBlock { $p.VirtualMemorySize }
$s = New-PSSession -ComputerName Server02
Invoke-Command -Session $s -ScriptBlock { $p = Get-Process PowerShell }
Invoke-Command -Session $s -ScriptBlock { $p.VirtualMemorySize }

17930240

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

ComputerName パラメーターを使用すると、PowerShell によってコマンドを実行するための新しいセッションが作成されます。 コマンドが完了すると、セッションは閉じられます。 変数は $p 1 つの接続で作成されましたが、2 番目のコマンド用に作成された接続には存在しません。

この問題は、リモート コンピューターに永続的なセッションを作成し、両方のコマンドを同じセッションで実行することで解決されます。

コマンドレットは New-PSSession 、コンピューター Server02 に永続的なセッションを作成し、そのセッションを 変数に $s 保存します。 次の行ではInvoke-Command、Session パラメーターを使用して、同じセッションで両方のコマンドを実行します。 両方のコマンドが同じセッションで実行されるため、値は $p アクティブなままです。

例 5: 変数に格納されているスクリプト ブロックを使用してコマンドを呼び出す

この例では、スクリプト ブロックとして変数に格納されているコマンドを実行する方法を示します。 スクリプト ブロックを変数に保存する場合は、 ScriptBlock パラメーターの値として変数を指定できます。

$command = {
    Get-WinEvent -LogName PowerShellCore/Operational |
      Where-Object -FilterScript { $_.Message -like '*certificate*' }
}
Invoke-Command -ComputerName S1, S2 -ScriptBlock $command

変数には $commandGet-WinEvent スクリプト ブロックとして書式設定されたコマンドが格納されます。 は Invoke-Command 、S1 および S2 リモート コンピューターに格納されている $command コマンドを実行します。

例 6: 複数のコンピューターで 1 つのコマンドを実行する

この例では、 を使用 Invoke-Command して複数のコンピューターで 1 つのコマンドを実行する方法を示します。

$parameters = @{
  ComputerName      = 'Server01', 'Server02', 'TST-0143', 'localhost'
  ConfigurationName = 'MySession.PowerShell'
  ScriptBlock       = { Get-WinEvent -LogName PowerShellCore/Operational }
}
Invoke-Command @parameters

ComputerName パラメーターは、コンピューター名のコンマ区切りのリストを指定します。 コンピューターの一覧には、ローカル コンピューターを表す localhost 値が含まれています。 ConfigurationName パラメーターは、代替セッション構成を指定します。 ScriptBlock パラメーターを実行Get-WinEventして、各コンピューターから PowerShellCore/Operational イベント ログを取得します。

例 7: 複数のコンピューター上のホスト プログラムのバージョンを取得する

この例では、200 台のリモート コンピューターで実行されている PowerShell ホスト プログラムのバージョンを取得します。

$version = Invoke-Command -ComputerName (Get-Content Machines.txt) -ScriptBlock {
    (Get-Host).Version
}

実行されるコマンドは 1 つだけであるため、各コンピューターへの永続的な接続を作成する必要はありません。 ただし、ComputerName パラメーターを使用してコンピューターを指定します。 コンピューターを指定するために、 コマンドレットを Get-Content 使用して、コンピューター名のファイルであるMachine.txt ファイルの内容を取得します。

コマンドレットは Invoke-CommandGet-Host リモート コンピューターでコマンドを実行します。 ドット表記を使用して、PowerShell ホストの Version プロパティを取得します。

これらのコマンドは一度に 1 つずつ実行されます。 コマンドが完了すると、すべてのコンピューターからのコマンドの出力が 変数に $version 保存されます。 出力には、データの発生元であるコンピューターの名前も含まれます。

例 8: 複数のリモート コンピューターでバックグラウンド ジョブを実行する

次の使用例は、2 台のリモート コンピューターでコマンドを実行します。 コマンドは Invoke-CommandAsJob パラメーターを使用して、コマンドがバックグラウンド ジョブとして実行されるようにします。 コマンドはリモート コンピューターで実行されますが、ジョブはローカル コンピューターに存在します。 結果はローカル コンピューターに送信されます。

$s = New-PSSession -ComputerName Server01, Server02
Invoke-Command -Session $s -ScriptBlock { Get-EventLog system } -AsJob

Id   Name    State      HasMoreData   Location           Command
---  ----    -----      -----         -----------        ---------------
1    Job1    Running    True          Server01,Server02  Get-EventLog system

$j = Get-Job
$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  :

$results = $j | Receive-Job

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

コマンドは Get-Job 、ジョブ オブジェクトを 変数に $j 保存します。 その後、変数は $j コマンドレットに Format-List パイプ処理され、ジョブ オブジェクトのすべてのプロパティが一覧に表示されます。 最後のコマンドは、ジョブの結果を取得します。 ジョブ オブジェクト $j を コマンドレットに Receive-Job パイプ処理し、結果を 変数に $results 格納します。

例 9: リモート コンピューターで実行するコマンドにローカル変数を含める

この例は、リモート コンピューターで実行されるコマンドにローカル変数の値を含める方法を示しています。 コマンドは、スコープ修飾子を Using 使用して、リモート コマンド内のローカル変数を識別します。 既定では、すべての変数は、リモート セッションで定義されると見なされます。 スコープ修飾子は Using 、PowerShell 3.0 で導入されました。 スコープ修飾子の Using 詳細については、「 about_Remote_Variablesabout_Scopes」を参照してください。

$Log = 'PowerShellCore/Operational'
Invoke-Command -ComputerName Server01 -ScriptBlock {
    Get-WinEvent -LogName $Using:Log -MaxEvents 10
}

変数には $Log 、イベント ログの名前 PowerShellCore/Operational が格納されます。 コマンドレットは Invoke-Command Server01 で実行され Get-WinEvent 、イベント ログから最新の 10 個のイベントを取得します。 LogName パラメーターの値は、$Logリモート セッションではなく、ローカル セッションで作成されたことを示すスコープ修飾子の前Usingに付いた変数です。

例 10: コンピューター名を非表示にする

この例では、 の HideComputerName パラメーターを使用した場合の Invoke-Command効果を示します。 HideComputerName では、このコマンドレットが返すオブジェクトは変更されません。 表示のみを変更します。 Format コマンドレットを 使用しても、影響を受けるオブジェクトの PsComputerName プロパティを表示できます。

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

Invoke-Command -ComputerName S1, S2 -HideComputerName -ScriptBlock {
    Get-Process PowerShell
}

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

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

例 11: スクリプト ブロックで Param キーワードを使用する

Paramキーワードと ArgumentList パラメーターは、スクリプト ブロック内の名前付きパラメーターに変数値を渡すために使用されます。 次の使用例は、文字 a で始まり拡張子を持つファイル名を .pdf 表示します。

キーワードの Param 詳細については、「 about_Language_Keywords」を参照してください。

$parameters = @{
    ComputerName = 'Server01'
    ScriptBlock  = {
        Param ($param1, $param2)
        Get-ChildItem -Name $param1 -Include $param2
    }
    ArgumentList = 'a*', '*.pdf'
}
Invoke-Command @parameters

aa.pdf
ab.pdf
ac.pdf
az.pdf

Invoke-Commandでは、 と の 2 つの変数$param1を定義する ScriptBlock パラメーターを$param2使用します。 Get-ChildItem では、名前付きパラメーター NameInclude を変数名と共に使用します。 ArgumentList は、値を変数に渡します。

例 12: スクリプト ブロックで $args 自動変数を使用する

$args自動変数と ArgumentList パラメーターは、スクリプト ブロック内のパラメーター位置に配列値を渡すために使用されます。 次の使用例は、サーバーのファイルのディレクトリの内容を .txt 表示します。 Path パラメーターはGet-ChildItem位置 0、Filter パラメーターは位置 1 です。

変数の$args詳細については、「about_Automatic_Variables」を参照してください。

$parameters = @{
    ComputerName = 'Server01'
    ScriptBlock  = { Get-ChildItem $args[0] $args[1] }
    ArgumentList = 'C:\Test', '*.txt*'
}
Invoke-Command @parameters

Directory: C:\Test

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
-a---           6/12/2019    15:15            128 alog.txt
-a---           7/27/2019    15:16            256 blog.txt
-a---           9/28/2019    17:10             64 zlog.txt

Invoke-Commandは ScriptBlock パラメーターを使用し、 と Get-ChildItem$args[1] 配列の値を$args[0]指定します。 ArgumentList はPath と Filter の$argsパラメーター位置にGet-ChildItem配列値を渡します

例 13: テキスト ファイルに一覧表示されているすべてのコンピューターでスクリプトを実行する

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

$parameters = @{
    ComputerName = (Get-Content Servers.txt)
    FilePath     = 'C:\Scripts\Sample.ps1'
    ArgumentList = 'Process', 'Service'
}
Invoke-Command @parameters

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

例 14: URI を使用してリモート コンピューターでコマンドを実行する

この例では、Uniform Resource Identifier (URI) で識別されるリモート コンピューターでコマンドを実行する方法を示します。 この特定の例では、 Set-Mailbox リモート Exchange サーバーでコマンドを実行します。

$LiveCred = Get-Credential
$parameters = @{
  ConfigurationName = 'Microsoft.Exchange'
  ConnectionUri     = 'https://ps.exchangelabs.com/PowerShell'
  Credential        = $LiveCred
  Authentication    = 'Basic'
  ScriptBlock       = { Set-Mailbox Dan -DisplayName 'Dan Park' }
}
Invoke-Command @parameters

最初の行では、 コマンドレットを Get-Credential 使用して、Windows Live ID 資格情報を 変数に $LiveCred 格納します。 PowerShell は、Windows Live ID 資格情報の入力をユーザーに求めます。

変数は $parameters 、コマンドレットに渡される Invoke-Command パラメーターを含むハッシュ テーブルです。 コマンドレットはInvoke-CommandSet-MailboxMicrosoft.Exchange セッション構成を使用してコマンドを実行します。 ConnectionURI パラメーターは、Exchange サーバーのエンドポイントの URL を指定しています。 Credential パラメーターは、 変数に格納されている資格情報を$LiveCred指定します。 AuthenticationMechanism パラメーターでは、基本認証の使用を指定しています。 ScriptBlockパラメーターは、コマンドが含まれているスクリプト ブロックを指定しています。

例 15: セッション オプションを使用する

この例では、 SessionOption パラメーターを作成して使用する方法を示します。

$so = New-PSSessionOption -SkipCACheck -SkipCNCheck -SkipRevocationCheck
$parameters = @{
    ComputerName  = 'server01'
    UseSSL        = $true
    ScriptBlock   = { Get-HotFix }
    SessionOption = $so
    Credential    = 'server01\user01'
}
Invoke-Command @parameters

コマンドレットは New-PSSessionOption 、受信 HTTPS 接続の評価中に、リモート エンドが証明機関、正規名、失効リストを検証しないようにするセッション オプション オブジェクトを作成します。 SessionOption オブジェクトは 変数に$so保存されます。

Note

これらのチェックを無効にするとトラブルシューティングには便利ですが、明らかに安全ではありません。

コマンドレットは Invoke-Command 、コマンドをリモートで Get-HotFix 実行します。 SessionOption パラメーターには 変数が指定されています$so

例 16: リモート コマンドで URI リダイレクトを管理する

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

$max = New-PSSessionOption -MaximumRedirection 1
$parameters = @{
  ConnectionUri    = 'https://ps.exchangelabs.com/PowerShell'
  ScriptBlock      = { Get-Mailbox dan }
  AllowRedirection = $true
  SessionOption    = $max
}
Invoke-Command @parameters

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

コマンドレットはInvoke-CommandGet-Mailboxリモート Microsoft Exchange Serverでコマンドを実行します。 AllowRedirection パラメーターは、接続を代替エンドポイントにリダイレクトするための明示的なアクセス許可を提供します。 SessionOption パラメーターは、 変数に格納されているセッション オブジェクトを$max使用します。

その結果、 ConnectionURI で指定されたリモート コンピューターがリダイレクト メッセージを返した場合、PowerShell は接続をリダイレクトしますが、新しい宛先から別のリダイレクト メッセージが返された場合、リダイレクト数の値 1 を超え、 Invoke-Command 終了しないエラーが返されます。

例 17: リモート セッションでネットワーク共有にアクセスする

この例では、リモート セッションからネットワーク共有にアクセスする方法を示します。 この例を示すために、3 台のコンピューターを使用します。 Server01 はローカル コンピューター、Server02 はリモート コンピューター、Net03 にはネットワーク共有が含まれています。 Server01 は Server02 に接続し、Server02 はネットワーク共有にアクセスするために Net03 への 2 番目のホップを実行します。 PowerShell リモート処理がコンピューター間のホップをサポートする方法の詳細については、「 PowerShell リモート処理での 2 番目のホップの作成」を参照してください。

必要な資格情報セキュリティ サポート プロバイダー (CredSSP) の委任は、ローカル コンピューターのクライアント設定とリモート コンピューターのサービス設定で有効になります。 この例のコマンドを実行するには、ローカル コンピューターとリモート コンピューターの Administrators グループのメンバーである必要があります。

Enable-WSManCredSSP -Role Client -DelegateComputer Server02
$s = New-PSSession Server02
Invoke-Command -Session $s -ScriptBlock { Enable-WSManCredSSP -Role Server -Force }
$parameters = @{
  ComputerName   = 'Server02'
  ScriptBlock    = { Get-Item \\Net03\Scripts\LogFiles.ps1 }
  Authentication = 'CredSSP'
  Credential     = 'Domain01\Admin01'
}
Invoke-Command @parameters

コマンドレットを Enable-WSManCredSSP 使用すると、Server01 ローカル コンピューターから Server02 リモート コンピューターへの CredSSP 委任が有効になります。 Role パラメーターは、ローカル コンピューターで CredSSP クライアント設定を構成するクライアントを指定します。

New-PSSession は Server02 の PSSession オブジェクトを作成し、 オブジェクトを 変数に $s 格納します。

コマンドレットでは Invoke-Command 、 変数を $s 使用してリモート コンピューター Server02 に接続します。 ScriptBlock パラメーターは、リモート コンピューターで実行されますEnable-WSManCredSSPRole パラメーターは、リモート コンピューターで CredSSP サーバー設定を構成するサーバーを指定します。

変数には $parameters 、ネットワーク共有に接続するためのパラメーター値が含まれています。 コマンドレットは Invoke-CommandGet-Item のセッション $sでコマンドを実行します。 このコマンドは、ネットワーク共有からスクリプトを \\Net03\Scripts 取得します。 このコマンドでは、値が CredSSPAuthentication パラメーターと、値 Domain01\Admin01Credential パラメーターが使用されます。

例 18: 多くのリモート コンピューターでスクリプトを開始する

この例では、100 を超えるコンピューターでスクリプトを実行します。 ローカル コンピューターへの影響を最小限に抑えるために、各コンピューターに接続してスクリプトを起動した後で、各コンピューターとの接続を切断します。 スクリプトは、引き続き切断されたセッションで実行されます。

$parameters = @{
  ComputerName          = (Get-Content -Path C:\Test\Servers.txt)
  InDisconnectedSession = $true
  FilePath              = '\\Scripts\Public\ConfigInventory.ps1'
  SessionOption         = @{
      OutputBufferingMode = 'Drop'
      IdleTimeout         = [timespan]::FromHours(12)
  }
}
Invoke-Command @parameters

コマンドは を使用 Invoke-Command してスクリプトを実行します。 ComputerName パラメーターの値は、Get-Contentテキスト ファイルからリモート コンピューターの名前を取得するコマンドです。 InDisconnectedSession パラメーターにより、コマンドを起動するとすぐにセッションが切断されます。 FilePath パラメーターの値は、各コンピューターで実行されるInvoke-Commandスクリプトです。

SessionOption の値はハッシュ テーブルです。 OutputBufferingMode 値が にDrop設定され、IdleTimeout 値が 12 時間に設定されています。

切断されたセッションで実行されるコマンドとスクリプトの結果を取得するには、 コマンドレットを使用します Receive-PSSession

例 19: SSH を使用してリモート コンピューターでコマンドを実行する

この例では、Secure Shell (SSH) を使用してリモート コンピューターでコマンドを実行する方法を示します。 リモート コンピューターでパスワードの入力を求める SSH が構成されている場合は、パスワード プロンプトが表示されます。 それ以外の場合は、SSH キーベースのユーザー認証を使用する必要があります。

Invoke-Command -HostName UserA@LinuxServer01 -ScriptBlock { Get-MailBox * }

例 20: SSH を使用してリモート コンピューターでコマンドを実行し、ユーザー認証キーを指定する

この例では、SSH を使用してリモート コンピューターでコマンドを実行し、ユーザー認証用のキー ファイルを指定する方法を示します。 キー認証が失敗し、リモート コンピューターが基本パスワード認証を許可するように構成されている場合を除き、パスワードの入力を求められることはありません。

$parameters = @{
    HostName    = 'UserA@LinuxServer01'
    ScriptBlock = { Get-MailBox * }
    KeyFilePath = '/UserA/UserAKey_rsa'
}
Invoke-Command

例 21: SSH をジョブとして使用して複数のリモート コンピューターでスクリプト ファイルを実行する

この例では、SSH と SSHConnection パラメーター セットを使用して、複数のリモート コンピューターでスクリプト ファイルを実行する方法を示します。 SSHConnection パラメーターは、各コンピューターの接続情報を含むハッシュ テーブルの配列を受け取ります。 この例では、ターゲット リモート コンピューターでキーベースのユーザー認証をサポートするように SSH が構成されている必要があります。

$sshConnections = @(
    @{
        HostName    = "WinServer1"
        UserName    = "Domain\UserA"
        KeyFilePath = "C:\Users\UserA\id_rsa"
    }
    @{
        HostName    = "UserB@LinuxServer5"
        KeyFilePath = "/Users/UserB/id_rsa"
    }
)
$results = Invoke-Command -FilePath c:\Scripts\GetInfo.ps1 -SSHConnection $sshConnections

例 22: SSH オプションを使用してリモート SSH セッションに接続する

この例では、SSH オプションを使用して、リモート Linux ベースのコンピューターでスクリプト ファイルを実行する方法を示します。 Options パラメーターは、リモート システムへの接続を確立した基になるsshコマンドにオプションとして渡される値のハッシュテーブルを受け取ります。

$options = @{
    Port=22
    User = 'UserB'
    Host = 'LinuxServer5'
}
$results = Invoke-Command -FilePath c:\Scripts\CollectEvents.ps1 -KeyFilePath '/Users/UserB/id_rsa' -Options $options

パラメーター

-AllowRedirection

この接続を代替 Uniform Resource Identifier (URI) にリダイレクトできます。

ConnectionURI パラメーターを使用すると、リモートの送信先は別の URI にリダイレクトするように指示を返すことができます。 既定では、PowerShell は接続をリダイレクトしませんが、このパラメーターを使用して接続のリダイレクトを許可できます。

また、MaximumConnectionRedirectionCount セッション オプション値を変更することで、接続をリダイレクトする回数を制限することもできます。 コマンドレットの MaximumRedirection パラメーターを New-PSSessionOption 使用するか、ユーザー設定変数の MaximumConnectionRedirectionCount プロパティを $PSSessionOption 設定します。 既定値は 5 です。

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

-ApplicationName

接続 URI のアプリケーション名セグメントを指定します。 コマンドで ConnectionURI パラメーターを使用していない場合は、このパラメーターを使用してアプリケーション名を指定します。

既定値は、ローカル コンピューターの $PSSessionApplicationName 基本設定変数の値です。 この基本設定変数が定義されていない場合、既定値は WSMAN です。 この値はほとんどの用途に適しています。 詳細については、「 about_Preference_Variables」を参照してください。

WinRM サービスは、アプリケーション名を使用して、接続要求を処理するリスナーを選択します。 このパラメーターの値は、リモート コンピューター上のリスナーの URLPrefix プロパティの値に一致している必要があります。

Type:String
Position:Named
Default value:$PSSessionApplicationName if set on the local computer, otherwise WSMAN
Accept pipeline input:True
Accept wildcard characters:False

-ArgumentList

scriptblock のパラメーターの値を指定します。 スクリプト ブロック内のパラメーターは、 ArgumentList に指定された配列値から位置によって渡されます。 これは配列スプラッティングと呼ばれます。 ArgumentList の動作の詳細については、「about_Splatting」を参照してください。

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

-AsJob

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

AsJob パラメーターを使用すると、コマンドはジョブを表す オブジェクトを返し、コマンド プロンプトを表示します。 ジョブが完了しても、引き続きセッションで作業できます。 ジョブを管理するには、 コマンドレットを *-Job 使用します。 ジョブの結果を取得するには、Receive-Job コマンドレットを使用します。

AsJob パラメーターは、 コマンドレットを使用してコマンドレットをInvoke-Commandリモートで実行Start-Jobする場合と似ています。 ただし、 AsJob では、ジョブがリモート コンピューターで実行されている場合でも、ローカル コンピューター上にジョブが作成されます。 リモート ジョブの結果は、ローカル コンピューターに自動的に返されます。

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

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

-Authentication

ユーザーの資格情報の認証に使用されるメカニズムを指定します。 CredSSP 認証は、Windows Vista、Windows Server 2008、およびそれ以降のバージョンの Windows オペレーティング システムでのみ使用できます。

このパラメーターに使用できる値は次のとおりです。

  • Default
  • Basic
  • Credssp
  • ダイジェスト
  • Kerberos
  • ネゴシエート
  • NegotiateWithImplicitCredential

既定値は Default です。

このパラメーターの値の詳細については、「 AuthenticationMechanism 列挙」を参照してください。

注意事項

ユーザーの資格情報が認証対象のリモート コンピューターに渡される Credential Security Support Provider (CredSSP) 認証は、リモート ネットワーク共有にアクセスする場合など、複数のリソースの認証を必要とするコマンドを対象としています。 このメカニズムを使用すると、リモート操作のセキュリティ リスクが高まります。 リモート コンピューターのセキュリティが低下している場合は、そのリモート コンピューターに渡される資格情報を使用してネットワーク セッションが制御される場合があります。 詳細については、「 資格情報セキュリティ サポート プロバイダー」を参照してください。

Type:AuthenticationMechanism
Accepted values:Basic, Default, Credssp, Digest, Kerberos, Negotiate, NegotiateWithImplicitCredential
Position:Named
Default value:Default
Accept pipeline input:False
Accept wildcard characters:False

-CertificateThumbprint

切断されたセッションに接続するためのアクセス許可を持つユーザー アカウントのデジタル公開キー証明書 (X509) を指定します。 証明書の拇印を入力します。

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

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

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

-ComputerName

コマンドを実行するコンピューターを指定します。 既定値はローカル コンピューターです。

ComputerName パラメーターを使用すると、PowerShell によって、指定したコマンドの実行にのみ使用される一時的な接続が作成され、閉じられます。 永続的な接続が必要な場合は、 Session パラメーターを使用します。

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

ComputerName の値に IP アドレスを使用するには、コマンドに Credential パラメーターを含める必要があります。 コンピューターは HTTPS トランスポート用に構成する必要があります。または、リモート コンピューターの IP アドレスをローカル コンピューターの WinRM TrustedHosts リストに含める必要があります。 TrustedHosts リストにコンピューター名を追加する手順については、「How to Add a Computer to the Trusted Host List」を参照してください。

Windows Vista 以降のバージョンの Windows オペレーティング システムでは、 ComputerName の値にローカル コンピューターを含めるには、[ 管理者として実行 ] オプションを使用して PowerShell を実行する必要があります。

Type:String[]
Aliases:Cn
Position:0
Default value:Local computer
Accept pipeline input:False
Accept wildcard characters:False

-ConfigurationName

新しい PSSession に使用されるセッション構成を指定します。

セッション構成の構成名または完全修飾リソース URI を入力します。 構成名のみを指定した場合は、次のスキーマ URI が先頭に付加されます。 http://schemas.microsoft.com/PowerShell

SSH で使用する場合、このパラメーターは、 で sshd_config定義されているターゲットで使用するサブシステムを指定します。 SSH の既定値はサブシステムです powershell

セッションのセッション構成は、リモート コンピューター上にあります。 指定したセッション構成がリモート コンピューターに存在しない場合、コマンドは失敗します。

既定値は、ローカル コンピューターの $PSSessionConfigurationName 基本設定変数の値です。 この基本設定変数が設定されていない場合、既定値は Microsoft.PowerShell です。 詳細については、「 about_Preference_Variables」を参照してください。

Type:String
Position:Named
Default value:$PSSessionConfigurationName if set on the local computer, otherwise Microsoft.PowerShell
Accept pipeline input:True
Accept wildcard characters:False

-ConnectingTimeout

最初の SSH 接続が完了するまでに許可される時間をミリ秒単位で指定します。 指定した時間内に接続が完了しない場合は、エラーが返されます。

このパラメーターは PowerShell 7.2 で導入されました

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

-ConnectionUri

セッションの接続エンドポイントを定義する Uniform Resource Identifier (URI) を指定します。 URI は完全修飾名にする必要があります。

この文字列の形式は次のとおりです。

<Transport>://<ComputerName>:<Port>/<ApplicationName>

既定値は、次のとおりです。

http://localhost:5985/WSMAN

接続 URI を指定しない場合は、 UseSSL パラメーターと Port パラメーターを使用して接続 URI 値を指定できます。

URI の Transport セグメントの有効な値は、HTTP および HTTPS です。 トランスポート セグメントで接続 URI を指定したが、ポートを指定しない場合、セッションは標準ポート (HTTP の場合は 80、HTTPS の場合は 443) で作成されます。 PowerShell リモート処理に既定のポートを使用するには、HTTP にポート 5985、HTTPS に 5986 を指定します。

宛先コンピューターが接続を別の URI にリダイレクトする場合、コマンドで AllowRedirection パラメーターを使用しない限り、PowerShell はリダイレクトを防止します。

Type:Uri[]
Aliases:URI, CU
Position:0
Default value:http://localhost:5985/WSMAN
Accept pipeline input:False
Accept wildcard characters:False

-ContainerId

コンテナー ID の配列を指定します。

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

-Credential

この処理を実行するアクセス許可を持つユーザー アカウントを指定します。 既定値は現在のユーザーです。

User01 や Domain01\User01 などのユーザー名を入力するか、コマンドレットによって生成された PSCredential オブジェクトをGet-Credential入力します。 ユーザー名を入力すると、パスワードの入力を求められます。

資格情報は PSCredential オブジェクトに 格納され、パスワードは SecureString として格納されます。

Note

SecureString データ保護の詳細については、「SecureString のセキュリティ保護方法」を参照してください。

Type:PSCredential
Position:Named
Default value:Current user
Accept pipeline input:True
Accept wildcard characters:False

-EnableNetworkAccess

このコマンドレットが、ループバック セッションに対話型セキュリティ トークンを追加することを示します。 対話型トークンを使用すると、他のコンピューターからデータを取得するコマンドをループバック セッションで実行できます。 たとえば、リモート コンピューターからローカル コンピューターに XML ファイルをコピーするコマンドをセッションで実行できます。

ループバック セッションは、同じコンピューター上で開始および終了する PSSession です。 ループバック セッションを作成するには、 ComputerName パラメーターを省略するか、値をドット (.)、localhost、またはローカル コンピューターの名前に設定します。

既定では、ループバック セッションはネットワーク トークンを使用して作成されます。これにより、リモート コンピューターに対して認証するための十分なアクセス許可が提供されない可能性があります。

EnableNetworkAccess パラメーターは、ループバック セッションでのみ有効です。 リモート コンピューターでセッションを作成するときに EnableNetworkAccess を 使用すると、コマンドは成功しますが、 パラメーターは無視されます。

セッション資格情報を他のコンピューターに委任する Authentication パラメーターの CredSSP 値を使用して、ループバック セッションでリモート アクセスを許可できます。

悪意のあるアクセスからコンピューターを保護するために、 EnableNetworkAccess を使用して作成された対話型トークンを持つ切断されたループバック セッションは、セッションが作成されたコンピューターからのみ再接続できます。 CredSSP 認証を使用するセッションが切断された場合には、他のコンピューターから再接続することができます。 詳細については、「Disconnect-PSSession」を参照してください。

このパラメーターは、PowerShell 3.0 で導入されました。

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

-FilePath

このコマンドレットが 1 つ以上のリモート コンピューターで実行されるローカル スクリプトを指定します。 スクリプトのパスとファイル名を入力するか、スクリプト パスを に Invoke-Commandパイプします。 スクリプトは、ローカル コンピューターまたはローカル コンピューターがアクセスできるディレクトリに存在する必要があります。 ArgumentList を使用して、スクリプト内のパラメーターの値を指定します。

このパラメーターを使用すると、PowerShell は、指定したスクリプト ファイルの内容をスクリプト ブロックに変換し、スクリプト ブロックをリモート コンピューターに送信して、リモート コンピューター上で実行します。

Type:String
Aliases:PSPath
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-HideComputerName

このコマンドレットは、出力表示から各オブジェクトのコンピューター名を省略することを示します。 既定では、オブジェクトを生成したコンピューター名が画面に表示されます。

このパラメーターが有効なのは、出力の表示だけです。 オブジェクトは変更されません。

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

-HostName

Secure Shell (SSH) ベースの接続のコンピューター名の配列を指定します。 これは ComputerName パラメーターに似ていますが、リモート コンピューターへの接続は Windows WinRM ではなく SSH を使用して行われます。

このパラメーターは、PowerShell 6.0 で導入されました。

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

-InDisconnectedSession

このコマンドレットが、切断されたセッションでコマンドまたはスクリプトを実行することを示します。

InDisconnectedSession パラメーターを使用すると、Invoke-Command各リモート コンピューターに永続的なセッションが作成され、ScriptBlock または FilePath パラメーターで指定されたコマンドが開始され、セッションから切断されます。 コマンドは、切断されたセッションで引き続き実行されます。 InDisconnectedSession を使用すると、リモート セッションへの接続を維持せずにコマンドを実行できます。 また、結果が返される前にセッションが切断されるため、 InDisconnectedSession では、セッション間で分割されるのではなく、すべてのコマンド結果が再接続されたセッションに確実に返されます。

Session パラメーターまたは AsJob パラメーターでは InDisconnectedSession を使用できません。

InDisconnectedSession を使用するコマンドは、切断されたセッションを表す PSSession オブジェクトを返します。 コマンド出力は返されません。 切断されたセッションに接続するには、 または Receive-PSSession コマンドレットをConnect-PSSession使用します。 セッションで実行されたコマンドの結果を取得するには、 コマンドレットを Receive-PSSession 使用します。 切断されたセッションで出力を生成するコマンドを実行するには、 OutputBufferingMode セッション オプションの値を Drop に設定 します。 切断されたセッションに接続する場合は、セッションを削除する前に接続するのに十分な時間が確保されるように、セッションでアイドル タイムアウトを設定します。

出力バッファリング モードとアイドル タイムアウトは 、SessionOption パラメーターまたは基本設定変数で $PSSessionOption 設定できます。 セッション オプションの詳細については、「」と「about_Preference_Variables」を参照してくださいNew-PSSessionOption

切断されたセッションの機能の詳細については、「about_Remote_Disconnected_Sessions」を参照してください。

このパラメーターは、PowerShell 3.0 で導入されました。

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

-InputObject

コマンドへの入力を指定します。 オブジェクトが格納されている変数を入力するか、オブジェクトを取得するコマンドまたは式を入力します。

InputObject パラメーターを使用する場合は、ScriptBlock パラメーターの値で自動変数を使用$Inputして、入力オブジェクトを表します。

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

-JobName

バックグラウンド ジョブのフレンドリ名を指定します。 既定では、ジョブには という名前が付けられます Job<n>。ここで <n> 、 は序数です。

コマンドで JobName パラメーターを使用すると、コマンドはジョブとして実行され Invoke-Command 、コマンドに AsJob を含めない場合でもジョブ オブジェクトが返されます。

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

Type:String
Position:Named
Default value:Job<n>
Accept pipeline input:False
Accept wildcard characters:False

-KeyFilePath

リモート コンピューターでユーザーを認証するために Secure Shell (SSH) によって使用されるキー ファイル パスを指定します。

SSH を使用すると、基本パスワード認証の代わりに、秘密キーと公開キーを使用してユーザー認証を実行できます。 リモート コンピューターがキー認証用に構成されている場合、このパラメーターを使用して、ユーザーを識別するキーを指定できます。

このパラメーターは、PowerShell 6.0 で導入されました。

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

-NoNewScope

このコマンドレットが、現在のスコープで指定したコマンドを実行することを示します。 既定では、 Invoke-Command は独自のスコープでコマンドを実行します。

このパラメーターは、現在のセッションで実行されるコマンド、つまり、ComputerName および Session の両パラメーターを除外したコマンド内でのみ有効です。

このパラメーターは、PowerShell 3.0 で導入されました。

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

-Options

リモート SSH ベースのセッションに接続するときに使用される SSH オプションのハッシュテーブルを指定します。 使用できるオプションは、Unix ベースの バージョンの ssh コマンドでサポートされている任意の値です。

パラメーターによって明示的に渡された値は 、Options ハッシュテーブルで渡された値よりも優先されます。 たとえば、Port パラメーターを使用すると、Options ハッシュテーブルで渡されたキーと値のペアがオーバーライドPortされます。

このパラメーターは PowerShell 7.3 で追加されました。

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

-Port

このコマンドに使用されるリモート コンピューター上のネットワーク ポートを指定します。 リモート コンピューターに接続するには、リモート コンピューターで、接続に使用されるポートをリッスンすることが必要です。 既定のポートは 5985 (HTTP の場合は WinRM ポート) と 5986 (HTTPS の場合は WinRM ポート) です。

別のポートを使用する場合には、そのポートでリッスンするようにリモート コンピューターの WinRM リスナーを構成します。 リスナーを構成するには、PowerShell プロンプトで次の 2 つのコマンドを入力します。

Remove-Item -Path WSMan:\Localhost\listener\listener* -Recurse

New-Item -Path WSMan:\Localhost\listener -Transport http -Address * -Port \<port-number\>

必要な場合を除き、 Port パラメーターを使用しないでください。 コマンドに設定されているポートは、コマンドが実行されるすべてのコンピューターまたはセッションに適用されます。 代替ポートの設定によっては、コマンドがすべてのコンピューターで実行されない場合があります。

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

-RemoteDebug

リモート PowerShell セッションでデバッグ モードで呼び出されたコマンドを実行するために使用されます。

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

-RunAsAdministrator

このコマンドレットが管理者としてコマンドを呼び出したことを示します。

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

-ScriptBlock

実行するコマンドを指定します。 コマンドを中かっこ ({ }) で囲み、スクリプト ブロックを作成します。 を使用して Invoke-Command コマンドをリモートで実行すると、コマンド内のすべての変数がリモート コンピューターで評価されます。

Note

scriptblock のパラメーターは 、ArgumentList から位置によってのみ渡すことができます。 スイッチ パラメーターを位置で渡すことはできません。 SwitchParameter 型のように動作するパラメーターが必要な場合は、代わりにブール型を使用します。

Type:ScriptBlock
Aliases:Command
Position:0
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-Session

このコマンドレットがコマンドを実行するセッションの配列を指定します。 PSSession オブジェクトを含む変数、または PSSession オブジェクトを作成または取得するコマンド (または Get-PSSession コマンドなど) をNew-PSSession入力します。

PSSession を作成すると、PowerShell によってリモート コンピューターへの永続的な接続が確立されます。 PSSession を使用して、データを共有する一連の関連コマンドを実行します。 1 つのコマンドまたは一連の関連のないコマンドを実行するには、 ComputerName パラメーターを使用します。 詳細については、「 about_PSSessions」を参照してください。

Type:PSSession[]
Position:0
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-SessionName

切断されたセッションのフレンドリ名を指定します。 名前を使用して、コマンドなどの後続のコマンドでセッションを Get-PSSession 参照できます。 このパラメーターは、InDisconnectedSession パラメーターと共に使用する場合に限り有効です。

このパラメーターは、PowerShell 3.0 で導入されました。

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

-SessionOption

セッションの詳細オプションを指定します。 コマンドレットを使用してNew-PSSessionOption作成した SessionOption オブジェクトや、キーがセッション オプション名で値がセッション オプション値であるハッシュ テーブルを入力します。

Note

SessionOption にハッシュテーブルを指定すると、PowerShell はハッシュテーブルを System.Management.Autiomation.Remoting.PSSessionOption オブジェクトに変換します。 ハッシュテーブルで指定されたキーの値は、 オブジェクトの一致するプロパティにキャストされます。 これは、 の呼び出しとは異なる動作をします New-PSSessionOption。 たとえば、IdleTimeout などのタイムアウト プロパティの System.TimeSpan 値は、整数値をミリ秒ではなくティックに変換します。 PSSessionOption オブジェクトとそのプロパティの詳細については、「PSSessionOption」を参照してください。

オプションの既定値は、設定されている場合は、基本設定変数の $PSSessionOption 値によって決まります。 それ以外の場合、既定値はセッション構成で設定されたオプションによって決まります。

セッション オプションの値は、基本設定変数とセッション構成で設定された $PSSessionOption セッションの既定値よりも優先されます。 ただし、セッション構成で設定された最大値、クォータ、または制限よりも優先されません。

既定値を含むセッション オプションの説明については、「」を参照してください New-PSSessionOption。 基本設定変数の $PSSessionOption 詳細については、「 about_Preference_Variables」を参照してください。 セッション構成の詳細については、「 about_Session_Configurations」を参照してください。

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

-SSHConnection

このパラメーターはハッシュ テーブルの配列を受け取ります。各ハッシュ テーブルには、Secure Shell (SSH) 接続を確立するために必要な 1 つ以上の接続パラメーターが含まれています。 SSHConnection パラメーターは、各セッションで異なる接続情報が必要な複数のセッションを作成する場合に便利です。

ハッシュテーブルには、次のメンバーがあります。

  • ComputerName (または HostName)
  • [ポート]
  • UserName
  • KeyFilePath (または IdentityFilePath)

ComputerName (または HostName) は、必要な唯一のキーと値のペアです。

このパラメーターは、PowerShell 6.0 で導入されました。

Type:Hashtable[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-SSHTransport

Secure Shell (SSH) を使用してリモート接続が確立されていることを示します。

既定では、PowerShell は Windows WinRM を使用してリモート コンピューターに接続します。 このスイッチは、SSH ベースのリモート接続を確立するために 、PowerShell で HostName パラメーターを使用するように強制します。

このパラメーターは、PowerShell 6.0 で導入されました。

Type:SwitchParameter
Accepted values:true
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

-Subsystem

新しい PSSession に使用される SSH サブシステムを指定します。

これは、sshd_configで定義されているターゲットで使用するサブシステムを指定します。 サブシステムは、定義済みのパラメーターを使用して PowerShell の特定のバージョンを開始します。 指定したサブシステムがリモート コンピューターに存在しない場合、コマンドは失敗します。

このパラメーターを使用しない場合、デフォルトはサブシステムです powershell

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

-ThrottleLimit

このコマンドを実行するために確立できる最大コンカレント接続数を指定します。 このパラメーターを省略した場合、または値 0 を入力した場合は、既定値の 32 が使用されます。

スロットル制限は現在のコマンドのみに適用され、セッションまたはコンピューターには適用されません。

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

-UserName

リモート コンピューターでコマンドを実行するために使用するアカウントのユーザー名を指定します。 ユーザー認証方法は、リモート コンピューターでの Secure Shell (SSH) の構成方法によって異なります。

SSH が基本パスワード認証用に構成されている場合は、ユーザー パスワードの入力を求められます。

SSH がキーベースのユーザー認証用に構成されている場合は、 KeyFilePath パラメーターを使用してキー ファイル パスを指定でき、パスワード プロンプトは表示されません。 クライアント ユーザー キー ファイルが SSH の既知の場所にある場合は、キーベースの認証に KeyFilePath パラメーターは必要ありません。ユーザー認証はユーザー名に基づいて自動的に行われます。 詳細については、キーベースのユーザー認証に関するプラットフォームの SSH ドキュメントを参照してください。

これは必須のパラメーターではありません。 UserName パラメーターが指定されていない場合は、現在ログオンしているユーザー名が接続に使用されます。

このパラメーターは、PowerShell 6.0 で導入されました。

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

-UseSSL

このコマンドレットが Secure Sockets Layer (SSL) プロトコルを使用してリモート コンピューターへの接続を確立することを示します。 既定では、SSL は使用されません。

WS-Managementは、ネットワーク経由で送信されるすべての PowerShell コンテンツを暗号化します。 UseSSL パラメーターは、HTTP ではなく HTTPS 経由でデータを送信する追加の保護です。

このパラメーターを使用しても、コマンドに使用されているポートで SSL を使用できない場合、コマンドは失敗します。

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

-VMId

仮想マシンの ID の配列を指定します。

Type:Guid[]
Aliases:VMGuid
Position:0
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-VMName

仮想マシンの名前の配列を指定します。

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

入力

ScriptBlock

スクリプト ブロック内のコマンドを に Invoke-Commandパイプできます。 コマンドの $Input 入力オブジェクトを表すには、自動変数を使用します。

出力

System.Management.Automation.PSRemotingJob

AsJob パラメーターを使用すると、このコマンドレットはジョブ オブジェクトを返します。

PSSession

InDisconnectedSession パラメーターを使用すると、このコマンドレットは PSSession オブジェクトを返します。

Object

既定では、このコマンドレットは、呼び出されたコマンドの出力 ( ScriptBlock パラメーターの値) を返します。

メモ

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

  • すべてのプラットフォーム:
    • icm

Windows Vista 以降のバージョンの Windows オペレーティング システムでは、 の ComputerName パラメーター Invoke-Command を使用してローカル コンピューターでコマンドを実行するには、[ 管理者として実行 ] オプションを使用して PowerShell を実行する必要があります。

複数のコンピューターでコマンドを実行すると、PowerShell は一覧に表示される順序でコンピューターに接続します。 ただし、コマンド出力は、リモート コンピューターから受信した順序で表示されます。これは異なる場合があります。

実行されるコマンドから発生した Invoke-Command エラーは、コマンドの結果に含まれます。 ローカル コマンドでは "終了するエラー" となるエラーは、リモート コマンドでは "終了しないエラー" として扱われます。 この方法により、1 台のコンピューターで終了エラーが発生しても、実行されているすべてのコンピューターでコマンドが閉じないようにします。 また、この方法は、1 台のコンピューターでリモート コマンドを実行する場合にも、使用されます。

リモート コンピューターがローカル コンピューターが信頼するドメインにない場合、コンピューターはユーザーの資格情報を認証できない可能性があります。 WS-Management で信頼されたホストの一覧にリモート コンピューターを追加するには、プロバイダーで次のコマンドを WSMAN 使用します。ここで <Remote-Computer-Name> 、 はリモート コンピューターの名前です。

Set-Item -Path WSMan:\Localhost\Client\TrustedHosts -Value \<Remote-Computer-Name\>

InDisconnectedSession パラメーターを使用して PSSession を切断すると、セッションの状態は Disconnected で、可用性は None になりますState プロパティの値は、現在のセッションに関連付けられています。 Disconnected の値は、PSSession が現在のセッションに接続されていないことを意味します。 ただし、 PSSession がすべてのセッションから切断されているわけではありません。 別のセッションに接続されている可能性があるためです。 セッションに接続または再接続できるかどうかを確認するには、Availability プロパティを使用します。

Availability の値が None の場合は、セッションに接続できることを示します。 [ビジー] の値は、別のセッションに接続されているため、PSSession に接続できないことを示します。 セッションの State プロパティの値の詳細については、「 RunspaceState」を参照してください。 セッションの Availability プロパティの値の詳細については、「 RunspaceAvailability」を参照してください。

HostName パラメーターと SSHConnection パラメーターは、PowerShell 6.0 以降に含まれていました。 これらは、Secure Shell (SSH) に基づく PowerShell リモート処理を提供するために追加されました。 PowerShell と SSH は、複数のプラットフォーム (Windows、Linux、macOS) でサポートされており、PowerShell と SSH がインストールおよび構成されているこれらのプラットフォームで PowerShell リモート処理が機能します。 これは、WinRM に基づく以前の Windows のみのリモート処理とは別であり、WinRM 固有の機能と制限の多くは適用されません。 たとえば、WinRM ベースのクォータ、セッション オプション、カスタム エンドポイント構成、切断/再接続機能は現在サポートされていません。 PowerShell SSH リモート処理を設定する方法の詳細については、「 SSH 経由の PowerShell リモート処理」を参照してください。

実行可能ファイルは ssh 、次のソースから次の順序で構成データを取得します。

  1. コマンド ライン オプション
  2. ユーザーの構成ファイル (~/.ssh/config)
  3. システム全体の構成ファイル (/etc/ssh/ssh_config)

次のコマンドレット パラメーターは、パラメーターとオプションに ssh マップされます。

コマンドレット パラメーター ssh パラメーター 同等の ssh -o オプション
-KeyFilePath -i <KeyFilePath> -o IdentityFile=<KeyFilePath>
-UserName -l <UserName> -o User=<UserName>
-Port -p <Port> -o Port=<Port>
-ComputerName -Subsystem -s <ComputerName> <Subsystem> -o Host=<ComputerName>

パラメーターによって明示的に渡された値は 、Options ハッシュテーブルで渡された値よりも優先されます。 ファイルの詳細 ssh_config については、「 ssh_config(5)」を参照してください。