Citrix Virtual Apps and Desktops SDK


Sends a message to a session.


Send-BrokerSessionMessage [-InputObject] <Session[]> [-MessageStyle] <SendMessageStyle> [-Title] <String> [-Text] <String> [-LoggingId <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]

Detailed Description

Generates a message box in the target session(s).


Name Description Required? Pipeline Input Default Value
InputObject The target session(s) to send the message to. true true (ByValue)  
MessageStyle The style of message box to use (valid values are Critical, Question, Exclamation, or Information). true true (ByValue)  
Title Text to display in the messagebox title bar. true true (ByValue)  
Text The message to display. true true (ByValue)  
LoggingId Specifies the identifier of the high level operation that this cmdlet call forms a part of. Desktop Studio and Desktop Director typically create High Level Operations. PowerShell scripts can also wrap a series of cmdlet calls in a High Level Operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets. false false  
AdminAddress Specifies the address of a XenDesktop controller that the PowerShell snapin will connect to. This can be provided as a host name or an IP address. false false Localhost. Once a value is provided by any cmdlet, this value will become the default.
BearerToken Specifies the bearer token assigned to the calling user false false  
TraceParent Specifies the trace parent assigned for internal diagnostic tracing use false false  
TraceState Specifies the trace state assigned for internal diagnostic tracing use false false  
VirtualSiteId Specifies the virtual site the PowerShell snap-in will connect to. false false  

Input Type


The session to which to send the message can be piped in.

Return Values



Sessions can be passed as the InputObject parameter as either session objects or their numeric Uids.
This operation is non-blocking and returns before it completes. The operation, however, is unlikely to fail unless there are communication problems between controller and machine, if bad arguments are passed to the cmdlet itself or if the machine cannot successfully execute the operation.
The transient nature of sessions means that the list of session objects or UIDs supplied to Send-BrokerSessionMessage could consist of valid and invalid sessions. Invalid sessions are detected and disregarded and the send message operation is invoked on the machines running valid sessions.
The system can fail to invoke the operation if the machine is not in an appropriate state or if there are problems in communicating with the machine. When an operation is invoked the system detects if the operation was initiated successfully or not by the session. As this operation is non-blocking the system doesn’t detect or report whether the operation ultimately succeeded or failed after its successful initialization in the session.
Operation failures are reported through the broker SDK error handling mechanism (see about_Broker_ErrorHandling). In the event of errors the SdkErrorRecord error status code is set to SessionOperationFailed and its error data dictionary is populated with the following entries:
o OperationsAttemptedCount: The number of operations attempted.
o OperationsFailedCount - The number of failed operations.
o OperationsSucceededCount - The number of successfully executed operations.
o UnresolvedSessionFailuresCount - The number of operations that failed due to invalid sessions being supplied.
o OperationInvocationFailuresCount - The number of operations that failed because they could not be invoked in the session.
o DesktopExecutionFailuresCount - The number of operations that failed because they could not be successfully executed in the session.
The SdkErrorRecord message will also display the number of attempted, failed and successful operations in the following format:
“Session operation error - attempted:<OperationsAttemptedCount>, failed:<OperationsFailedCount>, succeeded:<OperationsSucceededCount>”


Example 1

C:\PS> $sessions = Get-BrokerSession -UserName MYDOMAIN\\*

C:\PS> Send-BrokerSessionMessage $sessions -MessageStyle Information -Title TestTitle -Text TestMessage


Sends a message to all the sessions for any user in MYDOMAIN.

Example 2

C:\PS> $desktop = Get-BrokerDesktop -Uid 1

C:\PS> Send-BrokerSessionMessage $desktop.SessionUid -MessageStyle Information -Title TestTitle -Text TestMessage


Sends a message to the session on the desktop with Uid 1.

Example 3

C:\PS> trap  [Citrix.Broker.Admin.SDK.SdkOperationException]

C:\PS> {

C:\PS>   write $("Exception name = " + $_.Exception.GetType().FullName)

C:\PS>   write $("SdkOperationException.Status = " + $_.Exception.Status)

C:\PS>   write $("SdkOperationException.ErrorData=")

C:\PS>   $_.Exception.ErrorData


C:\PS>   write $("SdkOperationException.InnerException = " + $_.Exception.InnerException)

C:\PS>   $_.Exception.InnerException

C:\PS>   continue

C:\PS> }


C:\PS> Send-BrokerSessionMessage -InputObject 10,11,12 -MessageStyle Information -Title "message title" -Text "message text"


Trap and display error information.