Enter-PSSession
使用遠端電腦啟動互動式會話。
語法
Enter-PSSession
[-ComputerName] <String>
[-EnableNetworkAccess]
[-Credential <PSCredential>]
[-Port <Int32>]
[-UseSSL]
[-ConfigurationName <String>]
[-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
[-VMGuid] <Guid>
-Credential <PSCredential>
[<CommonParameters>]
Enter-PSSession
[-VMName] <String>
-Credential <PSCredential>
[<CommonParameters>]
Description
Enter-PSSession Cmdlet 會啟動具有單一遠端電腦的互動式會話。 在工作階段期間,您輸入的命令會在遠端電腦上執行,就如同您直接在遠端電腦上輸入一樣。 您一次只能有一個互動式會話。
一般而言,您可以使用 ComputerName 參數來指定遠端電腦的名稱。 不過,您也可以使用互動式會話的 New-PSSession Cmdlet 來建立的會話。 不過,您無法使用 Disconnect-PSSession、Connect-PSSession 或 Receive-PSSession Cmdlet 來中斷連線或重新連線到互動式會話。
若要結束互動式工作階段並從遠端電腦中斷連線,請使用 Exit-PSSession Cmdlet,或輸入 exit
。
範例
範例 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:\>
這些命令會使用 Enter-PSSessionSession 參數,在現有的 Windows PowerShell 會話中執行互動式會話(PSSession)。
範例 4:啟動互動式會話,並指定埠和認證參數
PS C:\> Enter-PSSession -ComputerName Server01 -Port 90 -Credential Domain01\User01
[Server01]: PS C:\>
此命令會啟動與 Server01 計算機的互動式作業階段。 它會使用 Port 參數來指定埠和 Credential 參數,以指定有權連線到遠端電腦之用戶的帳戶。
範例 5:停止互動式會話
PS C:\> Enter-PSSession -ComputerName Server01
[Server01]: PS C:\> Exit-PSSession
PS C:\>
此範例示範如何啟動和停止互動式會話。 第一個命令會使用 Enter-PSSession Cmdlet 來啟動與 Server01 計算機的互動式會話。
第二個命令會使用 Exit-PSSession Cmdlet 結束會話。 您也可以使用 Exit 關鍵詞結束互動式工作階段。 Exit-PSSession 和 Exit 具有相同的效果。
參數
-AllowRedirection
允許將此連線重新導向至替代的統一資源標識碼(URI)。 根據預設,不允許重新導向。
當您使用 ConnectionURI 參數時,遠端目的地可以傳回指示以重新導向至不同的 URI。 根據預設,Windows PowerShell 不會重新導向連線,但您可以使用此參數來允許它重新導向連線。
您也可以變更 MaximumConnectionRedirectionCount 會話選項值,來限制重新導向連線的次數。 使用 New-PSSessionOption Cmdlet 的 MaximumRedirection 參數,或設定$PSSessionOption喜好設定變數的 MaximumConnectionRedirectionCount 屬性。 預設值為 5。
類型: | SwitchParameter |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-ApplicationName
指定連線 URI 的應用程式名稱區段。 當您不使用命令中的 ConnectionURI 參數時,請使用此參數來指定應用程式名稱。
默認值是本機計算機上$PSSessionApplicationName喜好設定變數的值。 如果未定義此喜好設定變數,預設值為 WSMAN。 此值適用於大部分使用。 如需詳細資訊,請參閱about_Preference_Variables。
WinRM 服務會使用應用程式名稱來選取接聽程式來服務連線要求。 此參數的值應該符合遠端電腦上接聽程式 URLPrefix 屬性的值。
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-Authentication
指定用來驗證使用者認證的機制。 此參數可接受的值為:
- 違約
- 基本
- Credssp
- 消化
- Kerberos
- 談判
- NegotiateWithImplicitCredential
預設值為 Default。
CredSSP 驗證僅適用於 Windows Vista、Windows Server 2008 和更新版本的 Windows 操作系統。
如需此參數值的詳細資訊,請參閱 MSDN 連結庫中 AuthenticationMechanism 列舉。
注意:認證安全性支援提供者 (CredSSP) 驗證,其中使用者的認證會傳遞至要驗證的遠端計算機,其設計目的是需要對多個資源進行驗證的命令,例如存取遠端網路共用。 此機制會增加遠端作業的安全性風險。 如果遠端電腦遭到入侵,傳遞給它的認證可用來控制網路會話。
類型: | AuthenticationMechanism |
接受的值: | Default, Basic, Negotiate, NegotiateWithImplicitCredential, Credssp, Digest, Kerberos |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-CertificateThumbprint
指定具有執行此動作許可權之用戶帳戶的數位公鑰憑證 (X509)。 輸入憑證的憑證指紋。
憑證用於客戶端憑證型驗證。 它們只能對應至本機用戶帳戶;它們不適用於網域帳戶。
若要取得憑證,請使用 Windows PowerShell 憑證: 磁碟驅動器中的 Get-Item 或 Get-ChildItem 命令。
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-ComputerName
指定計算機名稱。 此 Cmdlet 會啟動具有指定遠端電腦的互動式工作階段。 只輸入一個計算機名稱。 預設值為本機計算機。
輸入 NetBIOS 名稱、IP 位址或電腦的完整功能變數名稱。 您也可以使用管線將電腦名稱傳送至 Enter-PSSession。
若要在 ComputerName 參數的值中使用 IP 位址,命令必須包含 Credential 參數。 此外,計算機必須針對 HTTPS 傳輸進行設定,或遠端電腦的 IP 位址必須包含在本機電腦上的 WinRM TrustedHosts 清單中。 如需將計算機名稱新增至 TrustedHosts 清單的指示,請參閱 about_Remote_Troubleshooting 中的。
注意:在 Windows Vista 和更新版本的 Windows 作業系統中,若要將本機計算機包含在 ComputerName 參數的值中,您必須使用 [以系統管理員身分執行] 選項啟動 Windows PowerShell。
類型: | String |
別名: | Cn |
Position: | 0 |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
-ConfigurationName
指定用於互動式工作階段的工作階段組態。
輸入工作階段組態的組態名稱或完整資源URI。
如果您只指定組態名稱,則前面會加上下列架構 URI:https://schemas.microsoft.com/powershell
。
會話的會話組態位於遠端電腦上。 如果遠端電腦上沒有指定的工作階段組態,命令會失敗。
預設值是本機計算機上$PSSessionConfigurationName喜好設定變數的值。 如果未設定此喜好設定變數,則預設值為 Microsoft.PowerShell。 如需詳細資訊,請參閱about_Preference_Variables。
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-ConnectionUri
指定 URI,定義工作階段的連接端點。 URI 必須完整。 此字串格式如下所示:
<Transport>://<ComputerName>:<Port>/<ApplicationName>
預設值如下:
https://localhost:5985/WSMAN
如果您未指定 ConnectionURI,您可以使用 UseSSL、ComputerName、Port和 ApplicationName 參數來指定 ConnectionURI 值。
URI 傳輸區段的有效值為 HTTP 和 HTTPS。 如果您使用傳輸區段指定連線 URI,但未指定埠,則會使用標準埠來建立會話:80 代表 HTTP,而 HTTPS 則為 443。 若要使用 Windows PowerShell 遠端的預設埠,請針對 HTTP 指定埠 5985,或針對 HTTPS 指定埠 5986。
如果目的地計算機將連線重新導向至不同的 URI,除非您在命令中使用 AllowRedirection 參數,否則 Windows PowerShell 會防止重新導向。
類型: | Uri |
別名: | URI, CU |
Position: | 1 |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-Credential
指定具有執行此動作許可權的用戶帳戶。 預設值為目前的使用者。
輸入使用者名稱,例如 User01
、Domain01\User01
或 User@Domain.com
,或輸入 PSCredential 物件,例如 Get-Credential Cmdlet 所傳回的用戶名稱。
當您輸入使用者名稱時,此 Cmdlet 會提示您輸入密碼。
類型: | PSCredential |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-EnableNetworkAccess
指出此 Cmdlet 會將互動式安全性令牌新增至回送會話。 互動式令牌可讓您在從其他電腦取得數據的回送會話中執行命令。 例如,您可以在會話中執行命令,將 XML 檔案從遠端電腦複製到本機電腦。
回送會話是 來自相同電腦上的 PSSession。 若要建立回送工作階段,請省略 ComputerName 參數,或將其值設定為 。 (dot)、localhost 或本機計算機的名稱。
根據預設,會使用網路令牌來建立回送會話,而網路令牌可能無法提供足夠的許可權來向遠端計算機進行驗證。
EnableNetworkAccess 參數只在回送會話中有效。 如果您在遠端電腦上建立會話時,使用 EnableNetworkAccess,命令會成功,但會忽略 參數。
您也可以使用 Authentication 參數的 CredSSP 值,在回送會話中允許遠端訪問,此參數會將會話認證委派給其他計算機。
此參數是在 Windows PowerShell 3.0 中引進的。
類型: | SwitchParameter |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-Id
指定現有工作階段的識別碼。 Enter-PSSession 會針對互動式會話使用指定的會話。
若要尋找會話的標識符,請使用 Get-PSSession Cmdlet。
類型: | Int32 |
Position: | 0 |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-InstanceId
指定現有工作階段的實例識別碼。 Enter-PSSession 會針對互動式會話使用指定的會話。
實例標識碼是 GUID。 若要尋找會話的實例標識符,請使用 Get-PSSession Cmdlet。 您也可以使用 Session、Name或 ID 參數來指定現有的工作階段。 或者,您可以使用 ComputerName 參數來啟動暫存會話。
類型: | Guid |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-Name
指定現有工作階段的易記名稱。 Enter-PSSession 會針對互動式會話使用指定的會話。
如果您指定的名稱符合一個以上的會話,命令就會失敗。 您也可以使用 Session、InstanceID或 ID 參數來指定現有的工作階段。 或者,您可以使用 ComputerName 參數來啟動暫存會話。
若要建立會話的易記名稱,請使用 New-PSSession Cmdlet 的 Name 參數。
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-Port
指定遠端電腦上用於此命令的網路埠。 若要連線到遠端電腦,遠端計算機必須接聽連線所使用的埠。 默認埠為 5985,這是 HTTP 的 WinRM 連接埠,而 5986 是 HTTPS 的 WinRM 連接埠。
使用替代埠之前,您必須在遠端電腦上設定 WinRM 接聽程式,以在該埠接聽。 使用下列命令來設定接聽程式:
1. winrm delete winrm/config/listener?Address=*+Transport=HTTP
2. winrm create winrm/config/listener?Address=*+Transport=HTTP @{Port="\<port-number\>"}
除非您必須,否則請勿使用 Port 參數。 命令中的埠設定會套用至命令執行所在的所有計算機或會話。 替代埠設定可能會防止命令在所有計算機上執行。
類型: | Int32 |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-Session
指定要用於互動式會話的 Windows PowerShell 工作階段(PSSession)。 此參數會採用會話物件。 您也可以使用 Name、InstanceID或 ID 參數來指定 PSSession。
輸入包含會話物件的變數,或建立或取得會話物件的命令,例如 New-PSSession 或 Get-PSSession 命令。 您也可以使用管線將會話物件傳送至 Enter-PSSession。 您可以使用此參數,只提交一個 PSSession。 如果您輸入的變數包含多個 PSSession,此命令會失敗。
當您使用 Exit-PSSession 或 EXIT 關鍵詞時,互動式會話會結束,但您所建立 PSSession 仍保持開啟且可供使用。
類型: | PSSession |
Position: | 0 |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-SessionOption
設定工作階段的進階選項。 輸入 SessionOption 物件,例如您使用 New-PSSessionOption Cmdlet 建立的物件,或索引鍵為會話選項名稱和值是會話選項值的哈希表。
如果設定選項,選項的預設值取決於$PSSessionOption喜好設定變數的值。 否則,預設值是由會話組態中設定的選項所建立。
會話選項值優先於$PSSessionOption喜好設定變數和會話組態中設定的會話預設值。 不過,它們不會優先於會話設定中設定的最大值、配額或限制。
如需工作階段選項的描述,包括預設值,請參閱 New-PSSessionOption。 如需$PSSessionOption喜好設定變數的相關信息,請參閱 about_Preference_Variables。 如需工作階段組態的詳細資訊,請參閱 about_Session_Configurations。
類型: | PSSessionOption |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-UseSSL
指出此 Cmdlet 會使用安全套接字層 (SSL) 通訊協定來建立與遠端電腦的連線。 根據預設,不會使用 SSL。
WS-Management 會加密透過網路傳輸的所有 Windows PowerShell 內容。 UseSSL 參數是額外的保護,可跨 HTTPS 連線傳送數據,而不是 HTTP 連線。
如果您使用此參數,但在用於命令的埠上無法使用 SSL,則命令會失敗。
類型: | SwitchParameter |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-VMGuid
指定虛擬機的識別碼。
類型: | Guid |
Position: | 0 |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
-VMName
指定虛擬機的名稱。
類型: | String |
Position: | 0 |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
輸入
System.String, System.Management.Automation.Runspaces.PSSession
您可以使用管線將電腦名稱、字串或工作階段物件傳送至此 Cmdlet。
輸出
None
Cmdlet 不會傳回任何輸出。
備註
- 若要連線到遠端電腦,您必須是遠端電腦上的 Administrators 群組成員。
- 在 Windows Vista 和更新版本的 Windows 作業系統中,若要在本機電腦上啟動互動式會話,您必須使用 [以系統管理員身分執行] 選項啟動 Windows PowerShell。
- 當您使用 Enter-PSSession時,遠端電腦上的使用者配置檔會用於互動式會話。 遠端使用者配置檔中的命令,包括新增 Windows PowerShell 嵌入式管理單元的命令,以及變更命令提示字元,在顯示遠端提示字元之前執行。
- Enter-PSSession 使用本機電腦上的 UI 文化特性設定來進行互動式會話。 若要尋找本機 UI 文化特性,請使用$UICulture自動變數。
- Enter-PSSession 需要 Get-Command、Out-Default 和 Exit-PSSession Cmdlet。 如果遠端電腦上的會話設定中未包含這些 Cmdlet,Enter-PSSession 命令會失敗。
- 不同於 Invoke-Command,它會先剖析並解譯命令再將命令傳送至遠端電腦,Enter-PSSession 直接將命令傳送至遠端電腦,而不需要解譯。
- 如果您想要輸入的會話正忙於處理命令,則 Windows PowerShell 回應 enter-PSSession 命令之前可能會有延遲。 一旦會話可供使用,您就會立即連線。 若要取消 Enter-PSSession 命令,請按
CTRL+C
。