Get-UserLockRasSession Cmdlet
Synopsis
Gets the opened RAS sessions registered in UserLock server.
Syntax
Get-UserLockRasSession [-UserName <string[]>] [-UserLockServerName <string>] [<CommonParameters>]
Get-UserLockRasSession [-Name] <string[]> [-UserLockServerName <string>] [<CommonParameters>]
Get-UserLockRasSession [-ComputerName] <string[]> [-UserLockServerName <string>] [<CommonParameters>]
Description
The Get-UserLockRasSession cmdlet gets the opened RAS 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). If the cmdlet is used without parameters, all RAS 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 |
-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.RasSession or None
Notes
You can also refer to Get-UserLockRasSession by its alias, "gulras". For more information, see about_Aliases. To use Get-UserLockRasSession, you must have the "User sessions" UserLock administrative access right.
Examples
Example 1
Get-UserLockRasSession -UserLockServerName MyUlSrv
Gets the RAS sessions registerered in the 'MyUlSrv' UserLock server.
Example 2
Get-UserLockRasSession Alice -UserLockServerName MyUlSrv
Gets the RAS sessions, opened by the user Alice, registered in the 'MyUlSrv' UserLock server.