Send-UserLockPopup Cmdlet
Synopsis
Sends a pop-up to a session through the UserLock server.
Syntax
Send-UserLockPopup [-UserName] <string[]> [-Message] <string> [-Title <string>] [-UserLockServerName <string>] [-PassThru] [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
Send-UserLockPopup [-Name] <string[]> [-Message] <string> [-Title <string>] [-UserLockServerName <string>] [-PassThru] [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
Send-UserLockPopup [-ComputerName] <string[]> [-Message] <string> [-Title <string>] [-UserLockServerName <string>] [-PassThru] [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
Send-UserLockPopup [-InputObject] <Session[]> [-Message] <string> [-Title <string>] [-UserLockServerName <string>] [-PassThru] [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
Description
The Send-UserLockPopup cmdlet sends a pop-up to the interactive session(s) through the UserLock server. Caution: PowerShell 3.0 is required.
Parameters
-Message <string>
Specifies the message of the pop-up.
| Required | true |
| Position | 1 |
| Accepts pipeline input | false |
| Accepts wildcard characters | false |
-Title <string>
Specifies the title of the pop-up.
| Required | false |
| Position | 2 |
| Accepts pipeline input | false |
| Accepts wildcard characters | false |
-UserName <string[]>
Specifies the name of the user for which to send a pop-up 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 send a pop-up. 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 send a pop-up 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 send a pop-up. Enter a variable that contains the session objects or a command that gets the session objects, such as a
| 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 popped up 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>
Sends a pop-up to the 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 Send-UserLockPopup by its alias, "sulp". For more information, see about_Aliases.
To use Send-UserLockPopup, you must have the "User sessions" UserLock administrative access right.
Send a pop-up to RAS or IIS sessions is not supported.
Send-UserLockPopup prompts to confirm pop-up by default. To prevent from prompting, use -Force.
To use Send-UserLockPopup with ISDecisions.UserLockLibrary.Session objects through the pipeline, you can use the
Examples
Example 1
Send-UserLockPopup -UserName 'Alice', 'Bob' -UserLockServerName MyUlSrv
Send a pop-up to all sessions of the 'Alice' and 'Bob' user accounts through the 'MyUlSrv' UserLock server.
Example 2
Send-UserLockPopup -ComputerName 'MyWrk01' -UserLockServerName MyUlSrv
Sends a pop-up to all sessions opened on the 'MyWrk01' computer through the 'MyUlSrv' UserLock server.
Example 3
Send-UserLockPopup -Name 'MyWrk01/0', 'MyWrk05/2' -UserLockServerName MyUlSrv
Sends a pop-up to 'MyWrk01/0' and 'MyWrk05/2' sessions through the 'MyUlSrv' UserLock server.
Example 4
$us = guls -UserLockServerName $UserLockServerName | where {$_.SessionCount -gt 0}
Send-UserLockPopup -InputObject $us -userl $UserLockServerName -Force
Sends a pop-up to all interactive sessions through the 'MyUlSrv' UserLock server.