Citrix Daas SDK

Remove-BrokerApplicationGroup

August 9, 2024

Contributed by:

C C

Remove application groups from the system, or break the association between an application group and a desktop group.

Syntax

Remove-BrokerApplicationGroup
      [-InputObject] <ApplicationGroup[]>
      [-Force]
      [-DesktopGroup <DesktopGroup>]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Remove-BrokerApplicationGroup
      [-Force]
      [-Name] <String>
      [-DesktopGroup <DesktopGroup>]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

This cmdlet has 2 functions:

Break associations between application groups and desktop groups.
Remove application groups from the system.

Associating an application group with a desktop group allows the applications that are members of that application group to be launched on machines that are members of the associated desktop group. Breaking that association means that those applications may no longer be launched on those machines.

To remove an application group from the system, you must first remove all of its applications. Use the Remove-BrokerApplication cmdlet to remove an application (either to remove it from an application group, or to remove it from the system entirely).

Examples

EXAMPLE 1

Remove the association between the ‘Office’ application group and the ‘Windows10VDAs’ desktop group. The ‘Office’ applications will no longer be launchable on the machines in the ‘Windows10VDAs’ desktop group.

Remove-BrokerApplicationGroup Office -DesktopGroup Windows10VDAs
<!--NeedCopy-->

EXAMPLE 2

Remove the ‘Office’ application group from the system altogether. You must remove all applications from the application group first.

Remove-BrokerApplicationGroup Office
<!--NeedCopy-->

Parameters

-InputObject

Specifies the application groups to remove.

Type:	ApplicationGroup[]
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True (ByValue)
Accept wildcard characters:	False

-Name

Removes application groups whose name matches the given pattern.

Type:	String
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	True

-Force

When this flag is specified, an application group may be removed from the system even if its SessionSharingEnabled property is false and one of its applications is still running in some session.

Such an application group cannot by default be removed, because doing so would allow for other applications to be launched into existing sessions. Either wait until the sessions associated with the application group have exited, or use the -Force flag.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DesktopGroup

When this parameter is specified, the application groups are removed from the given desktop group. The desktop group may be specified either by its Uid or by its name.

When this parmeter is not specified, the application groups are removed from the system entirely.

Type:	DesktopGroup
Position:	Named
Default value:	None
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.ApplicationGroup

You can pipe application groups to Remove-BrokerApplicationGroup.

Outputs

None

By default, this cmdlet returns no output.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Remove-BrokerApplicationGroup

August 9, 2024

Contributed by:

C C

August 9, 2024

Contributed by:

C C

Remove-BrokerApplicationGroup

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

Parameters

-InputObject

-Name

-Force

-DesktopGroup

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

Citrix.Broker.Admin.SDK.ApplicationGroup

Outputs

None

Related Links

In this article