Product Documentation

Install Citrix Connector

May 02, 2016
Follow this sequence to install and set up Citrix Connector:
  1. Prepare for installation.
  2. Install the Citrix Connector service and console extension.
  3. Configure the Connector.
  4. Install components on master images or session machines.
  5. Install Connector policies.
  6. Install components on user devices.

The following diagram summarizes where you install components.


Prepare for installation

Before you install Citrix Connector, prepare your environment as follows.

checkmark icon

Description
 

If you recently completed first-time setup of Configuration Manager, XenApp, or XenDesktop environments, verify that you can successfully deploy applications from Configuration Manager, publish them in Citrix Studio, and view them in Receiver.

 

Identify where to install the Configuration Manager console extension. You must install it on each server or workstation that has the Microsoft System Center 2012 Configuration Manager console installed. You can install the console extension on the same server as the Connector service.

Decide where to install the Connector service:
  • Either on its own dedicated VM (domain joined) or on the Configuration Manager site server. For a production environment we recommend that you install the Connector service on a dedicated VM.
  • For Citrix environments with multiple sites, install the Connector on a dedicated VM in each site and point it to the appropriate Citrix Delivery Controller. Point each Connector to the same Configuration Manager site server.
  • To use the Connector with XenApp 6.5 Connector, you can install the two Connectors on the same or different VMs.
  The Connector installer will install .NET 4.5.2 for you if the .NET version is below 4.5. However, installing a supported version of .NET before installing the Connector will speed the Connector installation and enable you to avoid restarting the server and the Connector installer if it is on a different machine. Refer to system requirements for supported .NET versions.

In the policies of the computer where you will install the Connector service, ensure that the Do not allow storage of passwords and credentials for network authentication option is disabled. That setting is disabled by default.


Security Policy window

 

Create the service account that will run the Connector service. The Connector service account must:

  • Have the Full Administrator role with the All scope for the XenApp or XenDesktop site
  • Be a local administrator on the Citrix Delivery Controller, the SMS Provider for the Configuration Manager 2012 site, and the machine where the Connector service will be installed
  • Have "Log on as a service" rights on the computer where the Connector is installed

    The installation wizard prompts you to configure this.

  • In Configuration Manager, have all permissions on these object classes:
    • Application
    • Client Agent Settings
    • Collection
    • Configuration Item
    • Distribution Point
    • Global Condition
    • Software Update

    The built-in security role Full Administrator has permissions on all object classes. If you are using a different security role, verify that the permissions are sufficient. To view or edit those permissions, open the Configuration Manager console and go to Administration > Security.

 

Check the MaxMemoryPerShellMB setting on each Delivery Controller. The Connector requires that Citrix Delivery Controllers have a PowerShell memory limit of at least 1024 MB. The default maximum PowerShell memory per shell on Windows Server 2008 R2 does not meet the requirement. The Connector cannot operate with an insufficient memory limit.

To configure the MaxMemoryPerShellMB setting on the Delivery Controller, start PowerShell with administrator privileges and then run:

Winrm set winrm/config/winrs '@{MaxMemoryPerShellMB="1024"}'

Tip: You can also run that command from a cmd.exe window. Omit the single quotation marks.

To view the current MaxMemoryPerShellMB value:

  1. Set the working location to the Shell folder:

    Set-Location wsman:\localhost\Shell

  2. View child items:

    Get-ChildItem

  Download the Citrix Connector package (CitrixConnector_7.5_ConfigMgr.exe) and extract its contents.


Contents of extracted package

Install the Citrix Connector service and console extension

For proof-of-concept or other small deployments you can install the Connector service and console extension on the same Configuration Manager server. For production deployments, install the Connector service on a separate server and install the console extension on each server or workstation that has the Configuration Manager console. For more information about deployment scenarios, refer to Plan your deployment.

Install the Connector service and console extension

  1. Make sure that your environment meets the system requirements and then prepare the server where you are installing the Connector.
  2. Run the Connector installer: CitrixConnectorConfigMgr.exe.
  3. Follow the instructions in the installation wizard.

    If you are installing the Connector on a machine that has the Configuration Manager console, the Configuration Manager Console Extension check box is selected by default.

The Connector Configuration wizard starts when the installation is complete.

