RegistryKey XenDesktop 7.x

8/15/2019 RegistryKey XenDesktop 7.x

1/67


2/67

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


3/67

Active Directory Identity

FMA Registry Settings Usage (build 6.0.0.16)

Registry Settings Group:

HKLM\Software\Citrix\XDservices\ADIdentitySchema\EncryptionKeySharingSettings

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

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

EventLogSettings


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\ADIdentitySchemaAdIdentitySettings


4/67

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.

InterceptShutdown DWORD Remind Administrator to take inventory during

shutdown if set to 1.

UserDiskDrive REG_SZ The mount point to use for storing PvD.

Note: Not used in XenDesktop

PercentOfPvDForApps DWORD The percentage of PvD disk that should be

allocated for apps.

EnableUserProfileRedirection DWORD Enabling and disabling profile redirection.

PvDResetUserGroup REG_SZ Name of the User\Group allowed to do PvD

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

ontainer

DWORD To enable and disable dynamic resize.

MinimumVHDSizeMB

Minimum VHD size.


5/67


6/67

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

s

DWORD

"1"

2.2 COM – Specific

2.2.1

Key: HKCR\AppID\[APPID]

Default String "Citrix.VirtApp.Vda.Com.AppVObject"

LaunchPermission

Binary

""

AccessPermission Binary ""

RunAs String CTXAPPVCOMADMIN


7/67

2.3 Tracing Specific

KEY:HKLM\SYSTEM\CurrentControlSet\Control\Citrix\Tracing\Modules\Ctx_DLL_VirtAppPlu gin

Value

Type

Data

Classes String ""

Enabled DWORD "0"

Flags DWORD "7"

Level DWORD

"0"

GUID String

"72E2B16B-E99A-486C-AD1E-3B52A00E48BF "

2.3.1

KEY:HKLM\SYSTEM\CurrentControlSet\Control\Citrix\Tracing\Modules\

Ctx_EXE_VirtAppCOMServer

Classes String ""

Enabled DWORD "0"

Flags DWORD

"7"

Level DWORD "0"

GUID String "8808A5A5-92EC-49B9-8727-C2301BE9B965"

2.3.2

KEY:HKLM\SYSTEM\CurrentControlSet\Control\Citrix\Tracing\Modules\

Ctx_EXE_VirtAppLauncher

Classes String ""

Enabled DWORD

"0" Flags DWORD "7"

Level DWORD "0"

GUID String "87CBB5A6 45CE 4145 9D43 DF4205C6C632"


8/67

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


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


9/67

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\2AB7D86F-

53B0-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\1D60D946-86B7-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\29E1B66B-

7BD1-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


10/67

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


HKLM\Software\Citrix\XDservices\DAS\DataStore\Connections

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


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

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

DelegatedAdminSettings

R/W

Name

Type

Default

Info

Summary


before the first retry

of a failed start-up.

StartupRetryPeriodStartMaxMs int

10000

Milliseconds

The maximum delay between retries of

failed start-up

attempts.


11/67

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\...


12/67

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


HKLM\Software\Citrix\XDservices\DesktopUpdateManagerSchema\DataStore\

Connections

Policy Key:

HKLM\Software\Policies\Citrix\XDservices\DesktopUpdateManagerSchema\DataStore\Connect

ions



HKLM\Software\Citrix\XDservices\DesktopUpdateManagerSchema

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

MachineCreationSettings

R/W

Name

Type

Default

Info

Summary



13/67

Host Service

FMA Registry Settings Usage (build 6.0.0.16)


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


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

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

HostSettings

R/W

Name

Type

Default

Info

Summary


before the first retry

of a failed start-up


14/67

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 Type Data Notes

HKLM\Software\Citrix

DeliveryServices

CertificateStoreName

REG_SZ

Citrix Delivery Services

ClockSkew REG_SZ 00:05:00

ConfigurationLevel

REG_SZ

Guid

Used and updated

when propagating

configuration across

servers in a server

group.

FrameworkControllerAssemblyPath

REG_SZ

Full path of the folder containing the

Framework Controller

assembly

FrameworkControllerType REG_SZ Framework Controller

type

IISAssemblyPath REG_SZ Full path of the Citrix IIS

assembly

IISManagerType

REG_SZ

Citrix IIS Manager type

InstallDir REG_SZ Root install folder

FrameworkControllerData


15/67

Name

Type

Data

Notes

