New-PSSession

構文

New-PSSession
   [[-ComputerName] <String[]>]
   [-Credential <PSCredential>]
   [-Name <String[]>]
   [-EnableNetworkAccess]
   [-ConfigurationName <String>]
   [-Port <Int32>]
   [-UseSSL]
   [-ApplicationName <String>]
   [-ThrottleLimit <Int32>]
   [-SessionOption <PSSessionOption>]
   [-Authentication <AuthenticationMechanism>]
   [-CertificateThumbprint <String>]
   [<CommonParameters>]

New-PSSession
   [-Credential <PSCredential>]
   [-Name <String[]>]
   [-EnableNetworkAccess]
   [-ConfigurationName <String>]
   [-ThrottleLimit <Int32>]
   [-ConnectionUri] <Uri[]>
   [-AllowRedirection]
   [-SessionOption <PSSessionOption>]
   [-Authentication <AuthenticationMechanism>]
   [-CertificateThumbprint <String>]
   [<CommonParameters>]

New-PSSession
   -Credential <PSCredential>
   [-Name <String[]>]
   [-ConfigurationName <String>]
   [-VMId] <Guid[]>
   [-ThrottleLimit <Int32>]
   [<CommonParameters>]

New-PSSession
   -Credential <PSCredential>
   [-Name <String[]>]
   [-ConfigurationName <String>]
   -VMName <String[]>
   [-ThrottleLimit <Int32>]
   [<CommonParameters>]

New-PSSession
   [[-Session] <PSSession[]>]
   [-Name <String[]>]
   [-EnableNetworkAccess]
   [-ThrottleLimit <Int32>]
   [<CommonParameters>]

New-PSSession
   [-Name <String[]>]
   [-ConfigurationName <String>]
   -ContainerId <String[]>
   [-RunAsAdministrator]
   [-ThrottleLimit <Int32>]
   [<CommonParameters>]

New-PSSession
   [-Name <String[]>]
   [-UseWindowsPowerShell]
   [<CommonParameters>]

New-PSSession
   [-Name <String[]>]
   [-Port <Int32>]
   [-HostName] <String[]>
   [-UserName <String>]
   [-KeyFilePath <String>]
   [-Subsystem <String>]
   [-ConnectingTimeout <Int32>]
   [-SSHTransport]
   [-Options <Hashtable>]
   [<CommonParameters>]

New-PSSession
   [-Name <String[]>]
   -SSHConnection <Hashtable[]>
   [<CommonParameters>]

説明

New-PSSession コマンドレットは、ローカル コンピューターまたはリモート コンピューターに PowerShell セッション (PSSession) を作成します。 PSSessionを作成すると、PowerShell はリモート コンピューターへの永続的な接続を確立します。

PSSessionを使用して、関数や変数の値など、データを共有する複数のコマンドを実行します。 PSSession でコマンドを実行するには、Invoke-Command コマンドレットを使用します。 PSSession を使用してリモート コンピューターと直接対話するには、Enter-PSSession コマンドレットを使用します。 詳細については、 about_PSSessionsを参照してください。

Enter-PSSessionまたはInvoke-Commandの ComputerName パラメーターを使用してPSSessionを作成せずに、リモート コンピューターでコマンドを実行できます。 ComputerName パラメーターを使用すると、PowerShell によってコマンドに使用される一時的な接続が作成され、閉じられます。

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

例

例 1: ローカル コンピューターでセッションを作成する

$s = New-PSSession

このコマンドは,ローカル・コンピューターに新しい PSSession を作成し, PSSession を $s 変数に保管します。

この PSSession を使用して、ローカル コンピューターでコマンドを実行できるようになりました。

例 2: リモート コンピューターでセッションを作成する

$Server01 = New-PSSession -ComputerName Server01

このコマンドは、Server01 コンピューターに新しい PSSession を作成し、 $Server01 変数に保存します。

複数の PSSession オブジェクトを作成する場合は、有用な名前を持つ変数に割り当てます。 これは、後続のコマンドで PSSession オブジェクトを管理するのに役立ちます。

例 3: 複数のコンピューターでセッションを作成する

$s1, $s2, $s3 = New-PSSession -ComputerName Server01,Server02,Server03

このコマンドは、ComputerName パラメーターで指定された各コンピューターに 1 つずつ、3 つのPSSession オブジェクトを作成します。

