Edit

Share via

Publish-WmsDesktop

Module:
MultiPoint Module

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

Syntax

Default (Default) 

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.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MaxViewers

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

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RemoteControl

Indicates that the published desktop can be remotely controlled.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Server

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ComputerName

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-SessionId

Specifies the session ID of the desktop to publish.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

UInt32

String

Outputs

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