OrderingHint REG_DWO

RD

0x00000014 (20) Specifies the node

display order in the Admin Console

Parent REG_SZ Root

SupportsInitialConfigMode REG_SZ True

Extensions

Certificate

(Default) REG_SZ Full path of the

Certificate extensionassembly

CitrixAGBasicExtension

(Default) REG_SZ Full path of the Citrix AG

Basic extension

assembly

SupportsInitialConfigMode

REG_SZ

True

CitrixFederationExtension

(Default) REG_SZ Full path of the Citrix

Federation extension

assembly

ExplicitCommonExtension

(Default) REG_SZ Full path of the Explicit

Common extension

assembly

SupportsInitialConfigMode

REG_SZ

True

IntegratedWindowsExtension

(Default) REG SZ Full path of the


16/67

Name

Type

Data

Notes

IntegratedWindowsExtension

(Default)

REG_SZ

Full path of the Integrated Windows

Authentication view

extension assembly

Beacons

(Default) REG_SZ Full path of the Beacons

plugin assembly

OrderingHint

REG_DWO RD

0x0000003c (60)

Specifies the node display order in the

Admin Console

Parent REG_SZ Root

Gateways

(Default) REG_SZ Full path of the

Gateways plugin

assembly


RD


display order in the

Admin Console

Parent REG_SZ Root


OneTimeConfiguration

(Default) REG_SZ Full path of the One-

time Configuration

plugin assembly

IsEnabled REG SZ True Changed to False


17/67

Name

Type

Data

Notes

the Roaming service

DependentUpon

REG_SZ

Authentication

Denotes adependency from

this extension to the

named extension

Stores

(Default) REG_SZ Full path of the Stores

plugin assembly

Receiver for Web (Default) REG_SZ Full path of the Receiver

for Web plugin

assembly


RD



Admin Console

Parent

REG_SZ

Root


Extensions

(Default) REG_SZ (value not set)

ViewExtensions

(Default) REG_SZ (value not set)

Server Group

(Default) REG_SZ Full path of the Server

Group plugin assembly


RD

0x0000000a (10) Specifies the node



18/67

Name

Type

Data

Notes


Roaming

(Default) REG_SZ Full path of the Roaming

extension assembly


ViewExtensions

LegacySupport

(Default) REG_SZ Full path of the Legacy

Support view extensionassembly

Roaming


extension assembly

The same assembly

provides all Roaming

extensions

WizardExtensions

ReceiverForWeb

(Default) REG_SZ Full path of the Receiver

for Web plugin

assembly


Roaming


extension assembly

The same assembly

provides all Roaming

extensions

StoreFront / XenDesktop side-by-side deployment

HKLM\Software\Citrix


19/67

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.


20/67

DesktopServer

ControllerSettings

Name Type Default Info Description

ControllerStartupRetryPeriodLimitMs int 600000 Milliseconds The maximum

delay before the

first retry of a

failed controllerinfrastructure

start-up.

ControllerStartupRetryPeriodStartMaxMs int 10000 Milliseconds The maximum

delay between

retries of failed

controller

infrastructure

start-up attempts.

CoreSettingsName Type Default Info Description

AllowMultipleRemotePCAssign

ments

bool TRUE Controls whether to permit

multiple automated user

assignments to RemotePCmachines.


21/67


AutoHideNonContactableSessio

ns

bool TRUE Broker Service

automatically hidessessions on non-

contactable VDAs when

looking for shared desktop

or app sessions to which to

reconnect; this allows

brokering of new sessions

when existing sessions arepresent 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.

BrokerStartupRetryPeriodLimit

Ms

int 600000 Millisecond

s

The maximum delay before

the first retry of a failed

broker component start-up.

BrokerStartupRetryPeriodStart

MaxMs


s

The maximum delay

between retries of failedbroker component start-up

attempts.


22/67


ExtraSpinUpTimeSecs int 120 Seconds

Minimum=30

Additional time which may

be added toMaxTimeForPrepareSecs to

extend the timeout should

the target machine need

spun up as part of a session

launch.

FreeSessionThresholdForLoadEv

aluation

int 20 Minimum=

0

Threshold for number of

free sessions that ischecked 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.

This setting is onlyapplicable to multi-session

machines.


23/67


HeartbeatPeriodMs int 600000 Millisecond

s

Controls both the interval

and timeouts used for thekeep-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 thetime 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 enforcedby the XDC.

