Auto Client Reconnect Fix on XenDesktop Deployments with CloudBridge for Traffic Optimization

Auto Client Reconnect Fix on XenDesktop Deployments with CloudBridge for Traffic Optimization

book

Article ID: CTX202392

calendar_today

Updated On:

Description

This fix applies only to XenDesktop deployments that utilize CloudBridge for traffic optimization. This fix enables the Auto Client Reconnect functionality of XenDesktop for deployments that utilize CloudBridge for traffic optimization. With this fix Auto Client Reconnect is used for session recovery instead of Session Reliability.

Enabling this functionality

To enable this fix, you must upgrade to Citrix Receiver for Windows 3.4 Cumulative Update 1 (limited release) and take steps at the Broker, the VDA, and the Web Interface site as follows.

What you need to do on the Broker

You must enable the following policies on the Broker:  

Session Reliability

Session Reliability Connection = Enabled ( Required)
Session Reliability Port Number = 2598 (default)
Session Reliability Timeout = 180 seconds (default)

Auto Client Reconnect

Auto Client Reconnect = Enabled ( Required)
Auto Client Reconnect Authentication = Do not require authentication (default)
Auto Client Reconnect Logging = Do not log auto reconnect events (default)

What you need to do on VDAs

In scenarios where VDAs are experiencing heavy CPU loads, processing, or network-related delays, Auto Client Reconnect might take longer to initialize and therefore time out before it succeeds. To increase the VDA’s wait time for Auto Client Reconnect to succeed, modify the following registry key:
HKEY_LOCAL_MACHINE\SOFTWARE\Citrix\XTEConfig 
Name: CgpListenerTimeout 
Type: REG_DWORD 
Data: 0-60
(wait time in seconds; default=5)

What you need to do at the Web Interface site

When you install XenDesktop, it creates the necessary Web Interface sites that are used by the deployment. The meta-installer creates the sites and adds two values that you must tweak for this new functionality to work. The settings requiring to be tweaked live in the Default.ica file, see below for details.

You must verify or set the following parameters on the Web Interface site:

  1. Open the default.ica file for the XenDesktop site where the Auto Client Reconnect functionality is enabled. Its default location is c:\InetPub\WWWRoot\Citrix\<sitename>\Conf on the Broker.

  2. Modify the following settings as follows:
    TransportReconnectEnabled=ON, default is OFF. If set to OFF, this functionality will not work.
    SessionReliabilityTTL=180*, default is 60.
    * Note (SessionReliabilityTTL): Tweak this value to match the Session Reliability Time-Out machine policy (default 180). Otherwise, Citrix Receiver and the VDA get into out of sync condition and Auto Client Reconnect will fail.

Disabling this functionality

This functionality is enabled even without the presence of this key but only works in CloudBridge deployments. To disable this functionality and revert to the previous behavior, you must set the following registry key on VDAs:
HKEY_LOCAL_MACHINE\SOFTWARE\Citrix\XTEConfig 
Name: CgpDisableBranchRepeaterSessionReliability 
Type: REG_DWORD 
Data: 0
(enabled; default); 1 (disable)

Known Issues

  • Flash Redirection: After Auto Client Reconnect completes, a black area displays in place of Flash animations. To recover from the condition, refresh or restart the browser.

  • Windows Media Redirection: After Auto Client Reconnect completes, a black area displays in place of the Windows media content. To recover from the condition, restart Windows Media Player and the video playing before disconnecting. After restarting the video, it begins playing from the start.

Additional Resources

CTX138196 - Citrix XenDesktop 7.x - Issues Fixed in This Release (VDA for Desktop OS)

Issue/Introduction

This fix enables the Auto Client Reconnect functionality of XenDesktop for deployments that utilize CloudBridge for traffic optimization.