Configure and install using command-line parameters

Customize Citrix Workspace app installer by specifying command line options. The installer package self-extracts to the user’s temp directory before launching the setup program. The space requirement includes program files, user data, and temp directories after launching several applications.

For more information about system requirements, see System requirements.

To install Citrix Workspace app for Windows from a command prompt, use the syntax:

CitrixWorkspaceApp.exe [Options]

Workspace Updates

Option /AutoUpdateCheck = auto/manual/disabled
Description Indicates that Citrix Workspace app detects when an update is available. Auto – You are notified when an update is available (default).; Manual –You are not notified when updates are available. Check for updates manually.; Disabled – Disable auto-update
Sample usage CitrixWorkspaceApp.exe /AutoUpdateCheck = auto ; CitrixWorkspaceApp.exe /AutoUpdateCheck = manual ; CitrixWorkspaceApp.exe /AutoUpdateCheck = disabled
Option /AutoUpdateStream= LTSR/Current
Description Indicates the release of Citrix Workspace app. LTSR – indicates that the release is a Long Term Service Release ; Current – indicates that the release is the latest version of Citrix Workspace app
Sample usage CitrixWorkspaceApp.exe /AutoUpdateStream= LTSR ; CitrixWorkspaceApp.exe /AutoUpdateStream= Current
Option /DeferUpdateCount
Description Indicates the release of Citrix Workspace app. -1 – indicates that you can defer the notifications any number of times (default value=-1) ; 0 – indicates that the Remind me later option is not displayed. Any other number – indicates that the Remind me later option is displayed in that count. For example, if you set the value to 10, the Remind me later option is displayed 10 times.
Sample usage CitrixWorkspaceApp.exe /DeferUpdateCount=-1 ; CitrixWorkspaceApp.exe /DeferUpdateCount=-0 ; CitrixWorkspaceApp.exe /DeferUpdateCount=any other number
Option /AURolloutPriority
Description Indicates the period when you can stage the rollout. Fast – Update rollout happens at the beginning of the delivery period. Medium – Update rollout happens at the mid-delivery period. Slow – Update rollout happens at the end of the delivery period.
Sample usage CitrixWorkspaceApp.exe /AURolloutPriority=Fast ; CitrixWorkspaceApp.exe /AURolloutPriority=Medium ; CitrixWorkspaceApp.exe /AURolloutPriority=Slow

Enable bidirectional content redirection

Note

By default, Citrix Workspace app does not install the bidirectional content redirection components if they are already installed on the server. If you are using Citrix Virtual Apps and Desktops as a client machine, you must install Citrix Workspace app by using the /FORCE_LAA switch to install the bidirectional content redirection components. The feature, however, must be configured both on the server and the client.

Option ALLOW_BIDIRCONTENTREDIRECTION=1
Description Indicates that the bidirectional content redirection between client to host and host to the client is Enabled.
Sample usage CitrixWorkspaceApp.exe /ALLOW_BIDIRCONTENTREDIRECTION=1

Hide Settings Option

   
Option /DisableSetting
Description Suppresses Shortcuts and Reconnect option to be displayed in the Advanced Preferences sheet.
Sample usage CitrixWorkspaceApp.exe /DisableSetting=3
   
If you want both Application Display and Reconnect Options to be displayed in the Shortcuts and Reconnect Option. Enter CitrixWorkspaceApp.exe /DisableSetting=0
If you want Shortcuts and Reconnect option to be hidden in the Advanced Preferences sheet Enter CitrixWorkspaceApp.exe /DisableSetting=3
If you want Shortcuts and Reconnect option to display only Application Display Enter CitrixWorkspaceApp.exe /DisableSetting=2
If you want Shortcuts and Reconnect option to display only Reconnect Options Enter CitrixWorkspaceApp.exe /DisableSetting=1

Enable Local App Access

Option FORCE_LAA=1
Description By default, Citrix Workspace app does not install the client-end Local App Access components if the components are already installed on the server. To force the client side Local App Access components on the Citrix Workspace, use FORCE_LAA command line switch. Administrator-level privileges are required to perform these steps. For more information on Local App Access, see Local App Access in Citrix Virtual Apps and Desktops documentation.
Sample usage CitrixWorkspaceApp.exe /FORCE_LAA =1

Display usage information

Option /? or /help
Description Indicates usage information
Sample usage CitrixWorkspaceApp.exe /? ; CitrixWorkspaceApp.exe /help

Suppress reboot during UI installation

Option /noreboot
Description Suppresses reboot during UI installations. This option is not necessary for silent installs. If you suppress reboot prompts, the USB devices that are in suspended state when Citrix Workspace app installs is not recognized by Citrix Workspace until after the user device is restarted.
Sample usage CitrixWorkspaceApp.exe /noreboot

