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>]
   [-ConnectingTimeout <int>]
   [<CommonParameters>]

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

説明

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

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

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

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

Note

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

例

例 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 プロトコルを使用する新しい PSSession を Server01 コンピューターに作成します。新しい PSSession では、という E12代替セッション構成が使用されます。

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

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

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

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

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

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

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

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

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

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

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

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

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

このコマンドは、 ファイルにリストされている 200 台の各コンピューターに PSSession を Servers.txt 作成し、結果 の 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 オブジェクトでバックグラウンドジョブを実行します。

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

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

2 番目のコマンドは、コマンドレットの AsJob パラメーターをInvoke-Command使用して、Get-Process PowerShell.$s.

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

パラメーター

-AllowRedirection

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

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

MaximumConnectionRedirectionCount セッションオプションの値を変更することで、接続がリダイレクトされる回数を制限することもできます。コマンドレットの MaximumRedirection パラメーターをNew-PSSessionOption使用するか、$PSSessionOption基本設定変数の MaximumConnectionRedirectionCount プロパティを設定します。既定値は 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:	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-Item or Get-ChildItem コマンドを使用します。

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の「信頼できるホストの一覧にコンピューターを追加する方法」を参照してください。

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

-ConnectingTimeout

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

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

Type:	Int32
Position:	Named
Default value:	unlimited
Required:	False
Accept pipeline input:	False
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 を指定したが、ポートを指定しない場合、セッションは標準ポート 80 (HTTP 用と 443 HTTPS 用) で作成されます。 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

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

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

資格情報は 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

-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 のフレンドリ名を 指定します。

他のコマンドレットを使用する場合は、Enter-PSSessionGet-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 リスナーを構成する必要があります。リスナーを構成するには、次のコマンドを使用します。

winrm delete winrm/config/listener?Address=*+Transport=HTTP
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:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Session

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

PSSession オブジェクトを含む変数、または PSSession オブジェクト (コマンドなど) を作成または取得するコマンドをNew-PSSessionGet-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) 接続 (HostName、Port、UserName、KeyFilePath) を確立するために必要な 1 つ以上の接続パラメーターが含まれています。

ハッシュテーブル接続パラメーターは、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 ベースのリモート接続を確立するために、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:	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:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UseWindowsPowerShell

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

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

-VMId

仮想マシン ID の配列を指定します。このコマンドレットは、指定された各仮想マシンとの PowerShell Direct 対話型セッションを開始します。詳細については、「PowerShell を使用した仮想マシンの自動化と管理」を参照してください。

Hyper-V ホストで使用可能な仮想マシンを表示するために使用 Get-VM します。

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

-VMName

仮想マシンの名前の配列を指定します。このコマンドレットは、指定された各仮想マシンとの PowerShell Direct 対話型セッションを開始します。詳細については、「PowerShell を使用した仮想マシンの自動化と管理」を参照してください。

Hyper-V ホストで使用可能な仮想マシンを表示するために使用 Get-VM します。

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

入力

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 リモート処理を設定する方法の詳細については、「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>`

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

New-PSSession

構文

説明

例

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

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

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

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

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

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

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

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

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

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

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

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

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

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

パラメーター

-AllowRedirection

-ApplicationName

-Authentication

-CertificateThumbprint

-ComputerName

-ConfigurationName

-ConnectingTimeout

-ConnectionUri

-ContainerId

-Credential

-EnableNetworkAccess

-HostName

-KeyFilePath

-Name

-Port

-RunAsAdministrator

-Session

-SessionOption

-SSHConnection

-SSHTransport

-Subsystem

-ThrottleLimit

-UserName

-UseSSL

-UseWindowsPowerShell

-VMId

-VMName

入力

出力

メモ

関連リンク

フィードバック

その他のリソース

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

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

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

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

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