Product Documentation

Set-BrokerApplication

Oct 21, 2016

Changes the settings of an application to the value specified in the command.

Syntax

Set-BrokerApplication [-InputObject] <Application[]> [-PassThru] [-BrowserName <String>] [-ClientFolder <String>] [-CommandLineArguments <String>] [-CommandLineExecutable <String>] [-CpuPriorityLevel <CpuPriorityLevel>] [-Description <String>] [-Enabled <Boolean>] [-IconFromClient <Boolean>] [-IconUid <Int32>] [-PublishedName <String>] [-SecureCmdLineArgumentsEnabled <Boolean>] [-ShortcutAddedToDesktop <Boolean>] [-ShortcutAddedToStartMenu <Boolean>] [-StartMenuFolder <String>] [-UserFilterEnabled <Boolean>] [-Visible <Boolean>] [-WaitForPrinterCreation <Boolean>] [-WorkingDirectory <String>] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Set-BrokerApplication [-Name] <String> [-PassThru] [-BrowserName <String>] [-ClientFolder <String>] [-CommandLineArguments <String>] [-CommandLineExecutable <String>] [-CpuPriorityLevel <CpuPriorityLevel>] [-Description <String>] [-Enabled <Boolean>] [-IconFromClient <Boolean>] [-IconUid <Int32>] [-PublishedName <String>] [-SecureCmdLineArgumentsEnabled <Boolean>] [-ShortcutAddedToDesktop <Boolean>] [-ShortcutAddedToStartMenu <Boolean>] [-StartMenuFolder <String>] [-UserFilterEnabled <Boolean>] [-Visible <Boolean>] [-WaitForPrinterCreation <Boolean>] [-WorkingDirectory <String>] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

The Set-BrokerApplication cmdlet changes the value of one or more properties of an application, such as its CpuPriorityLevel or its CommandLineArguments, to the value specified in the command.

This cmdlet only lets you change the settings of the Application object, and not any of the relationships to other objects. For instance, it does not let you change which users can access this application, or change which desktop groups this application is published to. To do so, you typically need to remove the existing association, and then add a new association. The following is an example of changing the desktop group that an application is associated with from $group1 to $group2:

Remove-BrokerApplication -DesktopGroup $group1

Add-RemoveApplication -DesktopGroup $group2

You can change properties of both HostedOnDesktop and InstalledOnClient applications but it is not possible to change the ApplicationType. Also, the Name cannot be changed using this cmdlet, but can be changed with the Rename-BrokerApplication cmdlet.

Parameters

-InputObject<Application[]>

Specifies the application to modify. The Uid of the application can also be substituted for the object.

Required? true
Default Value  
Accept Pipeline Input? true (ByValue)

-Name<String>

Specifies the name of the application to be modified.

Required? true
Default Value  
Accept Pipeline Input? true (ByPropertyName)

-PassThru<SwitchParameter>

This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it returns the affected record.

Required? false
Default Value False
Accept Pipeline Input? false

-BrowserName<String>

Specifies the name of the application to modify. Note that the BrowserName cannot actually be changed in this manner. In order to modify the BrowserName of an application use the Rename-BrokerApplication cmdlet.

Required? false
Default Value  
Accept Pipeline Input? false

-ClientFolder<String>

Specifies the folder that the application belongs to as the user sees it. This is the application folder that is seen in the Citrix Online Plug-in, in Web Services, and also in the user's start menu. Subdirectories can be specified with '\' character. The following special characters are not allowed: / * ? < > | " :. Note that this property cannot be set for applications of type InstalledOnClient.

Required? false
Default Value  
Accept Pipeline Input? false

-CommandLineArguments<String>

Specifies the command-line arguments that should be used when launching the executable.

Required? false
Default Value  
Accept Pipeline Input? false

-CommandLineExecutable<String>

Specifies the name of the executable file to launch.

Required? false
Default Value  
Accept Pipeline Input? false

-CpuPriorityLevel<CpuPriorityLevel>

