Citrix Receiver Command Line



Single Sign-on authentication can be configured on both new and upgraded setup.

Configuring Single Sign-on on a new Citrix Receiver for Windows setup
Configuring Single Sign-on on an upgraded Citrix Receiver for Windows setup
Single Sign-on Troubleshooting and Diagnostics

To configure Single Sign-on on a new setup:


1. Enable User name and password and Domain pass-through on StoreFront or the Web Interface

For Citrix-recommended Receiver (Enterprise) installation methods, refer to Citrix eDocs - Configure and install Receiver for Windows using command-line parameters. Extract the.msi files. Run the following at command prompt: For 4.x use: CitrixReceiver.exe /extract Destinationname, e.g. Using the Command Line Interface: Open a command prompt as an administrator and change to the directory to where CitrixReceiver.exe is located. Run the following command to install Citrix Receiver for Windows with the Single Sign-on feature enabled. From Citrix Receiver, look for your user name in the top right corner. Next to it is a small arrow pointing down - click that and choose 'Refresh Apps' from the menu that appears From Citrix Receiver, click on the plus sign on the left edge of the screen to reveal available apps.

Depending on the XenApp/XenDesktop deployment, Single Sign-on authentication can be configured on StoreFront or the Web Interface using the Management Console.

  • StoreFront server: Launch StoreFront Studio, go to Store > Manage Authentication methods > enable Domain pass-through.

Note: Single Sign-on is not supported if Citrix Receiver for Windows is connected to XenApp/XenDesktop using NetScaler Gateway.

ScenarioStepsDescription
Configured on StoreFront or the Web Interface with Management ConsoleStoreFront server: Launch StoreFront Studio, go to Store > Manage Authentication methods > enable Domain pass-through.When Citrix Receiver for Windows is not configured with Single Sign-on, it automatically switches the authentication method from Domain pass-through to Username and Password, if available.
Receiver for Web IS RequiredLaunch Stores > Receiver for Websites > Manage Authentication methods > enable Domain pass-through.

When Citrix Receiver for Web is not configured to allow Domain pass-through, it automatically switches the authentication method to Username and Password, if available.

If you are launching published applications using Internet Explorer for Storeweb, enable the Single Sign-on feature as described in the section Group Policy Settings.

StoreFront IS NOT configuredIf Web Interface is configured on a XenApp server, open XenApp Services Sites > Authentication Methods > enable Pass-through.
When Citrix Receiver for Windows is not configured with Single Sign-on, it automatically switches the authentication method from Pass-through to Explicit, if available.


2. Configure XML trust services on the Delivery Controller

On XenDesktop 7 or later or XenApp 7.5 or later, run the following PowerShell command as an administrator on the Delivery Controller:

asnp Citrix*
Set-BrokerSite -TrustRequestsSentToTheXmlServicePort $True

Refer to the Knowledge Center article: Error: 'An error occurred while making the requested connection'.

Note: On XenApp 6.5, XML Service Port and Trust is enabled using the Graphical User Interface. For more information, see Configuring the Citrix XML Service Port and Trust.


3. Modify Internet Explorer settings and Install Citrix Receiver for Windows with Single Sign-on


3.1 Modify the Internet Explorer settings

Modify the Internet Explorer settings to add StoreFront URL or Web Interface URL to the list of Security Zones in Internet Options. There are two methods to modify Security Zones:

NOTE: At any time, use only one of the following methods.

Option 1
  1. Local Intranet: Open Internet Explorer > Internet Options > Security > Local Intranet, Click Sites. The Local intranet window appears.
  2. Click Advanced.
  3. Add the URL of the StoreFront or Web Interface FQDN with appropriate http or https protocol.
Option 2
  1. Trusted Sites: Open Internet Explorer > Tools > Internet Options > Security >Trusted Sites > Sites
  2. Add StoreFront or Web Interface FQDN with appropriate http or https protocol.
  3. In the Internet Options > Security tab, select Trusted Sites.
  4. Click Custom level. The Security Settings – Trusted Sites Zone window appears.
  5. From the User Authentication options, select Automatic logon with current user name and password.

Note: Automatic logon with current user name and password can be configured using Group Policy. For more details, see Managing Browser Settings with Group Policy Tools.


3.2 Install Citrix Receiver for Windows

Command
  1. Download Citrix Receiver for Windows (CitrixReceiver.exe) from Citrix Downloads.
  2. Log onto the client device with administrator privilege.
  3. You can install Citrix Receiver for Windows in two ways:
    Using the Graphical User InterfaceUsing the Command Line Interface
    1. Double-click CitrixReceiver.exe.
    2. In the Citrix Receiver Installation wizard, select Enable Single Sign-on.
    3. Click Next.
    4. After the installation is complete, log off from the client device and log on again.
    1. Open a command prompt as an administrator and change to the directory to where CitrixReceiver.exe is located.
    2. Run the following command to install Citrix Receiver for Windows with the Single Sign-on feature enabled:
      CitrixReceiver.exe /includeSSON /silent
  4. After the installation is complete, log off from the client machine and log on again.
  5. Launch the Task Manager to verify that the ssonsvr.exe process is running.

Users should now be able to log on to an existing Store (or configure a new Store) using Citrix Receiver for Windows without providing credentials.

Group policy settings

Configuration described in this section is required in two cases:

  • When access to StoreWeb using Internet Explorer (IE) is required.
  • Citrix Receiver for Windows version 4.3 or earlier.