このコマンドでは、代入演算子 (=) を使用して、新しい PSSession オブジェクトを変数 ( $s1、 $s2、 $s3) に割り当てます。 Server01 PSSession を $s1に割り当て、Server02 PSSession を $s2に、Server03 PSSession を $s3に割り当てます。

複数のオブジェクトを一連の変数に割り当てると、PowerShell は各オブジェクトを系列内の変数にそれぞれ割り当てます。 変数よりオブジェクトが多い場合、残りのすべてのオブジェクトが最後の変数に代入されます。 オブジェクトよりも多くの変数がある場合、残りの変数は空です ($null)。

例 4: 指定したポートを使用してセッションを作成する

New-PSSession -ComputerName Server01 -Port 8081 -UseSSL -ConfigurationName E12

このコマンドは、サーバー ポート 8081に接続し、SSL プロトコルを使用する Server01 コンピューターに新しいPSSessionを作成します。 新しい PSSession では、 E12と呼ばれる別のセッション構成が使用されます。

ポートを設定する前に、ポート 8081 でリッスンするように、リモートのコンピューター上で WinRM リスナーを構成する必要があります。 詳細については、 Port パラメーターの説明を参照してください。

例 5: 既存のセッションに基づいてセッションを作成する

New-PSSession -Session $s -Credential Domain01\User01

このコマンドは PSSession 既存の PSSessionと同じプロパティを使用して作成します。 このコマンド形式は、既存の PSSession のリソースが使い果たされ、需要の一部をオフロードするために新しい PSSession が必要な場合に使用できます。

このコマンドでは、New-PSSession の Session パラメーターを使用して、$s変数に保存されるPSSessionを指定します。 Domain1\Admin01 ユーザーの資格情報を使用してコマンドを完了します。

例 6: 別のドメインにグローバル スコープを持つセッションを作成する

$global:s = New-PSSession -ComputerName Server1.Domain44.Corpnet.Fabrikam.com -Credential Domain01\Admin01

この例では、別のドメインのコンピューターでグローバル スコープを持つ PSSession を作成する方法を示します。

既定では、コマンド ラインで作成された PSSession オブジェクトはローカル スコープで作成され、スクリプトで作成された PSSession オブジェクトにはスクリプト スコープがあります。

グローバル スコープを持つ PSSession を作成するには、新しい PSSessionを作成し グローバル スコープにキャストされる変数に PSSession を格納します。 この場合、 $s 変数はグローバル スコープにキャストされます。

このコマンドでは、 ComputerName パラメーターを使用してリモート コンピューターを指定します。 コンピューターがユーザー アカウントとは異なるドメインにあるため、コンピューターの完全な名前はユーザーの資格情報と共に指定されます。

例 7: 多くのコンピューターのセッションを作成する

$rs = Get-Content C:\Test\Servers.txt | New-PSSession -ThrottleLimit 50

このコマンドは、Servers.txt ファイルにリストされている 200 台の各コンピューターにPSSessionを作成し、結果のPSSessionを$rs変数に格納します。 PSSession オブジェクトには、50のスロットル制限があります。

このコマンドの形式は、コンピューターの名前がデータベース、スプレッドシート、テキスト ファイル、またはその他のテキストに変換できる形式に格納されている場合、使用することができます。

例 8: URI を使用してセッションを作成する

$s = New-PSSession -URI http://Server01:91/NewSession -Credential Domain01\User01

このコマンドは、Server01 コンピューターに PSSession を作成し、 $s 変数に格納します。 URI パラメーターを使用して、トランスポート プロトコル、リモート コンピューター、ポート、および代替セッション構成を指定します。 また、 Credential パラメーターを使用して、リモート コンピューターでセッションを作成するアクセス許可を持つユーザー アカウントを指定します。

例 9: 一連のセッションでバックグラウンド ジョブを実行する

$s = New-PSSession -ComputerName (Get-Content Servers.txt) -Credential Domain01\Admin01 -ThrottleLimit 16
Invoke-Command -Session $s -ScriptBlock {Get-Process PowerShell} -AsJob

これらのコマンドは、 PSSession オブジェクトのセットを作成し、各 PSSession オブジェクトでバックグラウンド ジョブを実行します。

最初のコマンドは、Servers.txt ファイルに一覧表示されている各コンピューターに新しい PSSession を作成します。 New-PSSession コマンドレットを使用して、PSSessionを作成します。 ComputerName パラメーターの値は、Get-Content コマンドレットを使用して、Servers.txt ファイルのコンピューター名の一覧を取得するコマンドです。

