Enter-PSSession

リファレンス

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

リモートコンピューターとの対話型セッションを開始します。

構文

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

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

Enter-PSSession
     [[-Session] <PSSession>]
     [<CommonParameters>]

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

Enter-PSSession
     [-InstanceId <Guid>]
     [<CommonParameters>]

Enter-PSSession
     [[-Id] <Int32>]
     [<CommonParameters>]

Enter-PSSession
     [-Name <String>]
     [<CommonParameters>]

Enter-PSSession
     [-VMId] <Guid>
     [-Credential] <PSCredential>
     [-ConfigurationName <String>]
     [<CommonParameters>]

Enter-PSSession
     [-VMName] <String>
     [-Credential] <PSCredential>
     [-ConfigurationName <String>]
     [<CommonParameters>]

Enter-PSSession
     [-ContainerId] <String>
     [-ConfigurationName <String>]
     [-RunAsAdministrator]
     [<CommonParameters>]

説明

Enter-PSSession コマンドレットは、1 台のリモートコンピューターとの対話型セッションを開始します。セッション中、入力したコマンドは、リモートコンピューターで直接入力する場合と同様に、リモートコンピューターで実行されます。一度に 1 つのみの対話型セッションを確立できます。

通常、 ComputerName パラメーターを使用して、リモートコンピューターの名前を指定します。ただし、対話型セッションの New-PSSession コマンドレットを使用して作成したセッションを使用することもできます。ただし、 Disconnect-PSSession、 Connect-PSSession、または Receive-PSSession コマンドレットを使用して、対話型セッションから切断したり、対話型セッションに再接続したりすることはできません。

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

対話型セッションを終了し、リモートコンピューターから切断するには、 Exit-PSSession コマンドレットを使用するか、「 exit」と入力します。

重要

Enter-PSSession は、現在の対話型セッションを新しい対話型リモートセッションに置き換えるために設計されています。関数またはスクリプト内から呼び出したり、 pwsh 実行可能ファイルにコマンドとして渡したりしないでください。

例

例 1: 対話型セッションを開始する

PS> Enter-PSSession
[localhost]: PS>

このコマンドは、ローカルコンピューターで対話型セッションを開始します。コマンドプロンプトが変更され、現在、別のセッションでコマンドを実行していることを示します。

入力したコマンドは新しいセッションで実行され、結果がテキストとして既定のセッションに返されます。

例 2: 対話型セッションを操作する

最初のコマンドでは、 Enter-PSSession コマンドレットを使用して、リモートコンピューターである Server01 との対話型セッションを開始します。セッションが開始されると、コマンドプロンプトがコンピューター名を含むように変更されます。

2 番目のコマンドは PowerShell プロセスを取得し、出力を Process.txt ファイルにリダイレクトします。コマンドはリモートコンピューターに送信され、ファイルはリモートコンピューターに保存されます。

3 番目のコマンドでは、 Exit キーワードを使用して対話型セッションを終了し、接続を閉じます。 4 番目のコマンドは、Process.txt ファイルがリモートコンピューター上にあることを確認します。ローカルコンピューター上の Get-ChildItem ("dir") コマンドでファイルが見つかりません。

PS C:\> Enter-PSSession -ComputerName Server01
[Server01]: PS C:\>
[Server01]: PS C:\> Get-Process PowerShell > C:\ps-test\Process.txt
[Server01]: PS C:\> exit
PS C:\>
PS C:\> dir C:\ps-test\Process.txt
Get-ChildItem : Cannot find path 'C:\ps-test\Process.txt' because it does not exist.
At line:1 char:4
+ dir <<<<  c:\ps-test\Process.txt

このコマンドは、リモートコンピューターとの対話型セッションで作業する方法を示します。

例 3: Session パラメーターを使用する

PS> $s = New-PSSession -ComputerName Server01
PS> Enter-PSSession -Session $s
[Server01]: PS>

これらのコマンドでは、Enter-PSSessionの Session パラメーターを使用して、既存の PowerShell セッション (PSSession) で対話型セッションを実行します。

例 4: 対話型セッションを開始し、ポートと資格情報のパラメーターを指定する

PS> Enter-PSSession -ComputerName Server01 -Port 90 -Credential Domain01\User01
[Server01]: PS>

このコマンドは、Server01 コンピューターとの対話型セッションを開始します。 Port パラメーターを使用して、ポートと Credential パラメーターを指定して、リモートコンピューターに接続するアクセス許可を持つユーザーのアカウントを指定します。

例 5: 対話型セッションを停止する

PS> Enter-PSSession -ComputerName Server01
[Server01]: PS> Exit-PSSession
PS>

