Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-RDRemoteDesktop

Set-RDRemoteDesktop

remotedesktop.psm1

Synopsis

Changes whether to publish a Remote Desktop to a collection.

Syntax

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

Detailed 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.

Parameters

-CollectionName <String>

Specifies the name of a personal virtual desktop collection.

Aliases

None

Required?

true

Position

1

Default value

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-ConnectionBroker <String>

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.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-Force <SwitchParameter>

Performs the action without a confirmation message.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-ShowInWebAccess <Boolean>

Specifies whether to publish a Remote Desktop connection.

Aliases

None

Required?

true

Position

2

Default value

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type

Null

Notes

None

Examples

Example 1: Publish a Remote Desktop

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.

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

Online Version
Get-RDRemoteDesktop