Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Exit-PSSession

Exit-PSSession

system.management.automation.dll

Synopsis

Ends an interactive session with a remote computer.

Syntax

Exit-PSSession [<CommonParameters>]

Detailed Description

The Exit-PSSession cmdlet ends interactive sessions that you started by using Enter-PSSession.

You can also use the Exit keyword to end an interactive session. The effect is the same as using Exit-PSSession.

Parameters

Input Type

None

Return Type

None

Notes

This cmdlet takes only the common parameters.

Examples

-------------------------- EXAMPLE 1 --------------------------

These commands start and then stop an interactive session with the Server01 remote computer.

PS C:\>Enter-PSSession -computername Server01
Server01\PS> Exit-PSSession
PS C:\>

-------------------------- EXAMPLE 2 --------------------------

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 (PSSession), 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 the Enter-PSSession cmdlet to start an interactive session using the PSSession in $s.

The third command uses the Exit-PSSession cmdlet 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.

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

-------------------------- EXAMPLE 3 --------------------------

This command uses the Exit keyword to stop an interactive session started by using the Enter-PSSession cmdlet. The Exit keyword has the same effect as using Exit-PSSession.

PS C:\>Enter-PSSession -computername Server01
Server01\PS> exit
PS C:\>

Online Version
Connect-PSSession
Disconnect-PSSession
Enter-PSSession
Get-PSSession
Invoke-Command
New-PSSession
Receive-PSSession
Remove-PSSession
about_PSSessions
about_Remote