ICT-Hotlist Topic

Back to the ICT-Hotlist...

Do you want to produce a download with all the applications configured in your Citrix XenApp Farm with PowerShell?

By Johan van Soest.

Published : 2014-03-11.

Last updated : 2017-05-02.

Citrix installs the PowerShell extensions default on the XenApp servers so you do not have to download and configure them (see example 2 for a server based Excel version).
Here are the steps to run the Citrix PowerShell snapins on your client PC.

Example 1: PC based

Add-PSSnapin Citrix*
Get-PSSnapin Citrix*
Get-XAApplicationReport * -ComputerName nlaalcit01 | Export-Clixml c:\test\DownloadApps.xml

Example 2: Server Based

Check if registered Citrix Snapins are loaded on the XenApp server:

PS> Get-PSSnapin Citrix* -Registered

Name        : Citrix.Common.Commands
PSVersion   : 2.0
Description : Citrix Common Commands

Name        : Citrix.Common.GroupPolicy
PSVersion   : 2.0
Description : Citrix Group Policy Provider

Name        : Citrix.XenApp.Commands
PSVersion   : 2.0
Description : Citrix XenApp Commands

Ok, the Citrix Snapins are registered. Now you can run the following commands:

PS> Add-PSSnapin Citrix*
PS> Get-XAApplication -ComputerName nlaalcit01 | Export-Csv c:\temp\CitrixApps.csv

This will retrieve the following parameters per application:

AccessSessionConditions	CachingOption	EncryptionRequired	ProfileLocation
AccessSessionConditionsEnabled	ClientFolder	FolderPath	ProfileProgramArguments
AddToClientDesktop	ColorDepth	HideWhenDisabled	ProfileProgramName
AddToClientStartMenu	CommandLineExecutable	InstanceLimit	RunAsLeastPrivilegedUser
AlternateProfiles	ConnectionsThroughAccessGatewayAllowed	LoadBalancingApplicationCheckEnabled	SequenceNumber
AnonymousConnectionsAllowed	ContentAddress	MachineName	SslConnectionEnabled
ApplicationId	CpuPriorityLevel	MaximizedOnStartup	StartMenuFolder
ApplicationType	Description	MultipleInstancesPerUserAllowed	TitleBarHidden
AudioRequired	DisplayName	OfflineAccessAllowed	WaitOnPrinterCreation
AudioType	Enabled	OtherConnectionsAllowed	WindowType
BrowserName	EncryptionLevel	PreLaunch	WorkingDirectory

This generates the following overview when imported in Excel:

Citrix XenApp application parameters exported and shown in Microsoft Excel.

To get a limited ordered list of application information the next powershell script can be used.
This example runs on a XenApp server, grabs on the application name, description and if the application is available. The CSV file is ordered alphabetically and downloaded to the computer PC0101.

# This PowerShell script must run on a XenApp Server.
# It extracts the Application name, description and if it is enabled. The sorted file is
# downloaded to the computer PC0101 (Change it to your pc!)
# (C)Copyright 2015-2024 vanSoest.it by Johan van Soest
Add-PSSnapin Citrix*
Get-PSSnapin Citrix*
Get-XAApplicationReport * |
   Select DisplayName, Description, Enabled |
   Sort DisplayName |
   Export-Csv -Path \\PC0101\c$\test\CitrixApps.csv

You may vote your opinion about this article:

Scripts and programming examples disclaimer

Unless stated otherwise, the script sources and programming examples provided are copyrighted freeware. You may modify them, as long as a reference to the original code and hyperlink to the source page is included in the modified code and documentation. However, it is not allowed to publish (copies of) scripts and programming examples on your own site, blog, vlog, or distribute them on paper or any other medium, without prior written consent.
Many of the techniques used in these scripts, including but not limited to modifying the registry or system files and settings, impose a risk of rendering the Operating System inoperable and loss of data. Make sure you have verified full backups and the associated restore software available before running any script or programming example. Use these scripts and programming examples entirely at your own risk. All liability claims against the author in relation to material or non-material losses caused by the use, misuse or non-use of the information provided, or the use of incorrect or incomplete information, are excluded. All content is subject to change and provided without obligation.