Get-UserLockInteractiveSession Cmdlet
Synopsis
Gets the opened interactive sessions registered in UserLock server.
Syntax
Get-UserLockInteractiveSession [-UserName <string[]>] [-SessionType <SessionType>] [-UserLockServerName <string>] [<CommonParameters>]
Get-UserLockInteractiveSession [-Name] <string[]> [-SessionType <SessionType>] [-UserLockServerName <string>] [<CommonParameters>]
Get-UserLockInteractiveSession [-ComputerName] <string[]> [-SessionType <SessionType>] [-UserLockServerName <string>] [<CommonParameters>]
Description
The Get-UserLockInteractiveSession cmdlet gets the opened interactive sessions registered in UserLock server, and searches them by user name (name of the account that opened the session), by computer name (where the session is located) or by name of a session (Universal key name, to uniquely identify it by specifying the type of session). Also you can get all kind of interactive sessions (Workstation, Terminal or both). If the cmdlet is used without parameters all Interactive (Workstation and Terminal) sessions will be returned. Caution: PowerShell 3.0 is required.
Parameters
-UserName <string[]>
Specifies the user name of a session (name of the account that opened the session). You can type multiple user names (separated by commas). Wildcard characters are permited.
| Required | false |
| Position | 1 |
| Accepts pipeline input | true (ByValue, ByPropertyName) |
| Accepts wildcard characters | true |
-Name <string[]>
Specifies the name of a session (Universal key name of the session, to uniquely identify it by specifying the type of session). You can type multiple names (separated by commas). Wildcard characters are permited.
| Required | true |
| Position | named |
| Accepts pipeline input | true (ByValue, ByPropertyName) |
| Accepts wildcard characters | true |
-ComputerName <string[]>
Specifies the name of the computer where the session is located. You can type multiple computer names (separated by commas). Wildcard characters are permited.
| Required | true |
| Position | named |
| Accepts pipeline input | true (ByValue, ByPropertyName) |
| Accepts wildcard characters | true |
-SessionType <SessionType>
Specifies the type of the session. Possible values for this parameter include: Workstation or 1 Terminal or 2 Interactive or Workstation,Terminal or 3 The default session type is Interactive. The alias for SessionType is Type.
| Required | false |
| Position | named |
| Accepts pipeline input | false |
| Accepts wildcard characters | false |
| Default Value | Interactive |
-UserLockServerName <string>
Specifies the name of the UserLock server. The default is the localhost name.
| Required | false |
| Position | named |
| Accepts pipeline input | false |
| Accepts wildcard characters | false |
| Default Value | '.' |
<CommonParameters>
For more information about common parameters, type "Get-Help about_commonparameters".
Input Type
None
Return Type
ISDecisions.UserLockLibrary.UserSession or None
Notes
You can also refer to Get-UserLockInteractiveSession by its alias, "gulis". For more information, see about_Aliases. To use Get-UserLockInteractiveSession, you must have the "User sessions" UserLock administrative access right.
Examples
Example 1
Get-UserLockInteractiveSession -UserLockServerName MyUlSrv
Gets the interactive sessions registerered in the 'MyUlSrv' UserLock server.
Example 2
Get-UserLockInteractiveSession Alice -Type Workstation -UserLockServerName MyUlSrv
Gets the workstation sessions, opened by the user Alice, registered in the 'MyUlSrv' UserLock server.