Key Registry Entries Used by XenDesktop 2.0

RoyATokeshi
September 8, 2008 7:24 am

Citrix States:

Key Registry Entries Used by XenDesktop 2.0

Document ID: CTX117446   /   Created On: Jun 20, 2008   /   Updated On: Jul 10, 2008
Average Rating: not yet rated

productFamilyKey3 = "xd"; topics3 = "General"; productFamilyKey = productFamilyKey3.replace("/","--") + "/"; topics = topics3.replace("/","--") + "/";

Introduction

XenDesktop 2.0 uses a number of registry entries in various machines in the farm to broker and manage its virtual desktops. Several Desktop Delivery Controller (DDC) server components are inherited from equivalent XenApp components and so many registry entries used by these components also apply to the DDC server. This article concentrates on new and changed registry entries in the XenDesktop product.

DDC Server Controller Service Entries

A number of registry entries have been added that are used on the DDC servers by the Citrix Desktop Delivery Controller Service:

 

Entry

Type

Default Value

Description

HKLM\Software\Citrix\DesktopServer\HeartbeatPeriodMS

REG_DWORD

60000

The maximum time in milliseconds given for a VDA to send a ping to the DDC before it is automatically deregistered.

HKLM\Software\Citrix\DesktopServer\PrepareSessionConnectionTimeoutSec

REG_DWORD

None

The maximum time in seconds given for a client to connect to a desktop before the Virtual Desktop Agent (VDA) stops listening for a client connection. If this registry entry is not set, the timeout value from the Web Interface configuration is used.

HKLM\Software\Citrix\DesktopServer\MaxWorkers

REG_DWORD

10000

The maximum number of VDA ‘worker’ machines that can be registered with the DDC controller at any one time.

HKLM\SOFTWARE\Citrix\DesktopServer\InstallData\WCF_PORT

REG_SZ

None

Set on install to the user specified Windows Communication Foundation (WCF) Port. This is purely for use by later install actions (modify/repair/uninstall) and should not be manually changed.

HKLM\Software\Citrix\ADConfig\ServersGroupGuid

REG_SZ

None

The Globally Unique Identifier GUID to an Active Directory (AD) security group object which is to be used as the 'Controllers' security group instead of the default one in the farm Organizational Unit (OU).

HKLM\Software\Citrix\DesktopServer\BuildNumber

REG_DWORD

None

The installed version build number. Set up by the installer.

HKLM\Software\Citrix\DesktopServer\FarmSettingsRefreshPeriodMS

REG_DWORD

-1

The time in milliseconds between forced updates of the cached farm settings to be sent to workers, whether those settings have changed or not. A negative value means that no regular forced updates will be done, and settings will only update when they are changed.

DDC Server IMA Entries

A number of registry entries have been added or changed that are used on the DDC servers by the Independent management Architecture Service. This is not a comprehensive list of registry entries that the IMA service uses, but highlights the entries that have been added or changed for the XenDesktop product. Consult the XenApp documentation for descriptions of IMA registry entries that are common to both XenDesktop and XenApp.

 

valign="top" bgcolor="#ffffff" bordercolor="#000000">

Description

Entry

Type

Default Value

HKLM\Software\Citrix\Desktop Delivery Controller\DisableActiveSessionReconnect

REG_DWORD

0

Prevents active sessions from being reconnected by this DDC server. Queried at IMA startup. Set this value to 1 to trigger this reconnection prevention.

HKLM\Software\Citrix\Desktop Delivery Controller\SuppressResolveFailureLogging

REG_DWORD

0

Disables generation of event log entries for failures to resolve VDA machines to be used for brokered launches. Queried at IMA startup. Set this value to 1 to prevent the event log entries from being generated.

HKLM\Software\Citrix\Desktop Delivery Controller\InitialEdition

REG_SZ

‘PLT’

The XenDesktop edition value. Used by the installer and only sets the edition value if IMA is creating persistent store objects, which normally only occurs during the initial creation of the farm.

Virtual Desktop Agent Workstation Service Entries

A number of registry entries on the VDA ‘worker’ machines relate to the VDA Workstation Service

 

Entry

Type

Default Value

Description

HKLM\SOFTWARE\Citrix\VirtualDesktopAgent\StartUpRetryDelaySec

REG_DWORD

600

The minimum delay in seconds between start up attempts of the Desktop Service.

HKLM\SOFTWARE\Citrix\VirtualDesktopAgent\MaxStartUpRetryDelayDeltaSec

REG_DWORD

240

The maximum time interval in seconds between StartUpRetryDelaySec and the next actual Desktop Service start up attempt.

HKLM\SOFTWARE\Citrix\VirtualDesktopAgent\FarmGUID

REG_SZ

None

The GUID of the AD object of the farm base OU. This defines which farm the VDA machine belongs to. This will only be used if a policy based FarmGUID has not been set.

HKLM\SOFTWARE\Policies\Citrix\VirtualDesktopAgent\FarmGUID

REG_SZ

None

