Enter-PSSession

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

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

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

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

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

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

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

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

既定値は Default です。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

セッションの接続エンドポイントを定義する 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 はリダイレクトを禁止します。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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