Publish-Wms
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.
Required Parameters
Specifies the session ID of the desktop to publish.
Type: | UInt32 |
Position: | 0 |
Default value: | None |
Accept pipeline input: | True (ByPropertyName) |
Accept wildcard characters: | False |
Optional Parameters
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies the maximum number of clients that can view the published desktop.
Type: | Int32 |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Indicates that the published desktop can be remotely controlled.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
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 |
Accept pipeline input: | True (ByPropertyName) |
Accept wildcard characters: | False |
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Outputs
string
This cmdlet returns the desktop sharing invitation string that is used to initiate viewing of the published session's desktop.