Product Documentation

Configure and install Receiver for Windows using command-line parameters

Jan 25, 2017

Customize the Citrix Receiver installer by specifying command line options. The installer package self-extracts to the user's temp directory before launching the setup program and requires 78.8 MB of free space in the %temp% directory. The space requirement includes program files, user data, and temp directories after launching several applications.

Warning

Using Registry Editor incorrectly can cause serious problems that can require you to reinstall the operating system. Citrix cannot guarantee that problems resulting from incorrect use of Registry Editor can be solved. Use Registry Editor at your own risk. Make sure you back up the registry before you edit it.

To install Receiver for Windows from a command prompt, use the syntax:

CitrixReceiver.exe [Options]

Display usage information

Option /? or /help
Description  This switch displays usage information
Sample usage

CitrixReceiver.exe /?

CitrixReceiver.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, any USB devices which are in a suspended state when Receiver installs will not be recognized by Receiver until after the user device is restarted.
Sample usage CitrixReceiver.exe /noreboot

Silent installation

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

Enable single sign on authentication

Option /includeSSON
Description

Installs single sign-on (pass-through) authentication. This option is required for smart card single sign on.

The related option, ENABLE_SSON, is enabled when /includeSSON is on the command line. If you useADDLOCAL= to specify features and you want to install single sign on, you must also specify the valueSSON.

To enable pass-through authentication for a user device, you must install Receiver with local administrator rights from a command line that has the option /includeSSON. On the user device, you must also enable these policies located in Administrative Templates > Classic Administrative Templates (ADM) > Citrix Components > Citrix Receiver > User authentication:

  • Local user name and password
  • Enable pass-through authentication
  • Allow pass-through authentication for all ICA (might be needed, depending on the Web Interface configuration and security settings)

After the changes are completed, restart the user device. For more information, refer to How to Manually Install and Configure Citrix Receiver 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 CitrixReceiver.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. Enables single sign on when /includeSSON is also specified. This property is required for smart card single sign on. Note that users must log off and log back on to their devices after an installation with single sign-on authentication enabled. Requires administrator rights.

Sample usage CitrixReceiver.exe /ENABLE_SSON=Yes

Always-on tracing

Option /EnableTracing={true | false}
Description
This feature is enabled by default. Use this property to explicitly enable or disable the always-on tracing feature. Always-on tracing helps collect critical logs around connection time. These logs can prove userful when troubleshooting intermittent connetivity issues. The Always-on tracing policy overrides this setting.
Sample usage CitrixReceiver.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 CitrixReceiver.exe /EnableCEIP=true

Specify the installation directory

Option INSTALLDIR=<Installation Directory>
Description

Specifies the installation path, where Installation Directory is the location where most of the Citrix Receiver software will be installed. The default value is C:\Program Files\Citrix\Receiver. The following Receiver components are installed in the C:\Program Files\Citrix path: Authentication Manager, Citrix Receiver, and the Self-Service plug-in.

If you use this option and specify an Installation directory, you must install RIInstaller.msi in the installation directory\Receiver directory and the other .msi files in the installation directory.

Sample usage CitrixReceiver.exe INSTALLDIR=c:\Citrix\Test

Identify a user device to a server farm

Option CLIENT_NAME=<ClientName>
Description
Specifies the client name, where ClientName is the name used to identify the user device to the server farm. The default value is %COMPUTERNAME%
Sample usage CitrixReceiver.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 CitrixReceiver.exe DYNAMIC_NAME=Yes

Install specified components

Option ADDLOCAL=<feature... ,>
Description

Installs one or more of the specified components. When specifying multiple parameters, separate each parameter with a comma and without spaces. The names are case sensitive. If you do not specify this parameter, all components are installed by default.

Note: ReceiverInside and ICA_Client are prerequisites for all other components and must be installed.

