You are on page 1of 67

Registry Key Entries Used by

XenDesktop 7

This article provides information on the Registry Key Entries Used by XenDesktop 7.

Page 1

Table of Contents
Active Directory Identity ..................................................................................................................... 1
Personal vDisk ..................................................................................................................................... 2
AppV ................................................................................................................................................... 3
User Profile Management................................................................................................................... 7
Delegated Administration Service ...................................................................................................... 8
Machine Creation Services ............................................................................................................... 10
Host Service ...................................................................................................................................... 11
StoreFront ......................................................................................................................................... 12
Broker Service ................................................................................................................................... 17
Citrix Director .................................................................................................................................... 54
Citrix Studio ....................................................................................................................................... 55
Virtual Desktop Agent ....................................................................................................................... 57

Active Directory Identity

FMA Registry Settings Usage (build 6.0.0.16)


Registry Settings Group:
HKLM\Software\Citrix\XDservices\ADIdentitySchema\Encryption
KeySharingSettings

Registry Settings Group:


HKLM\Software\Citrix\XDservices\ADIdentitySchema\EventLog
Policy Key: HKLM\Software\Policies\Citrix\XDservices\ADIdentitySchema\EventLog
EventLogSettings

Registry Settings Group:


HKLM\Software\Citrix\XDservices\ADIdentitySchema\DataStore\Connections
Policy Key:
HKLM\Software\Policies\Citrix\XDservices\ADIdentitySchema\DataStore\Connections
DBConnectionSettings

Registry Settings Group: HKLM\Software\Citrix\XDservices\ADIdentitySchema


Policy Key: HKLM\Software\Policies\Citrix\XDservices\ADIdentitySchema
AdIdentitySettings
R/W

Name

Type

Default

Info

Summary

StartupRetryPeriodLimit
Ms

int

600000

Milliseconds

The maximum delay


before the first retry of
a failed start-up.

StartupRetryPeriodStart
MaxMs

int

10000

Milliseconds

The maximum delay


between retries of failed
start-up attempts.

Personal vDisk

Registry Keys and Values


[HKEY_LOCAL_MACHINE\SOFTWARE\Citrix\personal vDisk\Config]
Name
Type
Data
VdiEnvironment
DWORD
VDI Environment possible values are
2 for XenDesktop
4 for VDI-in-aBox
5 for XCE
Note: This value is set by Installer and must not
be modified by Administrator.
Remind Administrator to take inventory during
InterceptShutdown
DWORD
shutdown if set to 1.
UserDiskDrive
REG_SZ
The mount point to use for storing PvD.
Note: Not used in XenDesktop
The percentage of PvD disk that should be
PercentOfPvDForApps
DWORD
allocated for apps.
EnableUserProfileRedirection DWORD
Enabling and disabling profile redirection.
Name of the User\Group allowed to do PvD
PvDResetUserGroup
REG_SZ
Reset.
PvDReservedSpaceMB
DWORD
Size reserved for non-profile and app data on
PvD disk, for example PvD image update logs,
local cache for offline plugin etc.
EnableDynamicResizeOfAppC DWORD
To enable and disable dynamic resize.
ontainer
MinimumVHDSizeMB
Minimum VHD size.

Installed Service
Name : Citrix Personal vDisk
Logon As : Local System

AppV

Registry Keys and Values

[ALL REGISTRY KEYS AND VALUES ARE CREATED BY INSTALLER AND SHOULD NOT BE
MODIFIED OR REMOVED]

1.STUDIO Specific

1.1 SnapIn Specific

1.1.1 on X86 Platform :


Key:
HKLM\Software\Microsoft\PowerShell\1\PowerShellSnapIns\$(var.SnapInName)
Value
Type
Data
"C:\Program
ApplicationBase
String
Files\Citrix\StudioAppVIntegration\SnapIn\Citrix.AppV.A
dmin.V1"
AssemblyName
String
Citrix.VirtApp.PowerShellSnapIn
Description
String
"Used For Publishing AppV 5.0 Applications"
"C:\Program
ModuleName
String
Files\Citrix\StudioAppVIntegration\SnapIn\Citrix.AppV.A
dmin.V1\Citrix.VirtApp.PowerShellSnapIn.dll"
PowerShellVersion String
"2.0"
Vendor
String
"Citrix Systems, Inc."
Version
String
"7.0.0.x"
1.1.2 on X64 platform
Same as 1.1.1 in both the 32-bit and 64-bit view of Registry

1.2 Tracing Specific

1.2.1
KEY:HKLM\SYSTEM\CurrentControlSet\Control\Citrix\Tracing\Modules\CTX_DLL_CtxAppVC
ommon
Classes
Enabled
Flags
Level
GUID

String
DWORD
DWORD
DWORD
String

""
"0"
"7"
"0"
"2759262C-2476-4B9C-910E-B5D73D3149C3"
1.2.2
KEY:HKLM\SYSTEM\CurrentControlSet\Control\Citrix\Tracing\Modules\CTX_DLL_CtxVirtAp
pSnapIn
Classes
String
""
Enabled
DWORD
"0"
Flags
DWORD
"7"
Level
DWORD
"0"
GUID
String
"72D02E9F-1DCC-47F8-B913-3BD634D33642"
3

1.2.3
KEY:HKLM\SYSTEM\CurrentControlSet\Control\Citrix\Tracing\Modules\CTX_DLL_CtxAppVS
tudio
Value
Type
Data
Classes
String
""
Enabled
DWORD
"0"
Flags
DWORD
"7"
Level
DWORD
"0"
GUID
String
"2759262C-2476-4B9C-910E-B5D73D3149C3"

2. VDA Specific

2.1 Plugin Specific

2.1.1
Key: HKLM\Software\Citrix\Virtual Desktop Agent\Plugins\VirtAppPlugin
AssemblyName
String
"PzVirtAppPlugin.dll"
ClassName
String
"Citrix.VirtApp.Vda.Plugin.VirtAppPlugin"
Active
DWORD
"1"
ReceivesNotifications DWORD
"1"
NeedCommandQueue DWORD
s
"1"

2.2 COM Specific

Default
LaunchPermission
AccessPermission
RunAs
Default
APPID

Default

Default
AppID

2.2.1
Key: HKCR\AppID\[APPID]
String
"Citrix.VirtApp.Vda.Com.AppVObject"
Binary
"<Binary Data>"
Binary
"<Binary Data>"
String
CTXAPPVCOMADMIN
2.2.2
Key:HKCR\CLSID\[APPID]
String
"Citrix.VirtApp.Vda.Com.AppVObject"
String
"[APPID]"
2.2.3
Key: HKCR\Citrix.VirtApp.Vda.Com.AppVObject
String

Data:"Citrix.VirtApp.Vda.Com.AppVObject"
2.2.4
Key: HKCR\Citrix.VirtApp.Vda.Com.AppVObject\CLSID
String
Data:"[APPID]"
2.2.5
Key5: HKLM\Software\Classes\AppID\PzVirtAppComServer.exe
String
Data:"[APPID]"

2.3 Tracing Specific

KEY:HKLM\SYSTEM\CurrentControlSet\Control\Citrix\Tracing\Modules\Ctx_DLL_VirtAppPlu
gin
Value
Type
Data
Classes
Enabled
Flags
Level
GUID

Classes
Enabled
Flags
Level
GUID

Classes
Enabled
Flags
Level
GUID

Classes
Enabled
Flags
Level
GUID

String
DWORD
DWORD
DWORD
String

""
"0"
"7"
"0"
"72E2B16B-E99A-486C-AD1E-3B52A00E48BF "
2.3.1
KEY:HKLM\SYSTEM\CurrentControlSet\Control\Citrix\Tracing\Modules\
Ctx_EXE_VirtAppCOMServer
String
""
DWORD
"0"
DWORD
"7"
DWORD
"0"
String
"8808A5A5-92EC-49B9-8727-C2301BE9B965"
2.3.2
KEY:HKLM\SYSTEM\CurrentControlSet\Control\Citrix\Tracing\Modules\
Ctx_EXE_VirtAppLauncher
String
""
DWORD
"0"
DWORD
"7"
DWORD
"0"
String
"87CBB5A6-45CE-4145-9D43-DF4205C6C632"
2.3.4
KEY:HKLM\SYSTEM\CurrentControlSet\Control\Citrix\Tracing\Modules\
CTX_DLL_CtxVirtAppPowerShellLib
String
""
DWORD
"0"
DWORD
"7"
DWORD
"0"
String
"6F2643CA-53F4-49B6-A3BC-F52DA217156F"

2.4 Logon Specific

