Remove-RDSessionCollection
Removes a session collection from a Remote Desktop deployment.
Syntax
Remove-RDSessionCollection
[-CollectionName] <String>
[-ConnectionBroker <String>]
[-Force]
[-WhatIf]
[-Confirm]
[<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 (RD Session Host) servers. The RD Session Host servers remain part of the deployment. This cmdlet does not remove or modify any of the role services installed on the servers.
Examples
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 RD Connection Broker named RDCB.Contoso.com.
Parameters
-CollectionName
Specifies the name of a session 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
Performs the action without a confirmation message.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| 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