Get-UserLockMessage Cmdlet
Synopsis
Gets the customizable messages displayed to users.
Syntax
Get-UserLockMessage [-Name <string[]>] [-UserLockServerName <string>] [<CommonParameters>]
Description
The Get-UserLockMessage cmdlet gets the customizable messages displayed to users. Caution: PowerShell 3.0 is required.
Parameters
-Name <string[]>
Specifies the name (ID) of the message(s) to get. 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 | false |
Position | 1 |
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.Message
Notes
You can also refer to Get-UserLockMessage by its alias, "gulm". For more information, see about_Aliases. To use Get-UserLockMessage, you must have the "Customizable messages" UserLock administrative access right.
Examples
Example 1
Get-UserLockMessage -UserLockServerName 'MyUlSrv'
Gets the customizable messages from the 'MyUlSrv' UserLock server.
Example 2
Get-UserLockMessage -Name 'WELCOME_MESSAGE' -us 'MyUlSrv'
Gets the content of the welcome message from the 'MyUlSrv' UserLock server.