この例は、対話型セッションを開始および停止する方法を示しています。最初のコマンドでは、 Enter-PSSession コマンドレットを使用して、Server01 コンピューターとの対話型セッションを開始します。

2 番目のコマンドでは、 Exit-PSSession コマンドレットを使用してセッションを終了します。 Exit キーワードを使用して対話型セッションを終了することもできます。 Exit-PSSession と Exit は同じ効果を持ちます。

例 6: SSH を使用して対話型セッションを開始する

PS> Enter-PSSession -HostName UserA@LinuxServer01

この例では、Secure Shell (SSH) を使用して対話型セッションを開始する方法を示します。リモートコンピューターでパスワードを使用するように SSH が構成されている場合は、パスワードの入力を求められます。それ以外の場合は、キーベースのユーザー認証を使用する必要があります。

例 7: ポートとユーザー認証キーを使用して SSH を使用して対話型セッションを開始する

PS> Enter-PSSession -HostName UserA@LinuxServer02:22 -KeyFilePath c:\sshkeys\userAKey_rsa

この例では、SSH を使用して対話型セッションを開始する方法を示します。ユーザー名と SSH ポート番号は、 HostName パラメーターの値の一部として指定されます。 KeyFilePath パラメーターは、リモートコンピューターでユーザーを認証するために使用される RSA キーの場所を指定します。

例 8: SSH オプションを使用して対話型セッションを開始する

$options = @{
    Port=22
    User = 'UserA'
    Host = 'LinuxServer02'
}
Enter-PSSession -KeyFilePath c:\sshkeys\userAKey_rsa -Options $options

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

パラメーター

-AllowRedirection

この接続を代替 Uniform Resource Identifier (URI) にリダイレクトできます。既定では、リダイレクトは許可されません。

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

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

型:	SwitchParameter
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ApplicationName

接続 URI のアプリケーション名セグメントを指定します。コマンドで ConnectionURI パラメーターを使用していない場合は、このパラメーターを使用してアプリケーション名を指定します。

既定値は、ローカルコンピューターの $PSSessionApplicationName 基本設定変数の値です。この基本設定変数が定義されていない場合、既定値は WSMAN です。この値はほとんどの用途に適しています。詳細については、「 about_Preference_Variables」を参照してください。

WinRM サービスは、アプリケーション名を使用して、接続要求をサービスするリスナーを選択します。このパラメーターの値は、リモートコンピューター上のリスナーの URLPrefix プロパティの値と一致する必要があります。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Authentication

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

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

既定値は Default です。

CredSSP 認証は、Windows Vista、Windows Server 2008、およびそれ以降のバージョンの Windows オペレーティングシステムでのみ使用できます。

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

注意事項

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

型:	AuthenticationMechanism
指定可能な値:	Default, Basic, Negotiate, NegotiateWithImplicitCredential, Credssp, Digest, Kerberos
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-CertificateThumbprint

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

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

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

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ComputerName

コンピューター名を指定します。このコマンドレットは、指定されたリモートコンピューターとの対話型セッションを開始します。コンピューター名を1 つだけ入力します。既定値はローカルコンピューターです。

コンピューターの NetBIOS 名、IP アドレス、または完全修飾ドメイン名を入力します。コンピューター名をパイプして Enter-PSSessionすることもできます。

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

Note

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

型:	String
Aliases:	Cn
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ConfigurationName

対話型セッションに使用されるセッション構成を指定します。

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

SSH で使用する場合、これは、sshd_configで定義されているターゲットで使用するサブシステムを指定します。 SSH の既定値は、 powershell サブシステムです。

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

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

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ConnectingTimeout

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

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

型:	Int32
配置:	Named
規定値:	unlimited
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ConnectionUri

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

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

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

http://localhost:5985/WSMAN

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

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

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

型:	Uri
Aliases:	URI, CU
配置:	1
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ContainerId

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

型:	String
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Credential

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

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

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

Note

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

型:	PSCredential
配置:	1
規定値:	Current user
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-EnableNetworkAccess

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

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

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

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

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

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

型:	SwitchParameter
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-HostName

Secure Shell (SSH) ベースの接続のコンピューター名を指定します。これは ComputerName パラメーターに似ていますが、リモートコンピューターへの接続は Windows WinRM ではなく SSH を使用して行われます。このパラメーターでは、フォーム user@hostname:portを使用して、ホスト名パラメーター値の一部としてユーザー名またはポートを指定できます。ホスト名の一部として指定されたユーザー名またはポートは、 -UserName パラメーターと -Port パラメーター (指定されている場合) よりも優先されます。これにより、複数のコンピューター名をこのパラメーターに渡すことができます。一部のコンピューター名には特定のユーザー名やポートがあり、他のコンピューター名やポートは -UserName パラメーターと -Port パラメーターから使用されます。

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

