Citrix Virtual Apps and Desktops SDK

Add-BrokerApplication

August 9, 2024

Contributed by:

Adds applications to a desktop group or application group.

Syntax

Add-BrokerApplication
   [-InputObject] <Application[]>
   [-ApplicationGroup <ApplicationGroup>]
   [-DesktopGroup <DesktopGroup>]
   [-Priority <Int32>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Add-BrokerApplication
   [-Name] <String>
   [-ApplicationGroup <ApplicationGroup>]
   [-DesktopGroup <DesktopGroup>]
   [-Priority <Int32>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

The Add-BrokerApplication cmdlet is used to associate one or more applications with an existing desktop group or application group.

There are two parameter sets for this cmdlet, allowing you to specify the application either by its BrowserName or by an array of object references. Uids can also be substituted for the object references.

See about_Broker_Desktops and about_Broker_Applications for more information.

Examples

EXAMPLE 1

Adds the application with a Name of “Notepad” to the desktop group called “Private DesktopGroup”.

Add-BrokerApplication -Name "Notepad" -DesktopGroup "Private DesktopGroup"
<!--NeedCopy-->

Parameters

-InputObject

Specifies the application to associate. Its Uid can also be substituted for the object reference.

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

-Name

Specifies the name of the application to be associated with the desktop group.

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

-ApplicationGroup

Specifies which application group this application should be associated with.

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

-DesktopGroup

Specifies which desktop group this application should be associated with. Note that applications can only be associated with desktop groups of the AppsOnly or DesktopsAndApps delivery type.

Type:	DesktopGroup
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True (ByValue)
Accept wildcard characters:	False

-Priority

Specifies the priority of the mapping between the application and desktop group where lower numbers imply higher priority with zero being highest.

If one association has a higher priority than the other, machines from that group will be selected for launching sessions until all machines are at maximum load, in maintenance mode, unregistered, or unavailable for any other reason. Only when all machines from the higher-priority group are unavailable will new connections be routed to the next lowest priority group.

If multiple associations with equal priorities are encountered, session launches will be load balanced across all machines in both groups. The least-loaded machine across the groups will be chosen.

This parameter is used only when adding an application to a desktop group. It is an error to specify a priority when adding an application to an application group.

Type:	Int32
Position:	Named
Default value:	0
Required:	False
Accept pipeline input:	True (ByPropertyName)
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.Application, or as appropriate by property name

You can pipe the application to be added to Add-BrokerApplication. You can also pipe some of the other parameters by name.

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

Add-BrokerApplication

August 9, 2024

Contributed by:

August 9, 2024

Contributed by:

Add-BrokerApplication

Syntax

Description

Examples

EXAMPLE 1

Parameters

-InputObject

-Name

-ApplicationGroup

-DesktopGroup

-Priority

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

Citrix.Broker.Admin.SDK.Application, or as appropriate by property name

Outputs

None

Related Links

In this article