Enter-PSSession

構文

ComputerName (既定)

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

Session

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

Uri

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

InstanceId

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

Id

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

Name

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

VMId

Enter-PSSession
    [-VMGuid] <Guid>
    -Credential <PSCredential>
    [<CommonParameters>]

VMName

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

説明

例

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

PS C:\> Enter-PSSession
[localhost]: PS C:\>

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

The first command uses the **Enter-PSSession** cmdlet to start an interactive session with Server01, a remote computer. When the session starts, the command prompt changes to include the computer name.
PS C:\> Enter-PSSession -ComputerName Server01
[Server01]: PS C:\>

The second command gets the Windows PowerShell process and redirects the output to the Process.txt file. The command is submitted to the remote computer, and the file is saved on the remote computer.
[Server01]: PS C:\> Get-Process PowerShell > C:\ps-test\Process.txt

The third command uses the **Exit** keyword to end the interactive session and close the connection.
[Server01]: PS C:\> exit
PS C:\>

The fourth command confirms that the Process.txt file is on the remote computer. A **Get-ChildItem** ("dir") command on the local computer cannot find the file.
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 C:\> $s = New-PSSession -ComputerName Server01
PS C:\> Enter-PSSession -Session $s
[Server01]: PS C:\>

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

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

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

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

パラメーター

-AllowRedirection

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

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

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

パラメーターのプロパティ

パラメーター セット

-ApplicationName

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

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

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

パラメーターのプロパティ

パラメーター セット

-Authentication

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

• 既定値
• Basic
• Credssp
• ダイジェスト
• Kerberos
• 交渉する
• NegotiateWithImplicitCredential（インプリシットクレデンシャルで交渉する）

既定値は Default です。

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

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

注意: Credential Security Support Provider (CredSSP) 認証は、ユーザーの資格情報が認証されるリモート コンピュータに渡され、リモート ネットワーク共有へのアクセスなど、複数のリソースで認証を必要とするコマンド用に設計されています。 このメカニズムにより、リモート操作のセキュリティ リスクが高まります。 リモート コンピューターが侵害された場合、それに渡される資格情報を使用してネットワーク セッションを制御できます。

パラメーターのプロパティ

パラメーター セット

-CertificateThumbprint

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

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

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

パラメーターのプロパティ

パラメーター セット

-ComputerName

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

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

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

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

パラメーターのプロパティ

パラメーター セット

-ConfigurationName

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

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

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

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

パラメーターのプロパティ

パラメーター セット

-ConnectionUri

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

<トランスポート>://<ComputerName>:<Port>/<ApplicationName>

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

https://localhost:5985/WSMAN

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

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

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

パラメーターのプロパティ

パラメーター セット

-Credential

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

ユーザー名 ( User01、 Domain01\User01、 User@Domain.com など) を入力するか、Get-Credential コマンドレットによって返されるオブジェクトなどの PSCredential オブジェクトを入力します。

ユーザー名を入力すると、このコマンドレットによってパスワードの入力が求められます。

パラメーターのプロパティ

パラメーター セット

-EnableNetworkAccess

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

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

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

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

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

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

パラメーターのプロパティ

パラメーター セット

-Id

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

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

パラメーターのプロパティ

パラメーター セット

-InstanceId

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

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

パラメーターのプロパティ

パラメーター セット

-Name

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

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

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

パラメーターのプロパティ

パラメーター セット

-Port

このコマンドに使用するリモート コンピューター上のネットワーク ポートを指定します。 リモートコンピューターに接続するには、接続に使用するポートでリモートコンピューターが待機している必要があります。 既定のポートは、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 パラメーターは使用しないでください。 コマンドのポート設定は、コマンドを実行するすべてのコンピューターまたはセッションに適用されます。 代替ポート設定により、コマンドがすべてのコンピューターで実行できなくなる可能性があります。

パラメーターのプロパティ

パラメーター セット

-Session

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

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

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

パラメーターのプロパティ

パラメーター セット

-SessionOption

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

オプションのデフォルト値は、$PSSessionOption preference 変数が設定されている場合、その値によって決まります。 それ以外の場合、既定値はセッション構成で設定されたオプションによって確立されます。

セッション・オプションの値は、$PSSessionOption プリファレンス変数およびセッション構成で設定されたセッションのデフォルト値よりも優先されます。 ただし、セッション構成で設定された最大値、クォータ、または制限よりも優先されません。

既定値を含むセッション オプションの説明については、「 New-PSSessionOption」を参照してください。 $PSSessionOption プリファレンス変数の詳細については、 about_Preference_Variablesを参照してください。 セッション構成の詳細については、「about_Session_Configurations」を参照してください。

パラメーターのプロパティ

パラメーター セット

-UseSSL

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

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

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

パラメーターのプロパティ

パラメーター セット

-VMGuid

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

パラメーターのプロパティ

パラメーター セット

-VMName

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

パラメーターのプロパティ

パラメーター セット

CommonParameters

入力

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

出力

None

メモ

関連リンク

• Exit-PSSession
• Get-PSSession
• Invoke-Command
• New-PSSession
• Remove-PSSession
• Connect-PSSession
• Disconnect-PSSession
• Receive-PSSession
• PSSessionsについて
• about_Remote に関するページ