Send-RDUserMessage

Mis à jour: juin 2015

S'applique à: Windows 10, Windows Server Technical Preview

Send-RDUserMessage

Sends a system message to a specified user session.

Syntaxe

Parameter Set: Default
Send-RDUserMessage [-HostServer] <String> [-UnifiedSessionID] <Int32> [-MessageTitle] <String> [-MessageBody] <String> [-InformationAction <System.Management.Automation.ActionPreference> {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend} ] [-InformationVariable <System.String> ] [ <CommonParameters>]

Description détaillée

The Send-RDUserMessage cmdlet sends a system message to a specified user session. Because the user session ID is unique only within the context of a session host, a different session host server can share the same user session ID. The host server and session ID that you specify by using this cmdlet uniquely identify a session within a deployment.

Paramètres

-HostServer<String>

Specifies the name of the server that hosts the session. For session collections the host server has the name of the Remote Desktop Session Host (RD  Session Host) server. For virtual desktop collections the host server has the name of the Remote Desktop Virtualization Host (RD Virtualization Host) server.

Alias	none
Requis ?	true
Position ?	1
Valeur par défaut	none
Accepter l'entrée de pipeline ?	True (ByPropertyName)
Accepter les caractères génériques ?	false

-InformationAction<System.Management.Automation.ActionPreference>

Specifies how this cmdlet responds to an information event. The acceptable values for this parameter are:

-- SilentlyContinue
-- Stop
-- Continue
-- Inquire
-- Ignore
-- Suspend

Alias	infa
Requis ?	false
Position ?	named
Valeur par défaut	none
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-InformationVariable<System.String>

Specifies a variable in which to store an information event message.

Alias	iv
Requis ?	false
Position ?	named
Valeur par défaut	none
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-MessageBody<String>

Specifies the text for the message body.

Alias	none
Requis ?	true
Position ?	4
Valeur par défaut	none
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-MessageTitle<String>

Specifies the text for the message title.

Alias	none
Requis ?	true
Position ?	3
Valeur par défaut	none
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-UnifiedSessionID<Int32>

Specifies a unique session ID on the host. Use Get-RDUserSession to retrieve the unique ID for a specific session.

Alias	none
Requis ?	true
Position ?	2
Valeur par défaut	none
Accepter l'entrée de pipeline ?	True (ByPropertyName)
Accepter les caractères génériques ?	false

<CommonParameters>

Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer et -OutVariable. Pour plus d'informations, consultez  . about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Entrées

Le type d'entrée correspond au type des objets que vous pouvez adresser à l'applet de commande.

Sorties

Le type de sortie correspond au type des objets que l'applet de commande émet.

• System.Object

Exemples

Example 1: Send a system message to users of a Remote Desktop application

This command sends a system message to users of the session with an ID of 1 on the host server named rdsh.contoso.com.

PS C:\> Send-RDUserMessage -HostServer "rdsh.contoso.com" -UnifiedSessionID 1 -MessageTitle "Message from Administrator" -MessageBody "Please save your work. You will be logged off in 10 minutes"

Rubriques connexes

Disconnect-RDUser

Get-RDUserSession

Invoke-RDUserLogoff