Silent installation

Option /silent
Description SDisables the error and progress dialogs to run a completely silent installation.
Sample usage CitrixWorkspaceApp.exe /silent

Enable single sign on authentication

Option /includeSSON
Description Indicates that the Citrix Workspace app will be installed with the single sign-on component. The related option, ENABLE_SSON, is enabled when /includeSSON is on the command line. If you use ADDLOCAL= to specify features and you want to install the single sign on, you must also specify the value SSON. To enable pass-through authentication for a user device, you must install Citrix Workspace app with local administrator rights from a command line that has the option /includeSSON. For more information, see How to Manually Install and Configure Citrix Workspace for Pass-Through Authentication. Note: Smart card, Kerberos and Local user name and password policies are inter-dependent. The order of configuration is important. We recommend to first disable unwanted policies, and then enable the policies you require. Carefully validate the result.
Sample usage CitrixWorkspaceApp.exe /includeSSON

Enable single sign on when /includeSSON is specified

Option ENABLE_SSON={Yes, No}
Description Enable Single sign-on when /includeSSON is specified. The default value is Yes. This property is required for smart card Single sign-on. Users must log off and log in to their devices after installing with Single sign-on authentication enabled. Requires administrator rights.
Sample usage CitrixWorkspaceApp.exe ENABLE_SSON=Yes

Always-on tracing

Option /EnableTracing={true, false}
Description By default, this feature is set to true. Use this property to enable or disable the always-on tracing feature. Always-on tracing helps to collect critical logs around the connection time. These logs can prove useful when troubleshooting intermittent connectivity issues. The Always On tracing policy overrides this setting.
Sample usage CitrixWorkspaceApp.exe /EnableTracing=true

Using the Citrix Customer Experience Improvement Program (CEIP)

Option EnableCEIP={true , false }
Description When you enable participation in the Citrix Customer Experience Improvement Program (CEIP), anonymous statistics and usage information are sent to Citrix to help Citrix improve the quality and performance of its products.
Sample usage CitrixWorkspaceApp.exe EnableCEIP=true

Specify the installation directory

Option INSTALLDIR=Installation Directory
Description Specifies the installation path where most of the Citrix Workspace app is installed. The default value is C:\Program Files\Citrix\Workspace. The following Citrix Workspace components are installed in the C:\Program Files\Citrix path: Authentication Manager ; Citrix Workspace ; Self-Service plug-in. If you use this option and specify an Installation directory, you must install RIInstaller.msi file in the \Workspace directory and the other .msi files in the installation directory.
Sample usage CitrixWorkspaceApp.exe INSTALLDIR=c:\Citrix\Test

Identify a user device

Option CLIENT_NAME=ClientName
Description Specifies the client name, where ClientName is the name used to identify the user device to the server. The default value is %COMPUTERNAME%
Sample usage CitrixWorkspaceApp.exe CLIENT_NAME=%COMPUTERNAME%.

Dynamic client name

Option ENABLE_CLIENT_NAME=Yes, No
Description The dynamic client name feature allows the client name to be the same as the computer name. When users change their computer name, the client name changes to match. Defaults to Yes. To disable dynamic client name support, set this property to No and specify a value for the CLIENT_NAME property.
Sample usage CitrixWorkspaceApp.exe ENABLE_DYNAMIC_CLIENT_NAME =Yes

Install specified components

Option ADDLOCAL=
Description alt_text
Sample usage CitrixWorkspaceapp.exe ADDLOCAL=ReceiverInside,ICA_Client,AM,SELFSERVICE,DesktopViewer,Flash,Vd3d,WebHelper,BrowserEngine, WorkspaceHub

Configure Workspace for Windows to manually add Stores

Option ENABLE_CLIENT_NAME=Yes, No
Description The dynamic client name feature allows the client name to be the same as the computer name. When users change their computer name, the client name changes to match. Defaults to Yes. To disable dynamic client name support, set this property to No and specify a value for the CLIENT_NAME property.
Sample usage CitrixWorkspaceApp.exe ENABLE_DYNAMIC_CLIENT_NAME =Yes

Save credentials for stores locally using PNAgent protocol

