PowerShell Genie

Get-PSSession

Use Get-PSSession to list the PSSessions in the current session, or those available on a remote computer.

Command 1 min read Windows PowerShell 5.1 and PowerShell 7

Documentation: Microsoft Learn — PowerShell module reference

Written and tested by Dhrub Bharali · Updated

Syntax

1PS> Get-PSSession [[-ComputerName] <string[]>] [-Name <String[]>] [-Id <Int32[]>] [-State <SessionFilterState>] [-Credential <PSCredential>] [<CommonParameters>]
See the command anatomy

Read the command and its supplied arguments. This example requires real PowerShell or its module; this diagram does not execute it.

Get-PSSession [[-ComputerName] <string[]>] [-Name <String[]>] [-Id <Int32[]>] [-State <SessionFilterState>] [-Credential <PSCredential>] [<CommonParameters>]
  1. Stage 1Get-PSSession-ComputerName -Name -Id -State -Credential

    Try it

    Windows PowerShell

    PowerShell example · browser support is limited.

    Execution scope: The full example below requires PowerShell outside this browser. You can edit this runner to use the supported practice commands; unsupported syntax returns an explanation.

    Interactive simulation · fictional data

    Examples

    Select Id, ComputerName, State, Availability

    1PS> Get-PSSession | Select-Object Id, ComputerName, State, Availability
    Show reference output

    Sample output · fictional data, shaped like the real thing

    Id  ComputerName  State   Availability
--  ------------  ------  ------------
1   SRV01         Opened  Available

    Get-PSSession -ComputerName SRV01

    1PS> Get-PSSession -ComputerName SRV01 -State Disconnected
    Show reference output

    Sample output · fictional data, shaped like the real thing

    Id  ComputerName  State   Availability
--  ------------  ------  ------------
1   SRV01         Opened  Available

    Get-PSSession -State Broken

    1PS> Get-PSSession -State Broken | Remove-PSSession
    Show reference output

    Sample output · fictional data, shaped like the real thing

    Id  ComputerName  State   Availability
--  ------------  ------  ------------
1   SRV01         Opened  Available

    Parameters

    Parameter definitions:

    • -ComputerName
    • -Name
    • -Id
    • -State
    • -Credential

    PowerShell module reference on Microsoft Learn

    Practical use and troubleshooting

    Practical scenario: Use Get-PSSession when you need to list the PSSessions in the current session, or those available on a remote computer. Start with one identified target and inspect the returned values before extending the operation to a list. Keep the identity in your report so you can trace each result back to the object or path that produced it.

    Common error and fix: A Disconnected or Broken state should be inspected before reuse. Keep the intended session object and check availability rather than passing every stored session to the next remote operation. In an unattended script, capture this failure with its original error record and record which target failed. An empty result and an unsuccessful query must remain distinguishable in the final report.

    See also: Remove-PSSession. Get-PSSession inspects remoting session state; Remove-PSSession closes selected sessions. Closing a session also affects remote state held inside it. Read the linked command before substituting it; similar names do not imply identical inputs or output.

    Get-PSSession reference on Microsoft Learn

    Recap

    Get-PSSession Use Get-PSSession to list the PSSessions in the current session, or those available on a remote computer.

    Next: Enter-PSSession
    Genie guideGet-PSSession

    Use Get-PSSession to list the PSSessions in the current session, or those available on a remote computer. The console below is pre-loaded — run it, then change a value and run it again.

    Explore PowerShell Genie

    Related