Professional Documents
Culture Documents
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
Name
Type
Default
Info
Summary
StartupRetryPeriodLimit
Ms
int
600000
Milliseconds
StartupRetryPeriodStart
MaxMs
int
10000
Milliseconds
Personal vDisk
Installed Service
Name : Citrix Personal vDisk
Logon As : Local System
AppV
[ALL REGISTRY KEYS AND VALUES ARE CREATED BY INSTALLER AND SHOULD NOT BE
MODIFIED OR REMOVED]
1.STUDIO 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.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"
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]"
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.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
StartupRetryPeriodStartMaxMs
int
10000
Milliseconds
Name
Type
Default
Info
Summary
StartupRetryPeriodLimitMs
int
600000
Milliseconds
StartupRetryPeriodStartMaxMs
int
10000
Milliseconds
NameCacheRefreshDBBatchSize
int
250
Number
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
HKLM\SOFTWARE\Microsoft\Windows
NT\CurrentVersion\Winlogon\GPExtensions\{26F29E43-DA55-459d-A045-5FEB25F8AB15}
Name
Type
Default
Info
Summary
StartupRetryPeriodLimitMs
int
600000
Milliseconds
StartupRetryPeriodStartMa
xMs
int
10000
Milliseconds
HKEY_LOCAL_MACHINE\SOFTWARE\Citrix\XDservices\DAS\DataStore\Connecti
ons
ConnectionString : REG_SZ : Database connection string for the DDC datastore
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\...
Name
Type
Default
Info
Summary
StartupRetryPeriodLimitMs
int
600000
Milliseconds
StartupRetryPeriodStartMa
xMs
int
10000
Milliseconds
10
Host Service
Name
Type
Default
Info
Summary
StartupRetryPeriodLimitMs
int
600000
Milliseconds
StartupRetryPeriodStartMa
xMs
int
10000
Milliseconds
11
StoreFront
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
Notes
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
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
Notes
Denotes a
dependency from
this extension to the
named extension
REG_SZ
REG_SZ
REG_SZ
REG_SZ
Root
True
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
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:
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.
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
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
20
Name
HeartbeatPeriodMs
Type
int
Default
Info
Description
LaunchLicenseCheckPeriodSec
int
30
Seconds
Name
Type
Default
5
Info
Description
Seconds
Minimum=
0
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
MaxLogoffWaitTimeSecs
int
10
MaxPendingSessions
int
1024
Seconds
Minimum=
0
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
MinimumAcceptableVdaMajorV
ersion
int
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
ProtectedSessionReconnectSecs
int
15
Seconds
Minimum=
0
SettleTimeForVdaStatusUpdate
Ms
int
1000
Millisecond
s
Minimum=
0
27
Name
Type
Default
SiteDynamicDataRefreshPeriod
Ms
int
15000
SupportMultipleForest
bool
FALSE
TestVdaCommunicationsTimeou int
tSecs
Info
Description
Millisecond
s
Minimum=
0
Seconds
Minimum=
1
28
Name
UpdateLoadIndexThreshold
Type
int
Default
500
Info
Description
Minimum=
0
Maximum=
10000
UseIPAddressFromWcf
bool
TRUE
UserDrivenResetTimeoutMs
int
30000
WIRetryIntervalDuringRegistrati
onStateChangeSec
int
30
Millisecond
s
Minimum=
0
Seconds
Minimum=
0
29
Name
WIRetryIntervalDuringSessionSt
ateChangeSec
Type
int
WorkerSettingsAssessmentMinu int
tes
Default
2
Info
Description
Seconds
Minimum=
0
90
HostingManagementSettings
Name
CompletedActionRetentionPeri
odSec
Type
int
Default
3600
HostingStartupRetryPeriodLimit int
Ms
600000
HostingStartupRetryPeriodStart int
MaxMs
10000
HypervisorConnectionPollPerio
dSec
30
int
Info
Description
Seconds
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
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
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
RebootCycleDataLifetimeHours int
336
Hours
Minimum=0
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
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
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
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
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
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
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
EditionsAndFeatur string
es
InstallLocation
string
Disable
int
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
int
int
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
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
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
Terminate
REG_DWORD
1- Do
nothing
3-Close
ProgramsCHSEn
REG_DWORD
0 - Disabled,
Type
Location
RegValue Name
Reg Type
Default
Possible
Values
1 - Enabled
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
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
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
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