Option ALLOWSAVEPWD={N, S, A}
Description The default is the value specified by the PNAgent server at runtime. Specifies whether users can save the credentials for stores locally on their computers and apply only to stores using the PNAgent protocol. Defaults to S. Options include: N – Never allow users to save their passwords. S - Allow users to save passwords for both secure stores (HTTPS) and non-secure stores (HTTPS) and non-secure stores (HTTP). You can also control this feature by updating the registry key HKEY_LOCAL_MACHINE\Software[Wow6432Node]\Citrix\Dazzle\AllowSavePwd. Note: The following registry key must be added manually if AllowSavePwd does not work: 1 Key for 32 bit OS client: HKEY_LOCAL_MACHINE\Software\Citrix\AuthManager 2 Key for 64 bit OS client: HKEY_LOCAL_MACHINE\Software\wow6432node\Citrix\AuthManager 3 Type: REG_SZ 4 Value: never - never allow users to save their passwords. secureonly - allow users to save passwords for secure stores only (configured with HTTPS). always - allow users to save passwords for both secure stores (HTTPS) and non-secure stores (HTTP).
Sample usage CitrixWorkspaceApp.exe ALLOWADDSTORE=N

Select certificate

Option AM_CERTIFICATESELECTIONMODE={Prompt, SmartCardDefault, LatestExpriry }
Description alt_text
Sample usage CitrixWorkspaceApp.exe AM_CERTIFICATESELECTIONMODE=Prompt

Use CSP components to manage Smart Card PIN entry

Option AM_SMARTCARDPINENTRY=CSP
Description Use CSP components to manage Smart Card PIN entry. By default, the PIN prompts presented to users are provided by Citrix Workspace app rather than the smart card Cryptographic Service Provider (CSP). Citrix Workspace app prompts users to type a PIN when required and then passes the PIN to the smart card CSP. Specify this property to use the CSP components to manage the PIN entry, including the prompt for a PIN.
Sample usage CitrixWorkspaceApp.exe AM_SMARTCARDPINENTRY=CSP

Using Kerberos

Option ENABLE_KERBEROS={Yes , No}
Description The default value is No. Specifies whether the HDX engine should use Kerberos authentication and applies only when single sign-on (pass-through) authentication is enabled. For more information, see Configure domain pass-through authentication with Kerberos.
Sample usage CitrixWorkspaceApp.exe ENABLE_KERBEROS=No

Displaying legacy FTA icons

Option LEGACYFTAICONS={False, True}
Description Use this option to display Legacy FTA icons. The default value is False. Specifies whether or not application icons are displayed for documents that have file type associations with subscribed applications. When the argument is set to false, Windows generates icons for documents that do not have a specific icon assigned to them. The icons generated by Windows consist of a generic document icon overlaid with a smaller version of the application icon. Citrix recommends enabling this option if you plan to deliver Microsoft Office applications to users running Windows 7.
Sample usage CitrixWorkspaceApp.exe LEGACYFTAICONS=False

Enabling pre-launch

Option ENABLEPRELAUNCH={False, True}
Description The default value is False. For information about session pre-launch, see Reduce application launch time.
Sample usage CitrixWorkspaceApp.exe ENABLEPRELAUNCH=False

Specifying the directory for Start Menu shortcuts

Option STARTMENUDIR={Directory Name}
Description By default, applications appear under Start > All Programs. You can specify the relative path of the shortcuts in the programs folder. For example, to place shortcuts under Start > All Programs > Workspace, specify STARTMENUDIR=\Workspace. You can change or move the folder at any time.You can also control this feature using a registry key: Create the entry REG_SZ for StartMenuDir and give it the value “\RelativePath” Location: HKEY_LOCAL_MACHINE\Software[Wow6432Node]Citrix\Dazzle , HKEY_CURRENT_USER\Software\Citrix\Dazzle. For applications published through Citrix Virtual Apps with a Client applications folder (also referred to as a Program Neighborhood folder) specified, you can specify that the client applications folder is to be appended to the shortcuts path as follows: Create the entry REG_SZ for UseCategoryAsStartMenuPath and give it the value “true.” Use the same registry locations as noted above.Note: Windows 8/8.1 does not allow you to create nested folders within the Start menu. Applications are displayed individually or inside the root folder and not within defined Category sub folders. Examples: 1 If client application folder is \office, UseCategoryAsStartMenuPath is true, and no StartMenuDiris specified, shortcuts are placed under Start > All Programs > Office. 2 If Client applications folder is \Office, UseCategoryAsStartMenuPath is true, and StartMenuDir is \Workspace, shortcuts are placed under Start > All Programs > Workspace > Office. Changes made to these settings have no impact on shortcuts that are already created. To move shortcuts, you must uninstall and reinstall the applications
Sample usage CitrixWorkspaceApp.exe STARTMENUDIR=\Office

Specifying the Store Name