2.4.1
KEY: HKLM\SOFTWARE\Microsoft\Windows
NT\CurrentVersion\Winlogon\SpecialAccounts\UserList
"CTXAPPVCOMADMIN
DWORD
0

Configuration Service
Registry Keys

Name

Type

Default

Info

Summary

StartupRetryPeriodLimitMs

int

600000

Milliseconds

The maximum delay


before the first retry of a
failed start-up.

StartupRetryPeriodStartMaxMs

int

10000

Milliseconds

The maximum delay


between retries of failed
start-up attempts.

Configuration Logging Service


Registry Keys

Name

Type

Default

Info

Summary

StartupRetryPeriodLimitMs

int

600000

Milliseconds

The maximum delay


before the first retry of a
failed start-up.

StartupRetryPeriodStartMaxMs

int

10000

Milliseconds

The maximum delay


between retries of failed
start-up attempts.

NameCacheRefreshDBBatchSize

int

250

Number

When refreshing one of


the AD name caches,
defines the maximum
number of expired
entries to read from the
database in a single read
operation. All entries to
be refreshed are iterated
over in batches of this
size. This value does not
relate to the maximum
number of objects
batched into a single
request when requesting
new data from AD itself.

User Profile Management


UPM Event Logging

HKLM\SYSTEM\CurrentControlSet\Services\Eventlog\Application\Citrix Profile management

1.1 UPM CDF Tracing

HKLM\SYSTEM\CurrentControlSet\Control\Citrix\Tracing\Modules\UPM_Service\2AB7D86F53B0-474f-838C-8FE3B0DCE579
HKLM\SYSTEM\CurrentControlSet\Control\Citrix\Tracing\Modules\UPM_DLL_Perfmon\9EC6B7
85-EC0A-469b-888C-FBA09AB7893E
HKLM\SYSTEM\CurrentControlSet\Control\Citrix\Tracing\Modules\UPM_Driver\1D60D94686B7-4f4f-AEE1-9E4493524D00
HKLM\SYSTEM\CurrentControlSet\Control\Citrix\Tracing\Modules\UPM_DLL_GPCSE\2DAB79C
9-208A-4560-906C-6E8042552349
HKLM\SYSTEM\CurrentControlSet\Control\Citrix\Tracing\Modules\UPM_WMI\29E1B66B7BD1-44D7-9AD6-065902662048

1.2 UPM Group Policy Extension for Folder Redirection

HKLM\SOFTWARE\Microsoft\Windows
NT\CurrentVersion\Winlogon\GPExtensions\{26F29E43-DA55-459d-A045-5FEB25F8AB15}

1.3 UPM WMI Provider for diagnostics and troubleshooting


HKLM\SOFTWARE\Citrix\VirtualDesktopAgent\Plugins\UserProfileManager

1.4 UPM diagnostics and user error messages

HKLM\SOFTWARE\Microsoft\Windows\CurrentVersion\Run\Citrix UPM UserMsg

Delegated Administration Service

FMA Registry Settings Usage (build 6.0.0.16)


Registry Settings Group: HKLM\Software\Citrix\XDservices\DAS\EventLog
Policy Key: HKLM\Software\Policies\Citrix\XDservices\DAS\EventLog
EventLogSettings

Registry Settings Group:


HKLM\Software\Citrix\XDservices\DAS\DataStore\Connections
Policy Key: HKLM\Software\Policies\Citrix\XDservices\DAS\DataStore\Connections
DBConnectionSettings

Registry Settings Group: HKLM\Software\Citrix\XDservices\DAS


Policy Key: HKLM\Software\Policies\Citrix\XDservices\DAS
DelegatedAdminSettings
R/W

Name

Type

Default

Info

Summary

StartupRetryPeriodLimitMs

int

600000

Milliseconds

The maximum delay


before the first retry
of a failed start-up.

StartupRetryPeriodStartMa
xMs

int

10000

Milliseconds

The maximum delay


between retries of
failed start-up
attempts.

HKEY_LOCAL_MACHINE\SOFTWARE\Citrix\XDservices\DAS\DataStore\Connecti
ons
ConnectionString : REG_SZ : Database connection string for the DDC datastore

Additional Registry Keys used for Installation

Important: The following keys should not be modified:

HKEY_LOCAL_MACHINE\SOFTWARE\Citrix\DelegatedAdmin\Service
ConfigTool : REG_SZ : Location of the service post installation configuration tool
InstallLocation : REG_SZ : Install location of the service

HKEY_LOCAL_MACHINE\SOFTWARE\Citrix\DelegatedAdmin\Snapin\v1
InstallLocation : REG_SZ : Install location of the snapin binaries
Additional registry keys are installed to configure the PowerShell snapin under key:

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\PowerShell\1\PowerShellSnapI
ns\Citrix.DelegatedAdmin.Admin.V1
and on 64 bit machines the in the Wow6432Node hive.
Finally a number of CDF trace modules are registered in the usual place:
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Citrix\Tracing\Modules\...

Machine Creation Services

FMA Registry Settings Usage (build 6.0.0.16)


Registry Settings Group:
HKLM\Software\Citrix\XDservices\DesktopUpdateManagerSchema\EventLog
Policy Key:
HKLM\Software\Policies\Citrix\XDservices\DesktopUpdateManagerSchema\EventLog
EventLogSettings

Registry Settings Group:


HKLM\Software\Citrix\XDservices\DesktopUpdateManagerSchema\DataStore\
Connections
Policy Key:
HKLM\Software\Policies\Citrix\XDservices\DesktopUpdateManagerSchema\DataStore\Connect
ions
DBConnectionSettings

Registry Settings Group:


HKLM\Software\Citrix\XDservices\DesktopUpdateManagerSchema

Policy Key: HKLM\Software\Policies\Citrix\XDservices\DesktopUpdateManagerSchema


MachineCreationSettings
R/W

Name

Type

Default

Info

Summary

StartupRetryPeriodLimitMs

int

600000

Milliseconds

The maximum delay


before the first retry
of a failed start-up.

StartupRetryPeriodStartMa
xMs

int

10000

Milliseconds

The maximum delay


between retries of
failed start-up
attempts.

10

Host Service

FMA Registry Settings Usage (build 6.0.0.16)


Registry Settings Group:
HKLM\Software\Citrix\XDservices\HostingUnitServiceSchema\EventLog
Policy Key: HKLM\Software\Policies\Citrix\XDservices\HostingUnitServiceSchema\EventLog
EventLogSettings

Registry Settings Group:


HKLM\Software\Citrix\XDservices\HostingUnitServiceSchema\DataStore\Conn
ections
Policy Key:
HKLM\Software\Policies\Citrix\XDservices\HostingUnitServiceSchema\DataStore\Connections
DBConnectionSettings

Registry Settings Group:


HKLM\Software\Citrix\XDservices\HostingUnitServiceSchema
Policy Key: HKLM\Software\Policies\Citrix\XDservices\HostingUnitServiceSchema
HostSettings
R/W

Name

Type

Default

Info

Summary

StartupRetryPeriodLimitMs

int

600000

Milliseconds

The maximum delay


before the first retry
of a failed start-up.

StartupRetryPeriodStartMa
xMs

int

10000

Milliseconds

The maximum delay


between retries of
failed start-up
attempts.

11

StoreFront

StoreFront 2.0 Registry Keys

All Keys and Values are initially created by the MetaInstaller.


Keys and values should not be manually modified or removed.

Name
HKLM\Software\Citrix
CertificateStoreName
ClockSkew
ConfigurationLevel

Type

Data

DeliveryServices
REG_SZ
Citrix Delivery Services
REG_SZ
00:05:00
REG_SZ
Guid

FrameworkControllerAssemblyPath REG_SZ

FrameworkControllerType
IISAssemblyPath
IISManagerType
InstallDir
DirectoryPath

AdminMscFileLocation
InstallDir
Plugins
(Default)
IsFirstUsePlugin

Full path of the folder


containing the
Framework Controller
assembly
Framework Controller
REG_SZ
type
Full path of the Citrix IIS
REG_SZ
assembly
REG_SZ
Citrix IIS Manager type
REG_SZ
Root install folder
FrameworkControllerData
Full path of the folder
REG_SZ
containing
Framework.xml
DeliveryServicesManagement
Full path of the
REG_SZ
StoreFront .msc file
loaded by MMC
Root install folder for
management
components

Notes

Used and updated


when propagating
configuration across
servers in a server
group.

Authentication
Full path of the
REG_SZ
Authentication plugin
assembly
REG_SZ
True
12

OrderingHint

Name

Parent
SupportsInitialConfigMode
Extensions
(Default)

(Default)
SupportsInitialConfigMode
(Default)