Th i i d


24/67


LaunchRetryPeriodSec int 5 Seconds

Minimum=0

Period after which users of

the XML service are hintedto retry launches that are

delayed due to

circumstances such as VMs

needing to be started to

satisfy the launch.

LicensingCacheFileLocation string The directory in the file

system where the policyengine will write the cache

file that holds cached

information from the

license server.

MachineSinBinStayTimeSecs int 60 Seconds

Minimum=

0

Period during which new

brokering requests are

inhibited to a machine

following a failed launch

(applicable to shared

desktops only).

MaxConcurrentRegistrationUpg

rades

int 5 Minimum=

1

Maximum number of

concurrent registration

hardening operations on

machine registrations that

the Registration Hardeningsite service will perform.

MaxDisconnectWaitTimeSecs int 10 Seconds Maximum time to wait for


25/67


MaxHeartbeatIntervalMs int -1 Millisecond

sMinimum=-

1

Defines the maximum

period between receipt oftwo 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 ofthe 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.

This setting does not

change the frequency at

which a VDA sends out

pings to a XDC.

MaxLogoffWaitTimeSecs int 10 SecondsMinimum=

0

Maximum time to wait forsession logoff to occur after

logoff request issued.


26/67


MaxRegistrationCompletionTim

eSecs

int 600 Seconds

Minimum=1

Maximum time within

which the registrationsequence for a single

machine must complete.

This refers to both

immediate hard

registrations, and soft to

hard registration

transitions. If theregistration fails to

complete within this time

then the machine's partial

registration is discarded by

the broker.

MaxSessionEstablishmentTimeS

ecs

int 200 Seconds

Minimum=

10

Used for logon ticket

lifetime, VDA listening

timeout, and deadline

imposed by the broker for

evidence of client

connection.

MaxTimeForPrepareSecs int 60 Seconds

Minimum=

5

A deadline imposed by the

broker for launch preamble

ahead of the

PrepareSession call to theVDA. Following successful

PrepareSession, the


27/67


MinHeartbeatPeriodMs int 30000 Millisecond

sMinimum=

0

Maximum=

3600000

Defines the minimum

period between two pingmessages 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 loaddata.

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.

The period itself is sent

from XDC to VDA as part of

the ping mechanism.MinimumAcceptableVdaMajorV

ersion

int 5 The earliest major version

of VDA install that is

bl h h


28/67


MinRegistrationRecountInterval

Secs

int 15 Seconds

Minimum=0

Minimum interval between

accurate recounts by abroker 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 thedatabase 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 time-

based restrictions; this is

not recommended

however.

MinVdaStatusUpdatePeriodMs int 1000 Millisecond

s

Minimum=0

Period to limit the rate at

which VDAs can send status

updates to the XDCs.


29/67


NonContactableSessionGracePe

riodSecs

int 30 Seconds

Minimum=0

Grace period after which a

session would otherwise beconsidered non-contactable

before automatic session

hiding during reconnect can

occur. The grace period

prevents transient failures

from causing sessions to be

hidden if a reconnectshould occur just after the

failure.

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.

ProtectedSessionReconnectSecs int 15 Seconds

Minimum=

0

Grace period after a session

launch request (for

reconnect/steal) duringwhich a session deletion or

disconnect event does not

h d l h


30/67


SiteDynamicDataRefreshPeriod

Ms


sMinimum=

0

Period after which site data

that changes in thedatabase is noticed by the

XDCs.

SupportMultipleForest bool FALSE Allows the XDC to accept

registrations from VDAs in a

different Active Directory

forest to that containing the

XDC itself. In this situationthe VDA must be

authenticated using NTLM

rather than the more

secure Kerberos protocol,

thus this feature is disabled

by default.

TestVdaCommunicationsTimeou

tSecs

int 5 Seconds

Minimum=

1

The timeout when verifying

the connection between

the broker and a VDA

during a registration

request.


31/67


UpdateLoadIndexThreshold int 500 Minimum=

0Maximum=

10000

Defines the maximum

allowed change within anindividual 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 maycause 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.

The threshold value itself issent from XDC to VDA as

part of the ping mechanism.

dd f b l d h h


32/67


33/67


MachineRecreationSinBinMinut

es

int 20 Minutes How long the broker

should 'sin bin' a VM thatis being re-created,

preventing it from being

selected in brokering or

otherwise started

automatically by power

