Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Publish-WmsDesktop

Last Updated: 3/8/2017

SYNOPSIS

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
Parameter Sets: (All)
Aliases: cf

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

-MaxViewers

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

Type: Int32
Parameter Sets: (All)
Aliases: 

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

-RemoteControl

Indicates that the published desktop can be remotely controlled.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
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
Parameter Sets: (All)
Aliases: ComputerName

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-SessionId

Specifies the session ID of the desktop to publish.

Type: UInt32
Parameter Sets: (All)
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-WhatIf

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

CommonParameters

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

INPUTS

OUTPUTS

string

This cmdlet returns the desktop sharing invitation string that is used to initiate viewing of the published session's desktop.

NOTES

Show-WmsDesktop

Unpublish-WmsDesktop

© 2017 Microsoft