このコマンドは、 Credential パラメーターを使用して、ドメイン管理者のアクセス許可を持つ PSSession オブジェクトを作成し、 ThrottleLimit パラメーターを使用して、同時接続を 16 するようにコマンドを制限します。 このコマンドは、 PSSession オブジェクトを $s 変数に保存します。

2 番目のコマンドでは、Invoke-Command コマンドレットの AsJob パラメーターを使用して、$s の各 PSSession オブジェクトでGet-Process PowerShell コマンドを実行するバックグラウンド ジョブを開始します。

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

例 10: URI を使用してコンピューターのセッションを作成する

New-PSSession -ConnectionURI https://management.exchangelabs.com/Management

このコマンドは、コンピューター名ではなく URI で指定されたコンピューターに接続する PSSession オブジェクトを作成します。

例 11: セッション オプションを作成する

$so = New-PSSessionOption -SkipCACheck
New-PSSession -ConnectionUri https://management.exchangelabs.com/Management -SessionOption $so -Credential Server01\Admin01

この例では、セッション オプション オブジェクトを作成し、 SessionOption パラメーターを使用する方法を示します。

最初のコマンドでは、 New-PSSessionOption コマンドレットを使用してセッション オプションを作成します。 結果の SessionOption オブジェクトが $so 変数に保存されます。

2 番目のコマンドは、新しいセッションでこのオプションを使用します。 このコマンドでは、 New-PSSession コマンドレットを使用して新しいセッションを作成します。 SessionOption パラメーターの値は、$so変数のSessionOption オブジェクトです。

例 12: SSH を使用してセッションを作成する

New-PSSession -HostName UserA@LinuxServer01

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

例 13: SSH を使用してセッションを作成し、ポートとユーザー認証キーを指定する

New-PSSession -HostName UserA@LinuxServer01:22 -KeyFilePath c:\<path>\userAKey_rsa

この例では、Secure Shell (SSH) を使用して PSSession を作成する方法を示します。 Port パラメーターを使用して使用するポートを指定し、KeyFilePath パラメーターを使用して、リモート コンピューターでユーザーを識別および認証するために使用する RSA キーを指定します。

例 14: SSH を使用して複数のセッションを作成する

$sshConnections = @(
    @{
          HostName    = 'WinServer1'
          UserName    = 'domain\userA'
          KeyFilePath = 'c:\users\UserA\id_rsa'
    }
    @{
        HostName    = 'UserB@LinuxServer5'
        KeyFilePath = 'c:\UserB\<path>\id_rsa'
    }
)
New-PSSession -SSHConnection $sshConnections

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

例 15: SSH オプションを使用して新しいセッションを作成する

$options = @{
    Port=22
    User = 'UserB'
    Host = 'LinuxServer5'
}
New-PSSession -KeyFilePath '/Users/UserB/id_rsa' -Options $options

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

パラメーター

-AllowRedirection

-ApplicationName

-Authentication

-CertificateThumbprint

-ComputerName

-ConfigurationName

-ConnectingTimeout

-ConnectionUri

-ContainerId

-Credential

-EnableNetworkAccess

-HostName

-KeyFilePath

-Name

-Options

-Port

-RunAsAdministrator

-Session

-SessionOption

-SSHConnection

-SSHTransport

-Subsystem

-ThrottleLimit

-UserName

-UseSSL

-UseWindowsPowerShell

-VMId

-VMName

入力

String

このコマンドレットに文字列をパイプできます。

System.URI

このコマンドレットに URI をパイプできます。

PSSession

セッション オブジェクトをこのコマンドレットにパイプできます。

出力

PSSession

メモ

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

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

  • nsn

• このコマンドレットでは、PowerShell リモート処理インフラストラクチャを使用します。 このコマンドレットを使用するには、ローカル コンピューターとリモート コンピューターを PowerShell リモート処理用に構成する必要があります。 詳細については、「about_Remote_Requirements」を参照してください。

• ローカル コンピューターで PSSession を作成するには、 管理者として実行 オプションを使用して PowerShell を起動します。

• PSSession を終了したら、Remove-PSSession コマンドレットを使用してPSSession を削除しそのリソースを解放します。

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

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)」を参照してください。

関連リンク

• Connect-PSSession
• Disconnect-PSSession
• Enter-PSSession
• Exit-PSSession
• Get-PSSession
• Invoke-Command
• Receive-PSSession
• Remove-PSSession