management automation.

This state is cleared uponcompletion of VM re-

creation.

MachineStartSinBinSeconds int 300 Seconds 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.

MaxFailedRegistrationsAllowed int 2 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.MaxRegistrationDelayMin int 20 Minutes How long to wait in

minutes after a VM is


34/67


35/67


StarvationBoostPeriodSec int 600 Seconds The period between

automatic power actionboosting to avoid low

priority actions being

always pre-empted by

higher priority actions.


36/67

DesktopServer\IdleSessions

IdleSessionsSettings


MaxIdleSessionToTerminatePercent int 1 Minimum=1

Maximum=100

Maximum number of

sessions to terminate

when load threshold on

the machine and

desktop group are hit.

MaxRetriesPerSession int 3 Minimum=1 Maximum time a

logoff/disconnect

operation is retried

before the session is

put into a sin bin.

MaxSessionOperationWaitTimeSecs int 30 Minimum=30 Maximum time a

logoff/disconnectoperation is to be

performed in for the

list of sessions on each

worker.

SinBinDurationSecs int 180 Seconds

Minimum=60

Maximum time a

session is put into sin

bin when alogoff/disconnect

performed on it does

not happen with the


37/67


XmlListeners int 500 Minimum=1

Maximum=1000

The maximum

number of requeststhat the XML service

will process

concurrently. If more

requests than this

number are

outstanding, the

additional requestsare queued until

processing of one or

more existing

requests completes.

The Broker service

must be restarted for

it recognise a change

to this value.

XmlServicesEnableNonSsl bool TRUE Enables listening for

http requests.

XmlServicesEnableSsl bool TRUE Enables listening for

https requests.

XmlServicesPort int 80 The port that the XML

service will listen on

for http requests.XmlServicesSslPort int 443 The port that the XML

service will listen on


38/67


XmlStaIdentity string 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.

XmlStaRefreshableTicket

LifetimeInSeconds

int 500 Seconds The time for which a

refreshable ticket

remains live (without

being refreshed).

XmlStaTicketLifetimeInSeconds int 100 Seconds The time for which a

non-refreshable ticket

remains live.

XmlWpnbrRequestTimeoutMs int 20000 Milliseconds How long to wait in

milliseconds before a

Wpnbr request is

timed out.

XmsStartupRetryPeriodLimitMs int 600000 Milliseconds The maximum delay

before the first retryof a failed XML

services start-up.


39/67

DesktopServer\RebootSchedule

RebootScheduleSettings


MaxActionThreads int 5 Minimum=1

Maximum=5

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.

MaxPvDPrepareTimeMins int 60 MinutesMinimum=1

Maximum=1

80

Maximum time allowed for aPvD 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.MaxShutdownDelayMin int 10 Minutes

Minimum=1

Maximum=6

Maximum time allowed for a

VM to shutdown during

reboot cycle processing before


40/67

ISCMSettings

Name Type Default Info DescriptionInterServiceConfigRefreshPeriodMs int 120000 Milliseconds The period between

polls of the Central

Configuration Service by

the inter-service

connection manager

component to refresh

its lists of availableservice instances.

MaxMsInterService

ConnectionRetryPeriod

int 60000 Milliseconds 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.


41/67

DesktopServer\DataStore\Connections\Controller



ConnectionString string The connection string used

by the broker service to

contact the database.

ConnectivityRetryDelaySecs int 10 Seconds

Minimum=1

Interval between command

batch retries when

database connectivity

appears to have been lost.

MaxConnectivityLossSecs int 300 Seconds

Minimum=0

Maximum elapsed time

over which a command

batch can be retried when

database connectivity

appears to have been lost.MaxTxRetries int 5 Seconds

Minimum=0

Maximum number of

command batch execution

retries following errors not

related to loss of database

connectivity.

MaxTxRetryIntervalMs int 1000 Milliseconds

Minimum=10

Maximum retry interval

between command batchexecution attempts

following errors not related

to loss of database


42/67


MinTxRetryIntervalMs int 500 Milliseconds

Minimum=10

Minimum retry interval

between command batchexecution 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.

ProviderName string System.D

ata.SqlCli

ent

The name of the database

provider used for the

database connection.

ReaperDeferralPeriodSecs int 45 Seconds

Minimum=0

Period after database

connectivity is restoredfollowing 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.

SdkSqlQueryTimeoutSecs int 30 Seconds Maximum time allowed for