(Default)
SupportsInitialConfigMode
(Default)

ViewExtensions
(Default)

(Default)

(Default)

Type
Data
REG_DWO 0x00000014 (20)
RD
REG_SZ
REG_SZ

Root
True

Notes
Specifies the node
display order in the
Admin Console

Certificate
Full path of the
REG_SZ
Certificate extension
assembly
CitrixAGBasicExtension
Full path of the Citrix AG
REG_SZ
Basic extension
assembly
REG_SZ
True
CitrixFederationExtension
Full path of the Citrix
REG_SZ
Federation extension
assembly
ExplicitCommonExtension
Full path of the Explicit
REG_SZ
Common extension
assembly
REG_SZ
True
IntegratedWindowsExtension
REG_SZ
Full path of the
Integrated Windows
Authentication
extension assembly
Certificate
REG_SZ
Full path of the
Certificate view
extension assembly
CitrixAGBasicExtension
Full path of the Citrix AG
REG_SZ
Basic view extension
assembly
ExplicitAuthenticationExtension
Full path of the Explicit
REG_SZ
Authentication view
extension assembly
13

Name
(Default)

Beacons
(Default)
OrderingHint
Parent
(Default)
OrderingHint
Parent
SupportsInitialConfigMode
(Default)
IsEnabled

IsFirstUsePlugin
OrderingHint
Parent
WizardExtensions
(Default)

(Default)

Type
Data
IntegratedWindowsExtension
REG_SZ
Full path of the
Integrated Windows
Authentication view
extension assembly

Notes

Full path of the Beacons


plugin assembly
REG_DWO 0x0000003c (60)
Specifies the node
RD
display order in the
Admin Console
REG_SZ
Root
Gateways
Full path of the
REG_SZ
Gateways plugin
assembly
REG_DWO 0x00000032 (50)
Specifies the node
RD
display order in the
Admin Console
REG_SZ
Root
REG_SZ
True
OneTimeConfiguration
Full path of the OneREG_SZ
time Configuration
plugin assembly
Changed to False
REG_SZ
True
once initial
configuration is
completed
REG_SZ
True
REG_DWO 0x00000005 (5)
Specifies the node
RD
display order in the
Admin Console
REG_SZ
Root
REG_SZ

Authentication
Full path of the
REG_SZ
Authentication plugin
assembly
Roaming
Full path of the
REG_SZ
assembly that creates
14

Name

Type

Data
the Roaming service
Authentication

DependentUpon

REG_SZ

(Default)

Stores
Full path of the Stores
REG_SZ
plugin assembly

Receiver for Web


(Default)
OrderingHint
Parent
SupportsInitialConfigMode
Extensions
(Default)
ViewExtensions
(Default)
Server Group
(Default)
OrderingHint
Parent
Stores
(Default)
IsFirstUsePlugin
OrderingHint
Parent
SupportsInitialConfigMode
Extensions
(Default)

Notes
Denotes a
dependency from
this extension to the
named extension

Full path of the Receiver


for Web plugin
assembly
REG_DWO 0x00000028 (40)
Specifies the node
RD
display order in the
Admin Console
REG_SZ
Root
REG_SZ
True
REG_SZ

REG_SZ

(value not set)

REG_SZ

(value not set)

Full path of the Server


Group plugin assembly
REG_DWO 0x0000000a (10)
Specifies the node
RD
display order in the
Admin Console
REG_SZ
Root
REG_SZ

Full path of the Stores


plugin assembly
REG_SZ
True
REG_DWO 0x0000001e (30)
RD
REG_SZ

REG_SZ
REG_SZ

Root
True

Specifies the node


display order in the
Admin Console

LegacySupport
Full path of the Legacy
REG_SZ
Support extension
assembly
15

Name
SupportsInitialConfigMode
(Default)
SupportsInitialConfigMode
ViewExtensions
(Default)

(Default)
WizardExtensions
(Default)
SupportsInitialConfigMode
(Default)

Type
Data
REG_SZ True
Roaming
REG_SZ Full path of the Roaming
extension assembly
REG_SZ True

Notes

LegacySupport
REG_SZ Full path of the Legacy
Support view extension
assembly
Roaming
REG_SZ Full path of the Roaming The same assembly
extension assembly
provides all Roaming
extensions
ReceiverForWeb
REG_SZ Full path of the Receiver
for Web plugin
assembly
REG_SZ True
Roaming
REG_SZ Full path of the Roaming The same assembly
extension assembly
provides all Roaming
extensions

StoreFront / XenDesktop side-by-side deployment


HKLM\Software\Citrix

XenDesktopSideBySide

DeliveryServicesManagement
REG_DWO A value greater than
This value is written
RD
zero indicates a side-by- by XenDesktop to tell
side deployment
StoreFront that it is in
a side-by-side
deployment

16

Broker Service
Following registry value types are being used in the tables:

Int Represents a whole 32bit number. Registry value type is REG_DWORD.

String Represents a string. Registry value type is REG_SZ.

Bool Boolean value, represents true or false. Registry value type is REG_DWORD. 0
is interpreted as a False, while any other value is interpreted as a True statement.

Long - Represents a whole 64bit number. Registry value type is REG_QWORD.

DateTime Represents a .NET DateTime format. Registry value type is REG_SZ. Powershell
cmdlet Get-Date followed by the input string can be used to translate a DateTime
structure to human readable format.

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

17

DesktopServer
ControllerSettings
Name
ControllerStartupRetryPeriodLimitMs

Type

Default

int

600000 Milliseconds The maximum


delay before the
first retry of a
failed controller
infrastructure
start-up.
10000 Milliseconds The maximum
delay between
retries of failed
controller
infrastructure
start-up attempts.

ControllerStartupRetryPeriodStartMaxMs int

CoreSettings

Name

AllowMultipleRemotePCAssign
ments

Type
bool

Default
TRUE

Info

Info

Description

Description
Controls whether to permit
multiple automated user
assignments to RemotePC
machines.

18

Name

Type

AutoHideNonContactableSessio
ns

bool

BrokerStartupRetryPeriodLimit
Ms

int

BrokerStartupRetryPeriodStart
MaxMs

int

DisableActiveSessionReconnect

bool

DisablePerformanceCounters

bool

Default

Info

Description

TRUE

Broker Service
automatically hides
sessions on noncontactable VDAs when
looking for shared desktop
or app sessions to which to
reconnect; this allows
brokering of new sessions
when existing sessions are
present but which cannot
be used, for example due to
hypervisor failure. Where
hidden sessions are still
viable after recovery of the
hypervisor they must be
explicitly un-hidden by use
of the SDK before the user
can reconnect to them
using XenDesktop.
600000 Millisecond The maximum delay before
s
the first retry of a failed
broker component start-up.
10000 Millisecond The maximum delay
s
between retries of failed
broker component start-up
attempts.
FALSE
Indicates whether the
ability to connect to an
active desktop session from
a different endpoint is
disabled. By default it is
possible to connect to an
active session from a
different endpoint device
without first disconnecting
the session from the
original endpoint.
FALSE
Indicates if the
maintenance of Windows
performance counters by
the broker service should
be disabled.
19

Name

Type

Default

Info

Description
Additional time which may
be added to
MaxTimeForPrepareSecs to
extend the timeout should
the target machine need
spun up as part of a session
launch.
Threshold for number of
free sessions that is
checked after a session
terminates, at or below
which the effective load
index of the machine is
immediately recalculated
using the new session
count. This additional
evaluation maintains the
figures used for load
balancing in a more timely
fashion as the machine
approaches its configured
session limit.

ExtraSpinUpTimeSecs

int

120

Seconds
Minimum=
30

FreeSessionThresholdForLoadEv
aluation

int

20

Minimum=
0

This setting is only


applicable to multi-session
machines.

20

Name
HeartbeatPeriodMs

Type
int

Default

Info

Description

600000 Millisecond Controls both the interval


s
and timeouts used for the
keep-alive 'pings' from the
VDA.
This value is sent from the
XDC to VDA and causes the
VDA to ping the XDC at an
interval half that of the
time specified by this
setting. By default the XDC
will consider contact to
have been lost, and discard
the VDA's registration, if no
ping is received within the
full time specified (i.e. the
timeout is double the ping
interval).
This setting is dynamic, that
is, changing it immediately
alters both the active ping
interval for all VDAs and the
maximum interval enforced
by the XDC.

LaunchLicenseCheckPeriodSec

int

30

Seconds

The maximum period over


which no ping is received
before contact is
considered to have been
lost can be controlled
independently of the VDA
ping interval itself using the
MaxHeartbeatIntervalMs
setting.
The time between checks
that the launching XDC
performs to allow
ownership of the license for
a new session to be handed
over to the central license
mechanism.
21