Components include:

  • ReceiverInside – Installs the Citrix Receiver experience (required component for Receiver operation).
  • ICA_Client – Installs the standard Citrix Receiver (required component for Receiver operation).
  • WebHelper –Installs the WebHelper component. This component retrieves the ICA file from Storefront and passes it to the HDX Engine. In addition, if verifies environment parameters and shares them with Storefront (similar to ICO client detection).
  • SSON – Installs single sign on. Requires administrator rights.
  • AM – Installs the Authentication Manager.
  • SELFSERVICE – Installs the Self-Service Plug-in. The AM value must be specified on the command line and .NET 3.5 Service Pack 1 must be installed on the user device. The Self-Service Plug-in is not available for Windows Thin PC devices, which do not support .NET 3.5.
  • For information on scripting the Self-Service Plug-in (SSP), and a list of parameters available in Receiver for Windows 4.2 and later, see http://support.citrix.com/article/CTX200337.
  • The Self-Service Plug-in allows users to access virtual desktops and applications from the Receiver window or from a command line, as described in later in this section in To launch a virtual desktop or application from a command line.
  • USB – Installs USB support. Requires administrator rights.
  • DesktopViewer – Installs the Desktop Viewer.
  • Flash – Installs HDX media stream for Flash.
  • Vd3d – Enables the Windows Aero experience (for operating systems that support it).
Sample usage CitrixReceiver.exe ADDLOCAL=ReceiverInside, ICA_Client, SSON

Configuring stores not configured through Merchandising Server deliveries

Option ALLOWADDSTORE={N | S | A}
Description

Specifies whether users can add and remove stores not configured through Merchandising Server deliveries; users can enable or disable stores configured through Merchandising Server deliveries, but they cannot remove these stores or change the names or the URLs.) Defaults to S. Options include:

  • N – Never allow users to add or remove their own store.
  • S – Allow users to add or remove secure stores only (configured with HTTPS).
  • A – Allow users to add or remove both secure stores (HTTPS) and non-secure stores (HTTP). Not applicable if Citrix Receiver is installed per user.

You can also control this feature by updating the registry key HKLM\Software\[Wow6432Node\]Citrix\Dazzle\AllowAddStore.

Note: Only secure (HTTPS) stores are allowed by default and are recommended for production environments. For test environments, you can use HTTP store connections through the following configuration:

  1. Set HKLM\Software\[Wow6432Node\]Citrix\Dazzle\AllowAddStore to A to allow users to add non-secure stores.
  2. Set HKLM\Software\[Wow6432Node\]Citrix\Dazzle\AllowSavePwd to A to allow users to save their passwords for non-secure stores.
  3. To enable the addition of a store that is configured in StoreFront with a TransportType of HTTP, add to HKLM\Software\[Wow6432Node\]Citrix\AuthManager the value ConnectionSecurityMode (REG_SZ type) and set it to Any.
  4. Exit and restart Citrix Receiver.
Sample usage CitrixReceiver.exe ALLOWADDSTORE=N

Save credentials for stores locally using PNAgent protocol

Option ALLOWSAVEPWD={N | S | A}
Description

Specifies whether users can add and remove stores not configured through Merchandising Server deliveries; users can enable or disable stores configured through Merchandising Server deliveries, but they cannot remove these stores or change the names or the URLs.) Defaults to S. Options include:

  • N – Never allow users to save their passwords.
  • S – Allow users to save passwords for secure stores only (configured with HTTPS).
  • A – 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 HKLM\Software\[Wow6432Node]\Citrix\Dazzle\AllowSavePwd.

Note: The following registry key must be added manually if AllowSavePwd does not work:

  • Key for 32bit OS cilent: HKLM\Software\Citrix\AuthManager
  • Key for 64bit OS client: HKLM\Software\wow6432node\Citrix\AuthManager
  • Type: REG_SZ
  • 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 CitrixReceiver.exe ALLOWSAVEPWD=N

Select certificate

Option AM_CERTIFICATESELECTIONMODE={Prompt | SmartCardDefault | LatestExpiry}
Description

Use this option to select a certificate.The default value is Prompt, which prompts the user to choose a certificate from a list. Change this property to choose the default certificate (per the smart card provider) or the certificate with the latest expiry date. If there are no valid logon certificates, the user is notified, and given the option to use an alternate logon method if available.

