Enter-PSSession
リモート コンピューターとの対話型セッションを開始します。
構文
Enter-PSSession
[-ComputerName] <String>
[-EnableNetworkAccess]
[-Credential <PSCredential>]
[-ConfigurationName <String>]
[-Port <Int32>]
[-UseSSL]
[-ApplicationName <String>]
[-SessionOption <PSSessionOption>]
[-Authentication <AuthenticationMechanism>]
[-CertificateThumbprint <String>]
[<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 コマンドレットを使用して、対話型セッションから切断したり、対話型セッションに再接続したりすることはできません。
対話型セッションを終了し、リモート コンピューターから切断するには、 Exit-PSSession コマンドレットを使用するか、「 exit」と入力します。
重要
Enter-PSSession は、現在の対話型セッションを新しい対話型リモート セッションに置き換えるために設計されています。 関数またはスクリプト内から呼び出したり、 powershell.exe 実行可能ファイルにコマンドとして渡したりしないでください。
例
例 1: 対話型セッションを開始する
PS C:\> Enter-PSSession
[localhost]: PS C:\>このコマンドは、ローカル コンピューターで対話型セッションを開始します。 コマンド プロンプトが変更され、現在、別のセッションでコマンドを実行していることを示します。
入力したコマンドは新しいセッションで実行され、結果がテキストとして既定のセッションに返されます。
例 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 は同じ効果を持ちます。
パラメーター
-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。
セッションのセッション構成は、リモート コンピューター上にあります。 指定したセッション構成がリモート コンピューターに存在しない場合、コマンドは失敗します。
既定値は、ローカル コンピューターの $PSSessionConfigurationName 基本設定変数の値です。 この基本設定変数が設定されていない場合、既定値は Microsoft.PowerShell です。 詳細については、「 about_Preference_Variables」を参照してください。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | 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 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | 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 |
-Name
既存のセッションのフレンドリ名を指定します。 Enter-PSSession は、指定されたセッションを対話型セッションに使用します。
指定した名前が複数のセッションと一致する場合、コマンドは失敗します。 Session、InstanceID、または ID パラメーターを使用して、既存のセッションを指定することもできます。 または、 ComputerName パラメーターを使用して、一時セッションを開始できます。
セッションのフレンドリ名を確立するには、New-PSSession コマンドレットの Name パラメーターを使用します。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Port
このコマンドに使用するリモート コンピューター上のネットワーク ポートを指定します。 リモート コンピューターに接続するには、リモート コンピューターで、接続に使用されるポートをリッスンすることが必要です。 既定のポートは、HTTP の WinRM ポートである 5985 と、HTTPS の WinRM ポートである 5986 です。
代替ポートを使用する前に、そのポートでリッスンするようにリモート コンピューター上の WinRM リスナーを構成する必要があります。 リスナーを構成するには、次のコマンドを使用します。
winrm delete winrm/config/listener?Address=*+Transport=HTTPwinrm create winrm/config/listener?Address=*+Transport=HTTP @{Port="\<port-number\>"}
必要な場合を除き、 Port パラメーターは使用しないでください。 コマンドのポート設定は、コマンドが実行されるすべてのコンピューターまたはセッションに適用されます。 代替ポートの設定によっては、コマンドがすべてのコンピューターで実行されない場合があります。
| 型: | 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 |
-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 |
入力
コンピューター名を文字列としてこのコマンドレットにパイプできます。
セッション オブジェクトをこのコマンドレットにパイプできます。
出力
None
このコマンドレットは、出力を返しません。
メモ
Windows 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 キーを押します。
関連リンク
PowerShell