---
locale: "en"
updated_at: "2025-11-06T12:53:02.649Z"
canonical: "https://www.isdecisions.com/en/userlock/docs/build-with-userlock/powershell/manage-userlock-with-powershell"
---

# UserLock PowerShell

Command usage, examples, automation best practices.

## Overview

UserLock PowerShell provides a command-line interface for administrators who **prefer scripting** to GUI management.
It allows bulk operations, scheduled automation, and custom data queries against UserLock.

Already used for Windows Server and Exchange administration, PowerShell is a familiar tool for IT professionals.
UserLock PowerShell supports the same principles — cmdlets can be executed manually or scheduled to run automatically.

![](https://a.storyblok.com/f/122374/700x810/05b7dae115/powershellconsole.png)

## Requirements

To use UserLock PowerShell, make sure the following prerequisites are met:

- ✅** PowerShell 3.0 or later.**
Installed by default since Windows Server 2012 and Windows 8.
- ✅** Execution policy.**
Must be set to `RemoteSigned` (or less restrictive) on the computer running scripts.
- ✅** UserLock installation.**
The Userlock service must be installed on the machine running the scripts.

## Launching the UserLock PowerShell console

UserLock PowerShell is automatically installed with the UserLock Windows Console.
To start it:

1. Open the **UserLock Console**.
2. Click the **PowerShell prompt** icon in the toolbar.

![](https://a.storyblok.com/f/122374/323x350/25806028fe/three_dots_menu.png)

> **Note**
>
> The console loads with the UserLock module pre-imported and connected to the currently selected server. No additional configuration is required.

## Managing remote servers

Each cmdlet accepts an optional `UserLockServerName` parameter that defines which UserLock server executes the command.

- If specified, the command runs on the indicated server, and the variables `$UserLockServerName` and `$UserLockServer` are updated accordingly.
- If omitted, the cmdlet uses the current server stored in `$UserLockServerName`.

#### Example** **

```powershell
Get-UserLockProtectedAccountEffective -UserLockServerName 'ULSRV2' -Name 'MyUsr'
```

You can also change the `$UserLockServerName` variable manually before running a command.

#### Example 2

```powershell
$UserLockServerName = 'ULSRV3'
Get-UserLockProtectedAccount
```

## Getting help

UserLock PowerShell offers several ways to access help — online documentation and contextual assistance directly within PowerShell.

### Online documentation

The complete online documentation for UserLock PowerShell is available here:
👉 [UserLock PowerShell cmdlet reference](/userlock/docs/build-with-userlock/powershell/cmdlet-reference/)

Each cmdlet has its own dedicated page describing:

- Its **syntax**
- **Parameters** and accepted values
- **Examples**
- Related cmdlets and **use cases**

### Available cmdlets

To display all available UserLock PowerShell cmdlets directly from the console:

```powershell
Get-UserLockCommand
```

This command lists every UserLock-specific cmdlet loaded in the current session, with their names and brief descriptions.

![](https://a.storyblok.com/f/122374/700x810/05b7dae115/powershellconsole.png)

### Command-specific help

Use PowerShell’s built-in `Get-Help` to view detailed information about a cmdlet:

```powershell
Get-Help <UserLock_Cmdlet_Name>
```

![](https://a.storyblok.com/f/122374/700x472/d1d6f2d56e/powershellgethelp.png)

## Example scripts

The following examples demonstrate common administrative automations that can be achieved with PowerShell.
These can be run manually or scheduled through Windows Task Scheduler.

### Automate workstation shutdown (no open session)

```powershell
Get-UserLockReportedComputer -OnlyWorkstation |
where {($_.SessionCount -eq 0) -and ($_.Available)} |
Stop-UserLockComputer -Force
```

### Deploy the UserLock agent automatically

```powershell
Get-UserLockAgentDistribution |
where {($_.IsServer -eq 'Workstation') -and ($_.AgentType -eq 'Desktop') -and ($_.AgentStatus -eq 'NotInstalled') -and ($_.LastCheckStatus -eq 0)} |
Install-UserLockAgent -Force
```

### Reboot workstations with a pending installation

```powershell
Get-UserLockAgentDistribution |
where {($_.AgentStatus -eq 'installing') -and ($_.IsServer -eq 'workstation')} |
Restart-UserLockComputer -Force
```

### Send a message to all open sessions

```powershell
Get-UserLockInteractiveSession |
Send-UserLockPopup -Title 'IT Maintenance' -Message 'The File server is currently restarting. It will be available in 5 minutes.' -Force
```

### Enforce a UserLock setting on all users

```powershell
Set-UserLockProtectedAccount -Name * -Type user -Property DisplayWelcomeMessage -Value true -Force
```

### Reset all sessions (after a power failure)

```powershell
Get-UserLockOrphanedInteractiveSession | Reset-UserLockSession -Force
```

### Reset MFA keys for all users

```powershell
Get-UserLockReportedUser | ForEach-Object {
    $name = $PSItem.Name
    Write-Host "Resetting MFA key for $name"
    $UserLockServer.ResetMFAKey($name)
}
```

### Create and configure new access policy

Download the script and follow the included instructions:
[https://cdn.isdecisions.com/Download/userlock/NewUserLockProtectedAccountSettings.zip](https://cdn.isdecisions.com/Download/userlock/NewUserLockProtectedAccountSettings.zip)