型:	String
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Id

既存のセッションの ID を指定します。 Enter-PSSession は、指定されたセッションを対話型セッションに使用します。

セッションの ID を検索するには、 Get-PSSession コマンドレットを使用します。

型:	Int32
配置:	0
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-InstanceId

既存のセッションのインスタンス ID を指定します。 Enter-PSSession は、指定されたセッションを対話型セッションに使用します。

インスタンス ID は GUID です。セッションのインスタンス ID を検索するには、 Get-PSSession コマンドレットを使用します。 Session、Name、または ID パラメーターを使用して、既存のセッションを指定することもできます。または、 ComputerName パラメーターを使用して、一時セッションを開始できます。

型:	Guid
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-KeyFilePath

リモートコンピューターでユーザーを認証するために Secure Shell (SSH) によって使用されるキーファイルパスを指定します。

SSH を使用すると、基本パスワード認証の代わりに、秘密キーまたは公開キーを使用してユーザー認証を実行できます。リモートコンピューターがキー認証用に構成されている場合、このパラメーターを使用して、ユーザーを識別するキーを指定できます。

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

型:	String
Aliases:	IdentityFilePath
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Name

既存のセッションのフレンドリ名を指定します。 Enter-PSSession は、指定されたセッションを対話型セッションに使用します。

指定した名前が複数のセッションと一致する場合、コマンドは失敗します。 Session、InstanceID、または ID パラメーターを使用して、既存のセッションを指定することもできます。または、 ComputerName パラメーターを使用して、一時セッションを開始できます。

セッションのフレンドリ名を確立するには、New-PSSession コマンドレットの Name パラメーターを使用します。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Options

リモート SSH ベースのセッションに接続するときに使用される SSH オプションのハッシュテーブルを指定します。使用可能なオプションは、unix ベースのバージョンの ssh コマンドでサポートされている任意の値です。

パラメーターによって明示的に渡された値は、 Options ハッシュテーブルで渡された値よりも優先されます。たとえば、Port パラメーターを使用すると、Options ハッシュテーブルで渡されたPortキーと値のペアがオーバーライドされます。

型:	Hashtable
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Port

このコマンドに使用するリモートコンピューター上のネットワークポートを指定します。

PowerShell 6.0 では、このパラメーターは、Secure Shell (SSH) 接続をサポートする HostName パラメーターセットに含まれていました。

WinRM (ComputerName パラメーターセット)

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

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

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

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

SSH (HostName パラメーターセット)

リモートコンピューターに接続するには、リモートコンピューターを SSH サービス (SSHD) で構成し、接続で使用するポートをリッスンしている必要があります。 SSH の既定のポートは 22 です。

型:	Int32
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-RunAsAdministrator

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

型:	SwitchParameter
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Session

対話型セッションに使用する PowerShell セッション (PSSession) を指定します。このパラメーターは、セッションオブジェクトを受け取ります。 Name、InstanceID、または ID パラメーターを使用して、PSSessionを指定することもできます。

セッションオブジェクトを含む変数、またはセッションオブジェクトを作成または取得するコマンド ( New-PSSession 、 Get-PSSession コマンドなど) を入力します。セッションオブジェクトをパイプ処理して Enter-PSSessionすることもできます。このパラメーターを使用して送信できる PSSession は 1 つだけです。複数の PSSessionを含む変数を入力すると、コマンドは失敗します。

Exit-PSSessionまたは EXIT キーワードを使用すると、対話型セッションは終了しますが、作成した PSSession は開いたままで使用できます。

型:	PSSession
配置:	0
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-SessionOption

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

オプションの既定値は、設定されている場合、 $PSSessionOption 基本設定変数の値によって決まります。それ以外の場合、既定値はセッション構成で設定されたオプションによって決まります。

セッションオプションの値は、 $PSSessionOption 基本設定変数およびセッション構成で設定されたセッションの既定値よりも優先されます。ただし、セッション構成で設定された最大値、クォータ、または制限よりも優先されません。

デフォルト値を含むセッション・オプションの説明については、 New-PSSessionOptionを参照してください。 $PSSessionOption基本設定変数の詳細については、about_Preference_Variablesを参照してください。セッション構成の詳細については、「 about_Session_Configurations」を参照してください。

型:	PSSessionOption
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-SSHTransport