43/67

DesktopServer\SiteServices

SiteServicesSettings


ControllerKeepalivePollMs int 20000 Milliseconds

Minimum=5

000

The time between

controller heartbeat

updates to its recorded

last activity time in the

database. The lastactivity time, in

conjunction with the

MaxControllerInactivityS

ecs setting, is used to

enable detection of

failed controllers in a

site.

LeasePeriodSecs int 40 Seconds

Minimum=1

0

The time for which a site

service lease remains

valid once acquired by a

controller in the site. A

service lease must be

renewed by the owning

controller before it

expires otherwise it maybe acquired by another

controller in the site.


44/67


LeaseRefreshPollSecs int 30 Seconds

Minimum=5

The period between site

service lease renewalrequests 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.

MaxControllerInactivitySecs int 40 Seconds

Minimum=1

0

Maximum elapsed time

allowed since the last

recorded activity time of

a controller before it isconsidered 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

b d d


45/67


46/67


MachineNameLookupTime

outMs

int 3000 Milliseconds

Minimum=0

Maximum time to wait for

machine name resolutionduring creation of a desktop.

NameRefreshPeriodAfterErr

orMins

int 60 Minutes

Minimum=1

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).

NameRefreshPeriodMins int 1440 Minutes

Minimum=5

Period after which cached

AD user/group account

name, or machine namedetails are refreshed in the

case where the SAM name

of the cached entity was

successfully obtained.

OnDemandLookupCoalesce

PeriodMs

int 1000 Milliseconds

Minimum=0

Period over which on-

demand background name

lookups to refresh specificentries in an AD cache will

be coalesced in an attempt


47/67

DesktopServer\Logging

LoggingSettingsName Type Default Info Description

ConnectionLogLifetimeHours int 48 Hours

Minimum=0

Time for which connection

log entries are kept before

being purged.

HypervisorAlertLifetimeHours int 168 Hours

Minimum=0

Time for which hypervisor

alert entries are keptbefore being purged.


48/67

DesktopServer\MachineCommandQueues

MachineCommandQueuesSettingsName Type Default Info Description

MachineCommandQueueLifetimeHours int 24 Hours

Minimum=0

Time for which data

for

sent/cancelled/expired

machine command

messages are retainedbefore being purged.


49/67

DesktopServer\ConnectionLeasing

ConnectionLeasingSettings


DeletionCheckItemLimitPer

Cycle

int 100 Minimum=1 Setting that controls the

number of items check for

possible deletion each

deletion check interval, per

item category. The numberof items checked in a

particular cycle is by whole

subdirectories, so may

exceed this limit by the size

of the last subdirectory

encountered.

EnumerationLeaseKeyMask int 9 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

LaunchRefCacheExpiryMax

Mins

int 3 Minutes Setting that controls the

maximum time the logontickets are cached in

memory before they are


50/67


LeaseMarkedDeletedTimeIn

Mins

int 30 Minutes Setting that specific the

maximum time a lease willremain in deleted state

before its purged.

MaxItemsPerSyncCycle int 1000 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.

MaxRetryDuringLocalCache

Deletion

int 5 Setting that controls the

maximum number of time

we will attempt to delete

the local cache directory in

case of IO exceptions.

MinLeaseLifetimeFractionBeforeRefresh

int 10 Setting that specifies the lifetime of an unchanged lease

before its expiration time is

refreshed. The value is

specified as a fraction of the

LeaseExpirationTimeInMins.

PendingFailureMaxSecs int 90 Seconds Setting that specific the

maximum time in seconds towait before entering leasing

mode on hitting pending


51/67


SyncLocation string %Program

Data%\\Citrix\\Brok

er\\Cache

The location on local disk

where the leases are to becached.

SyncStartDelayMins int 1 Minutes Setting that controls the

time to elapse before the

first sync can run after the

controller service has beenstarted.

UploadQueueIdleMaxSecs int 10 Seconds 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 thecontents of the lease queue

will be upload for sync.

UploadQueueMaxItems int 100 Setting that controls the max

items to queue before lease

upload is triggered.

Broker\Service\State\ConnectionLeasing

Note: This area is dynamically updated by the broker service during normal operation and anychanges 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


52/67


ApplicationChangesLastCheckTime DateTime 0 The time

when theapps were

last checked

for changes.

ApplicationDeletionLastCheckTime DateTime 0 The time

when the

