Invoke-Command

リファレンス

モジュール:: Microsoft.PowerShell.Core

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

構文

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-Commandを使用して 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 パラメーターは、コマンドを実行するアクセス許可を持つユーザーである Doメイン01\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-Command 、Server02 でコマンドを Get-Culture 実行します。 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

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

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

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

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

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

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

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

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

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

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

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

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

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

$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_Variablesとabout_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 つのコマンドは、PowerShell プロセスのGet-Processコマンドを実行するために使用Invoke-Commandします。最初のコマンドの出力には、PsComputerName プロパティが含まれています。このプロパティには、コマンドが実行されたコンピューターの名前が含まれます。 HideComputerName を使用する 2 番目のコマンドの出力には、PsComputerName 列は含まれません。

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

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

キーワード (keyword)の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では、名前付きパラメーター Name と Include を変数名と共に使用します。 ArgumentList は、値を変数に渡します。

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

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

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

$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 を使用してリモートコンピューターでコマンドを実行する

この例では、Uri (Uniform Resource Identifier) によって識別されるリモートコンピューターでコマンドを実行する方法を示します。この特定の例では、 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-Command、Set-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-Command 、リモートの Get-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) の委任は、ローカルコンピューターのクライアント設定とリモートコンピューターのサービス設定で有効になっています。この例のコマンドを実行するには、ローカルコンピューターとリモートコンピューターの 管理istrators グループのメンバーである必要があります。

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-WSManCredSSP。 Role パラメーターは、リモートコンピューターで CredSSP サーバー設定を構成するサーバーを指定します。

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

例 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
Required:	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
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ArgumentList

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

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

-AsJob

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

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

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

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

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

-Authentication

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

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

既定値
基本
Credssp
Digest
Kerberos
ネゴシエート
NegotiateWithImplicitCredential

既定値は Default です。

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

注意

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

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

-CertificateThumbprint

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

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

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

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

-ComputerName

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

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

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

ComputerName の値に IP アドレスを使用するには、コマンドに Credential パラメーターを含める必要があります。コンピューターは HTTPS トランスポート用に構成する必要があります。または、リモートコンピューターの IP アドレスをローカルコンピューターの WinRM TrustedHosts リストに含める必要があります。 TrustedHosts リストにコンピューター名を追加する手順については、「信頼できるホストの一覧にコンピューターを追加する方法」を参照してください。

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

Type:	String[]
Aliases:	Cn
Position:	0
Default value:	Local computer
Required:	False
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
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ConnectingTimeout

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

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

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

-ConnectionUri

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

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

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

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

http://localhost:5985/WSMAN

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

URI のトランスポート セグメントの有効な値は、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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ContainerId

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

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

-Credential

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

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

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

Note

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

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

-EnableNetworkAccess

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

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

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

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

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

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

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

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

-FilePath

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

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

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

-HideComputerName

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

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

Type:	SwitchParameter
Aliases:	HCN
Position:	Named
Default value:	False
Required:	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
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-InDisconnectedSession

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

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

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

InDisconnectedSession を使用するコマンドは、切断されたセッションを表す PSSession オブジェクトを返します。コマンド出力は返されません。切断されたセッションに接続するには、コマンドレットをConnect-PSSessionReceive-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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

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

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

Type:	PSObject
Position:	Named
Default value:	None
Required:	False
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>
Required:	False
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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-NoNewScope

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

このパラメーターは、現在のセッションで実行されているコマンド、つまり ComputerName パラメーターと Session パラメーターの両方を省略したコマンドでのみ有効です。

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

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	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
Required:	False
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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RemoteDebug

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

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

-RunAsAdministrator

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

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	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
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Session

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

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

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

-SessionName

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

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

Type:	String[]
Position:	Named
Default value:	None
Required:	False
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
Required:	False
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
Required:	True
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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Subsystem

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

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

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

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

-ThrottleLimit

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

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

Type:	Int32
Position:	Named
Default value:	32
Required:	False
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
Required:	False
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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-VMId

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

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

-VMName

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

Type:	String[]
Position:	Named
Default value:	None
Required:	True
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 台のコンピューターでリモートコマンドを実行する場合にも、使用されます。

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

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

InDisconnectedSession パラメーターを使用して PSSession を切断すると、セッション状態は切断され、可用性は None になります。 State プロパティの値は、現在のセッションに対する相対値です。 Disconnected の値は、PSSession が現在のセッションに接続されていないことを意味します。ただし、PSSession がすべてのセッションから切断されているわけではありません。別のセッションに接続されている可能性があるためです。セッションに接続できるか再接続できるかを確認するには、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 、次のソースから次の順序で構成データを取得します。

コマンドラインオプション
ユーザーの構成ファイル (~/.ssh/config)
システム全体の構成ファイル (/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)」を参照してください。

Invoke-Command

構文

説明

例

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

パラメーター

-AllowRedirection

-ApplicationName

-ArgumentList

-AsJob

-Authentication

-CertificateThumbprint

-ComputerName

-ConfigurationName

-ConnectingTimeout

-ConnectionUri

-ContainerId

-Credential

-EnableNetworkAccess

-FilePath

-HideComputerName

-HostName

-InDisconnectedSession

-InputObject

-JobName

-KeyFilePath

-NoNewScope

-Options

-Port

-RemoteDebug

-RunAsAdministrator

-ScriptBlock

-Session

-SessionName

-SessionOption

-SSHConnection

-SSHTransport

-Subsystem

-ThrottleLimit

-UserName

-UseSSL

-VMId

-VMName

入力

出力

メモ

関連リンク

フィードバック

その他のリソース

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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