To run the Configuration wizard at any time, choose Citrix Connector 3.1 Config Wizard from the Start screen or menu. The Connector will not function until you complete the wizard.

Install the Connector console extension on additional machines

Install the Connector console extension on each server or workstation that has the Configuration Manager console.
  1. If the Configuration Manager console is open, close it.
  2. Run the Connector installer: CitrixConnectorConfigMgr.exe.
  3. Follow the instructions in the installation wizard.

    Clear the check box for Citrix Connector Service and select the check box for Configuration Manager Console Extension.

The Connector Configuration wizard starts when the installation is complete.

To run the Configuration wizard at any time, choose Citrix Connector 3.1 Config Wizard from the Start screen or menu. The Connector will not function until you complete the wizard.

Configure the Connector

The Connector Configuration wizard opens after you install the Connector. To run the Configuration wizard at any time, choose Citrix Connector 3.1 Config Wizard from the Start screen or menu.

Information needed to configure the Connector:
  • Credentials for the Connector service account used to run the Connector service.
  • The fully-qualified domain name (FQDN) for the Delivery Controller. The FQDN must include all levels (such as hostname.subdomain.domain).

    The Delivery Controller must be running the Citrix PowerShell SDK.

  • The Delivery Controller Remote PowerShell Port, if the default port (5985) is not used.
  • The FQDN for the Configuration Manager Site Server.
The Configuration wizard includes on-screen instructions that guide you through the steps. Also be aware of the following:
  • The first-time you run the Configuration wizard, the Software Installation Maintenance Window page prompts you to select a maintenance window option. After that, if there is at least one maintenance window defined, the page shows a view-only list of all maintenance windows created by this wizard and the Configuration Manager console.

    To change or add maintenance windows after initial configuration, use the Configuration Manager console.

  • To optionally change Connector task intervals, click Advanced Settings on the Settings Summary page. The Connector installation folder contains shortcuts that you can use to run the tasks as needed.

After you complete the wizard, the Connector synchronizes Configuration Manager with XenApp or XenDesktop.

We recommend that you export the configuration to a file that you can use for backup and recovery. For information, refer to Back up and recover.

Install components on master images or session machines

Use the steps in this topic to install components on the following items:
Install the following components:
  • Configuration Manager client. The Configuration Manager client coordinates with the Connector during application and software installation and updates.
  • Citrix Connector agent. The Connector agent handles application and software installation and updates.
  • Optional: Citrix deployment handler. The Citrix deployment handler is required only to deploy Citrix published applications to the Configuration Manager Application Catalog or Software Center on devices managed by Configuration Manager. The Citrix deployment handler is not needed to publish applications to Receiver on user devices.
  • Additional components for App-V and Provisioning Services, noted in the following steps.
  1. Using the Configuration Manager console, install the Configuration Manager client on master images or manually provisioned session machines. Click Assets and Compliance > Devices, select the devices, right-click, and choose Install Client. This operation can take a while and must complete before you can perform step 3.
    Tip: To manually install the client, log on to the VM for the master image or session machine, navigate to \\ConfigMgr site server\SMS_Site Code\Client and run the installer, CCMSetup.exe.

    For more information about installing the Configuration Manager client, refer to Determine the Client Installation Method to Use for Windows Computers in Configuration Manager in the Microsoft TechNet documentation.

  2. Install the Connector Agent using one of the following installers from the extracted Connector package:
    • Citrix VDA extensions\CitrixConnectorAgent_x64.msi
    • Citrix VDA extensions\ CitrixConnectorAgent_x86.msi

    If you are installing the agent on a non-server OS and the WMI-In rule is not open in the Windows firewall, the installer prompts for permission to open it. The Connector configures the rule for the Domain network location.

    To configure the rule manually: In the Windows Firewall window, click Inbound Rules, scroll to Windows Management Instrumentation (WMI-In), right-click that rule, and then choose Enable Rule. That rule enables Connector to verify whether a device is a master image.

  3. Install the Connector deployment handler using one of the following installers from the extracted Connector package:
    • Citrix Receiver extensions\CitrixDTHandler_x64.msi
    • Citrix Receiver extensions\CitrixDTHandler_x86.msi
  4. To verify installation, search for the components in Programs and Features.
  5. If you use App-V, install the App-V Client for Remote Desktop Services on Server OS images and session machines.
  6. For Provisioning Services, install the Provisioning Services agent on any vDisk images that will be shared.
  7. After you test a proof-of-concept installation, Citrix recommends that you use Configuration Manager to deploy the Connector components. For command options, see Install Connector components unattended.