For newer versions of Receiver (4.4 onwards) that do not require IE access, the configuration is optional


On Citrix Receiver for Windows 4.3 and Earlier:

An additional configuration is required in the Group policy settings as described below:
  • Using Citrix Receiver for Windows Group Policy template files

Add Citrix Receiver for Windows template files to the Local Group Policy Editor. For more information, see Configure Receiver with the Group Policy Object template. Be sure to use the ADM template of the same version as the Receiver on the Client.

  1. Open Local Group Policy Editor by running the gpedit.msc command. Navigate to Citrix Receiver > User authentication.
  2. Open the Local user name password policy.
  3. Select Enable pass-through authentication and Allow pass-through authentication for all ICA connections.
  4. Click Apply and OK.

Note: If the existing version of Citrix Receiver for Windows does not have the Single Sign-on component installed, upgrading to the latest version with the /includeSSON switch is not supported.

After the installation is complete, log off from the client device and log on again.

Single Sign-on Diagnostics

In Citrix Receiver for Windows Version 4.5, you can use Configuration Checker to diagnose the Single Sign-on configuration.

  1. Right-click the Citrix Receiver icon in the notification area and select Advanced Preferences > Configuration Checker.
    The Configuration Checker window appears.

  2. Select SSONChecker and click Run.
    The test runs on all the SSON checkpoints.

After the test is complete, the results are displayed for each test.

The test describes if all the configuration requirements for Single Sign-on are met.

For more information, see Using Configuration Checker to validate Single Sign-on configuration


Verify the list of Network Providers

If users face any issues with Single Sign-on, Citrix recommends that you verify the list of network providers list on the client machin e as described below:

  1. Click Start.

  2. Enter View network connections. The Network Connection window appears.

  3. Press ALT to display the menu. Click Advanced > Advanced Settings
    Advanced Settings
    window appears.

  4. Click the Provider Order tab.

  5. Move “Citrix Single Sign On” to the top of the list to change the order of network providers.

downloadWhy can't I download this file?Refresh Citrix Receiver Command Line

Use the following command line parameter:

Note: Double click installation for Receiver using individual .msi is not recommended for 4.4.x and 4.5

Install the Components:

When installing the Receiver.exe components, run the .msi files in the following order:

  1. RIInstaller.msi
  2. ICAWebWrapper.msi
  3. GenericUSB.msi
  4. DesktopViewer.msi
  5. CitrixHDXMediaStreamForFlash-ClientInstall.msi
  6. Vd3dClient.msi
  7. AuthManager.msi
  8. SSONWrapper.msi
  9. SelfServicePlugin.msi
  10. WebHelper.msi

During the execution of each of these msi packages, the following command line parameters need to specified:
REBOOT=ReallySuppress MSIDISABLERMRESTART=0 MSIRESTARTMANAGERCONTROL=0 NEED_RECEIVER=n TROLLEYINSTALL=1 ALLUSERS=1

The command to execute a msi package is as follows:

msiexec /i <path to the .msi package> REBOOT=ReallySuppress MSIDISABLERMRESTART=0 MSIRESTARTMANAGERCONTROL=0 NEED_RECEIVER=n TROLLEYINSTALL=1 ALLUSERS=1

For a non-admin user installation, the parameters are as follows:

REBOOT=ReallySuppress MSIDISABLERMRESTART=0 MSIRESTARTMANAGERCONTROL=0 NEED_RECEIVER=n TROLLEYINSTALL=1 ALLUSERS='

Note: GenericUSB and SSON are not supported for non-admin users, so no need to install GenericUSB.msi and SSONWrapper.msi for non-admin user installation.

Remove the Components:

When removing the components, remove them in the following order:

  1. SelfServicePlugin.msi
  2. SSONWrapper.msi
  3. AuthManager.msi
  4. Vd3dClient.msi
  5. CitrixHDXMediaStreamForFlash-ClientInstall.msi
  6. DesktopViewer.msi
  7. GenericUSB.msi
  8. ICAWebWrapper.msi
  9. RIInstaller.msi
  10. WebHelper.msi

Each .msi file has an Add/Remove (Control Panel on Windows XP or Windows Server 2003) or Programs and Features (Control Panel on Windows Vista, Windows 7, and Windows Server 2008) entry in the following format:

Name of packageName displayed in Add/Remove or Programs and Features
RIInstaller.msiCitrix Receiver Inside
ICAWebWrapper.msiOnline Plug-in
PNAWrapper.msiCitrix Receiver (PNA)
SSONWrapper.msiCitrix Receiver (SSON)
CitrixHDXMediaStreamForFlash-ClientInstall.msiCitrix Receiver (HDX Flash Redirection)
DesktopViewer.msiCitrix Receiver (DV)
GenericUSB.msiCitrix Receiver (USB)
Vd3d.msiCitrix Receiver (Aero)
AuthManager.msiCitrix Authentication Manager
CitrixReceiverUpdater-User.msiCitrix Receiver Updater
SelfServicePlugin.msiCitrix Single Sign-On Plug-in

Note: CitrixReceiverUpdater-user.msi is not included in Citrix Receiver from version 4.3 onwards

Change Citrix Receiver Resolution

Additional Resources

Citrix Receiver Logoff Command Line

Note: A tool has been developed that automatically removes previous installations of the Citrix Receiver
Receiver Clean-Up Utility

Citrix Xenapp Commands

Citrix Documentation - Citrix Receiver for Windows Enterprise 3.4 and 3