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

Lock-UserLockSession Cmdlet

Synopsis

Locks session through the UserLock server.

Syntax

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

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

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

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

Description

The Lock-UserLockSession cmdlet locks 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 lock 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, to uniquely identify it by specifying the type of session) to lock. 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 lock 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 locked. 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 Lock-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 locked 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>

Locks 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 Lock-UserLockSession by its alias, "luls". For more information, see about_Aliases. To use Lock-UserLockSession, you must have the "User sessions" UserLock administrative access right. Lock RAS or IIS sessions is not supported. Lock-UserLockSession prompts to confirm lock by default. To prevent from prompting, use -Force. To use Lock-UserLockSession with ISDecisions.UserLockLibrary.Session objects through the pipeline, you can use the Get-UserLockSession cmdlet.

Examples

Example 1

Lock-UserLockSession -UserName 'Alice', 'Bob' -UserLockServerName MyUlSrv

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

Example 2

Lock-UserLockSession -ComputerName 'MyWrk01' -UserLockServerName MyUlSrv

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

Example 3

Lock-UserLockSession -Name 'MyWrk01/0', 'MyWrk05/2' -UserLockServerName MyUlSrv

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

Example 4

$us = Get-UserLockInteractiveSession -UserLockServerName MyUlSrv | where {$PSItem.LogonDate -gt (Get-Date).Date.AddHours(15)}
Lock-UserLockSession -Force -InputObject $us

Locks all interactive sessions logged on the current day after 03:00 PM through the 'MyUlSrv' UserLock server.