Set-UserLockMessage

Sets the content of customizable messages displayed to users.

Published May 31, 2025

Synopsis

Sets the content of customizable messages displayed to users.

Syntax

powershell

Set-UserLockMessage [-Name] <string[]> [-Value] <string> [-UserLockServerName <string>] [-PassThru] [-Force] [-Confirm] [-WhatIf][<CommonParameters>]

Description

The Set-UserLockMessage cmdlet sets the content of customizable messages displayed to users. Caution: PowerShell 3.0 is required.

Parameters

-Name <string[]>

Specifies the name (ID) of the message(s) to modify. Wildcard characters are permited. 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. The alias for Name is MessageID.

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

-Value <string>

New content of the customizable message. The alias for Value is Text.

Required	true
Position	2
Accepts pipeline input	false
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 specified message object(s). By default, this cmdlet does not generate any output.

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

-Force <SwitchParameter>

Modifies the content of the message(s) with no confirmation.

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

-Confirm <SwitchParameter>

Prompts you for confirmation before executing the command.

Required	true
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	true
Position	named
Accepts pipeline input	false
Accepts wildcard characters	false

<CommonParameters>

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

Input Type

None

Return Type

ISDecisions.UserLockLibrary.Message

Notes

You can also refer to Set-UserLockMessage by its alias, "sulm". For more information, see about_Aliases. To use Set-UserLockMessage, you must have the "Customizable messages" UserLock administrative access right.

Example