about_Remote_Variables

[アーティクル]
10/26/2022

簡単な説明

リモートコマンドのローカル変数とリモート変数の使用方法について説明します。

長い説明

リモートコンピューターで実行するコマンドで変数を使用できます。変数に値を割り当て、値の代わりに変数を使用します。

既定では、リモートコマンドの変数は、コマンドを実行するセッションで定義されているものと見なされます。ローカルセッションで定義されている変数は、コマンドでローカル変数として識別する必要があります。

リモート変数の使用

PowerShell では、リモートコマンドで使用される変数は、コマンドが実行されるセッションで定義されていることを前提としています。

この例では、コマンドが $ps 実行される一時セッションで変数が Get-WinEvent 定義されています。

Invoke-Command -ComputerName S1 -ScriptBlock {
  $ps = "*PowerShell*"; Get-WinEvent -LogName $ps
}

コマンドが永続セッション PSSession で実行される場合は、そのセッションでリモート変数を定義する必要があります。

$s = New-PSSession -ComputerName S1
Invoke-Command -Session $s -ScriptBlock {$ps = "*PowerShell*"}
Invoke-Command -Session $s -ScriptBlock {Get-WinEvent -LogName $ps}

ローカル変数の使用

リモートコマンドではローカル変数を使用できますが、ローカルセッションで変数を定義する必要があります。

PowerShell 3.0 以降では、スコープ修飾子を Using 使用して、リモートコマンドでローカル変数を識別できます。

構文 Using は次のとおりです。

$Using:<VariableName>

次の例では、 $ps 変数はローカルセッションで作成されますが、コマンドが実行されるセッションで使用されます。スコープ修飾子は Using 、ローカル変数として識別されます $ps 。

$ps = "*PowerShell*"
Invoke-Command -ComputerName S1 -ScriptBlock {
  Get-WinEvent -LogName $Using:ps
}

スコープ修飾子は UsingPSSession で使用できます。

$s = New-PSSession -ComputerName S1
$ps = "*PowerShell*"
Invoke-Command -Session $s -ScriptBlock {Get-WinEvent -LogName $Using:ps}

呼び出し元のコンテキストから変数の値に展開などの $using:var 変数 $var 参照。呼び出し元の変数オブジェクトにはアクセスできません。 Usingスコープ修飾子を使用して PSSession 内のローカル変数を変更することはできません。たとえば、次のコードは機能しません。

$s = New-PSSession -ComputerName S1
$ps = "*PowerShell*"
Invoke-Command -Session $s -ScriptBlock {$Using:ps = 'Cannot assign new value'}

詳細についてはUsing、「about_Scopes」を参照してください。

スプラッティングの使用

PowerShell のスプラッティングは、パラメーター名と値のコレクションをコマンドに渡します。詳細については、「 about_Splatting」を参照してください。

この例では、splatting 変数は、 $Splat ローカルコンピューターに設定されるハッシュテーブルです。 Invoke-Commandリモートコンピューターセッションに接続します。 ScriptBlock は、At (@) 記号を持つスコープ修飾子を使用Usingして、スプラッティングされた変数を表します。

$Splat = @{ Name = "Win*"; Include = "WinRM" }
Invoke-Command -Session $s -ScriptBlock { Get-Service @Using:Splat }

'Using' スコープ修飾子が必要なその他の状況

セッション外で実行されるスクリプトまたはコマンドの場合は、呼び出し元の Using セッションスコープから変数値を埋め込むためのスコープ修飾子が必要です。そのため、セッション外のコードからそれらにアクセスできます。 Usingスコープ修飾子は、次のコンテキストでサポートされています。

ComputerName、HostName、SSHConnection、またはセッション パラメーター (リモートセッション) の使用でInvoke-Command開始されたリモートで実行されたコマンド
バックグラウンドジョブ(プロセス外セッション) で Start-Job 開始
スレッドジョブ(別のスレッドセッションを介して Start-ThreadJob 開始)または ForEach-Object -Parallel (個別のスレッドセッション)

コンテキストに応じて、埋め込み変数の値は、呼び出し元のスコープ内のデータの独立したコピーであるか、それに対する参照です。リモートセッションとアウトプロセスセッションでは、常に独立したコピーです。スレッドセッションでは、参照渡しされます。

変数値のシリアル化

リモートで実行されたコマンドとバックグラウンドジョブは、アウトプロセスで実行されます。アウトプロセスセッションでは、XML ベースのシリアル化と逆シリアル化を使用して、プロセス境界を越えて変数の値を使用できるようにします。シリアル化プロセスは、元のオブジェクトプロパティを含むが、そのメソッドを含まない PSObject にオブジェクトを変換します。

型のセットが限られている場合、逆シリアル化によってオブジェクトが元の型に戻されます。リハイドレートされたオブジェクトは、元のオブジェクトインスタンスのコピーです。型のプロパティとメソッドがあります。 System.Version などの単純な型の場合、コピーは正確です。複合型の場合、コピーは不完全です。たとえば、リハイドレートされた証明書オブジェクトには秘密キーは含まれません。

他のすべての型のインスタンスは PSObject インスタンスです。 PSTypeNames プロパティには、逆シリアル化された元の型名 (Deserialized.System.Data.DataTable など) が含まれています

ArgumentList パラメーターでのローカル変数の使用

リモートコマンドのパラメーターを定義し、コマンドレットの ArgumentList パラメーターを使用してローカル変数をパラメーター Invoke-Command 値として指定することで、リモートコマンドでローカル変数を使用できます。

このキーワードを param 使用して、リモートコマンドのパラメーターを定義します。パラメーター名は、ローカル変数の名前と一致する必要のないプレースホルダーです。
コマンド内のキーワードによって定義された param パラメーターを使用します。
コマンドレットの ArgumentList パラメーターを Invoke-Command 使用して、パラメーター値としてローカル変数を指定します。

たとえば、次のコマンドは、ローカルセッションで変数を定義 $ps し、リモートコマンドで使用します。このコマンドは、パラメーター名とローカル変数として、$psその値として使用$logします。

$ps = "*PowerShell*"
Invoke-Command -ComputerName S1 -ScriptBlock {
  param($log)
  Get-WinEvent -LogName $log
} -ArgumentList $ps