次の方法で共有

New-PSSession

  • リファレンス
モジュール:
Microsoft.PowerShell.Core

ローカル コンピューターまたはリモート コンピューターへの永続的な接続を作成します。

構文

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
   -UseWindowsPowerShell
   [-Name <string[]>]
   [<CommonParameters>]
New-PSSession
   [-Name <String[]>]
   [-Port <Int32>]
   [-HostName] <String[]>
   [-UserName <String>]
   [-KeyFilePath <String>]
   [-SSHTransport]
   [-Subsystem <String>]
   [<CommonParameters>]
New-PSSession
   [-Name <String[]>]
   -SSHConnection <Hashtable[]>
   [<CommonParameters>]

説明

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

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

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

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

注意

サーバー証明書が信頼されていない HTTPS エンドポイント (自己署名証明書など) で Linux または macOS クライアントから WSMan リモート処理を使用する場合。 接続を正常に確立するには、 に設定$trueされた SkipCACheck 値と SkipCNCheck 値を含む PSSessionOption を指定する必要があります。 これは、サーバー証明書とターゲット システムへのネットワーク接続を特定できる環境にある場合にのみ行います。

例

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

$s = New-PSSession

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

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

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

$Server01 = New-PSSession -ComputerName Server01

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

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

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

$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: 指定したポートを使用してセッションをCreateする

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

$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 オブジェクトでバックグラウンド ジョブを実行します。

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

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

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

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

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

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

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

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

$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 パラメーターの値は、 変数の $soSessionOption オブジェクトです。

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

New-PSSession -HostName UserA@LinuxServer01

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

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

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

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

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

$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 が構成されている必要があることに注意してください。

パラメーター

-AllowRedirection

このコマンドレットによって、代替の Uniform Resource Identifier (URI) へのこの接続のリダイレクトが許可されることを示します。

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

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

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

-Authentication

ユーザーの資格情報の認証に使用するメカニズムを指定します。 このパラメーターの有効値は、次のとおりです。

  • Default
  • Basic
  • Credssp
  • Digest
  • Kerberos
  • Negotiate
  • NegotiateWithImplicitCredential

既定値は Default です。

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

注意事項

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

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

-CertificateThumbprint

この処理を実行するアクセス許可を持つユーザー アカウントのデジタル公開キー証明書 (X509) を指定します。 証明書の拇印を入力します。

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

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

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

-ComputerName

コンピューターの名前の配列を指定します。 このコマンドレットは、指定されたコンピューターへの永続的な接続 (PSSession) を作成します。 複数のコンピューター名を入力する場合は、 New-PSSession コンピューターごとに 1 つずつ、複数 の PSSession オブジェクトを作成します。 既定値はローカル コンピューターです。

1 台または複数のリモート コンピューターの NetBIOS 名、IP アドレス、または完全修飾ドメイン名を入力します。 ローカル コンピューターを指定するには、コンピューター名、、 localhostまたはドット (.) を入力します。 コンピューターがユーザーとは異なるドメインにある場合は、完全修飾ドメイン名が必要です。 コンピューター名を引用符で囲んで に New-PSSessionパイプすることもできます。

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

ComputerName パラメーターの値にローカル コンピューターを含めるには、[管理者として実行] オプションを使用してWindows PowerShellを開始します。

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

-ConfigurationName

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

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

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

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

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

-ConnectionUri

セッションの接続エンドポイントを定義する URI を指定します。 URI は完全修飾名にする必要があります。 この文字列の形式は次のとおりです。

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

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

http://localhost:5985/WSMAN

ConnectionURI を指定しなかった場合は、UseSSL、ComputerName、Port、および ApplicationName パラメーターを使用して、ConnectionURI 値を指定できます。

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

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

Type:Uri[]
Aliases:URI, CU
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ContainerId

コンテナーの ID の配列を指定します。 このコマンドレットは、指定された各コンテナーとの対話型セッションを開始します。 コマンドを docker ps 使用して、コンテナー ID の一覧を取得します。 詳細については、 docker ps コマンドのヘルプを参照してください。

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

-Credential

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

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

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

注意

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 を 使用すると、コマンドは成功しますが、 パラメーターは無視されます。

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

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

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

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

-HostName

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

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

Type:String[]
Position:0
Default value:None
Required:True
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

-Name

PSSession のフレンドリ名を指定します。

や などのGet-PSSessionEnter-PSSession他のコマンドレットを使用する場合は、名前を使用して PSSession を参照できます。 名前は、コンピューターや現在のセッションで一意である必要ありません。

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

-Port

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

別のポートを使用する前に、そのポートでリッスンするようにリモート コンピューターで WinRM リスナーを構成する必要があります。 リスナーを構成するには、次のコマンドを使用します。

  1. winrm delete winrm/config/listener?Address=*+Transport=HTTP
  2. winrm create winrm/config/listener?Address=*+Transport=HTTP @{Port="\<port-number\>"}

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

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

-RunAsAdministrator

PSSession が管理者として実行されることを示します。

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

-Session

このコマンドレットが新しい PSSession のモデルとして使用する PSSession オブジェクトの配列を指定します。 このパラメーターは、指定された PSSession オブジェクトと同じプロパティを持つ新しい PSSession オブジェクトを 作成します。

PSSession オブジェクトを含む変数、または PSSession オブジェクトを作成または取得するコマンド (または Get-PSSession コマンドなど) をNew-PSSession入力します。

結果として得られる PSSession オブジェクトのコンピューター名、アプリケーション名、接続 URI、ポート、構成名、スロットル制限、Secure Sockets Layer (SSL) の値は元のオブジェクトと同じですが、表示名、ID、インスタンス ID (GUID) は異なります。

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

-SessionOption

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

オプションの既定値は、設定されている場合は、基本設定変数の $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 つ以上の接続パラメーター (HostName、 Port、 UserName、 KeyFilePath) が含まれています。

ハッシュテーブル接続パラメーターは、 SSHHost パラメーター セットに対して定義されているのと同じです。

SSHConnection パラメーターは、各セッションで異なる接続情報が必要な複数のセッションを作成する場合に便利です。

このパラメーターは、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 ベースのリモート接続を確立するために HostName パラメーター セットを使用するように PowerShell に強制します。

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

Type:SwitchParameter
Accepted values:true
Position:Named
Default value:None
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:True
Accept wildcard characters:False

-ThrottleLimit

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

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

Type:Int32
Position:Named
Default value:None
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

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

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

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

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

-UseWindowsPowerShell

ローカル システム上の新しいWindows PowerShell実行空間へのリモート接続を作成します。

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

-VMId

仮想マシン ID の配列を指定します。 このコマンドレットは、指定された各仮想マシンとの対話型セッションを開始します。 使用可能な仮想マシンを表示するには、次のコマンドを使用します。

Get-VM | Select-Object -Property Name, ID

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

-VMName

仮想マシンの名前の配列を指定します。 このコマンドレットは、指定された各仮想マシンとの対話型セッションを開始します。 使用可能な仮想マシンを表示するには、 コマンドレットを Get-VM 使用します。

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

入力

System.String, System.URI, System.Management.Automation.Runspaces.PSSession

文字列、URI、またはセッション オブジェクトをこのコマンドレットにパイプできます。

出力

PSSession

メモ

  • このコマンドレットでは、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 リモート処理を設定する方法の詳細については、「 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>

ファイルの詳細 ssh_config については、「 ssh_config(5)」を参照してください。