Remove-BrokerDesktopGroup
Remove desktop groups from the system or remove them from a Remote PC catalog.
Syntax
Remove-BrokerDesktopGroup
[-InputObject] <DesktopGroup[]>
[-Force]
[-RemotePCCatalog <Catalog>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Remove-BrokerDesktopGroup
[-Force]
[-Name] <String>
[-RemotePCCatalog <Catalog>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
This cmdlet has 2 functions:
-
Remove desktop groups from the system.
-
Break Remote PC associations between desktop groups and a catalog.
The Remote PC relationships are used by Remote PC automation to determine which desktop groups a machine in a particular Remote PC catalog can be published to. The assignment policy rules belonging to those desktop groups also determines the set of users that are allowed to be assigned to machines from the catalog.
Examples
EXAMPLE 1
Remove all desktop groups with names starting with "EMEA".
Remove-BrokerDesktopGroup EMEA*
EXAMPLE 2
Remove all desktops that are currently disabled even if there are active sessions.
Get-BrokerDesktopGroup -Enabled $false | Remove-BrokerDesktopGroup -Force
EXAMPLE 3
Remove all the Remote PC desktop groups that are associated with catalog 42. Note that this only breaks the Remote PC relationships and does not delete the desktop groups.
Get-BrokerDesktopGroup -RemotePCCatalogUid 42 | Remove-BrokerDesktopGroup -RemotePCCatalog 42
Parameters
-InputObject
Specifies the desktop groups to remove.
| Type: | DesktopGroup[] |
| Position: | 2 |
| Default value: | Null |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-Name
Specifies the name of the desktop group to remove.
| Type: | String |
| Position: | 2 |
| Default value: | Null |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | True |
-Force
Remove desktop groups even if there are active sessions.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RemotePCCatalog
When this parameter is specified, Remote PC desktop groups are removed from the specified Remote PC catalog.
| Type: | Catalog |
| Position: | Named |
| Default value: | Null |
| Required: | False |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-LoggingId
Specifies the identifier of the high level operation that this cmdlet call forms a part of. Desktop Studio and Desktop Director typically create High Level Operations. PowerShell scripts can also wrap a series of cmdlet calls in a High Level Operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
CitrixCommonParameters
This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
Citrix.Broker.Admin.SDK.DesktopGroup
You can pipe desktop groups to Remove-BrokerDesktopGroup.
Outputs
None
By default, this cmdlet returns no output.
Notes
If a desktop group contains desktops when it is removed, these desktops are also removed (but the underlying broker machine remains).
A desktop group that still has active sessions cannot be removed unless the -Force switch is used.