The GUID of the AD object of the farm base OU. This defines which farm the VDA machine belongs to.

HKLM\SOFTWARE\Citrix\VirtualDesktopAgent\InstallData\WCF_PORT

REG_SZ

None

Set on install to the user specified WCF Port. This is purely for use by later install actions (modify/repair/uninstall) and should not be manually changed.

HKLM\Software\Citrix\ADConfig\ServersGroupGuid

REG_SZ

None

The GUID of the AD security group object that is to be used to define which DDC servers are members of the farm. If this entry is not set the default ‘Controllers’ security group in the farm base OU is used.

HKLM\Software\Citrix\PortICA\Session\IdleTimer\Enabled

REG_DWORD

1

If non-zero, cause XenDesktop sessions to be automatically disconnected after a defined period of idleness

HKLM\Software\Citrix\PortICA\Session\IdleTimer\MaxIdleTime

REG_DWORD

1440

The number of seconds of continuous idle state before an automatic disconnection (if enabled)

HKLM\Software\Citrix\PortICA\Session\ConnectionTimer\Enabled

REG_DWORD

0

If non-zero, cause XenDesktop sessions to be
automatically disconnected after a defined period of being connected

HKLM\Software\Citrix\PortICA\Session\ConnectionTimer\MaxConnectionTime

REG_DWORD

1440

The number of seconds of continuous connected state before an automatic disconnection (if enabled)

HKLM\Software\Citrix\PortICA\Session\DisconnectTimer\Enabled

REG_DWORD

0

If non-zero, cause XenDesktop sessions to be automatically logged out after a defined period of being disconnected

HKLM\Software\Citrix\PortICA\Session\DisconnectTimer\MaxDisconnectTime

REG_DWORD

1440

The number of seconds of continuous disconnected state before an automatic log off (if enabled)

VDA CGP Service Entries

Only install-related entries are present for the Common Gateway Protocol (CGP) service on each VDA machine

 

Entry

Type

Default Value

Description

HKLM\Software\Citrix\Citrix CGP Server Service\Install\Location

REG_SZ

None

The absolute path where the CGP service files are installed on the VDA machine.

Other Components

There are some other components on the XenDesktop product whose registry entries are not covered by this article. These include Web Interface, XTE service, management consoles and the license server on the DDC server and also the ICA service (PortICA) and Universal Printing support on the VDA machines.


This document applies to:

  • XenDesktop 2.0 x32

 



Primary links

Custom Search

User login

Who's new

  • japhabept
  • Rullydery
  • eagenorce
  • rittaarier
  • swasseZex

Who's online

There are currently 0 users and 3 guests online.

KrissysCorner.com RuthSwensonLaw.com CreativeLizardProductions.com

DISCLAIMER:

None of this has anything to do with us, someone else is responsible for the entire thing, and we have no idea who or why. We do not know anything about it. It may be alien life forms for all we know: we haven't a clue. You cannot blame us for anything that may result from your visit. That was entirely your own personal choice, made by you of your own volition, and without our knowledge. We do not, after all, have any control over you and cannot by any stretch of the imagination be expected to accept or acknowledge, be it legally or morally, any accountability for decisions made by you on an independent basis, utilizing your own free will, and without our intervention. We are therefore in no way, shape, or form answerable to anyone for any consequences arising from the aforementioned or indeed any other actions, similar or otherwise, because it was not us that did, or did not do anything. It is not even remotely our fault, and we are in no way prepared or willing to accept any liability, not even slightly, ever. We are, in fact completely and utterly blameless, in that it is definitely not our concern, and no blame can possibly be laid at our doorstep, even if we had one, the possession of which we hereby reserve as being entirely our own free choice. The onus is not on us at all, and furthermore, never has been. The entire matter is wholly beyond our control, and completely out of our hands, each of which are washed scrupulously clean of the whole business. We are not accountable for anything at all, and we hereby categorically deny all responsibility for all that has ever, or will ever happen. Our innocence is therefore wholly beyond doubt and absolutely unimpeachable, and so cannot, under even the remotest or unlikeliest circumstances, be brought into question. By clicking either on a link on this site, clicking on a link that leads to this site, or by arriving at this site by natural or supernatural means, you are in effect accepting responsibility for the fact that it is all entirely your own fault, down to the most miniscule detail, and that you are wholly accountable for whatever outcome may arise as a consequence of the aforementioned action or actions insofar as they were undertaken personally by you on an entirely voluntary basis and without any persuasion, coercion or influence from any party or parties other than yourself. Don't come sniveling to us, we are only figments of your imagination. I also agree that if I am ever with a contributor to this website during mealtimes I agree to pay for any super-sizing of their meal, or at least a nice dessert or one of those foo-foo drinks with an umbrella or a monkey. By admitting to have seen the worthless spineless drivel on this website (also known as content)

I Agree Wholeheartedly and Without Reservation to the above. (Except maybe for that part about the monkey.)

All Your Base Are Belong To Us.

Soylent Green Is People!

Never make a bet with a Sicilian when Death is on the Line!

No. Really, I do agree.