UserLock Documentation
UserLock Documentation
You are here: Reference > UserLock PowerShell > Cmdlet Help > Close-UserLockSession

Close-UserLockSession Cmdlet

Synopsis

Logs off session through the UserLock server.

Syntax

Close-UserLockSession [-UserName] <string[]> [-UserLockServerName <string>] [-PassThru] [-Force] [-Confirm] [-WhatIf][<CommonParameters>]

Close-UserLockSession [-Name] <string[]> [-UserLockServerName <string>] [-PassThru] [-Force] [-Confirm] [-WhatIf][<CommonParameters>]

Close-UserLockSession [-ComputerName] <string[]> [-UserLockServerName <string>] [-PassThru] [-Force] [-Confirm] [-WhatIf][<CommonParameters>]

Close-UserLockSession [-InputObject] <Session[]> [-UserLockServerName <string>] [-PassThru] [-Force] [-Confirm] [-WhatIf][<CommonParameters>]

Description

The Close-UserLockSession cmdlet logs off interactive session(s) through the UserLock server. Caution: PowerShell 3.0 is required.

Parameters

-UserName <string[]>

Specifies the name of the user for which to log off all sessions. You can type multiple user names (separated by commas). If the name includes escape characters, enclose it in single quotation marks. Single quotation marks tell Windows PowerShell not to interpret any characters as escape sequences. Wildcard characters are permited.

Required true
Position named
Accepts pipeline input true (ByValue, ByPropertyName)
Accepts wildcard characters true

-Name <string[]>

Specifies the name of the session (Universal key name, in order to identify it uniquely over all kind of session) to log off. You can type multiple session names (separated by commas). If the name includes escape characters, enclose it in single quotation marks. Single quotation marks tell Windows PowerShell not to interpret any characters as escape sequences. 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 for which to log off all sessions. You can type multiple computer names (separated by commas). If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell Windows PowerShell not to interpret any characters as escape sequences. Wildcard characters are permited.

Required true
Position named
Accepts pipeline input true (ByValue, ByPropertyName)
Accepts wildcard characters true

-InputObject <Session[]>

Specifies the session objects that represent sessions to be logged off. Enter a variable that contains the session objects or a command that gets the session objects, such as a Get-UserLockSession command. You can also pipe the objects to Close-UserLockSession.

Required true
Position named
Accepts pipeline input true (ByValue)
Accepts wildcard characters false

-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 '.'

-PassThru <SwitchParameter>

Returns the logged off session object(s). By default, this cmdlet does not generate any output.

Required false
Position named
Accepts pipeline input false
Accepts wildcard characters false

-Force <SwitchParameter>

Logs off session(s) with no confirmation.

Required false
Position named
Accepts pipeline input false
Accepts wildcard characters false

-Confirm <SwitchParameter>

Prompts you for confirmation before executing the command.

Required false
Position named
Accepts pipeline input false
Accepts wildcard characters false

-WhatIf <SwitchParameter>

Describes what would happen if you executed the command without actually executing the command.

Required false
Position named
Accepts pipeline input false
Accepts wildcard characters false

<CommonParameters>

For more information about common parameters, type "Get-Help about_commonparameters".

Input Type

ISDecisions.UserLockLibrary.Session or ISDecisions.UserLockLibrary.UserSession

Return Type

None or ISDecisions.UserLockLibrary.Session

Notes

You can also refer to Close-UserLockSession by its alias, "culs". For more information, see about_Aliases. To use Close-UserLockSession, you must have the "User sessions" UserLock administrative access right. Close RAS or IIS sessions is not supported. Close-UserLockSession prompts to confirm logoff by default. To prevent from prompting, use -Force. To use Close-UserLockSession with ISDecisions.UserLockLibrary.Session objects through the pipeline, you can use the Get-UserLockSession cmdlet.

Examples

Example 1

C:\PS>Close-UserLockSession -UserName 'Alice', 'Bob' -UserLockServerName MyUlSrv

Logs off all sessions of the 'Alice' and 'Bob' user accounts through the 'MyUlSrv' UserLock server.

Example 2

C:\PS>Close-UserLockSession -ComputerName 'MyWrk01' -UserLockServerName MyUlSrv

Logs off all sessions opened on the 'MyWrk01' computer through the 'MyUlSrv' UserLock server.

Example 3

C:\PS>Close-UserLockSession -Name 'MyWrk01/0', 'MyWrk05/2' -UserLockServerName MyUlSrv

Logs off 'MyWrk01/0' and 'MyWrk05/2' sessions through the 'MyUlSrv' UserLock server.

Example 4

C:\PS>$us = guls -UserLockServerName $UserLockServerName | where {$_.SessionCount -gt 0} C:\PS>culs -InputObject $us -userl $UserLockServerName

Logs off all interactive sessions through the 'MyUlSrv' UserLock server.

Related Links

Get-UserLockSession

Get-UserLockInteractiveSession

Lock-UserLockSession

Reset-UserLockSession

Send-UserLockPopup

Get-UserLockCommand