apps were

last checked

for delete

changes.

DesktopDeletionLastCheckTime DateTime 0 The time

when the

Leases were

last checked

for delete

changes.DnsResolutionEnabled bool FALSE Indicates

that the

Controller

should use

dns

resolution

for workerswhen in

leasing.


53/67


IconChangesCurrentEnumStartTime DateTime 0 The time

when thecurrent sync

check for

changes

started.

IconChangesLastCheckTime DateTime 0 The time

when the

icons were

last checked

for changes.

IconDeletionLastCheckTime DateTime 0 The time

when the

icons were

last checked

for delete

changes.LeaseChangesCurrentEnumLastUidRetrieved long 0 The last

Lease

retrieved

during the

current sync

check..

LeaseChangesCurrentEnumStartTime DateTime 0 The timewhen the

current sync


54/67


PrivateDesktopChangesCurrentEnumLastUidRetrieved long 0 The last

privatedesktop

retrieved

during the

current sync

check..

PrivateDesktopChangesCurrentEnumStartTime DateTime 0 The time

when the

current sync

check for

changes

started.

PrivateDesktopChangesLastCheckTime DateTime 0 The time

when the

private

desktopswere last

checked for

changes.

SharedDesktopChangesCurrentEnumLastUidRetrieved long 0 The last

shared

desktop

retrievedduring the

current sync


55/67


WorkerChangesCurrentEnumLastUidRetrieved long 0 The last

Workerretrieved

during the

current sync

check..

WorkerChangesCurrentEnumStartTime DateTime 0 The time

when the

current sync

check for

changes

started.

WorkerChangesLastCheckTime DateTime 0 The time

when the

Workers

were last

checked forchanges.

WorkerDeletionLastCheckTime DateTime 0 The time

when the

Workers

were last

checked for

deletechanges.


56/67

Citrix Director

Registry Keys Location Hive Value Type Notes

VDA HKLM \Software\Citrix\Director\Task

ManagerDataDisplayed

REG_DWOR

D

Setting for Director

VDAplugin for displaying

the Applications in Task

Manager

Director

server

NONE

Privileged Service

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

This is used to determine whether the service is installed.


57/67

Citrix Studio Hive

Key

Value

Type

Details

HKLM

SOFTWARE\Citrix\Citrix

Desktop Delivery

Controller\Configuration

Data\RoleConfiguration

*

string

Path(s) to load the DA role

configuration files from

HKLM

SOFTWARE\Citrix\Citrix

Desktop Delivery


Data\RoleConfiguration

Studio

string

Path to the Studio DA role

configuration file

HKLM SOFTWARE\Citrix\Citrix

Desktop Delivery


Data

EditionsAndFeatur

es

string Path to load the feature

table from

HKLM SOFTWARE\Citrix\DesktopSt

udio

InstallLocation string Path to Studio install

location

HKLM

SOFTWARE\Citrix\OnlineErr orReporting

Disable

int

Non-zero to disablecitrix.com error reporting

(across all components that

use citrix.com error

reporting)

HKLM SOFTWARE\Citrix\DesktopSt

udio (32bit) |

SOFTWARE\Wow6442Node\

Citrix\DesktopStudio (64bit)

ClientHostedApps

Enabled

int Non-zero to enable local

access apps

HKCU SOFTWARE\Citrix\XenDeskt

op\DesktopStudio

DoNotShowFullDe

ployIntro

int Disables wizard intro page

(non zero to disable)


58/67

Hive

Key

Value

Type

Details


op\DesktopStudio

DoNotShowConfig

LoggingIntro

int Disables top level intro page



op\DesktopStudio

DoNotShowReceiv

erStorefrontIntro

int Disables top level intro page



59/67

Virtual Desktop Agent Type Location RegValue Name Reg Type Default Possible

Values

Description

LAA(Server-side registry settings)

Registry 32-bit machines

HKLM\Software\Citrix\L

ocal Access Apps

64-bit machine

HKLM\Software\Wow64

32Node\Citrix\Local

Access Apps

CacheCHSIcons REG_DWORD 1 0 - Disabled,

1 - Enabled

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.

Registry For 32-bit machine

HKLM\Software\Citrix\L

ocal Access Apps

For 64-bit machines HKLM\Software\Wow64

32Node\Citrix\Local

Access Apps

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.

Registry 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

Terminate REG_DWORD 1 1- Do

nothing

