Get-PSUUserSession

Query connected PowerShell Universal user sessions by ID, source, user, or computer.

SYNOPSIS

Gets PowerShell Universal user sessions.

SYNTAX

Get-PSUUserSession -Id <Int64> [<ConnectionOptions>] [<CommonParameters>]
Get-PSUUserSession [-Source <String>] [-UserName <String>] [-ComputerName <String>] [<ConnectionOptions>] [<CommonParameters>]

<ConnectionOptions>: [-AppToken <String>] [-Credential <PSCredential>] [-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies]. For this command, -ComputerName in the listing parameter set filters sessions by the computer that owns them; it is not a Management API target. Connect to the desired PSU server first with Connect-PSUServer.

DESCRIPTION

Retrieves user-session records. Use the singular command name; it replaces the formerly exported Get-PSUUserSessions command. The listing filters support wildcards. Use -Id to retrieve a single session instead of combining it with list filters.

EXAMPLES

Get-PSUUserSession
Get-PSUUserSession -Id 10
Get-PSUUserSession -UserName 'admin'
Get-PSUUserSession -Source 'Dashboard'
Get-PSUUserSession -ComputerName 'server01'

PARAMETERS

Parameter	Description
-Id	Required numeric ID of one session (Id parameter set).
-Source	Source filter; supports wildcards (All parameter set).
-UserName	Username filter; supports wildcards (All parameter set).
-ComputerName	Computer owning the session; supports wildcards (All parameter set), not a target PSU server URL.
-AppToken	Management API app token.
-Credential	Management API credentials.
-UseDefaultCredentials	Uses current Windows credentials.
-Integrated	Uses the in-process management client.
-TrustCertificate	Ignores certificate validation errors.
-Cookies	Reuses session authentication cookies.

OUTPUTS

PowerShellUniversal.UserSession.

PERMISSIONS

The access token requires platform.usersessions/read to run this cmdlet remotely.