Option STOREx=”storename;http[s]://servername.domain/IISLocation/discovery;[On, Off] ; [storedescription] “[STOREy=”–”]
Description Use this option to specify the Store name. Specifies up to 10 stores to use with Workspace for Windows. Values: x and y – Integers 0 through 9.; storename – Defaults to store. This must match the name configured on the StoreFront Server.; servername.domain – The fully qualified domain name of the server hosting the store. ; IISLocation – the path to the store within IIS. The store URL must match the URL in StoreFront provisioning files. The store URLs are of the form “/Citrix/store/discovery.” To obtain the URL, export a provisioning file from StoreFront, open it in notepad and copy the URL from the Address element.; On, Off - The optional Off configuration setting enables you to deliver disabled stores, giving users the choice of whether or not they access them. When the store status is not specified, the default setting is On. storedescription – An optional description of the store, such as HR App Store.Note: In this release, it is important to include “/discovery” in the store URL for successful pass-through authentication.
Sample usage CitrixWorkspaceApp.exe STORE0=”Store;https://test.xx.com/Citrix/Store/Discovery

Enabling URL Redirection on user devices

Option ALLOW_CLIENTHOSTEDAPPSURL=1
Description Enables the URL redirection feature on user devices. Requires administrator rights. Requires that Workspace for Windows is installed for All Users. For information about URL redirection, see Local App Access and its subtopics in the Citrix Virtual Apps and Desktops documentation.
Sample usage CitrixWorkspaceApp.exe ALLOW_CLIENTHOSTEDAPPSURL=1

Enabling self-service mode

Option SELFSERVICEMODE={False , True}
Description The default value is True. When the administrator sets the SelfServiceMode flag to false, the user no longer has access to the self-service Workspace for Windows user interface. Instead, they can access subscribed apps from the Start menu and via desktop shortcuts - known as “shortcut-only mode”.
Sample usage CitrixWorkspaceApp.exe SELFSERVICEMODE=False

Specifying the directory for Desktop Shortcuts

Option DESKTOPDIR=Directory Name
Description Brings all shortcuts into a single folder. Category Path is supported for desktop shortcuts. Note: When using the DESKTOPDIR option, set the PutShortcutsOnDesktop key to True.
Sample usage CitrixWorkspaceApp.exe DESKTOPDIR=\Office

Upgrading from an unsupported Citrix Workspace app version

Note

When you upgrade Citrix Workspace app Version 13.x Enterprise or 12.x to Citrix Workspacd app Version 4.4 and later using the graphical user interface, the installer runs the Receiver cleanup utility by default.

However, the utility does not run by default when you upgrade from the command line. To upgrade from the command line, run the following command:

CitrixWorkspaceApp.exe /rcu /silent

When you upgrade Citrix Receiver for Windows from 13.x (non-Enterprise) or 4.1 to Version 4.2 or later, the /rcu switch is unnecessary and ignored.

Option /rcu
Description Allows you to upgrade from an unsupported version to the latest version of Citrix Workspace.
Sample usage CitrixWorkspaceApp.exe /rcu

Troubleshooting the installation

If there is a problem with the installation, search in the user’s %TEMP%/CTXWorkspaceInstallLogs directory for the logs with the prefix CtxInstall- or TrolleyExpress- . For example:

CtxInstall-ICAWebWrapper-20141114-134516.log

TrolleyExpress-20090807-123456.log

Examples of a command line installation

To specify the Citrix Gateway store URL:

CitrixWorkspaceApp.exe STORE0="\<StoreFriendlyName\>;[testserver](https://testserver.com) <StoreName\>;\<On/Off\>;\<StoreDescription\>"]

Note

The Citrix Gateway store URL must be the first entry in the list of configured store URLs.

To install all components silently and specify two application stores:

CitrixWorkspaceApp.exe /silent
STORE0="AppStore;https://testserver.net/Citrix/MyStore/discovery;on;HR App Store"
STORE1="BackUpAppStore;https://testserver.net/Citrix/MyBackupStore/discovery;on;Backup HR App Store"

To specify single sign-on (pass-through authentication) and add a store that points to a XenApp Services URL:

CitrixWorkspaceApp.exe / INCLUDESSON
/STORE0="PNAgent;https://testserver.net/Citrix/PNAgent/config.xml;on;MyPNAgent Site"

To launch a virtual desktop or application from a command line

Citrix Workspace app creates a stub application for each subscribed desktop or application. You can use a stub application to launch a virtual desktop or application from the command line. Stub applications are located in %appdata%\\Citrix\\SelfService. The file name for a stub application is the Display Name of the application, with the spaces removed. For example, the stub application file name for Internet Explorer is InternetExplorer.exe.