Edit

Share via

Publish-WmsDesktop

  • Reference
Module:
MultiPoint

Shares a desktop and optionally allows remote control of the desktop.

Syntax

Publish-WmsDesktop
       [-SessionId] <UInt32>
       [-RemoteControl]
       [-MaxViewers <Int32>]
       [-Server <String>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Description

The Publish-WmsDesktop cmdlet shares the specified session desktop, which makes it viewable by other sessions. A published desktop can also optionally be remotely controlled.

Examples

Example 1: Publish a desktop

PS C:\> Publish-WmsDesktop -RemoteControl -MaxViewers 10 -SessionId 2 -TeacherName "PattiFuller"





Invitation string

This command shares the desktop of session 2 for viewing by up to 10 other sessions, and permits remote control of the desktop.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MaxViewers

Specifies the maximum number of clients that can view the published desktop.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RemoteControl

Indicates that the published desktop can be remotely controlled.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Server

Specifies the fully qualified host name of the MultiPoint Server that is the target of the command. The default is localhost.

Type:String
Aliases:ComputerName
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SessionId

Specifies the session ID of the desktop to publish.

Type:UInt32
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

UInt32

String

Outputs

Microsoft.WindowsServerSolutions.MultipointServer.PowerShell.Commands.Library.WmsDesktop