Set-BrokerApplicationGroup

Last published : Oct 31, 2026
Changes properties of application groups.
Related information
about_Broker_AccessPolicy

Syntax

Set-BrokerApplicationGroup
   [-InputObject] <ApplicationGroup[]>
   [-PassThru]
   [-Description <String>]
   [-Enabled <Boolean>]
   [-RestrictToTag <String>]
   [-SessionSharingEnabled <Boolean>]
   [-SingleAppPerSession <Boolean>]
   [-UserFilterEnabled <Boolean>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
Set-BrokerApplicationGroup
   [-Name] <String>
   [-PassThru]
   [-Description <String>]
   [-Enabled <Boolean>]
   [-RestrictToTag <String>]
   [-SessionSharingEnabled <Boolean>]
   [-SingleAppPerSession <Boolean>]
   [-UserFilterEnabled <Boolean>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]

Description

The Set-BrokerApplicationGroup cmdlet changes the properties of one or more application groups. The changed properties and the new values of those properties are specified as parameters to Set-BrokerApplicationGroup.
This cmdlet cannot change the relationships of application group objects with other objects. For instance, it cannot change which users can access applications in this application group, or change which desktop groups this application group is published to. To do this, you need to remove the existing association, and then add a new association.
The following example shows how to change the desktop group that application group \$applicationGroup is associated with from \$desktopGroup1 to \$desktopGroup2:
Remove-BrokerApplicationGroup \$applicationGroup -DesktopGroup \$desktopGroup1
Add-BrokerApplicationGroup \$applicationGroup -DesktopGroup \$desktopGroup2
Application groups may not be renamed using this cmdlet. To rename an application group, use Rename-BrokerApplicationGroup.

Examples

EXAMPLE 1

Prevent new instances of applications in the 'Helpdesk Apps' application group from being launched.
Set-BrokerApplicationGroup 'Helpdesk Apps' -Enabled $false

EXAMPLE 2

Disable the user filter on every application group in the system. (Other access control mechanisms, such as access policy and user filters on individual applications, still apply.)
Get-BrokerApplicationGroup | Set-BrokerApplicationGroup -UserFilterEnabled $false

Parameters

-InputObject

Specifies the application group whose properties should be altered. Its Uid can also be substituted for the object reference.
Type: ApplicationGroup[]
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

Alters the properties of application groups whose name matches the supplied pattern.
Type: String
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True

-PassThru

This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it returns the affected record.
Type: SwitchParameter
Position: Named
Default value: False
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Description

The new description for the application group.
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Disallowed characters: All ASCII control characters

-Enabled

Whether the application group's applications should be launchable by end users.
Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-RestrictToTag

Specifies the new values of the application group's tag restriction.
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Disallowed characters: /;:#.*?=<>\|[]()"'` and all ASCII control characters

-SessionSharingEnabled

Specifies the new value of the application group's SessionSharingEnabled flag. Please note this setting and SingleAppPerSession cannot be true at the same time.
Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-SingleAppPerSession

Specifies whether each application launched from this application group starts in its own new session or can share an existing suitable session if present. Please note this setting and SessionSharingEnabled cannot be true at the same time.
Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-UserFilterEnabled

Specifies the new value of the application group's UserFilterEnabled flag.
Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
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 Set-BrokerApplication.

Outputs

None or Citrix.Broker.Admin.SDK.ApplicationGroup

This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it generates a Citrix.Broker.Admin.SDK.ApplicationGroup object.