Install Connector policies

The Connector notifies users about pending installations for certain types of machine catalogs. The Connector for Configuration Manager policies enable you to change the defaults for those notifications, including how far in advance to start them, their frequency, and the notification text.

Although installing the Connector policy component is optional, you will likely need to change the default settings. We recommend that you review the defaults to determine if changes are needed for your environment. For a description of the settings and their defaults, refer to Connector for Configuration Manager policy settings.

The installer is in the extracted Connector package:
  • Citrix Studio Extensions\CitrixGroupPolicyManagement_x64.msi
  • Citrix Studio Extensions\CitrixGroupPolicyManagement_x86.msi

Install the policy component on the Delivery Controller. When installation completes, you are prompted to click Finish. The component installed is Citrix Group Policy Management 2.3.0.0.

To update the settings: In Citrix Studio, click Policy and then Edit Policy. From the All Settings menu, choose Connector for Configuration Manager.

Install components on user devices

Unmanaged user devices

The only requirement for unmanaged devices is a version of Receiver supported by XenApp 7.5, 7.6, 7.7, 7.8 or XenDesktop 7.1, 7.5, 7.6, 7.7 or 7.8.

Managed user devices

A managed device is one with the Configuration Manager client installed. If your users will obtain Citrix hosted applications from the Configuration Manager Application Catalog or Software Center on managed devices, install the following components:
  • Configuration Manager client. The Configuration Manager client coordinates with the Connector during application and software installation and updates.
  • Citrix Receiver for Windows. Receiver works in the background with StoreFront to provide application icons to the user device. Users do not interact with Receiver. This feature is not available for the Enterprise edition of Receiver.
  • Citrix deployment handler. The Citrix deployment handler coordinates publishing to the Configuration Manager Application Catalog and Software Center.
  1. Using the Configuration Manager console, install the Configuration Manager client. Click Assets and Compliance > Devices, select the devices, right-click, and choose Install Client. This operation can take a while and must complete before you can perform step 3.
    Tip: To manually install the client, log on to the VM for the master image or session machine, navigate to \\ConfigMgr site server\SMS_Site Code\Client and run the installer, CCMSetup.exe.

    For more information about installing the Configuration Manager client, refer to Determine the Client Installation Method to Use for Windows Computers in Configuration Manager in the Microsoft TechNet documentation.

  2. Install Citrix Receiver for Windows.
    • For a list of supported Receivers and their authentication requirements, refer to System requirements.
    • Configure Receiver to use pass-through authentication on user devices. (Pass-through authentication is also referred to as single sign-on authentication.)

      For information, refer to the /includeSSON command-line parameter description in the Receiver for Windows documentation.

    • Install Receiver per-machine and in the all users mode on all machines.
  3. Install the Connector deployment handler using one of the following installers from the extracted Connector package:
    • Citrix Receiver extensions\CitrixDTHandler_x64.msi
    • Citrix Receiver extensions\CitrixDTHandler_x86.msi

    After you test a proof-of-concept installation, you can use Configuration Manager to deploy this component. For command line options, see Install Connector components unattended, next.

  4. To verify installation, search for the components in Programs and Features.

Install Connector components unattended

Connector agent command line options

The installer is in the extracted Connector package in the folder Citrix VDA extensions.
Action: Command:
Get help on all options CitrixConnectorAgent_x64[86].msi /help
Silently install the agent and open the WMI-IN rule in the Windows firewall CitrixConnectorAgent_x64[86].msi /openfwport /quiet
Uninstall the agent CitrixConnectorAgent_x64[86].msi /uninstall

Citrix deployment handler command line options

The installer is in the extracted Connector package in the folder Citrix Receiver extensions.
Action: Command:
Get help on all options CitrixDTHandler_x64[86].msi /help
Silently install the handler CitrixDTHandler_x64[86].msi /quiet
Uninstall the handler CitrixDTHandler_x64[86].msi /uninstall