Name

Type

Default
5

Info

Description

Seconds
Minimum=
0

Period after which users of


the XML service are hinted
to retry launches that are
delayed due to
circumstances such as VMs
needing to be started to
satisfy the launch.
The directory in the file
system where the policy
engine will write the cache
file that holds cached
information from the
license server.
Period during which new
brokering requests are
inhibited to a machine
following a failed launch
(applicable to shared
desktops only).
Maximum number of
concurrent registration
hardening operations on
machine registrations that
the Registration Hardening
site service will perform.
Maximum time to wait for
session disconnect to occur
after disconnect request
issued.

LaunchRetryPeriodSec

int

LicensingCacheFileLocation

string

MachineSinBinStayTimeSecs

int

60

Seconds
Minimum=
0

MaxConcurrentRegistrationUpg
rades

int

Minimum=
1

MaxDisconnectWaitTimeSecs

int

10

Seconds
Minimum=
0

22

Name
MaxHeartbeatIntervalMs

Type
int

Default
-1

Info

Description

Millisecond
s
Minimum=1

Defines the maximum


period between receipt of
two pings from a VDA by
the XDC before contact is
considered to have been
lost and the VDA's
registration discarded. By
default, where this setting
is not specified, the value of
the HeartbeatPeriodMs
setting is used.
If specified, this value must
be at least half that of the
current HeartbeatPeriodMs
value, otherwise the
HeartbeatPeriodMs value
overrides this setting.

MaxLogoffWaitTimeSecs

int

10

MaxPendingSessions

int

1024

Seconds
Minimum=
0

This setting does not


change the frequency at
which a VDA sends out
pings to a XDC.
Maximum time to wait for
session logoff to occur after
logoff request issued.
Specifies the maximum
number of concurrent
pending connections to a
single WCF service endpoint
of the broker service.

23

Name

Type

Default

Info

Description
Maximum time within
which the registration
sequence for a single
machine must complete.
This refers to both
immediate hard
registrations, and soft to
hard registration
transitions. If the
registration fails to
complete within this time
then the machine's partial
registration is discarded by
the broker.
Used for logon ticket
lifetime, VDA listening
timeout, and deadline
imposed by the broker for
evidence of client
connection.
A deadline imposed by the
broker for launch preamble
ahead of the
PrepareSession call to the
VDA. Following successful
PrepareSession, the
MaxSessionEstablishmentTi
meSecs setting will be
applied to replace this
initial timeout.
The limit for the number of
registered VDAs that the
controller will accept.

MaxRegistrationCompletionTim
eSecs

int

600

Seconds
Minimum=
1

MaxSessionEstablishmentTimeS
ecs

int

200

Seconds
Minimum=
10

MaxTimeForPrepareSecs

int

60

Seconds
Minimum=
5

MaxWorkers

int

10000

24

Name
MinHeartbeatPeriodMs

Type
int

Default
30000

Info

Description

Millisecond
s
Minimum=
0
Maximum=
3600000

Defines the minimum


period between two ping
messages sent from the
VDA to the XDC. This setting
is only used if both XDC and
VDA are from the
XenDesktop 6 release or
later where the ping
mechanism also relays load
data.
Note that because the ping
mechanism also relays state
information to the XDC,
when a state update is
required, an immediate
ping is sent even where the
minimum period has not
elapsed since the previous
ping.

MinimumAcceptableVdaMajorV
ersion

int

The period itself is sent


from XDC to VDA as part of
the ping mechanism.
The earliest major version
of VDA install that is
compatible with the XDC.

25

Name

Type

Default

Info

Description
Minimum interval between
accurate recounts by a
broker of the number of
machines that are
registered with it. This
interval is designed to
prevent a broker that is at
or close to its registration
limit from flooding the
database server with work
in the registration storm
that could result if another
broker in the site should
fail. If this value is set to
zero then the broker will
perform accurate
registration counts as
required with no timebased restrictions; this is
not recommended
however.
Period to limit the rate at
which VDAs can send status
updates to the XDCs.

MinRegistrationRecountInterval
Secs

int

15

Seconds
Minimum=
0

MinVdaStatusUpdatePeriodMs

int

1000

Millisecond
s
Minimum=
0

26

Name
NonContactableSessionGracePe
riodSecs

Type
int

Default
30

Info

Description

Seconds
Minimum=
0

Grace period after which a


session would otherwise be
considered non-contactable
before automatic session
hiding during reconnect can
occur. The grace period
prevents transient failures
from causing sessions to be
hidden if a reconnect
should occur just after the
failure.

ProtectedSessionReconnectSecs

int

15

Seconds
Minimum=
0

SettleTimeForVdaStatusUpdate
Ms

int

1000

Millisecond
s
Minimum=
0

The grace period does not


apply to sessions on
managed machines where
contact has also been lost
with the hypervisor. Losing
contact with both the VDA
and its hypervisor causes
immediate session hiding
during reconnect.
Grace period after a session
launch request (for
reconnect/steal) during
which a session deletion or
disconnect event does not
cause the pending launch
request to be cancelled.
This ensures the
subsequently created
session is correctly
associated with the original
launch request.
Length of time VDAs are
told to delay before sending
status updates to the XDC.
This delay allows multiple
status changes to be
collected into one status
update notification.

27

Name

Type

Default

SiteDynamicDataRefreshPeriod
Ms

int

15000

SupportMultipleForest

bool

FALSE

TestVdaCommunicationsTimeou int
tSecs

Info

Description

Millisecond
s
Minimum=
0

Period after which site data


that changes in the
database is noticed by the
XDCs.
Allows the XDC to accept
registrations from VDAs in a
different Active Directory
forest to that containing the
XDC itself. In this situation
the VDA must be
authenticated using NTLM
rather than the more
secure Kerberos protocol,
thus this feature is disabled
by default.
The timeout when verifying
the connection between
the broker and a VDA
during a registration
request.

Seconds
Minimum=
1

28

Name
UpdateLoadIndexThreshold

Type
int

Default
500

Info

Description

Minimum=
0
Maximum=
10000

Defines the maximum


allowed change within an
individual load rule index's
value before the VDA sends
updated load data to the
XDC. The load data is sent
using the ping mechanism,
thus changes to the load on
the VDA machine may
cause pings to be sent more
frequently than the interval
specified by the
HeartbeatPeriodMs setting.
Even if this update
threshold is exceeded,
updated load data is not
sent if the minimum period
since the previous ping as
specified by the
MinHeartbeatPeriodMs
setting has not yet elapsed.

UseIPAddressFromWcf

bool

TRUE

UserDrivenResetTimeoutMs

int

30000

WIRetryIntervalDuringRegistrati
onStateChangeSec

int

30

Millisecond
s
Minimum=
0
Seconds
Minimum=
0

The threshold value itself is


sent from XDC to VDA as
part of the ping mechanism.
Indicates that the XDC
should use the IP address
from the WCF connection
rather than find the IP
address from DNS or WINS.
How long to allow for a
user-driven reset power-off
action to complete (success
or fail).
Interval between WI retries
used during transient
registration state changes
where the VDA is unable to
process a launch request.

29

Name
WIRetryIntervalDuringSessionSt
ateChangeSec

Type
int

WorkerSettingsAssessmentMinu int
tes

Default
2

Info

Description

Seconds
Minimum=
0

Interval between WI retries


used during transient
session state changes
where the VDA is unable to
process a launch request.
This is only used for short
periods, and does not apply
to lengthy state changes
related to VM start-up etc.
Number of minutes
between checks on
whether a machine's policy
settings are out of date and
need to be refreshed.

90

HostingManagementSettings
Name
CompletedActionRetentionPeri
odSec

Type
int

Default
3600

HostingStartupRetryPeriodLimit int
Ms

600000

HostingStartupRetryPeriodStart int
MaxMs

10000

HypervisorConnectionPollPerio
dSec

30

int

Info

Description

Seconds

How long a completed


power action is retained in
the database before being
purged.
Milliseconds The maximum delay
before the first retry of a
failed hosting
management component
start-up.
Milliseconds The maximum delay
between retries of failed
hosting management
component start-up
attempts.
Seconds
The period at which the
broker service polls the
Citrix Hosting Unit Service
to detect possible changes
in the configuration of the
hypervisor connections in
use.

30

Name

Type

Default

Info

MachineRecreationSinBinMinut int
es

20

Minutes

MachineStartSinBinSeconds

int

300

Seconds

MaxFailedRegistrationsAllowed

int

MaxRegistrationDelayMin

int

20

Minutes

