Exit-PSSession
Ends an interactive session with a remote computer.
Syntax
Exit-PSSession []
Description
The Exit-PSSession
cmdlet ends interactive sessions that you started by using the
Enter-PSSession
cmdlet.
You can also use the exit
keyword to end an interactive session. The effect is the same as using
Exit-PSSession
.
Examples
Example 1: Start and stop an interactive session
PS C:\> Enter-PSSession -ComputerName Server01
Server01\PS> Exit-PSSession
PS C:\>
These commands start and then stop an interactive session with the Server01 remote computer.
Example 2: Start and stop an interactive session by using a PSSession object
PS C:\> $s = New-PSSession -ComputerName Server01
PS C:\> Enter-PSSession -Session $s
Server01\PS> Exit-PSSession
PS C:\> $s
Id Name ComputerName State ConfigurationName
-- ---- ------------ ----- -----------------
1 Session1 Server01 Opened Microsoft.PowerShell
These commands start and stop an interactive session with the Server01 computer that uses a Windows PowerShell session (PSSession).
Because the interactive session was started by using a Windows PowerShell session, the PSSession
is still available when the interactive session ends. If you use the ComputerName parameter,
Enter-PSSession
creates a temporary session that it closes when the interactive session ends.
The first command uses the New-PSSession
cmdlet to create a PSSession on the Server01
computer. The command saves the PSSession in the $s
variable.
The second command uses Enter-PSSession
to start an interactive session using the PSSession in
$s
.
The third command uses Exit-PSSession
to stop the interactive session.
The final command displays the PSSession in the $s
variable. The State property shows the
PSSession is still open and available for use.
Example 3: Use the Exit keyword to stop a session
PS C:\> Enter-PSSession -ComputerName Server01
Server01\PS> exit
PS C:\>
This example uses the exit
keyword to stop an interactive session started by using
Enter-PSSession
. The exit
keyword has the same effect as using Exit-PSSession
.
Inputs
None
You can't pipe objects to this cmdlet.
Outputs
None
This cmdlet returns no output.
Notes
Windows PowerShell includes the following aliases for Exit-PSSession
:
exsn
This cmdlet takes only the common parameters.
Related Links
PowerShell