You can also control this feature by updating the registry key HKCU or HKLM\Software\[Wow6432Node\]Citrix\AuthManager:CertificateSelectionMode={ Prompt | SmartCardDefault | LatestExpiry }. Values defined in HKCU take precedence over values in HKLM to best assist the user in selecting a certificate.

Sample usage CitrixReceiver.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 Receiver rather than the smart card Cryptographic Service Provider (CSP). Receiver prompts users to enter 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 CitrixReceiver.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 CitrixReceiver.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 CitrixReceiver.exe LEGACYFTAICONS=False

Enabling pre-launch

Option ENABLEPRELAUNCH={False | True}
Description

The default value is False. For information about session pre-launch, refer to Reduce application launch time.

Sample usage CitrixReceiver.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 under the programs folder to contain the shortcuts to subscribed applications. For example, to place shortcuts under Start > All Programs > Receiver, specify STARTMENUDIR=\Receiver\. Users can change the folder name or move the folder at any time.

You can also control this feature through a registry key: Create the entry REG_SZ for StartMenuDir and give it the value "\RelativePath". Location:

HKLM\Software\[Wow6432Node\]Citrix\Dazzle

HKCU\Software\Citrix\Dazzle

For applications published through XenApp 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 the creation of nested folders within the Start Menu. Applications will be displayed individually or under the root folder but not within Category sub folders defined with XenApp.

Examples

  • If client application folder is \office, UseCategoryAsStartMenuPath is true, and no StartMenuDiris specified, shortcuts are placed under Start > All Programs > Office.
  • If Client applications folder is \Office, UseCategoryAsStartMenuPath is true, and StartMenuDir is \Receiver, shortcuts are placed under Start > All Programs > Receiver > Office.

Changes made to these settings have no impact on shortcuts that are already created. To move shortcuts, you must uninstall and re-install the applications.

Sample usage CitrixReceiver.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 Citrix Receiver. 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 CitrixReceiver.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 Citrix Receiver is installed for All Users. For information about URL redirection, refer to Local App Access and its sub-topics in the XenDesktop 7 documentation.

Sample usage CitrixReceiver.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 Citrix Receiver user interface. Instead, they can access subscribed apps from the Start menu and via desktop shortcuts - known as "shortcut-only mode".

Sample usage CitrixReceiver.exe SELFSERVICEMODE=False

Specifying the directory for Desktop Shortcuts

Option DESKTOPDIR=<Directory Name>
Description

Brings all shortcuts into a single folder. CategoryPath is supported for desktop shortcuts.

Note: When using the DESKTOPDIR option, set the PutShortcutsOnDesktop key to True.

Sample usage CitrixReceiver.exe DESKTOPDIR=\Office

Upgrading from an unsupported Citrix Receiver version

Option /rcu
Description

Allows you to upgrade from an unsupported version to the latest version of Citrix Receiver.

Sample usage CitrixReceiver.exe /rcu

Display an installation complete dialog during unattended installs

For unattended installs of CitrixReceiver.exe, an Add Account dialog appears before the installation completes for a first-time user. The Add Account dialog requires that a user enter an email or server address to complete the installation. To replace the Add Account dialog with one that appears when installation completes and gives the user the option to set up an account, add the following key value to the registry keyHKCU\Software\Citrix\Receiver: EnableFTU=0.

Add that same registry key to machine-wide policies if multiple users log on to the same machine.

Note

If a common store has not been defined by the STOREx argument above, or by a Group Policy Object, then users who have not previously logged on to a computer where Citrix Receiver is installed, may see the Add Account dialog. To suppress this dialog, create a REG_DWORD value EnableFTU in the key HKLM\Software\Citrix\Receiverand set the value to 0.

Troubleshooting the installation

If there is a problem with the installation, search in the user's %TEMP%/CTXReceiverInstallLogs 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 install all components silently and specify two application stores:

CitrixReceiver.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:

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

To launch a virtual desktop or application from a command line

Citrix Receiver 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.