Description
How long the broker
should 'sin bin' a VM that
is being re-created,
preventing it from being
selected in brokering or
otherwise started
automatically by power
management automation.
This state is cleared upon
completion of VM recreation.
How long a machine that
fails to start should remain
in a 'sin bin' that prevents
it from being selected to to
automatically started
again.
How many times a VM can
fail to register before we
put it into maintenance
mode. A negative value
means that we never
automatically put a VM
into maintenance mode.
How long to wait in
minutes after a VM is
powered on before a
failure to receive a
registration from the VM is
deemed a problem.
This setting is also used in
combination with the
RebootSchedule/MaxShut
downDelayMin setting to
define the maximum
allowed time for a
machine (either physical or
a VM) to successfully
reboot during reboot
schedule processing.

31

Name

Type

Default

Info

MaxTimeBeforeStuckOnBootFa
ultSecs

int

300

Seconds

MaxTimeBeforeUnregisteredFa
ultSecs

int

600

Seconds

PvdImageUpdateTimeoutMins

int

2880

Minutes

Description
How long to wait in
seconds after a machine
started but did not receive
any notification from the
HCL that the VM tools are
running. After this timeout
a machine's fault state
would be set to
StuckOnBoot.
How long to wait in
seconds after a machine
started but remains
unregistered with the
Broker (with or without
attempting to register).
After this timeout a
machine's fault state
would be set to
Unregistered.
How long a machine that
fails to register after
starting the PVD image
update process should be
allowed to remain in the
updating state before the
PVD state is forcibly set
back to "None"; setting the
state back to "None" is a
fall-back action to allow
another PVD machine on
the same hypervisor
connection to try to
update its image in the
case that the update
process breaks registration
(the number of machines
on a hypervisor connection
allowed to do an image
update being separately
throttled).

32

Name
StarvationBoostPeriodSec

Type
int

Default
600

Info
Seconds

Description
The period between
automatic power action
boosting to avoid low
priority actions being
always pre-empted by
higher priority actions.

33

DesktopServer\IdleSessions
IdleSessionsSettings
Name

Type

MaxIdleSessionToTerminatePercent int

MaxRetriesPerSession

int

MaxSessionOperationWaitTimeSecs int

SinBinDurationSecs

int

Default

Info

Description

Minimum=1 Maximum number of


Maximum=100 sessions to terminate
when load threshold on
the machine and
desktop group are hit.
3 Minimum=1 Maximum time a
logoff/disconnect
operation is retried
before the session is
put into a sin bin.
30 Minimum=30 Maximum time a
logoff/disconnect
operation is to be
performed in for the
list of sessions on each
worker.
180
Seconds
Maximum time a
Minimum=60 session is put into sin
bin when a
logoff/disconnect
performed on it does
not happen with the
specified time and
maximum retries.

XmsSettings
Name

Type

Default

EnableXmlServiceSidEnumeration

bool

FALSE

UseNetworkLogon

bool

TRUE

Info

Description
Enables XML Service
SID Enumeration on a
per server basis.
Indicates that the
logon form used to
validate user
credentials is a 'local
logon' or a 'network
logon'.
34

Name

Type

XmlListeners

int

XmlServicesEnableNonSsl

bool

XmlServicesEnableSsl

bool

XmlServicesPort

int

XmlServicesSslPort

int

XmlServicesTargetAddress

string

Default

Info

Description

500

Minimum=1
The maximum
Maximum=1000 number of requests
that the XML service
will process
concurrently. If more
requests than this
number are
outstanding, the
additional requests
are queued until
processing of one or
more existing
requests completes.
The Broker service
must be restarted for
it recognise a change
to this value.
TRUE
Enables listening for
http requests.
TRUE
Enables listening for
https requests.
80
The port that the XML
service will listen on
for http requests.
443
The port that the XML
service will listen on
for https requests.
The portion of the
URL to define the host
address which is used
by the XML services as
its own target URL. If
no value if specified
then the host address
is defaulted to '+'.

35

Name

Type

Default

Info

XmlStaIdentity

string

XmlStaRefreshableTicket
LifetimeInSeconds

int

500

Seconds

XmlStaTicketLifetimeInSeconds

int

100

Seconds

XmlWpnbrRequestTimeoutMs

int

20000

Milliseconds

XmsStartupRetryPeriodLimitMs

int

600000

Milliseconds

10000

Milliseconds

XmsStartupRetryPeriodStartMaxMs int

Description
Must be defined for
the STA to function.
Must contain only
upper case letter and
digit characters. Must
be less than 32
characters long.
Usually of the form
'STAXXXXXXXX' where
XXXXXX is a
hexadecimal number.
The time for which a
refreshable ticket
remains live (without
being refreshed).
The time for which a
non-refreshable ticket
remains live.
How long to wait in
milliseconds before a
Wpnbr request is
timed out.
The maximum delay
before the first retry
of a failed XML
services start-up.
The maximum delay
between retries of
failed XML services
start-up attempts.

36

DesktopServer\RebootSchedule
RebootScheduleSettings
Name

Type Default Info

Description

MaxActionThreads

int

Minimum=1
Maximum=5
0

MaxPvDPrepareTimeMins

int

60

Minutes
Minimum=1
Maximum=1
80

MaxShutdownDelayMin

int

10

Minutes
Minimum=1
Maximum=6
0

Maximum number of threads


allowed to be active
concurrently in the Reboot
Cycle Manager site service to
perform actions requiring
synchronous CBP
communication with VDAs.
These actions are sending
reboot warning notification
messages, and requesting the
reboot of physical machines.
Maximum time allowed for a
PvD prepare operation to
complete during a reboot
cycle started for PvD image
rollout purposes. If a prepare
operation does not complete
within this time it is deemed
to have failed.
Maximum time allowed for a
VM to shutdown during
reboot cycle processing before
the reboot of the VM is
deemed to have failed.

RebootCycleDataLifetimeHours int

336

Hours
Minimum=0

This setting is also used in


combination with the
MaxRegistrationDelayMin
setting to define the maximum
allowed time for a machine
(either physical or VM) to
successfully reboot during
reboot schedule processing.
Time for which data for
completed/cancelled/abandon
ed reboot cycles is retained
before being purged.
37

ISCMSettings

Name

Type

Default

Info

InterServiceConfigRefreshPeriodMs int

120000

Milliseconds

MaxMsInterService
ConnectionRetryPeriod

60000

Milliseconds

int

Description
The period between
polls of the Central
Configuration Service by
the inter-service
connection manager
component to refresh
its lists of available
service instances.
The maximum time that
the inter-service
connection manager
component allows to
establish contact with a
single instance of a
particular service before
considering that
instance to be
unavailable.

38

DesktopServer\DataStore\Connections\Controller
DBConnectionSettings
Name

Type

Default

Info

ConnectionString

string

ConnectivityRetryDelaySecs

int

10

Seconds
Minimum=1

MaxConnectivityLossSecs

int

300

Seconds
Minimum=0

MaxTxRetries

int

Seconds
Minimum=0

MaxTxRetryIntervalMs

int

1000

Milliseconds
Minimum=10

Description
The connection string used
by the broker service to
contact the database.
Interval between command
batch retries when
database connectivity
appears to have been lost.
Maximum elapsed time
over which a command
batch can be retried when
database connectivity
appears to have been lost.
Maximum number of
command batch execution
retries following errors not
related to loss of database
connectivity.
Maximum retry interval
between command batch
execution attempts
following errors not related
to loss of database
connectivity. The actual
retry interval used is a
random value between this
value and that specified by
the MinTxRetryIntervalMs
setting.

39

Name

Type

Default
500

Info

Description

Milliseconds
Minimum=10

Minimum retry interval


between command batch
execution attempts
following errors not related
to loss of database
connectivity. The actual
retry interval used is a
random value between this
value and that specified by
the MaxTxRetryIntervalMs
setting.
The name of the database
provider used for the
database connection.
Period after database
connectivity is restored
following loss, before which
reaper actions of the broker
service are inhibited.
Setting this value too low
may result in VDA
registrations being dropped
by the broker service
following temporary loss of
database connectivity.
Maximum time allowed for
an SDK 'get' query to start
returning data from the SQL
server before it is timed-out
and abandoned. The query
will typically be retried
following a time-out; the
retry logic is controlled by
other database connection
settings.

MinTxRetryIntervalMs

int

ProviderName

string

ReaperDeferralPeriodSecs

int

45

Seconds
Minimum=0

SdkSqlQueryTimeoutSecs

int

30

Seconds
Minimum=1
Maximum=12
0

System.D
ata.SqlCli
ent

40

DesktopServer\SiteServices
SiteServicesSettings
Name

Type

ControllerKeepalivePollMs

