< Back
Remove-RDSessionCollection
Post
NAME Remove-RDSessionCollection
SYNOPSIS
Removes a session collection from a Remote Desktop deployment.
SYNTAX
Remove-RDSessionCollection [-CollectionName] <String> [-ConnectionBroker <String>] [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Remove-RDSessionCollection cmdlet removes a session collection from a Remote Desktop deployment. A session collection consists of one or more
Remote Desktop Session Host (RDSession Host) servers. The RDSession Host servers remain part of the deployment. This cmdlet does not remove or
modify any of the role services installed on the servers.
PARAMETERS
-CollectionName <String>
Specifies the name of a session 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>]
Performs the action without a confirmation message.
Required? false
Position? named
Default value none
Accept pipeline input? false
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: Remove a session collection
PS C:\\> Remove-RDSessionCollection -CollectionName "Session Collection" -ConnectionBroker "RDCB.Contoso.com"
This command removes the session collection named Session Collection from the Remote Desktop deployment that has the RDConnection Broker named
RDCB.Contoso.com.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=294248
Get-RDSessionCollection
New-RDSessionCollection
SYNOPSIS
Removes a session collection from a Remote Desktop deployment.
SYNTAX
Remove-RDSessionCollection [-CollectionName] <String> [-ConnectionBroker <String>] [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Remove-RDSessionCollection cmdlet removes a session collection from a Remote Desktop deployment. A session collection consists of one or more
Remote Desktop Session Host (RDSession Host) servers. The RDSession Host servers remain part of the deployment. This cmdlet does not remove or
modify any of the role services installed on the servers.
PARAMETERS
-CollectionName <String>
Specifies the name of a session 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>]
Performs the action without a confirmation message.
Required? false
Position? named
Default value none
Accept pipeline input? false
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: Remove a session collection
PS C:\\> Remove-RDSessionCollection -CollectionName "Session Collection" -ConnectionBroker "RDCB.Contoso.com"
This command removes the session collection named Session Collection from the Remote Desktop deployment that has the RDConnection Broker named
RDCB.Contoso.com.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=294248
Get-RDSessionCollection
New-RDSessionCollection