Secure Shell (SSH) を使用してリモート接続が確立されていることを示します。

既定では、PowerShell は Windows WinRM を使用してリモートコンピューターに接続します。このスイッチは、SSH ベースのリモート接続を確立するために、PowerShell で HostName パラメーターセットを使用するように強制します。

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

型:	SwitchParameter
指定可能な値:	true
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Subsystem

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

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

このパラメーターを使用しない場合、既定値は powershell サブシステムです。

型:	String
配置:	Named
規定値:	Powershell
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-UserName

リモートコンピューターでセッションを作成するために使用するアカウントのユーザー名を指定します。ユーザー認証方法は、リモートコンピューターでの Secure Shell (SSH) の構成方法によって異なります。

SSH が基本パスワード認証用に構成されている場合は、ユーザーパスワードの入力を求められます。

キーベースのユーザー認証用に SSH が構成されている場合、パスワードの入力を求められません。 SSH キーファイルへのパスを指定する必要があります。ユーザーキーファイルが SSH の既知の場所にある場合、 KeyFilePath パラメーターは必要ありません。ユーザー認証は、ユーザー名に基づいて自動的に行われます。詳細については、キーベースのユーザー認証に関する SSH ドキュメントを参照してください。

UserName パラメーターが指定されていない場合は、現在ログオンしているユーザー名が使用されます。

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

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-UseSSL

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

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

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

型:	SwitchParameter
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-VMId

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

型:	Guid
Aliases:	VMGuid
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-VMName

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

型:	String
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

入力

String

コンピューター名を文字列としてこのコマンドレットにパイプできます。

PSSession

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

出力

None

このコマンドレットは、出力を返しません。

メモ

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

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

リモートコンピューターに接続するには、リモートコンピューターの Administrators グループのメンバーであることが必要です。ローカルコンピューターで対話型セッションを開始するには、 管理者として実行 オプションを使用して PowerShell を起動する必要があります。

Enter-PSSessionを使用すると、リモートコンピューター上のユーザープロファイルが対話型セッションに使用されます。 PowerShell モジュールを追加するコマンドやコマンドプロンプトを変更するコマンドなど、リモートユーザープロファイルのコマンドは、リモートプロンプトが表示される前に実行します。

Enter-PSSession は、対話型セッション用にローカルコンピューターの UI カルチャ設定を使用します。ローカル UI カルチャを検索するには、 $UICulture 自動変数を使用します。

Enter-PSSession には、 Get-Command、 Out-Default、および Exit-PSSession コマンドレットが必要です。これらのコマンドレットがリモートコンピューターのセッション構成に含まれていない場合、 Enter-PSSession コマンドは失敗します。

コマンドを解析してリモートコンピューターに送信する前に解釈する Invoke-Commandとは異なり、 Enter-PSSession はコマンドを解釈せずにリモートコンピューターに直接送信します。

入力するセッションがコマンドの処理中にビジー状態の場合は、PowerShell が Enter-PSSession コマンドに応答するまでに遅延が発生する可能性があります。セッションが使用可能になるとすぐに接続されます。 Enter-PSSession コマンドを取り消すには、CTRL+C キーを押します。

HostName パラメーターセットは、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」を参照してください。

PowerShell 7.1 より前では、SSH 経由のリモート処理は、次ホップのリモートセッションをサポートしていませんでした。この機能は、WinRM を使用したセッションに限定されていました。 PowerShell 7.1 を使用すると、任意の対話型リモートセッション内で Enter-PSSession と Enter-PSHostProcess が機能します。

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

次の方法で共有

Enter-PSSession

構文

説明

例

例 1: 対話型セッションを開始する

例 2: 対話型セッションを操作する

例 3: Session パラメーターを使用する

例 4: 対話型セッションを開始し、ポートと資格情報のパラメーターを指定する

例 5: 対話型セッションを停止する

例 6: SSH を使用して対話型セッションを開始する

例 7: ポートとユーザー認証キーを使用して SSH を使用して対話型セッションを開始する

例 8: SSH オプションを使用して対話型セッションを開始する

パラメーター

-AllowRedirection

-ApplicationName

-Authentication

-CertificateThumbprint

-ComputerName

-ConfigurationName

-ConnectingTimeout

-ConnectionUri

-ContainerId

-Credential

-EnableNetworkAccess

-HostName

-Id

-InstanceId

-KeyFilePath

-Name

-Options

-Port

-RunAsAdministrator

-Session

-SessionOption

-SSHTransport

-Subsystem

-UserName

-UseSSL

-VMId

-VMName

入力

出力

メモ

関連リンク

その他のリソース