int

LeasePeriodSecs

int

LeaseRefreshPollAfterFailoverSecs int

Default

Info

Description

20000 Milliseconds The time between


Minimum=5 controller heartbeat
000
updates to its recorded
last activity time in the
database. The last
activity time, in
conjunction with the
MaxControllerInactivityS
ecs setting, is used to
enable detection of
failed controllers in a
site.
40
Seconds
The time for which a site
Minimum=1 service lease remains
0
valid once acquired by a
controller in the site. A
service lease must be
renewed by the owning
controller before it
expires otherwise it may
be acquired by another
controller in the site.
5
Seconds
If a controller acquires a
Minimum=1 site service lease due to
the failure of another
controller in the site,
then the next lease
renewal request follows
after this period. This
should be less than the
LeaseRefreshPollSecs
setting value and is
designed to increase the
rate at which service
leases are moved away
from a failed controller
(only a single lease can
be moved during each
lease renewal request).
41

Name

Type

Default

Info

Description
The period between site
service lease renewal
requests by a controller.
This must be less than
the LeasePeriodSecs
setting value. The lease
renewal request is also
the point at which new
site service leases can be
acquired. Note that each
renewal request applies
to all leases currently
held by the controller.
Maximum elapsed time
allowed since the last
recorded activity time of
a controller before it is
considered to have failed
by other controllers in
the site. This value
should be significantly
greater than the
ControllerKeepalivePoll
Ms setting value,
otherwise bogus
controller failures may
be detected causing
potentially expensive
moves of site services
between controllers.
Maximum time that the
Site Service Manager will
wait during shutdown for
all services active on the
local controller to stop.
Any services still active
after this time will be
assumed to have hung
and will be stopped by
virtue of the controller
process exiting; if this
occurs the service may
not shutdown cleanly.

LeaseRefreshPollSecs

int

30

Seconds
Minimum=5

MaxControllerInactivitySecs

int

40

Seconds
Minimum=1
0

MaxShutdownTimeSecs

int

20

Seconds
Minimum=1

42

DesktopServer\NameCache
NameCacheSettings
Name

Type

Default

Info

DisableAutomaticDomainTr
ustSearch

bool

FALSE

DisableDomainCaching

bool

FALSE

DomainTrustMappingMaxT
hreads

int

Minimum=1

DomainTrustMappingRefres int
hPeriodMins

60

Minutes
Minimum=10

Description
Disables automatic traversal
of the trust relationships to
the Citrix Broker Service
controller's computer
domain used to identify
domains and forests
available for performing
name lookups. If disabled,
only Domain Controllers in
the controllers domain, or
Global Catalogs in the
controller's forest are used
for name lookups. When
disabled, machine and user
names from remote forests
are typically not available.
Prevents persistent
connections being held open
to a Domain Controller in
each domain visible to the
Citrix Broker Service, but
incurs additional setup cost
each time a name lookup is
performed against a domain.
Maximum number of
concurrent threads that will
be used during identification
of AD forests and domains
that trust the current
domain of the controller.
Time between queries to the
AD infrastructure designed
to identify AD forests and
domains that trust the
current domain of the
controller, that is, domains
that can be searched directly
by the controller for account
name information.
43

Name
MachineNameLookupTime
outMs

Type

Default

Info

Description
Maximum time to wait for
machine name resolution
during creation of a desktop.
Period after which cached
AD user/group account
name, or machine name
details are refreshed in the
case where the SAM name
of the cached entity could
not be obtained (the cache
may thus either contain no
SAM name information, or
potentially an out of date
value).
Period after which cached
AD user/group account
name, or machine name
details are refreshed in the
case where the SAM name
of the cached entity was
successfully obtained.
Period over which ondemand background name
lookups to refresh specific
entries in an AD cache will
be coalesced in an attempt
to reduce the number of
small lookup requests issued
to AD.
When refreshing one of the
AD name caches, defines the
maximum number of
expired entries to read from
the database in a single read
operation. All entries to be
refreshed are iterated over
in batches of this size. This
value does not relate to the
maximum number of objects
batched into a single request
when requesting new data
from AD itself.

int

3000

Milliseconds
Minimum=0

NameRefreshPeriodAfterErr int
orMins

60

Minutes
Minimum=1

NameRefreshPeriodMins

int

1440

Minutes
Minimum=5

OnDemandLookupCoalesce
PeriodMs

int

1000

Milliseconds
Minimum=0

RefreshDBBatchSize

int

250

Minimum=1

44

DesktopServer\Logging
LoggingSettings

Name

ConnectionLogLifetimeHours

Type
int

HypervisorAlertLifetimeHours int

Default

Info

48

Hours
Minimum=0

168

Hours
Minimum=0

Description
Time for which connection
log entries are kept before
being purged.
Time for which hypervisor
alert entries are kept
before being purged.

45

DesktopServer\MachineCommandQueues
MachineCommandQueuesSettings
Name

Type

MachineCommandQueueLifetimeHours int

Default
24

Info

Description

Hours
Time for which data
Minimum=0 for
sent/cancelled/expired
machine command
messages are retained
before being purged.

46

DesktopServer\ConnectionLeasing
ConnectionLeasingSettings
Name

Type

Default

Info

Description

Minimum=1

Setting that controls the


number of items check for
possible deletion each
deletion check interval, per
item category. The number
of items checked in a
particular cycle is by whole
subdirectories, so may
exceed this limit by the size
of the last subdirectory
encountered.
Setting that controls the
components of the
enumeration lease key. Bit 0
- User Sid Bit 1 - Client Name
Bit 2 - Client IP Address Bit 3
- ViaAG flag Bit 4 AccessTags
Setting that controls the
maximum time the logon
tickets are cached in
memory before they are
discarded.
Setting that specifies the
time in minutes after which
the lease will expire once it
is stored in the database.
The expired leases are
removed every 30 minutes
by the site service. Setting
an expiration value smaller
than 30 minutes would need
a change to the site service
frequency if the lease needs
to be removed earlier.
Expired leases will not be
used by the controller even
if they are still present in the
lease cache.

DeletionCheckItemLimitPer
Cycle

int

100

EnumerationLeaseKeyMask

int

LaunchRefCacheExpiryMax
Mins

int

Minutes

LeaseExpirationTimeInMins

int

20160

Minutes

47

Name

Type

LeaseMarkedDeletedTimeIn int
Mins

Default
30

Info

Description

Minutes

Setting that specific the


maximum time a lease will
remain in deleted state
before its purged.
The maximum number of
lease to sync per sync cycle.
This helps to throttle and
restrict the number of disk
writes that would be
generated every time the
sync runs.
Setting that controls the
maximum number of time
we will attempt to delete
the local cache directory in
case of IO exceptions.
Setting that specifies the life
time of an unchanged lease
before its expiration time is
refreshed. The value is
specified as a fraction of the
LeaseExpirationTimeInMins.
Setting that specific the
maximum time in seconds to
wait before entering leasing
mode on hitting pending
failure state in the DAL layer.
Setting that controls the
time between stale lease
and cached data cleanup
cycles.
Setting that specifies the
intervals in which to check
for any leases to sync. A
sane value must he larger
than
SiteDynamicDataRefreshPeri
odMs, as site dynamic data
refreshed will tell when
lease and other data last
changed.

MaxItemsPerSyncCycle

int

1000

MaxRetryDuringLocalCache
Deletion

int

MinLeaseLifetimeFractionB
eforeRefresh

int

10

PendingFailureMaxSecs

int

90

Seconds

SyncCleanupDelaySecs

int

120

Seconds

SyncIntervalSecs

int

10

Seconds

48

Name

Type

Default

Info

SyncLocation

string

%Program
Data%\\Ci
trix\\Brok
er\\Cache

SyncStartDelayMins

int

Minutes

UploadQueueIdleMaxSecs

int

10

Seconds

UploadQueueMaxItems

int

100

Description
The location on local disk
where the leases are to be
cached.

Broker\Service\State\ConnectionLeasing

Setting that controls the


time to elapse before the
first sync can run after the
controller service has been
started.
Setting that controls the max
time to wait for the upload
queue to be idle. Once the
queue idle time pass this
limit, even if the queue item
threshold is not reached the
contents of the lease queue
will be upload for sync.
Setting that controls the max
items to queue before lease
upload is triggered.

Note: This area is dynamically updated by the broker service during normal operation and any
changes made by customers will be overwritten (and any changes may cause dynamic issues to
connection leasing operation leading to missed leases and potential other issues). This area is
where the broker is using the registry as a dynamic persistent store and should be considered as
a read-only store. This configuration does not have any applicable policy settings.

ConnectionLeasingState
Name