Specifies the CPU priority for the launched executable. Valid values are: Low, BelowNormal, Normal, AboveNormal, and High. Note that this property cannot be set for applications of type InstalledOnClient.

Required? false
Default Value  
Accept Pipeline Input? false

-Description<String>

Specifies the description of the application.

Required? false
Default Value  
Accept Pipeline Input? false

-Enabled<Boolean>

Specifies whether or not this application can be launched.

Required? false
Default Value  
Accept Pipeline Input? false

-IconFromClient<Boolean>

Specifies if the app icon should be retrieved from the application on the client. This is reserved for possible future use, and all applications of type HostedOnDesktop cannot set or change this value.

Required? false
Default Value  
Accept Pipeline Input? false

-IconUid<Int32>

Specifies which icon to use for this application. This application is visible both to the administrator (in the consoles) and also to the user. If no icon is specified, then a generic built-in application icon is used.

Required? false
Default Value  
Accept Pipeline Input? false

-PublishedName<String>

Specifies the name seen by end users who have access to this application.

Required? false
Default Value  
Accept Pipeline Input? false

-SecureCmdLineArgumentsEnabled<Boolean>

Specifies whether the command-line arguments should be secured. This is reserved for possible future use, and all applications of type HostedOnDesktop can only have this value set to true.

Required? false
Default Value  
Accept Pipeline Input? false

-ShortcutAddedToDesktop<Boolean>

Specifies whether or not a shortcut to the application should be placed on the user device.

Required? false
Default Value  
Accept Pipeline Input? false

-ShortcutAddedToStartMenu<Boolean>

Specifies whether a shortcut to the application should be placed in the user's start menu on their user device.

Required? false
Default Value  
Accept Pipeline Input? false

-StartMenuFolder<String>

Specifies the name of the start menu folder that holds the application shortcut (if any). This is only valid for the Citrix Online Plug-in. Subdirectories can be specified with '\' character. The following special characters are not allowed: / * ? < > | " :.

Required? false
Default Value  
Accept Pipeline Input? false

-UserFilterEnabled<Boolean>

Specifies whether the application's user filter is enabled or disabled. Where the user filter is enabled, the application is only visible to users who appear in the filter (either explicitly or by virtue of group membership).

Required? false
Default Value  
Accept Pipeline Input? false

-Visible<Boolean>

Specifies whether or not this application is visible to users. Note that it's possible for an application to be disabled and still visible.

Required? false
Default Value  
Accept Pipeline Input? false

-WaitForPrinterCreation<Boolean>

Specifies whether or not the session waits for the printers to be created before allowing the end-user to interact with the session. Note that this property cannot be set for applications of type InstalledOnClient.

Required? false
Default Value  
Accept Pipeline Input? false

-WorkingDirectory<String>

Specifies from which working directory the executable is launched from.

Required? false
Default Value  
Accept Pipeline Input? false

-LoggingId<Guid>

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.

Required? false
Default Value  
Accept Pipeline Input? false

-AdminAddress<String>

Specifies the address of a XenDesktop controller that the PowerShell snapin will connect to. This can be provided as a host name or an IP address.

Required? false
Default Value Localhost. Once a value is provided by any cmdlet, this value will become the default.
Accept Pipeline Input? false

Input Type

Citrix.Broker.Admin.SDK.Application, or depends on parameter You can pipe the application to be added to Set-BrokerApplication. You can also pipe some of the other parameters by name.

Return Values

None or Citrix.Broker.Admin.SDK.Application

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

Examples

-------------------------- EXAMPLE 1 --------------------------

C:\PS> Set-BrokerApplication -Name "Notepad" -Description 'Windows Notepad'

Modifies the application that has a Name of "Notepad" so that its description reads Windows Notepad.

-------------------------- EXAMPLE 2 --------------------------

C:\PS> $app = Get-BrokerApplication -BrowserName "Calculator" 
C:\PS> Set-BrokerApplication -InputObject $app -Enabled $false

First gets the application with a BrowserName of "Calculator", then modifies that application (by supplying the application object in the first position) so that it is disabled for users.