< Back
Set-RDRemoteDesktop
Post
NAME Set-RDRemoteDesktop
SYNOPSIS
Changes whether to publish a Remote Desktop to a collection.
SYNTAX
Set-RDRemoteDesktop [-CollectionName] <String> [-ShowInWebAccess] <Boolean> [-ConnectionBroker <String>] [-Force] [-Confirm] [-WhatIf]
[<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 (RDWebAccess) 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.
Required? true
Position? 1
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ConnectionBroker [<String>]
Specifies the Remote Desktop Connection Broker (RDConnection 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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-ShowInWebAccess <Boolean>
Specifies whether to publish a Remote Desktop connection.
Required? true
Position? 2
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.
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.Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Null
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 RDWeb Access. RemoteApp and Desktop Connections that the user subscribes to also display the collection.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=294264
Get-RDRemoteDesktop
SYNOPSIS
Changes whether to publish a Remote Desktop to a collection.
SYNTAX
Set-RDRemoteDesktop [-CollectionName] <String> [-ShowInWebAccess] <Boolean> [-ConnectionBroker <String>] [-Force] [-Confirm] [-WhatIf]
[<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 (RDWebAccess) 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.
Required? true
Position? 1
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ConnectionBroker [<String>]
Specifies the Remote Desktop Connection Broker (RDConnection 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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-ShowInWebAccess <Boolean>
Specifies whether to publish a Remote Desktop connection.
Required? true
Position? 2
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.
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.Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Null
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 RDWeb Access. RemoteApp and Desktop Connections that the user subscribes to also display the collection.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=294264
Get-RDRemoteDesktop