3-Close

Set the registry to configure

Action on Local Apps when user

logs off/disconnect the Session.

Registry HKCU\Software\Citrix\L ProgramsCHSEn REG_DWORD 1 0 - Disabled, Retrieve start menu programs

57


60/67

Type

Location

RegValue Name

Reg Type

Default

Possible

Values

Description

ocal Access Apps abled 1 - Enabled shortcuts: Start menu programs

shortcuts are retrieved by

default, if no value is present.

Registry

HKCU\Software\Citrix\L

ocal Access Apps

DesktopCHSFold

erName

REG_SZ

Local

Deskto

p

String

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-8912C333-

ACF9-4569-932A-

2EAD89A8B2DE. "Local

Desktop" is taken as display

name by default, if no value is

present.

Registry HKCU\Software\Citrix\L ProgramsCHSFol REG_SZ Local String Display name of start menu

58


61/67

Type

Location

RegValue Name

Reg Type

Default

Possible

Values

Description

ocal Access Apps derName Progra

ms

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-8912C333-

ACF9-4569-932A-

2EAD89A8B2DE. "Local

Programs" is taken as display

name by default, if no value is

present.

Registry HKCU\Software\Citrix\L

ocal Access Apps

RedirectFinalUR

Ls

REG_DWORD 0 0 - Disabled,

1 - Enabled

Let Internet explorer wait until

final URL is fully navigated by

59


62/67

Type

Location

RegValue Name

Reg Type

Default

Possible

Values

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.


ocal Access Apps

DesktopCHSMer

ge


1 - Enabled

Merge client desktop shortcuts:

This value determines if client

desktop shortcuts are mergedwith 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



ocal Access Apps

ProgramsCHSMe

rge


1 - Enabled

Merge start menu programs

shortcuts: This value determines

60


63/67

Type

Location

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


LAA(Client-side registry settings)

Registry HKCU\Software\Citrix\IC

A Client\CHS

DesktopFolders REG_MULTI_S

Z

Empty String List 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


64/67

Type

Location

RegValue Name

Reg Type

Default

Possible

Values

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 willbe 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.


A Client\CHS

ProgramsFolders REG_MULTI_S

Z

Empty String List 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


65/67

Type

Location

RegValue Name

Reg Type

Default

Possible

Values

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


A Client\CHS

RedirectFinalUR

Ls

REG_DWORD 0 0 -

Disabled1 -

Enabled

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


66/67

Type Location RegValue Name Reg Type Default Possible

Values

Description

server.

Registry HKLM\Software\Citrix\I

CA Client\RSM

SessionApplicati

onLimit

REG_DWORD The number of client hosted

applications/shortcuts that auser 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.

Registry

HKLM\Software\Citrix\I CA

Client\RSM\Applications

\ (For e.g firefox.exe)

REG_DWORD

Type, flags

Special Application flags: Application type and flags that

can be specified to get better

window taskbar integration

inside sessions.

CDM settings

Registry HKEY_LOCAL_MACHINE

\SYSTEM\CurrentContro

lSet\services\picadm\Pa

rameters

EnableCcReadCa

che


1 - Enabled

Set this value to enable file

system read caching of CDM

files on VDA

Registry

HKEY_LOCAL_MACHINE

\SYSTEM\CurrentContro

lSet\services\picadm\Pa

rameters

EnableCcWriteC

ache

REG_DWORD

1

0 - Disabled,

1 - Enabled

Set this value to enable file

system write caching of CDM

files on VDA

COM/LPT feature DEPRECATED in Excalibur. Following settings required to enable the feature.

Registry HKLM\Software\Citrix\G

roupPolicy\Defaults\De

precated

AllowComPortR

edirection


1 - Enabled

64


67/67

Type

Location

RegValue Name

Reg Type

Default

Possible

Values

Description



precated

LimitComBw REG_DWORD 0 Integer

value

Registry

HKLM\Software\Citrix\G


precated

LimitComBWPer

cent

REG_DWORD

0

percentage



precated

AllowLptPortRed

irection


1 - Enabled



precated

LimitLptBw REG_DWORD 0 Integer

value

Registry

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

precated

LimitLptBwPerce nt

REG_DWORD

0

Percentage



precated

AutoConnectClie

ntComPorts


1 - Enabled



precated

AutoConnectClie

ntLptPorts


1 - Enabled

RegistryKey XenDesktop 7.x

Documents