Type

Default

ApplicationChangesCurrentEnumLastUidRetrieved

long

ApplicationChangesCurrentEnumStartTime

DateTime 0

Info

Description
The last app
retrieved
during the
current sync
check.
The time
when the
current sync
check for
changes
started.
49

Name

Type

Default

ApplicationChangesLastCheckTime

DateTime 0

ApplicationDeletionLastCheckTime

DateTime 0

DesktopDeletionLastCheckTime

DateTime 0

DnsResolutionEnabled

bool

FALSE

Enabled

bool

FALSE

IconChangesCurrentEnumLastUidRetrieved

long

Info

Description
The time
when the
apps were
last checked
for changes.
The time
when the
apps were
last checked
for delete
changes.
The time
when the
Leases were
last checked
for delete
changes.
Indicates
that the
Controller
should use
dns
resolution
for workers
when in
leasing.
Indicates
that the
Controller
should use
connection
leasing,
when the DB
is not
available.
The last icon
retrieved
during the
current sync
check..

50

Name

Type

Default

IconChangesCurrentEnumStartTime

DateTime 0

IconChangesLastCheckTime

DateTime 0

IconDeletionLastCheckTime

DateTime 0

LeaseChangesCurrentEnumLastUidRetrieved

long

LeaseChangesCurrentEnumStartTime

DateTime 0

LeaseChangesLastCheckTime

DateTime 0

LeaseDeletionLastCheckTime

DateTime 0

Info

Description
The time
when the
current sync
check for
changes
started.
The time
when the
icons were
last checked
for changes.
The time
when the
icons were
last checked
for delete
changes.
The last
Lease
retrieved
during the
current sync
check..
The time
when the
current sync
check for
changes
started.
The time
when the
Leases were
last checked
for changes.
The time
when the
Leases were
last checked
for delete
changes.

51

Name

Type

PrivateDesktopChangesCurrentEnumLastUidRetrieved long

Default
0

PrivateDesktopChangesCurrentEnumStartTime

DateTime 0

PrivateDesktopChangesLastCheckTime

DateTime 0

SharedDesktopChangesCurrentEnumLastUidRetrieved long

SharedDesktopChangesCurrentEnumStartTime

DateTime 0

SharedDesktopChangesLastCheckTime

DateTime 0

SiteGuid

string

Info

Description
The last
private
desktop
retrieved
during the
current sync
check..
The time
when the
current sync
check for
changes
started.
The time
when the
private
desktops
were last
checked for
changes.
The last
shared
desktop
retrieved
during the
current sync
check..
The time
when the
current sync
check for
changes
started.
The time
when the
Leases were
last checked
for changes.
The site
GUID last
used.

52

Name

Type

Default

WorkerChangesCurrentEnumLastUidRetrieved

long

WorkerChangesCurrentEnumStartTime

DateTime 0

WorkerChangesLastCheckTime

DateTime 0

WorkerDeletionLastCheckTime

DateTime 0

Info

Description
The last
Worker
retrieved
during the
current sync
check..
The time
when the
current sync
check for
changes
started.
The time
when the
Workers
were last
checked for
changes.
The time
when the
Workers
were last
checked for
delete
changes.

53

Citrix Director
Registry Keys
Location

Hive

Value

VDA

HKLM

\Software\Citrix\Director\Task
ManagerDataDisplayed

Director
server

NONE

Type
REG_DWOR
D

Notes
Setting for Director
VDAplugin for displaying
the Applications in Task
Manager

Privileged Service
Registry Keys

The service install location: HKLM\Software\Citrix\PrivilegedService\InstallLocation


This is used to determine whether the service is installed.

54

Citrix Studio
Hive
Key
HKLM SOFTWARE\Citrix\Citrix
Desktop Delivery
Controller\Configuration
Data\RoleConfiguration
HKLM SOFTWARE\Citrix\Citrix
Desktop Delivery
Controller\Configuration
Data\RoleConfiguration
HKLM SOFTWARE\Citrix\Citrix
Desktop Delivery
Controller\Configuration
Data
HKLM SOFTWARE\Citrix\DesktopSt
udio
HKLM SOFTWARE\Citrix\OnlineErr
orReporting

HKLM SOFTWARE\Citrix\DesktopSt
udio (32bit) |
SOFTWARE\Wow6442Node\
Citrix\DesktopStudio (64bit)
HKCU SOFTWARE\Citrix\XenDeskt
op\DesktopStudio
HKCU SOFTWARE\Citrix\XenDeskt
op\DesktopStudio
HKCU SOFTWARE\Citrix\XenDeskt
op\DesktopStudio
HKCU

SOFTWARE\Citrix\XenDeskt
op\DesktopStudio

HKCU

SOFTWARE\Citrix\XenDeskt
op\DesktopStudio
SOFTWARE\Citrix\XenDeskt
op\DesktopStudio
SOFTWARE\Citrix\XenDeskt
op\DesktopStudio
SOFTWARE\Citrix\XenDeskt
op\DesktopStudio

HKCU
HKCU
HKCU

Value

Studio

Type
string

Details
Path(s) to load the DA role
configuration files from

string

Path to the Studio DA role


configuration file

EditionsAndFeatur string
es

Path to load the feature


table from

InstallLocation

string

Disable

int

Path to Studio install


location
Non-zero to disable
citrix.com error reporting
(across all components that
use citrix.com error
reporting)
Non-zero to enable local
access apps

ClientHostedApps int
Enabled
DoNotShowFullDe
ployIntro
DoNotShowCreate
Applications
DoNotShowCreate
DesktopGroupIntr
o
DoNotShowCreate
Local Access
ApplicationIntro
DoNotShowCreate
CatalogIntro
DoNotShowAppVI
ntro
DoNotShowDeleg
atedAdminIntro
DoNotShowGroup
PolicyIntro

int
int
int

Disables wizard intro page


(non zero to disable)
Disables wizard intro page
(non zero to disable)
Disables wizard intro page
(non zero to disable)

int

Disables wizard intro page


(non zero to disable)

int

Disables wizard intro page


(non zero to disable)
Disables top level intro page
(non zero to disable)
Disables top level intro page
(non zero to disable)
Disables top level intro page
(non zero to disable)

int
int
int

55

Hive
Key
HKCU SOFTWARE\Citrix\XenDeskt
op\DesktopStudio
HKCU SOFTWARE\Citrix\XenDeskt
op\DesktopStudio

Value
Type
DoNotShowConfig int
LoggingIntro
DoNotShowReceiv int
erStorefrontIntro

Details
Disables top level intro page
(non zero to disable)
Disables top level intro page
(non zero to disable)

56

Virtual Desktop Agent


Type
Registry

Registry

Registry

Registry

Location
32-bit machines
HKLM\Software\Citrix\L
ocal Access Apps
64-bit machine
HKLM\Software\Wow64
32Node\Citrix\Local
Access Apps
For 32-bit machine
HKLM\Software\Citrix\L
ocal Access Apps
For 64-bit machines
HKLM\Software\Wow64
32Node\Citrix\Local
Access Apps
32-bit machines:
HKLM\Software\Citrix\C
lient Hosted
Apps\Policies\Session
State
64-bit machines
HKLM\Software\Wow64
32Node\Citrix\Client
Hosted
Apps\Policies\Session
State
HKCU\Software\Citrix\L

RegValue Name

Reg Type

Default

Possible
Values

LAA(Server-side registry settings)


CacheCHSIcons
REG_DWORD 1
0 - Disabled,
1 - Enabled

Description
Cache shortcut icons: Caching of
shortcut icons helps in avoiding
network traffic for every
connection/reconnection. Icons
are cached by default, if no
value is present.

CHSShortcutEnu
merationLimit

REG_DWORD

250

Integer
value

Limit to the number of shortcuts


that can be enumerated in the
session. The Desktop is
enumerated first and then the
Programs menu.

Terminate

REG_DWORD

1- Do
nothing

Set the registry to configure


Action on Local Apps when user
logs off/disconnect the Session.

3-Close

ProgramsCHSEn

REG_DWORD

0 - Disabled,

Retrieve start menu programs


57

Type

Location

RegValue Name

Reg Type

Default

Possible
Values
1 - Enabled

ocal Access Apps

abled

Registry

HKCU\Software\Citrix\L
ocal Access Apps

DesktopCHSFold
erName

REG_SZ

Local
Deskto
p

String

Registry

HKCU\Software\Citrix\L

ProgramsCHSFol

REG_SZ

Local

String

