Edit

Set-RDRemoteDesktop

  • Reference
Module:
RemoteDesktop

Changes whether to publish a Remote Desktop to a collection.

Syntax

Set-RDRemoteDesktop
   [-CollectionName] <String>
   [-ShowInWebAccess] <Boolean>
   [-ConnectionBroker <String>]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-RDRemoteDesktop cmdlet changes whether to publish a Remote Desktop connection to a collection.

When you publish a Remote Desktop connection, the Remote Desktop Web Access (RD Web Access) server displays the Remote Desktop connection for the collection defined by the CollectionName parameter. RemoteApp and Desktop Connections that the user subscribes to also display published Remote Desktop connections.

You can publish either RemoteApps or a Remote Desktop connection to a collection, but not both. Therefore, if you publish a Remote Desktop connection by using this cmdlet, it unpublishes any published RemoteApps.

Examples

Example 1: Publish a Remote Desktop

PS C:\> Set-RDRemoteDesktop -CollectionName "Session Collection" -ShowInWebAccess $True

This command publishes a Remote Desktop to the collection named Session Collection. The ShowInWebAccess parameter has a value of $True, therefore the collection appears in RD Web Access. RemoteApp and Desktop Connections that the user subscribes to also display the collection.

Parameters

-CollectionName

Specifies the name of a personal virtual desktop collection.

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

-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

-ConnectionBroker

Specifies the Remote Desktop Connection Broker (RD Connection Broker) server for a Remote Desktop deployment. If you do not specify a value, the cmdlet uses the fully qualified domain name (FQDN) of the local computer.

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

-Force

Forces the command to run without asking for user confirmation.

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

-ShowInWebAccess

Specifies whether to publish a Remote Desktop connection.

Type:Boolean
Position:1
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

Outputs

Null