Description
shortcuts: Start menu programs
shortcuts are retrieved by
default, if no value is present.
Display name of desktop
shortcuts folder: If client
desktop shortcuts are retrieved
then specifies the display name
of the folder on the desktop
where shortcuts will be placed.
If folder name is empty, then
shortcuts will not be added. If
folder with same name already
exists, it will not be overwritten.
If no desktop shortcuts were
retrieved from client, then
"Local Desktop" is not created.
Sub folders present on client
desktop are created inside
"Local Desktop". If any subfolder
has no shortcuts, then that
subfolder is not created. File
system folder name is always
Citrix_CHS_Desktop-8912C333ACF9-4569-932A2EAD89A8B2DE. "Local
Desktop" is taken as display
name by default, if no value is
present.
Display name of start menu
58

Type

Registry

Location

RegValue Name

ocal Access Apps

derName

HKCU\Software\Citrix\L
ocal Access Apps

RedirectFinalUR
Ls

Reg Type

Default
Progra
ms

REG_DWORD

Possible
Values

0 - Disabled,
1 - Enabled

Description
programs shortcuts folder: If
client programs menu shortcuts
are retrieved then specifies the
display name of the folder in the
programs menu where shortcuts
will be placed.
If folder name is empty then
shortcuts will not be added.
If folder with same name
already exists, it will not be
overwritten.
If no programs shortcuts were
retrieved from client, then
"Local Programs" is not created.
Sub folders present on client
programs are created inside
"Local Programs".
If any subfolder has no
shortcuts, then that subfolder is
not created. File system folder
name is always
Citrix_CHS_Programs-8912C333ACF9-4569-932A2EAD89A8B2DE. "Local
Programs" is taken as display
name by default, if no value is
present.
Let Internet explorer wait until
final URL is fully navigated by
59

Type

Location

RegValue Name

Reg Type

Default

Possible
Values

Registry

HKCU\Software\Citrix\L
ocal Access Apps

DesktopCHSMer
ge

REG_DWORD

0 - Disabled,
1 - Enabled

Registry

HKCU\Software\Citrix\L
ocal Access Apps

ProgramsCHSMe REG_DWORD
rge

0 - Disabled,
1 - Enabled

Description
the browser: Before redirection,
let Internet explorer wait till
final URL is fully navigated by
the browser, instead of entered
URL by the user.
Setting it to 1, enables
redirecting final navigated URLs.
By default, URLs entered by user
are redirected from server to
client.
Merge client desktop shortcuts:
This value determines if client
desktop shortcuts are merged
with those of host after they are
retrieved. If shortcut with same
name already exists, then new
shortcut will not be added. If a
file is present with same display
name as shortcut, then file will
not be deleted. Shortcuts are
kept both at "Local Desktop"
and directly on desktop.
Shortcuts that were not added
because of merging can be
launched through the folder.
Shortcuts are not merged by
default, if no value is present.
Merge start menu programs
shortcuts: This value determines
60

Type

Registry

Location

HKCU\Software\Citrix\IC
A Client\CHS

RegValue Name

Reg Type

Default

Possible
Values

LAA(Client-side registry settings)


DesktopFolders REG_MULTI_S Empty
String List
Z

Description
if client start menu programs
shortcuts are merged with those
of host after they are retrieved.
If shortcut with same name
already exists, then new
shortcut will not be added. If a
file is present with same display
name as shortcut, then file will
not be deleted. Shortcuts are
kept both at "Local Desktop"
and directly on desktop.
Shortcuts that were not added
because of merging can be
launched through the folder.
Shortcuts are not merged by
default, if no value is present.
Paths to the folders containing
shortcuts to be placed on the
remote desktop. If shortcut with
the same name found in more
than one folder then last found
shortcut will be used. If value is
not found in the registry then
standard Windows desktop is
enumerated. Standard Windows
desktop folder are obtained by
calling Win32 SHGetFolderPath
API with CSIDLs
61

Type

Registry

Location

HKCU\Software\Citrix\IC
A Client\CHS

RegValue Name

Reg Type

Default

ProgramsFolders REG_MULTI_S Empty


Z

Possible
Values

String List

Description
CSIDL_COMMON_DESKTOPDIRE
CTORY and
CSIDL_DESKTOPDIRECTORY in
that order. When shortcuts with
the same name are encountered
in different folders, the latest
shortcut is used. For example, if
"Notepad" exists in both
CSIDL_COMMON_DESKTOPDIRE
CTORY and
CSIDL_DESKTOPDIRECTORY the
one from
CSIDL_DESKTOPDIRECTORY will
be used. .Net equivalent for
SHGetFolderPath is
Environment.GetFolderPath. If
value is found, but empty then
no shortcuts are enumerated.
Environment variables could be
used in folders paths.
Paths to the folders containing
shortcuts to be placed in the
remote programs menu. If
shortcut with the same name is
found in more than one folder
then last found shortcut will be
used. If value is not found in the
registry then standard Windows
programs menu is enumerated.
62

Type

Registry

Location

HKCU\Software\Citrix\IC
A Client\CHS

RegValue Name

RedirectFinalUR
Ls

Reg Type

REG_DWORD

Default

Possible
Values

0Disabled1 Enabled

Description
Standard Windows programs
menu folder are obtained by
calling Win32 SHGetFolderPath
API with CSIDLs
CSIDL_COMMON_PROGRAMS
and CSIDL_PROGRAMS in that
order. When shortcuts with the
same name are encountered in
different folders, the latest
shortcut is used. For example, if
"Notepad" exists in both
CSIDL_COMMON_PROGRAMS
and CSIDL_PROGRAMS the one
from CSIDL_PROGRAMS will be
used. .Net equivalent for
SHGetFolderPath is
Environment.GetFolderPath. If
value is found, but empty then
no shortcuts are enumerated.
Environment variables could be
used in folders paths
Before redirection, let Internet
explorer wait until final URL is
fully navigated by the browser,
instead of entered URL by the
user. Setting it to 1, enables
redirecting final navigated URLs.
By default, URLs entered by user
are redirected from client to
63

Type

Location

Registry

HKLM\Software\Citrix\I
CA Client\RSM

Registry

HKLM\Software\Citrix\I
CA
Client\RSM\Applications
\<application_name.exe
> (For e.g firefox.exe)

Registry

Registry

Registry

RegValue Name
SessionApplicati
onLimit

Reg Type

Default

Possible
Values

REG_DWORD

REG_DWORD

CDM settings
REG_DWORD 1

Type, flags

Description
server.
The number of client hosted
applications/shortcuts that a
user can have running in a
session (Default value: 100).
Once the limit is reached any
client hosted
applications/shortcuts launched
by the user will fail silently; a
CDF Error trace message will be
logged.
Special Application flags:
Application type and flags that
can be specified to get better
window taskbar integration
inside sessions.

HKEY_LOCAL_MACHINE EnableCcReadCa
0 - Disabled, Set this value to enable file
\SYSTEM\CurrentContro che
1 - Enabled system read caching of CDM
lSet\services\picadm\Pa
files on VDA
rameters
HKEY_LOCAL_MACHINE EnableCcWriteC REG_DWORD 1
0 - Disabled, Set this value to enable file
\SYSTEM\CurrentContro ache
1 - Enabled system write caching of CDM
lSet\services\picadm\Pa
files on VDA
rameters
COM/LPT feature DEPRECATED in Excalibur. Following settings required to enable the feature.
HKLM\Software\Citrix\G AllowComPortR REG_DWORD 0
0 - Disabled,
1 - Enabled
roupPolicy\Defaults\De
edirection
precated
64

Type

Location

Registry

HKLM\Software\Citrix\G
roupPolicy\Defaults\De
precated
HKLM\Software\Citrix\G
roupPolicy\Defaults\De
precated
HKLM\Software\Citrix\G
roupPolicy\Defaults\De
precated
HKLM\Software\Citrix\G
roupPolicy\Defaults\De
precated
HKLM\Software\Citrix\G
roupPolicy\Defaults\De
precated
HKLM\Software\Citrix\G
roupPolicy\Defaults\De
precated
HKLM\Software\Citrix\G
roupPolicy\Defaults\De
precated

Registry
Registry
Registry
Registry
Registry
Registry

RegValue Name

Reg Type

Default

Possible
Values
Integer
value

LimitComBw

REG_DWORD

LimitComBWPer
cent

REG_DWORD

percentage

AllowLptPortRed REG_DWORD
irection

0 - Disabled,
1 - Enabled

LimitLptBw

REG_DWORD

Integer
value

LimitLptBwPerce
nt

REG_DWORD

Percentage

AutoConnectClie
ntComPorts

REG_DWORD

0 - Disabled,
1 - Enabled

AutoConnectClie
ntLptPorts

REG_DWORD

0 - Disabled,
1 - Enabled

Description

You might also like